vedeu 0.5.4 → 0.5.5

data/lib/vedeu/models/escape.rb

@@ -27,7 +27,7 @@ module Vedeu
 
     # An object is equal when its values are the same.
     #
-    # @param other [Vedeu::Char]
+    # @param other [Vedeu::Views::Char]
     # @return [Boolean]
     def eql?(other)
       self.class == other.class && value == other.value

data/lib/vedeu/models/interface.rb

@@ -1,19 +1,14 @@
 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.
+  # {Vedeu::Geometry}.
   #
   class Interface
 
     include Vedeu::Model
     include Vedeu::Presentation
-    include Vedeu::DisplayBuffer
     include Vedeu::Toggleable
 
-    collection Vedeu::Lines
-    member     Vedeu::Line
-
     # @!attribute [rw] client
     # @return [Fixnum|Float]
     attr_accessor :client
@@ -31,7 +26,7 @@ module Vedeu
     attr_accessor :name
 
     # @!attribute [rw] parent
-    # @return [Vedeu::Composition]
+    # @return [Vedeu::Views::Composition]
     attr_accessor :parent
 
     # @!attribute [rw] zindex
@@ -42,10 +37,6 @@ module Vedeu
     # @return [Hash]
     attr_reader :attributes
 
-    # @!attribute [w] lines
-    # @return [Array<Vedeu::Line>]
-    attr_writer :lines
-
     # Return a new instance of Vedeu::Interface.
     #
     # @param attributes [Hash]
@@ -53,9 +44,8 @@ module Vedeu
     # @option attributes colour [Vedeu::Colour]
     # @option attributes delay [Float]
     # @option attributes group [String]
-    # @option attributes lines [Vedeu::Lines]
     # @option attributes name [String]
-    # @option attributes parent [Vedeu::Composition]
+    # @option attributes parent [Vedeu::Views::Composition]
     # @option attributes repository [Vedeu::Interfaces]
     # @option attributes style [Vedeu::Style]
     # @option attributes visible [Boolean]
@@ -67,13 +57,6 @@ module Vedeu
       @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    # @param child [Vedeu::Line]
-    # @return [void]
-    def add(child)
-      @lines = lines.add(child)
-    end
-    alias_method :<<, :add
-
     # Hide a named interface buffer, or without a name, the buffer of the
     # currently focussed interface.
     #
@@ -99,42 +82,6 @@ module Vedeu
       '>'
     end
 
-    # @return [Vedeu::Lines]
-    def lines
-      collection.coerce(@lines, self)
-    end
-    alias_method :value, :lines
-
-    # Returns a boolean indicating whether the interface has content.
-    #
-    # @return [Boolean]
-    def lines?
-      lines.any?
-    end
-
-    # Returns a boolean indicating whether the interface belongs to a
-    # group.
-    #
-    # @return [Boolean]
-    def group?
-      !group.nil? && !group.empty?
-    end
-
-    # @return [Array<Array<Vedeu::Char>>]
-    def render
-      return [] unless visible?
-
-      output = [
-        Vedeu.trigger(:_hide_cursor_, name),
-        Vedeu::Clear::NamedInterface.render(name),
-        Vedeu::Viewport.render(self),
-        Vedeu.borders.by_name(name).render,
-        Vedeu.trigger(:_show_cursor_, name)
-      ]
-
-      output
-    end
-
     # Show the named interface buffer, or without a name, the buffer of the
     # currently focussed interface.
     #
@@ -160,7 +107,6 @@ module Vedeu
                                          foreground: :default),
         delay:      0.0,
         group:      '',
-        lines:      [],
         name:       '',
         parent:     nil,
         repository: Vedeu.interfaces,

data/lib/vedeu/models/menu.rb

@@ -54,7 +54,7 @@ module Vedeu
     def self.menu(name = '', &block)
       fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
-      build({ name: name }, &block).store
+      build(name: name, &block).store
     end
 
     # Returns a new instance of Vedeu::Menu.

data/lib/vedeu/models/views/all.rb

@@ -0,0 +1,22 @@
+module Vedeu
+
+  # View related models.
+  #
+  module Views
+
+  end # Views
+
+end # Vedeu
+
+require 'vedeu/models/interface_collection'
+require 'vedeu/models/views/char'
+require 'vedeu/models/views/chars'
+require 'vedeu/models/views/stream'
+require 'vedeu/models/views/streams'
+require 'vedeu/models/views/line'
+require 'vedeu/models/views/lines'
+require 'vedeu/models/interface'
+require 'vedeu/models/interfaces'
+require 'vedeu/models/views/view_collection'
+require 'vedeu/models/views/view'
+require 'vedeu/models/views/composition'

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

@@ -0,0 +1,175 @@
+module Vedeu
+
+  module Views
+
+    # A Char represents a single character of the terminal. It is a container
+    # for the a single character in a {Vedeu::Views::Stream}.
+    #
+    # Though a multi-character String can be passed as a value, only the first
+    # character is returned in the escape sequence.
+    #
+    class Char
+
+      include Comparable
+      include Vedeu::Presentation
+
+      # @!attribute [rw] border
+      # @return [NilClass|Symbol]
+      attr_accessor :border
+
+      # @!attribute [rw] parent
+      # @return [Vedeu::Views::Line]
+      attr_accessor :parent
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # @!attribute [r] position
+      # @return [Vedeu::Position]
+      attr_reader :position
+
+      # @!attribute [w] value
+      # @return [String]
+      attr_writer :value
+
+      # Returns a new instance of Vedeu::Views::Char.
+      #
+      # @param attributes [Hash]
+      # @option attributes value    [String]
+      # @option attributes parent   [Vedeu::Views::Line]
+      # @option attributes colour   [Vedeu::Colour]
+      # @option attributes style    [Vedeu::Style]
+      # @option attributes position [Vedeu::Position]
+      # @option attributes border   [NilClass|Symbol] A symbol representing the
+      #   border 'piece' this Vedeu::Views::Char represents.
+      # @return [Vedeu::Views::Char]
+      def initialize(attributes = {})
+        @attributes = attributes
+        @border     = @attributes[:border]
+        @parent     = @attributes[:parent]
+        @value      = @attributes[:value]
+      end
+
+      # When {Vedeu::Viewport#show} has less lines that required to fill
+      # the visible area of the interface, it creates a line that contains a
+      # single {Vedeu::Views::Char} containing a space (0x20); later, attempts
+      # to call `#chars` on an expected {Vedeu::Views::Line} and fail; this
+      # method fixes that.
+      #
+      # @return [Array]
+      def chars
+        []
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Views::Char]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && value == other.value &&
+          position == other.position
+      end
+      alias_method :==, :eql?
+
+      # Override Ruby's Object#inspect method to provide a more helpful output.
+      #
+      # @return [String]
+      def inspect
+        "<Vedeu::Views::Char '#{Vedeu::Esc.escape(to_s)}'>"
+      end
+
+      # @return [Vedeu::Position]
+      def position
+        @position = Vedeu::Position.coerce(@attributes[:position])
+      end
+
+      # Sets the position of the Vedeu::Views::Char.
+      #
+      # @param value [Vedeu::Position]
+      # @return [Vedeu::Position]
+      def position=(value)
+        @position = @attributes[:position] = Vedeu::Position.coerce(value)
+      end
+
+      # @return [String]
+      def value
+        if border
+          Vedeu::Esc.border { @value }
+
+        else
+          @value
+
+        end
+      end
+
+      # Returns the x position for the Vedeu::Views::Char when set.
+      #
+      # @return [Fixnum|NilClass]
+      def x
+        position.x if position
+      end
+
+      # Returns the y position for the Vedeu::Views::Char when set.
+      #
+      # @return [Fixnum|NilClass]
+      def y
+        position.y if position
+      end
+
+      # Returns a Hash of all the values before coercion.
+      #
+      # @note
+      #   From this hash we should be able to construct a new instance of
+      #   Vedeu::Views::Char, however, at the moment, `:parent` cannot be
+      #   coerced.
+      #
+      # @return [Hash]
+      def to_hash
+        {
+          border:   border.to_s,
+          colour:   colour_to_hash,
+          parent:   parent_to_hash,
+          position: position_to_hash,
+          style:    style.to_s,
+          value:    value,
+        }
+      end
+
+      # @return [String]
+      def to_html
+        @to_html ||= Vedeu::HTMLChar.render(self)
+      end
+
+      private
+
+      # @return [Hash]
+      def colour_to_hash
+        {
+          background: background.to_s,
+          foreground: foreground.to_s,
+        }
+      end
+
+      # @return [Hash]
+      def parent_to_hash
+        {
+          background: parent_background.to_s,
+          foreground: parent_foreground.to_s,
+          style:      parent_style.to_s,
+        }
+      end
+
+      # @return [Hash]
+      def position_to_hash
+        {
+          y: y,
+          x: x,
+        }
+      end
+
+    end # Char
+
+  end # Views
+
+end # Vedeu

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

@@ -0,0 +1,13 @@
+module Vedeu
+
+  module Views
+
+    # A collection of {Vedeu::Views::Char} instances.
+    #
+    class Chars < Vedeu::Collection
+
+    end # Chars
+
+  end # Views
+
+end # Vedeu

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

@@ -0,0 +1,73 @@
+module Vedeu
+
+  module Views
+
+    # A composition is a collection of interfaces.
+    #
+    class Composition
+
+      include Vedeu::Model
+      include Vedeu::Presentation
+
+      collection Vedeu::Views::ViewCollection
+      member     Vedeu::Views::View
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # Returns a new instance of Vedeu::Views::Composition.
+      #
+      # @param attributes [Hash]
+      # @option attributes client [void]
+      # @option attributes colour [Vedeu::Colour]
+      # @option attributes views [void]
+      # @option attributes repository [void]
+      # @option attributes style [Vedeu::Style]
+      # @return [Vedeu::Views::Composition]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # @param child [Vedeu::Views::View]
+      # @return [Vedeu::InterfaceCollection]
+      def add(child)
+        @views = collection.coerce(@views, self).add(child)
+      end
+
+      # @return [Vedeu::Views::Views]
+      def views
+        collection.coerce(@views, self)
+      end
+      alias_method :value, :views
+
+      # Composition objects do not have a parent.
+      #
+      # @return [NilClass]
+      def parent
+        nil
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client:     nil,
+          colour:     nil,
+          views:      [],
+          style:      nil,
+        }
+      end
+
+    end # Composition
+
+  end # Views
+
+end # Vedeu

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

@@ -0,0 +1,111 @@
+module Vedeu
+
+  module Views
+
+    # Represents a single row of the terminal. It is a container for
+    # {Vedeu::Views::Stream} objects. A line's width is determined by the
+    # {Vedeu::Geometry} it belongs to.
+    #
+    class Line
+
+      include Vedeu::Model
+      include Vedeu::Presentation
+
+      collection Vedeu::Views::Streams
+      member     Vedeu::Views::Stream
+
+      # @!attribute [rw] parent
+      # @return [Vedeu::Views::View]
+      attr_accessor :parent
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # Returns a new instance of Vedeu::Views::Line.
+      #
+      # @param attributes [Hash]
+      # @option attributes streams [Vedeu::Views::Streams]
+      # @option attributes parent [Vedeu::Views::View]
+      # @option attributes colour [Vedeu::Colour]
+      # @option attributes style [Vedeu::Style]
+      # @return [Vedeu::Views::Line]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # @param child [void]
+      # @return [void]
+      def add(child)
+        @_streams = @streams = collection.coerce(streams, self).add(child)
+      end
+      alias_method :<<, :add
+
+      # Returns an array of all the characters with formatting for this line.
+      #
+      # @return [Array]
+      # @see Vedeu::Views::Stream
+      def chars
+        return [] if empty?
+
+        @chars ||= streams.flat_map(&:chars)
+      end
+
+      # Returns a boolean indicating whether the line has content.
+      #
+      # @return [Boolean]
+      def empty?
+        streams.empty?
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Collection]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && streams == other.streams
+      end
+      alias_method :==, :eql?
+
+      # @return [NilClass|String]
+      def name
+        parent.name if parent
+      end
+
+      # Returns the size of the content in characters without formatting.
+      #
+      # @return [Fixnum]
+      def size
+        streams.map(&:size).inject(0, :+)
+      end
+
+      # @return [Vedeu::Views::Streams]
+      def streams
+        @_streams ||= collection.coerce(@streams, self)
+      end
+      alias_method :value, :streams
+
+      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 # Line
+
+  end # Views
+
+end # Vedeu