vedeu 0.8.8 → 0.8.9

data/lib/vedeu/cursors/cursor.rb

@@ -188,7 +188,7 @@ module Vedeu
       #
       # @return [Vedeu::Geometries::Position]
       def position
-        @position = Vedeu::Geometries::Position.coerce([y, x])
+        @position = Vedeu::Geometries::Position.new(y, x)
       end
 
       # {include:file:docs/events/by_name/show_cursor.md}
@@ -224,9 +224,9 @@ module Vedeu
       #
       # @return [Vedeu::Cursors::Coordinate]
       def coordinate(offset, type)
-        Vedeu::Cursors::Coordinate.new(name:   name,
-                                       offset: offset,
-                                       type:   type)
+        Vedeu::Cursors::Coordinate.new(geometry: geometry,
+                                       offset:   offset,
+                                       type:     type)
       end
 
       # The default values for a new instance of this class.

data/lib/vedeu/cursors/reposition.rb

@@ -71,9 +71,9 @@ module Vedeu
       # @param type [Symbol]
       # @return [Vedeu::Cursors::Coordinate]
       def coordinate(offset, type)
-        Vedeu::Cursors::Coordinate.new(name:   name,
-                                       offset: offset,
-                                       type:   type)
+        Vedeu::Cursors::Coordinate.new(geometry: geometry,
+                                       offset:   offset,
+                                       type:     type)
       end
 
       # @return [Vedeu::Cursors::Cursor]

data/lib/vedeu/dsl/border.rb

@@ -10,39 +10,7 @@ module Vedeu
     #
     module Border
 
-      # When {Vedeu::DSL::Border} is included in a class, the
-      # methods within this module are included as class methods on
-      # that class.
-      #
-      module ClassMethods
-
-        # Specify the border of an interface or view with a simple
-        # DSL.
-        #
-        #   # Standalone (preferred):
-        #   Vedeu.border :my_interface do
-        #     # ... see {Vedeu::Borders::DSL}
-        #   end
-        #
-        # @param name [String|Symbol] The name of the interface or
-        #   view to which this border belongs.
-        # @param block [Proc]
-        # @macro raise_requires_block
-        # @macro raise_missing_required
-        # @return [Vedeu::Borders::Border]
-        # @see Vedeu::Borders::DSL
-        def border(name, &block)
-          fail Vedeu::Error::MissingRequired unless name
-          fail Vedeu::Error::RequiresBlock unless block_given?
-
-          Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
-        end
-
-      end # ClassMethods
-
-      # When {Vedeu::DSL::Border} is included in a class, the
-      # methods within this module are included as instance methods on
-      # that class.
+      # Provide additional behaviour as instance methods.
       #
       module InstanceMethods
 
@@ -110,13 +78,8 @@ module Vedeu
 
       end # InstanceMethods
 
-      # When this module is included in a class, provide ClassMethods
-      # as class methods for the class.
-      #
-      # @param klass [Class]
-      # @return [void]
+      # @macro included_module
       def self.included(klass)
-        klass.extend(Vedeu::DSL::Border::ClassMethods)
         klass.include(Vedeu::DSL::Border::InstanceMethods)
       end
 

data/lib/vedeu/dsl/elements.rb

@@ -61,7 +61,7 @@ module Vedeu
       #
       # @param block [Proc]
       # @macro raise_requires_block
-      # @raise [Vedeu::Error::Fatal]
+      # @macro raise_fatal
       # @return [void]
       def lines(opts = {}, &block)
         requires_block!(&block)
@@ -113,7 +113,7 @@ module Vedeu
       # @param opts [Hash]
       # @option opts ... [void]
       # @param block [Proc]
-      # @raise [Vedeu::Error::Fatal]
+      # @macro raise_fatal
       # @return [void]
       def line(value = '', opts = {}, &block)
         requires_model!
@@ -148,7 +148,7 @@ module Vedeu
       # @param opts [Hash]
       # @option opts ... [void]
       # @param block [Proc]
-      # @raise [Vedeu::Error::Fatal]
+      # @macro raise_fatal
       # @return [void]
       def stream(value = '', opts = {}, &block)
         requires_model!
@@ -241,7 +241,7 @@ module Vedeu
       # @option opts :pad [String] The character to use to pad the
       #   width, by default uses an empty space (0x20). Only when the
       #   string is shorter than the specified width.
-      # @raise [Vedeu::Error::Fatal]
+      # @macro raise_fatal
       # @return [void]
       def text(value = '', opts = {})
         requires_model!
@@ -302,8 +302,7 @@ module Vedeu
         fail Vedeu::Error::RequiresBlock unless block_given?
       end
 
-      # @raise [Vedeu::Error::Fatal] When the model cannot be
-      #   determined.
+      # @macro raise_fatal
       # @return [NilClass]
       def requires_model!
         fail Vedeu::Error::Fatal,

data/lib/vedeu/dsl/geometry.rb

@@ -10,9 +10,7 @@ module Vedeu
     #
     module Geometry
 
-      # When {Vedeu::DSL::Geometry} is included in a class, the
-      # methods within this module are included as class methods on
-      # that class.
+      # Provide additional behaviour as class methods.
       #
       module ClassMethods
 
@@ -44,9 +42,7 @@ module Vedeu
 
       end # ClassMethods
 
-      # When {Vedeu::DSL::Geometry} is included in a class, the
-      # methods within this module are included as instance methods on
-      # that class.
+      # Provide additional behaviour as instance methods.
       #
       module InstanceMethods
 
@@ -70,12 +66,7 @@ module Vedeu
 
       end # InstanceMethods
 
-      # When this module is included in a class, provide ClassMethods
-      # as class methods and InstanceMethods as instance methods for
-      # the given class.
-      #
-      # @param klass [Class]
-      # @return [void]
+      # @macro included_module
       def self.included(klass)
         klass.extend(Vedeu::DSL::Geometry::ClassMethods)
         klass.include(Vedeu::DSL::Geometry::InstanceMethods)

data/lib/vedeu/editor/cropper.rb

@@ -45,8 +45,9 @@ module Vedeu
 
         visible.each_with_index do |line, iy|
           line.chars.each_with_index do |char, ix|
+            position = Vedeu::Geometries::Position.new((by + iy), (bx + ix))
             out << Vedeu::Cells::Char.new(name:     name,
-                                          position: [(by + iy), (bx + ix)],
+                                          position: position,
                                           value:    char)
           end
         end

data/lib/vedeu/error.rb

@@ -37,6 +37,10 @@ module Vedeu
     # given or cannot be found is to use the name of the currently
     # focussed interface.
     #
+    # @!macro [new] raise_fatal
+    #   @raise [Vedeu::Error::Fatal] When Vedeu does not understand
+    #     that which the client application is attempting to achieve.
+    #
     class Fatal < StandardError
 
     end # Fatal

data/lib/vedeu/geometries/position.rb

@@ -21,34 +21,21 @@ module Vedeu
       attr_reader :x
       alias last x
 
-      # Convenience constructor for Vedeu::Geometries::Position.
-      #
-      # @param (see #initialize)
-      def self.[](y = 1, x = 1)
-        new(y, x)
-      end
-
-      # @param value [Array<Fixnum>|Fixnum|Hash|
-      #   Vedeu::Geometries::Position]
-      # @return [Vedeu::Geometries::Position]
-      def self.coerce(value)
-        if value.is_a?(self)
-          value
+      class << self
 
-        elsif value.is_a?(Array)
-          new(*value)
+        extend Forwardable
 
-        elsif value.is_a?(Fixnum)
-          new(value, 1)
-
-        elsif value.is_a?(Hash)
-          new(value.fetch(:y, 1), value.fetch(:x, 1))
-
-        elsif value.is_a?(NilClass)
-          nil
+        def_delegators Vedeu::Coercers::Position,
+                       :coerce
 
+        # Convenience constructor for Vedeu::Geometries::Position.
+        #
+        # @param (see #initialize)
+        def [](y = 1, x = 1)
+          new(y, x)
         end
-      end
+
+      end # Eigenclass
 
       # Initializes a new instance of Vedeu::Geometries::Position.
       #
@@ -67,10 +54,10 @@ module Vedeu
       #
       # @return [Array<Fixnum>]
       def as_indices
-        xi = ((x - 1) <= 1) ? 0 : (x - 1)
-        yi = ((y - 1) <= 1) ? 0 : (y - 1)
+        ix = Vedeu::Point.coerce(value: (x - 1), min: 0).value
+        iy = Vedeu::Point.coerce(value: (y - 1), min: 0).value
 
-        [yi, xi]
+        [iy, ix]
       end
 
       # @param other [Vedeu::Geometries::Position]

data/lib/vedeu/input/mouse.rb

@@ -65,21 +65,30 @@ module Vedeu
         mouse[0]
       end
 
-      # @return [Array<Fixnum>]
-      def mouse
-        @_input ||= input.chars[3..-1].map { |character| character.ord - 32 }
-      end
-
+      # Returns a boolean indicating the mouse interaction was
+      # recognised as a left click.
+      #
       # @return [Boolean]
       def left_click?
         button == 0
       end
 
+      # @return [Array<Fixnum>]
+      def mouse
+        @_input ||= input.chars[3..-1].map { |character| character.ord - 32 }
+      end
+
+      # Returns a boolean indicating the mouse interaction was
+      # recognised as the scroll wheel moving up.
+      #
       # @return [Boolean]
       def wheel_up?
         button == 64
       end
 
+      # Returns a boolean indicating the mouse interaction was
+      # recognised as the scroll wheel moving down.
+      #
       # @return [Boolean]
       def wheel_down?
         button == 65

data/lib/vedeu/input/read.rb

@@ -25,7 +25,7 @@ module Vedeu
       #
       # @param input [NilClass|String]
       # @param options [Hash<Symbol => Symbol]
-      # @option mode [Symbol] Either :cooked (default) or :raw
+      # @option mode [Symbol] Either :cooked (default), :raw or :fake.
       # @return [Vedeu::Input::Read]
       def initialize(input = nil, options = {})
         @input   = input
@@ -78,16 +78,6 @@ module Vedeu
         mode == :fake
       end
 
-      # @return [String]
-      def mouse_off
-        Vedeu.esc.mouse_x10_off
-      end
-
-      # @return [String]
-      def show_cursor
-        Vedeu.esc.show_cursor
-      end
-
       # @return [String]
       def input
         @_input ||= if input?

data/lib/vedeu/interfaces/clear.rb

@@ -162,9 +162,10 @@ module Vedeu
         Vedeu.timer("Clearing #{clearing}: '#{name}'") do
           @clear ||= Array.new(height) do |iy|
             Array.new(width) do |ix|
+              position = Vedeu::Geometries::Position.new((y + iy), (x + ix))
               Vedeu::Cells::Clear.new(colour:   colour,
                                       name:     name,
-                                      position: [y + iy, x + ix])
+                                      position: position)
             end
           end
         end

data/lib/vedeu/logging/log.rb

@@ -87,7 +87,7 @@ module Vedeu
           end
         end
 
-        # {include:file:docs/api/by_method/log_timestamp.md}
+        # {include:file:docs/dsl/by_method/log_timestamp.md}
         # @macro vedeu_logging_log_param_message
         # @return [String]
         def formatted_message(message)

data/lib/vedeu/models/page.rb

@@ -14,32 +14,14 @@ module Vedeu
       # @return [Array<NilClass|Vedeu::Models::Row>]
       attr_reader :rows
 
-      # @param value
-      #   [Vedeu::Models::Page|Vedeu::Models::Row|Array<void>|void]
-      # @macro raise_invalid_syntax
-      # @return [Vedeu::Models::Page]
-      def self.coerce(value)
-        if value.is_a?(Vedeu::Models::Page)
-          value
-
-        elsif value.is_a?(Vedeu::Models::Row)
-          Vedeu::Models::Page.new([value])
-
-        elsif value.is_a?(Array) && value.empty?
-          Vedeu::Models::Page.new([Vedeu::Models::Row.coerce(value)])
+      class << self
 
-        elsif value.is_a?(Array) || value.is_a?(Vedeu::Buffers::View)
-          values = value.map { |v| Vedeu::Models::Row.coerce(v) }
+        extend Forwardable
 
-          Vedeu::Models::Page.new(values)
+        def_delegators Vedeu::Coercers::Page,
+                       :coerce
 
-        else
-          fail Vedeu::Error::InvalidSyntax,
-               'Cannot coerce as value is not an Array, Vedeu::Models::Page ' \
-               "or Vedeu::Models::Row. Is a '#{value.class.name}'."
-
-        end
-      end
+      end # Eigenclass
 
       # Returns a new instance of Vedeu::Models::Page.
       #

data/lib/vedeu/models/row.rb

@@ -15,23 +15,14 @@ module Vedeu
       # @return [Array<NilClass|void>]
       attr_reader :cells
 
-      # @param value [Vedeu::Models::Row|Array<void>|void]
-      # @return [Vedeu::Models::Row]
-      def self.coerce(value)
-        if value.is_a?(self)
-          value
-
-        elsif value.is_a?(Array)
-          new(value.compact)
+      class << self
 
-        elsif value.nil?
-          new
+        extend Forwardable
 
-        else
-          new([value])
+        def_delegators Vedeu::Coercers::Row,
+                       :coerce
 
-        end
-      end
+      end # Eigenclass
 
       # Returns a new instance of Vedeu::Models::Row.
       #

data/lib/vedeu/models/toggleable.rb

@@ -43,8 +43,7 @@ module Vedeu
       show
     end
 
-    # Provide class methods to models to allow the visibility to be
-    # changed.
+    # Provide additional behaviour as class methods.
     #
     module ClassMethods
 
@@ -146,11 +145,7 @@ module Vedeu
 
     end # ClassMethods
 
-    # When this module is included in a class, provide ClassMethods as
-    # class methods for the class.
-    #
-    # @param klass [Class]
-    # @return [void]
+    # @macro included_module
     def self.included(klass)
       klass.extend(Vedeu::Toggleable::ClassMethods)
     end

data/lib/vedeu/plugins/plugin.rb

@@ -37,6 +37,7 @@ module Vedeu
 
     # Load the plugin (require the gem).
     #
+    # @macro raise_fatal
     # @return [void]
     def load!
       begin

data/lib/vedeu/presentation/style.rb

@@ -19,26 +19,10 @@ module Vedeu
 
       class << self
 
-        include Vedeu::Common
-
-        # Produces new objects of the correct class from the value,
-        # ignores objects that have already been coerced.
-        #
-        # @param value [Object|NilClass]
-        # @return [Object]
-        def coerce(value)
-          return value if value.is_a?(Vedeu::Presentation::Style)
-          return new(value) unless value.is_a?(Hash)
-          return new unless present?(value[:style])
-
-          if value[:style].is_a?(Vedeu::Presentation::Style)
-            value[:style]
-
-          else
-            new(value[:style])
-
-          end
-        end
+        extend Forwardable
+
+        def_delegators Vedeu::Coercers::Style,
+                       :coerce
 
       end # Eigenclass