vedeu 0.4.7 → 0.4.8

data/lib/vedeu/models/cell.rb

@@ -0,0 +1,68 @@
+module Vedeu
+
+  # A Cell represents a single square of the terminal.
+  #
+  class Cell
+
+    # @!attribute [r] background
+    # @return [NilClass|String]
+    attr_reader :background
+
+    # @!attribute [r] foreground
+    # @return [NilClass|String]
+    attr_reader :foreground
+
+    # @!attribute [r] style
+    # @return [NilClass|Array<Symbol|String>|Symbol|String]
+    attr_reader :style
+
+    # @!attribute [r] value
+    # @return [NilClass|String]
+    attr_reader :value
+
+    # @!attribute [r] x
+    # @return [NilClass|Fixnum]
+    attr_reader :x
+
+    # @!attribute [r] y
+    # @return [NilClass|Fixnum]
+    attr_reader :y
+
+    # @param attributes [Hash<Symbol => Array<Symbol|String>, Fixnum, String, Symbol]
+    # @option attributes background [NilClass|String]
+    # @option attributes foreground [NilClass|String]
+    # @option attributes style [NilClass|Array<Symbol|String>|Symbol|String]
+    # @option attributes value [NilClass|String]
+    # @option attributes x [NilClass|Fixnum]
+    # @option attributes y [NilClass|Fixnum]
+    # @return [Vedeu::Cell]
+    def initialize(attributes = {})
+      @background = attributes[:background]
+      @foreground = attributes[:foreground]
+      @style      = attributes[:style]
+      @value      = attributes[:value]
+      @x          = attributes[:x]
+      @y          = attributes[:y]
+    end
+
+    # @param other [Vedeu::Cell]
+    # @return [Boolean]
+    def ==(other)
+      eql?(other)
+    end
+
+    # @param other [Vedeu::Cell]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class      &&
+      background == other.background &&
+      foreground == other.foreground &&
+      style      == other.style      &&
+      value      == other.value      &&
+      x          == other.x          &&
+      y          == other.y
+    end
+
+  end # Cell
+
+end # Vedeu

data/lib/vedeu/models/interface.rb

@@ -1,4 +1,4 @@
-require 'vedeu/geometry/content_geometry'
+require 'vedeu/geometry/content'
 require 'vedeu/models/all'
 require 'vedeu/output/presentation'
 require 'vedeu/buffers/display_buffer'
@@ -132,7 +132,7 @@ module Vedeu
 
     # @return [Vedeu::Geometry]
     def geometry
-      Vedeu.geometries.find(name)
+      @geometry ||= Vedeu.geometries.find(name)
     end
 
     # @return [Vedeu::Lines]
@@ -148,6 +148,8 @@ module Vedeu
     def lines?
       lines.any?
     end
+    alias_method :content?, :lines?
+    alias_method :value?, :lines?
 
     # @return [Interface]
     def store

data/lib/vedeu/output/all.rb

@@ -8,7 +8,6 @@ require 'vedeu/output/border'
 require 'vedeu/output/colour'
 require 'vedeu/output/compositor'
 
-require 'vedeu/output/char_builder'
 require 'vedeu/output/clear'
 
 require 'vedeu/output/presentation'

data/lib/vedeu/output/border.rb

@@ -1,3 +1,4 @@
+require 'vedeu/repositories/all'
 require 'vedeu/dsl/components/all'
 
 module Vedeu
@@ -33,18 +34,22 @@ module Vedeu
     # @!attribute [rw] show_bottom
     # @return [Boolean]
     attr_accessor :show_bottom
+    alias_method :bottom?, :show_bottom
 
     # @!attribute [rw] show_left
     # @return [Boolean]
     attr_accessor :show_left
+    alias_method :left?, :show_left
 
     # @!attribute [rw] show_right
     # @return [Boolean]
     attr_accessor :show_right
+    alias_method :right?, :show_right
 
     # @!attribute [rw] show_top
     # @return [Boolean]
     attr_accessor :show_top
+    alias_method :top?, :show_top
 
     # @!attribute [rw] top_left
     # @return [String]
@@ -69,17 +74,12 @@ module Vedeu
     # @!attribute [r] enabled
     # @return [Boolean]
     attr_reader :enabled
+    alias_method :enabled?, :enabled
 
     # @!attribute [r] style
     # @return [Style]
     attr_reader :style
 
-    alias_method :enabled?, :enabled
-    alias_method :bottom?,  :show_bottom
-    alias_method :left?,    :show_left
-    alias_method :right?,   :show_right
-    alias_method :top?,     :show_top
-
     # Returns a new instance of Border.
     #
     # @param attributes [Hash]

data/lib/vedeu/output/clear.rb

@@ -4,8 +4,6 @@ module Vedeu
   #
   class Clear
 
-    include Vedeu::CharBuilder
-
     # Clears the area defined by the interface.
     #
     # @return [Array|String]
@@ -28,9 +26,12 @@ module Vedeu
     #
     # @return [Array<Array<Vedeu::Char>>]
     def clear
-      out = interface.height.times.inject([]) do |row, iy|
-        row << interface.width.times.inject([]) do |column, ix|
-          column << char_builder(' ', iy, ix)
+      Array.new(interface.height) do |iy|
+        Array.new(interface.width) do |ix|
+          Vedeu::Char.new({ value:    ' ',
+                            colour:   interface.colour,
+                            style:    interface.style,
+                            position: Vedeu::IndexPosition[iy, ix, interface.top, interface.left] })
         end
       end
     end

data/lib/vedeu/output/colour.rb

@@ -63,7 +63,7 @@ module Vedeu
 
     # The default values for a new instance of this class.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => String>]
     def defaults
       {
         foreground: '',

data/lib/vedeu/output/esc.rb

@@ -40,7 +40,7 @@ module Vedeu
     #   :light_cyan
     #   :white
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => Fixnum>]
     def codes
       {
         black:         30,
@@ -67,7 +67,7 @@ module Vedeu
     # Produces the background named colour escape sequence hash from the
     # foreground escape sequence hash.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => Fixnum>]
     def background_codes
       Vedeu::Esc.codes.inject({}) { |h, (k, v)| h.merge!(k => v + 10) }
     end

data/lib/vedeu/output/output.rb

@@ -11,8 +11,6 @@ module Vedeu
   #
   class Output
 
-    include Vedeu::CharBuilder
-
     # Writes content (the provided interface object with associated lines,
     # streams, colours and styles) to the area defined by the interface.
     #
@@ -65,7 +63,7 @@ module Vedeu
         row = []
         line.each_with_index do |char, ix|
           row << if char.x != ix || char.y != iy
-            char.position = origin(iy, ix)
+            char.position = Vedeu::IndexPosition[iy, ix, interface.top, interface.left]
             char
 
           else

data/lib/vedeu/output/style.rb

@@ -17,7 +17,7 @@ module Vedeu
 
     # Return a new instance of Vedeu::Style.
     #
-    # @param value [Array|Array<String>|Array<Symbol>|String|Symbol]
+    # @param value [Array<String|Symbol>|String|Symbol]
     #   The style value or a collection of values.
     # @return [Style]
     def initialize(value = nil)
@@ -26,7 +26,7 @@ module Vedeu
 
     # Return an attributes hash for this class.
     #
-    # @return [Hash]
+    # @return [Array<String|Symbol>|String|Symbol]
     def attributes
       {
         style: value

data/lib/vedeu/output/text.rb

@@ -54,6 +54,8 @@ module Vedeu
       options[:anchor]
     end
 
+    # The string padded to width, centralized.
+    #
     # @return [String]
     def centre
       string.center(width, pad)
@@ -61,7 +63,7 @@ module Vedeu
 
     # The default values for a new instance of this class.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => NilClass, String, Symbol>]
     def defaults
       {
         anchor: :left,
@@ -70,36 +72,50 @@ module Vedeu
       }
     end
 
+    # The string padded to width, left justified.
+    #
     # @return [String]
     def left
       string.ljust(width, pad)
     end
 
+    # The character to use for padding the string.
+    #
     # @return [String]
     def pad
       options[:pad]
     end
 
+    # The string padded to width, right justified.
+    #
     # @return [String]
     def right
       string.rjust(width, pad)
     end
 
+    # The string, coerced.
+    #
     # @return [String]
     def string
       value.to_s
     end
 
+    # Return a boolean indicating that the string is greater than the width.
+    #
     # @return [Boolean]
     def truncate?
       string.size > width
     end
 
+    # Return the string truncated to the width.
+    #
     # @return [String]
     def truncated
       string.slice(0, width)
     end
 
+    # Return the width.
+    #
     # @return [Fixnum]
     def width
       options[:width]

data/lib/vedeu/output/translator.rb

@@ -124,17 +124,10 @@ module Vedeu
       [numbered_prefix, css_to_numbered, 'm'].join
     end
 
-    # Returns a boolean indicated whether the colour is an HTML/CSS colour.
-    #
-    # @return [Boolean]
-    def rgb?
-      colour.is_a?(String) && valid_rgb?
-    end
-
     # Returns a boolean indicated whether the colour is a valid HTML/CSS colour.
     #
     # @return [Boolean]
-    def valid_rgb?
+    def rgb?
       !!(colour =~ /^#([A-Fa-f0-9]{6})$/)
     end
 

data/lib/vedeu/output/virtual_terminal.rb

@@ -91,7 +91,7 @@ module Vedeu
     # @param data [Vedeu::Char]
     # @return [Vedeu::Char]
     def write(y, x, data)
-      return false unless read(y, x).is_a?(Vedeu::Char)
+      return false unless read(y, x).is_a?(Vedeu::Cell)
 
       cy, cx = Vedeu::PositionIndex[y, x]
       cells[cy][cx] = data
@@ -109,10 +109,10 @@ module Vedeu
       from[which] || []
     end
 
-    # @return [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Cell>>]
     # @see {Vedeu::VirtualTerminal#cells}
     def new_virtual_terminal
-      Array.new(height) { Array.new(width) { Vedeu::Char.new } }
+      Array.new(height) { Array.new(width) { Vedeu::Cell.new } }
     end
 
   end # VirtualTerminal

data/lib/vedeu/output/wordwrap.rb

@@ -142,7 +142,7 @@ module Vedeu
       options.fetch(:width)
     end
 
-    # @return [Hash]
+    # @return [Hash<Symbol => Fixnum, String, Symbol>]
     def defaults
       {
         ellipsis: '...',

data/lib/vedeu/repositories/model.rb

@@ -44,7 +44,7 @@ module Vedeu
 
       # The default values for a new instance of this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => NilClass, String>]
       def defaults
         {
           client:    nil,

data/lib/vedeu/repositories/repository.rb

@@ -62,7 +62,7 @@ module Vedeu
     #
     # @param name [String]
     # @raise [ModelNotFound] When the model cannot be found with this name.
-    # @return [Hash]
+    # @return [Hash<String => Object>]
     def find(name)
       storage.fetch(name) do
         fail ModelNotFound, "Cannot find model by name: '#{name}'"

data/lib/vedeu/support/log.rb

@@ -141,7 +141,7 @@ module Vedeu
         Vedeu::Esc.send(message_types.fetch(type, :default)) { "[#{type}]".ljust(9) }
       end
 
-      # @return [Hash]
+      # @return [Hash<Symbol => Symbol>]
       def message_types
         {
           config: :yellow,

data/lib/vedeu/support/trace.rb

@@ -4,6 +4,7 @@ require 'vedeu/support/log'
 
 module Vedeu
 
+  # :nocov:
   # This class currently provides the means to trace each method call which
   # occurs inside Vedeu. This is very useful (to me!) for debugging. Running
   # this will make your application less responsive, and the tests
@@ -194,7 +195,7 @@ module Vedeu
         # 'Vedeu::Config::CLI',
         'Vedeu::Configuration',
         # 'Vedeu::Console',
-        # 'Vedeu::ContentGeometry',
+        # 'Vedeu::Content',
         # 'Vedeu::Coordinate',
         # 'Vedeu::Cursor',
         # 'Vedeu::DisplayBuffer',
@@ -233,7 +234,7 @@ module Vedeu
         # 'Vedeu::Menus',
         # 'Vedeu::Model',
         # 'Vedeu::Collection',
-        # 'Vedeu::MoveCursor',
+        # 'Vedeu::Move',
         # 'Vedeu::Node',
         # 'Vedeu::Output',
         'Vedeu::Position',
@@ -249,7 +250,7 @@ module Vedeu
         'Vedeu::Style',
         'Vedeu::Terminal',
         # 'Vedeu::Text',
-        # 'Vedeu::ToggleCursor',
+        # 'Vedeu::Toggle',
         'Vedeu::Trace',
         'Vedeu::Translator',
         # 'Vedeu::Traps',
@@ -263,5 +264,6 @@ module Vedeu
     end
 
   end # Trace
+  # :nocov:
 
 end # Vedeu

data/test/lib/vedeu/cursor/{move_cursor_test.rb → move_test.rb}

@@ -2,12 +2,12 @@ require 'test_helper'
 
 module Vedeu
 
-  describe MoveCursor do
+  describe Move do
 
-    let(:described) { Vedeu::MoveCursor }
+    let(:described) { Vedeu::Move }
     let(:instance)  { described.new(cursor, interface, dy, dx) }
     let(:cursor)    {
-      Cursor.new({ name: 'MoveCursor',
+      Cursor.new({ name: 'Move',
                    ox:    ox,
                    oy:    oy,
                    state: :show,
@@ -59,7 +59,7 @@ module Vedeu
     end
 
     describe '#initialize' do
-      it { instance.must_be_instance_of(Vedeu::MoveCursor) }
+      it { instance.must_be_instance_of(Vedeu::Move) }
       it { instance.instance_variable_get('@cursor').must_equal(cursor) }
       it { instance.instance_variable_get('@interface').must_equal(interface) }
       it { instance.instance_variable_get('@dy').must_equal(dy) }
@@ -78,7 +78,7 @@ module Vedeu
         Vedeu::Cursor.new({ name: 'manganese', oy: 2, ox: 3, x: 8, y: 7 }).store
       end
 
-      subject { MoveCursor.by_name(direction, _name) }
+      subject { Move.by_name(direction, _name) }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
 
@@ -119,7 +119,7 @@ module Vedeu
     end
 
     describe '.down' do
-      subject { MoveCursor.down(cursor, interface) }
+      subject { Move.down(cursor, interface) }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
 
@@ -127,7 +127,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the boundary of the ' \
               'interface' do
-        subject { MoveCursor.down(cursor, interface_without_border) }
+        subject { Move.down(cursor, interface_without_border) }
         let(:y) { 15 }
 
         it 'does not move past the bottom of the interface' do
@@ -137,7 +137,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the border of the ' \
               'interface' do
-        subject { MoveCursor.down(cursor, interface_with_border) }
+        subject { Move.down(cursor, interface_with_border) }
         let(:y)         { 15 }
 
         it 'does not move past the bottom border' do
@@ -147,7 +147,7 @@ module Vedeu
     end
 
     describe '.left' do
-      subject { MoveCursor.left(cursor, interface) }
+      subject { Move.left(cursor, interface) }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
 
@@ -155,7 +155,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the boundary of the ' \
               'interface' do
-        subject { MoveCursor.left(cursor, interface_without_border) }
+        subject { Move.left(cursor, interface_without_border) }
         let(:x)         { 3 }
 
         it 'does not move past the left of the interface' do
@@ -165,7 +165,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the border of the ' \
               'interface' do
-        subject { MoveCursor.left(cursor, interface_with_border) }
+        subject { Move.left(cursor, interface_with_border) }
         let(:x)         { 4 }
 
         it 'does not move past the left border' do
@@ -175,7 +175,7 @@ module Vedeu
     end
 
     describe '.right' do
-      subject { MoveCursor.right(cursor, interface) }
+      subject { Move.right(cursor, interface) }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
 
@@ -183,7 +183,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the boundary of the ' \
               'interface' do
-        subject { MoveCursor.right(cursor, interface_without_border) }
+        subject { Move.right(cursor, interface_without_border) }
         let(:x)         { 14 }
 
         it 'does not move past the right of the interface' do
@@ -193,7 +193,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the border of the ' \
               'interface' do
-        subject { MoveCursor.right(cursor, interface_with_border) }
+        subject { Move.right(cursor, interface_with_border) }
 
         let(:x)         { 14 }
 
@@ -204,7 +204,7 @@ module Vedeu
     end
 
     describe '.up' do
-      subject { MoveCursor.up(cursor, interface) }
+      subject { Move.up(cursor, interface) }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
 
@@ -212,7 +212,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the boundary of the ' \
               'interface' do
-        subject { MoveCursor.up(cursor, interface_without_border) }
+        subject { Move.up(cursor, interface_without_border) }
 
         let(:y)         { 3 }
 
@@ -223,7 +223,7 @@ module Vedeu
 
       context 'when moving, the cursor must be within the border of the ' \
               'interface' do
-        subject { MoveCursor.up(cursor, interface_with_border) }
+        subject { Move.up(cursor, interface_with_border) }
 
         let(:y)         { 3 }
 
@@ -234,7 +234,7 @@ module Vedeu
     end
 
     describe '#origin' do
-      subject { MoveCursor.origin(cursor, interface) }
+      subject { Move.origin(cursor, interface) }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
 
@@ -244,14 +244,14 @@ module Vedeu
       end
 
       context 'within the boundary of the interface' do
-        subject { MoveCursor.origin(cursor, interface_without_border) }
+        subject { Move.origin(cursor, interface_without_border) }
 
         it { subject.x.must_equal(5) }
         it { subject.y.must_equal(5) }
       end
 
       context 'within the border of the interface' do
-        subject { MoveCursor.origin(cursor, interface_with_border) }
+        subject { Move.origin(cursor, interface_with_border) }
 
         it { subject.x.must_equal(6) }
         it { subject.y.must_equal(6) }
@@ -259,11 +259,11 @@ module Vedeu
     end
 
     describe '#move' do
-      subject { MoveCursor.new(cursor, interface, dy, dx).move }
+      subject { Move.new(cursor, interface, dy, dx).move }
 
       it { subject.must_be_instance_of(Vedeu::Cursor) }
     end
 
-  end # MoveCursor
+  end # Move
 
 end # Vedeu

data/test/lib/vedeu/cursor/{toggle_cursor_test.rb → toggle_test.rb}

@@ -2,9 +2,9 @@ require 'test_helper'
 
 module Vedeu
 
-  describe ToggleCursor do
+  describe Toggle do
 
-    let(:described) { ToggleCursor.new(cursor) }
+    let(:described) { Toggle.new(cursor) }
     let(:cursor)    { Cursor.new({ name: 'vanadium',
                                    ox: 1,
                                    oy: 1,
@@ -14,12 +14,12 @@ module Vedeu
     let(:state)     { true }
 
     describe '#initialize' do
-      it { described.must_be_instance_of(ToggleCursor) }
+      it { described.must_be_instance_of(Toggle) }
       it { described.instance_variable_get('@cursor').must_equal(cursor) }
     end
 
     describe '.hide' do
-      subject { ToggleCursor.hide(cursor) }
+      subject { Toggle.hide(cursor) }
 
       it { subject.must_be_instance_of(Cursor) }
 
@@ -39,7 +39,7 @@ module Vedeu
     end
 
     describe '.show' do
-      subject { ToggleCursor.show(cursor) }
+      subject { Toggle.show(cursor) }
 
       it { subject.must_be_instance_of(Cursor) }
 
@@ -58,6 +58,6 @@ module Vedeu
       end
     end
 
-  end # ToggleCursor
+  end # Toggle
 
 end # Vedeu

data/test/lib/vedeu/dsl/components/geometry_test.rb

@@ -146,7 +146,7 @@ module Vedeu
               end
             }
 
-            it { subject.geometry.x.must_equal(0) }
+            it { subject.geometry.x.must_equal(1) }
           end
 
           context 'when a block is given' do
@@ -197,7 +197,7 @@ module Vedeu
               end
             }
 
-            it { subject.geometry.y.must_equal(0) }
+            it { subject.geometry.y.must_equal(1) }
           end
 
           context 'when a block is given' do
@@ -205,6 +205,18 @@ module Vedeu
         end
       end
 
+      describe '#xn' do
+        subject { Vedeu::Geometry.build({}) { xn 15 } }
+
+        it { subject.xn.must_equal(15) }
+      end
+
+      describe '#yn' do
+        subject { Vedeu::Geometry.build({}) { yn 8 } }
+
+        it { subject.yn.must_equal(8) }
+      end
+
     end # Geometry
 
   end # DSL