vedeu 0.4.16 → 0.4.17

data/lib/vedeu/output/presentation.rb

@@ -12,6 +12,7 @@ module Vedeu
 
       else
         Vedeu::Background.new
+        # @todo: Should this be: parent_background
 
       end
     end
@@ -40,6 +41,7 @@ module Vedeu
 
       else
         Vedeu::Foreground.new
+        # @todo: Should this be: parent_foreground
 
       end
     end

data/lib/vedeu/output/renderers/escape_sequence_renderer.rb

@@ -29,6 +29,9 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
+    # Escapes the escape sequences.
+    #
+    # @return [String]
     def parsed
       @parsed ||= Array(output).flatten.map do |char|
         Esc.escape(char.to_s) + "\n"

data/lib/vedeu/repositories/model.rb

@@ -40,6 +40,12 @@ module Vedeu
       alias_method :member,     :child
       alias_method :collection, :child
 
+      # @note
+      #   Not current used.
+      #
+      # @param klass [void]
+      # @param as [void]
+      # @return [void]
       def repository(klass, as:)
         self.repository = as
         klass.register(as, self)

data/lib/vedeu/repositories/repositories/groups.rb

@@ -19,6 +19,18 @@ module Vedeu
 
     end
 
+    # @param name [String] The name of the stored group.
+    # @return [Vedeu::Group]
+    def by_name(name)
+      if registered?(name)
+        find(name)
+
+      else
+        Vedeu::Group.new(name: name).store
+
+      end
+    end
+
   end # Groups
 
 end # Vedeu

data/lib/vedeu/repositories/repository.rb

@@ -24,6 +24,9 @@ module Vedeu
     # @return [void]
     attr_reader :storage
 
+    # @param model [Class]
+    # @param storage [Class|Hash]
+    # @return [Vedeu::Repository]
     def self.register_repository(model = nil, storage = {})
       new(model, storage).tap do |klass|
         Vedeu::Repositories.register(klass.repository)
@@ -40,6 +43,9 @@ module Vedeu
       @storage    = storage
     end
 
+    # Returns the repository class.
+    #
+    # @return [Class]
     def repository
       self.class # .name
     end
@@ -86,6 +92,11 @@ module Vedeu
     end
     alias_method :by_name, :find_or_create
 
+    # @return [String]
+    def inspect
+      "<#{self.class.name}: #{registered.inspect}>"
+    end
+
     # Returns a collection of the names of all the registered entities.
     #
     # @return [Array]
@@ -145,14 +156,6 @@ module Vedeu
     end
     alias_method :register, :store
 
-    # Access a model by name.
-    #
-    # @param name [String]
-    # @return [|NilClass]
-    def use(name)
-      find(name) if registered?(name)
-    end
-
     private
 
     # @return [Hash]

data/lib/vedeu/storage/all.rb

@@ -1,6 +1,6 @@
-require 'vedeu/storage/store'
+require_relative 'store'
 
-require 'vedeu/storage/associative_store'
-require 'vedeu/storage/conveyor_store'
-require 'vedeu/storage/fifo_store'
+require_relative 'associative_store'
+require_relative 'conveyor_store'
+require_relative 'fifo_store'
 

data/lib/vedeu/support/visibility.rb

@@ -4,6 +4,14 @@ module Vedeu
   #
   class Visibility
 
+    # @param name [String]
+    # @return [Vedeu::Visibility]
+    def self.for_cursor(name = nil)
+      named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
+
+      new(named)
+    end
+
     # @param model [void]
     # @return [void]
     def self.show(model)

data/test/lib/vedeu/buffers/buffer_test.rb

@@ -12,14 +12,12 @@ module Vedeu
         back:       back,
         front:      front,
         previous:   previous,
-        repository: repository,
       }
     }
     let(:_name) { 'krypton' }
     let(:back)        {}
     let(:front)       {}
     let(:previous)    {}
-    let(:repository)  {}
 
     before { Vedeu.stubs(:trigger) }
 

data/test/lib/vedeu/cursor/cursor_test.rb

@@ -39,6 +39,13 @@ module Vedeu
       it { subject.instance_variable_get('@y').must_equal(8) }
     end
 
+    describe '#hide_cursor' do
+      subject { instance.hide_cursor }
+
+      it { subject.must_be_instance_of(String) }
+      it { subject.must_equal("\e[?25l") }
+    end
+
     describe '#inspect' do
       subject { instance.inspect }
 
@@ -48,6 +55,13 @@ module Vedeu
       ) }
     end
 
+    describe '#show_cursor' do
+      subject { instance.show_cursor }
+
+      it { subject.must_be_instance_of(String) }
+      it { subject.must_equal("\e[?25h") }
+    end
+
     describe '#to_s' do
       let(:visible) { true }
 

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

@@ -173,9 +173,9 @@ module Vedeu
       end
 
       describe '#title' do
-        let(:value) { 'Some title'}
+        let(:_value) { 'Some title'}
 
-        subject { instance.title(value) }
+        subject { instance.title(_value) }
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('Some title') }

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

@@ -10,6 +10,8 @@ module Vedeu
       let(:instance)  { described.new(model) }
       let(:model)     { Vedeu::Geometry.new }
 
+      before { Terminal.stubs(:size).returns([25, 80]) }
+
       describe 'alias methods' do
         it { instance.must_respond_to(:centred!) }
       end
@@ -20,113 +22,86 @@ module Vedeu
       end
 
       describe '#centred' do
-        subject { Vedeu::Geometry.build({}) { centred true } }
+        subject { instance.centred(true) }
 
         it 'sets the attribute to the value' do
-          subject.centred.must_equal(true)
+          subject.must_equal(true)
         end
 
         context 'DSL #centred' do
           subject {
-            Vedeu.interface 'geometry' do
-              geometry do
-                centred false
-              end
+            Vedeu.geometry 'geometry' do
+              centred false
             end
           }
 
-          it { subject.must_be_instance_of(Vedeu::Interface) }
+          it { subject.must_be_instance_of(Vedeu::Geometry) }
 
           it 'allows the use of centred within geometry' do
-            subject.geometry.centred.must_equal(false)
+            subject.centred.must_equal(false)
           end
 
           context 'when no value is given' do
             subject {
-              Vedeu.interface 'geometry' do
-                geometry do
-                  centred
-                end
+              Vedeu.geometry 'geometry' do
+                centred
               end
             }
 
-            it { subject.geometry.centred.must_equal(true) }
+            it { subject.centred.must_equal(true) }
           end
         end
       end
 
       describe '#height' do
-        subject { Vedeu::Geometry.build({}) { height 6 } }
+        subject { instance.height(6) }
 
         it 'sets the attribute to the value' do
-          subject.height.must_equal(6)
+          subject.must_equal(6)
         end
 
         context 'DSL #height' do
           subject {
-            Vedeu.interface 'geometry' do
-              geometry do
-                height 17
-              end
+            Vedeu.geometry 'geometry' do
+              height 17
             end
           }
 
-          it { subject.must_be_instance_of(Vedeu::Interface) }
+          it { subject.must_be_instance_of(Vedeu::Geometry) }
 
           it 'allows the use of height within geometry' do
-            subject.geometry.height.must_equal(17)
+            subject.height.must_equal(17)
           end
         end
       end
 
-      # describe '#use' do
-      #   subject { 
-      #     Vedeu::Geometry.build({ name: 'hydrogen' }) { use 'helium' }
-      #   }
-
-      #   context 'when the named geometry does not exist' do
-      #   end
-
-      #   context 'when the named geometry exists' do
-      #     before do
-      #       Vedeu::Geometry.build({ name: 'helium', x: 5 }).store
-      #     end
-
-      #     it { subject.must_be_instance_of(Vedeu::Geometry) }
-      #     it { subject.name.must_equal('hydrogen') }
-      #     it { subject.x.must_equal(5) }
-      #   end
-      # end
-
       describe '#width' do
-        subject { Vedeu::Geometry.build({}) { width 25 } }
+        subject { instance.width(25) }
 
         it 'sets the attribute to the value' do
-          subject.width.must_equal(25)
+          subject.must_equal(25)
         end
 
         context 'DSL #width' do
           subject {
-            Vedeu.interface 'geometry' do
-              geometry do
-                width 29
-              end
+            Vedeu.geometry 'geometry' do
+              width 29
             end
           }
 
-          it { subject.must_be_instance_of(Vedeu::Interface) }
+          it { subject.must_be_instance_of(Vedeu::Geometry) }
 
           it 'allows the use of width within geometry' do
-            subject.geometry.width.must_equal(29)
+            subject.width.must_equal(29)
           end
         end
       end
 
       describe '#x' do
-        subject { Vedeu::Geometry.build({}) { x 2 } }
+        subject { instance.x(2) }
 
         it 'sets the attribute to the value' do
-          subject.x.must_equal(2)
+          subject.must_equal(2)
         end
 
         context 'when a block is given' do
@@ -143,41 +118,46 @@ module Vedeu
 
         context 'DSL #x' do
           subject {
-            Vedeu.interface 'geometry' do
-              geometry do
-                x 7
-              end
+            Vedeu.geometry 'geometry' do
+              x 7
             end
           }
 
-          it { subject.must_be_instance_of(Vedeu::Interface) }
+          it { subject.must_be_instance_of(Vedeu::Geometry) }
 
           it 'allows the use of x within geometry' do
-            subject.geometry.x.must_equal(7)
+            subject.x.must_equal(7)
           end
 
           context 'when no value is given' do
             subject {
-              Vedeu.interface 'geometry' do
-                geometry do
-                  x
-                end
+              Vedeu.geometry 'geometry' do
+                x
               end
             }
 
-            it { subject.geometry.x.must_equal(1) }
+            it { subject.x.must_equal(1) }
           end
 
           context 'when a block is given' do
+            subject {
+              Vedeu::Geometry.build({}) do
+                x do
+                  8 + 8
+                end
+              end
+            }
+
+            it { subject.x.must_equal(16) }
           end
         end
       end
 
       describe '#y' do
-        subject { Vedeu::Geometry.build({}) { y 5 } }
+        subject { instance.y(5) }
 
         it 'sets the attribute to the value' do
-          subject.y.must_equal(5)
+          subject.must_equal(5)
         end
 
         context 'when a block is given' do
@@ -194,42 +174,45 @@ module Vedeu
 
         context 'DSL #y' do
           subject {
-            Vedeu.interface 'geometry' do
-              geometry do
-                y 4
-              end
+            Vedeu.geometry 'geometry' do
+              y 4
             end
           }
 
-          it { subject.must_be_instance_of(Vedeu::Interface) }
+          it { subject.must_be_instance_of(Vedeu::Geometry) }
 
           it 'allows the use of y within geometry' do
-            subject.geometry.y.must_equal(4)
+            subject.y.must_equal(4)
           end
 
           context 'when no value is given' do
             subject {
-              Vedeu.interface 'geometry' do
-                geometry do
-                  y
-                end
+              Vedeu.geometry 'geometry' do
+                y
               end
             }
 
-            it { subject.geometry.y.must_equal(1) }
+            it { subject.y.must_equal(1) }
           end
 
           context 'when a block is given' do
+            subject {
+              Vedeu::Geometry.build({}) do
+                y do
+                  8 + 8
+                end
+              end
+            }
+
+            it { subject.y.must_equal(16) }
           end
         end
       end
 
       describe '#xn' do
-        before { Terminal.stubs(:size).returns([25, 80]) }
-
-        subject { Vedeu::Geometry.build({}) { xn 15 } }
+        subject { instance.xn(15) }
 
-        it { subject.xn.must_equal(15) }
+        it { subject.must_equal(15) }
 
         context 'when a block is given' do
           subject {
@@ -245,11 +228,9 @@ module Vedeu
       end
 
       describe '#yn' do
-        before { Terminal.stubs(:size).returns([25, 80]) }
-
-        subject { Vedeu::Geometry.build({}) { yn 8 } }
+        subject { instance.yn(8) }
 
-        it { subject.yn.must_equal(8) }
+        it { subject.must_equal(8) }
 
         context 'when a block is given' do
           subject {