vedeu 0.8.15 → 0.8.16

data/lib/vedeu/dsl/view.rb

@@ -46,8 +46,7 @@ module Vedeu
       include Vedeu::DSL
 
       # {include:file:docs/dsl/by_method/view.md}
-      # @param name [String|Symbol] The name of the interface you are
-      #   targetting for this view.
+      # @macro param_name
       # @param block [Proc] The directives you wish to send to this
       #   view.
       # @macro raise_requires_block
@@ -75,8 +74,7 @@ module Vedeu
       #
       # @todo More documentation required.
       #
-      # @param name [String|Symbol] The name of interface for which this
-      #   template's content belongs to.
+      # @macro param_name
       # @param filename [String] The filename (including path) to the
       #   template to be used. Yoy can use `File.dirname(__FILE__)` to
       #   use relative paths.
@@ -109,7 +107,7 @@ module Vedeu
 
       private
 
-      # @param name [String|Symbol]
+      # @macro param_name
       # @param lines [Vedeu::Views::Lines]
       # @return [Hash<Symbol => void>]
       def template_attributes(name, lines)
@@ -119,7 +117,7 @@ module Vedeu
       # Return the current attributes combined with the existing
       # interface attributes defined by the interface.
       #
-      # @param name [String|Symbol] The name of the interface.
+      # @macro param_name
       # @return [Hash<Symbol => void>]
       def new_attributes(name)
         existing_attributes(name).merge!(attributes)
@@ -127,7 +125,7 @@ module Vedeu
 
       # Retrieve the attributes of the interface by name.
       #
-      # @param name [String|Symbol] The name of the interface.
+      # @macro param_name
       # @return [Hash<Symbol => void>]
       def existing_attributes(name)
         interface(name).attributes

data/lib/vedeu/editor/cropper.rb

@@ -25,7 +25,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Editor::Cropper.
       #
       # @param lines [Vedeu::Editor::Lines]
-      # @param name [String|Symbol]
+      # @macro param_name
       # @param ox [Fixnum]
       # @param oy [Fixnum]
       # @return [Vedeu::Editor::Cropper]

data/lib/vedeu/editor/editor.rb

@@ -35,7 +35,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Editor::Editor.
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @param input [String|Symbol]
       # @return [Vedeu::Editor::Editor]
       def initialize(input:, name:)

data/lib/vedeu/events/event.rb

@@ -41,8 +41,7 @@ module Vedeu
         # which when triggered will execute the code contained within
         # the passed block.
         #
-        # @param name [Symbol] The name of the event to be triggered
-        #   later.
+        # @macro param_name
         # @param options [Hash<Symbol => void>] The options to
         #   register the event with.
         # @option options :delay [Fixnum|Float] Limits the execution
@@ -94,7 +93,7 @@ module Vedeu
         alias register bind
 
         # {include:file:docs/dsl/by_method/bound.md}
-        # @param name [Symbol]
+        # @macro param_name
         # @return [Boolean]
         def bound?(name)
           Vedeu.events.registered?(name) ||
@@ -102,7 +101,7 @@ module Vedeu
         end
 
         # {include:file:docs/dsl/by_method/unbind.md}
-        # @param name [Symbol]
+        # @macro param_name
         # @return [Boolean]
         def unbind(name)
           return false unless Vedeu.bound?(name)

data/lib/vedeu/events/trigger.rb

@@ -26,8 +26,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Events::Trigger.
       #
-      # @param name [Symbol] The name of the event you wish to
-      #   trigger. The event does not have to exist.
+      # @macro param_name
       # @param args [Array] Any arguments the event needs to execute
       #   correctly.
       # @return [Vedeu::Events::Trigger]

data/lib/vedeu/geometries/area/area.rb

@@ -82,7 +82,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Area.
       #
-      # @param name [Symbol|String]
+      # @macro param_name
       # @param y [Fixnum] The starting row/line position.
       # @param yn [Fixnum] The ending row/line position.
       # @param x [Fixnum] The starting column/character position.

data/lib/vedeu/groups/clear.rb

@@ -10,13 +10,8 @@ module Vedeu
 
       class << self
 
-        # Clears the group of interfaces belonging to the given name.
-        #
-        # @example
-        #   Vedeu.trigger(:_clear_group_, name)
-        #   Vedeu.clear_by_group(name)
-        #
-        # @param name [String|Symbol]
+        # {include:file:docs/dsl/by_method/clear_by_group.md}
+        # @macro param_name
         # @return [void]
         def render(name)
           new(name).render
@@ -28,7 +23,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Groups::Clear.
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [Vedeu::Groups::Clear]
       def initialize(name)
         @name = name

data/lib/vedeu/groups/dsl.rb

@@ -54,7 +54,7 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @param name [String|Symbol] The name of this group.
+      # @macro param_name
       # @param block [Proc]
       # @macro raise_requires_block
       # @return [Vedeu::Groups::Group]
@@ -71,7 +71,7 @@ module Vedeu
       #     add :editor_interface
       #   end
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [Vedeu::Groups::Group]
       def add(name)
         model.add(name)

data/lib/vedeu/groups/refresh.rb

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

data/lib/vedeu/input/capture.rb

@@ -50,7 +50,7 @@ module Vedeu
       #
       # @return [Array|String|Symbol]
       def read
-        Vedeu.log(type: :input, message: 'Waiting for user input...')
+        Vedeu.log(type: :input, message: "Waiting for user input...\n")
 
         if raw_mode?
           Vedeu.trigger(:_keypress_, keypress)

data/lib/vedeu/input/dsl.rb

@@ -57,8 +57,7 @@ module Vedeu
       #
       #   This is also used when defining the '_global_' keymap.
       #
-      # @param name [String|Symbol] The name of the interface which
-      #   this keymap relates to.
+      # @macro param_name
       # @param block [Proc]
       # @macro raise_requires_block
       # @macro raise_missing_required

data/lib/vedeu/input/mapper.rb

@@ -28,7 +28,7 @@ module Vedeu
         end
 
         # @param key [String|Symbol] The keypress.
-        # @param name [String|Symbol] The keymap name.
+        # @macro param_name
         # @macro raise_missing_required
         # @return [Boolean]
         def registered?(key = nil, name = nil)
@@ -59,7 +59,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Input::Mapper.
       #
       # @param key [NilClass|String|Symbol]
-      # @param name [NilClass|String]
+      # @macro param_name
       # @param repository [NilClass|Vedeu::Repositories::Repository]
       # @return [Vedeu::Input::Mapper]
       def initialize(key = nil, name = nil, repository = nil)

data/lib/vedeu/interfaces/clear.rb

@@ -12,12 +12,7 @@ module Vedeu
 
       class << self
 
-        # Clear the interface with the given name.
-        #
-        # @example
-        #   Vedeu.trigger(:_clear_view_, name)
-        #   Vedeu.clear_by_name(name)
-        #
+        # {include:file:docs/dsl/by_method/clear_by_name.md}
         # @return [Array<Array<Vedeu::Cells::Char>>]
         # @see #initialize
         def render(name = Vedeu.focus)
@@ -28,12 +23,7 @@ module Vedeu
         alias clear_by_name render
         alias by_name render
 
-        # Clear the content of the interface with the given name.
-        #
-        # @example
-        #   Vedeu.trigger(:_clear_view_content_, name)
-        #   Vedeu.clear_content_by_name(name)
-        #
+        # {include:file:docs/dsl/by_method/clear_content_by_name.md}
         # @return [Array<Array<Vedeu::Cells::Char>>]
         # @see #initialize
         def clear_content_by_name(name = Vedeu.focus)
@@ -46,8 +36,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Interfaces::Clear.
       #
-      # @param name [String|Symbol] The name of the interface to
-      #   clear.
+      # @macro param_name
       # @param options [Hash]
       # @option options content_only [Boolean] Only clear the content
       #   not the border as well. Defaults to false.

data/lib/vedeu/interfaces/dsl.rb

@@ -29,9 +29,7 @@ module Vedeu
         #     # ... some code
         #   end
         #
-        # @param name [String|Symbol] The name of the interface. Used
-        #   to reference the interface throughout your application's
-        #   execution lifetime.
+        # @macro param_name
         # @param block [Proc] A set of attributes which define the
         #   features of the interface.
         # @macro raise_requires_block
@@ -63,7 +61,7 @@ module Vedeu
         # registered, and also adds interface's name to list of
         # focussable interfaces.
         #
-        # @param name [String|Symbol]
+        # @macro param_name
         # @see Vedeu::Buffers::Buffer
         # @return [Vedeu::Buffers::Buffer]
         def add_buffers!(name)
@@ -73,7 +71,7 @@ module Vedeu
         # Registers a new cursor for the interface unless already
         # registered.
         #
-        # @param name [String|Symbol]
+        # @macro param_name
         # @return [Vedeu::Cursors::Cursor]
         def add_cursor!(name)
           Vedeu::Cursors::Cursor.store(name: name)
@@ -81,7 +79,7 @@ module Vedeu
 
         # Registers a new document with the interface.
         #
-        # @param name [String|Symbol]
+        # @macro param_name
         def add_editor!(name)
           Vedeu::Editor::Document.store(name: name)
         end
@@ -89,7 +87,7 @@ module Vedeu
         # Registers interface name in focus list unless already
         # registered.
         #
-        # @param name [String|Symbol]
+        # @macro param_name
         # @return [Array<String|Symbol>]
         def add_focusable!(name)
           Vedeu::Models::Focus.add(name)
@@ -98,7 +96,7 @@ module Vedeu
         # Registers a new keymap for the interface unless already
         # registered.
         #
-        # @param name [String|Symbol]
+        # @macro param_name
         # @return [NilClass|Vedeu::Input::Keymap]
         def add_keymap!(name)
           Vedeu::Input::Keymap.store(name: name) unless keymap?(name)
@@ -114,7 +112,7 @@ module Vedeu
 
         private
 
-        # @param name [String|Symbol]
+        # @macro param_name
         # @return [Boolean]
         def keymap?(name)
           Vedeu.keymaps.registered?(name)
@@ -214,8 +212,7 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @param name [String|Symbol] The name of the group to which
-      #   this interface should belong.
+      # @macro param_name
       # @return [Vedeu::Groups::Group]
       def group(name)
         return false unless present?(name)
@@ -225,8 +222,7 @@ 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.
+      # @macro param_name
       # @see Vedeu::Input::DSL.keymap
       def keymap(name = model.name, &block)
         Vedeu.keymap(name, &block)
@@ -262,8 +258,7 @@ module Vedeu
 
       # Use a value from another model.
       #
-      # @param name [String|Symbol] The name of the interface model
-      #   you wish to use a value from.
+      # @macro param_name
       # @return [Vedeu::Interfaces::Interface]
       def use(name)
         model.repository.by_name(name)

data/lib/vedeu/interfaces/repository.rb

@@ -13,15 +13,15 @@ module Vedeu
       null Vedeu::Interfaces::Null
       real Vedeu::Interfaces::Interface
 
-      # Returns the interfaces in zindex order.
+      # Returns the interface names in zindex order.
       #
       # @example
       #   Vedeu.interfaces.zindexed
       #
-      # @return [Array<Vedeu::Interfaces::Interface>]
+      # @return [Array<String|Symbol>]
       # @see Vedeu::Interfaces::DSL#zindex
       def zindexed
-        all.sort_by(&:zindex)
+        all.sort_by(&:zindex).map(&:name)
       end
 
     end # Interfaces

data/lib/vedeu/menus/dsl.rb

@@ -17,8 +17,7 @@ module Vedeu
         # items for your users to select; and provide interactivity
         # within your application.
         #
-        # @param name [String|Symbol] The name of the interface or
-        #   view to which this menu belongs.
+        # @macro param_name
         # @param block [Proc] A set of attributes which define the
         #   features of the menu.
         #

data/lib/vedeu/models/focus.rb

@@ -25,7 +25,7 @@ module Vedeu
       # Add an interface name to the focus list unless it is already
       # registered.
       #
-      # @param name [String|Symbol] The name of the interface.
+      # @macro param_name
       # @param focus [Boolean] When true, prepends the interface name
       #   to the collection, making that interface the currently
       #   focussed interface.
@@ -51,8 +51,7 @@ module Vedeu
       #   Vedeu.trigger(:_focus_by_name_, name)
       #   Vedeu.focus_by_name('name')
       #
-      # @param name [String|Symbol] The interface to focus; must be
-      #   defined.
+      # @macro param_name
       # @raise [Vedeu::Error::ModelNotFound] When the interface cannot
       #   be found.
       # @return [String|Symbol] The name of the interface now in
@@ -86,7 +85,7 @@ module Vedeu
       # @example
       #   Vedeu.focussed?(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [Boolean]
       def current?(name)
         current == name
@@ -184,7 +183,7 @@ module Vedeu
       # Returns a boolean indicating whether the named model is
       # registered.
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [Boolean]
       def registered?(name)
         return false if storage.empty?

data/lib/vedeu/models/toggleable.rb

@@ -53,7 +53,7 @@ module Vedeu
       #   Vedeu.hide_group(name)
       #   Vedeu.hide_interface(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [void]
       def hide(name = Vedeu.focus)
         repository.by_name(name).hide
@@ -68,7 +68,7 @@ module Vedeu
       #   Vedeu.show_group(name)
       #   Vedeu.show_interface(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [void]
       def show(name = Vedeu.focus)
         repository.by_name(name).show
@@ -83,7 +83,7 @@ module Vedeu
       #   Vedeu.toggle_group(name)
       #   Vedeu.toggle_interface(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [void]
       def toggle(name = Vedeu.focus)
         repository.by_name(name).toggle
@@ -96,7 +96,7 @@ module Vedeu
       # @example
       #   Vedeu.hide_cursor(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [void]
       # @see Vedeu::Toggleable#hide
       def hide_cursor(name = Vedeu.focus)
@@ -108,7 +108,7 @@ module Vedeu
       # @example
       #   Vedeu.show_cursor(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [void]
       # @see Vedeu::Toggleable#show
       def show_cursor(name = Vedeu.focus)
@@ -120,7 +120,7 @@ module Vedeu
       # @example
       #   Vedeu.toggle_cursor(name)
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [void]
       # @see Vedeu::Toggleable#toggle
       def toggle_cursor(name = Vedeu.focus)
@@ -131,12 +131,13 @@ module Vedeu
 
       # Returns a boolean indicating whether the cursor is visible.
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @return [Boolean]
       def cursor_visible?(name)
         buffer(name).cursor_visible?
       end
 
+      # @macro param_name
       # @return [Vedeu::Buffers::Buffer]
       def buffer(name)
         Vedeu.buffers.by_name(name)