vedeu 0.6.12 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3baa951de557aa4e39a7c9414fae7caea7c9efef
-  data.tar.gz: 58355bdd2dabc9b59d5c52fc99306a81afcc934b
+  metadata.gz: 31c6be7113f82b029855008aaaf699fbd567ae33
+  data.tar.gz: 1bf5c6c64eb63d6332af2645be09bf0103fc19e8
 SHA512:
-  metadata.gz: b9f5da3a38e66ce269b8233084bfbec48fb67c2cd32abe33e71e12b03d2f77d85f816188b050b7f8d1ec92c8fdc14dcb00e5019efd8095c645de54cc39418e9c
-  data.tar.gz: 2c44e1296ac86195023e72bc5f40cc6428de275c9115b2322f3c756f25145bb5a7c3e3efd6a3eb33c059c66d3bde4b0dca1491f8ac5d8f36df1b5276dca0186a
+  metadata.gz: 24727ce127fde1301bddc57102f7814fde4fb73f020012cbe0bf5d1d13c7b4023a0457691f1815f6e4ee6f5d53160843a003b53ba9dc231b12b9df8b8ac34e87
+  data.tar.gz: 310d942055981700a8b3f7381291b0c1a29517c85531be676eee43ff877a6dba875f53b57a424d7863949c9f975b3dba66e766d811347e634fed7f074b8edae4

data/lib/vedeu/bindings/application.rb

@@ -18,6 +18,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/application.md#\_goto_}
       def goto!
         Vedeu.bind(:_goto_) do |controller, action, **args|
@@ -27,6 +29,8 @@ module Vedeu
         Vedeu.bind_alias(:_action_, :_goto_)
       end
 
+      # :nocov:
+
     end # Application
 
   end # Bindings

data/lib/vedeu/bindings/document.rb

@@ -27,6 +27,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/document.md#\_editor_execute_}
       def editor_execute!
         Vedeu.bind(:_editor_execute_) do |name|
@@ -86,6 +88,8 @@ module Vedeu
         Vedeu.bind(:_editor_up_) { |name| Vedeu.documents.by_name(name).up }
       end
 
+      # :nocov:
+
     end # Document
 
   end # Bindings

data/lib/vedeu/bindings/focus.rb

@@ -18,6 +18,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/focus.md#\_focus_by_name_}
       def focus_by_name!
         Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
@@ -33,6 +35,8 @@ module Vedeu
         Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
       end
 
+      # :nocov:
+
     end # Focus
 
   end # Bindings

data/lib/vedeu/bindings/menus.rb

@@ -28,6 +28,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/menu.md#\_menu_bottom_}
       def menu_bottom!
         Vedeu.bind(:_menu_bottom_) do |name|
@@ -88,6 +90,8 @@ module Vedeu
         Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.by_name(name).view }
       end
 
+      # :nocov:
+
     end # Menus
 
   end # Bindings

data/lib/vedeu/bindings/movement.rb

@@ -21,6 +21,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/movement.md#\_cursor_up_down_left_right_}
       def directional!
         %w(down left right up).each do |direction|
@@ -71,6 +73,8 @@ module Vedeu
         end
       end
 
+      # :nocov:
+
     end # Movement
 
   end # Bindings

data/lib/vedeu/bindings/refresh.rb

@@ -18,6 +18,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/refresh.md#\_refresh_}
       def refresh!
         Vedeu.bind(:_refresh_) do |name|
@@ -45,6 +47,8 @@ module Vedeu
         end
       end
 
+      # :nocov:
+
     end # Refresh
 
   end # Bindings

data/lib/vedeu/bindings/system.rb

@@ -27,6 +27,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/system.md#\_cleanup_}
       def cleanup!
         Vedeu.bind(:_cleanup_) do
@@ -104,6 +106,8 @@ module Vedeu
         end
       end
 
+      # :nocov:
+
     end # System
 
   end # Bindings

data/lib/vedeu/bindings/visibility.rb

@@ -28,6 +28,8 @@ module Vedeu
 
       private
 
+      # :nocov:
+
       # See {file:docs/events/visibility.md#\_clear_group_}
       def clear_group!
         Vedeu.bind(:_clear_group_) do |name|
@@ -102,6 +104,8 @@ module Vedeu
         end
       end
 
+      # :nocov:
+
     end # Visibility
 
   end # Bindings

data/lib/vedeu/borders/dsl.rb

@@ -19,11 +19,10 @@ module Vedeu
       # @param name [String] The name of the interface or view to
       #   which this border belongs.
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax]
-      #   The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Borders::Border]
       def self.border(name, &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
       end

data/lib/vedeu/configuration/api.rb

@@ -269,6 +269,19 @@ module Vedeu
         options[:colour_mode] = value
       end
 
+      # Sets the height of the terminal.
+      #
+      #   Vedeu.configure do
+      #     height 25
+      #     # ...
+      #   end
+      #
+      # @param height [Fixnum]
+      # @return [Fixnum]
+      def height(height = 25)
+        options[:height] = height
+      end
+
       # Sets the location of the log file.
       #
       #   Vedeu.configure do
@@ -452,6 +465,19 @@ module Vedeu
         end
       end
 
+      # Sets the width of the terminal.
+      #
+      #   Vedeu.configure do
+      #     width 80
+      #     # ...
+      #   end
+      #
+      # @param width [Fixnum]
+      # @return [Fixnum]
+      def width(width = 80)
+        options[:width] = width
+      end
+
       private
 
       # Returns the options set via the configuration API DSL or an

data/lib/vedeu/configuration/configuration.rb

@@ -139,6 +139,13 @@ module Vedeu
         instance.options[:drb_width]
       end
 
+      # Returns the client defined height for the terminal.
+      #
+      # @return [Fixnum]
+      def height
+        instance.options[:height]
+      end
+
       # Returns whether the application is interactive (required user
       # input) or standalone (will run until terminates of natural
       # causes.) Default is true; meaning the application will require
@@ -224,6 +231,13 @@ module Vedeu
         instance.options[:terminal_mode]
       end
 
+      # Returns the client defined width for the terminal.
+      #
+      # @return [Fixnum]
+      def width
+        instance.options[:width]
+      end
+
       # @param value [void]
       # @return [void]
       def options=(value)
@@ -293,6 +307,7 @@ module Vedeu
         drb_port:      nil,
         drb_height:    25,
         drb_width:     80,
+        height:        nil,
         interactive:   true,
         log:           nil,
         log_only:      [],
@@ -303,6 +318,7 @@ module Vedeu
         stdout:        nil,
         stderr:        nil,
         terminal_mode: :raw,
+        width:         nil,
       }
     end
 

data/lib/vedeu/dsl/composition.rb

@@ -71,11 +71,10 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @raise [Vedeu::Error::InvalidSyntax]
-      #   The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def view(name = '', &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         new_model = model.member.build(new_attributes(name), &block)
 

data/lib/vedeu/dsl/group.rb

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

data/lib/vedeu/dsl/interface.rb

@@ -31,13 +31,11 @@ module Vedeu
         #   execution lifetime.
         # @param block [Proc] A set of attributes which define the
         #   features of the interface.
-        # @raise [Vedeu::Error::InvalidSyntax] The required block was
-        #   not given.
+        # @raise [Vedeu::Error::RequiresBlock]
         # @return [Vedeu::Models::Interface]
         # @todo More documentation required.
         def interface(name, &block)
-          fail Vedeu::Error::InvalidSyntax,
-               'block not given' unless block_given?
+          fail Vedeu::Error::RequiresBlock unless block_given?
           fail Vedeu::Error::MissingRequired,
                'name not given' unless present?(name)
 

data/lib/vedeu/dsl/keymap.rb

@@ -2,19 +2,20 @@ module Vedeu
 
   module DSL
 
-    # You can define keymaps by name which matches a defined interface. When
-    # that interface is in focus, keys pressed as part of this definition will
-    # affect that interface. This allows you to form context driven behaviour
-    # for your application.
+    # You can define keymaps by name which matches a defined
+    # interface. When that interface is in focus, keys pressed as part
+    # of this definition will affect that interface. This allows you
+    # to form context driven behaviour for your application.
     #
     class Keymap
 
       include Vedeu::Common
       include Vedeu::DSL
 
-      # Define actions for keypresses for when specific interfaces are in focus.
-      # Unless an interface is specified, the key will be assumed to be global,
-      # meaning its action will happen regardless of the interface in focus.
+      # Define actions for keypresses for when specific interfaces are
+      # in focus. Unless an interface is specified, the key will be
+      # assumed to be global, meaning its action will happen
+      # regardless of the interface in focus.
       #
       #   Vedeu.keymap 'some_interface' do
       #     key('s')        { Vedeu.trigger(:save) }
@@ -44,13 +45,13 @@ module Vedeu
       #     end
       #   end
       #
-      # @param name [String] The name of the interface which this keymap relates
-      #   to.
+      # @param name [String] The name of the interface which this
+      #   keymap relates to.
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Input::Keymap]
-      # @todo Try to remember why we need to pre-create the keymap in the
-      #   repository.
+      # @todo Try to remember why we need to pre-create the keymap in
+      #   the repository.
       def self.keymap(name, &block)
         Vedeu::Input::Keymap.new(name: name).store
 
@@ -73,11 +74,12 @@ module Vedeu
       #   The key(s) pressed. Special keys can be found in
       #   {Vedeu::Input::Input#specials}. When more than one key is
       #   defined, then the 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.
+      # @param block [Proc] The action to perform when this key is
+      #   pressed. Can be a method call or event triggered.
       # @raise [Vedeu::Error::InvalidSyntax]
-      #   When the required block is not given, the values parameter is
-      #   undefined, or when processing the collection, a member is undefined.
+      #   When the required block is not given, the values parameter
+      #   is undefined, or when processing the collection, a member
+      #   is undefined.
       # @return [Array] A collection containing the keypress(es).
       def key(*values, &block)
         fail Vedeu::Error::InvalidSyntax,
@@ -99,12 +101,13 @@ module Vedeu
 
       # Define the name of the keymap.
       #
-      # To only allow certain keys to work with specific interfaces, use the
-      # same name as the interface.
+      # To only allow certain keys to work with specific interfaces,
+      # use the same name as the interface.
       #
-      # When the name '_global_' is used, all keys in the keymap block will be
-      # available to all interfaces. Once a key has been defined in the
-      # '_global_' keymap, it cannot be used for a specific interface.
+      # When the name '_global_' is used, all keys in the keymap block
+      # will be available to all interfaces. Once a key has been
+      # defined in the '_global_' keymap, it cannot be used for a
+      # specific interface.
       #
       #   Vedeu.keymap do
       #     name 'some_interface'

data/lib/vedeu/dsl/line.rb

@@ -59,8 +59,7 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [Vedeu::Error::InvalidSyntax] When no block or value is
-      #   provided.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Lines]
       def line(value = '', &block)
         if block_given?
@@ -73,7 +72,7 @@ module Vedeu
                                              value:  [build_stream(value)])
 
         else
-          fail Vedeu::Error::InvalidSyntax, 'block not given'
+          fail Vedeu::Error::RequiresBlock unless block_given?
 
         end
 
@@ -100,12 +99,11 @@ module Vedeu
       #   end
       #
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Streams<Vedeu::Views::Stream>]
       # @see Vedeu::DSL::Stream for subdirectives.
       def streams(&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/dsl/presentation.rb

@@ -2,18 +2,20 @@ module Vedeu
 
   module DSL
 
-    # Provides colour and style helpers for use in the {Vedeu::DSL::Interface},
-    # {Vedeu::DSL::Line} and {Vedeu::DSL::Stream} classes.
+    # Provides colour and style helpers for use in the
+    # {Vedeu::DSL::Interface}, {Vedeu::DSL::Line} and
+    # {Vedeu::DSL::Stream} classes.
     #
     module Presentation
 
-      # Define the background colour for an interface, line, or a stream. When
-      # called with a block, will create a new stream with the background colour
-      # specified. When the block terminates, the background will return to that
-      # of the parent.
+      # Define the background colour for an interface, line, or a
+      # stream. When called with a block, will create a new stream
+      # with the background colour specified. When the block
+      # terminates, the background will return to that of the parent.
       #
-      # @note The last defined background colour for a particular interface,
-      #   line or stream overrides previously defined entries in the same block.
+      # @note The last defined background colour for a particular
+      #   interface, line or stream overrides previously defined
+      #   entries in the same block.
       #
       # @param value [String] A HTML/CSS value.
       #
@@ -56,11 +58,13 @@ module Vedeu
       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.
+      # interface, line or a stream. At least one attribute is
+      # required.
       #
-      # @note Rejects invalid keys and empty/nil attributes. Also, the last
-      #   defined colour for a particular interface, line or stream overrides
-      #   previously defined entries in the same block.
+      # @note Rejects invalid keys and empty/nil attributes. Also, the
+      #   last defined colour for a particular interface, line or
+      #   stream overrides previously defined entries in the same
+      #   block.
       #
       # @param attrs [Hash] See {Vedeu::Colours::Colour}
       #