vedeu 0.4.2 → 0.4.3

data/lib/vedeu/configuration/api.rb

@@ -7,8 +7,6 @@ module Vedeu
     # The Configuration::API class parses client application configuration into
     # options used by Vedeu to affect certain behaviours.
     #
-    # @api private
-    #
     class API
 
       include Vedeu::Common

data/lib/vedeu/configuration/cli.rb

@@ -7,8 +7,6 @@ module Vedeu
     # The Configuration::CLI class parses command-line arguments using
     # OptionParser into options used by Vedeu to affect certain behaviours.
     #
-    # @api private
-    #
     class CLI
 
       # Configure Vedeu via command-line arguments. Options set here via

data/lib/vedeu/configuration/configuration.rb

@@ -33,8 +33,6 @@ module Vedeu
   # application settings (via the configuration API), or any command-line
   # arguments provided.
   #
-  # @api private
-  #
   class Configuration
 
     include Singleton

data/lib/vedeu/cursor/cursor.rb

@@ -8,8 +8,6 @@ module Vedeu
   # Each interface has its own Cursor which maintains the position and
   # visibility of the cursor within that interface.
   #
-  # @api private
-  #
   class Cursor
 
     extend Forwardable

data/lib/vedeu/debug.rb

@@ -1,5 +1,3 @@
-require 'ruby-prof'
-
 module Vedeu
 
   # Helps to debug a running application by providing a stack trace of its
@@ -8,6 +6,8 @@ module Vedeu
   # @param filename [String]
   # @param block [Proc]
   def self.debug(filename = 'profile.html', &block)
+    require 'ruby-prof'
+
     RubyProf.start
 
     yield

data/lib/vedeu/distributed/server.rb

@@ -7,8 +7,6 @@ module Vedeu
 
     # A class for the server side of the DRb server/client relationship.
     #
-    # @api private
-    #
     class Server
 
       $SAFE = 1 # disable `eval` and related calls on strings passed

data/lib/vedeu/dsl/components/border.rb

@@ -28,25 +28,21 @@ module Vedeu
       include Vedeu::DSL::Colour
       include Vedeu::DSL::Style
 
-      class << self
-
-        # Specify the border of an interface or view with a simple DSL.
-        #
-        # @example
-        #   Vedeu.border 'some_interface' do
-        #     # ...
-        #
-        # @param name [String] The name of the interface or view to which this
-        #   border belongs.
-        # @param block [Proc]
-        # @raise [InvalidSyntax] The required block was not given.
-        # @return [Vedeu::Border]
-        def border(name, &block)
-          fail InvalidSyntax, 'block not given' unless block_given?
-
-          Vedeu::Border.build({ enabled: true, name: name }, &block).store
-        end
-
+      # Specify the border of an interface or view with a simple DSL.
+      #
+      # @example
+      #   Vedeu.border 'some_interface' do
+      #     # ...
+      #
+      # @param name [String] The name of the interface or view to which this
+      #   border belongs.
+      # @param block [Proc]
+      # @raise [InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Border]
+      def self.border(name, &block)
+        fail InvalidSyntax, 'block not given' unless block_given?
+
+        Vedeu::Border.build({ enabled: true, name: name }, &block).store
       end
 
       # Returns an instance of DSL::Border.

data/lib/vedeu/dsl/components/geometry.rb

@@ -12,25 +12,21 @@ module Vedeu
       include Vedeu::DSL
       include Vedeu::DSL::Use
 
-      class << self
-
-        # Specify the geometry of an interface or view with a simple DSL.
-        #
-        # @example
-        #   Vedeu.geometry 'some_interface' do
-        #     # ...
-        #
-        # @param name [String] The name of the interface or view to which this
-        #   geometry belongs.
-        # @param block [Proc]
-        # @raise [InvalidSyntax] The required block was not given.
-        # @return [Vedeu::Geometry]
-        def geometry(name, &block)
-          fail InvalidSyntax, 'block not given' unless block_given?
-
-          Vedeu::Geometry.build({ name: name }, &block).store
-        end
+      # Specify the geometry of an interface or view with a simple DSL.
+      #
+      # @example
+      #   Vedeu.geometry 'some_interface' do
+      #     # ...
+      #
+      # @param name [String] The name of the interface or view to which this
+      #   geometry belongs.
+      # @param block [Proc]
+      # @raise [InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Geometry]
+      def self.geometry(name, &block)
+        fail InvalidSyntax, 'block not given' unless block_given?
 
+        Vedeu::Geometry.build({ name: name }, &block).store
       end
 
       # Returns an instance of DSL::Geometry.

data/lib/vedeu/dsl/components/keymap.rb

@@ -15,38 +15,34 @@ module Vedeu
       include Vedeu::Common
       include Vedeu::DSL
 
-      class << self
-
-        # Define actions for keypresses for when specific interfaces are in focus.
-        # Unless an interface is specified, the key will be assumed to be global,
-        # meaning its action will happen regardless of the interface in focus.
-        #
-        # @note
-        #   When defining an interface, there is no need to provide a name since
-        #   this can be discerned from the interface itself, e.g:
-        #
-        #   Vedeu.interface 'my_interface' do
-        #     keymap do
-        #       ...
-        #
-        # @param name [String] The name of the interface which this keymap relates
-        #   to.
-        # @param block [Proc]
-        #
-        # @example
-        #   keymap 'my_interface' do
-        #     ...
-        #
-        # @raise [InvalidSyntax] The required block was not given.
-        # @return [Keymap]
-        # @todo Try to remember why we need to pre-create the keymap in the
-        #   repository.
-        def keymap(name, &block)
-          Vedeu::Keymap.new({ name: name }).store
-
-          Vedeu::Keymap.build({ name: name }, &block).store
-        end
-
+      # Define actions for keypresses for when specific interfaces are in focus.
+      # Unless an interface is specified, the key will be assumed to be global,
+      # meaning its action will happen regardless of the interface in focus.
+      #
+      # @note
+      #   When defining an interface, there is no need to provide a name since
+      #   this can be discerned from the interface itself, e.g:
+      #
+      #   Vedeu.interface 'my_interface' do
+      #     keymap do
+      #       ...
+      #
+      # @param name [String] The name of the interface which this keymap relates
+      #   to.
+      # @param block [Proc]
+      #
+      # @example
+      #   keymap 'my_interface' do
+      #     ...
+      #
+      # @raise [InvalidSyntax] The required block was not given.
+      # @return [Keymap]
+      # @todo Try to remember why we need to pre-create the keymap in the
+      #   repository.
+      def self.keymap(name, &block)
+        Vedeu::Keymap.new({ name: name }).store
+
+        Vedeu::Keymap.build({ name: name }, &block).store
       end
 
       # Returns an instance of DSL::Keymap.

data/lib/vedeu/dsl/composition.rb

@@ -13,6 +13,8 @@ module Vedeu
       # Returns an instance of DSL::Composition.
       #
       # @param model [Composition]
+      # @param client [Object]
+      # @return [Vedeu::DSL::Composition]
       def initialize(model, client = nil)
         @model  = model
         @client = client
@@ -22,6 +24,10 @@ module Vedeu
       #
       # A view is just an Interface object.
       #
+      # When a view already exists, we take its attributes and use them as the
+      # basis for the newly defined view. This way we don't need to specify
+      # everything again.
+      #
       # @todo More documentation required.
       # @param name [String] The name of the interface you are targetting for
       #   this view.
@@ -36,22 +42,34 @@ module Vedeu
       def view(name = '', &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        new_member = if Vedeu.interfaces.registered?(name)
-          existing_member = Vedeu.interfaces.find(name)
-          model.member.build(attributes.merge!(existing_member.attributes), &block)
-
-        else
-          model.member.build(attributes.merge!({ name: name }), &block)
-
-        end
+        new_model = model.member.build(new_attributes(name), &block)
 
-        model.add(new_member)
+        model.add(new_model)
       end
 
       private
 
       attr_reader :client, :model
 
+      # @param name [String] The name of the interface.
+      # @return [Hash]
+      def new_attributes(name)
+        attributes.merge!(existing_interface_attributes(name))
+      end
+
+      # @param name [String] The name of the interface.
+      # @return [Hash]
+      def existing_interface_attributes(name)
+        if model.repository.registered?(name)
+          stored = model.repository.find(name)
+          stored.attributes
+
+        else
+          { name: name }
+
+        end
+      end
+
       # @return [Hash]
       def attributes
         {

data/lib/vedeu/events/all.rb

@@ -1,3 +1,4 @@
+require 'vedeu/events/events'
 require 'vedeu/events/event'
 require 'vedeu/events/trigger'
 

data/lib/vedeu/events/event.rb

@@ -32,8 +32,6 @@ module Vedeu
   #     :do_stuff
   #   end
   #
-  # @api private
-  #
   class Event
 
     include Vedeu::Model
@@ -91,11 +89,6 @@ module Vedeu
       alias_method :event, :bind
       alias_method :register, :bind
 
-      # @see Vedeu::Trigger.trigger
-      def trigger(name, *args)
-        Vedeu::Trigger.trigger(name, *args)
-      end
-
       # Unbind events from a named handler.
       #
       # @param name [String]
@@ -112,6 +105,11 @@ module Vedeu
 
     end
 
+    # @see Vedeu::Trigger.trigger
+    def self.trigger(name, *args)
+      Vedeu::Trigger.trigger(name, *args)
+    end
+
     # Returns a new instance of Event.
     #
     # @param name [Symbol]
@@ -135,7 +133,7 @@ module Vedeu
         new_collection = collection.add(self)
 
       else
-        new_collection = Vedeu::Model::Collection.new([self], nil, name)
+        new_collection = Vedeu::Events.new([self], nil, name)
 
       end
 

data/lib/vedeu/events/events.rb

@@ -0,0 +1,10 @@
+require 'vedeu/models/collection'
+
+module Vedeu
+
+  # A collection of {Vedeu::Event} instances.
+  #
+  class Events < Vedeu::Model::Collection
+  end # Events
+
+end # Vedeu

data/lib/vedeu/events/trigger.rb

@@ -8,20 +8,14 @@ module Vedeu
   # @example
   #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
   #
-  # @api private
-  #
   class Trigger
 
-    class << self
-
-      # @param name [Symbol] The name of the event you wish to trigger. The event
-      #   does not have to exist.
-      # @param args [Array] Any arguments the event needs to execute correctly.
-      # @return [Array]
-      def trigger(name, *args)
-        new(name, *args).trigger
-      end
-
+    # @param name [Symbol] The name of the event you wish to trigger. The event
+    #   does not have to exist.
+    # @param args [Array] Any arguments the event needs to execute correctly.
+    # @return [Array]
+    def self.trigger(name, *args)
+      new(name, *args).trigger
     end
 
     # @see Vedeu::Trigger.trigger

data/lib/vedeu/geometry/grid.rb

@@ -24,8 +24,6 @@ module Vedeu
   # Divides horizontal terminal space into 12 equal columns, discarding
   # the remainder.
   #
-  # @api private
-  #
   class Grid
 
     # @param value [Fixnum]

data/lib/vedeu/geometry/position.rb

@@ -2,8 +2,6 @@ module Vedeu
 
   # Change coordinates into an escape sequence to set the cursor position.
   #
-  # @api private
-  #
   class Position
 
     attr_reader  :y,

data/lib/vedeu/geometry/position_validator.rb

@@ -104,20 +104,6 @@ module Vedeu
       self
     end
 
-    # def x
-    #   @x = [[[[@x, tx].max, txn].min, left].max, right].min
-    #   @x = border? && left?  ? [@x, (left + 1)].max  : @x
-    #   @x = border? && right? ? [@x, (right - 2)].min : @x
-    #   @x
-    # end
-
-    # def y
-    #   @y = [[[[@y, ty].max, tyn].min, top].max, bottom].min
-    #   @y = border? && top?    ? [@y, (top + 1)].max    : @y
-    #   @y = border? && bottom? ? [@y, (bottom - 2)].min : @y
-    #   @y
-    # end
-
   end # PositionValidator
 
 end # Vedeu

data/lib/vedeu/input/input.rb

@@ -3,8 +3,6 @@ module Vedeu
   # Captures input from the user via {Vedeu::Terminal#input} and translates
   # special characters into symbols.
   #
-  # @api private
-  #
   class Input
 
     # Instantiate Input and capture keypress(es).

data/lib/vedeu/models/collection.rb

@@ -5,8 +5,6 @@ module Vedeu
     # Convert an Array into an object which has some meaning in the context it
     # is being used.
     #
-    # @private
-    #
     class Collection
 
       include Enumerable

data/lib/vedeu/models/focus.rb

@@ -4,7 +4,6 @@ module Vedeu
   # serving to store and manipulate the which interface is currently being
   # focussed.
   #
-  # @api private
   module Focus
 
     extend self

data/lib/vedeu/models/geometry.rb

@@ -10,7 +10,7 @@ module Vedeu
   # @todo Consider storing the Terminal size at the time of first creation,
   # this allows us to return the interface to its original dimensions if
   # the terminal resizes back to normal size.
-
+  #
   # Calculates and provides interface geometry determined by both the client's
   # requirements and the terminal's current viewing area.
   #
@@ -27,8 +27,6 @@ module Vedeu
   #    yn +--------------+           # south:  yn + 1
   #            south
   #
-  # @api private
-  #
   class Geometry
 
     include Vedeu::Model
@@ -137,6 +135,9 @@ module Vedeu
     # Returns the top coordinate of the interface, a fixed or dynamic value
     # depending on whether the interface is centred or not.
     #
+    # @note
+    #   Division which results in a non-integer will be rounded down.
+    #
     # @return [Fixnum]
     def top
       if centred
@@ -166,6 +167,9 @@ module Vedeu
     # Returns the left coordinate of the interface, a fixed or dynamic value
     # depending on whether the interface is centred or not.
     #
+    # @note
+    #   Division which results in a non-integer will be rounded down.
+    #
     # @return [Fixnum]
     def left
       if centred