vedeu 0.6.28 → 0.6.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e78a39e26891252b15013c3ee2e5b3d9255a824
-  data.tar.gz: 72ae82abfadbc68b4877b21379d086ddd552249d
+  metadata.gz: acc3caf904e10f4af35074e6b869c3ad65f96af2
+  data.tar.gz: fe00ef8a86cc1e6e4615361e9d57e30ed2f316fc
 SHA512:
-  metadata.gz: 06071e418374792ba1b007ececa0d47b04e8ef53290a821b1e8fe99283cac3e872f09c667a911a0f6f54e3c01490bacbfbcae47180b373244a678967f0d5c6c4
-  data.tar.gz: 09d5fe864aff632e25baf9b1ff0a0b0215e6e5ba5c5874fac7e4950ed4293b7410fc25229b54e31340d00c484e3a5e325f47ed69720d3190034fc38f1c00dc0f
+  metadata.gz: f0c354b58c059144923e853c58d3a3b5d5ac31b194f51362cb876c9182fa2fde1003781963b1b3fc69e17e36e830af7f4c6ad6f053b67003289345eed811c9d3
+  data.tar.gz: 2c618148a9cf0f395c110ba0b4e9d1aa845966f1c9d2d1d771860bb27f808b24502e66550aac3c6fdf9e677bb3ed653a5d3d50c0b0259e73564d3192e5164a4f

data/.yardopts

@@ -13,6 +13,7 @@ docs/geometry.md
 docs/getting_started.md
 docs/group.md
 docs/interfaces.md
+docs/keymaps.md
 docs/object_graph.md
 docs/view.md
 docs/events/application.md

data/README.md

@@ -55,6 +55,7 @@ here is some documentation for the various aspects of Vedeu:
 - [Geometry](http://rubydoc.info/gems/vedeu/file/docs/geometry.md)
 - [Borders](http://rubydoc.info/gems/vedeu/file/docs/border.md)
 - [Cursors](http://rubydoc.info/gems/vedeu/file/docs/cursor.md)
+- [Keymaps](http://rubydoc.info/gems/vedeu/file/docs/keymaps.md)
 - [Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
 - [Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
 - [Getting Started](http://rubydoc.info/gems/vedeu/file/docs/getting_started.md)

data/docs/dsl.md

@@ -129,9 +129,9 @@ end
 
 ## Keymaps
 
-{include:Vedeu::DSL::Keymap}
-{include:Vedeu::DSL::Keymap.keymap}
-{include:Vedeu::DSL::Keymap#name}
+{include:Vedeu::Keymaps::DSL}
+{include:Vedeu::Keymaps::DSL.keymap}
+{include:Vedeu::Keymaps::DSL#name}
 
 ## Menus
 
@@ -143,7 +143,7 @@ end
 ## Views
 
 {include:Vedeu::DSL::View}
-{include:Vedeu::DSL::Interface.interface}
+{include:Vedeu::Interfaces::DSL.interface}
 
 ### Immediate rendering
 

data/docs/keymaps.md

@@ -0,0 +1,25 @@
+# @title Vedeu Keymaps
+# Vedeu Keymaps
+
+Keymaps define the keypresses applicable to an interface or view. A
+keymap sharing the same name as an interface will only operate if that
+interface is currently in focus.
+
+Alongside this functioanlity, there is a global keymap '_global_'
+which will respond to keypresses regardless of which interface is in
+focus. The global keymap is useful for mapping the key to exit the
+application for example.
+
+- It has a name. This name associates it with an
+  {file:docs/interface.md Interface}.
+- A key registered with a keymap can call a method or trigger an
+  event, or either, in multitude.
+- Keymaps only affect the interface/view with the same name.
+- The same key can be registered with mulitple keymaps and perform
+  different actions dependent on which interface is currently in
+  focus.
+- Some keys on the keymap are stored as strings, whilst others are
+  symbols; representations of the keys pressed.
+
+You can find out which keys Vedeu recognises here:
+{Vedeu::Input::Translator}.

data/lib/vedeu/all.rb

@@ -15,7 +15,6 @@ require 'vedeu/repositories/all'
 
 require 'vedeu/models/toggleable'
 
-require 'vedeu/output/direct'
 require 'vedeu/output/clear/all'
 require 'vedeu/output/compressor'
 require 'vedeu/output/text'
@@ -42,6 +41,7 @@ require 'vedeu/events/all'
 require 'vedeu/geometry/all'
 require 'vedeu/groups/all'
 require 'vedeu/input/all'
+require 'vedeu/interfaces/all'
 require 'vedeu/menus/all'
 require 'vedeu/templating/all'
 

data/lib/vedeu/borders/border.rb

@@ -86,7 +86,7 @@ module Vedeu
       attr_reader :name
 
       # @!attribute [r] parent
-      # @return [Vedeu::Models::Interface|NilClass]
+      # @return [Vedeu::Interfaces::Interface|NilClass]
       attr_reader :parent
 
       # @!attribute [r] enabled

data/lib/vedeu/borders/refresh.rb

@@ -174,7 +174,7 @@ module Vedeu
 
       # The parent of a border is always an interface.
       #
-      # @return [Vedeu::Models::Interface]
+      # @return [Vedeu::Interfaces::Interface]
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/common.rb

@@ -16,7 +16,7 @@ module Vedeu
     # Removes the module part from the expression in the string.
     #
     # @example
-    #   demodulize('Vedeu::DSL::Interface') # => "Interface"
+    #   demodulize('Vedeu::SomeModule::SomeClass') # => "SomeClass"
     #
     # @param klass [Class|String]
     # @return [String]

data/lib/vedeu/dsl/all.rb

@@ -13,9 +13,7 @@ require 'vedeu/dsl/shared'
 require 'vedeu/dsl/use'
 require 'vedeu/dsl/presentation'
 require 'vedeu/dsl/composition'
-require 'vedeu/dsl/keymap'
 require 'vedeu/dsl/text'
-require 'vedeu/dsl/interface'
 require 'vedeu/dsl/line'
 require 'vedeu/dsl/stream'
 require 'vedeu/dsl/view'

data/lib/vedeu/dsl/presentation.rb

@@ -3,7 +3,7 @@ module Vedeu
   module DSL
 
     # Provides colour and style helpers for use in the
-    # {Vedeu::DSL::Interface}, {Vedeu::DSL::Line} and
+    # {Vedeu::Interfaces::DSL}, {Vedeu::DSL::Line} and
     # {Vedeu::DSL::Stream} classes.
     #
     module Presentation

data/lib/vedeu/dsl/shared.rb

@@ -3,7 +3,7 @@ module Vedeu
   module DSL
 
     # Provides behaviour to be shared between both
-    # {Vedeu::DSL::Interface} and {Vedeu::DSL::View} objects.
+    # {Vedeu::Interfaces::DSL} and {Vedeu::DSL::View} objects.
     #
     module Shared
 

data/lib/vedeu/dsl/text.rb

@@ -64,7 +64,7 @@ module Vedeu
       #   string is shorter than the specified width.
       # @return [String]
       def text(value = '', options = {})
-        options.merge!(anchor: __callee__, model: model)
+        options.merge!(anchor: __callee__, model: model, client: client)
 
         Vedeu::Output::Text.add(value, options)
       end

data/lib/vedeu/dsl/view.rb

@@ -10,7 +10,7 @@ module Vedeu
     # Both of these approaches require that you have defined an
     # interface (or 'visible area') first. You can find out how to
     # define an interface with Vedeu below or in
-    # {Vedeu::DSL::Interface}. The examples in 'Immediate Render' and
+    # {Vedeu::Interfaces::DSL}. The examples in 'Immediate Render' and
     # 'Deferred View' use these interface definitions: (Note: should
     # you use these examples, ensure your terminal is at least 70
     # characters in width and 5 lines in height.)
@@ -136,7 +136,9 @@ module Vedeu
         def renders(&block)
           fail Vedeu::Error::RequiresBlock unless block_given?
 
-          store(:store_immediate, &block)
+          client = eval('self', block.binding)
+
+          store(:store_immediate, client, &block)
         end
         alias_method :render, :renders
 
@@ -181,19 +183,13 @@ module Vedeu
         def views(&block)
           fail Vedeu::Error::RequiresBlock unless block_given?
 
-          store(:store_deferred, &block)
+          client = eval('self', block.binding)
+
+          store(:store_deferred, client, &block)
         end
 
         private
 
-        # Returns the client object which called the DSL method.
-        #
-        # @param block [Proc]
-        # @return [Object]
-        def client(&block)
-          eval('self', block.binding)
-        end
-
         # Creates a new Vedeu::Views::Composition which may contain
         # one or more views (Vedeu::Views::View objects).
         #
@@ -210,10 +206,12 @@ module Vedeu
         # @param method [Symbol] An instruction; `:store_immediate` or
         #   `:store_deferred` which determines whether the view will
         #   be shown immediately or later respectively.
+        # @param client [Object] The client class which called the DSL
+        #   object.
         # @param block [Proc]
         # @return [Array]
-        def store(method, &block)
-          composition(client(&block), &block).views.map do |view|
+        def store(method, client, &block)
+          composition(client, &block).views.map do |view|
             view.public_send(method)
           end
         end

data/lib/vedeu/editor/cropper.rb

@@ -87,7 +87,7 @@ module Vedeu
         @lines[oy...(oy + height)] || []
       end
 
-      # @return [Vedeu::Models::Interface]
+      # @return [Vedeu::Interfaces::Interface]
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/editor/document.rb

@@ -178,14 +178,14 @@ module Vedeu
       #
       # @return [Vedeu::Editor::Document]
       def up
-        if x > line(y - 1).size
-          cursor.up
+        return self if y - 1 < 0
 
+        cursor.up
+
+        if x > line(y).size
           eol
 
         else
-          cursor.up
-
           refresh
 
         end
@@ -197,14 +197,12 @@ module Vedeu
       def down
         return self if y + 1 >= lines.size
 
-        if x > line(y + 1).size
-          cursor.down
+        cursor.down
 
+        if x > line(y).size
           eol
 
         else
-          cursor.down
-
           refresh
 
         end

data/lib/vedeu/geometry/geometry.rb

@@ -72,6 +72,10 @@ module Vedeu
       # @return [Fixnum]
       attr_writer :yn
 
+      # @!attribute [rw] client
+      # @return [Object]
+      attr_accessor :client
+
       # @param (see #initialize)
       # @return (see #initialize)
       def self.store(attributes)
@@ -194,6 +198,7 @@ module Vedeu
         store do
           Vedeu.trigger(:_clear_)
           Vedeu.trigger(:_refresh_)
+          Vedeu.trigger(:_refresh_view_, name)
         end
       end
 
@@ -283,6 +288,7 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
+          client:     nil,
           centred:    nil,
           height:     nil,
           maximised:  false,

data/lib/vedeu/geometry/position.rb

@@ -47,6 +47,8 @@ module Vedeu
       def initialize(y = 1, x = 1)
         @y = (y.nil? || y < 1) ? 1 : y
         @x = (x.nil? || x < 1) ? 1 : x
+
+        freeze
       end
 
       # Converts a position into an index for the terminal. An index

data/lib/vedeu/groups/group.rb

@@ -162,7 +162,7 @@ module Vedeu
 
       # Return the interfaces for all members of the group.
       #
-      # @return [Array<Vedeu::Models::Interface]
+      # @return [Array<Vedeu::Interfaces::Interface]
       def interfaces
         members.map { |name| Vedeu.interfaces.by_name(name) }
       end

data/lib/vedeu/input/all.rb

@@ -10,6 +10,7 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/input/capture'
+require 'vedeu/input/dsl'
 require 'vedeu/input/key'
 require 'vedeu/input/keymap'
 require 'vedeu/input/keymaps'

data/lib/vedeu/{dsl/keymap.rb → input/dsl.rb}

@@ -1,13 +1,13 @@
 module Vedeu
 
-  module DSL
+  module Keymaps
 
     # You can define keymaps by name which matches a defined
     # interface. When that interface is in focus, keys pressed as part
     # of this definition will affect that interface. This allows you
     # to form context driven behaviour for your application.
     #
-    class Keymap
+    class DSL
 
       include Vedeu::Common
       include Vedeu::DSL
@@ -110,12 +110,12 @@ module Vedeu
       end
       alias_method :name=, :name
 
-    end # Keymap
+    end # DSL
 
-  end # DSL
+  end # Keymaps
 
   # @!method keymap
-  #   @see Vedeu::DSL::Keymap.keymap
-  def_delegators Vedeu::DSL::Keymap, :keymap
+  #   @see Vedeu::Keymaps::DSL.keymap
+  def_delegators Vedeu::Keymaps::DSL, :keymap
 
 end # Vedeu

data/lib/vedeu/interfaces/all.rb

@@ -0,0 +1,12 @@
+module Vedeu
+
+  module Interfaces
+
+  end # Interfaces
+
+end # Vedeu
+
+require 'vedeu/interfaces/interface'
+require 'vedeu/interfaces/dsl'
+require 'vedeu/interfaces/null'
+require 'vedeu/interfaces/repository'

data/lib/vedeu/{dsl/interface.rb → interfaces/dsl.rb}

@@ -1,10 +1,10 @@
 module Vedeu
 
-  module DSL
+  module Interfaces
 
     # DSL for creating interfaces.
     #
-    class Interface
+    class DSL
 
       include Vedeu::Common
       include Vedeu::DSL
@@ -32,7 +32,7 @@ module Vedeu
         # @param block [Proc] A set of attributes which define the
         #   features of the interface.
         # @raise [Vedeu::Error::RequiresBlock]
-        # @return [Vedeu::Models::Interface]
+        # @return [Vedeu::Interfaces::Interface]
         # @todo More documentation required.
         def interface(name, &block)
           fail Vedeu::Error::RequiresBlock unless block_given?
@@ -45,7 +45,7 @@ module Vedeu
 
           attributes = { client: client(&block), name: name }
 
-          Vedeu::Models::Interface.build(attributes, &block).store
+          Vedeu::Interfaces::Interface.build(attributes, &block).store
         end
 
         private
@@ -193,7 +193,7 @@ module Vedeu
 
       # @param name [String|Symbol] The name of the interface to which
       #   this keymap should belong.
-      # @see Vedeu::DSL::Keymap.keymap
+      # @see Vedeu::Keymaps::DSL.keymap
       def keymap(name = model.name, &block)
         Vedeu.keymap(name, &block)
       end
@@ -252,7 +252,7 @@ module Vedeu
       #
       # @param name [String|Symbol] The name of the interface model
       #   you wish to use a value from.
-      # @return [Vedeu::Models::Interface]
+      # @return [Vedeu::Interfaces::Interface]
       def use(name)
         model.repository.by_name(name)
       end
@@ -312,12 +312,12 @@ module Vedeu
       alias_method :z_index, :zindex
       alias_method :z,       :zindex
 
-    end # Interface
+    end # DSL
 
-  end # DSL
+  end # Interfaces
 
   # @!method interface
-  #   @see Vedeu::DSL::Interface.interface
-  def_delegators Vedeu::DSL::Interface, :interface
+  #   @see Vedeu::Interfaces::DSL.interface
+  def_delegators Vedeu::Interfaces::DSL, :interface
 
 end # Vedeu

data/lib/vedeu/{models → interfaces}/interface.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Models
+  module Interfaces
 
     # An Interface represents a portion of the terminal defined by
     # {Vedeu::Geometry::Geometry}.
@@ -39,7 +39,7 @@ module Vedeu
       # @return [Fixnum]
       attr_accessor :zindex
 
-      # Return a new instance of Vedeu::Models::Interface.
+      # Return a new instance of Vedeu::Interfaces::Interface.
       #
       # @param attributes [Hash]
       # @option attributes client [Vedeu::Client]
@@ -48,11 +48,11 @@ module Vedeu
       # @option attributes group [String]
       # @option attributes name [String|Symbol]
       # @option attributes parent [Vedeu::Views::Composition]
-      # @option attributes repository [Vedeu::Models::Interfaces]
+      # @option attributes repository [Vedeu::Interfaces::Repository]
       # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes visible [Boolean]
       # @option attributes zindex [Fixnum]
-      # @return [Vedeu::Models::Interface]
+      # @return [Vedeu::Interfaces::Interface]
       def initialize(attributes = {})
         @attributes = defaults.merge!(attributes)
 
@@ -123,7 +123,7 @@ module Vedeu
 
     end # Interface
 
-  end # Models
+  end # Interfaces
 
   # @!method hide_interface
   #   @see Vedeu::Toggleable::ClassMethods#hide
@@ -131,7 +131,7 @@ module Vedeu
   #   @see Vedeu::Toggleable::ClassMethods#show
   # @!method toggle_interface
   #   @see Vedeu::Toggleable::ClassMethods#toggle
-  def_delegators Vedeu::Models::Interface, :hide_interface, :show_interface,
+  def_delegators Vedeu::Interfaces::Interface, :hide_interface, :show_interface,
                  :toggle_interface
 
 end # Vedeu

data/lib/vedeu/{null/interface.rb → interfaces/null.rb}

@@ -1,10 +1,10 @@
 module Vedeu
 
-  module Null
+  module Interfaces
 
     # Provides a non-existent model to swallow messages.
     #
-    class Interface < Vedeu::Null::Generic
+    class Null < Vedeu::Null::Generic
 
       include Vedeu::Presentation
 
@@ -12,19 +12,19 @@ module Vedeu
       # @return [String]
       attr_reader :attributes
 
-      # Returns a new instance of Vedeu::Null::Interface.
+      # Returns a new instance of Vedeu::Interfaces::Null.
       #
       # @param attributes [Hash<Symbol => void>]
       # @option attributes name [String|Symbol]
-      # @return [Vedeu::Null::Interface]
+      # @return [Vedeu::Interfaces::Null]
       def initialize(attributes = {})
         @attributes = attributes
         @name       = @attributes[:name]
         @visible    = false
       end
 
-    end # Interface
+    end # Null
 
-  end # Null
+  end # Interfaces
 
 end # Vedeu

data/lib/vedeu/{models/interfaces.rb → interfaces/repository.rb}

@@ -1,23 +1,23 @@
 module Vedeu
 
-  module Models
+  module Interfaces
 
     # Allows the storing of interfaces and views.
     #
-    class Interfaces < Vedeu::Repositories::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :interfaces, :repository)
 
-      null Vedeu::Null::Interface
-      real Vedeu::Models::Interface
+      null Vedeu::Interfaces::Null
+      real Vedeu::Interfaces::Interface
 
       # Returns the interfaces in zindex order.
       #
       # @example
       #   Vedeu.interfaces.zindexed
       #
-      # @return [Array<Vedeu::Models::Interface>]
-      # @see Vedeu::DSL::Interface#zindex
+      # @return [Array<Vedeu::Interfaces::Interface>]
+      # @see Vedeu::Interfaces::DSL#zindex
       def zindexed
         all.sort_by(&:zindex)
       end
@@ -26,11 +26,11 @@ module Vedeu
 
     class Interface
 
-      repo Vedeu::Models::Interfaces.repository
+      repo Vedeu::Interfaces::Repository.repository
 
     end # Interface
 
-  end # Models
+  end # Interfaces
 
   # Manipulate the repository of interfaces.
   #
@@ -38,7 +38,7 @@ module Vedeu
   #   Vedeu.interfaces
   #
   # @!method interfaces
-  # @return [Vedeu::Models::Interfaces]
-  def_delegators Vedeu::Models::Interfaces, :interfaces
+  # @return [Vedeu::Interfaces::Repository]
+  def_delegators Vedeu::Interfaces::Repository, :interfaces
 
 end # Vedeu

data/lib/vedeu/logging/log.rb

@@ -138,21 +138,27 @@ module Vedeu
         # @return [Hash<Symbol => Array<Symbol>>]
         def message_types
           {
-            config: [:light_yellow,  :yellow],
-            create: [:light_green,   :green],
-            debug:  [:light_red,     :red],
+            create: [:light_cyan,    :cyan],
+            store:  [:light_cyan,    :cyan],
+            update: [:light_cyan,    :cyan],
+            reset:  [:light_cyan,    :cyan],
+
+            event:  [:light_magenta, :magenta],
+
+            timer:  [:light_yellow,  :yellow],
+
+            info:   [:white,   :default],
+            test:   [:white,   :default],
+            debug:  [:white,   :default],
+
+            input:  [:light_red,     :red],
+            output: [:light_red,     :red],
             error:  [:light_red,     :red],
+
+            config: [:light_blue,    :blue],
+            dsl:    [:light_blue,    :blue],
             editor: [:light_blue,    :blue],
             drb:    [:light_blue,    :blue],
-            event:  [:light_magenta, :magenta],
-            info:   [:white,         :default],
-            input:  [:light_red,     :red],
-            output: [:light_green,   :green],
-            reset:  [:light_cyan,    :cyan],
-            store:  [:light_cyan,    :cyan],
-            test:   [:light_white,   :white],
-            timer:  [:light_yellow,  :yellow],
-            update: [:light_cyan,    :cyan],
           }
         end
 

data/lib/vedeu/models/focus.rb

@@ -10,7 +10,7 @@ module Vedeu
     #   - Interfaces are added to the collection in the order they are
     #     defined.
     #   - If the interface definition contains `focus!`,
-    #     (see Vedeu::DSL::Interface#focus!) then that interface is
+    #     (see Vedeu::Interfaces::DSL#focus!) then that interface is
     #     prepended to the list.
     #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is
     #     used, then the list pointer (`current`) is set to the

data/lib/vedeu/models/toggleable.rb

@@ -4,7 +4,7 @@ module Vedeu
   # toggled between being shown and hidden.
   #
   # Currently using this are: {Vedeu::Cursors::Cursor},
-  # {Vedeu::Groups::Group} and {Vedeu::Models::Interface}.
+  # {Vedeu::Groups::Group} and {Vedeu::Interfaces::Interface}.
   #
   module Toggleable
 

data/lib/vedeu/models/views/all.rb

@@ -12,7 +12,5 @@ require 'vedeu/models/views/char'
 require 'vedeu/models/views/html_char'
 require 'vedeu/models/views/stream'
 require 'vedeu/models/views/line'
-require 'vedeu/models/interface'
-require 'vedeu/models/interfaces'
 require 'vedeu/models/views/view'
 require 'vedeu/models/views/composition'