Contents

require 'vedeu/output/esc'

module Vedeu

  # Represents the concept of a visible or invisible attribute.
  #
  class Visible

    # @param value [Boolean|Symbol]
    # @return [Visible]
    def self.coerce(value)
      if value.is_a?(self)
        value

      else
        new(value)

      end
    end

    # Returns a new instance of Vedeu::Visible
    #
    # @param visible [Boolean|Symbol]
    # @return [Visible]
    def initialize(visible = nil)
      @visible = visible
    end

    # @return [String]
    def to_s
      visible? ? 'visible' : 'invisible'
    end

    # @return [String]
    def cursor
      if visible?
        Vedeu::Esc.string('show_cursor')

      else
        Vedeu::Esc.string('hide_cursor')

      end
    end

    # Returns a boolean indicating whether the instance is visible.
    #
    # @return [Boolean]
    def visible?
      visible
    end

    # Returns a boolean indicating whether the instance is invisible.
    #
    # @return [Boolean]
    def invisible?
      !visible
    end

    # @return [Visible]
    def hide
      Vedeu::Visible.new(false)
    end

    # @return [Visible]
    def show
      Vedeu::Visible.new(true)
    end

    # @return [Visible]
    def toggle
      visible? ? hide : show
    end

    # @return [Boolean]
    def visible
      if @visible == :hide || @visible == false
        false

      elsif @visible == :show || @visible == true
        true

      else
        !!@visible

      end
    end

  end # Visible

end # Vedeu

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
vedeu-0.4.13	lib/vedeu/support/visible.rb
vedeu-0.4.12	lib/vedeu/support/visible.rb