vedeu 0.6.12 → 0.6.13

data/lib/vedeu/dsl/shared.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module DSL
 
-    # Provides behaviour to be shared between both {Vedeu::DSL::Interface} and
-    # {Vedeu::DSL::View} objects.
+    # Provides behaviour to be shared between both
+    # {Vedeu::DSL::Interface} and {Vedeu::DSL::View} objects.
     #
     module Shared
 
@@ -12,19 +12,21 @@ module Vedeu
       # @example
       #   Vedeu.interface 'my_interface' do
       #     border do
-      #       # ... see Vedeu::Borders::DSL for DSL methods for borders.
+      #       # ... see Vedeu::Borders::DSL for DSL methods for
+      #       #     borders.
       #     end
       #   end
       #
-      # @param name [String] 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::Borders::DSL.border}.
+      # @param name [String] 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::Borders::DSL.border}.
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Borders::Border]
       # @see Vedeu::Borders::DSL
       def border(name = nil, &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         model_name = name ? name : model.name
 
@@ -55,19 +57,21 @@ module Vedeu
       # @example
       #   Vedeu.interface 'my_interface' do
       #     geometry do
-      #       # ... see Vedeu::Geometry::DSL for DSL methods for geometries.
+      #       # ... see Vedeu::Geometry::DSL for DSL methods for
+      #       #     geometries.
       #     end
       #   end
       #
-      # @param name [String] 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::Geometry::DSL.geometry}.
+      # @param name [String] 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::Geometry::DSL.geometry}.
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Geometry::Geometry]
       # @see Vedeu::Geometry::DSL
       def geometry(name = nil, &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         model_name = name ? name : model.name
 

data/lib/vedeu/dsl/stream.rb

@@ -21,11 +21,10 @@ module Vedeu
       end
 
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [void]
       def stream(&block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         model.add(model.class.build(attributes, &block))
       end

data/lib/vedeu/dsl/text.rb

@@ -6,11 +6,13 @@ module Vedeu
     #
     module Text
 
-      # Specify the content for a view. Provides the means to align a string
-      # (or object responding to `to_s`), and add it as a Line or to the Stream.
+      # Specify the content for a view. Provides the means to align a
+      # string (or object responding to `to_s`), and add it as a Line
+      # or to the Stream.
       #
-      # @note If using the convenience methods; {left}, {centre}, {center} or
-      #   {right}, then a specified anchor will be ignored.
+      # @note If using the convenience methods; {left}, {centre},
+      #   {center} or {right}, then a specified anchor will be
+      #   ignored.
       #
       # @example
       #   lines do

data/lib/vedeu/dsl/view.rb

@@ -126,11 +126,10 @@ module Vedeu
         #
         # @param block [Proc] The directives you wish to send to render.
         #   Typically includes `view` with associated sub-directives.
-        # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+        # @raise [Vedeu::Error::RequiresBlock]
         # @return [Array<View>]
         def renders(&block)
-          fail Vedeu::Error::InvalidSyntax,
-               'block not given' unless block_given?
+          fail Vedeu::Error::RequiresBlock unless block_given?
 
           store(:store_immediate, &block)
         end
@@ -171,11 +170,10 @@ module Vedeu
         #
         # @param block [Proc] The directives you wish to send to render.
         #   Typically includes `view` with associated sub-directives.
-        # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+        # @raise [Vedeu::Error::RequiresBlock]
         # @return [Array<View>]
         def views(&block)
-          fail Vedeu::Error::InvalidSyntax,
-               'block not given' unless block_given?
+          fail Vedeu::Error::RequiresBlock unless block_given?
 
           store(:store_deferred, &block)
         end
@@ -243,10 +241,10 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Line]
       def lines(&block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         model.add(model.member.build(attributes, &block))
       end

data/lib/vedeu/error.rb

@@ -87,6 +87,18 @@ module Vedeu
 
     end # OutOfRange
 
+    # Raised when a method expecting a block to be given was not given
+    # the block.
+    #
+    class RequiresBlock < StandardError
+
+      # @return [String]
+      def message
+        'The required block was not given.'
+      end
+
+    end
+
   end # Error
 
 end # Vedeu

data/lib/vedeu/geometry/area.rb

@@ -12,7 +12,8 @@ module Vedeu
       alias_method :top, :y
 
       # @!attribute [r] yn
-      # @return [Fixnum] Returns the bottom coordinate of the interface.
+      # @return [Fixnum] Returns the bottom coordinate of the
+      #   interface.
       attr_reader :yn
       alias_method :bottom, :yn
 
@@ -22,7 +23,8 @@ module Vedeu
       alias_method :left, :x
 
       # @!attribute [r] xn
-      # @return [Fixnum] Returns the right coordinate of the interface.
+      # @return [Fixnum] Returns the right coordinate of the
+      #   interface.
       attr_reader :xn
       alias_method :right, :xn
 

data/lib/vedeu/geometry/coordinate.rb

@@ -44,8 +44,8 @@ module Vedeu
 
       private
 
-      # Provide an instance of Vedeu::Geometry::GenericCoordinate to determine
-      # correct x related coordinates.
+      # Provide an instance of {Vedeu::Geometry::GenericCoordinate} to
+      # determine correct x related coordinates.
       #
       # @return [Vedeu::Geometry::GenericCoordinate]
       def x
@@ -54,8 +54,8 @@ module Vedeu
                                                       type:   :x)
       end
 
-      # Provide an instance of Vedeu::Geometry::GenericCoordinate to determine
-      # correct y related coordinates.
+      # Provide an instance of {Vedeu::Geometry::GenericCoordinate} to
+      # determine correct y related coordinates.
       #
       # @return [Vedeu::Geometry::GenericCoordinate]
       def y

data/lib/vedeu/geometry/dimension.rb

@@ -15,11 +15,13 @@ module Vedeu
       # Returns a new instance of Vedeu::Geometry::Dimension.
       #
       # @param attributes [Hash<Symbol => Fixnum, NilClass>]
-      # @option attributes d [Fixnum|NilClass] The starting value (y or x).
-      # @option attributes dn [Fixnum|NilClass] The ending value (yn or xn).
+      # @option attributes d [Fixnum|NilClass]
+      #   The starting value (y or x).
+      # @option attributes dn [Fixnum|NilClass]
+      #   The ending value (yn or xn).
       # @option attributes d_dn [Fixnum|NilClass] A width or a height.
-      # @option attributes default [Fixnum|NilClass] The terminal width or
-      #   height.
+      # @option attributes default [Fixnum|NilClass]
+      #   The terminal width or height.
       # @option attributes options [Hash]
       # @return [Vedeu::Geometry::Dimension]
       def initialize(attributes = {})

data/lib/vedeu/geometry/dsl.rb

@@ -3,11 +3,13 @@ module Vedeu
   module Geometry
 
     # Geometry allows the configuration of the position and size of an
-    # interface. Within Vedeu, as the same for ANSI terminals, has the origin at
-    # top-left, y = 1, x = 1. The 'y' coordinate is deliberately first.
+    # interface. Within Vedeu, as the same for ANSI terminals, has the
+    # origin at top-left, y = 1, x = 1. The 'y' coordinate is
+    # deliberately first.
     #
-    # The Geometry DSL can be used within the Interface DSL or standalone. Here
-    # are example of declarations for a `geometry` block:
+    # The Geometry DSL can be used within the Interface DSL or
+    # standalone. Here are example of declarations for a `geometry`
+    # block:
     #
     # A standalone geometry definition:
     #
@@ -34,11 +36,12 @@ module Vedeu
     #     # ... some code here
     #   end
     #
-    # If a declaration is omitted for `height` or `width` the full remaining
-    # space available in the terminal will be used. `x` and `y` both default to
-    # 1.
+    # If a declaration is omitted for `height` or `width` the full
+    # remaining space available in the terminal will be used. `x` and
+    # `y` both default to 1.
     #
-    # You can also make a geometry declaration dependent on another view:
+    # You can also make a geometry declaration dependent on another
+    # view:
     #
     #   Vedeu.interface 'other_panel' do
     #     # ... some code here
@@ -55,8 +58,8 @@ module Vedeu
     #
     # This view will begin just below "other\_panel".
     #
-    # This crude ASCII diagram represents a Geometry within Vedeu, each of the
-    # labels is a value you can access or define.
+    # This crude ASCII diagram represents a Geometry within Vedeu,
+    # each of the labels is a value you can access or define.
     #
     #        x    north    xn           # north:  y - 1
     #      y +--------------+           # top:    y
@@ -73,19 +76,20 @@ module Vedeu
       include Vedeu::DSL
       include Vedeu::DSL::Use
 
-      # Specify the geometry of an interface or view with a simple DSL.
+      # Specify the geometry of an interface or view with a simple
+      # DSL.
       #
       #   Vedeu.geometry 'some_interface' do
       #     # ...
       #   end
       #
-      # @param name [String] The name of the interface or view to which this
-      #   geometry belongs.
+      # @param name [String] The name of the interface or view to
+      #   which this geometry belongs.
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Geometry::Geometry]
       def self.geometry(name, &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         Vedeu::Geometry::Geometry.build(name: name, &block).store
       end
@@ -100,8 +104,9 @@ module Vedeu
         @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.
+      # 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
       #     centred false # or...
@@ -111,8 +116,8 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @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.
       # @return [Boolean]
       def centred(value = true)
         boolean = value ? true : false
@@ -122,7 +127,8 @@ module Vedeu
       alias_method :centred!, :centred
       alias_method :centred=, :centred
 
-      # Returns the width in characters for the number of columns specified.
+      # Returns the width in characters for the number of columns
+      # specified.
       #
       #   Vedeu.geometry 'main_interface' do
       #     # ... some code
@@ -133,15 +139,15 @@ module Vedeu
       #   end
       #
       # @param value [Fixnum]
-      # @raise [Vedeu::Error::OutOfRange] When the value parameter is not
-      #   between 1 and 12 inclusive.
+      # @raise [Vedeu::Error::OutOfRange] When the value parameter is
+      #   not between 1 and 12 inclusive.
       # @return [Fixnum|Vedeu::Error::OutOfRange]
       def columns(value)
         Vedeu::Geometry::Grid.columns(value)
       end
 
-      # Specify the number of characters/rows/lines tall the interface will be.
-      # This value will be ignored when `y` and `yn` are set.
+      # 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
       #     height 8
@@ -155,7 +161,8 @@ module Vedeu
       end
       alias_method :height=, :height
 
-      # Returns the height in characters for the number of rows specified.
+      # Returns the height in characters for the number of rows
+      # specified.
       #
       #   Vedeu.geometry 'main_interface' do
       #     # ... some code
@@ -166,15 +173,15 @@ module Vedeu
       #   end
       #
       # @param value [Fixnum]
-      # @raise [Vedeu::Error::OutOfRange] When the value parameter is not
-      #   between 1 and 12 inclusive.
+      # @raise [Vedeu::Error::OutOfRange] When the value parameter is
+      #   not between 1 and 12 inclusive.
       # @return [Fixnum]
       def rows(value)
         Vedeu::Geometry::Grid.rows(value)
       end
 
-      # Specify the number of characters/columns wide the interface will be.
-      # This value will be ignored when `x` and `xn` are set.
+      # 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
       #     width 25
@@ -193,10 +200,11 @@ module Vedeu
       #   Vedeu.geometry 'some_interface' do
       #     x 7 # start on column 7.
       #
-      #     x { use('other_interface').east } # start on column 8, if
-      #     # ... some code                   # `other_interface` changes
-      #   end                                 # position, `some_interface` will
-      #                                       # too.
+      #     # start on column 8, if `other_interface` changes position
+      #     # then `some_interface` will too.
+      #     x { use('other_interface').east }
+      #     # ... some code
+      #   end
       #
       # @param value [Fixnum]
       # @param block [Proc]
@@ -214,9 +222,10 @@ module Vedeu
       #   Vedeu.geometry 'some_interface' do
       #     xn 37 # end at column 37.
       #
-      #     xn  { use('other_interface').right } # when `other_interface`
-      #                                          # changes position,
-      #     # ... some code                      # `some_interface` will too.
+      #     # when `other_interface` changes position,
+      #     # `some_interface` will too.
+      #     xn  { use('other_interface').right }
+      #     # ... some code
       #   end
       #
       # @param value [Fixnum]
@@ -234,10 +243,11 @@ module Vedeu
       #   Vedeu.geometry 'some_interface' do
       #     y  4 # start at row 4
       #
-      #     y  { use('other_interface').north } # start on row/line 3, when
-      #     # ... some code                     # `other_interface` changes
-      #   end                                   # position, `some_interface`
-      #                                         # will too.
+      #     # start on row/line 3, when `other_interface` changes
+      #     # position, `some_interface` will too.
+      #     y  { use('other_interface').north }
+      #     # ... some code
+      #   end
       #
       # @param value [Fixnum]
       # @param block [Proc]
@@ -255,9 +265,11 @@ module Vedeu
       #   Vedeu.geometry 'some_interface' do
       #     yn 24 # end at row 24.
       #
-      #     yn { use('other_interface').bottom } # if `other_interface` changes
-      #     # ... some code                      # position, `some_interface`
-      #   end                                    # will too.
+      #     # if `other_interface` changes position, `some_interface`
+      #     # will too.
+      #     yn { use('other_interface').bottom }
+      #     # ... some code
+      #   end
       #
       # @param value [Fixnum]
       # @param block [Proc]

data/lib/vedeu/geometry/generic_coordinate.rb

@@ -113,10 +113,11 @@ module Vedeu
         border.send(coordinate_type[3])
       end
 
-      # Ascertain the correct methods to use for determining the coordinates.
+      # Ascertain the correct methods to use for determining the
+      # coordinates.
       #
-      # @raise [Vedeu::Error::InvalidSyntax] When the coordinate type is not
-      #   given.
+      # @raise [Vedeu::Error::InvalidSyntax] When the coordinate type
+      #   is not given.
       # @return [Fixnum]
       def coordinate_type
         @_type ||= case type