vedeu 0.6.20 → 0.6.21

data/lib/vedeu/editor/editor.rb

@@ -25,16 +25,15 @@ module Vedeu
 
       # Send given input to the named document.
       #
-      # @param name [String]
-      # @param input [String|Symbol]
-      # @return [String|Symbol]
+      # @param (see #initialize)
+      # @return (see #keypress)
       def self.keypress(input:, name:)
         new(input: input, name: name).keypress
       end
 
       # Returns a new instance of Vedeu::Editor::Editor.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @param input [String|Symbol]
       # @return [Vedeu::Editor::Editor]
       def initialize(input:, name:)

data/lib/vedeu/editor/insert.rb

@@ -6,8 +6,8 @@ module Vedeu
     #
     class Insert
 
+      # @param (see #initialize)
       # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
-      # @see #initialize
       def self.into(collection, entity, index = nil, size = 0)
         new(collection, entity, index, size).insert
       end

data/lib/vedeu/editor/line.rb

@@ -14,7 +14,7 @@ module Vedeu
       # Coerce a line into a new instance of Vedeu::Editor::Line.
       #
       # @param line [String|Vedeu::Editor::Line]
-      # @return [Vedeu::Editor::Line]
+      # @return (see #initialize)
       def self.coerce(line)
         return line      if line.is_a?(self)
         return new(line) if line.is_a?(String)
@@ -116,13 +116,6 @@ module Vedeu
         line.size
       end
 
-      # Return the line as a collection of Vedeu::Views::Char objects.
-      #
-      # @return [Array<Vedeu::Views::Char>]
-      def to_chars
-        line.chars.map { |char| Vedeu::Views::Char.new(value: char) }
-      end
-
     end # Line
 
   end # Editor

data/lib/vedeu/editor/lines.rb

@@ -15,7 +15,7 @@ module Vedeu
       # Coerce a document into a new instance of Vedeu::Editor::Lines.
       #
       # @param document [Array<String>|Vedeu::Editor::Lines]
-      # @return [Vedeu::Editor::Lines]
+      # @return (see #initialize)
       def self.coerce(document)
         if document.is_a?(self)
           new(document.lines)

data/lib/vedeu/editor/repository.rb

@@ -15,4 +15,13 @@ module Vedeu
 
   end # Editor
 
+  # Manipulate the repository of documents.
+  #
+  # @example
+  #   Vedeu.documents
+  #
+  # @!method documents
+  # @return [Vedeu::Editor::Repository]
+  def_delegators Vedeu::Editor::Repository, :documents
+
 end # Vedeu

data/lib/vedeu/esc/esc.rb

@@ -11,6 +11,7 @@ module Vedeu
     #
     module Esc
 
+      include Vedeu::Common
       include Vedeu::EscapeSequences::Actions
       include Vedeu::EscapeSequences::Borders
       include Vedeu::EscapeSequences::Colours
@@ -25,7 +26,7 @@ module Vedeu
       # @param stream [String]
       # @return [String]
       def escape(stream = '')
-        return stream if stream.nil? || stream.empty?
+        return stream if absent?(stream)
 
         stream.gsub(/\e/, '\\e')
       end

data/lib/vedeu/events/aliases.rb

@@ -10,6 +10,7 @@ module Vedeu
     #
     module Aliases
 
+      include Vedeu::Common
       extend self
 
       # Add events by name to the alias name group. When an alias is
@@ -48,7 +49,7 @@ module Vedeu
       # @param alias_name [Symbol]
       # @return [Boolean]
       def registered?(alias_name)
-        return false if empty? || alias_name.nil? || alias_name.empty?
+        return false if empty? || absent?(alias_name)
 
         storage.include?(alias_name)
       end
@@ -106,4 +107,10 @@ module Vedeu
 
   end # Events
 
+  # @!method bind_alias
+  #   @see Vedeu::Events::Aliases#bind_alias
+  # @!method unbind_alias
+  #   @see Vedeu::Events::Aliases#unbind_alias
+  def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias
+
 end # Vedeu

data/lib/vedeu/events/event.rb

@@ -293,4 +293,12 @@ module Vedeu
 
   end # Events
 
+  # @!method bind
+  #   @see Vedeu::Events::Event.bind
+  # @!method bound?
+  #   @see Vedeu::Events::Event.bound?
+  # @!method unbind
+  #   @see Vedeu::Events::Event.unbind
+  def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind
+
 end # Vedeu

data/lib/vedeu/events/repository.rb

@@ -27,4 +27,13 @@ module Vedeu
 
   end # Events
 
+  # Manipulate the repository of events.
+  #
+  # @example
+  #   Vedeu.events
+  #
+  # @!method events
+  # @return [Vedeu::Events::Repository]
+  def_delegators Vedeu::Events::Repository, :events
+
 end # Vedeu

data/lib/vedeu/events/trigger.rb

@@ -14,10 +14,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
       #
-      # @param name [Symbol] The name of the event you wish to
-      #   trigger. The event does not have to exist.
-      # @param args [Array] Any arguments the event needs to execute
-      #   correctly.
+      # @param (see #initialize)
       # @return [Array]
       def self.trigger(name, *args)
         new(name, *args).trigger
@@ -25,7 +22,10 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Events::Trigger.
       #
-      # @param (see .trigger)
+      # @param name [Symbol] The name of the event you wish to
+      #   trigger. The event does not have to exist.
+      # @param args [Array] Any arguments the event needs to execute
+      #   correctly.
       # @return [Vedeu::Events::Trigger]
       def initialize(name, *args)
         @name = name
@@ -81,4 +81,8 @@ module Vedeu
 
   end # Events
 
+  # @!method trigger
+  #   @see Vedeu::Events::Trigger.trigger
+  def_delegators Vedeu::Events::Trigger, :trigger
+
 end # Vedeu

data/lib/vedeu/geometry/coordinate.rb

@@ -18,7 +18,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Geometry::Coordinate.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @param oy [Fixnum]
       # @param ox [Fixnum]
       # @return [Vedeu::Geometry::Coordinate]
@@ -31,7 +31,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       # @!attribute [rw] ox

data/lib/vedeu/geometry/dsl.rb

@@ -13,7 +13,7 @@ module Vedeu
     #
     # A standalone geometry definition:
     #
-    #   Vedeu.geometry 'some_interface' do
+    #   Vedeu.geometry :some_interface do
     #     height 5 # Sets the height of the view to 5
     #     width 20 # Sets the width of the view to 20
     #     x 3      # Start drawing 3 spaces from left
@@ -24,7 +24,7 @@ module Vedeu
     #
     # An interface including a geometry definition:
     #
-    #   Vedeu.interface 'some_interface' do
+    #   Vedeu.interface :some_interface do
     #     geometry do
     #       height 5
     #       width 20
@@ -43,14 +43,14 @@ module Vedeu
     # You can also make a geometry declaration dependent on another
     # view:
     #
-    #   Vedeu.interface 'other_panel' do
+    #   Vedeu.interface :other_panel do
     #     # ... some code here
     #   end
     #
-    #   Vedeu.interface 'main' do
+    #   Vedeu.interface :main do
     #     geometry do
     #       height 10
-    #       y { use('other_panel').south }
+    #       y { use(:other_panel).south }
     #     end
     #     # ... some code here
     #   end
@@ -79,12 +79,12 @@ module Vedeu
       # Specify the geometry of an interface or view with a simple
       # DSL.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     # ...
       #   end
       #
-      # @param name [String] The name of the interface or view to
-      #   which this geometry belongs.
+      # @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::Geometry::Geometry]
@@ -94,21 +94,11 @@ module Vedeu
         Vedeu::Geometry::Geometry.build(name: name, &block).store
       end
 
-      # Returns an instance of Vedeu::Geometry::DSL.
-      #
-      # @param model [Vedeu::Geometry::Geometry]
-      # @param client [Object]
-      # @return [Vedeu::Geometry::DSL]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Instructs Vedeu to calculate x and y geometry automatically
       # based on the centre character of the terminal, the width and
       # the height.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     centred false # or...
       #
       #     centred true  # or...
@@ -130,7 +120,7 @@ module Vedeu
       # Returns the width in characters for the number of columns
       # specified.
       #
-      #   Vedeu.geometry 'main_interface' do
+      #   Vedeu.geometry :main_interface do
       #     # ... some code
       #     width columns(9) # Vedeu.width # => 92 (for example)
       #                      # 92 / 12 = 7
@@ -149,7 +139,7 @@ module Vedeu
       # Specify the number of characters/rows/lines tall the interface
       # will be. This value will be ignored when `y` and `yn` are set.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     height 8
       #     # ... some code
       #   end
@@ -164,7 +154,7 @@ module Vedeu
       # Returns the height in characters for the number of rows
       # specified.
       #
-      #   Vedeu.geometry 'main_interface' do
+      #   Vedeu.geometry :main_interface do
       #     # ... some code
       #     height rows(3)  # Vedeu.height # => 38 (for example)
       #                     # 38 / 12 = 3
@@ -183,7 +173,7 @@ module Vedeu
       # Specify the number of characters/columns wide the interface
       # will be. This value will be ignored when `x` and `xn` are set.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     width 25
       #     # ... some code
       #   end
@@ -197,12 +187,12 @@ module Vedeu
 
       # Specify the starting x position (column) of the interface.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     x 7 # start on column 7.
       #
-      #     # start on column 8, if `other_interface` changes position
-      #     # then `some_interface` will too.
-      #     x { use('other_interface').east }
+      #     # start on column 8, if :other_interface changes position
+      #     # then :some_interface will too.
+      #     x { use(:other_interface).east }
       #     # ... some code
       #   end
       #
@@ -219,12 +209,12 @@ module Vedeu
       # Specify the ending x position (column) of the interface.
       # This value will override `width`.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     xn 37 # end at column 37.
       #
-      #     # when `other_interface` changes position,
-      #     # `some_interface` will too.
-      #     xn  { use('other_interface').right }
+      #     # when :other_interface changes position,
+      #     # :some_interface will too.
+      #     xn  { use(:other_interface).right }
       #     # ... some code
       #   end
       #
@@ -240,12 +230,12 @@ module Vedeu
 
       # Specify the starting y position (row/line) of the interface.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     y  4 # start at row 4
       #
-      #     # start on row/line 3, when `other_interface` changes
-      #     # position, `some_interface` will too.
-      #     y  { use('other_interface').north }
+      #     # start on row/line 3, when :other_interface changes
+      #     # position, :some_interface will too.
+      #     y  { use(:other_interface).north }
       #     # ... some code
       #   end
       #
@@ -262,12 +252,12 @@ module Vedeu
       # Specify the ending y position (row/line) of the interface.
       # This value will override `height`.
       #
-      #   Vedeu.geometry 'some_interface' do
+      #   Vedeu.geometry :some_interface do
       #     yn 24 # end at row 24.
       #
-      #     # if `other_interface` changes position, `some_interface`
+      #     # if :other_interface changes position, :some_interface
       #     # will too.
-      #     yn { use('other_interface').bottom }
+      #     yn { use(:other_interface).bottom }
       #     # ... some code
       #   end
       #
@@ -285,4 +275,8 @@ module Vedeu
 
   end # Geometry
 
+  # @!method geometry
+  #   @see Vedeu::Geometry::DSL.geometry
+  def_delegators Vedeu::Geometry::DSL, :geometry
+
 end # Vedeu

data/lib/vedeu/geometry/generic_coordinate.rb

@@ -9,7 +9,7 @@ module Vedeu
       # Return a new instance of Vedeu::Geometry::GenericCoordinate.
       #
       # @param attributes [Hash]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @option attributes type [Symbol]
       # @option attributes offset [Fixnum]
       # @return [Vedeu::Geometry::GenericCoordinate]

data/lib/vedeu/geometry/geometry.rb

@@ -72,8 +72,8 @@ module Vedeu
       # @return [Fixnum]
       attr_writer :yn
 
-      # @param attributes [Hash] See #initialize
-      # @return [Vedeu::Geometry::Geometry]
+      # @param (see #initialize)
+      # @return (see #initialize)
       def self.store(attributes)
         new(attributes).store
       end
@@ -84,7 +84,7 @@ module Vedeu
       # @option attributes centred [Boolean]
       # @option attributes maximised [Boolean]
       # @option attributes height [Fixnum]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @option attributes repository [Vedeu::Geometry::Repository]
       # @option attributes width [Fixnum]
       # @option attributes x [Fixnum]

data/lib/vedeu/geometry/null.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Provides a non-existent model to swallow messages.
     #
-    class Null
+    class Null < Vedeu::Null::Generic
 
       extend Forwardable
 
@@ -35,7 +35,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Geometry::Null.
       #
       # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|NilClass]
+      # @option attributes name [String|Symbol|NilClass]
       # @return [Vedeu::Geometry::Null]
       def initialize(attributes = {})
         @attributes = attributes
@@ -43,28 +43,6 @@ module Vedeu
         @maximised  = @attributes.fetch(:maximised, false)
       end
 
-      # @return [FalseClass]
-      def centred
-        false
-      end
-
-      # @return [FalseClass]
-      def maximised?
-        false
-      end
-      alias_method :maximise, :maximised?
-      alias_method :unmaximise, :maximised?
-
-      # @return [Boolean]
-      def null?
-        true
-      end
-
-      # @return [Vedeu::Geometry::Null]
-      def store
-        self
-      end
-
       private
 
       # @return [Vedeu::Geometry::Area]