vedeu 0.6.20 → 0.6.21

data/lib/vedeu/geometry/repository.rb

@@ -16,4 +16,13 @@ module Vedeu
 
   end # Geometry
 
+  # Manipulate the repository of geometries.
+  #
+  # @example
+  #   Vedeu.geometries
+  #
+  # @!method geometries
+  # @return [Vedeu::Geometry::Repository]
+  def_delegators Vedeu::Geometry::Repository, :geometries
+
 end # Vedeu

data/lib/vedeu/groups/clear.rb

@@ -13,7 +13,7 @@ module Vedeu
         # @example
         #   Vedeu.clear_by_group(name)
         #
-        # @param name [String]
+        # @param name [String|Symbol]
         # @return [void]
         def render(name)
           new(name).render
@@ -25,7 +25,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Groups::Clear.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Vedeu::Groups::Clear]
       def initialize(name)
         @name = name
@@ -39,7 +39,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       private
@@ -53,4 +53,8 @@ module Vedeu
 
   end # Groups
 
+  # @!method clear_by_group
+  #   @see Vedeu::Groups::Clear.render
+  def_delegators Vedeu::Groups::Clear, :clear_by_group
+
 end # Vedeu

data/lib/vedeu/groups/dsl.rb

@@ -24,35 +24,35 @@ module Vedeu
       # The example below resembles 'vim' (the popular terminal-based
       # text editor):
       #
-      #   Vedeu.group 'title_screen' do
-      #     add 'welcome_interface'
+      #   Vedeu.group :title_screen do
+      #     add :welcome_interface
       #     # ... some code
       #   end
       #
-      #   Vedeu.group 'main_screen' do
-      #     add 'editor_interface'
-      #     add 'status_interface'
-      #     add 'command_interface'
+      #   Vedeu.group :main_screen do
+      #     add :editor_interface
+      #     add :status_interface
+      #     add :command_interface
       #     # ... some code
       #   end
       #
       # or more succinctly:
       #
-      #   Vedeu.group 'main_screen' do
-      #     members 'editor_interface',
-      #             'status_interface',
-      #             'command_interface'
+      #   Vedeu.group :main_screen do
+      #     members :editor_interface,
+      #             :status_interface,
+      #             :command_interface
       #     # ... some code
       #   end
       #
       # or when defining an interface:
       #
-      #   Vedeu.interface 'some_interface' do
-      #     group 'some_group'
+      #   Vedeu.interface :some_interface do
+      #     group :some_group
       #     # ... some code
       #   end
       #
-      # @param name [String] The name of this group.
+      # @param name [String|Symbol] The name of this group.
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Groups::Group]
@@ -62,44 +62,38 @@ module Vedeu
         Vedeu::Groups::Group.build(name: name, &block).store
       end
 
-      # Returns an instance of Groups::DSL.
-      #
-      # @param model [Vedeu::Groups::Group]
-      # @param client [Object]
-      # @return [Vedeu::Groups::DSL]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Add the named interface to this group.
       #
-      #   Vedeu.group 'main_screen' do
-      #     add 'editor_interface'
+      #   Vedeu.group :main_screen do
+      #     add :editor_interface
       #   end
       #
-      # @param interface_name [String]
+      # @param name [String|Symbol]
       # @return [Vedeu::Groups::Group]
-      def add(interface_name)
-        model.add(interface_name)
+      def add(name)
+        model.add(name)
       end
 
       # Add the named interfaces to this group in bulk.
       #
-      #   Vedeu.group 'main_screen' do
-      #     members ['editor_interface',
-      #              'some_interface',
-      #              'other_interface']
+      #   Vedeu.group :main_screen do
+      #     members [:editor_interface,
+      #              :some_interface,
+      #              :other_interface]
       #   end
       #
-      # @param interface_names [Array<String>]
+      # @param names [Array<String|Symbol>]
       # @return [Array<String>]
-      def members(*interface_names)
-        interface_names.each { |name| add(name) }
+      def members(*names)
+        names.each { |name| add(name) }
       end
 
     end # DSL
 
   end # Groups
 
+  # @!method group
+  #   @see Vedeu::Groups::DSL.group
+  def_delegators Vedeu::Groups::DSL, :group
+
 end # Vedeu

data/lib/vedeu/groups/group.rb

@@ -14,6 +14,12 @@ module Vedeu
       # @return [String]
       attr_accessor :name
 
+      # @param (see #initialize)
+      # @return (see #initialize)
+      def self.store(attributes = {})
+        new(attributes).store
+      end
+
       # Return a new instance of Vedeu::Groups::Group.
       #
       # @note
@@ -23,7 +29,7 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes members [Set] A collection of names of
       #   interfaces belonging to this group.
-      # @option attributes name [String] The name of the group.
+      # @option attributes name [String|Symbol] The name of the group.
       # @option attributes repository
       #   [Vedeu::Repositories::Repository]
       #   The storage for all Group models.
@@ -43,7 +49,7 @@ module Vedeu
       def add(member)
         attrs = attributes.merge!(members: members.add(member))
 
-        Vedeu::Groups::Group.new(attrs).store
+        Vedeu::Groups::Group.store(attrs)
       end
 
       # Returns the attributes of the group.
@@ -66,6 +72,16 @@ module Vedeu
         interfaces.sort { |a, b| a.zindex <=> b.zindex }.map(&:name)
       end
 
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Groups::Group]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && name == other.name &&
+          members == other.members
+      end
+      alias_method :==, :eql?
+
       # Hide the named group of interfaces, or without a name, the
       # group of the currently focussed interface. Useful for hiding
       # part of that which is currently displaying in the terminal.
@@ -102,7 +118,7 @@ module Vedeu
       def remove(member)
         attrs = attributes.merge!(members: members.delete(member))
 
-        Vedeu::Groups::Group.new(attrs).store
+        Vedeu::Groups::Group.store(attrs)
       end
 
       # Remove all members from the group.
@@ -111,7 +127,7 @@ module Vedeu
       def reset
         attrs = defaults.merge!(name: name)
 
-        Vedeu::Groups::Group.new(attrs).store
+        Vedeu::Groups::Group.store(attrs)
       end
 
       # Show the named group of interfaces, or without a name, the
@@ -155,4 +171,12 @@ module Vedeu
 
   end # Groups
 
+  # @!method hide_group
+  #   @see Vedeu::Toggleable::ClassMethods#hide
+  # @!method show_group
+  #   @see Vedeu::Toggleable::ClassMethods#show
+  # @!method toggle_group
+  #   @see Vedeu::Toggleable::ClassMethods#toggle
+  def_delegators Vedeu::Groups::Group, :hide_group, :show_group, :toggle_group
+
 end # Vedeu

data/lib/vedeu/groups/refresh.rb

@@ -16,7 +16,8 @@ module Vedeu
 
       include Vedeu::Common
 
-      # @param name [String] The name of the group to be refreshed.
+      # @param name [String|Symbol] The name of the group to be
+      #   refreshed.
       # @return [Array|Vedeu::Error::ModelNotFound] A collection of
       #   the names of interfaces refreshed, or an exception when the
       #   group was not found.
@@ -26,7 +27,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Groups::Refresh.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Vedeu::Groups::Refresh]
       def initialize(name)
         @name = name

data/lib/vedeu/groups/repository.rb

@@ -21,4 +21,13 @@ module Vedeu
 
   end # Groups
 
+  # Manipulate the repository of groups.
+  #
+  # @example
+  #   Vedeu.groups
+  #
+  # @!method groups
+  # @return [Vedeu::Groups::Repository]
+  def_delegators Vedeu::Groups::Repository, :groups
+
 end # Vedeu

data/lib/vedeu/input/capture.rb

@@ -10,7 +10,7 @@ module Vedeu
       # Instantiate Vedeu::Input::Input and capture keypress(es).
       #
       # @param (see #initialize)
-      # @return [String|Symbol]
+      # @return (see #read)
       def self.read(reader)
         new(reader).read
       end

data/lib/vedeu/input/keymap.rb

@@ -19,7 +19,8 @@ module Vedeu
       # Returns a new instance of Vedeu::Input::Keymap.
       #
       # @param attributes [Hash]
-      # @option attributes name [String] The name of the keymap.
+      # @option attributes name [String|Symbol] The name of the
+      #   keymap.
       # @option attributes keys [Vedeu::Input::Keys|Array]
       #   A collection of keys.
       # @option attributes repository

data/lib/vedeu/input/keymaps.rb

@@ -14,4 +14,13 @@ module Vedeu
 
   end # Input
 
+  # Manipulate the repository of keymaps.
+  #
+  # @example
+  #   Vedeu.keymaps
+  #
+  # @!method keymaps
+  # @return [Vedeu::Input::Keymaps]
+  def_delegators Vedeu::Input::Keymaps, :keymaps
+
 end # Vedeu

data/lib/vedeu/input/mapper.rb

@@ -130,4 +130,8 @@ module Vedeu
 
   end # Input
 
+  # @!method keypress
+  #   @see Vedeu::Input::Mapper.keypress
+  def_delegators Vedeu::Input::Mapper, :keypress
+
 end # Vedeu

data/lib/vedeu/input/translator.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Translator
 
-      # @param code [String]
+      # @param (see #initialize)
       # @return [Symbol]
       def self.translate(code)
         new(code).translate

data/lib/vedeu/logging/debug.rb

@@ -13,6 +13,9 @@ module Vedeu
       # Helps to debug a running application by providing a stack
       # trace of its execution upon exiting.
       #
+      # @example
+      #   Vedeu.debug
+      #
       # @param filename [String]
       # @return [void]
       # @yieldreturn [void] The section of the application to debug.
@@ -81,4 +84,14 @@ module Vedeu
 
   end # Logging
 
+  # Allow debugging via the creation of stack traces courtesy of
+  # ruby-prof.
+  #
+  # @example
+  #   Vedeu.debug
+  #
+  # @!method debug
+  # @return [Vedeu::Logging::Debug]
+  def_delegators Vedeu::Logging::Debug, :debug
+
 end # Vedeu

data/lib/vedeu/logging/log.rb

@@ -178,4 +178,12 @@ module Vedeu
 
   end # Logging
 
+  # @!method log
+  #   @see Vedeu::Logging::Log.log
+  # @!method log_stdout
+  #   @see Vedeu::Logging::Log.log_stdout
+  # @!method log_stderr
+  #   @see Vedeu::Logging::Log.log_stderr
+  def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr
+
 end # Vedeu

data/lib/vedeu/logging/timer.rb

@@ -8,6 +8,8 @@ module Vedeu
 
       class << self
 
+        # Measure the execution time of the code in the given block.
+        #
         # @example
         #   Vedeu.timer 'message' do
         #     # ... code to be measured
@@ -65,4 +67,15 @@ module Vedeu
 
   end # Logging
 
+  # Measure the execution time of the code in the given block.
+  #
+  # @example
+  #   Vedeu.timer do
+  #     # ... some code here ...
+  #   end
+  #
+  # @!method timer
+  #   @see Vedeu::Logging::Timer.timer
+  def_delegators Vedeu::Logging::Timer, :timer
+
 end # Vedeu

data/lib/vedeu/menus/dsl.rb

@@ -9,22 +9,12 @@ module Vedeu
 
       include Vedeu::DSL
 
-      # Return a new instance of Vedeu::Menus::DSL.
-      #
-      # @param model [Vedeu::Menus::Menu]
-      # @param client [Object]
-      # @return [Vedeu::Menus::DSL]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Add an individual item to the menu.
       #
       # @param element [Object] An object you wish to add to the
       #   collection.
       #
-      #   Vedeu.menu 'my_menu' do
+      #   Vedeu.menu :my_menu do
       #     item SomeClass.new
       #     item SomeClass.new
       #   end
@@ -38,14 +28,14 @@ module Vedeu
       # Define the items for the menu. Most powerful when used with
       # one of your model classes.
       #
-      # In the 'my_playlist' example below, your `Track` model may
+      # In the :my_playlist example below, your `Track` model may
       # return a collection of tracks to populate the menu.
       #
-      #   Vedeu.menu 'my_menu' do
+      #   Vedeu.menu :my_menu do
       #     items [:item_1, :item_2, :item_3]
       #   end
       #
-      #   Vedeu.menu 'my_playlist' do
+      #   Vedeu.menu :my_playlist do
       #     items Track.all_my_favourites
       #   end
       #
@@ -61,14 +51,14 @@ module Vedeu
       # your application's execution lifetime.
       #
       #   Vedeu.menu do
-      #     name 'my_menu'
+      #     name :my_menu
       #     # ...
       #   end
       #
-      # @param value [String]
+      # @param name [String|Symbol]
       # @return [String]
-      def name(value)
-        model.name = value
+      def name(name)
+        model.name = name
       end
       alias_method :name=, :name