vedeu 0.6.71 → 0.7.0

data/lib/vedeu/cells/borders/right_vertical.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of the
+    # right vertical border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class RightVertical < Vedeu::Cells::Vertical
+
+      # @return [Symbol]
+      def type
+        :right_vertical
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(value: Vedeu::EscapeSequences::Borders.vertical)
+      end
+
+    end # RightVertical
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/top_horizontal.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of the
+    # top horizontal border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class TopHorizontal < Vedeu::Cells::Horizontal
+
+      # @return [Symbol]
+      def type
+        :top_horizontal
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(value: Vedeu::EscapeSequences::Borders.horizontal)
+      end
+
+    end # TopHorizontal
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/top_left.rb

@@ -0,0 +1,34 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw the top left
+    # border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class TopLeft < Vedeu::Cells::Border
+
+      # @return [Vedeu::Geometries::Position]
+      def position
+        @position = defaults[:position]
+      end
+
+      # @return [Symbol]
+      def type
+        :top_left
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(position: Vedeu::Geometries::Position.coerce([y, x]),
+                     value:    Vedeu::EscapeSequences::Borders.top_left)
+      end
+
+    end # TopLeft
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/top_right.rb

@@ -0,0 +1,34 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw the top right
+    # border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class TopRight < Vedeu::Cells::Border
+
+      # @return [Vedeu::Geometries::Position]
+      def position
+        @position = defaults[:position]
+      end
+
+      # @return [Symbol]
+      def type
+        :top_right
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(position: Vedeu::Geometries::Position.coerce([y, xn]),
+                     value:    Vedeu::EscapeSequences::Borders.top_right)
+      end
+
+    end # TopRight
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/vertical.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # vertical border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class Vertical < Vedeu::Cells::Border
+
+      # @return [Symbol]
+      def type
+        :vertical
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(value: Vedeu::EscapeSequences::Borders.vertical)
+      end
+
+    end # Vertical
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/char.rb

@@ -0,0 +1,24 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # with a custom value, colour and style.
+    #
+    # The Vedeu::Cells::Char object represents an alpha-numeric
+    # character.
+    #
+    # @api private
+    #
+    class Char < Vedeu::Cells::Empty
+
+      # @return [Boolean]
+      def cell?
+        false
+      end
+
+    end # Char
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/clear.rb

@@ -0,0 +1,29 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # with a custom value, colour and style.
+    #
+    # The Vedeu::Cells::Clear object represents a cleared cell using
+    # the space character.
+    #
+    # @api private
+    #
+    class Clear < Vedeu::Cells::Empty
+
+      # @return [Boolean]
+      def cell?
+        false
+      end
+
+      # @return [String]
+      def value
+        ' '.freeze
+      end
+
+    end # Clear
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/empty.rb

@@ -0,0 +1,78 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # with a custom value, colour and style.
+    #
+    # The Vedeu::Cells::Empty object represents an empty cell with no
+    # content and is the basis of all the Vedeu::Cells objects.
+    #
+    # @api private
+    #
+    class Empty
+
+      include Comparable
+      include Vedeu::Common
+      include Vedeu::Presentation
+      include Vedeu::Repositories::Defaults
+
+      # @!attribute [r] name
+      # @return [String|Symbol] The name of the interface/view this
+      #   cell belongs to.
+      attr_reader :name
+
+      # @!attribute [r] value
+      # @return [String]
+      attr_reader :value
+
+      # @return [Boolean]
+      def cell?
+        true
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [void]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class    &&
+          position == other.position &&
+          value    == other.value    &&
+          colour   == other.colour
+      end
+      alias_method :==, :eql?
+
+      private
+
+      # @return [Hash<Symbol => Hash<void>|NilClass|String>]
+      def defaults
+        {
+          colour:   {},
+          name:     '',
+          position: nil,
+          style:    '',
+          value:    '',
+        }
+      end
+
+      # @return [Vedeu::Borders::Border]
+      def border
+        Vedeu.borders.by_name(name)
+      end
+
+      # @return [Vedeu::Geometries::Geometry]
+      def geometry
+        Vedeu.geometries.by_name(name)
+      end
+
+      # @return [Vedeu::Interfaces::Interface]
+      def interface
+        Vedeu.interfaces.by_name(name)
+      end
+
+    end # Empty
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/escape.rb

@@ -0,0 +1,24 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # with a custom value, colour and style.
+    #
+    # The Vedeu::Cells::Escape object represents an escape sequence as
+    # a single character, meaning they will behave dependent on the
+    # context in which they are used.
+    #
+    # (In a terminal, an escape sequence makes sense, when a view is
+    # being rendered as HTML, the sequence may be meaningless, for
+    # example; the sequence to show or hide the cursor.)
+    #
+    # @api private
+    #
+    class Escape < Vedeu::Cells::Empty
+
+    end # Escape
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/html.rb

@@ -0,0 +1,19 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # with a custom value, colour and style.
+    #
+    # The Vedeu::Cells::HTML object represents a cell as a snippet
+    # of HTML. A table cell perhaps: `<td>a</td>`.
+    #
+    # @api private
+    #
+    class HTML < Vedeu::Cells::Empty
+
+    end # HTML
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/json.rb

@@ -0,0 +1,19 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # with a custom value, colour and style.
+    #
+    # The Vedeu::Cells::JSON object represents a cell as a snippet of
+    # JSON.
+    #
+    # @api private
+    #
+    class JSON < Vedeu::Cells::Empty
+
+    end # JSON
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/colours/colour.rb

@@ -87,15 +87,15 @@ module Vedeu
 
       # @return [Vedeu::Colours::Background]
       def background
-        @background = Vedeu::Colours::Background.coerce(@background)
+        @_background ||= Vedeu::Colours::Background.coerce(@background)
       end
 
       # Converts the value into a Vedeu::Colours::Background.
       #
       # @param value [String]
-      # @return [String]
+      # @return [Vedeu::Colours::Foreground]
       def background=(value)
-        @background = Vedeu::Colours::Background.coerce(value)
+        @_background = @background = Vedeu::Colours::Background.coerce(value)
       end
 
       # An object is equal when its values are the same.
@@ -110,15 +110,15 @@ module Vedeu
 
       # @return [Vedeu::Colours::Foreground]
       def foreground
-        @foreground = Vedeu::Colours::Foreground.coerce(@foreground)
+        @_foreground ||= Vedeu::Colours::Foreground.coerce(@foreground)
       end
 
       # Converts the value into a Vedeu::Colours::Foreground.
       #
       # @param value [String]
-      # @return [String]
+      # @return [Vedeu::Colours::Foreground]
       def foreground=(value)
-        @foreground = Vedeu::Colours::Foreground.coerce(value)
+        @_foreground = @foreground = Vedeu::Colours::Foreground.coerce(value)
       end
 
       # Returns both or either of the converted attributes into a

data/lib/vedeu/common.rb

@@ -15,6 +15,15 @@ module Vedeu
       !present?(variable)
     end
 
+    # Converts one class into another.
+    #
+    # @param klass [Class] The class to become an instance of.
+    # @param attributes [Hash] The attributes of klass.
+    # @return [Class] Returns a new instance of klass.
+    def become(klass, attributes)
+      klass.new(attributes)
+    end
+
     # Removes the module part from the expression in the string.
     #
     # @example

data/lib/vedeu/cursors/move.rb

@@ -14,9 +14,8 @@ module Vedeu
       def_delegators :cursor,
                      :visible?
 
-      # @param name [String|Symbol]
-      # @param direction [Symbol]
-      # @return [Vedeu::Cursors::Cursor]
+      # @param (see #initialize)
+      # @return (see #move)
       def self.move(name, direction)
         new(name, direction).move
       end

data/lib/vedeu/editor/insert.rb

@@ -9,7 +9,7 @@ module Vedeu
     class Insert
 
       # @param (see #initialize)
-      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @return (see #insert)
       def self.into(collection, entity, index = nil, size = 0)
         new(collection, entity, index, size).insert
       end

data/lib/vedeu/editor/item.rb

@@ -8,9 +8,8 @@ module Vedeu
     #
     class Item
 
-      # @param collection [Vedeu::Editor::Line|Vedeu::Editor::Lines]
-      # @param index [Fixnum]
-      # @return [String|Vedeu::Editor::Line]
+      # @param (see #initialize)
+      # @return (see #by_index)
       def self.by_index(collection, index = nil)
         new(collection, index).by_index
       end