vedeu 0.6.20 → 0.6.21

data/lib/vedeu/borders/border.rb

@@ -104,8 +104,8 @@ module Vedeu
       #   border is to be shown for this interface.
       # @option attributes horizontal [String] The horizontal border
       #   character.
-      # @option attributes name [String] The name of the interface to
-      #   which this border relates.
+      # @option attributes name [String|Symbol] The name of the
+      #   interface to which this border relates.
       # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes show_bottom [Boolean] Indicate whether the
       #   bottom border is to be shown.

data/lib/vedeu/borders/dsl.rb

@@ -12,12 +12,12 @@ module Vedeu
 
       # Specify the border of an interface or view with a simple DSL.
       #
-      #   Vedeu.border 'some_interface' do
+      #   Vedeu.border :some_interface do
       #     # ...
       #   end
       #
-      # @param name [String] The name of the interface or view to
-      #   which this border belongs.
+      # @param name [String|Symbol] The name of the interface or view
+      #   to which this border belongs.
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Borders::Border]
@@ -27,20 +27,10 @@ module Vedeu
         Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
       end
 
-      # Returns an instance of Borders::DSL.
-      #
-      # @param model [Vedeu::Borders::Border]
-      # @param client [Object]
-      # @return [Vedeu::Borders::DSL]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Set the character to be used to draw the bottom left corner of
       # the border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     bottom_left '+'
       #     # ... some code
       #   end
@@ -56,7 +46,7 @@ module Vedeu
       # Set the character to be used to draw the bottom right corner
       # of the border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     bottom_right '+'
       #     # ... some code
       #   end
@@ -71,7 +61,7 @@ module Vedeu
 
       # Disable the border:
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     disable!
       #     # ... some other code (will be ignored)
       #   end
@@ -92,7 +82,7 @@ module Vedeu
       # (Borders are enabled by default when defined for an
       # interface).
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     enable!
       #     # ... some code
       #   end
@@ -112,7 +102,7 @@ module Vedeu
       # Set the character to be used to draw a horizontal part of the
       # border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     horizontal '-'
       #     # ... some code
       #   end
@@ -127,7 +117,7 @@ module Vedeu
 
       # Enable/disable the bottom border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     bottom true  # or...
       #     bottom false # or...
       #     hide_bottom! # or...
@@ -162,7 +152,7 @@ module Vedeu
 
       # Enable/disable the left border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     left true  # or...
       #     left false # or...
       #     hide_left! # or...
@@ -197,7 +187,7 @@ module Vedeu
 
       # Enable/disable the right border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     right true  # or...
       #     right false # or...
       #     hide_right! # or...
@@ -233,7 +223,7 @@ module Vedeu
       # If you have you are showing a top border, you could add a
       # title.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     title 'My Cool Title'
       #     # ... some code
       #   end
@@ -252,7 +242,7 @@ module Vedeu
       # If you have you are showing a bottom border, you could add a
       # caption.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     caption 'My Cool Caption'
       #     # ... some code
       #   end
@@ -270,7 +260,7 @@ module Vedeu
 
       # Enable/disable the top border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     top true  # or...
       #     top false # or...
       #     hide_top! # or...
@@ -306,7 +296,7 @@ module Vedeu
       # Set the character to be used to draw the top left corner of
       # the border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     top_left '+'
       #     # ... some code
       #   end
@@ -322,7 +312,7 @@ module Vedeu
       # Set the character to be used to draw the top right corner of
       # the border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     top_right '+'
       #     # ... some code
       #   end
@@ -338,7 +328,7 @@ module Vedeu
       # Set the character to be used to draw a vertical part of the
       # border.
       #
-      #   Vedeu.border 'border_demo' do
+      #   Vedeu.border :border_demo do
       #     vertical '|'
       #     # ... some code
       #   end
@@ -355,4 +345,8 @@ module Vedeu
 
   end # DSL
 
+  # @!method border
+  #   @see Vedeu::Borders::DSL.border
+  def_delegators Vedeu::Borders::DSL, :border
+
 end # Vedeu

data/lib/vedeu/borders/null.rb

@@ -8,13 +8,13 @@ module Vedeu
     class Null
 
       # @!attribute [r] name
-      # @return [String|NilClass]
+      # @return [String|Symbol|NilClass]
       attr_reader :name
 
       # Returns a new instance of Vedeu::Borders::Null.
       #
       # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|NilClass]
+      # @option attributes name [String|Symbol|NilClass]
       # @return [Vedeu::Borders::Null]
       def initialize(attributes = {})
         @attributes = attributes
@@ -45,24 +45,11 @@ module Vedeu
       end
       alias_method :yn, :byn
 
-      # The null border should not be enabled, so that named geometry
-      # or null geometry is used.
-      #
-      # @return [FalseClass]
-      def enabled?
-        false
-      end
-
       # @return [Fixnum]
       def height
         (by..byn).size
       end
 
-      # @return [Boolean]
-      def null?
-        true
-      end
-
       # @return [Array]
       def render
         []

data/lib/vedeu/borders/render.rb

@@ -40,7 +40,7 @@ module Vedeu
                      :yn
 
       # @return [Array<Array<Vedeu::Views::Char>>]
-      # @see Vedeu::Borders::Render#initialize
+      # @param (see #initialize)
       def self.with(border)
         new(border).render
       end

data/lib/vedeu/borders/repository.rb

@@ -16,4 +16,13 @@ module Vedeu
 
   end # Borders
 
+  # Manipulate the repository of borders.
+  #
+  # @example
+  #   Vedeu.borders
+  #
+  # @!method borders
+  # @return [Vedeu::Borders::Repository]
+  def_delegators Vedeu::Borders::Repository, :borders
+
 end # Vedeu

data/lib/vedeu/buffers/buffer.rb

@@ -37,8 +37,8 @@ module Vedeu
       # Return a new instance of Buffer. Generally a Buffer is
       # initialized with only a 'name' and 'back' parameter.
       #
-      # @option attributes name [String] The name of the interface for
-      #   which the buffer belongs.
+      # @option attributes name [String|Symbol] The name of the
+      #   interface for which the buffer belongs.
       # @option attributes back [Vedeu::Views::View]
       # @option attributes front [Vedeu::Views::View]
       # @option attributes previous [Vedeu::Views::View]

data/lib/vedeu/buffers/null.rb

@@ -5,37 +5,7 @@ module Vedeu
     # Provides a non-existent Vedeu::Buffers::Buffer that acts like
     # the real thing, but does nothing.
     #
-    class Null
-
-      # @!attribute [r] name
-      # @return [String]
-      attr_reader :name
-
-      # Returns a new instance of Vedeu::Buffers::Null.
-      #
-      # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|NilClass]
-      # @return [Vedeu::Buffers::Null]
-      def initialize(attributes = {})
-        @attributes = attributes
-        @name       = @attributes[:name]
-      end
-
-      # @return [NilClass]
-      def null(*)
-        nil
-      end
-      alias_method :add, :null
-      alias_method :clear, :null
-      alias_method :hide, :null
-      alias_method :render, :null
-      alias_method :show, :null
-      alias_method :toggle, :null
-
-      # @return [Boolean]
-      def null?
-        true
-      end
+    class Null < Vedeu::Null::Generic
 
     end # Null
 

data/lib/vedeu/buffers/refresh.rb

@@ -11,22 +11,22 @@ module Vedeu
 
       include Vedeu::Common
 
-      # @param name [String] The name of the interface to be refreshed
-      #   using the named buffer.
-      # @return [Array|Vedeu::Error::ModelNotFound]
+      # @param (see #initialize)
+      # @return (see #by_name)
       def self.by_name(name)
         new(name).by_name
       end
 
       # Return a new instance of Vedeu::Buffers::Refresh.
       #
-      # @param name [String]
+      # @param name [String|Symbol] The name of the interface to be refreshed
+      #   using the named buffer.
       # @return [Vedeu::Buffers::Refresh]
       def initialize(name)
         @name = name
       end
 
-      # @return [void]
+      # @return [Array|Vedeu::Error::ModelNotFound]
       def by_name
         Vedeu.timer("Refresh Buffer: '#{buffer_name}'") do
           Vedeu.buffers.by_name(buffer_name).render
@@ -35,15 +35,15 @@ module Vedeu
 
       protected
 
-      # # @!attribute [r] name
-      # @return [String]
+      # @!attribute [r] name
+      # @return [String|Symbol]
       attr_reader :name
 
       private
 
       # @raise [Vedeu::Error::MissingRequired] When the name is empty
       #   or nil.
-      # @return [String]
+      # @return [String|Symbol]
       def buffer_name
         return name if present?(name)
 

data/lib/vedeu/buffers/repository.rb

@@ -21,4 +21,13 @@ module Vedeu
 
   end # Buffers
 
+  # Manipulate the repository of buffers.
+  #
+  # @example
+  #   Vedeu.buffers
+  #
+  # @!method buffers
+  # @return [Vedeu::Buffers::Repository]
+  def_delegators Vedeu::Buffers::Repository, :buffers
+
 end # Vedeu

data/lib/vedeu/colours/backgrounds.rb

@@ -6,6 +6,11 @@ module Vedeu
     #
     class Backgrounds < Vedeu::Colours::Repository
 
+      # Manipulate the repository of background colours.
+      #
+      # @example
+      #   Vedeu.background_colours
+      #
       # @return [Vedeu::Colours::Backgrounds]
       # @see Vedeu::Repositories::Repository
       def self.background_colours
@@ -16,4 +21,8 @@ module Vedeu
 
   end # Colours
 
+  # @!method background_colours
+  # @return [Vedeu::Colours::Backgrounds]
+  def_delegators Vedeu::Colours::Backgrounds, :background_colours
+
 end # Vedeu

data/lib/vedeu/colours/colour.rb

@@ -46,7 +46,7 @@ module Vedeu
       attr_reader :foreground
 
       # @param value [Vedeu::Colours::Colour|Hash<Symbol => void>]
-      # @return [Object]
+      # @return [Vedeu::Colours::Colour]
       def self.coerce(value)
         return value if value.is_a?(self)
         return new unless value.is_a?(Hash)

data/lib/vedeu/colours/foregrounds.rb

@@ -6,6 +6,11 @@ module Vedeu
     #
     class Foregrounds < Vedeu::Colours::Repository
 
+      # Manipulate the repository of foreground colours.
+      #
+      # @example
+      #   Vedeu.foreground_colours
+      #
       # @return [Vedeu::Colours::Foregrounds]
       # @see Vedeu::Repositories::Repository
       def self.foreground_colours
@@ -16,4 +21,8 @@ module Vedeu
 
   end # Colours
 
+  # @!method foreground_colours
+  # @return [Vedeu::Colours::Foregrounds]
+  def_delegators Vedeu::Colours::Foregrounds, :foreground_colours
+
 end # Vedeu

data/lib/vedeu/common.rb

@@ -4,6 +4,15 @@ module Vedeu
   #
   module Common
 
+    # Returns a boolean indicating whether a variable is nil or empty.
+    #
+    # @param variable [String|Symbol|Array|Fixnum] The variable to
+    #   check.
+    # @return [Boolean]
+    def absent?(variable)
+      !present?(variable)
+    end
+
     # Removes the module part from the expression in the string.
     #
     # @example
@@ -17,6 +26,19 @@ module Vedeu
       klass[(klass.rindex('::') + 2)..-1]
     end
 
+    # Returns a boolean indicating whether a variable has a useful
+    # value.
+    #
+    # @param variable [String|Symbol|Array|Fixnum] The variable to
+    #   check.
+    # @return [Boolean]
+    def present?(variable)
+      return true if variable.is_a?(Fixnum)
+      return true unless variable.nil? || variable.empty?
+
+      false
+    end
+
     # Converts a class name to a lowercase snake case string.
     #
     # @example
@@ -35,19 +57,6 @@ module Vedeu
       name
     end
 
-    # Returns a boolean indicating whether a variable has a useful
-    # value.
-    #
-    # @param variable [String|Symbol|Array|Fixnum] The variable to
-    #   check.
-    # @return [Boolean]
-    def present?(variable)
-      return true if variable.is_a?(Fixnum)
-      return true unless variable.nil? || variable.empty?
-
-      false
-    end
-
   end # Common
 
 end # Vedeu