vedeu 0.6.6 → 0.6.7

data/lib/vedeu/log/timer.rb

@@ -13,7 +13,7 @@ module Vedeu
       #
       # @param message [String]
       # @param block [Proc]
-      # @return [void]
+      # @return [void] The return value of the executed block.
       def timer(message = '', &block)
         new(message).measure(&block)
       end
@@ -32,7 +32,7 @@ module Vedeu
     # Write an entry to the log file stating how long a section of code took in
     # milliseconds. Useful for debugging performance.
     #
-    # @return [void]
+    # @return [void] The return value of the executed block.
     def measure
       work = yield
 

data/lib/vedeu/models/focus.rb

@@ -46,6 +46,7 @@ module Vedeu
     # to set the initially focussed interface.
     #
     # @example
+    #   Vedeu.trigger(:_focus_by_name_, name)
     #   Vedeu.focus_by_name('name')
     #
     # @param name [String] The interface to focus; must be defined.
@@ -96,6 +97,7 @@ module Vedeu
     # Put the next interface relative to the current interfaces in focus.
     #
     # @example
+    #   Vedeu.trigger(:_focus_next_)
     #   Vedeu.focus_next
     #
     # @return [String]
@@ -125,6 +127,7 @@ module Vedeu
     # Put the previous interface relative to the current interface in focus.
     #
     # @example
+    #   Vedeu.trigger(:_focus_prev_)
     #   Vedeu.focus_previous
     #
     # @return [String]

data/lib/vedeu/models/group.rb

@@ -124,6 +124,19 @@ module Vedeu
       self
     end
 
+    # Toggle the visibility of the group with the given name.
+    #
+    # @example
+    #   Vedeu.trigger(:_toggle_group, name)
+    #   Vedeu.toggle_group(name)
+    #
+    # @return [Vedeu::Group]
+    def toggle
+      super
+
+      self
+    end
+
     private
 
     # Returns the default options/attributes for this class.

data/lib/vedeu/models/interface.rb

@@ -22,7 +22,7 @@ module Vedeu
     attr_accessor :delay
 
     # @!attribute [rw] group
-    # @return [void]
+    # @return [Symbol|String]
     attr_accessor :group
 
     # @!attribute [rw] name
@@ -83,6 +83,22 @@ module Vedeu
       Vedeu.buffers.by_name(name).show
     end
 
+    # Toggle the visibility of the interface with the given name.
+    #
+    # @example
+    #   Vedeu.toggle_interface(name)
+    #
+    # @return [void]
+    def toggle
+      if visible?
+        hide
+
+      else
+        show
+
+      end
+    end
+
     private
 
     # The default values for a new instance of this class.

data/lib/vedeu/models/toggleable.rb

@@ -31,7 +31,8 @@ module Vedeu
       store
     end
 
-    # Toggle the visible state and store the model.
+    # Toggle the visible state and store the model. When the model is
+    # hidden, then it is shown, and vice versa.
     #
     # @return [FalseClass|TrueClass]
     def toggle

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

@@ -4,6 +4,7 @@ module Vedeu
 
     # A collection of {Vedeu::Views::Char} instances.
     #
+    # @api private
     class Chars < Vedeu::Collection
 
     end # Chars

data/lib/vedeu/models/views/collections/lines.rb

@@ -4,6 +4,7 @@ module Vedeu
 
     # A collection of {Vedeu::Views::Line} instances.
     #
+    # @api private
     class Lines < Vedeu::Collection
 
     end # Lines

data/lib/vedeu/models/views/collections/streams.rb

@@ -4,6 +4,7 @@ module Vedeu
 
     # A collection of {Vedeu::Views::Stream} instances.
     #
+    # @api private
     class Streams < Vedeu::Collection
 
     end # Streams

data/lib/vedeu/models/views/collections/view_collection.rb

@@ -4,6 +4,7 @@ module Vedeu
 
     # A collection of {Vedeu::Views::View} instances.
     #
+    # @api private
     class ViewCollection < Vedeu::Collection
 
     end # ViewCollection

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

@@ -38,8 +38,8 @@ module Vedeu
         end
       end
 
-      # @param child [void]
-      # @return [void]
+      # @param child [Vedeu::Views::Stream]
+      # @return [Vedeu::Views::Stream]
       def add(child)
         @value = value.add(child)
       end

data/lib/vedeu/null/generic.rb

@@ -6,6 +6,14 @@ module Vedeu
     #
     class Generic
 
+      # @!attribute [r] attributes
+      # @return [String]
+      attr_reader :attributes
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
+
       # Returns an instance of the Vedeu::Null::Generic class.
       #
       # @param attributes [Hash<Symbol => void>]
@@ -20,10 +28,25 @@ module Vedeu
       def null(*)
         nil
       end
-      alias_method :add, :null
-      alias_method :colour, :null
-      alias_method :parent, :null
-      alias_method :style, :null
+      alias_method :add,           :null
+      alias_method :bottom_item,   :null
+      alias_method :colour,        :null
+      alias_method :current_item,  :null
+      alias_method :deselect_item, :null
+      alias_method :hide,          :null
+      alias_method :item,          :null
+      alias_method :items,         :null
+      alias_method :next_item,     :null
+      alias_method :parent,        :null
+      alias_method :prev_item,     :null
+      alias_method :select_item,   :null
+      alias_method :selected_item, :null
+      alias_method :show,          :null
+      alias_method :style,         :null
+      alias_method :toggle,        :null
+      alias_method :top_item,      :null
+      alias_method :view,          :null
+      alias_method :zindex,        :null
 
       # @return [Boolean]
       def null?

data/lib/vedeu/null/interface.rb

@@ -6,23 +6,14 @@ module Vedeu
 
     # Provides a non-existent model to swallow messages.
     #
-    class Interface
+    class Interface < Vedeu::Null::Generic
 
       include Vedeu::Presentation
 
-      # @!attribute [r] name
-      # @return [String]
-      attr_reader :name
-
       # @!attribute [r] attributes
       # @return [String]
       attr_reader :attributes
 
-      # @!attribute [rw] visible
-      # @return [String]
-      attr_accessor :visible
-      alias_method :visible?, :visible
-
       # Returns a new instance of Vedeu::Null::Interface.
       #
       # @param attributes [Hash<Symbol => void>]
@@ -34,28 +25,6 @@ module Vedeu
         @visible    = false
       end
 
-      # @return [NilClass]
-      def null
-        nil
-      end
-      alias_method :hide, :null
-      alias_method :parent, :null
-      alias_method :show, :null
-      alias_method :toggle, :null
-      alias_method :zindex, :null
-
-      # @return [Boolean]
-      def null?
-        true
-      end
-
-      # Pretend to store this model in the repository.
-      #
-      # @return [Vedeu::Null::Interface]
-      def store
-        self
-      end
-
     end # Interface
 
   end # Null

data/lib/vedeu/null/menu.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Provides a non-existent model to swallow messages.
     #
-    class Menu
+    class Menu < Vedeu::Null::Generic
 
       # Returns an instance of the Vedeu::Null::Menu class.
       #
@@ -16,21 +16,6 @@ module Vedeu
         @name       = @attributes[:name]
       end
 
-      # @return [NilClass]
-      def item
-        nil
-      end
-      alias_method :bottom_item, :item
-      alias_method :current_item, :item
-      alias_method :deselect_item, :item
-      alias_method :items, :item
-      alias_method :next_item, :item
-      alias_method :prev_item, :item
-      alias_method :select_item, :item
-      alias_method :selected_item, :item
-      alias_method :top_item, :item
-      alias_method :view, :item
-
     end # Menu
 
   end # Null

data/lib/vedeu/null/view.rb

@@ -6,23 +6,10 @@ module Vedeu
 
     # Provides a non-existent model to swallow messages.
     #
-    class View
+    class View < Vedeu::Null::Generic
 
       include Vedeu::Presentation
 
-      # @!attribute [r] name,
-      # @return [String]
-      attr_reader :name
-
-      # @!attribute [r] attributes
-      # @return [String]
-      attr_reader :attributes
-
-      # @!attribute [rw] visible
-      # @return [String]
-      attr_accessor :visible
-      alias_method :visible?, :visible
-
       # Returns a new instance of Vedeu::Null::View.
       #
       # @param attributes [Hash<Symbol => void>]
@@ -34,25 +21,6 @@ module Vedeu
         @visible    = false
       end
 
-      # @return [NilClass]
-      def null
-        nil
-      end
-      alias_method :parent, :null
-      alias_method :zindex, :null
-
-      # @return [Boolean]
-      def null?
-        true
-      end
-
-      # Pretend to store this model in the repository.
-      #
-      # @return [Vedeu::Null::View]
-      def store
-        self
-      end
-
     end # View
 
   end # Null

data/lib/vedeu/options.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # An internal class for Vedeu to provide a consistent interface to
+  # options used by many classes.
+  #
   class Options
 
     # @param options [Hash]

data/lib/vedeu/output/clear/named_group.rb

@@ -10,6 +10,11 @@ module Vedeu
 
       class << self
 
+        # Clears the group of interfaces belonging to the given name.
+        #
+        # @example
+        #   Vedeu.clear_by_group(name)
+        #
         # @param name [String]
         # @return [void]
         def render(name)

data/lib/vedeu/output/clear/named_interface.rb

@@ -10,6 +10,11 @@ module Vedeu
 
       class << self
 
+        # Clear the interface with the given name.
+        #
+        # @example
+        #   Vedeu.clear_by_name(name)
+        #
         # @return [Array<Array<Vedeu::Views::Char>>]
         # @see #initialize
         def render(name)

data/lib/vedeu/output/direct.rb

@@ -7,7 +7,7 @@ module Vedeu
     # @param value [String]
     # @param x [Fixnum]
     # @param y [Fixnum]
-    # @return [void]
+    # @return [String]
     def self.write(value:, x:, y:)
       new(value: value, x: x, y: y).write
     end
@@ -24,7 +24,7 @@ module Vedeu
       @y     = y     || 1
     end
 
-    # @return [void]
+    # @return [String]
     def write
       Vedeu::Terminal.output(output)
 

data/lib/vedeu/output/viewport.rb

@@ -129,7 +129,7 @@ module Vedeu
     # @param dimension [Fixnum] Either the height or width.
     # @return [Fixnum]
     def content_offset(offset, dimension)
-      if offset >= dimension && ((offset - dimension) > 0)
+      if offset >= dimension
         offset - dimension
 
       else

data/lib/vedeu/refresh/refresh_group.rb

@@ -32,7 +32,7 @@ module Vedeu
     def by_name
       Vedeu.timer("Refresh Group: '#{group_name}'") do
         Vedeu.groups.by_name(group_name).by_zindex.each do |name|
-          Vedeu::RefreshBuffer.by_name(name)
+          Vedeu::Buffers::Refresh.by_name(name)
         end
       end
     end

data/lib/vedeu/runtime/application.rb

@@ -23,6 +23,9 @@ module Vedeu
       #   encouraged to use this event to close any open buffers, save files,
       #   empty trash, etc.
       #
+      # @example
+      #   Vedeu.exit
+      #
       # @return [void]
       def stop
         Vedeu.trigger(:_cleanup_)

data/lib/vedeu/terminal/terminal.rb

@@ -81,6 +81,9 @@ module Vedeu
 
     # Clears the entire terminal space.
     #
+    # @example
+    #   Vedeu.clear
+    #
     # @return [String]
     def clear
       virtual.clear if Vedeu::Configuration.drb?

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.6'
+  VERSION = '0.6.7'
 
 end

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

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Buffers
+
+    describe Refresh do
+
+      let(:described) { Vedeu::Buffers::Refresh }
+      let(:instance)  { described.new(_name) }
+      let(:_name)     { 'Vedeu::Buffers::Refresh' }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@name').must_equal(_name) }
+      end
+
+      describe '.by_name' do
+        subject { described.by_name(_name) }
+
+        context 'when the name is not present' do
+          let(:_name) { '' }
+
+          it { proc { subject }.must_raise(Vedeu::Error::MissingRequired) }
+        end
+
+        # describe '.by_name' do
+        #   let(:_name)  { 'aluminium' }
+        #   let(:buffer) { Vedeu::Buffers::Null.new(name: _name) }
+        #
+        #   subject { described.by_name(_name) }
+        #
+        #   it {
+        #     Vedeu.buffers.expects(:by_name).with(_name).returns(buffer)
+        #     buffer.expects(:render)
+        #     subject
+        #   }
+        # end
+
+        context 'when the name is present' do
+          # @todo Add more tests.
+          # it { skip }
+        end
+      end
+
+      describe '#by_name' do
+        it { instance.must_respond_to(:by_name) }
+      end
+
+    end # Refresh
+
+  end # Buffers
+
+end # Vedeu