vedeu 0.8.20 → 0.8.21

data/lib/vedeu/esc/foreground.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       extend self
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def black(&block)
         if block_given?
@@ -24,7 +24,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def red(&block)
         if block_given?
@@ -36,7 +36,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def green(&block)
         if block_given?
@@ -48,7 +48,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def yellow(&block)
         if block_given?
@@ -60,7 +60,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def blue(&block)
         if block_given?
@@ -72,7 +72,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def magenta(&block)
         if block_given?
@@ -84,7 +84,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def cyan(&block)
         if block_given?
@@ -96,7 +96,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_grey(&block)
         if block_given?
@@ -108,7 +108,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def default(&block)
         if block_given?
@@ -120,7 +120,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def dark_grey(&block)
         if block_given?
@@ -132,7 +132,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_red(&block)
         if block_given?
@@ -144,7 +144,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_green(&block)
         if block_given?
@@ -156,7 +156,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_yellow(&block)
         if block_given?
@@ -168,7 +168,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_blue(&block)
         if block_given?
@@ -180,7 +180,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_magenta(&block)
         if block_given?
@@ -192,7 +192,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def light_cyan(&block)
         if block_given?
@@ -204,7 +204,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def white(&block)
         if block_given?

data/lib/vedeu/events/event.rb

@@ -52,9 +52,7 @@ module Vedeu
         #   execution of the triggered event to only execute once the
         #   debounce has expired. Subsequent triggers before debounce
         #   expiry are ignored.
-        # @param block [Proc] The event to be executed when triggered.
-        #   This block could be a method call, or the triggering of
-        #   another event, or sequence of either/both.
+        # @macro param_block
         #
         # @example
         #   Vedeu.bind :my_event do |some, args|

data/lib/vedeu/events/repository.rb

@@ -10,8 +10,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :events, :repository)
-
       class << self
 
         # Remove all stored models from the repository.

data/lib/vedeu/geometries/dsl/dsl.rb

@@ -123,45 +123,14 @@ module Vedeu
         model
       end
 
-      # Vertically align the interface/view to the bottom of the
-      # terminal.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # `height` is a positive integer, e.g. 30
-      #     align_bottom 30
-      #
-      #     # this is the same as:
-      #     # vertical_alignment(:bottom, 30)
-      #
-      #     # or you can use: (see notes)
-      #     # align(vertical: :bottom, height: 30)
-      #
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/align_bottom.md}
       # @param height [Fixnum] The number of lines/rows.
       # @return [Vedeu::Geometries::Geometry]
       def align_bottom(height = nil)
         vertical_alignment(:bottom, height)
       end
 
-      # Horizontally align the interface/view centrally.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # `width` is a positive integer, e.g. 30
-      #     align_centre 30
-      #
-      #     # this is the same as:
-      #     # horizontal_alignment(:centre, 30)
-      #
-      #     # or you can use: (see notes)
-      #     # align(horizontal: :centre, width: 30)
-      #
-      #     # ... some code
-      #   end
-      #
-      #   # Also allows `align_center` if preferred.
-      #
+      # {include:file:docs/dsl/by_method/geometry/align_centre.md}
       # @param width [Fixnum] The number of characters/columns.
       # @return [Vedeu::Geometries::Geometry]
       def align_centre(width = nil)
@@ -169,103 +138,35 @@ module Vedeu
       end
       alias align_center align_centre
 
-      # Horizontally align the interface/view to the left.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # `width` is a positive integer, e.g. 30
-      #     align_left 30
-      #
-      #     # this is the same as:
-      #     # horizontal_alignment(:left, 30)
-      #
-      #     # or you can use: (see notes)
-      #     # align(horizontal: :left, width: 30)
-      #
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/align_left.md}
       # @param width [Fixnum] The number of characters/columns.
       # @return [Vedeu::Geometries::Geometry]
       def align_left(width = nil)
         horizontal_alignment(:left, width)
       end
 
-      # Vertically align the interface/view to the middle of the
-      # terminal.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # `height` is a positive integer, e.g. 30
-      #     align_middle 30
-      #
-      #     # this is the same as:
-      #     # vertical_alignment(:middle, 30)
-      #
-      #     # or you can use: (see notes)
-      #     # align(vertical: :middle, height: 30)
-      #
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/align_middle.md}
       # @param height [Fixnum] The number of lines/rows.
       # @return [Vedeu::Geometries::Geometry]
       def align_middle(height = nil)
         vertical_alignment(:middle, height)
       end
 
-      # Align the interface/view to the right.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # `width` is a positive integer, e.g. 30
-      #     align_right 30
-      #
-      #     # this is the same as:
-      #     # horizontal_alignment(:right, 30)
-      #
-      #     # or you can use: (see notes)
-      #     # align(horizontal: :right, width: 30)
-      #
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/align_right.md}
       # @param width [Fixnum] The number of characters/columns.
       # @return [Vedeu::Geometries::Geometry]
       def align_right(width = nil)
         horizontal_alignment(:right, width)
       end
 
-      # Vertically align the interface/view to the top of the
-      # terminal.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # `height` is a positive integer, e.g. 30
-      #     align_top 30
-      #
-      #     # this is the same as:
-      #     # vertical_alignment(:top, 30)
-      #
-      #     # or you can use: (see notes)
-      #     # align(vertical: :top, height: 30)
-      #
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/align_top.md}
       # @param height [Fixnum] The number of lines/rows.
       # @return [Vedeu::Geometries::Geometry]
       def align_top(height = nil)
         vertical_alignment(:top, height)
       end
 
-      # Returns the width in characters for the number of columns
-      # specified.
-      #
-      #   Vedeu.geometry :main_interface do
-      #     # ... some code
-      #     width columns(9) # Vedeu.width # => 92 (for example)
-      #                      # 92 / 12 = 7
-      #                      # 7 * 9 = 63
-      #                      # Therefore, width is 63 characters.
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/columns.md}
       # @param value [Fixnum]
       # @macro raise_out_of_range
       # @return [Fixnum|Vedeu::Error::OutOfRange]
@@ -273,14 +174,7 @@ module Vedeu
         Vedeu::Geometries::Grid.columns(value)
       end
 
-      # Specify the number of characters/rows/lines tall the interface
-      # will be. This value will be ignored when `y` and `yn` are set.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     height 8
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/height.md}
       # @param value [Fixnum]
       # @return [Fixnum]
       def height(value)
@@ -288,17 +182,7 @@ module Vedeu
       end
       alias height= height
 
-      # Returns the height in characters for the number of rows
-      # specified.
-      #
-      #   Vedeu.geometry :main_interface do
-      #     # ... some code
-      #     height rows(3)  # Vedeu.height # => 38 (for example)
-      #                     # 38 / 12 = 3
-      #                     # 3 * 3 = 9
-      #                     # Therefore, height is 9 characters.
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/rows.md}
       # @param value [Fixnum]
       # @macro raise_out_of_range
       # @return [Fixnum]
@@ -306,14 +190,7 @@ module Vedeu
         Vedeu::Geometries::Grid.rows(value)
       end
 
-      # Specify the number of characters/columns wide the interface
-      # will be. This value will be ignored when `x` and `xn` are set.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     width 25
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/width.md}
       # @param value [Fixnum] The number of characters/columns.
       # @return [Fixnum]
       def width(value)
@@ -321,19 +198,9 @@ module Vedeu
       end
       alias width= width
 
-      # Specify the starting x position (column) of the interface.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     x 7 # start on column 7.
-      #
-      #     # start on column 8, if :other_interface changes position
-      #     # then :some_interface will too.
-      #     x { use(:other_interface).east }
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/x.md}
       # @param value [Fixnum]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Fixnum]
       def x(value = 1, &block)
         return model.x = block if block_given?
@@ -342,20 +209,9 @@ module Vedeu
       end
       alias x= x
 
-      # Specify the ending x position (column) of the interface.
-      # This value will override `width`.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     xn 37 # end at column 37.
-      #
-      #     # when :other_interface changes position,
-      #     # :some_interface will too.
-      #     xn  { use(:other_interface).right }
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/xn.md}
       # @param value [Fixnum]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Fixnum]
       def xn(value = 1, &block)
         return model.xn = block if block_given?
@@ -364,19 +220,9 @@ module Vedeu
       end
       alias xn= xn
 
-      # Specify the starting y position (row/line) of the interface.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     y  4 # start at row 4
-      #
-      #     # start on row/line 3, when :other_interface changes
-      #     # position, :some_interface will too.
-      #     y  { use(:other_interface).north }
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/y.md}
       # @param value [Fixnum]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Fixnum]
       def y(value = 1, &block)
         return model.y = block if block_given?
@@ -385,20 +231,9 @@ module Vedeu
       end
       alias y= y
 
-      # Specify the ending y position (row/line) of the interface.
-      # This value will override `height`.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     yn 24 # end at row 24.
-      #
-      #     # if :other_interface changes position, :some_interface
-      #     # will too.
-      #     yn { use(:other_interface).bottom }
-      #     # ... some code
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/geometry/yn.md}
       # @param value [Fixnum]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Fixnum]
       def yn(value = 1, &block)
         return model.yn = block if block_given?

data/lib/vedeu/geometries/move.rb

@@ -76,13 +76,35 @@ module Vedeu
         direction != :none
       end
 
-      # Moves the geometry down by the offset.
+      # Moves the geometry in the direction given by the offset also
+      # given.
       #
-      # @return [Hash<Symbol => Fixnum]
-      def down
+      # @return [Hash<Symbol => Hash<Symbol => Fixnum>>]
+      def movement
         {
-          y: y + offset,
-          yn: yn + offset,
+          down: {
+            y: y  + offset,
+            yn: yn + offset,
+          },
+          left: {
+            x: x  - offset,
+            xn: xn - offset,
+          },
+          none: {},
+          origin: {
+            x: 1,
+            xn: (xn - x + 1),
+            y: 1,
+            yn: (yn - y + 1),
+          },
+          right: {
+            x: x  + offset,
+            xn: xn + offset,
+          },
+          up: {
+            y: y  - offset,
+            yn: yn - offset,
+          },
         }
       end
 
@@ -97,46 +119,19 @@ module Vedeu
         }[direction]
       end
 
+      # @return [Hash<Symbol => Hash<Symbol => Fixnum>>]
+      def directional_move
+        movement.fetch(direction, {})
+      end
+
       # @macro geometry_by_name
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end
 
-      # Moves the geometry left by the offset.
-      #
-      # @return [Hash<Symbol => Fixnum]
-      def left
-        {
-          x: x - offset,
-          xn: xn - offset,
-        }
-      end
-
       # @return [Hash<Symbol => Boolean|String|Symbol>]
       def new_attributes
-        geometry.attributes.merge!(unalign_unmaximise).merge!(send(direction))
-      end
-
-      # Moves the geometry to the top left of the terminal.
-      #
-      # @return [Hash<Symbol => Fixnum]
-      def origin
-        {
-          x:  1,
-          xn: (xn - x + 1),
-          y:  1,
-          yn: (yn - y + 1),
-        }
-      end
-
-      # Moves the geometry right by the offset.
-      #
-      # @return [Hash<Symbol => Fixnum]
-      def right
-        {
-          x: x + offset,
-          xn: xn + offset,
-        }
+        geometry.attributes.merge!(unalign_unmaximise)
       end
 
       # @return [Hash<Symbol => Boolean|Symbol]
@@ -145,17 +140,7 @@ module Vedeu
           horizontal_alignment: :none,
           maximised:            false,
           vertical_alignment:   :none,
-        }
-      end
-
-      # Moves the geometry up by the offset.
-      #
-      # @return [Hash<Symbol => Fixnum]
-      def up
-        {
-          y: y - offset,
-          yn: yn - offset,
-        }
+        }.merge(directional_move)
       end
 
       # Refresh the cursor after moving.

data/lib/vedeu/geometries/position.rb

@@ -111,7 +111,7 @@ module Vedeu
       # the aforementioned, call the block and then reposition to this
       # location.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       # @yieldreturn [String] Returns the block wrapped in position
       #   escape sequences.

data/lib/vedeu/geometries/repository.rb

@@ -9,8 +9,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :geometries, :repository)
-
       null Vedeu::Geometries::Geometry
       real Vedeu::Geometries::Geometry
 

data/lib/vedeu/groups/dsl.rb

@@ -55,7 +55,7 @@ module Vedeu
       #   end
       #
       # @macro param_name
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [Vedeu::Groups::Group]
       def self.group(name, &block)

data/lib/vedeu/groups/repository.rb

@@ -8,8 +8,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :groups, :repository)
-
       null Vedeu::Groups::Group
       real Vedeu::Groups::Group
 

data/lib/vedeu/input/dsl.rb

@@ -58,7 +58,7 @@ module Vedeu
       #   This is also used when defining the '_global_' keymap.
       #
       # @macro param_name
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @macro raise_missing_required
       # @return [Vedeu::Input::Keymap]
@@ -79,8 +79,7 @@ module Vedeu
       #   The key(s) pressed. Special keys can be found in
       #   {Vedeu::Input::Input#specials}. When more than one key is
       #   defined, then the extras are treated as aliases.
-      # @param block [Proc] The action to perform when this key is
-      #   pressed. Can be a method call or event triggered.
+      # @macro param_block
       # @macro raise_invalid_syntax
       # @return [Array] A collection containing the keys minus any
       #   invalid or nil keys.

data/lib/vedeu/input/key.rb

@@ -17,7 +17,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Input::Key.
       #
       # @param input [String|Symbol]
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [Vedeu::Input::Key]
       def initialize(input = nil, &block)

data/lib/vedeu/input/repository.rb

@@ -8,8 +8,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :keymaps, :repository)
-
       real Vedeu::Input::Keymap
 
     end # Repository

data/lib/vedeu/interfaces/dsl.rb

@@ -30,8 +30,7 @@ module Vedeu
         #   end
         #
         # @macro param_name
-        # @param block [Proc] A set of attributes which define the
-        #   features of the interface.
+        # @macro param_block
         # @macro raise_requires_block
         # @macro raise_missing_required
         # @return [Vedeu::Interfaces::Interface]
@@ -104,7 +103,7 @@ module Vedeu
 
         # Returns the client object which called the DSL method.
         #
-        # @param block [Proc]
+        # @macro param_block
         # @return [Object]
         def client(&block)
           eval('self', block.binding) if block_given?

data/lib/vedeu/interfaces/interface.rb

@@ -11,6 +11,9 @@ module Vedeu
 
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
       include Vedeu::Toggleable
 
       # @!attribute [rw] client

data/lib/vedeu/interfaces/null.rb

@@ -9,6 +9,9 @@ module Vedeu
     class Null < Vedeu::Null::Generic
 
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
 
       # @!attribute [r] attributes
       # @return [String]