vedeu 0.7.4 → 0.8.0

data/lib/vedeu/esc/mouse.rb

@@ -30,25 +30,28 @@ module Vedeu
 
       extend self
 
-      # @return [Hash<Symbol => String>]
-      def mouse_codes
-        {
-          mouse_x10_on:  "\e[?9h".freeze,
-          mouse_x10_off: "\e[?9l".freeze,
-          mouse_on:      "\e[?1000h".freeze,
-          mouse_off:     "\e[?1000l".freeze,
-        }
+      # @return [String]
+      def mouse_x10_on
+        "\e[?9h".freeze
       end
 
-      # @return [void]
-      def setup!
-        mouse_codes.each { |key, code| define_method(key) { code } }
+      # @return [String]
+      def mouse_x10_off
+        "\e[?9l".freeze
+      end
+
+      # @return [String]
+      def mouse_on
+        "\e[?1000h".freeze
+      end
+
+      # @return [String]
+      def mouse_off
+        "\e[?1000l".freeze
       end
 
     end # Mouse
 
   end # EscapeSequences
 
-  Vedeu::EscapeSequences::Mouse.setup!
-
 end # Vedeu

data/lib/vedeu/events/aliases.rb

@@ -58,7 +58,7 @@ module Vedeu
       #   Vedeu.unbind_alias(alias_name)
       #
       # @param alias_name [Symbol] The name of the alias.
-      # @return [FalseClass|Hash<Symbol => Array<Symbol>>]
+      # @return [Boolean|Hash<Symbol => Array<Symbol>>]
       def unbind_alias(alias_name)
         return false if empty?
         return false unless registered?(alias_name)
@@ -83,7 +83,7 @@ module Vedeu
 
       # @param alias_name [Symbol]
       # @param args [void]
-      # @return [FalseClass|Array<void>|void]
+      # @return [Boolean|Array<void>|void]
       def trigger(alias_name, *args)
         return [] unless registered?(alias_name)
 

data/lib/vedeu/events/event.rb

@@ -82,7 +82,7 @@ module Vedeu
         #     # ... some code here ...
         #   end
         #
-        # @return [TrueClass]
+        # @return [Boolean]
         def bind(name, options = {}, &block)
           Vedeu.log(type: :event, message: "Binding: '#{name.inspect}'".freeze)
 

data/lib/vedeu/geometries/all.rb

@@ -13,7 +13,6 @@ module Vedeu
 
 end # Vedeu
 
-require 'vedeu/geometries/alignment/all'
 require 'vedeu/geometries/area/all'
 require 'vedeu/geometries/dsl/all'
 

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

@@ -76,9 +76,9 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Geometries::Alignment]
+      # @return [Vedeu::Coercers::Alignment]
       def alignment
-        Vedeu::Geometries::Alignment.coerce(@alignment)
+        @_alignment ||= Vedeu::Coercers::Alignment.coerce(@alignment)
       end
 
       # Return the dimension.

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

@@ -74,58 +74,10 @@ module Vedeu
     class DSL
 
       include Vedeu::DSL
+      include Vedeu::DSL::Geometry
       include Vedeu::DSL::Use
       include Vedeu::Geometries::Validator
 
-      # Specify the geometry of an interface or view with a simple
-      # DSL.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # ...
-      #   end
-      #
-      # @param name [String|Symbol] The name of the interface or view
-      #   to which this geometry belongs.
-      # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Geometries::Geometry]
-      def self.geometry(name, &block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        Vedeu::Geometries::Geometry.build(name: name, &block).store
-      end
-
-      # Instructs Vedeu to align the interface/view either left,
-      # centre or right. A width is also required so that required
-      # coordinates are calculated correctly.
-      #
-      #   Vedeu.geometry :some_interface do
-      #     # :some_value must be one of: :left, :none, :center,
-      #     #   :centre, or :right
-      #     # `width` is a positive integer, e.g. 30
-      #     alignment(:some_value, width)
-      #
-      #     # ... some code
-      #   end
-      #
-      # @param value [Symbol] One of :center, :centre, :left, :none,
-      #   :right.
-      # @param width [Fixnum] The width of the aligned interface/view.
-      # @raise [Vedeu::Error::InvalidSyntax] When the value or width
-      #   is not given.
-      # @return [Vedeu::Geometries::Geometry]
-      # def alignment(value, width)
-      #   fail Vedeu::Error::InvalidSyntax,
-      #        'No alignment given. Valid values are :center, :centre, ' \
-      #        ':left, :none, :right.'.freeze unless present?(value)
-      #   fail Vedeu::Error::InvalidSyntax,
-      #        'No width given.'.freeze unless present?(width)
-
-      #   model.alignment = Vedeu::Geometries::Alignment.align(value)
-      #   model.width     = width
-      #   model
-      # end
-
       # Align the interface/view horizontally or vertically within
       # the terminal.
       #
@@ -164,7 +116,7 @@ module Vedeu
         validate_horizontal_alignment!(value)
         validate_width!(width)
 
-        model.horizontal_alignment = Vedeu::Geometries::HorizontalAlignment
+        model.horizontal_alignment = Vedeu::Coercers::HorizontalAlignment
           .coerce(value)
         model.width = width
         model
@@ -177,7 +129,7 @@ module Vedeu
         validate_vertical_alignment!(value)
         validate_height!(height)
 
-        model.vertical_alignment = Vedeu::Geometries::VerticalAlignment
+        model.vertical_alignment = Vedeu::Coercers::VerticalAlignment
           .coerce(value)
         model.height = height
         model

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

@@ -12,7 +12,7 @@ module Vedeu
 
       # @param value [Fixnum] The number of lines/rows.
       # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
-      # @return [TrueClass]
+      # @return [Boolean]
       def validate_height!(value)
         fail Vedeu::Error::InvalidSyntax,
              'No height given.'.freeze if absent?(value)
@@ -23,7 +23,7 @@ module Vedeu
       # @param value [Symbol] One of :center, :centre, :left,
       #   :none, :right.
       # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
-      # @return [TrueClass]
+      # @return [Boolean]
       def validate_horizontal_alignment!(value)
         fail Vedeu::Error::InvalidSyntax,
              'No horizontal alignment given. Valid values are :center, ' \
@@ -34,7 +34,7 @@ module Vedeu
 
       # @param value [Symbol] One of :bottom, :middle, :none, :top.
       # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
-      # @return [TrueClass]
+      # @return [Boolean]
       def validate_vertical_alignment!(value)
         fail Vedeu::Error::InvalidSyntax,
              'No vertical alignment given. Valid values are :bottom, ' \
@@ -45,7 +45,7 @@ module Vedeu
 
       # @param value [Fixnum] The number of characters/columns.
       # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
-      # @return [TrueClass]
+      # @return [Boolean]
       def validate_width!(value)
         fail Vedeu::Error::InvalidSyntax,
              'No width given.'.freeze if absent?(value)

data/lib/vedeu/geometries/geometry.rb

@@ -108,13 +108,13 @@ module Vedeu
       #   Vedeu::Geometries::Repository]
       def attributes
         {
-          client:               @client,
+          client:               client,
           height:               height,
-          horizontal_alignment: @horizontal_alignment,
-          maximised:            @maximised,
-          name:                 @name,
-          repository:           @repository,
-          vertical_alignment:   @vertical_alignment,
+          horizontal_alignment: horizontal_alignment,
+          maximised:            maximised,
+          name:                 name,
+          repository:           repository,
+          vertical_alignment:   vertical_alignment,
           width:                width,
           x:                    x,
           xn:                   xn,
@@ -189,16 +189,16 @@ module Vedeu
 
       # @return [Vedeu::Geometries::Area]
       def area
-        @area = Vedeu::Geometries::Area.from_attributes(area_attributes)
+        Vedeu::Geometries::Area.from_attributes(area_attributes)
       end
 
       # @return [Hash<Symbol => Boolean|Fixnum>]
       def area_attributes
         {
-          horizontal_alignment: @horizontal_alignment,
-          maximised:            @maximised,
+          horizontal_alignment: horizontal_alignment,
+          maximised:            maximised,
           name:                 name,
-          vertical_alignment:   @vertical_alignment,
+          vertical_alignment:   vertical_alignment,
           x:                    @x.is_a?(Proc)      ? @x.call      : @x,
           xn:                   @xn.is_a?(Proc)     ? @xn.call     : @xn,
           x_xn:                 @width.is_a?(Proc)  ? @width.call  : @width,

data/lib/vedeu/geometries/move.rb

@@ -27,13 +27,13 @@ module Vedeu
                      :y,
                      :yn
 
-      # @param attributes See #initialize
-      # @return See #move
+      # @param (see #initialize)
+      # @return (see #move)
       def self.move(attributes = {})
         new(attributes).move
       end
 
-      # @return [FalseClass|Vedeu::Geometries::Geometry]
+      # @return [Boolean|Vedeu::Geometries::Geometry]
       def move
         return false unless valid?
 
@@ -64,7 +64,7 @@ module Vedeu
       def defaults
         {
           direction: :none,
-          name:      '',
+          name:      ''.freeze,
           offset:    1,
         }
       end

data/lib/vedeu/groups/dsl.rb

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

data/lib/vedeu/groups/group.rb

@@ -163,7 +163,7 @@ module Vedeu
       def defaults
         {
           members:    Set.new,
-          name:       '',
+          name:       ''.freeze,
           repository: Vedeu.groups,
           visible:    true,
         }

data/lib/vedeu/input/all.rb

@@ -12,6 +12,7 @@ end # Vedeu
 require 'vedeu/input/raw'
 require 'vedeu/input/capture'
 require 'vedeu/input/dsl'
+require 'vedeu/input/keys'
 require 'vedeu/input/key'
 require 'vedeu/input/keymap'
 require 'vedeu/input/mapper'

data/lib/vedeu/input/capture.rb

@@ -54,7 +54,10 @@ module Vedeu
         elsif fake_mode?
           @key ||= keypress
 
-          if click?(@key)
+          if @key.nil?
+            nil
+
+          elsif click?(@key)
             Vedeu.trigger(:_mouse_event_, @key)
 
           elsif Vedeu::Input::Mapper.registered?(@key, name)
@@ -63,9 +66,6 @@ module Vedeu
           elsif interface.editable?
             Vedeu.trigger(:_editor_, @key)
 
-          elsif @key.nil?
-            nil
-
           else
             Vedeu.trigger(:key, @key)
 
@@ -93,9 +93,13 @@ module Vedeu
       def input
         keys = Vedeu::Input::Raw.read
 
-        return Vedeu::Input::Mouse.click(keys) if click?(keys)
+        if click?(keys)
+          Vedeu::Input::Mouse.click(keys)
+
+        else
+          keys
 
-        keys
+        end
       end
 
       # @return [Vedeu::Interfaces::Interface]
@@ -106,12 +110,12 @@ module Vedeu
       # Returns a boolean indicating whether a mouse click was
       # received.
       #
-      # @param input [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
+      # @param keys [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
       # @return [Boolean]
-      def click?(input)
-        return false if input.nil? || input.is_a?(Symbol)
+      def click?(keys)
+        return false if keys.nil? || keys.is_a?(Symbol)
 
-        input.is_a?(Vedeu::Cursors::Cursor) || input.start_with?("\e[M".freeze)
+        keys.is_a?(Vedeu::Cursors::Cursor) || keys.start_with?("\e[M".freeze)
       end
 
       # @return [IO]

data/lib/vedeu/input/dsl.rb

@@ -45,15 +45,30 @@ module Vedeu
       #     end
       #   end
       #
+      # @note
+      #   If a keymap with this name does not already exist,
+      #   pre-register it, otherwise we have no way of knowing if a
+      #   key defined in the DSL for this keymap has already been
+      #   registered. This protects the client application from
+      #   attempting to define the same key more than once for the
+      #   same keymap.
+      #
+      #   This is also used when defining the '_global_' keymap.
+      #
       # @param name [String|Symbol] The name of the interface which
       #   this keymap relates to.
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @raise [Vedeu::Error::MissingRequired|
+      #   Vedeu::Error::RequiresBlock] When a name or block
+      #   respectively are not given.
       # @return [Vedeu::Input::Keymap]
-      # @todo Try to remember why we need to pre-create the keymap in
-      #   the repository.
       def self.keymap(name, &block)
-        Vedeu::Input::Keymap.new(name: name).store
+        fail Vedeu::Error::MissingRequired unless name
+        fail Vedeu::Error::RequiresBlock unless block_given?
+
+        unless Vedeu.keymaps.registered?(name)
+          Vedeu::Input::Keymap.new(name: name).store
+        end
 
         Vedeu::Input::Keymap.build(name: name, &block).store
       end
@@ -84,32 +99,11 @@ module Vedeu
                  'An invalid value for `key` was encountered.'.freeze
           end
 
-          model.add(model.member.new(value, &block))
+          model.add(Vedeu::Input::Key.new(value, &block))
         end
       end
       alias_method :key=, :key
 
-      # Define the name of the keymap.
-      #
-      # To only allow certain keys to work with specific interfaces,
-      # use the same name as the interface.
-      #
-      # When the name :_global_ is used, all keys in the keymap block
-      # will be available to all interfaces. Once a key has been
-      # defined in the :_global_ keymap, it cannot be used for a
-      # specific interface.
-      #
-      #   Vedeu.keymap do
-      #     name :some_interface
-      #   end
-      #
-      # @param value [String|Symbol]
-      # @return [String]
-      def name(value)
-        model.name = value
-      end
-      alias_method :name=, :name
-
     end # DSL
 
   end # Input

data/lib/vedeu/input/key.rb

@@ -2,12 +2,6 @@ module Vedeu
 
   module Input
 
-    # A collection of {Vedeu::Input::Key} instances.
-    #
-    class Keys < Vedeu::Repositories::Collection
-
-    end # Keys
-
     # A single keypress or combination of keypresses bound to a
     # specific action.
     #

data/lib/vedeu/input/keymap.rb

@@ -9,9 +9,6 @@ module Vedeu
 
       include Vedeu::Repositories::Model
 
-      collection Vedeu::Input::Keys
-      member     Vedeu::Input::Key
-
       # @!attribute [rw] name
       # @return [String]
       attr_accessor :name
@@ -59,7 +56,7 @@ module Vedeu
       #
       # @return [Vedeu::Input::Keys]
       def keys
-        collection.coerce(@keys, self)
+        Vedeu::Input::Keys.coerce(@keys, self)
       end
 
       # Check whether the key is already defined for this keymap.
@@ -75,14 +72,12 @@ module Vedeu
       # method triggers the action associated with the key.
       #
       # @param input [String|Symbol]
-      # @return [Array|FalseClass]
+      # @return [Array|Boolean]
       def use(input)
         return false unless key_defined?(input)
 
         Vedeu.log(type: :input, message: "Key pressed: '#{input}'".freeze)
 
-        Vedeu.trigger(:key, input)
-
         keys.select { |key| key.input == input }.map(&:press)
       end
 
@@ -93,9 +88,9 @@ module Vedeu
       # @return [Hash<Symbol => Array|String|Vedeu::Input::Repository]
       def defaults
         {
-          name:       '',
+          name:       ''.freeze,
           keys:       [],
-          repository: Vedeu::Input::Repository.keymaps,
+          repository: Vedeu.keymaps,
         }
       end