vedeu 0.4.58 → 0.4.59

data/lib/vedeu/dsl/line.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # Provides methods to be used to define views.
     #
-    # @example
     #   Vedeu.renders do
     #     view 'my_interface' do
     #       lines do
@@ -31,7 +30,6 @@ module Vedeu
     #     end
     #   end
     #
-    # @api public
     class Line
 
       include Vedeu::DSL
@@ -50,14 +48,13 @@ module Vedeu
 
       # Specify a single line in a view.
       #
-      # @example
       #   Vedeu.renders do
       #     view 'my_interface' do
       #       line 'some text...'
-      #       # ...
+      #       # ... some code
       #
       #       line do
-      #         # ...
+      #         # ... some code
       #       end
       #     end
       #   end
@@ -85,23 +82,21 @@ module Vedeu
       # Define multiple streams (a stream is a subset of a line).
       # Uses {Vedeu::DSL::Stream} for all directives within the required block.
       #
-      # @param block [Proc]
-      #
-      # @example
       #   Vedeu.renders do
       #     view 'my_interface' do
       #       line do
       #         streams do
-      #           # ...
+      #           # ... some code
       #         end
       #
       #         stream do
-      #           # ...
+      #           # ... some code
       #         end
       #       end
       #     end
       #   end
       #
+      # @param block [Proc]
       # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Streams<Vedeu::Stream>]
       # @see Vedeu::DSL::Stream for subdirectives.

data/lib/vedeu/dsl/menu.rb

@@ -5,7 +5,6 @@ module Vedeu
     # Provides the mechanism to create menus within client applications and use
     # events to drive them.
     #
-    # @api public
     class Menu
 
       include Vedeu::DSL
@@ -24,8 +23,7 @@ module Vedeu
       #
       # @param element [Object] An object you wish to add to the collection.
       #
-      # @example
-      #   menu 'my_menu' do
+      #   Vedeu.menu 'my_menu' do
       #     item SomeClass.new
       #     item SomeClass.new
       #   end
@@ -41,18 +39,16 @@ module Vedeu
       # In the 'my_playlist' example below, your `Track` model may return a
       # collection of tracks to populate the menu.
       #
-      # @param collection [Array<Object>] A collection of objects which make up
-      #   the menu items.
-      #
-      # @example
-      #   menu 'my_menu' do
+      #   Vedeu.menu 'my_menu' do
       #     items [:item_1, :item_2, :item_3]
       #   end
       #
-      #   menu 'my_playlist' do
+      #   Vedeu.menu 'my_playlist' do
       #     items Track.all_my_favourites
       #   end
       #
+      # @param collection [Array<Object>] A collection of objects which make up
+      #   the menu items.
       # @return [Array]
       def items(collection = [])
         model.collection = collection
@@ -61,14 +57,12 @@ module Vedeu
       # The name of the menu. Used to reference the menu throughout your
       # application's execution lifetime.
       #
-      # @param value [String]
-      #
-      # @example
-      #   menu do
+      #   Vedeu.menu do
       #     name 'my_menu'
       #     # ...
       #   end
       #
+      # @param value [String]
       # @return [String]
       def name(value)
         model.name = value

data/lib/vedeu/dsl/presentation.rb

@@ -5,7 +5,6 @@ module Vedeu
     # Provides colour and style helpers for use in the {Vedeu::DSL::Interface},
     # {Vedeu::DSL::Line} and {Vedeu::DSL::Stream} classes.
     #
-    # @api public
     module Presentation
 
       # Define the background colour for an interface, line, or a stream. When

data/lib/vedeu/dsl/stream.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # Provides methods to be used to define views.
     #
-    # @api public
     class Stream
 
       include Vedeu::DSL

data/lib/vedeu/dsl/text.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # Provides helper methods for building views.
     #
-    # @api public
     module Text
 
       # Specify the content for a view. Provides the means to align a string

data/lib/vedeu/dsl/use.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # Provides helper methods for building views.
     #
-    # @api public
     module Use
 
       # Duplicate a stored model.

data/lib/vedeu/dsl/view.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # DSL for creating views.
     #
-    # @api public
     class View
 
       class << self
@@ -13,25 +12,22 @@ module Vedeu
         # or command. This provides the means for you to define your the views
         # of your application without their content.
         #
-        # @todo More documentation required.
-        #
-        # @param name [String] The name of the interface. Used to reference the
-        #   interface throughout your application's execution lifetime.
-        # @param block [Proc] A set of attributes which define the features of
-        #   the interface.
-        #
-        # @example
         #   Vedeu.interface 'my_interface' do
-        #     # ...
+        #     # ... some code
         #   end
         #
         #   Vedeu.interface do
         #     name 'interfaces_must_have_a_name'
-        #     # ...
+        #     # ... some code
         #   end
         #
+        # @param name [String] The name of the interface. Used to reference the
+        #   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.
         # @return [Vedeu::Interface]
+        # @todo More documentation required.
         def interface(name = '', &block)
           fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
@@ -40,22 +36,26 @@ module Vedeu
           Vedeu::Interface.build(attributes, &block).store
         end
 
-        # Immediate render
-        #
         # Directly write a view buffer to the terminal. Using this method means
         # that the refresh event does not need to be triggered after creating
         # the views, though can be later triggered if needed.
         #
-        # @param block [Proc] The directives you wish to send to render.
-        #   Typically includes `view` with associated sub-directives.
-        #
-        # @example
         #   Vedeu.renders do
         #     view 'my_interface' do
-        #       # ...
+        #       # ... some code
         #     end
         #   end
         #
+        #   # or...
+        #
+        #   Vedeu.render do
+        #     view 'my_interface' do
+        #       # ... some code
+        #     end
+        #   end
+        #
+        # @param block [Proc] The directives you wish to send to render.
+        #   Typically includes `view` with associated sub-directives.
         # @raise [Vedeu::InvalidSyntax] The required block was not given.
         # @return [Array<Interface>]
         def render(&block)
@@ -65,20 +65,14 @@ module Vedeu
         end
         alias_method :renders, :render
 
-        # Deferred view
-        #
         # Define a view (content) for an interface.
         #
-        # @note The views declared within this block are stored in their
-        #   respective interface back buffers until a refresh event occurs. When
-        #   the refresh event is triggered, the back buffers are swapped into
-        #   the front buffers and the content here will be rendered to
-        #   {Vedeu::Terminal.output}.
+        # The views declared within this block are stored in their respective
+        # interface back buffers until a refresh event occurs. When the refresh
+        # event is triggered, the back buffers are swapped into the front
+        # buffers and the content here will be rendered to
+        # {Vedeu::Terminal.output}.
         #
-        # @param block [Proc] The directives you wish to send to render.
-        #   Typically includes `view` with associated sub-directives.
-        #
-        # @example
         #   Vedeu.views do
         #     view 'my_interface' do
         #       # ... some attributes ...
@@ -86,16 +80,19 @@ module Vedeu
         #     view 'my_other_interface' do
         #       # ... some other attributes ...
         #     end
-        #     # ...
+        #     # ... some code
         #   end
         #
+        # @param block [Proc] The directives you wish to send to render.
+        #   Typically includes `view` with associated sub-directives.
         # @raise [Vedeu::InvalidSyntax] The required block was not given.
         # @return [Array<Interface>]
-        def views(&block)
+        def view(&block)
           fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
           store(:store_deferred, &block)
         end
+        alias_method :views, :view
 
         private
 

data/lib/vedeu/events/event.rb

@@ -1,5 +1,3 @@
-require 'vedeu/events/trigger'
-
 module Vedeu
 
   # Contains all the logic of an event. Handles debouncing and throttling.
@@ -30,7 +28,6 @@ module Vedeu
   #       :do_stuff
   #     end
   #
-  # @api public
   class Event
 
     include Vedeu::Model

data/lib/vedeu/events/events.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Allows the storing of events.
   #
-  # @api public
   class Events < Vedeu::Repository
 
     class << self

data/lib/vedeu/events/trigger.rb

@@ -8,7 +8,6 @@ module Vedeu
   # @example
   #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
   #
-  # @api public
   class Trigger
 
     # @param name [Symbol] The name of the event you wish to trigger. The event

data/lib/vedeu/geometry/geometries.rb

@@ -1,12 +1,8 @@
-require 'vedeu/null/geometry'
-require 'vedeu/geometry/geometry'
-
 module Vedeu
 
   # Allows the storing of interface/view geometry independent of the interface
   # instance.
   #
-  # @api public
   class Geometries < Vedeu::Repository
 
     class << self

data/lib/vedeu/geometry/geometry.rb

@@ -1,5 +1,3 @@
-require 'vedeu/repositories/model'
-
 module Vedeu
 
   # @todo Consider storing the Terminal size at the time of first creation,

data/lib/vedeu/geometry/grid.rb

@@ -5,7 +5,6 @@ module Vedeu
   # width is not a multiple of 12, then Grid chooses the maximum value which
   # will fit.
   #
-  # @api public
   class Grid
 
     # @see #initialize
@@ -28,18 +27,7 @@ module Vedeu
       @value = value
     end
 
-    # Returns the width in characters for the number of columns specified.
-    #
-    # @example
-    #  Vedeu.geometry 'main_interface' do
-    #    width: columns(9) # Vedeu.width # => 92 (for example)
-    #                      # 92 / 12 = 7
-    #                      # 7 * 9 = 63
-    #                      # Therefore, width is 63 characters.
-    #
-    # @raise [Vedeu::OutOfRange] When the value parameter is not between 1 and
-    #   12 inclusive.
-    # @return [Fixnum|Vedeu::OutOfRange]
+    # @see Vedeu::DSL::Geometry#columns
     def columns
       fail Vedeu::OutOfRange,
            'Valid value between 1 and 12 inclusive.' if out_of_range?
@@ -47,18 +35,7 @@ module Vedeu
       column * value
     end
 
-    # Returns the height in characters for the number of rows specified.
-    #
-    # @example
-    #  Vedeu.geometry 'main_interface' do
-    #    height: rows(3) # Vedeu.height # => 38 (for example)
-    #                    # 38 / 12 = 3
-    #                    # 3 * 3 = 9
-    #                    # Therefore, height is 9 characters.
-    #
-    # @raise [Vedeu::OutOfRange] When the value parameter is not between 1 and
-    #   12 inclusive.
-    # @return [Fixnum|Vedeu::OutOfRange]
+    # @see Vedeu::DSL::Geometry#rows
     def rows
       fail Vedeu::OutOfRange,
            'Valid value between 1 and 12 inclusive.' if out_of_range?

data/lib/vedeu/input/keymap.rb

@@ -1,6 +1,3 @@
-require 'vedeu/input/key'
-require 'vedeu/dsl/keymap'
-
 module Vedeu
 
   # A container class for keys associated with a particular interface.

data/lib/vedeu/input/keymaps.rb

@@ -1,10 +1,7 @@
-require 'vedeu/input/keymap'
-
 module Vedeu
 
   # Allows the storing of keymaps.
   #
-  # @api public
   class Keymaps < Vedeu::Repository
 
     class << self

data/lib/vedeu/launcher.rb

@@ -5,7 +5,6 @@ module Vedeu
   # the starting of the application, the handling of uncaught exceptions and
   # finally the exiting of the application with the correct exit code.
   #
-  # @api public
   class Launcher
 
     # @!attribute [r] exit_code

data/lib/vedeu/log.rb

@@ -77,7 +77,6 @@ module Vedeu
 
   # Provides the ability to log anything to the Vedeu log file.
   #
-  # @api public
   class Log
 
     class << self

data/lib/vedeu/models/char.rb

@@ -1,8 +1,3 @@
-require 'vedeu/geometry/position'
-require 'vedeu/output/esc'
-require 'vedeu/output/html_char'
-require 'vedeu/output/presentation'
-
 module Vedeu
 
   # A Char represents a single character of the terminal. It is a container for

data/lib/vedeu/models/group.rb

@@ -1,5 +1,3 @@
-require 'vedeu/models/toggleable'
-
 module Vedeu
 
   # Interfaces can be associated with one another by being members of the same

data/lib/vedeu/models/groups.rb

@@ -1,10 +1,7 @@
-require 'vedeu/models/group'
-
 module Vedeu
 
   # Allows the storing of view groups.
   #
-  # @api public
   class Groups < Vedeu::Repository
 
     class << self

data/lib/vedeu/models/interface.rb

@@ -1,9 +1,3 @@
-require 'vedeu/models/char'
-require 'vedeu/models/stream'
-require 'vedeu/models/line'
-require 'vedeu/buffers/display_buffer'
-require 'vedeu/models/toggleable'
-
 module Vedeu
 
   # An Interface represents a portion of the terminal defined by
@@ -165,19 +159,6 @@ module Vedeu
       store_group
     end
 
-    # Toggle the named interface buffer, or without a name, the buffer of the
-    # currently focussed interface.
-    #
-    # @example
-    #   Vedeu.toggle_interface(name)
-    #
-    # @return [void]
-    def toggle
-      super
-
-      Vedeu.buffers.by_name(name).toggle
-    end
-
     private
 
     # The default values for a new instance of this class.