vedeu 0.3.1 → 0.3.2

data/lib/vedeu/output/wordwrap.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Wrap or prune text.
+  #
   class Wordwrap
 
     # @param text [String]
@@ -58,6 +60,7 @@ module Vedeu
       end
     end
 
+    # @return [Vedeu::Lines]
     def as_lines
       if __callee__ == :prune_as_lines
         to_line_objects(prune)
@@ -75,7 +78,8 @@ module Vedeu
 
     private
 
-    attr_reader :text, :options
+    attr_reader :text,
+      :options
 
     # @param text_as_lines [Array<String>]
     # @return [Vedeu::Lines]
@@ -102,6 +106,7 @@ module Vedeu
       end.join("\n")
     end
 
+    # @param string [String]
     # @return [String]
     def ellipsis_string(string)
       if string.size < ellipsis.size
@@ -113,6 +118,7 @@ module Vedeu
       end
     end
 
+    # @param string [String]
     # @return [String]
     def prune_string(string)
       string.chomp.slice(0..pruned_width)

data/lib/vedeu/output/writer.rb

@@ -4,10 +4,12 @@ module Vedeu
 
     attr_reader :writers
 
+    # @return [Vedeu::Writer]
     def self.[](*args)
       new(args)
     end
 
+    # @return [Vedeu::Writer]
     def initialize(writers)
       @writers = writers
     end
@@ -16,6 +18,7 @@ module Vedeu
       writers == other.writers
     end
 
+    # @return [Vedeu::Writer]
     def +(other)
       Writer[*(writers + other.writers)]
     end

data/lib/vedeu/presentation/presentation.rb

@@ -37,12 +37,14 @@ module Vedeu
 
     private
 
+    # @return [String]
     def parent_colour
       return '' unless parent
 
       parent.colour
     end
 
+    # @return [String]
     def parent_style
       return '' unless parent
 

data/lib/vedeu/repositories/all.rb

@@ -1,5 +1,111 @@
 require 'vedeu/repositories/repository'
-require 'vedeu/repositories/menus'
 
 module Vedeu
+
+  # Allows the storing of interface/view borders independent of the interface
+  # instance.
+  #
+  class Borders < Repository
+
+    # @return [Vedeu::Borders]
+    def self.borders
+      @_borders ||= Vedeu::Borders.new(Vedeu::Border)
+    end
+
+  end # Borders
+
+  # Allows the storing of view buffers.
+  #
+  class Buffers < Repository
+
+    # @return [Vedeu::Buffers]
+    def self.buffers
+      @_buffers ||= Vedeu::Buffers.new(Vedeu::Buffer)
+    end
+
+  end # Buffers
+
+  # Allows the storing of each interface's cursor.
+  #
+  class Cursors < Repository
+
+    # @return [Vedeu::Cursors]
+    def self.cursors
+      @_cursors ||= Vedeu::Cursors.new(Vedeu::Cursor)
+    end
+
+    # @return [Vedeu::Cursor]
+    def self.cursor
+      cursors.current
+    end
+
+  end # Cursors
+
+  # Allows the storing of events.
+  #
+  class Events < Repository
+
+    # @return [Vedeu::Events]
+    def self.events
+      @_events ||= Vedeu::Events.new(Vedeu::Model::Collection)
+    end
+
+  end # Events
+
+  # Allows the storing of interface/view geometry independent of the interface
+  # instance.
+  #
+  class Geometries < Repository
+
+    # @return [Vedeu::Geometries]
+    def self.geometries
+      @_geometries ||= Vedeu::Geometries.new(Vedeu::Geometry)
+    end
+
+  end # Geometries
+
+  # Allows the storing of view groups.
+  #
+  class Groups < Repository
+
+    # @return [Vedeu::Groups]
+    def self.groups
+      @_groups ||= Vedeu::Groups.new(Vedeu::Group)
+    end
+
+  end # Groups
+
+  # Allows the storing of interfaces and views.
+  #
+  class InterfacesRepository < Repository
+
+    # @return [Vedeu::InterfacesRepository]
+    def self.interfaces
+      @_interfaces ||= Vedeu::InterfacesRepository.new(Vedeu::Interface)
+    end
+
+  end # InterfacesRepository
+
+  # Allows the storing of keymaps.
+  #
+  class Keymaps < Repository
+
+    # @return [Vedeu::Keymaps]
+    def self.keymaps
+      @_keymaps ||= Vedeu::Keymaps.new(Vedeu::Keymap)
+    end
+
+  end # Keymaps
+
+  # Allows the storing of menus by name.
+  #
+  class Menus < Repository
+
+    # @return [Vedeu::Menus]
+    def self.menus
+      @_menus ||= Vedeu::Menus.new(Vedeu::Menu)
+    end
+
+  end # Menus
+
 end # Vedeu

data/lib/vedeu/repositories/repository.rb

@@ -19,6 +19,9 @@ module Vedeu
 
     attr_reader :model, :storage
 
+    # @param model [Class]
+    # @param storage [Class|Hash]
+    # @return [Vedeu::Repository]
     def initialize(model = nil, storage = {})
       @model   = model
       @storage = storage
@@ -45,6 +48,7 @@ module Vedeu
       find_or_create(Vedeu.focus) if Vedeu.focus
     end
 
+    # @return [Enumerator]
     def each(&block)
       storage.each(&block)
     end

data/lib/vedeu/support/bounding_area.rb

@@ -9,7 +9,7 @@ module Vedeu
     #
     # @param height [Fixnum]
     # @param width [Fixnum]
-    # @return [ConsoleGeometry]
+    # @return [Vedeu::BoundingArea]
     def initialize(height, width)
       @height = height
       @width  = width

data/lib/vedeu/support/position_validator.rb

@@ -60,25 +60,43 @@ module Vedeu
 
     attr_reader :interface
 
+    # Validate the x and y coordinates are within the dimensions of the
+    # terminal.
+    #
+    # @return [PositionValidator]
     def terminal_validation
       @x = tx  if x < tx
       @x = txn if x > txn
       @y = ty  if y < ty
       @y = tyn if y > tyn
+
+      self
     end
 
+    # Validate the x and y coordinates are within the dimensions of the
+    # interface.
+    #
+    # @return [PositionValidator]
     def interface_validation
       @x = left   if x < left
       @x = right  if x > right
       @y = top    if y < top
       @y = bottom if y > bottom
+
+      self
     end
 
+    # Validate the x and y coordinates are within the dimensions of an interface
+    # with a border.
+    #
+    # @return [PositionValidator]
     def border_validation
       @x = left + 1   if left?   && x < (left + 1)
       @x = right - 2  if right?  && x > (right - 1)
       @y = top + 1    if top?    && y < (top + 1)
       @y = bottom - 2 if bottom? && y > (bottom - 1)
+
+      self
     end
 
     # def x

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

@@ -33,14 +33,14 @@ module Vedeu
 
     describe '#add' do
       let(:back) {
-        Vedeu::Interface.build do
+        Vedeu.interface 'buffer' do
           lines do
             line 'old_back'
           end
         end
       }
       let(:content) {
-        Vedeu::Interface.build do
+        Vedeu.interface 'buffer' do
           lines do
             line 'new_back'
           end
@@ -67,7 +67,7 @@ module Vedeu
 
       context 'when there is content on the back buffer' do
         let(:back) {
-        Vedeu::Interface.build do
+        Vedeu.interface 'buffer' do
           lines do
             line 'old_back'
           end
@@ -94,7 +94,7 @@ module Vedeu
       context 'when there is content on the front buffer' do
         let(:buffer) { :front }
         let(:front) {
-          Vedeu::Interface.build do
+          Vedeu.interface 'buffer' do
             lines do
               line 'front'
             end
@@ -120,7 +120,7 @@ module Vedeu
       context 'when there is content on the previous buffer' do
         let(:buffer) { :previous }
         let(:previous) {
-          Vedeu::Interface.build do
+          Vedeu.interface 'buffer' do
             lines do
               line 'old_back'
             end
@@ -149,21 +149,21 @@ module Vedeu
 
       context 'when there is new content on the back buffer' do
         let(:back) {
-          Vedeu::Interface.build do
+          Vedeu.interface 'buffer' do
             lines do
               line 'back'
             end
           end
         }
         let(:front) {
-          Vedeu::Interface.build do
+          Vedeu.interface 'buffer' do
             lines do
               line 'front'
             end
           end
         }
         let(:previous) {
-          Vedeu::Interface.build do
+          Vedeu.interface 'buffer' do
             lines do
               line 'previous'
             end

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

@@ -13,16 +13,14 @@ module Vedeu
     let(:y)         { 1 }
 
     let(:interface) {
-      Vedeu::Interface.build do
-        name 'magnesium'
+      Vedeu.interface 'magnesium' do
         geometry do
 
         end
       end
     }
     let(:interface_with_border) {
-      Vedeu::Interface.build do
-        name 'manganese'
+      Vedeu.interface 'manganese' do
         border do
           # ...
         end
@@ -35,8 +33,7 @@ module Vedeu
       end
     }
     let(:interface_without_border) {
-      Vedeu::Interface.build do
-        name 'meitnerium'
+      Vedeu.interface 'meitnerium' do
         geometry do
           height 5
           width 5

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

@@ -7,14 +7,15 @@ module Vedeu
     describe Border do
 
       let(:described)  { Vedeu::DSL::Border }
-      let(:instance)   { described.new(model) }
-      let(:model)      { Vedeu::Border.new(interface, attributes) }
+      let(:instance)   { described.new(model, client) }
+      let(:model)      { Vedeu::Border.new(attributes) }
       let(:client)     {}
-      let(:interface)  { mock('Interface') }
-      let(:attributes) { {} }
+      let(:attributes) { { name: 'borders' } }
       let(:boolean)    { true }
 
       before do
+        Vedeu.borders.reset
+        Vedeu.buffers.reset
         Vedeu.interfaces.reset
         Vedeu.interface 'borders' do
           geometry do
@@ -182,6 +183,18 @@ module Vedeu
         end
       end
 
+      describe '#hide_bottom!' do
+        subject { instance.hide_bottom! }
+
+        it { subject.must_be_instance_of(FalseClass) }
+      end
+
+      describe '#show_bottom!' do
+        subject { instance.show_bottom! }
+
+        it { subject.must_be_instance_of(TrueClass) }
+      end
+
       describe '#show_left' do
         subject { instance.show_left(boolean) }
 
@@ -221,6 +234,18 @@ module Vedeu
         end
       end
 
+      describe '#hide_left!' do
+        subject { instance.hide_left! }
+
+        it { subject.must_be_instance_of(FalseClass) }
+      end
+
+      describe '#show_left!' do
+        subject { instance.show_left! }
+
+        it { subject.must_be_instance_of(TrueClass) }
+      end
+
       describe '#show_right' do
         subject { instance.show_right(boolean) }
 
@@ -260,6 +285,18 @@ module Vedeu
         end
       end
 
+      describe '#hide_right!' do
+        subject { instance.hide_right! }
+
+        it { subject.must_be_instance_of(FalseClass) }
+      end
+
+      describe '#show_right!' do
+        subject { instance.show_right! }
+
+        it { subject.must_be_instance_of(TrueClass) }
+      end
+
       describe '#show_top' do
         subject { instance.show_top(boolean) }
 
@@ -299,6 +336,18 @@ module Vedeu
         end
       end
 
+      describe '#hide_top!' do
+        subject { instance.hide_top! }
+
+        it { subject.must_be_instance_of(FalseClass) }
+      end
+
+      describe '#show_top!' do
+        subject { instance.show_top! }
+
+        it { subject.must_be_instance_of(TrueClass) }
+      end
+
       describe '#top_left' do
         let(:char) { 'A' }