vedeu 0.8.9 → 0.8.10

data/lib/vedeu/editor/lines.rb

@@ -20,36 +20,10 @@ module Vedeu
 
       class << self
 
-        include Vedeu::Common
+        extend Forwardable
 
-        # Coerce a document into a new instance of
-        # Vedeu::Editor::Lines.
-        #
-        # @param document [Array<String>|Vedeu::Editor::Lines]
-        # @return (see #initialize)
-        def coerce(document)
-          if document.is_a?(self)
-            new(document.lines)
-
-          elsif document.is_a?(Array)
-            collection = document.map do |line|
-              Vedeu::Editor::Line.coerce(line)
-            end
-
-            new(collection)
-
-          elsif string?(document)
-            collection = document.lines.map(&:chomp).map do |line|
-              Vedeu::Editor::Line.coerce(line)
-            end
-
-            new(collection)
-
-          else
-            new
-
-          end
-        end
+        def_delegators Vedeu::Coercers::EditorLines,
+                       :coerce
 
       end # Eigenclass
 

data/lib/vedeu/events/event.rb

@@ -280,9 +280,7 @@ module Vedeu
         defaults.merge!(@options)
       end
 
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
+      # @macro defaults_method
       def defaults
         {
           delay:      0.0,

data/lib/vedeu/geometries/area/dimension.rb

@@ -226,9 +226,7 @@ module Vedeu
         end
       end
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => Boolean,Fixnum,NilClass,Symbol>]
+      # @macro defaults_method
       def defaults
         {
           alignment: :none,

data/lib/vedeu/geometries/area/x_dimension.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       private
 
-      # @see Vedeu::Geometries::Dimension#defaults
+      # @macro defaults_method
       def defaults
         super.merge!(default: Vedeu.width)
       end

data/lib/vedeu/geometries/area/y_dimension.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       private
 
-      # @see Vedeu::Geometries::Dimension#defaults
+      # @macro defaults_method
       def defaults
         super.merge!(default: Vedeu.height)
       end

data/lib/vedeu/geometries/geometry.rb

@@ -196,10 +196,7 @@ module Vedeu
         }
       end
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|Symbol|
-      #   Vedeu::Geometries::Repository]
+      # @macro defaults_method
       def defaults
         {
           client:               nil,

data/lib/vedeu/geometries/move.rb

@@ -62,7 +62,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => Fixnum|String|Symbol>]
+      # @macro defaults_method
       def defaults
         {
           direction: :none,

data/lib/vedeu/groups/group.rb

@@ -158,10 +158,7 @@ module Vedeu
 
       private
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => Boolean|Set|String|
-      #   Vedeu::Groups::Repository]
+      # @macro defaults_method
       def defaults
         {
           members:    Set.new,
@@ -183,11 +180,11 @@ module Vedeu
   end # Groups
 
   # @!method hide_group
-  #   @see Vedeu::Toggleable::ClassMethods#hide
+  #   @see Vedeu::Toggleable::SingletonMethods#hide
   # @!method show_group
-  #   @see Vedeu::Toggleable::ClassMethods#show
+  #   @see Vedeu::Toggleable::SingletonMethods#show
   # @!method toggle_group
-  #   @see Vedeu::Toggleable::ClassMethods#toggle
+  #   @see Vedeu::Toggleable::SingletonMethods#toggle
   def_delegators Vedeu::Groups::Group,
                  :hide_group,
                  :show_group,

data/lib/vedeu/input/keymap.rb

@@ -85,9 +85,7 @@ module Vedeu
 
       private
 
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash<Symbol => Array|String|Vedeu::Input::Repository]
+      # @macro defaults_method
       def defaults
         {
           name:       '',

data/lib/vedeu/input/keys.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # A collection of {Vedeu::Input::Key} instances.
     #
+    # @api private
+    #
     class Keys < Vedeu::Repositories::Collection
 
     end # Keys

data/lib/vedeu/input/mapper.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Maps keys to keymaps.
     #
+    # @api private
+    #
     class Mapper
 
       class << self

data/lib/vedeu/input/mouse.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Rudimentary support for mouse interactions.
     #
+    # @api private
+    #
     class Mouse
 
       # Trigger an event depending on which button was pressed.

data/lib/vedeu/input/read.rb

@@ -48,12 +48,6 @@ module Vedeu
         input
       end
 
-      protected
-
-      # @!attribute [r] input
-      # @return [NilClass|String]
-      attr_reader :input
-
       private
 
       # @return [IO]
@@ -66,7 +60,7 @@ module Vedeu
         mode == :cooked
       end
 
-      # @return [Hash<Symbol => Symbol>]
+      # @macro defaults_method
       def defaults
         {
           mode: :cooked,

data/lib/vedeu/interfaces/clear.rb

@@ -98,7 +98,7 @@ module Vedeu
         options[:content_only]
       end
 
-      # @return [Hash<Symbol => Boolean>]
+      # @macro defaults_method
       def defaults
         {
           content_only: false,

data/lib/vedeu/interfaces/interface.rb

@@ -43,6 +43,10 @@ module Vedeu
       # @return [Vedeu::Views::Composition]
       attr_accessor :parent
 
+      # @!attribute [rw] wordwrap
+      # @return [Boolean]
+      attr_accessor :wordwrap
+
       # @!attribute [rw] zindex
       # @return [Fixnum]
       attr_accessor :zindex
@@ -60,6 +64,7 @@ module Vedeu
       # @option attributes repository [Vedeu::Interfaces::Repository]
       # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes visible [Boolean]
+      # @option attributes wordwrap [Boolean]
       # @option attributes zindex [Fixnum]
       # @return [Vedeu::Interfaces::Interface]
       def initialize(attributes = {})
@@ -82,6 +87,7 @@ module Vedeu
           repository:     repository,
           style:          style,
           visible:        visible,
+          wordwrap:       wordwrap,
           zindex:         zindex,
         }
       end
@@ -140,9 +146,7 @@ module Vedeu
 
       private
 
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
+      # @macro defaults_method
       def defaults
         {
           client:         nil,
@@ -156,6 +160,7 @@ module Vedeu
           repository:     Vedeu.interfaces,
           style:          :normal,
           visible:        true,
+          wordwrap:       true,
           zindex:         0,
         }
       end
@@ -165,11 +170,11 @@ module Vedeu
   end # Interfaces
 
   # @!method hide_interface
-  #   @see Vedeu::Toggleable::ClassMethods#hide
+  #   @see Vedeu::Toggleable::SingletonMethods#hide
   # @!method show_interface
-  #   @see Vedeu::Toggleable::ClassMethods#show
+  #   @see Vedeu::Toggleable::SingletonMethods#show
   # @!method toggle_interface
-  #   @see Vedeu::Toggleable::ClassMethods#toggle
+  #   @see Vedeu::Toggleable::SingletonMethods#toggle
   def_delegators Vedeu::Interfaces::Interface,
                  :hide_interface,
                  :show_interface,

data/lib/vedeu/logging/lockless_log_device.rb

@@ -16,10 +16,10 @@ module Vedeu
       # @param log [void]
       # @return [Vedeu::Logging::LocklessLogDevice]
       def initialize(log = nil)
-        @dev      = nil
         @filename = nil
+        @log      = log
 
-        if log.respond_to?(:write) && log.respond_to?(:close)
+        if writable? && closeable?
           @dev = log
 
         else
@@ -46,8 +46,19 @@ module Vedeu
         nil
       end
 
+      protected
+
+      # @!attribute [r] log
+      # @return [String]
+      attr_reader :log
+
       private
 
+      # @return [Boolean]
+      def closable?
+        log.respond_to?(:close)
+      end
+
       # @param log [String]
       # @return [void]
       def open_logfile(log)
@@ -62,6 +73,11 @@ module Vedeu
         end
       end
 
+      # @return [Boolean]
+      def writable?
+        log.respond_to?(:write)
+      end
+
     end # LocklessLogDevice
 
   end # Logging

data/lib/vedeu/logging/timer.rb

@@ -33,24 +33,30 @@ module Vedeu
       end
 
       # Write an entry to the log file stating how long a section of
-      # code took in milliseconds. Useful for debugging performance.
+      # code took in milliseconds when debugging is enabled and a
+      # block was Useful for debugging performance.
       #
       # @param block [Proc]
       # @macro raise_requires_block
-      # @return [void] The return value of the executed block.
+      # @return [void|NilClass] The return value of the executed
+      #   block if given, or nil if debugging is disabled.
       def measure(&block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
+        if block_given?
+          if Vedeu.config.debug?
+            work = yield
 
-        if Vedeu.config.debug?
-          work = yield
+            Vedeu.log(type:    :timer,
+                      message: "#{message} took #{elapsed}ms.")
 
-          Vedeu.log(type:    :timer,
-                    message: "#{message} took #{elapsed}ms.")
+            work
 
-          work
+          else
+            yield
+
+          end
 
         else
-          yield
+          fail Vedeu::Error::RequiresBlock if Vedeu.config.debug?
 
         end
       end
@@ -65,6 +71,8 @@ module Vedeu
       # @return [String]
       attr_reader :message
 
+      private
+
       # Returns the elapsed time in milliseconds with 3 decimal
       # places.
       #

data/lib/vedeu/menus/menu.rb

@@ -195,9 +195,7 @@ module Vedeu
 
       private
 
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash]
+      # @macro defaults_method
       def defaults
         {
           client:     nil,

data/lib/vedeu/models/toggleable.rb

@@ -43,9 +43,8 @@ module Vedeu
       show
     end
 
-    # Provide additional behaviour as class methods.
-    #
-    module ClassMethods
+    # @macro module_singleton_methods
+    module SingletonMethods
 
       # Hides the named model, or without a name, the model with same
       # name as the currently focussed interface.
@@ -143,11 +142,11 @@ module Vedeu
         Vedeu.buffers.by_name(name)
       end
 
-    end # ClassMethods
+    end # SingletonMethods
 
-    # @macro included_module
+    # @macro module_included
     def self.included(klass)
-      klass.extend(Vedeu::Toggleable::ClassMethods)
+      klass.extend(Vedeu::Toggleable::SingletonMethods)
     end
 
   end # Toggleable

data/lib/vedeu/output/all.rb

@@ -2,6 +2,9 @@
 
 module Vedeu
 
+  # Classes within the Output namespace handle various aspects of
+  # rendering content.
+  #
   module Output
 
   end # Output

data/lib/vedeu/output/compressor.rb

@@ -17,7 +17,7 @@ module Vedeu
       include Vedeu::Renderers::Options
 
       # @param (see #initialize)
-      # @return [String]
+      # @return (see #render)
       def self.render(output, options = {})
         new(output, options).render
       end

data/lib/vedeu/output/output.rb

@@ -2,13 +2,12 @@
 
 module Vedeu
 
-  # Classes within the Output namespace handle various aspects of
-  # rendering content.
-  #
   module Output
 
     # Sends the output to the renderers.
     #
+    # @api public
+    #
     class Output
 
       include Vedeu::Common

data/lib/vedeu/output/refresh.rb

@@ -7,7 +7,7 @@ module Vedeu
     # @see Vedeu::Bindings::System#refresh!
     class Refresh
 
-      # @see #all
+      # @return (see #all)
       def self.all
         new.all
       end

data/lib/vedeu/output/write.rb

@@ -16,7 +16,8 @@ module Vedeu
       include Vedeu::Presentation
 
       # @api public
-      # @see Vedeu::Output::Write#initialize
+      # @param (see #initialize)
+      # @return (see #write)
       def self.write(output = nil, options = {})
         new(output, options).write
       end
@@ -63,7 +64,7 @@ module Vedeu
 
       private
 
-      # @return [Hash<Symbol => Fixnum>]
+      # @macro defaults_method
       def defaults
         {
           x: 1,