vedeu 0.6.7 → 0.6.8

data/lib/vedeu/esc/colours.rb

@@ -10,8 +10,8 @@ module Vedeu
 
       extend self
 
-      # Produces the background named colour escape sequence hash from the
-      # foreground escape sequence hash.
+      # Produces the background named colour escape sequence hash from
+      # the foreground escape sequence hash.
       #
       # @return [Hash<Symbol => Fixnum>]
       def background_codes
@@ -22,10 +22,10 @@ module Vedeu
       end
 
       # Produces the foreground named colour escape sequence hash. The
-      # background escape sequences are also generated from this by adding 10 to
-      # the values.
-      # This hash gives rise to methods you can call directly on `Esc` to
-      # produce the desired colours:
+      # background escape sequences are also generated from this by
+      # adding 10 to the values.
+      # This hash gives rise to methods you can call directly on `Esc`
+      # to produce the desired colours:
       #
       # @example
       #   Esc.red                     # => "\e[31m"
@@ -37,9 +37,10 @@ module Vedeu
       #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
       #
       #   # Valid names:
-      #   :black, :red, :green, :yellow, :blue, :magenta, :cyan, :light_grey,
-      #   :default, :dark_grey, :light_red, :light_green, :light_yellow,
-      #   :light_blue, :light_magenta, :light_cyan, :white
+      #   :black, :red, :green, :yellow, :blue, :magenta, :cyan,
+      #   :light_grey, :default, :dark_grey, :light_red, :light_green,
+      #   :light_yellow, :light_blue, :light_magenta, :light_cyan,
+      #   :white
       #
       # @return [Hash<Symbol => Fixnum>]
       def foreground_codes
@@ -82,9 +83,9 @@ module Vedeu
         end
       end
 
-      # Dynamically creates methods for each terminal named colour. When a block
-      # is given, then the colour is reset to 'default' once the block is
-      # called.
+      # Dynamically creates methods for each terminal named colour.
+      # When a block is given, then the colour is reset to 'default'
+      # once the block is called.
       #
       # @return [void]
       def define_foregrounds!

data/lib/vedeu/esc/esc.rb

@@ -4,8 +4,8 @@ require 'vedeu/esc/colours'
 
 module Vedeu
 
-  # Provides escape sequence strings for setting the cursor position and various
-  # display related functions.
+  # Provides escape sequence strings for setting the cursor position
+  # and various display related functions.
   #
   module Esc
 
@@ -14,10 +14,10 @@ module Vedeu
     include Vedeu::EscapeSequences::Colours
     extend self
 
-    # Return the stream with the escape sequences escaped so that they can be
-    # printed to the terminal instead of being interpreted by the terminal which
-    # will render them. This way we can see what escape sequences are being sent
-    # along with the content.
+    # Return the stream with the escape sequences escaped so that they
+    # can be printed to the terminal instead of being interpreted by
+    # the terminal which will render them. This way we can see what
+    # escape sequences are being sent along with the content.
     #
     # @param stream [String]
     # @return [String]
@@ -27,8 +27,9 @@ module Vedeu
       stream.gsub(/\e/, '\\e')
     end
 
-    # Return the escape sequence string from the list of recognised sequence
-    # 'commands', or an empty string when the 'command' cannot be found.
+    # Return the escape sequence string from the list of recognised
+    # sequence 'commands', or an empty string when the 'command'
+    # cannot be found.
     #
     # @param value [String|Symbol]
     # @return [String]
@@ -43,8 +44,8 @@ module Vedeu
     # Return the escape sequence to render a border character.
     #
     # @return [String]
-    # @yieldreturn [void] The border character to wrap with border on and off
-    #   escape sequences.
+    # @yieldreturn [void] The border character to wrap with border on
+    #   and off escape sequences.
     def border
       return '' unless block_given?
 

data/lib/vedeu/input/all.rb

@@ -0,0 +1,15 @@
+module Vedeu
+
+  module Input
+
+  end # Input
+
+end # Vedeu
+
+require 'vedeu/input/input'
+require 'vedeu/input/key'
+require 'vedeu/input/keymap'
+require 'vedeu/input/keymaps'
+require 'vedeu/input/keys'
+require 'vedeu/input/mapper'
+require 'vedeu/input/translator'

data/lib/vedeu/input/input.rb

@@ -1,70 +1,73 @@
 module Vedeu
 
-  # Captures input from the user via {Vedeu::Terminal#input} and translates
-  # special characters into symbols.
-  #
-  class Input
+  module Input
 
-    # Instantiate Input and capture keypress(es).
+    # Captures input from the user via {Vedeu::Terminal#input} and
+    # translates special characters into symbols.
     #
-    # @param (see #initialize)
-    # @return [String|Symbol]
-    def self.capture(reader)
-      new(reader).capture
-    end
+    class Input
 
-    # Returns a new instance of Vedeu::Input.
-    #
-    # @param reader [IO] An object that responds to `#read`. Typically, this is
-    #   Vedeu::Terminal.
-    # @return [Vedeu::Input]
-    def initialize(reader)
-      @reader = reader
-    end
-
-    # Triggers either a ':_command_' event with the command when the reader is
-    # in cooked mode, or when in raw mode, the keypress event with the key(s)
-    # pressed.
-    #
-    # @return [Array|String|Symbol]
-    def capture
-      if reader.raw_mode?
-        Vedeu.trigger(:_keypress_, keypress)
+      # Instantiate Vedeu::Input::Input and capture keypress(es).
+      #
+      # @param (see #initialize)
+      # @return [String|Symbol]
+      def self.capture(reader)
+        new(reader).capture
+      end
+
+      # Returns a new instance of Vedeu::Input::Input.
+      #
+      # @param reader [IO] An object that responds to `#read`.
+      #   Typically, this is Vedeu::Terminal.
+      # @return [Vedeu::Input::Input]
+      def initialize(reader)
+        @reader = reader
+      end
+
+      # Triggers either a ':_command_' event with the command when the
+      # reader is in cooked mode, or when in raw mode, the keypress
+      # event with the key(s) pressed.
+      #
+      # @return [Array|String|Symbol]
+      def capture
+        if reader.raw_mode?
+          Vedeu.trigger(:_keypress_, keypress)
 
-      elsif reader.fake_mode?
-        Vedeu.trigger(:_editor_, keypress)
+        elsif reader.fake_mode?
+          Vedeu.trigger(:_editor_, keypress)
 
-      else
-        Vedeu.trigger(:_command_, command)
+        else
+          Vedeu.trigger(:_command_, command)
 
+        end
       end
-    end
 
-    protected
+      protected
 
-    # @!attribute [r] reader
-    # @return [IO]
-    attr_reader :reader
+      # @!attribute [r] reader
+      # @return [IO]
+      attr_reader :reader
 
-    private
+      private
 
-    # Returns the translated (when possible) keypress(es) as either a String or
-    # a Symbol.
-    #
-    # @return [String|Symbol]
-    def keypress
-      key = input
+      # Returns the translated (when possible) keypress(es).
+      #
+      # @return [String|Symbol]
+      def keypress
+        key = input
 
-      Vedeu::InputTranslator.translate(key)
-    end
+        Vedeu::Input::Translator.translate(key)
+      end
 
-    # Returns the input from the terminal.
-    #
-    # @return [String]
-    def input
-      @input ||= reader.read
-    end
-    alias_method :command, :input
+      # Returns the input from the terminal.
+      #
+      # @return [String]
+      def input
+        @input ||= reader.read
+      end
+      alias_method :command, :input
+
+    end # Input
 
   end # Input
 

data/lib/vedeu/input/key.rb

@@ -1,36 +1,42 @@
 module Vedeu
 
-  # A single keypress or combination of keypresses bound to a specific action.
-  #
-  class Key
+  module Input
 
-    # @!attribute [r] input
-    # @return [String|Symbol] Returns the key defined.
-    attr_reader :input
-    alias_method :key, :input
-
-    # Returns a new instance of Vedeu::Key.
-    #
-    # @param input [String|Symbol]
-    # @param block [Proc]
-    # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-    # @return [Vedeu::Key]
-    def initialize(input = nil, &block)
-      fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
-
-      @input  = input
-      @output = block
-    end
-
-    # Pressing the key will call the procedure.
+    # A single keypress or combination of keypresses bound to a
+    # specific action.
     #
-    # @return [|Symbol]
-    def output
-      @output.call
-    end
-    alias_method :action, :output
-    alias_method :press, :output
-
-  end # Key
+    class Key
+
+      # @!attribute [r] input
+      # @return [String|Symbol] Returns the key defined.
+      attr_reader :input
+      alias_method :key, :input
+
+      # Returns a new instance of Vedeu::Input::Key.
+      #
+      # @param input [String|Symbol]
+      # @param block [Proc]
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was
+      #   not given.
+      # @return [Vedeu::Input::Key]
+      def initialize(input = nil, &block)
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+
+        @input  = input
+        @output = block
+      end
+
+      # Pressing the key will call the procedure.
+      #
+      # @return [|Symbol]
+      def output
+        @output.call
+      end
+      alias_method :action, :output
+      alias_method :press, :output
+
+    end # Key
+
+  end # Input
 
 end # Vedeu

data/lib/vedeu/input/keymap.rb

@@ -1,98 +1,107 @@
 module Vedeu
 
-  # A container class for keys associated with a particular interface.
-  #
-  class Keymap
+  module Input
 
-    include Vedeu::Model
-
-    collection Vedeu::Keys
-    member     Vedeu::Key
-
-    # @!attribute [rw] name
-    # @return [String]
-    attr_accessor :name
-
-    # Returns a new instance of Vedeu::Keymap.
-    #
-    # @param attributes [Hash]
-    # @option attributes name [String] The name of the keymap.
-    # @option attributes keys [Vedeu::Keys|Array] A collection of keys.
-    # @option attributes repository [Vedeu::Repository] This model's storage.
-    # @return [Vedeu::Keymap]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Add a key to the keymap.
-    #
-    # @param key [Vedeu::Key]
-    # @return [void]
-    def add(key)
-      return false unless valid?(key)
-
-      @keys = keys.add(key)
-    end
-
-    # Returns the collection of keys defined for this keymap.
-    #
-    # @return [Vedeu::Keys]
-    def keys
-      collection.coerce(@keys, self)
-    end
-
-    # Check whether the key is already defined for this keymap.
-    #
-    # @param input [String|Symbol]
-    # @return [Boolean] A boolean indicating the input provided is already in
-    #   use for this keymap.
-    def key_defined?(input)
-      keys.any? { |key| key.input == input }
-    end
-
-    # When the given input is registered with this keymap, this method triggers
-    # the action associated with the key.
+    # A container class for keys associated with a particular interface.
     #
-    # @param input [String|Symbol]
-    # @return [Array|FalseClass]
-    def use(input)
-      return false unless key_defined?(input)
-
-      Vedeu.log(type: :input, message: "Key pressed: '#{input}'")
-
-      Vedeu.trigger(:key, input)
-
-      keys.select { |key| key.input == input }.map(&:press)
-    end
-
-    private
-
-    # Returns the default options/attributes for this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        name:       '',
-        keys:       [],
-        repository: Vedeu::Keymaps.keymaps,
-      }
-    end
-
-    # Checks that the provided key is not already registered with this keymap.
-    #
-    # @param key [Vedeu::Key]
-    # @return [Boolean]
-    def valid?(key)
-      return true unless key_defined?(key.input)
-
-      Vedeu.log(type:    :input,
-                message: "Keymap '#{name}' already defines '#{key.input}'.")
-
-      false
-    end
-
-  end # Keymap
+    class Keymap
+
+      include Vedeu::Model
+
+      collection Vedeu::Input::Keys
+      member     Vedeu::Input::Key
+
+      # @!attribute [rw] name
+      # @return [String]
+      attr_accessor :name
+
+      # Returns a new instance of Vedeu::Input::Keymap.
+      #
+      # @param attributes [Hash]
+      # @option attributes name [String] The name of the keymap.
+      # @option attributes keys [Vedeu::Input::Keys|Array]
+      #   A collection of keys.
+      # @option attributes repository [Vedeu::Repository]
+      #   This model's storage.
+      # @return [Vedeu::Input::Keymap]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # Add a key to the keymap.
+      #
+      # @param key [Vedeu::Input::Key]
+      # @return [void]
+      def add(key)
+        return false unless valid?(key)
+
+        @keys = keys.add(key)
+      end
+
+      # Returns the collection of keys defined for this keymap.
+      #
+      # @return [Vedeu::Input::Keys]
+      def keys
+        collection.coerce(@keys, self)
+      end
+
+      # Check whether the key is already defined for this keymap.
+      #
+      # @param input [String|Symbol]
+      # @return [Boolean] A boolean indicating the input provided is
+      #   already in use for this keymap.
+      def key_defined?(input)
+        keys.any? { |key| key.input == input }
+      end
+
+      # When the given input is registered with this keymap, this method
+      # triggers the action associated with the key.
+      #
+      # @param input [String|Symbol]
+      # @return [Array|FalseClass]
+      def use(input)
+        return false unless key_defined?(input)
+
+        Vedeu.log(type: :input, message: "Key pressed: '#{input}'")
+
+        Vedeu.trigger(:key, input)
+
+        keys.select { |key| key.input == input }.map(&:press)
+      end
+
+      private
+
+      # Returns the default options/attributes for this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          name:       '',
+          keys:       [],
+          repository: Vedeu::Input::Keymaps.keymaps,
+        }
+      end
+
+      # Checks that the provided key is not already registered with this
+      # keymap.
+      #
+      # @param key [Vedeu::Input::Key]
+      # @return [Boolean]
+      def valid?(key)
+        return true unless key_defined?(key.input)
+
+        Vedeu.log(type:    :input,
+                  message: "Keymap '#{name}' already defines '#{key.input}'.")
+
+        false
+      end
+
+    end # Keymap
+
+  end # Input
 
 end # Vedeu

data/lib/vedeu/input/keymaps.rb

@@ -1,13 +1,17 @@
 module Vedeu
 
-  # Allows the storing of keymaps.
-  #
-  class Keymaps < Vedeu::Repository
+  module Input
 
-    singleton_class.send(:alias_method, :keymaps, :repository)
+    # Allows the storing of keymaps.
+    #
+    class Keymaps < Vedeu::Repository
 
-    real Vedeu::Keymap
+      singleton_class.send(:alias_method, :keymaps, :repository)
 
-  end # Keymaps
+      real Vedeu::Input::Keymap
+
+    end # Keymaps
+
+  end # Input
 
 end # Vedeu

data/lib/vedeu/input/keys.rb

@@ -1,9 +1,13 @@
 module Vedeu
 
-  # A collection of {Vedeu::Key} instances.
-  #
-  class Keys < Vedeu::Collection
+  module Input
 
-  end # Keys
+    # A collection of {Vedeu::Input::Key} instances.
+    #
+    class Keys < Vedeu::Collection
+
+    end # Keys
+
+  end # Input
 
 end # Vedeu