vedeu 0.8.15 → 0.8.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7873b236437abf97edd687af67588fd80c87b3e9
-  data.tar.gz: 4c2646bd4fb5366960fb0fef677d96aa929db230
+  metadata.gz: 805fd2db1418da4e71a147f7e0c3abffe83cbca0
+  data.tar.gz: 5ae3a8f1f58bbce6b6581063d766f8b67cb87925
 SHA512:
-  metadata.gz: 1538cf094b528f976340e281c7cab189cf42e5190a662dff3d2b0ce61aa8990f26b05c7059c4ea29a19fa7ef830d362008a448d78160d9fb3e4dce44ef46527f
-  data.tar.gz: 74dabd2d4fbd0aef2512601a521a105644d227d482be6a31ca3f0a6ef270e8ba6749f518141b54f35470c2c96313a36ba89b8395bb36ac1893e0cbed8a7b09e0
+  metadata.gz: 8b85555d260e7e07638b1239abb46f97c99929539f8bac9efebe7b4239c72d47bc3941012826595806bf5b195e6a6421a5cd85b20affdc89f443ba68608c69c0
+  data.tar.gz: c8906b96488c8158013fd89a5f5faa4a7f77c8978a199e994f059de9735b341e35d19647c810af8a98a861c745146c46dbcc101543444c96948c17e401a0b326

data/docs/dsl/by_method/clear_by_group.md

@@ -1,2 +1,5 @@
 ### Vedeu.clear_by_group
-@todo Add more documentation.
+Clears the group of interfaces belonging to the given name.
+
+    Vedeu.trigger(:_clear_group_, name)
+    Vedeu.clear_by_group(name)

data/docs/dsl/by_method/clear_by_name.md

@@ -1,2 +1,5 @@
 ### Vedeu.clear_by_name
-@todo Add more documentation.
+Clear the interface with the given name.
+
+    Vedeu.trigger(:_clear_view_, name)
+    Vedeu.clear_by_name(name)

data/docs/dsl/by_method/clear_content_by_name.md

@@ -1,2 +1,5 @@
 ### Vedeu.clear_content_by_name
-@todo Add more documentation.
+Clear the content of the interface with the given name.
+
+    Vedeu.trigger(:_clear_view_content_, name)
+    Vedeu.clear_content_by_name(name)

data/docs/dsl/by_method/documents.md

@@ -1,2 +1,6 @@
 ### Vedeu.documents
-@todo Add more documentation.
+Repository method. Access registered documents.
+
+    Vedeu.documents # [Vedeu::Editor::Repository]
+
+    Vedeu.documents.all # [Array<Vedeu::Editor::Border>]

data/docs/dsl/by_method/geometry/align.md

@@ -3,11 +3,57 @@ terminal.
 
 An error will be raised if:
 
-- When the vertical is not given.
-- When the horizontal is not given.
-- When the horizontal is given (and not :none) and the width is not
-  given.
-- When the vertical is given (and not :none) and the height is not
-  given.
-
-@todo Add more documentation.
+- When the vertical argument is not given.
+- When the horizontal argument is not given.
+- When the horizontal argument is given (and not :none) and the width
+  argument is not given.
+- When the vertical argument is given (and not :none) and the height
+  argument is not given.
+
+Aligning the view with the bottom of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align vertical: :bottom
+
+        # ...
+    # end
+
+Aligning the view in the centre (horizontally) of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align horizontal: :centre
+
+        # ...
+    # end
+
+Aligning the view with the left of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align horizontal: :left
+
+        # ...
+    # end
+
+Aligning the view in the middle (vertically) of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align vertical: :middle
+
+        # ...
+    # end
+
+Aligning the view with the right of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align horizontal: :right
+
+        # ...
+    # end
+
+Aligning the view with the top of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align vertical: :top
+
+        # ...
+    # end

data/examples/dsl_alignment.rb

@@ -23,7 +23,7 @@ class AlignmentApp
       title 'Top Left'
     end
     geometry do
-      align(:top, :left, 20, 4)
+      align vertical: :top, horizontal: :left, width: 20, height: 4
     end
   end
 
@@ -32,7 +32,7 @@ class AlignmentApp
       title 'Top Centre'
     end
     geometry do
-      align(:top, :centre, 20, 4)
+      align vertical: :top, horizontal: :centre, width: 20, height: 4
     end
   end
 
@@ -41,7 +41,7 @@ class AlignmentApp
       title 'Top Right'
     end
     geometry do
-      align(:top, :right, 20, 4)
+      align vertical: :top, horizontal: :right, width: 20, height: 4
     end
   end
 
@@ -50,7 +50,7 @@ class AlignmentApp
       title 'Middle Left'
     end
     geometry do
-      align(:middle, :left, 20, 4)
+      align vertical: :middle, horizontal: :left, width: 20, height: 4
     end
   end
 
@@ -59,7 +59,7 @@ class AlignmentApp
       title 'Middle Centre'
     end
     geometry do
-      align(:middle, :centre, 20, 4)
+      align vertical: :middle, horizontal: :centre, width: 20, height: 4
     end
   end
 
@@ -68,7 +68,7 @@ class AlignmentApp
       title 'Middle Right'
     end
     geometry do
-      align(:middle, :right, 20, 4)
+      align vertical: :middle, horizontal: :right, width: 20, height: 4
     end
   end
 
@@ -77,7 +77,7 @@ class AlignmentApp
       title 'Bottom Left'
     end
     geometry do
-      align(:bottom, :left, 20, 4)
+      align vertical: :bottom, horizontal: :left, width: 20, height: 4
     end
   end
 
@@ -86,7 +86,7 @@ class AlignmentApp
       title 'Bottom Centre'
     end
     geometry do
-      align(:bottom, :centre, 20, 4)
+      align vertical: :bottom, horizontal: :centre, width: 20, height: 4
     end
   end
 
@@ -95,7 +95,7 @@ class AlignmentApp
       title 'Bottom Right'
     end
     geometry do
-      align(:bottom, :right, 20, 4)
+      align vertical: :bottom, horizontal: :right, width: 20, height: 4
     end
   end
 

data/examples/dsl_colours.rb

@@ -25,7 +25,7 @@ class ColoursApp
       title 'Interface Colours'
     end
     geometry do
-      align(:top, :left, 50, 20)
+      align vertical: :top, horizontal: :left, width: 50, height: 20
     end
   end
 

data/examples/dsl_editor.rb

@@ -23,7 +23,7 @@ class EditorApp
     end
     editable!
     geometry do
-      align(:top, :left, 40, 8)
+      align vertical: :top, horizontal: :left, width: 40, height: 8
     end
   end
 

data/examples/dsl_hello_worlds.rb

@@ -31,7 +31,7 @@ class HelloWorldsApp
     background '#000000'
     foreground '#00ff00'
     geometry do
-      align(:middle, :centre, 24, 5)
+      align vertical: :middle, horizontal: :centre, width: 24, height: 5
     end
     keymap do
       key('q') { Vedeu.exit }
@@ -61,7 +61,7 @@ class HelloWorldsApp
     Vedeu.render do
       view :hello do
         geometry do
-          align(:middle, :centre, (24 + 2), (5 + 2))
+          align vertical: :middle, horizontal: :centre, width: (24 + 2), height: (5 + 2)
         end
         border do
           colour foreground: ["#00ff00", "#000033", "#cddc39", "#03a9f4"].sample

data/lib/vedeu.rb

@@ -55,7 +55,7 @@ end # Vedeu
 #   Provide additional behaviour to a class or module.
 #
 #   @param klass [Class]
-#   @return [void]
+#   @return [Class] Returns the klass parameter.
 #
 # @!macro [new] module_instance_methods
 #   Provide additional behaviour as instance methods to the including
@@ -65,5 +65,11 @@ end # Vedeu
 #   Provide additional behaviour as singleton methods to the including
 #   class or module.
 #
+# @!macro [new] param_name
+#   @param name [NilClass|Symbol|String] The name of the model or
+#     target model to act upon. May default to `Vedeu.focus`.
+#
+# @!macro [new] return_name
+#   @return [NilClass|Symbol|String]
 
 require 'vedeu/all'

data/lib/vedeu/borders/dsl.rb

@@ -14,8 +14,7 @@ module Vedeu
       include Vedeu::DSL::Use
 
       # {include:file:docs/dsl/by_method/border.md}
-      # @param name [String|Symbol] The name of the interface or view
-      #   to which this border belongs.
+      # @macro param_name
       # @param block [Proc]
       # @macro raise_requires_block
       # @macro raise_missing_required

data/lib/vedeu/borders/refresh.rb

@@ -62,8 +62,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Borders::Refresh.
       #
-      # @param name [String|Symbol] The name of the interface/view
-      #   border to be refreshed. Defaults to `Vedeu.focus`.
+      # @macro param_name
       # @return [Vedeu::Borders::Refresh]
       def initialize(name = Vedeu.focus)
         @name = present?(name) ? name : Vedeu.focus

data/lib/vedeu/borders/title.rb

@@ -24,7 +24,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Borders::Title or
       # Vedeu::Borders::Caption.
       #
-      # @param name [String|Symbol]
+      # @macro param_name
       # @param value [String|Vedeu::Borders::Title|
       # @param horizontal [Array<Vedeu::Cells::Horizontal>]
       #   Vedeu::Borders::Caption]

data/lib/vedeu/buffers/refresh.rb

@@ -30,8 +30,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Buffers::Refresh.
       #
-      # @param name [String|Symbol] The name of the interface/view to
-      #   be refreshed. Defaults to `Vedeu.focus`.
+      # @macro param_name
       # @param options [Hash<Symbol => Boolean>]
       # @option options content_only [Boolean]
       # @return [Vedeu::Buffers::Refresh]

data/lib/vedeu/cells/support/html.rb

@@ -30,7 +30,7 @@ module Vedeu
       protected
 
       # @!attribute [r] cell
-      # @return [void]
+      # @return [Vedeu::Cells]
       attr_reader :cell
 
       # @!attribute [r] options

data/lib/vedeu/coercers/chars.rb

@@ -11,7 +11,7 @@ module Vedeu
     #
     class Chars < Vedeu::Coercers::Coercer
 
-      # @return [void]
+      # @return [Vedeu::Views::Chars]
       def coerce
       end
 

data/lib/vedeu/coercers/coercer.rb

@@ -28,7 +28,6 @@ module Vedeu
       end
 
       # @macro raise_not_implemented
-      # @return [void]
       def coerce
         raise Vedeu::Error::NotImplemented, 'Subclasses implement this.'
       end
@@ -47,14 +46,12 @@ module Vedeu
       end
 
       # @macro raise_fatal
-      # @return [void]
       def incoercible!
         raise Vedeu::Error::Fatal,
               "Vedeu cannot coerce a '#{value.class.name}' into a '#{klass}'."
       end
 
       # @macro raise_not_implemented
-      # @return [Class]
       def klass
         raise Vedeu::Error::NotImplemented, 'Subclasses implement this.'
       end

data/lib/vedeu/coercers/colour.rb

@@ -12,7 +12,7 @@ module Vedeu
     class Colour < Vedeu::Coercers::Coercer
 
       # @macro raise_fatal
-      # @return [void]
+      # @return [Vedeu::Colours::Colour]
       def coerce
         if coerced?
           value

data/lib/vedeu/coercers/editor_line.rb

@@ -11,7 +11,7 @@ module Vedeu
     #
     class EditorLine < Vedeu::Coercers::Coercer
 
-      # @return [void]
+      # @return [Vedeu::Editor::Line]
       def coerce
         if coerced?
           value

data/lib/vedeu/coercers/lines.rb

@@ -12,7 +12,7 @@ module Vedeu
     class Lines < Vedeu::Coercers::Coercer
 
       # @macro raise_fatal
-      # @return [void]
+      # @return [Vedeu::Views::Lines]
       def coerce
         if coerced?
           value

data/lib/vedeu/colours/backgrounds.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Store background colour escape sequences by HTML/CSS code.
     #
+    # @api private
+    #
     class Backgrounds < Vedeu::Colours::Repository
 
       # {include:file:docs/dsl/by_method/background_colours.md}

data/lib/vedeu/colours/foregrounds.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Store foreground colour escape sequences by HTML/CSS code.
     #
+    # @api private
+    #
     class Foregrounds < Vedeu::Colours::Repository
 
       # {include:file:docs/dsl/by_method/foreground_colours.md}

data/lib/vedeu/cursors/move.rb

@@ -22,7 +22,7 @@ module Vedeu
         new(name, direction, offset).move
       end
 
-      # @param name [String|Symbol]
+      # @macro param_name
       # @param direction [Symbol]
       # @param offset [Fixnum]
       # @return [Vedeu::Cursors::Move]

data/lib/vedeu/cursors/refresh.rb

@@ -39,8 +39,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Cursors::Refresh.
       #
-      # @param name [String|Symbol] The name of the interface/view
-      #   cursor to be refreshed. Defaults to `Vedeu.focus`.
+      # @macro param_name
       # @return [Vedeu::Cursors::Refresh]
       def initialize(name)
         @name = name

data/lib/vedeu/dsl/border.rb

@@ -32,10 +32,7 @@ module Vedeu
         #     end
         #   end
         #
-        # @param name [String|Symbol] 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::DSL::Border::SingletonMethods.border}.
+        # @macro param_name
         # @param block [Proc]
         # @macro raise_requires_block
         # @macro raise_missing_required

data/lib/vedeu/dsl/geometry.rb

@@ -14,8 +14,7 @@ module Vedeu
       module SingletonMethods
 
         # {include:file:docs/dsl/by_method/geometry.md}
-        # @param name [String|Symbol] The name of the interface or
-        #   view to which this geometry belongs.
+        # @macro param_name
         # @param block [Proc]
         # @macro raise_requires_block
         # @macro raise_missing_required
@@ -46,10 +45,7 @@ module Vedeu
       module InstanceMethods
 
         # {include:file:docs/dsl/by_method/geometry.md}
-        # @param name [String|Symbol] 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::DSL::Geometry::SingletonMethods#geometry}.
+        # @macro param_name
         # @param block [Proc]
         # @macro raise_requires_block
         # @macro raise_missing_required

data/lib/vedeu/dsl/use.rb

@@ -29,8 +29,7 @@ module Vedeu
       #     exception may be raised, or the request for an attribute
       #     may raise a NoMethodError exception.
       #
-      # @param name [String|Symbol] The name of the model with the
-      #   value you wish to use.
+      # @macro param_name
       # @raise
       #   [Vedeu::Error::ModelNotFound|Vedeu::Error::NoMethodError]
       #   The model or attribute cannot be found.