vedeu 0.8.9 → 0.8.10

data/lib/vedeu/coercers/lines.rb

@@ -11,13 +11,14 @@ module Vedeu
     #
     class Lines < Vedeu::Coercers::Coercer
 
+      # @macro raise_fatal
       # @return [void]
       def coerce
         if coerced?
           value
 
         else
-
+          incoercible!
 
         end
       end

data/lib/vedeu/coercers/page.rb

@@ -11,9 +11,7 @@ module Vedeu
     #
     class Page < Vedeu::Coercers::Coercer
 
-      # @param value
-      #   [Vedeu::Models::Page|Vedeu::Models::Row|Array<void>|void]
-      # @macro raise_invalid_syntax
+      # @macro raise_fatal
       # @return [Vedeu::Models::Page]
       def coerce
         if coerced?
@@ -31,9 +29,7 @@ module Vedeu
           klass.new(values)
 
         else
-          fail Vedeu::Error::InvalidSyntax,
-               "Cannot coerce as value is not an Array, #{klass} " \
-               "or Vedeu::Models::Row. Is a '#{value.class.name}'."
+          incoercible!
 
         end
       end

data/lib/vedeu/coercers/position.rb

@@ -27,9 +27,7 @@ module Vedeu
           klass.new(value, 1)
 
         else
-          fail Vedeu::Error::Fatal,
-               "Vedeu cannot coerce a '#{value.class.name}' into a " \
-               "'#{klass}'."
+          incoercible!
 
         end
       end

data/lib/vedeu/coercers/row.rb

@@ -11,7 +11,6 @@ module Vedeu
     #
     class Row < Vedeu::Coercers::Coercer
 
-      # @param value [Vedeu::Models::Row|Array<void>|void]
       # @return [Vedeu::Models::Row]
       def coerce
         if coerced?

data/lib/vedeu/colours/colour.rb

@@ -134,8 +134,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => Vedeu::Colours::Background|
-      #   Vedeu::Colours:Foreground]
+      # @macro defaults_method
       def defaults
         {
           background: Vedeu::Colours::Background.new,

data/lib/vedeu/configuration/api.rb

@@ -39,25 +39,7 @@ module Vedeu
           .log(Vedeu.esc.green { '[api]' }, options)
       end
 
-      # Sets boolean to allow user input. The default behaviour of
-      # Vedeu is to be interactive.
-      #
-      #   Vedeu.configure do
-      #     interactive! # => same as `interactive true` or
-      #                  #    `standalone false`
-      #     # ...
-      #   end
-      #
-      #   Vedeu.configure do
-      #     interactive true # => Allow user input.
-      #     # ...
-      #   end
-      #
-      #   Vedeu.configure do
-      #     interactive false # => Disallow user input.
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/interactive.md}
       # @param value [Boolean]
       # @return [Boolean]
       def interactive!(value = true)
@@ -65,25 +47,7 @@ module Vedeu
       end
       alias interactive interactive!
 
-      # Sets boolean to prevent user intervention. This is the same as
-      # setting {include:Vedeu::Config::API#interactive!} to false.
-      #
-      #   Vedeu.configure do
-      #     standalone! # => same as `standalone true` or
-      #                 #    `interactive false`
-      #     # ...
-      #   end
-      #
-      #   Vedeu.configure do
-      #     standalone true # => Disallow user input.
-      #     # ...
-      #   end
-      #
-      #   Vedeu.configure do
-      #     standalone false # => Allow user input.
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/standalone.md}
       # @param value [Boolean]
       # @return [Boolean]
       def standalone!(value = true)
@@ -91,16 +55,7 @@ module Vedeu
       end
       alias standalone standalone!
 
-      # 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
-      #
+      # {include:file:docs/configuration/run_once.md}
       # @param value [Boolean]
       # @return [Boolean]
       def run_once!(value = true)
@@ -108,13 +63,7 @@ module Vedeu
       end
       alias run_once run_once!
 
-      # Sets boolean to run a DRb server.
-      #
-      #   Vedeu.configure do
-      #     drb!
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/drb.md}
       # @param value [Boolean]
       # @return [Boolean]
       def drb!(value = true)
@@ -122,26 +71,14 @@ module Vedeu
       end
       alias drb drb!
 
-      # Sets the hostname or IP address of the DRb server.
-      #
-      #   Vedeu.configure do
-      #     drb_host 'localhost'
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/drb_host.md}
       # @param hostname [String]
       # @return [String]
       def drb_host(hostname = '')
         options[:drb_host] = hostname
       end
 
-      # Sets the port of the DRb server.
-      #
-      #   Vedeu.configure do
-      #     drb_port 12345
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/drb_port.md}
       # @param port [Fixnum|String]
       # @return [String]
       def drb_port(port = '')

data/lib/vedeu/configuration/configuration.rb

@@ -350,10 +350,7 @@ module Vedeu
 
     private
 
-    # The Vedeu default options, which of course are influenced by
-    # environment variables also.
-    #
-    # @return [Hash<Symbol => void>]
+    # @macro defaults_method
     def defaults
       {
         background:    :default,

data/lib/vedeu/cursors/coordinate.rb

@@ -117,9 +117,7 @@ module Vedeu
         (d...dn_position).to_a
       end
 
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => Fixnum|String|Symbol>]
+      # @macro defaults_method
       def defaults
         {
           geometry: nil,

data/lib/vedeu/cursors/cursor.rb

@@ -229,10 +229,7 @@ module Vedeu
                                        type:     type)
       end
 
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => Boolean|Fixnum|String|
-      #   Vedeu::Cursors::Repository>]
+      # @macro defaults_method
       def defaults
         {
           name:       '',
@@ -270,11 +267,11 @@ module Vedeu
   end # Cursors
 
   # @!method hide_cursor
-  #   @see Vedeu::Toggleable::ClassMethods.hide
+  #   @see Vedeu::Toggleable::SingletonMethods.hide
   # @!method show_cursor
-  #   @see Vedeu::Toggleable::ClassMethods#show
+  #   @see Vedeu::Toggleable::SingletonMethods#show
   # @!method toggle_cursor
-  #   @see Vedeu::Toggleable::ClassMethods#toggle
+  #   @see Vedeu::Toggleable::SingletonMethods#toggle
   def_delegators Vedeu::Cursors::Cursor,
                  :hide_cursor,
                  :show_cursor,

data/lib/vedeu/cursors/reposition.rb

@@ -81,7 +81,7 @@ module Vedeu
         Vedeu.cursors.by_name(name)
       end
 
-      # @return [Hash<Symbol => Fixnum|Symbol|String]
+      # @macro defaults_method
       def defaults
         {
           mode: :relative,

data/lib/vedeu/distributed/test_application.rb

@@ -93,9 +93,7 @@ module Vedeu
       File.dirname(__FILE__) + '/templates/default_application.vedeu'
     end
 
-    # @todo Don't like all this file reading.
-    #
-    # @return [Hash<Symbol => String>]
+    # @macro defaults_method
     def defaults
       {
         borders:       read('default_borders.vedeu'),

data/lib/vedeu/dsl/border.rb

@@ -10,8 +10,7 @@ module Vedeu
     #
     module Border
 
-      # Provide additional behaviour as instance methods.
-      #
+      # @macro module_instance_methods
       module InstanceMethods
 
         # Specify the border of an interface or view with a simple
@@ -36,7 +35,7 @@ module Vedeu
         # @param name [String|Symbol] The name of the interface; this
         #   is already provided when we define the interface or view,
         #   setting it here is just mirroring functionality of
-        #   {Vedeu::DSL::Border::ClassMethods.border}.
+        #   {Vedeu::DSL::Border::SingletonMethods.border}.
         # @param block [Proc]
         # @macro raise_requires_block
         # @macro raise_missing_required
@@ -78,7 +77,7 @@ module Vedeu
 
       end # InstanceMethods
 
-      # @macro included_module
+      # @macro module_included
       def self.included(klass)
         klass.include(Vedeu::DSL::Border::InstanceMethods)
       end

data/lib/vedeu/dsl/geometry.rb

@@ -10,9 +10,8 @@ module Vedeu
     #
     module Geometry
 
-      # Provide additional behaviour as class methods.
-      #
-      module ClassMethods
+      # @macro module_singleton_methods
+      module SingletonMethods
 
         # {include:file:docs/dsl/by_method/geometry.md}
         # @param name [String|Symbol] The name of the interface or
@@ -40,7 +39,7 @@ module Vedeu
           Vedeu::Geometries::Geometry.build(name: name, &block).store
         end
 
-      end # ClassMethods
+      end # SingletonMethods
 
       # Provide additional behaviour as instance methods.
       #
@@ -50,7 +49,7 @@ module Vedeu
         # @param name [String|Symbol] The name of the interface; this
         #   is already provided when we define the interface or view,
         #   setting it here is just mirroring functionality of
-        #   {Vedeu::DSL::Geometry::ClassMethods#geometry}.
+        #   {Vedeu::DSL::Geometry::SingletonMethods#geometry}.
         # @param block [Proc]
         # @macro raise_requires_block
         # @macro raise_missing_required
@@ -66,9 +65,9 @@ module Vedeu
 
       end # InstanceMethods
 
-      # @macro included_module
+      # @macro module_included
       def self.included(klass)
-        klass.extend(Vedeu::DSL::Geometry::ClassMethods)
+        klass.extend(Vedeu::DSL::Geometry::SingletonMethods)
         klass.include(Vedeu::DSL::Geometry::InstanceMethods)
       end
 

data/lib/vedeu/dsl/helpers/align.rb

@@ -76,7 +76,7 @@ module Vedeu
       end
       alias center centre
 
-      # @return [Hash]
+      # @macro defaults_method
       def defaults
         {
           align: :left,

data/lib/vedeu/dsl/helpers/attributes.rb

@@ -113,7 +113,7 @@ module Vedeu
         Vedeu::Colours::Colour.coerce(new_colour_options)
       end
 
-      # @return [Hash]
+      # @macro defaults_method
       def defaults
         {
           align:      :none,
@@ -124,7 +124,7 @@ module Vedeu
           style:      nil,
           truncate:   false,
           width:      nil,
-          wordwrap:   false,
+          wordwrap:   true,
         }
       end
 

data/lib/vedeu/dsl/helpers/truncate.rb

@@ -50,8 +50,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|
-      #   Symbol]
+      # @macro defaults_method
       def defaults
         {
           name:     nil,

data/lib/vedeu/dsl/helpers/wordwrap.rb

@@ -193,9 +193,7 @@ module Vedeu
              'or there is no geometry registered with that name.'
       end
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => NilClass, String, Symbol>]
+      # @macro defaults_method
       def defaults
         {
           ellipsis: '...',

data/lib/vedeu/dsl/presentation.rb

@@ -94,6 +94,13 @@ module Vedeu
       end
       alias colour= colour
 
+      # Instruct the view to not use wordwrapping. (Default)
+      #
+      # @return [Boolean]
+      def no_wordwrap!
+        wordwrap(false)
+      end
+
       # Define a style or styles for an interface, line or a stream.
       #
       # @param value [Array<Symbol>|Array<String>|Symbol|String]
@@ -122,6 +129,17 @@ module Vedeu
       alias styles style
       alias styles= style
 
+      # Specify whether the view should use wordwrapping (default).
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      def wordwrap(value = true)
+        boolean = value ? true : false
+
+        model.wordwrap = boolean
+      end
+      alias wordwrap! wordwrap
+
       private
 
       # @return [Hash<Symbol => String>]

data/lib/vedeu/editor/cursor.rb

@@ -172,9 +172,7 @@ module Vedeu
         @geometry ||= Vedeu.geometries.by_name(name)
       end
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => Fixnum|NilClass|String|Symbol>]
+      # @macro defaults_method
       def defaults
         {
           name: '',

data/lib/vedeu/editor/document.rb

@@ -216,9 +216,7 @@ module Vedeu
         @cursor ||= Vedeu::Editor::Cursor.new(name: name)
       end
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => void|Symbol]
+      # @macro defaults_method
       def defaults
         {
           data:       Vedeu::Editor::Lines.new([Vedeu::Editor::Line.new]),

data/lib/vedeu/editor/line.rb

@@ -20,18 +20,10 @@ module Vedeu
 
       class << self
 
-        include Vedeu::Common
-
-        # Coerce a line into a new instance of Vedeu::Editor::Line.
-        #
-        # @param collection [String|Vedeu::Editor::Line]
-        # @return (see #initialize)
-        def coerce(collection)
-          return collection      if collection.is_a?(self)
-          return new(collection) if string?(collection)
-
-          new
-        end
+        extend Forwardable
+
+        def_delegators Vedeu::Coercers::EditorLine,
+                       :coerce
 
       end # Eigenclass