vedeu 0.2.12 → 0.3.0

data/lib/vedeu/models/view/char.rb

@@ -0,0 +1,84 @@
+require 'vedeu/presentation/presentation'
+
+module Vedeu
+
+  # A Char represents a single character of the terminal. It is a container for
+  # the a single character in a {Vedeu::Stream}.
+  #
+  # Though a multi-character String can be passed as a value, only the first
+  # character is returned in the escape sequence.
+  #
+  # @api private
+  class Char
+
+    include Vedeu::Presentation
+
+    attr_accessor :parent
+    attr_reader :position
+
+    class << self
+      def coerce(value = nil, parent = nil, colour = nil, style = nil, position = nil)
+        if value.is_a?(self)
+          value
+
+        elsif value.is_a?(Array)
+          if value.first.is_a?(self)
+            value
+
+          elsif value.first.is_a?(String)
+            value.map { |char| new(char, parent, colour, style, position) }
+
+          else
+            # ...
+
+          end
+        else
+          # ...
+
+        end
+      end
+    end
+
+    # Returns a new instance of Char.
+    #
+    # @param  value    [String]
+    # @param  parent   [Line]
+    # @param  colour   [Colour]
+    # @param  style    [Style]
+    # @param  position [Position]
+    # @return [Char]
+    def initialize(value = nil, parent = nil, colour = nil, style = nil, position = nil)
+      @value    = value
+      @parent   = parent
+      @colour   = colour
+      @style    = style
+      @position = position
+    end
+
+    # Returns log friendly output.
+    #
+    # @return [String]
+    def inspect
+      "<#{self.class.name} (value:#{@value})>"
+    end
+
+    # @return [Boolean]
+    def ==(other)
+      eql?(other)
+    end
+
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && value == other.value
+    end
+
+    # @return [String] The character.
+    def value
+      return '' unless @value
+
+      @value[0]
+    end
+
+  end # Char
+
+end # Vedeu

data/lib/vedeu/models/view/chars.rb

@@ -0,0 +1,8 @@
+require 'vedeu/models/collection'
+
+module Vedeu
+
+  class Chars < Vedeu::Model::Collection
+  end
+
+end

data/lib/vedeu/models/view/composition.rb

@@ -0,0 +1,101 @@
+require 'vedeu/dsl/composition'
+require 'vedeu/models/collection'
+require 'vedeu/presentation/presentation'
+require 'vedeu/support/common'
+
+require 'vedeu/models/view/interfaces'
+require 'vedeu/models/view/interface'
+
+module Vedeu
+
+  # A composition is a collection of interfaces.
+  #
+  # @api private
+  class Composition
+
+    include Vedeu::Presentation
+    include Vedeu::Model
+
+    attr_reader  :interfaces
+    alias_method :value, :interfaces
+
+    class << self
+
+      # @param attributes [Hash]
+      # @option attributes client []
+      # @option attributes colour []
+      # @option attributes interfaces []
+      # @option attributes style []
+      # @param block [Proc]
+      # @return [Class]
+      def build(attributes = {}, &block)
+        attrs = defaults.merge(attributes)
+
+        model = new(attrs[:interfaces], attrs[:colour], attrs[:style])
+        model.deputy(attributes[:client]).instance_eval(&block) if block_given?
+        model
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client:     nil,
+          colour:     nil,
+          interfaces: [],
+          style:      nil,
+        }
+      end
+
+    end
+
+    # Returns a new instance of Composition.
+    #
+    # @param interfaces [Interfaces]
+    # @return [Composition]
+    def initialize(interfaces = [], colour = nil, style = nil)
+      @interfaces = interfaces
+      @colour     = colour
+      @style      = style
+    end
+
+    # @param child []
+    # @return []
+    def add(child)
+      @interfaces = interfaces.add(child)
+    end
+
+    # Returns log friendly output.
+    #
+    # @return [String]
+    def inspect
+      "<#{self.class.name} (interfaces:#{interfaces.size})>"
+    end
+
+    # @return [Vedeu::Interfaces]
+    def interfaces
+      children.coerce(@interfaces, self)
+    end
+
+    private
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def child
+      Vedeu::Interface
+    end
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def children
+      Vedeu::Interfaces
+    end
+
+  end # Composition
+
+end # Vedeu

data/lib/vedeu/models/view/interface.rb

@@ -0,0 +1,215 @@
+require 'vedeu/support/common'
+require 'vedeu/support/content_geometry'
+require 'vedeu/models/model'
+require 'vedeu/presentation/presentation'
+require 'vedeu/buffers/display_buffer'
+require 'vedeu/buffers/buffer'
+
+require 'vedeu/models/view/lines'
+
+module Vedeu
+
+  # An Interface represents a portion of the terminal defined by
+  # {Vedeu::Geometry}. It is a container for {Vedeu::Line} and {Vedeu::Stream}
+  # objects.
+  #
+  # @api private
+  class Interface
+
+    extend Forwardable
+
+    include Vedeu::Common
+    include Vedeu::Model
+    include Vedeu::Presentation
+    include Vedeu::DisplayBuffer
+
+    attr_accessor :border,
+      :colour,
+      :delay,
+      :geometry,
+      :group,
+      :name,
+      :parent,
+      :style
+
+    attr_writer :lines
+
+    def_delegators :geometry,
+      :north,
+      :east,
+      :south,
+      :west,
+      :top,
+      :right,
+      :bottom,
+      :left,
+      :width,
+      :height,
+      :origin
+
+    class << self
+
+      # Build interfaces using a simple DSL.
+      # If a name is provided as part of the attributes, we check the repository
+      # for an interface of the same name and update it from the new attributes
+      # provided, or if a block is given, new parameters set via the DSL.
+      #
+      # @param attributes [Hash]
+      # @option attributes client []
+      # @option attributes colour []
+      # @option attributes lines []
+      # @option attributes name []
+      # @option attributes parent []
+      # @option attributes style []
+      # @param block [Proc]
+      # @return [Class]
+      def build(attributes = {}, &block)
+        attributes = defaults.merge(attributes)
+        model = new(attributes[:name],
+                    attributes[:lines],
+                    attributes[:parent],
+                    attributes[:colour],
+                    attributes[:style])
+        model.deputy(attributes[:client]).instance_eval(&block) if block_given?
+        model
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client: nil,
+          colour: nil,
+          lines:  [],
+          name:   '',
+          parent: nil,
+          style:  nil,
+        }
+      end
+    end
+
+    # Return a new instance of Interface.
+    #
+    # @param name [String]
+    # @param lines [Vedeu::Lines]
+    # @param parent [Vedeu::Composition]
+    # @param colour [Vedeu::Colour]
+    # @param style [Vedeu::Style]
+    # @return [Interface]
+    def initialize(name = '', lines = [], parent = nil, colour = nil, style = nil)
+      @name   = name
+      @lines  = lines
+      @parent = parent
+      @colour = colour
+      @style  = style
+
+      @border   = nil
+      @delay    = 0.0
+      @geometry = nil
+      @group    = ''
+
+      @repository = Vedeu.interfaces
+    end
+
+    # @param child []
+    # @return []
+    def add(child)
+      @lines = lines.add(child)
+    end
+
+    # @return [Hash]
+    def attributes
+      {
+        border:   border,
+        colour:   colour,
+        delay:    delay,
+        geometry: geometry,
+        group:    group,
+        name:     name,
+        parent:   parent,
+        style:    style,
+      }
+    end
+
+    # Returns a boolean indicating whether the interface has a border.
+    #
+    # @return [Boolean]
+    def border?
+      !!(border)
+    end
+
+    # @return [Vedeu::Cursor]
+    def cursor
+      Vedeu.cursors.by_name(name)
+    end
+
+    # Returns log friendly output.
+    #
+    # @return [String]
+    def inspect
+      "<#{self.class.name} (lines:#{lines.size})>"
+    end
+
+    # @return [Vedeu::Lines]
+    def lines
+      children.coerce(@lines, self)
+    end
+    alias_method :content, :lines
+    alias_method :value, :lines
+
+    # Returns a boolean indicating whether the interface has content.
+    #
+    # @return [Boolean]
+    def lines?
+      lines.any?
+    end
+
+    # @return []
+    def render
+      if border
+        border.render
+
+      else
+        viewport
+
+      end
+    end
+
+    # @return [Interface]
+    def store
+      super
+
+      store_new_buffer
+      store_refresh_events
+      store_focusable
+      store_cursor
+      store_group
+    end
+
+    # return [Array]
+    def viewport
+      Vedeu::Viewport.show(self)
+    end
+
+    private
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def child
+      Vedeu::Line
+    end
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def children
+      Vedeu::Lines
+    end
+
+  end # Interface
+
+end # Vedeu

data/lib/vedeu/models/view/interfaces.rb

@@ -0,0 +1,8 @@
+require 'vedeu/models/collection'
+
+module Vedeu
+
+  class Interfaces < Vedeu::Model::Collection
+  end
+
+end

data/lib/vedeu/models/view/line.rb

@@ -0,0 +1,134 @@
+require 'vedeu/presentation/presentation'
+
+require 'vedeu/models/view/streams'
+require 'vedeu/models/view/stream'
+
+module Vedeu
+
+  # A Line represents a single row of the terminal. It is a container for
+  # {Vedeu::Stream} objects. A line's width is determined by the
+  # {Vedeu::Interface} it belongs to.
+  #
+  # @api private
+  class Line
+
+    include Vedeu::Model
+    include Vedeu::Presentation
+
+    attr_accessor :parent,
+      :streams
+
+    alias_method :value, :streams
+
+    class << self
+
+      # @option attributes streams []
+      # @option attributes parent []
+      # @option attributes colour []
+      # @option attributes style []
+      # @option attributes client []
+      def build(attributes = {}, &block)
+        attributes = defaults.merge(attributes)
+
+        model = new(attributes[:streams],
+                    attributes[:parent],
+                    attributes[:colour],
+                    attributes[:style])
+        model.deputy(attributes[:client]).instance_eval(&block) if block_given?
+        model
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client:  nil,
+          colour:  nil,
+          parent:  nil,
+          streams: [],
+          style:   nil,
+        }
+      end
+    end
+
+    # Returns a new instance of Line.
+    #
+    # @return [Line]
+    def initialize(streams = [], parent = nil, colour = nil, style = nil)
+      @colour  = colour
+      @parent  = parent
+      @streams = streams
+      @style   = style
+    end
+
+    # @param child []
+    # @return []
+    def add(child)
+      @streams = streams.add(child)
+    end
+
+    # Returns an array of all the characters with formatting for this line.
+    #
+    # @return [Array]
+    # @see Vedeu::Stream
+    def chars
+      return [] if empty?
+
+      streams.map(&:chars).flatten
+    end
+
+    # Returns a boolean indicating whether the line has content.
+    #
+    # @return [Boolean]
+    def empty?
+      streams.empty?
+    end
+
+    # Returns log friendly output.
+    #
+    # @return [String]
+    def inspect
+      "<#{self.class.name} (streams:#{streams.size})>"
+    end
+
+    # Returns the size of the content in characters without formatting.
+    #
+    # @return [Fixnum]
+    def size
+      streams.map(&:size).inject(0, :+) { |sum, x| sum += x }
+    end
+
+    # @return [Vedeu::Streams]
+    def streams
+      children.coerce(@streams, self)
+    end
+
+    # Delegate to Vedeu::Interface#width if available.
+    #
+    # @return [Fixnum]
+    def width
+      parent.width if parent
+    end
+
+    private
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def child
+      Vedeu::Stream
+    end
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def children
+      Vedeu::Streams
+    end
+
+  end # Line
+
+end # Vedeu

data/lib/vedeu/models/view/lines.rb

@@ -0,0 +1,8 @@
+require 'vedeu/models/collection'
+
+module Vedeu
+
+  class Lines < Vedeu::Model::Collection
+  end
+
+end

data/lib/vedeu/models/view/stream.rb

@@ -0,0 +1,144 @@
+require 'vedeu/presentation/presentation'
+require 'vedeu/models/view/char'
+
+module Vedeu
+
+  # A Stream can represent a character or collection of characters as part of a
+  # {Vedeu::Line} which you wish to colour and style independently of the other
+  # characters in that line.
+  #
+  # @api private
+  class Stream
+
+    include Vedeu::Model
+    include Vedeu::Presentation
+
+    attr_accessor :parent,
+      :value
+
+    alias_method :content, :value
+    alias_method :data,    :value
+    alias_method :text,    :value
+
+    class << self
+
+      # @option attributes value []
+      # @option attributes parent []
+      # @option attributes colour []
+      # @option attributes style []
+      # @option attributes client []
+      def build(attributes = {}, &block)
+        attributes = defaults.merge(attributes)
+
+        model = new(attributes[:value],
+                    attributes[:parent],
+                    attributes[:colour],
+                    attributes[:style])
+        model.deputy(attributes[:client]).instance_eval(&block) if block_given?
+        model
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client: nil,
+          colour: nil,
+          parent: nil,
+          style:  nil,
+          value:  '',
+        }
+      end
+
+    end
+
+    # Returns a new instance of Stream.
+    #
+    # @param value [String]
+    # @param parent [Vedeu::Line]
+    # @param colour [Vedeu::Colour]
+    # @param style [Vedeu::Style]
+    # @return [Vedeu::Stream]
+    def initialize(value = '', parent = nil, colour = nil, style = nil)
+      @value  = value
+      @parent = parent
+      @colour = colour
+      @style  = style
+    end
+
+    # @param child [Vedeu::Stream]
+    # @return [Vedeu::Line]
+    def add(child)
+      parent.add(child)
+    end
+
+    # Returns an array of characters, each element is the escape sequences of
+    # colours and styles for this stream, the character itself, and the escape
+    # sequences of colours and styles for the parent of the stream
+    # ({Vedeu::Line}).
+    #
+    # @return [Array]
+    def chars
+      return [] if value.empty?
+
+      value.chars.map do |char|
+        child.new(char, parent, colour, style, nil).to_s
+      end
+    end
+
+    # Returns a boolean indicating whether the stream has content.
+    #
+    # @return [Boolean]
+    def empty?
+      value.empty?
+    end
+
+    # Returns log friendly output.
+    #
+    # @return [String]
+    def inspect
+      "<#{self.class.name} (value:#{value}, size:#{size})>"
+    end
+
+    # Returns the size of the content in characters without formatting.
+    #
+    # @return [Fixnum]
+    def size
+      value.size
+    end
+
+    # @return [String]
+    def value
+      # Vedeu::Char.coerce(@value, parent, colour, style)
+      @value
+    end
+
+    # Delegate to Vedeu::Line#width if available.
+    #
+    # @return [Fixnum]
+    def width
+      parent.width if parent
+    end
+
+    private
+
+    # Return the class name for the children on this model.
+    #
+    # @return [Class]
+    def child
+      Vedeu::Char
+    end
+
+    # Return the class name for the collection of children on this model.
+    #
+    # @return [Class]
+    def children
+      Vedeu::Chars
+    end
+
+  end # Stream
+
+end # Vedeu

data/lib/vedeu/models/view/streams.rb

@@ -0,0 +1,8 @@
+require 'vedeu/models/collection'
+
+module Vedeu
+
+  class Streams < Vedeu::Model::Collection
+  end
+
+end