vedeu 0.7.4 → 0.8.0

data/lib/vedeu/input/keys.rb

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

data/lib/vedeu/input/mapper.rb

@@ -20,20 +20,21 @@ module Vedeu
         # @param (see #initialize)
         # @return [Boolean]
         def keypress(key = nil, name = nil)
-          Vedeu.trigger(:key, key)
-
-          return false unless key
-
           new(key, name).keypress
         end
 
+        # @param key [String|Symbol] The keypress.
+        # @param name [String|Symbol] The keymap name.
+        # @raise [Vedeu::Error::MissingRequired] When the key or name
+        #   params are missing.
+        # @return [Boolean]
         def registered?(key = nil, name = nil)
           fail Vedeu::Error::MissingRequired,
                'Cannot check whether a key is registered to a keymap without ' \
-               'the key.' if absent?(key)
+               'the key.'.freeze if absent?(key)
           fail Vedeu::Error::MissingRequired,
                'Cannot check whether a key is registered to a keymap without ' \
-               'the keymap name.' if absent?(name)
+               'the keymap name.'.freeze if absent?(name)
 
           new(key, name).registered?
         end
@@ -69,13 +70,15 @@ module Vedeu
       #
       # @return [Boolean]
       def keypress
+        Vedeu.trigger(:key, key)
+
         return false unless key
 
         return true if key_defined? && keymap.use(key)
 
         return true if global_key? && keymap('_global_').use(key)
 
-        Vedeu.log(type: :input, message: "Key detected: #{key.inspect}".freeze)
+        Vedeu.log(type: :input, message: log_message(key))
 
         false
       end
@@ -102,7 +105,7 @@ module Vedeu
       protected
 
       # @!attribute [r] key
-      # @return [String|Symbol]
+      # @return [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
       attr_reader :key
 
       # @!attribute [r] repository
@@ -135,6 +138,18 @@ module Vedeu
         repository.registered?(named)
       end
 
+      # @param key [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
+      # @return [String]
+      def log_message(key)
+        if key.is_a?(Vedeu::Cursors::Cursor)
+          "Click detected: x: #{key.x} y: #{key.y}".freeze
+
+        else
+          "Key detected: #{key.inspect}".freeze
+
+        end
+      end
+
       # With a name, we check the keymap with that name, otherwise we
       # use the name of the interface currently in focus.
       #
@@ -158,8 +173,6 @@ module Vedeu
   # See {file:docs/events/system.md#\_keypress_}
   Vedeu.bind(:_keypress_) do |key, name|
     Vedeu.timer('Executing keypress') do
-      Vedeu.trigger(:key, key)
-
       Vedeu.add_keypress(key)
 
       Vedeu.keypress(key, name)
@@ -170,10 +183,12 @@ module Vedeu
   Vedeu.bind(:_drb_input_) do |data, type|
     Vedeu.log(type: :drb, message: "Sending input (#{type})".freeze)
 
-    case type
-    when :command  then Vedeu.trigger(:_command_, data)
-    when :keypress then Vedeu.trigger(:_keypress_, data)
-    else Vedeu.trigger(:_keypress_, data)
+    if type == :command
+      Vedeu.trigger(:_command_, data)
+
+    else
+      Vedeu.trigger(:_keypress_, data)
+
     end
   end
 

data/lib/vedeu/input/read.rb

@@ -116,8 +116,10 @@ module Vedeu
 
       # @return [Symbol]
       def mode
-        fail Vedeu::Error::InvalidSyntax,
-             ':mode must be `:raw`, `:fake` or `:cooked`.' unless valid_mode?
+        unless valid_mode?
+          fail Vedeu::Error::InvalidSyntax,
+               ':mode must be `:raw`, `:fake` or `:cooked`.'.freeze
+        end
 
         options[:mode]
       end

data/lib/vedeu/interfaces/dsl.rb

@@ -8,10 +8,10 @@ module Vedeu
 
       include Vedeu::Common
       include Vedeu::DSL
-      include Vedeu::Cursors::DSL
+      include Vedeu::DSL::Cursors
+      include Vedeu::DSL::Border
+      include Vedeu::DSL::Geometry
       include Vedeu::DSL::Presentation
-      include Vedeu::DSL::Shared
-      include Vedeu::DSL::Text
       include Vedeu::DSL::Use
 
       class << self
@@ -36,9 +36,8 @@ module Vedeu
         # @return [Vedeu::Interfaces::Interface]
         # @todo More documentation required.
         def interface(name, &block)
+          fail Vedeu::Error::MissingRequired unless name
           fail Vedeu::Error::RequiresBlock unless block_given?
-          fail Vedeu::Error::MissingRequired,
-               'name not given'.freeze unless present?(name)
 
           attributes = { client: client(&block), name: name }
 
@@ -50,6 +49,7 @@ module Vedeu
           add_cursor!(name)
           add_editor!(name) if interface.editable?
           add_focusable!(name)
+          add_keymap!(name)
 
           interface
         end
@@ -87,11 +87,20 @@ module Vedeu
         # registered.
         #
         # @param name [String|Symbol]
-        # @return [void]
+        # @return [Array<String|Symbol>]
         def add_focusable!(name)
           Vedeu::Models::Focus.add(name)
         end
 
+        # Registers a new keymap for the interface unless already
+        # registered.
+        #
+        # @param name [String|Symbol]
+        # @return [NilClass|Vedeu::Input::Keymap]
+        def add_keymap!(name)
+          Vedeu::Input::Keymap.store(name: name) unless keymap?(name)
+        end
+
         # Returns the client object which called the DSL method.
         #
         # @param block [Proc]
@@ -100,6 +109,14 @@ module Vedeu
           eval('self', block.binding)
         end
 
+        private
+
+        # @param name [String|Symbol]
+        # @return [Boolean]
+        def keymap?(name)
+          Vedeu.keymaps.registered?(name)
+        end
+
       end # Eigenclass
 
       # To maintain performance interfaces can be delayed from
@@ -213,22 +230,6 @@ module Vedeu
       end
       alias_method :keys, :keymap
 
-      # The name of the interface. Used to reference the interface
-      # throughout your application's execution lifetime.
-      #
-      # @param value [String|Symbol]
-      #
-      # @example
-      #   Vedeu.interface do
-      #     name :my_interface
-      #     # ...
-      #   end
-      #
-      # @return [String|Symbol]
-      def name(value)
-        model.name = value
-      end
-
       # Set the interface to visible.
       #
       # @example

data/lib/vedeu/interfaces/interface.rb

@@ -148,8 +148,8 @@ module Vedeu
           cursor_visible: true,
           delay:          0.0,
           editable:       false,
-          group:          '',
-          name:           '',
+          group:          ''.freeze,
+          name:           ''.freeze,
           parent:         nil,
           repository:     Vedeu.interfaces,
           style:          :normal,

data/lib/vedeu/logging/debug.rb

@@ -9,6 +9,28 @@ module Vedeu
 
       extend self
 
+      # @param binding [Binding]
+      # @param obj [Object]
+      # @return [void]
+      def debug(binding = nil, obj = nil)
+        require 'pry'
+
+        if obj
+          message = ::Pry::ColorPrinter.pp(obj, '')
+
+          Vedeu.log(type: :debug, message: "#{message}")
+
+        elsif binding
+          Vedeu::Terminal.cooked_mode!
+          Vedeu::Terminal.open do
+            Vedeu::Terminal.debugging!
+
+            binding.pry
+          end
+          Vedeu::Terminal.raw_mode!
+        end
+      end
+
       # :nocov:
       # Helps to profile a running application by providing a stack
       # trace of its execution upon exiting.
@@ -99,4 +121,15 @@ module Vedeu
   def_delegators Vedeu::Logging::Debug,
                  :profile
 
+  # Drop into a debugging session within a running client application,
+  # courtesy of pry.
+  #
+  # @example
+  #   Vedeu.debug
+  #
+  # @!method debug
+  # @return [void]
+  def_delegators Vedeu::Logging::Debug,
+                 :debug
+
 end # Vedeu

data/lib/vedeu/logging/log.rb

@@ -22,7 +22,7 @@ module Vedeu
         # @param type [Symbol] Colour code messages in the log file
         #   depending on their source. See {message_types}
         #
-        # @return [TrueClass]
+        # @return [String]
         def log(message:, force: false, type: :info)
           output = log_entry(type, message)
 
@@ -38,7 +38,7 @@ module Vedeu
         # @example
         #   Vedeu.log_stdout
         #
-        # @return [TrueClass]
+        # @return [String]
         def log_stdout(type: :info, message:)
           $stdout.puts log_entry(type, message)
         end
@@ -48,7 +48,7 @@ module Vedeu
         # @example
         #   Vedeu.log_stderr
         #
-        # @return [TrueClass]
+        # @return [String]
         def log_stderr(type: :info, message:)
           $stderr.puts log_entry(type, message)
         end
@@ -73,7 +73,7 @@ module Vedeu
 
         private
 
-        # @return [TrueClass]
+        # @return [Boolean]
         def logger
           MonoLogger.new(log_file).tap do |log|
             log.formatter = proc do |_, _, _, message|
@@ -120,9 +120,17 @@ module Vedeu
         # @param body [String] The log message itself.
         # @return [String]
         def message_body(type, body)
-          Vedeu::EscapeSequences::Esc
-            .send(message_types.fetch(type, :default)[-1]) do
-            body
+          message_colour(type, -1) { body }
+        end
+
+        # @param type [Symbol] The type of log message.
+        # @param index [Fixnum] Either 0 or -1.
+        # @param block [Proc]
+        # @return [String]
+        def message_colour(type, index, &block)
+          Vedeu::EscapeSequences::Esc.send(
+            message_types.fetch(type, :default)[index]) do
+            yield if block_given?
           end
         end
 
@@ -132,10 +140,7 @@ module Vedeu
         # @param type [Symbol] The type of log message.
         # @return [String]
         def message_type(type)
-          Vedeu::EscapeSequences::Esc
-            .send(message_types.fetch(type, :default)[0]) do
-            "[#{type}]".ljust(11)
-          end
+          message_colour(type, 0) { "[#{type}]".ljust(11) }
         end
 
         # The defined message types for Vedeu with their respective
@@ -147,40 +152,44 @@ module Vedeu
         # value array, whilst the 'message' will be shown using the
         # last colour.
         #
-        # Valid types available:
-        #
-        #     :config, :create, :debug, :error, :drb, :event, :info,
-        #     :input, :output, :reset, :store, :test, :timer, :update
-        #
         # @return [Hash<Symbol => Array<Symbol>>]
         def message_types
           {
-            create: [:light_cyan, :cyan],
-            store:  [:light_cyan, :cyan],
-            update: [:light_cyan, :cyan],
-            reset:  [:light_cyan, :cyan],
+            create:   [:light_cyan, :cyan],
+            store:    [:light_cyan, :cyan],
+            update:   [:light_cyan, :cyan],
+            reset:    [:light_cyan, :cyan],
 
-            event:  [:light_magenta, :magenta],
+            event:    [:light_magenta, :magenta],
 
-            timer:  [:light_blue, :blue],
+            timer:    [:light_blue, :blue],
 
-            info:   [:white, :light_grey],
-            test:   [:white, :light_grey],
-            debug:  [:white, :light_grey],
+            info:     [:white, :light_grey],
+            test:     [:white, :light_grey],
+            debug:    [:white, :light_grey],
+            compress: [:white, :light_grey],
 
-            input:  [:light_yellow, :yellow],
+            input:    [:light_yellow, :yellow],
+            output:   [:light_yellow, :yellow],
 
-            compress: [:white, :light_grey],
             cursor:   [:light_green, :green],
-            output:   [:light_green, :green],
+            buffer:   [:light_green, :green],
             render:   [:light_green, :green],
 
-            error:  [:light_red, :red],
+            error:    [:light_red, :red],
+
+            config:   [:light_blue, :blue],
+            dsl:      [:light_blue, :blue],
+            editor:   [:light_blue, :blue],
+            drb:      [:light_blue, :blue],
 
-            config: [:light_blue, :blue],
-            dsl:    [:light_blue, :blue],
-            editor: [:light_blue, :blue],
-            drb:    [:light_blue, :blue],
+            blue:     [:light_blue,    :blue],
+            cyan:     [:light_cyan,    :cyan],
+            green:    [:light_green,   :green],
+            magenta:  [:light_magenta, :magenta],
+            red:      [:light_red,     :red],
+            white:    [:white,         :light_grey],
+            yellow:   [:light_yellow,  :yellow],
           }
         end
 

data/lib/vedeu/menus/dsl.rb

@@ -15,7 +15,8 @@ module Vedeu
         # items for your users to select; and provide interactivity
         # within your application.
         #
-        # @param name [String|Symbol]
+        # @param name [String|Symbol] The name of the interface or
+        #   view to which this menu belongs.
         # @param block [Proc] A set of attributes which define the
         #   features of the menu. See {Vedeu::Menus::DSL#items} and
         #   {Vedeu::Menus::DSL#name}.
@@ -32,9 +33,12 @@ module Vedeu
         #     # ...
         #   end
         #
-        # @raise [Vedeu::Error::RequiresBlock]
+        # @raise [Vedeu::Error::MissingRequired|
+        #   Vedeu::Error::RequiresBlock] When a name or block
+        #   respectively are not given.
         # @return [API::Menu]
-        def menu(name = '', &block)
+        def menu(name, &block)
+          fail Vedeu::Error::MissingRequired unless name
           fail Vedeu::Error::RequiresBlock unless block_given?
 
           attributes = { client: client(&block), name: name }
@@ -92,21 +96,6 @@ module Vedeu
       end
       alias_method :items=, :items
 
-      # The name of the menu. Used to reference the menu throughout
-      # your application's execution lifetime.
-      #
-      #   Vedeu.menu do
-      #     name :my_menu
-      #     # ...
-      #   end
-      #
-      # @param name [String|Symbol]
-      # @return [String]
-      def name(name)
-        model.name = name
-      end
-      alias_method :name=, :name
-
     end # DSL
 
   end # Menus