vedeu 0.8.9 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83b3e4909563317ccf8df15a1f8e0106f27ca00a
-  data.tar.gz: fc3fce16bcc6f5648854b4897b493aaf6b04857e
+  metadata.gz: 2b0005acf22666df61aa974c5fa63a7a2efe5e8b
+  data.tar.gz: 1534526ad0f0118be2c7d56513bc879a8d3da466
 SHA512:
-  metadata.gz: 32aa195136e7b3cbbfa16018dba9c6da366df448e2a4a432c232485808bbad8d0c5dd4f9154d5313ccb9a1867373b607142dad8859a90474c738deca068d2f94
-  data.tar.gz: efdbc099065362fd76ecc407f50915ebad6285b0f36707153fe7a2266f8603be7620aaefb87abb34871730db610527bddfda04783258c51b9bf9051273727019
+  metadata.gz: 19ef391ed3888dde03e08ca67767adb96d46a623d1b7a472b53eb55dc3bf6835caaf790610a88275b16162c79bad110e0338a122dff7ebb2bdd648fd530c7af2
+  data.tar.gz: 7cae3f72bfc99f04dbd03dc9b6f4b20e620bb18d3850395da822b506856b6a61b2c98095fa33f338825d90c87d4203887212d66abcef100e321b7f008dad6e86

data/.codeclimate.yml

@@ -3,5 +3,6 @@ ratings:
     - lib/**
 exclude_paths:
   - "examples/*"
+  - "integrations/*"
   - "test/*"
   - "vendor/*"

data/docs/configuration/drb.md

@@ -0,0 +1,6 @@
+Sets boolean to run a DRb server.
+
+    Vedeu.configure do
+      drb!
+      # ...
+    end

data/docs/configuration/drb_host.md

@@ -0,0 +1,6 @@
+Sets the hostname or IP address of the DRb server.
+
+    Vedeu.configure do
+      drb_host 'localhost'
+      # ...
+    end

data/docs/configuration/drb_port.md

@@ -0,0 +1,6 @@
+Sets the port of the DRb server.
+
+    Vedeu.configure do
+      drb_port 12345
+      # ...
+    end

data/docs/configuration/interactive.md

@@ -0,0 +1,21 @@
+Sets boolean to allow user input. The default behaviour of Vedeu is to
+be interactive. This is the same as setting
+{Vedeu::Config::API#standalone} to false.
+
+    # same as `interactive true` or `standalone false`.
+    Vedeu.configure do
+      interactive!
+      # ...
+    end
+
+    # => Allow user input.
+    Vedeu.configure do
+      interactive true
+      # ...
+    end
+
+    # => Disallow user input.
+    Vedeu.configure do
+      interactive false
+      # ...
+    end

data/docs/configuration/run_once.md

@@ -0,0 +1,8 @@
+Sets boolean to run the Vedeu main application loop once. In effect,
+using `run_once!` or setting `run_once` to true will allow Vedeu to
+initialize, run any client application code, cleanup, then terminate.
+
+    Vedeu.configure do
+      run_once!
+      # ...
+    end

data/docs/configuration/standalone.md

@@ -0,0 +1,20 @@
+Sets boolean to prevent user intervention. This is the same as setting
+{Vedeu::Config::API#interactive} to false.
+
+    # Same as `standalone true` or `interactive false`.
+    Vedeu.configure do
+      standalone!
+      # ...
+    end
+
+    # => Disallow user input.
+    Vedeu.configure do
+      standalone true
+      # ...
+    end
+
+    # => Allow user input.
+    Vedeu.configure do
+      standalone false
+      # ...
+    end

data/docs/dsl.md

@@ -113,7 +113,7 @@ end
 
 ### Creating a new named geometry
 
-{include:Vedeu::DSL::Geometry::ClassMethods#geometry}
+{include:Vedeu::DSL::Geometry::SingletonMethods#geometry}
 
 ### Setting the interface dimensions
 

data/lib/vedeu.rb

@@ -46,14 +46,24 @@ end # Vedeu
 
 # Define some Yard macros used throughout the project.
 #
-# @!macro [new] included_module
-#   Provide additional behaviour to a class or module.
+# @!macro [new] defaults_method
+#   The default options/attributes for a new instance of this class.
+#
+#   @return [Hash<Symbol => void>]
 #
-#   When a ClassMethods submodule and/or an InstanceMethods submodule
-#   is defined within this module, then provide these methods as
-#   class or instance methods to the including class or module.
+# @!macro [new] module_included
+#   Provide additional behaviour to a class or module.
 #
 #   @param klass [Class]
 #   @return [void]
+#
+# @!macro [new] module_instance_methods
+#   Provide additional behaviour as instance methods to the including
+#   class or module.
+#
+# @!macro [new] module_singleton_methods
+#   Provide additional behaviour as singleton methods to the including
+#   class or module.
+#
 
 require 'vedeu/all'

data/lib/vedeu/application/controller.rb

@@ -6,9 +6,8 @@ module Vedeu
   #
   module Controller
 
-    # Provide additional behaviour as class methods.
-    #
-    module ClassMethods
+    # @macro module_singleton_methods
+    module SingletonMethods
 
       attr_writer :controller_name
 
@@ -73,11 +72,11 @@ module Vedeu
       alias action_name action
       alias actions action
 
-    end # ClassMethods
+    end # SingletonMethods
 
-    # @macro included_module
+    # @macro module_included
     def self.included(klass)
-      klass.extend(Vedeu::Controller::ClassMethods)
+      klass.extend(Vedeu::Controller::SingletonMethods)
     end
 
   end # Controller

data/lib/vedeu/borders/border.rb

@@ -304,11 +304,7 @@ module Vedeu
         }
       end
 
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => Boolean|Hash|NilClass|String|Symbol|
-      #   Vedeu::Borders::Repository|Vedeu::Presentation::Style>]
-      # @see Vedeu::EscapeSequences::Borders
+      # @macro defaults_method
       def defaults
         {
           bottom_horizontal: nil,

data/lib/vedeu/borders/title.rb

@@ -52,7 +52,7 @@ module Vedeu
       def render
         return horizontal if empty?
 
-        horizontal[start_index..(start_index + (size - 1))] = chars
+        horizontal[start_index..end_index] = chars
 
         horizontal
       end
@@ -121,6 +121,11 @@ module Vedeu
         value.empty?
       end
 
+      # @return [Fixnum]
+      def end_index
+        start_index + (size - 1)
+      end
+
       # @return [Vedeu::Geometries::Geometry]
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(name)

data/lib/vedeu/buffers/buffer.rb

@@ -174,9 +174,7 @@ module Vedeu
 
       private
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => NilClass, String>]
+      # @macro defaults_method
       def defaults
         {
           back:       nil,

data/lib/vedeu/buffers/empty.rb

@@ -41,9 +41,7 @@ module Vedeu
 
       private
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => Fixnum|NilClass|String|Symbol>]
+      # @macro defaults_method
       def defaults
         {
           height: Vedeu.height,

data/lib/vedeu/buffers/refresh.rb

@@ -71,7 +71,7 @@ module Vedeu
         defaults.merge!(@options)
       end
 
-      # @return [Hash<Symbol => Boolean>]
+      # @macro defaults_method
       def defaults
         {
           content_only: false,

data/lib/vedeu/buffers/view.rb

@@ -70,7 +70,7 @@ module Vedeu
                                                y:      by).buffer
       end
 
-      # @return [Hash<Symbol => NilClass|String|Symbol]
+      # @macro defaults_method
       def defaults
         {
           name: nil,

data/lib/vedeu/cells/border.rb

@@ -56,7 +56,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => Hash<void>>]
+      # @macro defaults_method
       def defaults
         super
       end

data/lib/vedeu/cells/borders/edges/bottom_horizontal.rb

@@ -18,7 +18,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(value: Vedeu.esc.horizontal)
       end

data/lib/vedeu/cells/borders/edges/left_vertical.rb

@@ -18,7 +18,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(value: Vedeu.esc.vertical)
       end

data/lib/vedeu/cells/borders/edges/right_vertical.rb

@@ -18,7 +18,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(value: Vedeu.esc.vertical)
       end

data/lib/vedeu/cells/borders/edges/top_horizontal.rb

@@ -18,7 +18,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(value: Vedeu.esc.horizontal)
       end

data/lib/vedeu/cells/borders/horizontal.rb

@@ -28,7 +28,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(value: Vedeu.esc.horizontal)
       end

data/lib/vedeu/cells/borders/vertical.rb

@@ -28,7 +28,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(value: Vedeu.esc.vertical)
       end

data/lib/vedeu/cells/borders/vertices/bottom_left.rb

@@ -23,7 +23,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.new(yn, x),
                      value:    Vedeu.esc.bottom_left)

data/lib/vedeu/cells/borders/vertices/bottom_right.rb

@@ -23,7 +23,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.new(yn, xn),
                      value:    Vedeu.esc.bottom_right)

data/lib/vedeu/cells/borders/vertices/top_left.rb

@@ -23,7 +23,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.new(y, x),
                      value:    Vedeu.esc.top_left)

data/lib/vedeu/cells/borders/vertices/top_right.rb

@@ -23,7 +23,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => String>]
+      # @macro defaults_method
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.new(y, xn),
                      value:    Vedeu.esc.top_right)

data/lib/vedeu/cells/cursor.rb

@@ -56,7 +56,7 @@ module Vedeu
 
       private
 
-      # @return [Hash]
+      # @macro defaults_method
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.new(1, 1))
       end

data/lib/vedeu/cells/empty.rb

@@ -96,7 +96,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => Hash<void>|NilClass|String>]
+      # @macro defaults_method
       def defaults
         {
           colour:   {},

data/lib/vedeu/coercers/coercer.rb

@@ -46,6 +46,14 @@ module Vedeu
         value.is_a?(klass)
       end
 
+      # @macro raise_fatal
+      # @return [void]
+      def incoercible!
+        fail Vedeu::Error::Fatal,
+             "Vedeu cannot coerce a '#{value.class.name}' into a " \
+             "'#{klass}'."
+      end
+
       # @macro raise_not_implemented
       # @return [Class]
       def klass

data/lib/vedeu/coercers/colour.rb

@@ -11,8 +11,6 @@ module Vedeu
     #
     class Colour < Vedeu::Coercers::Coercer
 
-      include Vedeu::Common
-
       # @macro raise_fatal
       # @return [void]
       def coerce
@@ -29,17 +27,21 @@ module Vedeu
           klass.new(foreground: value)
 
         elsif hash?(value)
-          attributes = Vedeu::Coercers::ColourAttributes.coerce(value)
           klass.new(attributes)
 
         else
-          fail Vedeu::Error::Fatal, 'Vedeu cannot coerce this colour.'
+          incoercible!
 
         end
       end
 
       private
 
+      # @return [Hash]
+      def attributes
+        Vedeu::Coercers::ColourAttributes.coerce(value)
+      end
+
       # @return [Boolean]
       def background?
         value.is_a?(Vedeu::Colours::Background)

data/lib/vedeu/coercers/editor_line.rb

@@ -16,8 +16,11 @@ module Vedeu
         if coerced?
           value
 
-        else
+        elsif string?(value)
+          klass.new(value)
 
+        else
+          klass.new
 
         end
       end

data/lib/vedeu/coercers/editor_lines.rb

@@ -11,13 +11,28 @@ module Vedeu
     #
     class EditorLines < Vedeu::Coercers::Coercer
 
-      # @return [void]
+      # @macro raise_fatal
+      # @return [Vedeu::Editor::Lines]
       def coerce
         if coerced?
-          value
+          klass.new(value.lines)
 
-        else
+        elsif value.is_a?(Array)
+          collection = value.map do |line|
+            Vedeu::Editor::Line.coerce(line)
+          end
+
+          klass.new(collection)
+
+        elsif string?(value)
+          collection = value.lines.map(&:chomp).map do |line|
+            Vedeu::Editor::Line.coerce(line)
+          end
 
+          klass.new(collection)
+
+        else
+          klass.new
 
         end
       end