vedeu 0.8.12 → 0.8.13

data/lib/vedeu/cursors/cursor.rb

@@ -83,13 +83,14 @@ module Vedeu
       # @param other [Vedeu::Cursors::Cursor]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && name == other.name
+        self.class.equal?(other.class) && name == other.name
       end
       alias == eql?
 
       # @return [String]
       def inspect
-        "name:'#{name}' x:#{x} y:#{y} ox:#{ox} oy:#{oy} visible:#{visible}"
+        "name: #{name.inspect} x: #{x} y: #{y} ox: #{ox} oy: #{oy} " \
+        "visible: #{visible}"
       end
 
       # {include:file:docs/events/by_name/cursor_down.md}

data/lib/vedeu/dsl/border.rb

@@ -42,7 +42,7 @@ module Vedeu
         # @return [Vedeu::Borders::Border]
         # @see Vedeu::Borders::DSL
         def border(name = nil, &block)
-          fail Vedeu::Error::RequiresBlock unless block_given?
+          raise Vedeu::Error::RequiresBlock unless block_given?
 
           model_name = name ? name : model.name
 

data/lib/vedeu/dsl/elements.rb

@@ -137,8 +137,8 @@ module Vedeu
           model.add(l.value)
 
         else
-          fail Vedeu::Error::Fatal,
-               "Cannot add line to '#{model.class.name}' model."
+          raise Vedeu::Error::Fatal,
+                "Cannot add line to '#{model.class.name}' model."
 
         end
       end
@@ -178,8 +178,8 @@ module Vedeu
           model.add([l])
 
         else
-          fail Vedeu::Error::Fatal,
-               "Cannot add stream to '#{model.class.name}' model."
+          raise Vedeu::Error::Fatal,
+                "Cannot add stream to '#{model.class.name}' model."
 
         end
       end
@@ -262,8 +262,8 @@ module Vedeu
           model.add(stream.value)
 
         else
-          fail Vedeu::Error::Fatal,
-               "Cannot add text to '#{model.class.name}' model."
+          raise Vedeu::Error::Fatal,
+                "Cannot add text to '#{model.class.name}' model."
 
         end
       end
@@ -299,14 +299,14 @@ module Vedeu
       # @macro raise_requires_block
       # @return [NilClass]
       def requires_block!(&block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
+        raise Vedeu::Error::RequiresBlock unless block_given?
       end
 
       # @macro raise_fatal
       # @return [NilClass]
       def requires_model!
-        fail Vedeu::Error::Fatal,
-             'No model, cannot continue.' unless present?(model)
+        raise Vedeu::Error::Fatal,
+              'No model, cannot continue.' unless present?(model)
       end
 
     end # Elements

data/lib/vedeu/dsl/geometry.rb

@@ -33,8 +33,8 @@ module Vedeu
           #
           # end
 
-          fail Vedeu::Error::MissingRequired unless name
-          fail Vedeu::Error::RequiresBlock unless block_given?
+          raise Vedeu::Error::MissingRequired unless name
+          raise Vedeu::Error::RequiresBlock unless block_given?
 
           Vedeu::Geometries::Geometry.build(name: name, &block).store
         end
@@ -56,7 +56,7 @@ module Vedeu
         # @return [Vedeu::Geometries::Geometry]
         # @see Vedeu::Geometries::DSL
         def geometry(name = nil, &block)
-          fail Vedeu::Error::RequiresBlock unless block_given?
+          raise Vedeu::Error::RequiresBlock unless block_given?
 
           model_name = name ? name : model.name
 

data/lib/vedeu/dsl/helpers/wordwrap.rb

@@ -187,10 +187,10 @@ module Vedeu
         return options[:width] if present?(options[:width])
         return geometry.width if registered?
 
-        fail Vedeu::Error::MissingRequired,
-             'The text provided cannot be wrapped or pruned because a :width ' \
-             'option was not given, or a :name option was either not given ' \
-             'or there is no geometry registered with that name.'
+        raise Vedeu::Error::MissingRequired,
+              'The text provided cannot be wrapped or pruned because a ' \
+              ':width option was not given, or a :name option was either not ' \
+              'given or there is no geometry registered with that name.'
       end
 
       # @macro defaults_method

data/lib/vedeu/dsl/view.rb

@@ -55,9 +55,9 @@ module Vedeu
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       # @todo More documentation required.
       def view(name, &block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-        fail Vedeu::Error::MissingRequired,
-             'Cannot add view without a name.' unless present?(name)
+        raise Vedeu::Error::RequiresBlock unless block_given?
+        raise Vedeu::Error::MissingRequired,
+              'Cannot add view without a name.' unless present?(name)
 
         new_model = Vedeu::Views::View.build(new_attributes(name), &block)
 
@@ -87,12 +87,12 @@ module Vedeu
       # @macro raise_missing_required
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def template_for(name, filename, object = nil, options = {})
-        fail Vedeu::Error::MissingRequired,
-             'Cannot render template without the name of the ' \
-             'view.' unless present?(name)
-        fail Vedeu::Error::MissingRequired,
-             'Cannot render template without a ' \
-             'filename.' unless present?(filename)
+        raise Vedeu::Error::MissingRequired,
+              'Cannot render template without the name of the ' \
+              'view.' unless present?(name)
+        raise Vedeu::Error::MissingRequired,
+              'Cannot render template without a ' \
+              'filename.' unless present?(filename)
 
         options[:name] = name
 

data/lib/vedeu/dsl/views.rb

@@ -100,7 +100,7 @@ module Vedeu
         # @macro raise_requires_block
         # @return [Vedeu::Views::Composition]
         def renders(&block)
-          fail Vedeu::Error::RequiresBlock unless block_given?
+          raise Vedeu::Error::RequiresBlock unless block_given?
 
           composition(eval('self', block.binding), true, &block)
         end
@@ -113,7 +113,7 @@ module Vedeu
         # @macro raise_requires_block
         # @return [Vedeu::Views::Composition]
         def views(&block)
-          fail Vedeu::Error::RequiresBlock unless block_given?
+          raise Vedeu::Error::RequiresBlock unless block_given?
 
           composition(eval('self', block.binding), false, &block)
         end

data/lib/vedeu/editor/document.rb

@@ -92,7 +92,7 @@ module Vedeu
       # @param character [String|Symbol]
       # @return [Vedeu::Editor::Document]
       def insert_character(character)
-        return self if character.is_a?(Symbol)
+        return self if symbol?(character)
 
         @lines = lines.insert_character(character, y, x)
 

data/lib/vedeu/editor/item.rb

@@ -28,16 +28,16 @@ module Vedeu
 
       # @return [String|Vedeu::Editor::Line]
       def by_index
-        return nil unless size > 0
+        return nil unless collection
 
-        if index.nil? || index > size
-          collection[-1]
+        if index.nil? || index > collection.size
+          last_item
 
-        elsif index > 0 && index <= size
-          collection[index]
+        elsif index > 0 && index <= collection.size
+          nth_item
 
         else
-          collection[0]
+          first_item
 
         end
       end
@@ -54,17 +54,19 @@ module Vedeu
 
       private
 
-      # Returns the size of the collection or 0.
-      #
-      # @return [Fixnum]
-      def size
-        if collection
-          collection.size
+      # @return [String|Vedeu::Editor::Line]
+      def first_item
+        collection[0]
+      end
 
-        else
-          0
+      # @return [String|Vedeu::Editor::Line]
+      def last_item
+        collection[-1]
+      end
 
-        end
+      # @return [String|Vedeu::Editor::Line]
+      def nth_item
+        collection[index]
       end
 
     end # Item

data/lib/vedeu/esc/colours.rb

@@ -8,6 +8,7 @@ module Vedeu
     #
     module Colours
 
+      include Vedeu::Common
       extend self
 
       # Produces the background named colour escape sequence hash from
@@ -21,6 +22,25 @@ module Vedeu
         end
       end
 
+      # @param named_colour [Symbol]
+      # @param block [Proc]
+      # @return [String]
+      def background_colour(named_colour, &block)
+        return '' unless valid_name?(named_colour)
+
+        colour(named_colour.to_s.prepend('on_').to_sym, &block)
+      end
+
+      # @param named_colour [Symbol]
+      # @param block [Proc]
+      # @return [String]
+      def colour(named_colour, &block)
+        return '' unless valid_name?(named_colour)
+
+        public_send(named_colour, &block)
+      end
+      alias foreground_colour colour
+
       # Produces the foreground named colour escape sequence hash. The
       # background escape sequences are also generated from this by
       # adding 10 to the values.
@@ -69,25 +89,6 @@ module Vedeu
         }
       end
 
-      # @param named_colour [Symbol]
-      # @param block [Proc]
-      # @return [String]
-      def background_colour(named_colour, &block)
-        return '' unless valid_name?(named_colour)
-
-        colour(named_colour.to_s.prepend('on_').to_sym, &block)
-      end
-
-      # @param named_colour [Symbol]
-      # @param block [Proc]
-      # @return [String]
-      def colour(named_colour, &block)
-        return '' unless valid_name?(named_colour)
-
-        public_send(named_colour, &block)
-      end
-      alias foreground_colour colour
-
       # @return [Array<Symbol>]
       def valid_codes
         @_valid_codes ||= foreground_codes.keys.map do |name|
@@ -101,7 +102,7 @@ module Vedeu
       # @param named_colour [Symbol]
       # @return [Boolean]
       def valid_name?(named_colour)
-        return false unless named_colour.is_a?(Symbol)
+        return false unless symbol?(named_colour)
 
         valid_codes.include?(named_colour)
       end

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

@@ -101,8 +101,12 @@ module Vedeu
       # @param other [Vedeu::Geometries::Area]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && y == other.y && yn == other.yn &&
-          x == other.x && xn == other.xn
+        self.class.equal?(other.class) &&
+          name == other.name &&
+          y == other.y &&
+          yn == other.yn &&
+          x == other.x &&
+          xn == other.xn
       end
       alias == eql?
 

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

@@ -36,7 +36,7 @@ module Vedeu
       # @macro raise_out_of_range
       # @see Vedeu::Geometries::DSL#columns
       def columns
-        fail Vedeu::Error::OutOfRange if out_of_range?
+        raise Vedeu::Error::OutOfRange if out_of_range?
 
         column * value
       end
@@ -44,7 +44,7 @@ module Vedeu
       # @macro raise_out_of_range
       # @see Vedeu::Geometries::DSL#rows
       def rows
-        fail Vedeu::Error::OutOfRange if out_of_range?
+        raise Vedeu::Error::OutOfRange if out_of_range?
 
         row * value
       end

data/lib/vedeu/geometries/geometry.rb

@@ -39,27 +39,31 @@ module Vedeu
                      :y,
                      :yn
 
-      # @!attribute [rw] horizontal_alignment
-      # @return [Symbol]
-      attr_accessor :horizontal_alignment
-
-      # @!attribute [rw] vertical_alignment
-      # @return [Symbol]
-      attr_accessor :vertical_alignment
-
-      # @!attribute [rw] name
-      # @return [String|Symbol]
-      attr_accessor :name
+      # @!attribute [rw] client
+      # @return [Object]
+      attr_accessor :client
 
       # @!attribute [w] height
       # @return [Fixnum]
       attr_writer :height
 
+      # @!attribute [rw] horizontal_alignment
+      # @return [Symbol]
+      attr_accessor :horizontal_alignment
+
       # @!attribute [rw] maximised
       # @return [Boolean]
       attr_accessor :maximised
       alias maximised? maximised
 
+      # @!attribute [rw] name
+      # @return [String|Symbol]
+      attr_accessor :name
+
+      # @!attribute [rw] vertical_alignment
+      # @return [Symbol]
+      attr_accessor :vertical_alignment
+
       # @!attribute [w] width
       # @return [Fixnum]
       attr_writer :width
@@ -80,20 +84,17 @@ module Vedeu
       # @return [Fixnum]
       attr_writer :yn
 
-      # @!attribute [rw] client
-      # @return [Object]
-      attr_accessor :client
-
       # Returns a new instance of Vedeu::Geometries::Geometry.
       #
       # @param attributes [Hash<Symbol => Boolean|Fixnum|String|
       #   Symbol|Vedeu::Geometries::Repository]
+      # @option attributes client [void]
+      # @option attributes height [Fixnum]
       # @option attributes horizontal_alignment [Symbol]
-      # @option attributes vertical_alignment [Symbol]
       # @option attributes maximised [Boolean]
-      # @option attributes height [Fixnum]
       # @option attributes name [String|Symbol]
       # @option attributes repository [Vedeu::Geometries::Repository]
+      # @option attributes vertical_alignment [Symbol]
       # @option attributes width [Fixnum]
       # @option attributes x [Fixnum]
       # @option attributes xn [Fixnum]
@@ -106,22 +107,20 @@ module Vedeu
         end
       end
 
-      # @return [Hash<Symbol => Boolean|Fixnum|String|Symbol|
-      #   Vedeu::Geometries::Repository]
+      # @return [Hash<Symbol => Boolean|Fixnum|String|Symbol>]
       def attributes
         {
           client:               client,
-          height:               height,
+          height:               @height.is_a?(Proc) ? @height.call : @height,
           horizontal_alignment: horizontal_alignment,
           maximised:            maximised,
           name:                 name,
-          repository:           repository,
           vertical_alignment:   vertical_alignment,
-          width:                width,
-          x:                    x,
-          xn:                   xn,
-          y:                    y,
-          yn:                   yn,
+          width:                @width.is_a?(Proc)  ? @width.call  : @width,
+          x:                    @x.is_a?(Proc)      ? @x.call      : @x,
+          xn:                   @xn.is_a?(Proc)     ? @xn.call     : @xn,
+          y:                    @y.is_a?(Proc)      ? @y.call      : @y,
+          yn:                   @yn.is_a?(Proc)     ? @yn.call     : @yn,
         }
       end
 
@@ -143,7 +142,7 @@ module Vedeu
       # @param other [Vedeu::Geometries::Geometry]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && name == other.name
+        self.class.equal?(other.class) && name == other.name
       end
       alias == eql?
 
@@ -153,9 +152,9 @@ module Vedeu
         return self if maximised?
 
         @maximised = true
+        @_area     = nil
 
         store do
-          Vedeu.trigger(:_clear_)
           Vedeu.trigger(:_refresh_view_, name)
         end
       end
@@ -166,6 +165,7 @@ module Vedeu
         return self unless maximised?
 
         @maximised = false
+        @_area     = nil
 
         store do
           Vedeu.trigger(:_clear_)
@@ -173,27 +173,16 @@ module Vedeu
         end
       end
 
+      # @return [Vedeu::Geometries::Repository]
+      def repository
+        Vedeu.geometries
+      end
+
       private
 
       # @return [Vedeu::Geometries::Area]
       def area
-        Vedeu::Geometries::Area.from_attributes(area_attributes)
-      end
-
-      # @return [Hash<Symbol => Boolean|Fixnum>]
-      def area_attributes
-        {
-          horizontal_alignment: horizontal_alignment,
-          maximised:            maximised,
-          name:                 name,
-          vertical_alignment:   vertical_alignment,
-          x:                    @x.is_a?(Proc)      ? @x.call      : @x,
-          xn:                   @xn.is_a?(Proc)     ? @xn.call     : @xn,
-          width:                @width.is_a?(Proc)  ? @width.call  : @width,
-          y:                    @y.is_a?(Proc)      ? @y.call      : @y,
-          yn:                   @yn.is_a?(Proc)     ? @yn.call     : @yn,
-          height:               @height.is_a?(Proc) ? @height.call : @height,
-        }
+        @_area ||= Vedeu::Geometries::Area.from_attributes(attributes)
       end
 
       # @macro defaults_method
@@ -204,7 +193,6 @@ module Vedeu
           horizontal_alignment: :none,
           maximised:            false,
           name:                 nil,
-          repository:           Vedeu.geometries,
           vertical_alignment:   :none,
           width:                nil,
           x:                    nil,

data/lib/vedeu/geometries/move.rb

@@ -177,6 +177,7 @@ module Vedeu
           down:   valid_down?,
           left:   valid_left?,
           origin: true,
+          none:   false,
           right:  valid_right?,
           up:     valid_up?,
         }.fetch(direction, false)
@@ -184,22 +185,22 @@ module Vedeu
 
       # @return [Boolean]
       def valid_down?
-        yn + offset <= Vedeu.height
+        Vedeu::Point.valid?(value: yn + offset, max: Vedeu.height)
       end
 
       # @return [Boolean]
       def valid_left?
-        x - offset >= 1
+        Vedeu::Point.valid?(value: x - offset, min: 1)
       end
 
       # @return [Boolean]
       def valid_right?
-        xn + offset <= Vedeu.width
+        Vedeu::Point.valid?(value: xn + offset, max: Vedeu.width)
       end
 
       # @return [Boolean]
       def valid_up?
-        y - offset >= 1
+        Vedeu::Point.valid?(value: y - offset, min: 1)
       end
 
     end # Move

data/lib/vedeu/geometries/position.rb

@@ -77,7 +77,7 @@ module Vedeu
       # @param other [Vedeu::Geometries::Position]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && x == other.x && y == other.y
+        self.class.equal?(other.class) && x == other.x && y == other.y
       end
       alias == eql?
 

data/lib/vedeu/groups/dsl.rb

@@ -59,8 +59,8 @@ module Vedeu
       # @macro raise_requires_block
       # @return [Vedeu::Groups::Group]
       def self.group(name, &block)
-        fail Vedeu::Error::MissingRequired unless name
-        fail Vedeu::Error::RequiresBlock unless block_given?
+        raise Vedeu::Error::MissingRequired unless name
+        raise Vedeu::Error::RequiresBlock unless block_given?
 
         Vedeu::Groups::Group.build(name: name, &block).store
       end

data/lib/vedeu/groups/group.rb

@@ -86,7 +86,7 @@ module Vedeu
       # @param other [Vedeu::Groups::Group]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && name == other.name &&
+        self.class.equal?(other.class) && name == other.name &&
           members == other.members
       end
       alias == eql?

data/lib/vedeu/groups/refresh.rb

@@ -58,8 +58,8 @@ module Vedeu
         return name if present?(name)
         return group_from_interface if present?(group_from_interface)
 
-        fail Vedeu::Error::MissingRequired,
-             'Cannot refresh group with an empty group name.'
+        raise Vedeu::Error::MissingRequired,
+              'Cannot refresh group with an empty group name.'
       end
 
       # @return [String|Symbol]

data/lib/vedeu/input/capture.rb

@@ -12,6 +12,7 @@ module Vedeu
     #
     class Capture
 
+      include Vedeu::Common
       extend Forwardable
 
       def_delegators Vedeu::Terminal::Mode,
@@ -116,7 +117,7 @@ module Vedeu
       # @param keys [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
       # @return [Boolean]
       def click?(keys)
-        return false if keys.nil? || keys.is_a?(Symbol)
+        return false if keys.nil? || symbol?(keys)
 
         keys.is_a?(Vedeu::Cursors::Cursor) || keys.start_with?("\e[M")
       end

data/lib/vedeu/input/dsl.rb

@@ -64,8 +64,8 @@ module Vedeu
       # @macro raise_missing_required
       # @return [Vedeu::Input::Keymap]
       def self.keymap(name, &block)
-        fail Vedeu::Error::MissingRequired unless name
-        fail Vedeu::Error::RequiresBlock unless block_given?
+        raise Vedeu::Error::MissingRequired unless name
+        raise Vedeu::Error::RequiresBlock unless block_given?
 
         unless Vedeu.keymaps.registered?(name)
           Vedeu::Input::Keymap.new(name: name).store
@@ -76,32 +76,38 @@ module Vedeu
 
       # Define keypress(es) to perform an action.
       #
-      # @param values [Array<String>|Array<Symbol>|String|Symbol]
+      # @param keys [Array<String>|Array<Symbol>|String|Symbol]
       #   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 raise_invalid_syntax
-      # @return [Array] A collection containing the keypress(es).
-      def key(*values, &block)
-        fail Vedeu::Error::InvalidSyntax,
-             'No action defined for `key`.' unless block_given?
+      # @return [Array] A collection containing the keys minus any
+      #   invalid or nil keys.
+      def key(*keys, &block)
+        raise Vedeu::Error::InvalidSyntax,
+              'No action defined for `key`.' unless block_given?
 
-        fail Vedeu::Error::InvalidSyntax,
-             'No keypress(es) defined for `key`.' unless present?(values)
+        raise Vedeu::Error::InvalidSyntax,
+              'No keypresses defined for `key`.' unless present?(keys)
 
-        values.each do |value|
-          unless present?(value)
-            fail Vedeu::Error::InvalidSyntax,
-                 'An invalid value for `key` was encountered.'
-          end
-
-          model.add(Vedeu::Input::Key.new(value, &block))
+        valid_keys(keys).each do |key|
+          model.add(Vedeu::Input::Key.new(key, &block))
         end
       end
       alias key= key
 
+      private
+
+      # @param keys [Array<void>]
+      # @return [Array<String|Symbol>]
+      def valid_keys(keys)
+        keys.compact.keep_if do |key|
+          symbol?(key) || (string?(key) && present?(key))
+        end
+      end
+
     end # DSL
 
   end # Input

data/lib/vedeu/input/key.rb

@@ -21,7 +21,7 @@ module Vedeu
       # @macro raise_requires_block
       # @return [Vedeu::Input::Key]
       def initialize(input = nil, &block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
+        raise Vedeu::Error::RequiresBlock unless block_given?
 
         @input  = input
         @output = block