vedeu 0.4.58 → 0.4.59

data/lib/vedeu/colours/colours.rb

@@ -3,7 +3,6 @@ module Vedeu
   # Allows the storing of HTML/CSS colours and their respective escape
   # sequences.
   #
-  # @api public
   class Colours
 
     # @!attribute [r] storage

data/lib/vedeu/colours/foregrounds.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Store foreground colour escape sequences by HTML/CSS code.
   #
-  # @api public
   class Foregrounds < Colours
 
     # @return [Vedeu::Foregrounds]

data/lib/vedeu/configuration/api.rb

@@ -5,7 +5,6 @@ module Vedeu
     # The Configuration::API class parses client application configuration into
     # options used by Vedeu to affect certain behaviours.
     #
-    # @api public
     class API
 
       include Vedeu::Common
@@ -302,6 +301,20 @@ module Vedeu
         options[:base_path] = path
       end
 
+      # Sets the root of the client application. Vedeu will execute this
+      # controller first.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     root YourApp::SomeController.new
+      #     ...
+      #
+      # @param controller [Class]
+      # @return [Class]
+      def root(controller)
+        options[:root] = controller
+      end
+
       # Sets the value of STDIN.
       #
       # @example
@@ -393,13 +406,13 @@ module Vedeu
       # @return [Symbol]
       # @see Vedeu::Config::API#raw!
       # @see Vedeu::Config::API#cooked!
-      def terminal_mode(value)
-        if value == :raw || value == :cooked
-          options[:terminal_mode] = value
+      def terminal_mode(mode)
+        if mode == :raw || mode == :cooked
+          options[:terminal_mode] = mode
 
         else
-          fail Vedeu::InvalidSyntax, 'Terminal mode can be set to either :raw or ' \
-                              ':cooked'
+          fail Vedeu::InvalidSyntax,
+               'Terminal mode can be set to either :raw or :cooked'
 
         end
       end

data/lib/vedeu/configuration/cli.rb

@@ -5,7 +5,6 @@ module Vedeu
     # The Configuration::CLI class parses command-line arguments using
     # OptionParser into options used by Vedeu to affect certain behaviours.
     #
-    # @api public
     class CLI
 
       # @param (see #initialize)
@@ -78,6 +77,7 @@ module Vedeu
           :raw,
           :run_many,
           :run_once,
+          :root,
           :standalone,
         ]
       end
@@ -181,6 +181,14 @@ module Vedeu
         end
       end
 
+      # # @return [OptionParser]
+      def root
+        parser.on('-s', '--root []', String,
+                  'Start the application from the specified controller.') do |c|
+          options[:root] = c
+        end
+      end
+
       # @return [OptionParser]
       def run_many
         parser.on('-n', '--run-many',

data/lib/vedeu/configuration/configuration.rb

@@ -174,6 +174,14 @@ module Vedeu
         instance.options[:renderers]
       end
 
+      # Returns the root of the client application. Vedeu will execute this
+      # controller first.
+      #
+      # @return [Class]
+      def root
+        instance.options[:root]
+      end
+
       # Returns the redefined setting for STDIN.
       #
       # @return [File|IO]
@@ -274,6 +282,7 @@ module Vedeu
         log:           nil,
         once:          false,
         renderers:     [Vedeu::Renderers::Terminal.new],
+        root:          nil,
         stdin:         nil,
         stdout:        nil,
         stderr:        nil,

data/lib/vedeu/cursor/cursor.rb

@@ -1,5 +1,3 @@
-require 'vedeu/models/toggleable'
-
 module Vedeu
 
   # Each interface has its own Cursor which maintains the position and

data/lib/vedeu/cursor/cursors.rb

@@ -1,10 +1,7 @@
-require 'vedeu/cursor/cursor'
-
 module Vedeu
 
   # Allows the storing of each interface's cursor.
   #
-  # @api public
   class Cursors < Vedeu::Repository
 
     class << self

data/lib/vedeu/debug.rb

@@ -4,7 +4,6 @@ module Vedeu
   # Helps to debug a running application by providing a stack trace of its
   # execution upon exiting.
   #
-  # @api public
   # @param filename [String]
   # @return [void]
   # @yieldreturn [void] The section of the application to debug.

data/lib/vedeu/dsl.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides a mechanism to help configure and use Vedeu.
   #
-  # @api public
   module DSL
 
     private

data/lib/vedeu/dsl/border.rb

@@ -2,11 +2,10 @@ module Vedeu
 
   module DSL
 
-    # DSL for creating borders for interfaces.
-    #
-    # Allows customisation for the border's sides and corners; a custom
-    # foreground and background, style, and whether a particular side should be
-    # drawn or not.
+    # Borders are defined by name for each of the client application's
+    # interfaces or views. They can be enabled or disabled (which controls
+    # whether they are rendered or not), they have their own colours and styles,
+    # and each aspect of the border can be controlled.
     #
     # @example
     #   # Borders can be defined when defining your interface...
@@ -27,7 +26,6 @@ module Vedeu
     #     # ...
     #   end
     #
-    # @api public
     class Border
 
       include Vedeu::DSL
@@ -36,7 +34,6 @@ module Vedeu
 
       # Specify the border of an interface or view with a simple DSL.
       #
-      # @example
       #   Vedeu.border 'some_interface' do
       #     # ...
       #   end
@@ -65,14 +62,9 @@ module Vedeu
       # Set the character to be used to draw the bottom left corner of the
       # border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         bottom_left '+'
-      #         # ...
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     bottom_left '+'
+      #     # ... some code
       #   end
       #
       # @param char [String] Character to be used as the bottom left border
@@ -85,14 +77,9 @@ module Vedeu
       # Set the character to be used to draw the bottom right corner of the
       # border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         bottom_right '+'
-      #         # ...
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     bottom_right '+'
+      #     # ... some code
       #   end
       #
       # @param char [String] Character to be used as the bottom right border
@@ -102,7 +89,12 @@ module Vedeu
         model.bottom_right = char
       end
 
-      # Disable this border.
+      # Disable the border:
+      #
+      #   Vedeu.border 'border_demo' do
+      #     disable!
+      #     # ... some other code (will be ignored)
+      #   end
       #
       # @return [Boolean]
       def disable!
@@ -112,11 +104,18 @@ module Vedeu
         hide_left!
         hide_right!
         hide_top!
+
+        model.enabled
       end
 
-      # Enable this border.
+      # Enable the border:
       # (Borders are enabled by default if defined for an interface).
       #
+      #   Vedeu.border 'border_demo' do
+      #     enable!
+      #     # ... some code
+      #   end
+      #
       # @return [Boolean]
       def enable!
         model.enabled = true
@@ -125,18 +124,15 @@ module Vedeu
         show_left!
         show_right!
         show_top!
+
+        model.enabled
       end
 
       # Set the character to be used to draw a horizontal part of the border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         horizontal '-'
-      #         # ...
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     horizontal '-'
+      #     # ... some code
       #   end
       #
       # @param char [String] Character to be used as the horizontal border
@@ -148,17 +144,12 @@ module Vedeu
 
       # Enable/disable the bottom border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         bottom false
-      #         # ... or
-      #         hide_bottom!
-      #         # ... or
-      #         show_bottom!
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     bottom true  # or...
+      #     bottom false # or...
+      #     hide_bottom! # or...
+      #     show_bottom!
+      #     # ... some code
       #   end
       #
       # @param value [Boolean] All values evaluate as true except nil and
@@ -187,17 +178,12 @@ module Vedeu
 
       # Enable/disable the left border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         left false
-      #         # ... or
-      #         hide_left!
-      #         # ... or
-      #         show_left!
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     left true  # or...
+      #     left false # or...
+      #     hide_left! # or...
+      #     show_left!
+      #     # ... some code
       #   end
       #
       # @param value [Boolean] All values evaluate as true except nil and
@@ -226,17 +212,12 @@ module Vedeu
 
       # Enable/disable the right border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         right false
-      #         # ... or
-      #         hide_right!
-      #         # ... or
-      #         show_right!
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     right true  # or...
+      #     right false # or...
+      #     hide_right! # or...
+      #     show_right!
+      #     # ... some code
       #   end
       #
       # @param value [Boolean] All values evaluate as true except nil and
@@ -265,17 +246,13 @@ module Vedeu
 
       # If you have you are showing a top border, you could add a title.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       geometry { width: 50 }
-      #       border do
-      #         title 'My Cool Title'
-      #         # ...
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     title 'My Cool Title'
+      #     # ... some code
       #   end
       #
+      # produces, depending on other customisations:
+      #
       #   +- My Cool Title --------------------------------+
       #
       # @param value [String] The title.
@@ -286,17 +263,12 @@ module Vedeu
 
       # Enable/disable the top border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         top false
-      #         # ... or
-      #         hide_top!
-      #         # ... or
-      #         show_top!
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     top true  # or...
+      #     top false # or...
+      #     hide_top! # or...
+      #     show_top!
+      #     # ... some code
       #   end
       #
       # @param value [Boolean] All values evaluate as true except nil and
@@ -325,14 +297,9 @@ module Vedeu
 
       # Set the character to be used to draw the top left corner of the border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         top_left '+'
-      #         # ...
-      #       end
-      #     end
+      #   Vedeu.border 'border_demo' do
+      #     top_left '+'
+      #     # ... some code
       #   end
       #
       # @param char [String] Character to be used as the top left border
@@ -344,12 +311,10 @@ module Vedeu
 
       # Set the character to be used to draw the top right corner of the border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         top_right '+'
-      #         # ...
+      #   Vedeu.border 'border_demo' do
+      #     top_right '+'
+      #     # ... some code
+      #   end
       #
       # @param char [String] Character to be used as the top right border
       #   character.
@@ -360,12 +325,10 @@ module Vedeu
 
       # Set the character to be used to draw a vertical part of the border.
       #
-      # @example
-      #   Vedeu.renders do
-      #     view 'border_demo' do
-      #       border do
-      #         vertical '|'
-      #         # ...
+      #   Vedeu.border 'border_demo' do
+      #     vertical '|'
+      #     # ... some code
+      #   end
       #
       # @param char [String] Character to be used as the vertical border
       #   character.

data/lib/vedeu/dsl/composition.rb

@@ -36,7 +36,6 @@ module Vedeu
     # - Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
     # - Styles are named. See the table below for supported styles.
     #
-    # @api public
     class Composition
 
       include Vedeu::DSL
@@ -103,7 +102,7 @@ module Vedeu
         fail Vedeu::MissingRequired,
              'Cannot render template without the name of the view.' unless name
         fail Vedeu::MissingRequired,
-             "Cannot render template without a filename." unless filename
+             'Cannot render template without a filename.' unless filename
 
         content   = Vedeu::Templating::Template.parse(object, filename)
         lines     = Vedeu::Wordwrap.for(content, options)