vedeu 0.6.10 → 0.6.11

data/lib/vedeu/dsl/composition.rb

@@ -4,36 +4,38 @@ module Vedeu
 
     # DSL for creating collections of interfaces.
     #
-    # Views with Vedeu are made up of simple building blocks. These blocks can
-    # be arranged in a multitude of ways which I hope is more than sufficient
-    # for your design needs.
+    # Views with Vedeu are made up of simple building blocks. These
+    # blocks can be arranged in a multitude of ways which I hope is
+    # more than sufficient for your design needs.
 
     # - A view (`Composition`) is made up of one or more interfaces.
-    # - An interface is an area on the screen where you can take input or direct
-    #   output. You will define it's colour and style, its dimensions, including
-    #   position and give it a name. You can then direct the output of a
-    #   command, or event, to this interface and Vedeu will ensure the content
-    #   is placed there.
-    # - Interfaces (`Interface`) are made up of lines (`Line`), their length
-    #   being the width of the interface and their number being the height of
-    #   the interface.
-    # - An interface with `width: 12, height: 5` will have five lines, each made
-    #   of 12 characters- providing 60 cells. Colours and styles are handled by
-    #   terminal escape sequences and therefore do not consume a cell.
-    # - Lines are made up of zero, one or multiple streams (`Stream`) which are
+    # - An interface is an area on the screen where you can take input
+    #   or direct output. You will define it's colour and style, its
+    #   dimensions, including position and give it a name. You can
+    #   then direct the output of a command, or event, to this
+    #   interface and Vedeu will ensure the content is placed there.
+    # - Interfaces (`Interface`) are made up of lines (`Line`), their
+    #   length being the width of the interface and their number being
+    #   the height of the interface.
+    # - An interface with `width: 12, height: 5` will have five lines,
+    #   each made of 12 characters- providing 60 cells. Colours and
+    #   styles are handled by terminal escape sequences and therefore
+    #   do not consume a cell.
+    # - Lines are made up of zero, one or multiple streams which are
     #   basically subsets of the line.
-    # - An interface, line or stream can have a colour (`colour`) attribute.
-    # - An interface, line or stream can have a style (`style`) attribute.
-    # - Interfaces have a position (`y`, `x`) on the screen, and a size.
-    #   (`width`, `height`)
+    # - An interface, line or stream can have a colour attribute.
+    # - An interface, line or stream can have a style attribute.
+    # - Interfaces have a position (`y`, `x`) on the screen, and a
+    #   size. (`width`, `height`)
     # - Interfaces can be placed relative to each other based on their
     #   attributes.
-    #     - An interface has a `top`, `right`, `bottom`, `left`.
-    #     - An interface also has a `north` and `west` (`top` and `left` minus 1
-    #       respectively).
-    #     - An interface also has a `south` and `east` (`bottom` and `right`
-    #       plus 1 respectively).
-    # - Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
+    #   - An interface has a `top`, `right`, `bottom`, `left`.
+    #   - An interface also has a `north` and `west` (`top` and `left`
+    #     minus 1 respectively).
+    #   - An interface also has a `south` and `east` (`bottom` and
+    #     `right` plus 1 respectively).
+    # - Colours are defined in CSS-style values, i.e. `#ff0000` would
+    #   be red.
     # - Styles are named. See the table below for supported styles.
     #
     class Composition
@@ -54,14 +56,15 @@ module Vedeu
       #
       # A view is just an Interface object.
       #
-      # When a view already exists, we take its attributes and use them as the
-      # basis for the newly defined view. This way we don't need to specify
-      # everything again.
+      # When a view already exists, we take its attributes and use
+      # them as the basis for the newly defined view. This way we
+      # don't need to specify everything again.
       #
       # @todo More documentation required.
-      # @param name [String] The name of the interface you are targetting for
-      #   this view.
-      # @param block [Proc] The directives you wish to send to this interface.
+      # @param name [String] The name of the interface you are
+      #   targetting for this view.
+      # @param block [Proc] The directives you wish to send to this
+      #   interface.
       #
       # @example
       #   view 'my_interface' do
@@ -90,13 +93,13 @@ module Vedeu
       #
       # @todo More documentation required.
       #
-      # @param name [String] The name of interface for which this template's
-      #   content belongs to.
-      # @param filename [String] The filename (including path) to the template
-      #   to be used. Yoy can use `File.dirname(__FILE__)` to use relative
-      #   paths.
-      # @param object [Object] The object for which the values of template's
-      #   variables can be obtained.
+      # @param name [String] The name of interface for which this
+      #   template's content belongs to.
+      # @param filename [String] The filename (including path) to the
+      #   template to be used. Yoy can use `File.dirname(__FILE__)` to
+      #   use relative paths.
+      # @param object [Object] The object for which the values of
+      #   template's variables can be obtained.
       # @param options [Hash] See {Vedeu::Output::Wordwrap}
       # @raise [Vedeu::Error::MissingRequired]
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
@@ -128,8 +131,8 @@ module Vedeu
         new_attributes(name).merge!(value: lines)
       end
 
-      # Return the current attributes combined with the existing interface
-      # attributes defined by the interface.
+      # Return the current attributes combined with the existing
+      # interface attributes defined by the interface.
       #
       # @param name [String] The name of the interface.
       # @return [Hash]

data/lib/vedeu/dsl/dsl.rb

@@ -7,11 +7,13 @@ module Vedeu
     protected
 
     # @!attribute [r] client
-    # @return [Object] The object instance where the DSL is being used.
+    # @return [Object] The object instance where the DSL is being
+    #   used.
     attr_reader :client
 
     # @!attribute [r] model
-    # @return [void] The new model object which the DSL is constructing.
+    # @return [void] The new model object which the DSL is
+    #   constructing.
     attr_reader :model
 
     private
@@ -33,7 +35,8 @@ module Vedeu
     # Attempts to find the missing method on the client object.
     #
     # @param method [Symbol] The name of the method sought.
-    # @param args [Array] The arguments which the method was to be invoked with.
+    # @param args [Array] The arguments which the method was to be
+    #   invoked with.
     # @param block [Proc] The optional block provided to the method.
     # @return [void]
     def method_missing(method, *args, &block)

data/lib/vedeu/dsl/group.rb

@@ -2,25 +2,27 @@ module Vedeu
 
   module DSL
 
-    # Interfaces can be configured to be part of a named group. Once an
-    # interface is a member of group, the group can be affected by other
-    # controls. For example, assuming the client application is a simple Git
-    # client, it may have a group called 'commit'. The 'commit' group will
-    # contain the interfaces 'diff' (to show the changes), 'staged' (to show
-    # which files are staged) and 'unstaged'. A refresh of the 'commit' group
-    # would cause all interfaces belonging to the group to refresh. Similarly,
-    # showing or hiding the group would of course, show or hide the interfaces
-    # of that group.
+    # Interfaces can be configured to be part of a named group. Once
+    # an interface is a member of group, the group can be affected by
+    # other controls. For example, assuming the client application is
+    # a simple Git client, it may have a group called 'commit'. The
+    # 'commit' group will contain the interfaces 'diff' (to show the
+    # changes), 'staged' (to show which files are staged) and
+    # 'unstaged'. A refresh of the 'commit' group would cause all
+    # interfaces belonging to the group to refresh. Similarly,
+    # showing or hiding the group would of course, show or hide the
+    # interfaces of that group.
     #
     class Group
 
       include Vedeu::DSL
 
-      # Specify a new group of interfaces with a simple DSL. Creating a group
-      # with the same name as an existing group overwrites the existing group.
+      # Specify a new group of interfaces with a simple DSL. Creating
+      # a group with the same name as an existing group overwrites the
+      # existing group.
       #
-      # The example below resembles 'vim' (the popular terminal-based text
-      # editor):
+      # The example below resembles 'vim' (the popular terminal-based
+      # text editor):
       #
       #   Vedeu.group 'title_screen' do
       #     add 'welcome_interface'
@@ -37,7 +39,9 @@ module Vedeu
       # or more succinctly:
       #
       #   Vedeu.group 'main_screen' do
-      #     members 'editor_interface', 'status_interface', 'command_interface'
+      #     members 'editor_interface',
+      #             'status_interface',
+      #             'command_interface'
       #     # ... some code
       #   end
       #
@@ -50,7 +54,8 @@ module Vedeu
       #
       # @param name [String] The name of this group.
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was
+      #   not given.
       # @return [Vedeu::Models::Group]
       def self.group(name, &block)
         fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
@@ -83,7 +88,9 @@ module Vedeu
       # Add the named interfaces to this group in bulk.
       #
       #   Vedeu.group 'main_screen' do
-      #     members ['editor_interface', 'some_interface', 'other_interface']
+      #     members ['editor_interface',
+      #              'some_interface',
+      #              'other_interface']
       #   end
       #
       # @param interface_names [Array<String>]

data/lib/vedeu/dsl/interface.rb

@@ -17,19 +17,22 @@ module Vedeu
 
         include Vedeu::Common
 
-        # Register an interface by name which will display output from a event
-        # or command. This provides the means for you to define your the views
-        # of your application without their content.
+        # Register an interface by name which will display output from
+        # an event or a command. This provides the means for you to
+        # define your the views of your application without their
+        # content.
         #
         #   Vedeu.interface 'my_interface' do
         #     # ... some code
         #   end
         #
-        # @param name [String] The name of the interface. Used to reference the
-        #   interface throughout your application's execution lifetime.
-        # @param block [Proc] A set of attributes which define the features of
-        #   the interface.
-        # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+        # @param name [String] The name of the interface. Used to
+        #   reference the interface throughout your application's
+        #   execution lifetime.
+        # @param block [Proc] A set of attributes which define the
+        #   features of the interface.
+        # @raise [Vedeu::Error::InvalidSyntax] The required block was
+        #   not given.
         # @return [Vedeu::Models::Interface]
         # @todo More documentation required.
         def interface(name, &block)
@@ -50,8 +53,8 @@ module Vedeu
         private
 
         # Registers a set of buffers for the interface unless already
-        # registered, and also adds interface's name to list of focussable
-        # interfaces.
+        # registered, and also adds interface's name to list of
+        # focussable interfaces.
         #
         # @see Vedeu::Buffers::Buffer
         # @return [Vedeu::Buffers::Buffer]
@@ -59,14 +62,16 @@ module Vedeu
           Vedeu::Buffers::Buffer.new(name: name).store
         end
 
-        # Registers a new cursor for the interface unless already registered.
+        # Registers a new cursor for the interface unless already
+        # registered.
         #
         # @return [Vedeu::Cursors::Cursor]
         def add_cursor!(name)
           Vedeu::Cursors::Cursor.new(name: name).store
         end
 
-        # Registers interface name in focus list unless already registered.
+        # Registers interface name in focus list unless already
+        # registered.
         #
         # @return [void]
         def add_focusable!(name)
@@ -95,14 +100,16 @@ module Vedeu
 
       # Set the cursor visibility on an interface.
       #
-      # @param value [Boolean] Any value other than nil or false will evaluate
+      # @param value [Boolean] Any value other than nil or false will
+      #   evaluate
       #   to true.
       #
       # @example
       #   Vedeu.interface 'my_interface' do
       #     cursor  true  # => show the cursor for this interface
       #     # or...
-      #     cursor  :show # => both of these are equivalent to line above
+      #     cursor  :show # => both of these are equivalent to line
+      #                   #    above
       #     # or...
       #     cursor!       #
       #     # ...
@@ -116,8 +123,9 @@ module Vedeu
       #   end
       #
       #   Vedeu.view 'my_interface' do
-      #     cursor true # => Specify the visibility of the cursor when the view
-      #     # ...       #    is rendered.
+      #     cursor true # => Specify the visibility of the cursor when
+      #                 #    the view is rendered.
+      #     # ...
       #   end
       #
       # @return [Vedeu::Cursors::Cursor]
@@ -134,15 +142,16 @@ module Vedeu
         cursor(true)
       end
 
-      # To maintain performance interfaces can be delayed from refreshing too
-      # often, the reduces artefacts particularly when resizing the terminal
-      # screen.
+      # To maintain performance interfaces can be delayed from
+      # refreshing too often, the reduces artefacts particularly when
+      # resizing the terminal screen.
       #
       # @param value [Fixnum|Float] Time in seconds. (0.5 = 500ms).
       #
       # @example
       #   Vedeu.interface 'my_interface' do
-      #     delay 0.5 # interface will not update more often than every 500ms.
+      #     delay 0.5 # interface will not update more often than
+      #               # every 500ms.
       #     # ...
       #   end
       #
@@ -151,11 +160,12 @@ module Vedeu
         model.delay = value
       end
 
-      # Specify this interface as being in focus when the application starts.
+      # Specify this interface as being in focus when the application
+      # starts.
       #
-      # @note If multiple interfaces are defined, and this is included in each,
-      #   then the last defined will be the interface in focus. However, this
-      #   behaviour can be overridden:
+      # @note If multiple interfaces are defined, and this is included
+      #   in each, then the last defined will be the interface in
+      #   focus. However, this behaviour can be overridden:
       #
       #   ```ruby
       #   Vedeu.focus_by_name 'some_interface'
@@ -169,9 +179,9 @@ module Vedeu
         Vedeu::Models::Focus.add(model.name, true) if present?(model.name)
       end
 
-      # Specify a group for an interface. Interfaces of the same group can be
-      # targetted together; for example you may want to refresh multiple
-      # interfaces at once.
+      # Specify a group for an interface. Interfaces of the same group
+      # can be targetted together; for example you may want to refresh
+      # multiple interfaces at once.
       #
       # @example
       #   Vedeu.interface 'my_interface' do
@@ -179,8 +189,8 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @param name [String] The name of the group to which this interface
-      #   should belong.
+      # @param name [String] The name of the group to which this
+      #   interface should belong.
       # @return [Vedeu::Models::Group]
       def group(name)
         return false unless present?(name)
@@ -196,8 +206,8 @@ module Vedeu
       end
       alias_method :keys, :keymap
 
-      # The name of the interface. Used to reference the interface throughout
-      # your application's execution lifetime.
+      # The name of the interface. Used to reference the interface
+      # throughout your application's execution lifetime.
       #
       # @param value [String]
       #
@@ -247,8 +257,8 @@ module Vedeu
 
       # Use a value from another model.
       #
-      # @param name [String] The name of the interface model you wish to use a
-      #   value from.
+      # @param name [String] The name of the interface model you wish
+      #   to use a value from.
       # @return [Vedeu::Models::Interface]
       def use(name)
         model.repository.by_name(name)
@@ -256,8 +266,8 @@ module Vedeu
 
       # Set the visibility of the interface.
       #
-      # @param value [Boolean] Any value other than nil or false will evaluate
-      #   to true.
+      # @param value [Boolean] Any value other than nil or false will
+      #   evaluate to true.
       #
       # @example
       #   Vedeu.interface 'my_interface' do
@@ -286,9 +296,9 @@ module Vedeu
         model.visible = boolean
       end
 
-      # Set the zindex of the interface. This controls the render order of
-      # interfaces. Interfaces with a lower zindex will render before those
-      # with a higher zindex.
+      # Set the zindex of the interface. This controls the render
+      # order of interfaces. Interfaces with a lower zindex will
+      # render before those with a higher zindex.
       #
       # @example
       #   --4-- # rendered last

data/lib/vedeu/dsl/keymap.rb

@@ -69,25 +69,24 @@ module Vedeu
 
       # Define keypress(es) to perform an action.
       #
-      # @param value_or_values [Array<String>|Array<Symbol>|String|Symbol]
+      # @param values [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.
       # @raise [Vedeu::Error::InvalidSyntax]
-      #   When the required block is not given, the value_or_values parameter is
+      #   When the required block is not given, the values parameter is
       #   undefined, or when processing the collection, a member is undefined.
       # @return [Array] A collection containing the keypress(es).
-      def key(*value_or_values, &block)
+      def key(*values, &block)
         fail Vedeu::Error::InvalidSyntax,
              'No action defined for `key`.' unless block_given?
 
-        unless present?(value_or_values)
-          fail Vedeu::Error::InvalidSyntax, 'No keypress(es) defined for `key`.'
-        end
+        fail Vedeu::Error::InvalidSyntax,
+             'No keypress(es) defined for `key`.' unless present?(values)
 
-        value_or_values.each do |value|
+        values.each do |value|
           unless present?(value)
             fail Vedeu::Error::InvalidSyntax,
                  'An invalid value for `key` was encountered.'

data/lib/vedeu/dsl/line.rb

@@ -59,7 +59,8 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [Vedeu::Error::InvalidSyntax] When no block or value is provided.
+      # @raise [Vedeu::Error::InvalidSyntax] When no block or value is
+      #   provided.
       # @return [Vedeu::Views::Lines]
       def line(value = '', &block)
         if block_given?
@@ -81,7 +82,8 @@ module Vedeu
       alias_method :line=, :line
 
       # Define multiple streams (a stream is a subset of a line).
-      # Uses {Vedeu::DSL::Stream} for all directives within the required block.
+      # Uses {Vedeu::DSL::Stream} for all directives within the
+      # required block.
       #
       #   Vedeu.renders do
       #     view 'my_interface' do
@@ -98,7 +100,8 @@ module Vedeu
       #   end
       #
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was
+      #   not given.
       # @return [Vedeu::Views::Streams<Vedeu::Views::Stream>]
       # @see Vedeu::DSL::Stream for subdirectives.
       def streams(&block)

data/lib/vedeu/dsl/stream.rb

@@ -21,7 +21,8 @@ module Vedeu
       end
 
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was
+      #   not given.
       # @return [void]
       def stream(&block)
         fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?

data/lib/vedeu/editor/cursor.rb

@@ -53,9 +53,7 @@ module Vedeu
       # @option attributes ox [Fixnum]
       # @return [Vedeu::Editor::Cursor]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end

data/lib/vedeu/editor/document.rb

@@ -6,7 +6,7 @@ module Vedeu
     #
     class Document
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       extend Forwardable
 
       def_delegators :border,
@@ -41,12 +41,11 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes data [String]
       # @option attributes name [String]
-      # @option attributes repository [Vedeu::Repository]
+      # @option attributes repository
+      #   [Vedeu::Repositories::Repository]
       # @return [Vedeu::Editor::Document]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value || defaults.fetch(key))
         end
       end

data/lib/vedeu/editor/documents.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of documents.
     #
-    class Documents < Vedeu::Repository
+    class Documents < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :documents, :repository)
 

data/lib/vedeu/editor/line.rb

@@ -110,9 +110,8 @@ module Vedeu
       def insert_character(character, index = nil)
         return self unless character
 
-        insert = Vedeu::Editor::Insert.into(line, character, index, size)
-
-        Vedeu::Editor::Line.coerce(insert)
+        Vedeu::Editor::Line.coerce(Vedeu::Editor::Insert
+                                   .into(line, character, index, size))
       end
 
       # Return the size of the line in characters.

data/lib/vedeu/editor/lines.rb

@@ -137,9 +137,8 @@ module Vedeu
       def insert_line(line, index = nil)
         return self unless line
 
-        insert = Vedeu::Editor::Insert.into(lines, line, index, size)
-
-        Vedeu::Editor::Lines.coerce(insert)
+        Vedeu::Editor::Lines.coerce(Vedeu::Editor::Insert
+                                    .into(lines, line, index, size))
       end
 
       # Returns the line at the given index.

data/lib/vedeu/esc/all.rb

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # Provides escape sequence strings.
+  #
+  module EscapeSequences
+
+  end # EscapeSequences
+
+end # Vedeu
+
+require 'vedeu/esc/actions'
+require 'vedeu/esc/borders'
+require 'vedeu/esc/colours'
+require 'vedeu/esc/esc'

data/lib/vedeu/esc/colours.rb

@@ -28,13 +28,17 @@ module Vedeu
       # to produce the desired colours:
       #
       # @example
-      #   Esc.red                     # => "\e[31m"
+      #   # "\e[31m"
+      #   Vedeu::EscapeSequences::Esc.red
       #
-      #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
+      #   # "\e[31msome text\e[39m"
+      #   Vedeu::EscapeSequences::Esc.red { 'some text' }
       #
-      #   Esc.on_blue                 # => "\e[44m"
+      #   # "\e[44m"
+      #   Vedeu::EscapeSequences::Esc.on_blue
       #
-      #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
+      #   # "\e[44msome text\e[49m"
+      #   Vedeu::EscapeSequences::Esc.on_blue { 'some text' }
       #
       #   # Valid names:
       #   :black, :red, :green, :yellow, :blue, :magenta, :cyan,