vedeu 0.6.20 → 0.6.21

data/lib/vedeu/configuration/configuration.rb

@@ -335,4 +335,10 @@ module Vedeu
 
   end # Configuration
 
+  # @!method configure
+  #   @see Vedeu::Configuration.configure
+  # @!method configuration
+  #   @see Vedeu::Configuration.configuration
+  def_delegators Vedeu::Configuration, :configure, :configuration
+
 end # Vedeu

data/lib/vedeu/cursors/cursor.rb

@@ -22,7 +22,7 @@ module Vedeu
       attr_reader :attributes
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       # @!attribute [w] ox
@@ -33,10 +33,6 @@ module Vedeu
       # @return [Fixnum]
       attr_writer :oy
 
-      # @!attribute [r] state
-      # @return [Boolean|Symbol]
-      attr_reader :state
-
       # @!attribute [w] x
       # @return [Fixnum]
       attr_writer :x
@@ -45,7 +41,7 @@ module Vedeu
       # @return [Fixnum]
       attr_writer :y
 
-      # @param attributes [Hash] See #initialize
+      # @param (see #initialize)
       # @return [Vedeu::Cursors::Cursor]
       def self.store(attributes)
         new(attributes).store
@@ -54,8 +50,8 @@ module Vedeu
       # Returns a new instance of Vedeu::Cursors::Cursor.
       #
       # @param attributes [Hash]
-      # @option attributes name [String] The name of the interface
-      #   this cursor belongs to.
+      # @option attributes name [String|Symbol] The name of the
+      #   interface this cursor belongs to.
       # @option attributes ox [Fixnum] The offset x coordinate.
       # @option attributes oy [Fixnum] The offset y coordinate.
       # @option attributes repository
@@ -280,4 +276,13 @@ module Vedeu
 
   end # Cursors
 
+  # @!method hide_cursor
+  #   @see Vedeu::Toggleable::ClassMethods.hide
+  # @!method show_cursor
+  #   @see Vedeu::Toggleable::ClassMethods#show
+  # @!method toggle_cursor
+  #   @see Vedeu::Toggleable::ClassMethods#toggle
+  def_delegators Vedeu::Cursors::Cursor, :hide_cursor, :show_cursor,
+                 :toggle_cursor
+
 end # Vedeu

data/lib/vedeu/cursors/refresh.rb

@@ -21,7 +21,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Cursors::Refresh.
       #
-      # @param name [String] The name of the cursor.
+      # @param name [String|Symbol] The name of the cursor.
       # @return [Vedeu::Cursors::Refresh]
       def initialize(name = nil)
         @name = name || Vedeu.focus
@@ -44,7 +44,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       private

data/lib/vedeu/cursors/repository.rb

@@ -10,8 +10,12 @@ module Vedeu
 
       class << self
 
+        # Fetch the cursor of the currently focussed interface/view.
+        #
+        # @example
+        #   Vedeu.cursor
+        #
         # @return [Vedeu::Cursors::Cursor]
-        # @see Vedeu::API::External.cursor
         def cursor
           cursors.by_name(Vedeu.focus) if Vedeu.focus
         end
@@ -31,4 +35,17 @@ module Vedeu
 
   end # Cursors
 
+  # @!method cursor
+  #   @see Vedeu::Cursors::Repository.cursor
+  def_delegators Vedeu::Cursors::Repository, :cursor
+
+  # Manipulate the repository of cursors.
+  #
+  # @example
+  #   Vedeu.cursors
+  #
+  # @!method cursors
+  # @return [Vedeu::Cursors::Repository]
+  def_delegators Vedeu::Cursors::Repository, :cursors
+
 end # Vedeu

data/lib/vedeu/distributed/server.rb

@@ -87,6 +87,9 @@ module Vedeu
 
       # Restart the DRb server.
       #
+      # @example
+      #   Vedeu.drb_restart
+      #
       # @return [void]
       def restart
         log('Attempting to restart')
@@ -128,6 +131,9 @@ module Vedeu
 
       # Start the DRb server.
       #
+      # @example
+      #   Vedeu.drb_start
+      #
       # @return [Vedeu::Distributed::Server]
       def start
         log('Attempting to start')
@@ -148,6 +154,9 @@ module Vedeu
 
       # Fetch the status of the DRb server.
       #
+      # @example
+      #   Vedeu.drb_status
+      #
       # @return [Symbol]
       def status
         log('Fetching status')
@@ -169,6 +178,9 @@ module Vedeu
 
       # Stop the DRb server.
       #
+      # @example
+      #   Vedeu.drb_stop
+      #
       # @return [void]
       def stop
         log('Attempting to stop')
@@ -225,4 +237,15 @@ module Vedeu
 
   end # Distributed
 
+  # @!method drb_restart
+  #   @see Vedeu::Distributed::Server#restart
+  # @!method drb_start
+  #   @see Vedeu::Distributed::Server#start
+  # @!method drb_status
+  #   @see Vedeu::Distributed::Server#status
+  # @!method drb_stop
+  #   @see Vedeu::Distributed::Server#stop
+  def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
+                 :drb_status, :drb_stop
+
 end # Vedeu

data/lib/vedeu/distributed/templates/default_borders.vedeu

@@ -1,4 +1,4 @@
-Vedeu.border 'test_interface' do
+Vedeu.border :test_interface do
   # Define colour and style of border
   colour foreground: '#ffff00', background: '#0000ff'
   style  'normal'

data/lib/vedeu/distributed/templates/default_geometries.vedeu

@@ -1,4 +1,4 @@
-Vedeu.geometry 'test_interface' do
+Vedeu.geometry :test_interface do
   # centred!
   height 6
   width  26

data/lib/vedeu/distributed/templates/default_interfaces.vedeu

@@ -1,4 +1,4 @@
-Vedeu.interface 'test_interface' do
+Vedeu.interface :test_interface do
   colour foreground: '#ff0000', background: '#000000'
   cursor!
 end

data/lib/vedeu/distributed/templates/default_keymaps.vedeu

@@ -1,4 +1,4 @@
-Vedeu.keymap 'test_interface' do
+Vedeu.keymap :test_interface do
   key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
   key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
   key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }

data/lib/vedeu/distributed/templates/default_menus.vedeu

@@ -1,3 +1,3 @@
-Vedeu.menu 'test_interface' do
+Vedeu.menu :test_interface do
   # ...
 end

data/lib/vedeu/distributed/templates/default_views.vedeu

@@ -1,5 +1,5 @@
 Vedeu.renders do
-  view 'test_interface' do
+  view :test_interface do
     lines do
       line 'a1b1c1d1e1f1g1h1i1j1k1l1m1n1o1p1q1r1s1t1u1v1w1x1y1z1'
       line 'a2b2c2d2e2f2g2h2i2j2k2l2m2n2o2p2q2r2s2t2u2v2w2x2y2z2'

data/lib/vedeu/dsl/composition.rb

@@ -42,16 +42,6 @@ module Vedeu
 
       include Vedeu::DSL
 
-      # Returns an instance of DSL::Composition.
-      #
-      # @param model [Vedeu::Views::Composition]
-      # @param client [Object]
-      # @return [Vedeu::DSL::Composition]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Define a view.
       #
       # A view is just an Interface object.
@@ -61,13 +51,13 @@ module Vedeu
       # don't need to specify everything again.
       #
       # @todo More documentation required.
-      # @param name [String] The name of the interface you are
+      # @param name [String|Symbol] The name of the interface you are
       #   targetting for this view.
       # @param block [Proc] The directives you wish to send to this
       #   interface.
       #
       # @example
-      #   view 'my_interface' do
+      #   view :my_interface do
       #     # ...
       #   end
       #
@@ -85,14 +75,14 @@ module Vedeu
       #
       # @example
       #   Vedeu.renders do
-      #     template_for('my_interface',
+      #     template_for(:my_interface,
       #                  '/path/to/template.erb',
       #                  @some_object, options)
       #   end
       #
       # @todo More documentation required.
       #
-      # @param name [String] The name of interface for which this
+      # @param name [String|Symbol] The name of interface for which this
       #   template's content belongs to.
       # @param filename [String] The filename (including path) to the
       #   template to be used. Yoy can use `File.dirname(__FILE__)` to
@@ -123,7 +113,7 @@ module Vedeu
 
       private
 
-      # @param name [String]
+      # @param name [String|Symbol]
       # @param lines [Vedeu::Views::Lines]
       # @return [Hash]
       def template_attributes(name, lines)
@@ -133,7 +123,7 @@ module Vedeu
       # Return the current attributes combined with the existing
       # interface attributes defined by the interface.
       #
-      # @param name [String] The name of the interface.
+      # @param name [String|Symbol] The name of the interface.
       # @return [Hash]
       def new_attributes(name)
         attributes.merge!(existing_attributes(name))
@@ -141,7 +131,7 @@ module Vedeu
 
       # Retrieve the attributes of the interface by name.
       #
-      # @param name [String] The name of the interface.
+      # @param name [String|Symbol] The name of the interface.
       # @return [Hash]
       def existing_attributes(name)
         Vedeu.interfaces.by_name(name).attributes

data/lib/vedeu/dsl/dsl.rb

@@ -4,6 +4,18 @@ module Vedeu
   #
   module DSL
 
+    # Returns an instance of the DSL class including {Vedeu::DSL}.
+    #
+    # @param model [void] The model class which the DSL class is
+    #   wrapping.
+    # @param client [void] The class where the DSL methods are being
+    #   used.
+    # @return [void] An instance of the DSL class.
+    def initialize(model, client = nil)
+      @model  = model
+      @client = client
+    end
+
     protected
 
     # @!attribute [r] client

data/lib/vedeu/dsl/interface.rb

@@ -22,12 +22,12 @@ module Vedeu
         # define your the views of your application without their
         # content.
         #
-        #   Vedeu.interface 'my_interface' do
+        #   Vedeu.interface :my_interface do
         #     # ... some code
         #   end
         #
-        # @param name [String] The name of the interface. Used to
-        #   reference the interface throughout your application's
+        # @param name [String|Symbol] The name of the interface. Used
+        #   to reference the interface throughout your application's
         #   execution lifetime.
         # @param block [Proc] A set of attributes which define the
         #   features of the interface.
@@ -54,6 +54,7 @@ module Vedeu
         # registered, and also adds interface's name to list of
         # focussable interfaces.
         #
+        # @param name [String|Symbol]
         # @see Vedeu::Buffers::Buffer
         # @return [Vedeu::Buffers::Buffer]
         def add_buffers!(name)
@@ -63,6 +64,7 @@ module Vedeu
         # Registers a new cursor for the interface unless already
         # registered.
         #
+        # @param name [String|Symbol]
         # @return [Vedeu::Cursors::Cursor]
         def add_cursor!(name)
           Vedeu::Cursors::Cursor.store(name: name)
@@ -71,6 +73,7 @@ module Vedeu
         # Registers interface name in focus list unless already
         # registered.
         #
+        # @param name [String|Symbol]
         # @return [void]
         def add_focusable!(name)
           Vedeu.focusable.add(name) unless Vedeu.focusable.registered?(name)
@@ -86,16 +89,6 @@ module Vedeu
 
       end # Eigenclass
 
-      # Returns an instance of Vedeu::DSL::Interface.
-      #
-      # @param model [Vedeu::DSL::Interface]
-      # @param client [Object]
-      # @return [Vedeu::DSL::Interface]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Set the cursor visibility on an interface.
       #
       # @param value [Boolean] Any value other than nil or false will
@@ -103,7 +96,7 @@ module Vedeu
       #   to true.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     cursor  true  # => show the cursor for this interface
       #     # or...
       #     cursor  :show # => both of these are equivalent to line
@@ -113,14 +106,14 @@ module Vedeu
       #     # ...
       #   end
       #
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     cursor false # => hide the cursor for this interface
       #     # or...
       #     cursor nil   # => as above
       #     # ...
       #   end
       #
-      #   Vedeu.view 'my_interface' do
+      #   Vedeu.view :my_interface do
       #     cursor true # => Specify the visibility of the cursor when
       #                 #    the view is rendered.
       #     # ...
@@ -147,7 +140,7 @@ module Vedeu
       # @param value [Fixnum|Float] Time in seconds. (0.5 = 500ms).
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     delay 0.5 # interface will not update more often than
       #               # every 500ms.
       #     # ...
@@ -166,7 +159,7 @@ module Vedeu
       #   focus. However, this behaviour can be overridden:
       #
       #   ```ruby
-      #   Vedeu.focus_by_name 'some_interface'
+      #   Vedeu.focus_by_name :some_interface
       #   ```
       #
       #   When the above is specified (outside of a `Vedeu.interface`
@@ -182,13 +175,13 @@ module Vedeu
       # multiple interfaces at once.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
-      #     group 'main_screen'
+      #   Vedeu.interface :my_interface do
+      #     group :main_screen
       #     # ...
       #   end
       #
-      # @param name [String] The name of the group to which this
-      #   interface should belong.
+      # @param name [String|Symbol] The name of the group to which
+      #   this interface should belong.
       # @return [Vedeu::Groups::Group]
       def group(name)
         return false unless present?(name)
@@ -198,6 +191,8 @@ module Vedeu
         Vedeu.groups.by_name(name).add(model.name)
       end
 
+      # @param name [String|Symbol] The name of the interface to which
+      #   this keymap should belong.
       # @see Vedeu::DSL::Keymap.keymap
       def keymap(name = model.name, &block)
         Vedeu.keymap(name, &block)
@@ -207,15 +202,15 @@ module Vedeu
       # The name of the interface. Used to reference the interface
       # throughout your application's execution lifetime.
       #
-      # @param value [String]
+      # @param value [String|Symbol]
       #
       # @example
       #   Vedeu.interface do
-      #     name 'my_interface'
+      #     name :my_interface
       #     # ...
       #   end
       #
-      # @return [String]
+      # @return [String|Symbol]
       def name(value)
         model.name = value
       end
@@ -230,7 +225,7 @@ module Vedeu
       # Set the interface to visible.
       #
       # @example
-      #   Vedeu.interface('my_interface') do
+      #   Vedeu.interface :my_interface do
       #     show!
       #
       #     # ... some code
@@ -244,7 +239,7 @@ module Vedeu
       # Set the interface to invisible.
       #
       # @example
-      #   Vedeu.interface('my_interface') do
+      #   Vedeu.interface :my_interface do
       #     # ... some code
       #   end
       #
@@ -255,8 +250,8 @@ module Vedeu
 
       # Use a value from another model.
       #
-      # @param name [String] The name of the interface model you wish
-      #   to use a value from.
+      # @param name [String|Symbol] The name of the interface model
+      #   you wish to use a value from.
       # @return [Vedeu::Models::Interface]
       def use(name)
         model.repository.by_name(name)
@@ -268,21 +263,21 @@ module Vedeu
       #   evaluate to true.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     visible true  # => show the interface
       #     # or...
       #     show!         # => as above
       #     # ... some code
       #   end
       #
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     visible false # => hide the interface
       #     # or...
       #     hide!         # => as above
       #     # ... some code
       #   end
       #
-      #   Vedeu.view 'my_interface' do
+      #   Vedeu.view :my_interface do
       #     visible false
       #     # ... some code
       #   end
@@ -304,7 +299,7 @@ module Vedeu
       #   --2--
       #   --1-- # rendered first
       #
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     zindex 3
       #     # ...
       #   end
@@ -321,4 +316,8 @@ module Vedeu
 
   end # DSL
 
+  # @!method interface
+  #   @see Vedeu::DSL::Interface.interface
+  def_delegators Vedeu::DSL::Interface, :interface
+
 end # Vedeu