vedeu 0.6.1 → 0.6.2

data/lib/vedeu/configuration/configuration.rb

@@ -65,7 +65,8 @@ module Vedeu
       # @option opts stdout [File|IO]
       # @option opts stderr [File|IO]
       # @param block [Proc]
-      # @raise [Vedeu::InvalidSyntax] When the required block is not given.
+      # @raise [Vedeu::Error::InvalidSyntax]
+      #   When the required block is not given.
       # @return [Hash]
       def configure(args = [], opts = {}, &block)
         instance.configure(args, opts, &block)

data/lib/vedeu/dsl/border.rb

@@ -41,10 +41,11 @@ module Vedeu
       # @param name [String] The name of the interface or view to which this
       #   border belongs.
       # @param block [Proc]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax]
+      #   The required block was not given.
       # @return [Vedeu::Border]
       def self.border(name, &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         Vedeu::Border.build(enabled: true, name: name, &block).store
       end
@@ -73,6 +74,7 @@ module Vedeu
       def bottom_left(char)
         model.bottom_left = char
       end
+      alias_method :bottom_left=, :bottom_left
 
       # Set the character to be used to draw the bottom right corner of the
       # border.
@@ -88,6 +90,7 @@ module Vedeu
       def bottom_right(char)
         model.bottom_right = char
       end
+      alias_method :bottom_right=, :bottom_right
 
       # Disable the border:
       #
@@ -141,6 +144,7 @@ module Vedeu
       def horizontal(char)
         model.horizontal = char
       end
+      alias_method :horizontal=, :horizontal
 
       # Enable/disable the bottom border.
       #
@@ -161,6 +165,7 @@ module Vedeu
         model.show_bottom = boolean
       end
       alias_method :show_bottom, :bottom
+      alias_method :bottom=, :bottom
 
       # Disable the bottom border.
       #
@@ -195,6 +200,7 @@ module Vedeu
         model.show_left = boolean
       end
       alias_method :show_left, :left
+      alias_method :left=, :left
 
       # Disable the left border.
       #
@@ -229,6 +235,7 @@ module Vedeu
         model.show_right = boolean
       end
       alias_method :show_right, :right
+      alias_method :right=, :right
 
       # Disable the right border.
       #
@@ -260,6 +267,7 @@ module Vedeu
       def title(value)
         model.title = value
       end
+      alias_method :title=, :title
 
       # If you have you are showing a bottom border, you could add a caption.
       #
@@ -277,6 +285,7 @@ module Vedeu
       def caption(value)
         model.caption = value
       end
+      alias_method :caption=, :caption
 
       # Enable/disable the top border.
       #
@@ -297,6 +306,7 @@ module Vedeu
         model.show_top = boolean
       end
       alias_method :show_top, :top
+      alias_method :top=, :top
 
       # Disable the top border.
       #
@@ -325,6 +335,7 @@ module Vedeu
       def top_left(char)
         model.top_left = char
       end
+      alias_method :top_left=, :top_left
 
       # Set the character to be used to draw the top right corner of the border.
       #
@@ -339,6 +350,7 @@ module Vedeu
       def top_right(char)
         model.top_right = char
       end
+      alias_method :top_right=, :top_right
 
       # Set the character to be used to draw a vertical part of the border.
       #
@@ -353,6 +365,7 @@ module Vedeu
       def vertical(char)
         model.vertical = char
       end
+      alias_method :vertical=, :vertical
 
     end # Border
 

data/lib/vedeu/dsl/composition.rb

@@ -68,10 +68,11 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax]
+      #   The required block was not given.
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def view(name = '', &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         new_model = model.member.build(new_attributes(name), &block)
 
@@ -97,11 +98,12 @@ module Vedeu
       # @param object [Object] The object for which the values of template's
       #   variables can be obtained.
       # @param options [Hash] See {Vedeu::Wordwrap}
+      # @raise [Vedeu::Error::MissingRequired]
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def template_for(name, filename, object = nil, options = {})
-        fail Vedeu::MissingRequired,
+        fail Vedeu::Error::MissingRequired,
              'Cannot render template without the name of the view.' unless name
-        fail Vedeu::MissingRequired,
+        fail Vedeu::Error::MissingRequired,
              'Cannot render template without a filename.' unless filename
 
         options.merge!(name: name)

data/lib/vedeu/dsl/geometry.rb

@@ -82,10 +82,10 @@ module Vedeu
       # @param name [String] The name of the interface or view to which this
       #   geometry belongs.
       # @param block [Proc]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Geometry]
       def self.geometry(name, &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         Vedeu::Geometry.build(name: name, &block).store
       end
@@ -120,6 +120,7 @@ module Vedeu
         model.centred = boolean
       end
       alias_method :centred!, :centred
+      alias_method :centred=, :centred
 
       # Returns the width in characters for the number of columns specified.
       #
@@ -132,9 +133,9 @@ module Vedeu
       #   end
       #
       # @param value [Fixnum]
-      # @raise [Vedeu::OutOfRange] When the value parameter is not between 1 and
-      #   12 inclusive.
-      # @return [Fixnum|Vedeu::OutOfRange]
+      # @raise [Vedeu::Error::OutOfRange] When the value parameter is not
+      #   between 1 and 12 inclusive.
+      # @return [Fixnum|Vedeu::Error::OutOfRange]
       def columns(value)
         Vedeu::Grid.columns(value)
       end
@@ -152,6 +153,7 @@ module Vedeu
       def height(value)
         model.height = proc { value }
       end
+      alias_method :height=, :height
 
       # Returns the height in characters for the number of rows specified.
       #
@@ -164,8 +166,8 @@ module Vedeu
       #   end
       #
       # @param value [Fixnum]
-      # @raise [Vedeu::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::Grid.rows(value)
@@ -184,6 +186,7 @@ module Vedeu
       def width(value)
         model.width = proc { value }
       end
+      alias_method :width=, :width
 
       # Specify the starting x position (column) of the interface.
       #
@@ -203,6 +206,7 @@ module Vedeu
 
         model.x = value
       end
+      alias_method :x=, :x
 
       # Specify the ending x position (column) of the interface.
       # This value will override `width`.
@@ -223,6 +227,7 @@ module Vedeu
 
         model.xn = value
       end
+      alias_method :xn=, :xn
 
       # Specify the starting y position (row/line) of the interface.
       #
@@ -242,6 +247,7 @@ module Vedeu
 
         model.y = value
       end
+      alias_method :y=, :y
 
       # Specify the ending y position (row/line) of the interface.
       # This value will override `height`.
@@ -261,6 +267,7 @@ module Vedeu
 
         model.yn = value
       end
+      alias_method :yn=, :yn
 
     end # Geometry
 

data/lib/vedeu/dsl/group.rb

@@ -50,10 +50,10 @@ module Vedeu
       #
       # @param name [String] The name of this group.
       # @param block [Proc]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Group]
       def self.group(name, &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         Vedeu::Group.build(name: name, &block).store
       end

data/lib/vedeu/dsl/interface.rb

@@ -29,12 +29,14 @@ module Vedeu
         #   interface throughout your application's execution lifetime.
         # @param block [Proc] A set of attributes which define the features of
         #   the interface.
-        # @raise [Vedeu::InvalidSyntax] The required block was not given.
+        # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
         # @return [Vedeu::Interface]
         # @todo More documentation required.
         def interface(name, &block)
-          fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
-          fail Vedeu::MissingRequired, 'name not given' unless present?(name)
+          fail Vedeu::Error::InvalidSyntax,
+               'block not given' unless block_given?
+          fail Vedeu::Error::MissingRequired,
+               'name not given' unless present?(name)
 
           add_buffers!(name)
           add_cursor!(name)

data/lib/vedeu/dsl/keymap.rb

@@ -47,7 +47,7 @@ module Vedeu
       # @param name [String] The name of the interface which this keymap relates
       #   to.
       # @param block [Proc]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Keymap]
       # @todo Try to remember why we need to pre-create the keymap in the
       #   repository.
@@ -75,27 +75,28 @@ module Vedeu
       #   extras are treated as aliases.
       # @param block [Proc] The action to perform when this key is pressed. Can
       #   be a method call or event triggered.
-      # @raise [Vedeu::InvalidSyntax] When the required block is not given, the
-      #   value_or_values parameter is undefined, or when processing the
-      #   collection, a member is undefined.
+      # @raise [Vedeu::Error::InvalidSyntax]
+      #   When the required block is not given, the value_or_values parameter is
+      #   undefined, or when processing the collection, a member is undefined.
       # @return [Array] A collection containing the keypress(es).
       def key(*value_or_values, &block)
-        fail Vedeu::InvalidSyntax,
+        fail Vedeu::Error::InvalidSyntax,
              'No action defined for `key`.' unless block_given?
 
         unless present?(value_or_values)
-          fail Vedeu::InvalidSyntax, 'No keypress(es) defined for `key`.'
+          fail Vedeu::Error::InvalidSyntax, 'No keypress(es) defined for `key`.'
         end
 
         value_or_values.each do |value|
           unless present?(value)
-            fail Vedeu::InvalidSyntax,
+            fail Vedeu::Error::InvalidSyntax,
                  'An invalid value for `key` was encountered.'
           end
 
           model.add(model.member.new(value, &block))
         end
       end
+      alias_method :key=, :key
 
       # Define the name of the keymap.
       #
@@ -115,6 +116,7 @@ module Vedeu
       def name(value)
         model.name = value
       end
+      alias_method :name=, :name
 
     end # Keymap
 

data/lib/vedeu/dsl/line.rb

@@ -59,7 +59,7 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [Vedeu::InvalidSyntax] When no block or value is provided.
+      # @raise [Vedeu::Error::InvalidSyntax] When no block or value is provided.
       # @return [Vedeu::Views::Lines]
       def line(value = '', &block)
         if block_given?
@@ -72,12 +72,13 @@ module Vedeu
                                              value:  [build_stream(value)])
 
         else
-          fail Vedeu::InvalidSyntax, 'block not given'
+          fail Vedeu::Error::InvalidSyntax, 'block not given'
 
         end
 
         model.parent.add(content)
       end
+      alias_method :line=, :line
 
       # Define multiple streams (a stream is a subset of a line).
       # Uses {Vedeu::DSL::Stream} for all directives within the required block.
@@ -97,15 +98,17 @@ module Vedeu
       #   end
       #
       # @param block [Proc]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Views::Streams<Vedeu::Views::Stream>]
       # @see Vedeu::DSL::Stream for subdirectives.
       def streams(&block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         model.add(model.member.build(attributes, &block))
       end
       alias_method :stream, :streams
+      alias_method :stream=, :streams
+      alias_method :streams=, :streams
 
       private
 

data/lib/vedeu/dsl/menu.rb

@@ -32,6 +32,7 @@ module Vedeu
       def item(element)
         model.collection << element
       end
+      alias_method :item=, :item
 
       # Define the items for the menu. Most powerful when used with one of your
       # model classes.
@@ -53,6 +54,7 @@ module Vedeu
       def items(collection = [])
         model.collection = collection
       end
+      alias_method :items=, :items
 
       # The name of the menu. Used to reference the menu throughout your
       # application's execution lifetime.
@@ -67,6 +69,7 @@ module Vedeu
       def name(value)
         model.name = value
       end
+      alias_method :name=, :name
 
     end # Menu
 

data/lib/vedeu/dsl/presentation.rb

@@ -37,17 +37,23 @@ module Vedeu
       #
       # @return [String]
       def background(value = '')
-        colour(background: Vedeu::Background.coerce(value))
+        colour(background: Vedeu::Colours::Background.coerce(value))
       end
-      alias_method :bg,      :background
-      alias_method :bgcolor, :background
+      alias_method :bg,          :background
+      alias_method :bgcolor,     :background
+      alias_method :background=, :background
+      alias_method :bg=,         :background
+      alias_method :bgcolor=,    :background
 
       # @see Vedeu::DSL::Presentation#background
       def foreground(value = '')
-        colour(foreground: Vedeu::Foreground.coerce(value))
+        colour(foreground: Vedeu::Colours::Foreground.coerce(value))
       end
-      alias_method :fg,      :foreground
-      alias_method :fgcolor, :foreground
+      alias_method :fg,          :foreground
+      alias_method :fgcolor,     :foreground
+      alias_method :foreground=, :foreground
+      alias_method :fg=,         :foreground
+      alias_method :fgcolor=,    :foreground
 
       # Define either or both foreground and background colours for an
       # interface, line or a stream. At least one attribute is required.
@@ -56,7 +62,7 @@ module Vedeu
       #   defined colour for a particular interface, line or stream overrides
       #   previously defined entries in the same block.
       #
-      # @param attrs [Hash] See {Vedeu::Colour}
+      # @param attrs [Hash] See {Vedeu::Colours::Colour}
       #
       # @example
       #   interface 'my_interface' do
@@ -74,10 +80,12 @@ module Vedeu
       #     end
       #   end
       #
-      # @return [Vedeu::Colour]
+      # @return [Vedeu::Colours::Colour]
       def colour(attrs = {})
-        model.colour = Vedeu::Colour.coerce(colour_attributes.merge!(attrs))
+        model.colour = Vedeu::Colours::Colour
+          .coerce(colour_attributes.merge!(attrs))
       end
+      alias_method :colour=, :colour
 
       # Define a style or styles for an interface, line or a stream.
       #
@@ -103,7 +111,9 @@ module Vedeu
       def style(value)
         model.style = Vedeu::Style.coerce(value)
       end
-      alias_method :styles, :style
+      alias_method :style=,  :style
+      alias_method :styles,  :style
+      alias_method :styles=, :style
 
       private