vedeu 0.8.20 → 0.8.21

data/integrations/test_runner.rb

@@ -7,21 +7,21 @@ class TestRunner
 
   # @param (see #initialize)
   # @return [void]
-  def self.result(testcase, file)
-    new(testcase, file).result
+  def self.result(testcase, filename)
+    new(testcase, filename).result
   end
 
   # @param testcase [String]
-  # @param file [String]
+  # @param filename [String]
   # @return [TestRunner]
-  def initialize(testcase, file)
+  def initialize(testcase, filename)
     @testcase = testcase
-    @file     = file
+    @filename     = filename
   end
 
   # @return [void]
   def result
-    print "\e[36m#{file}: "
+    print "\e[36m#{filename}: "
     if expected == actual
       print "\e[32mPassed.\e[39m\n"
       exit 0;
@@ -41,20 +41,30 @@ class TestRunner
   # @return [String]
   attr_reader :testcase
 
-  # @!attribute [r] file
+  # @!attribute [r] filename
   # @return [String]
-  attr_reader :file
+  attr_reader :filename
 
   private
 
   # @return [String]
   def actual
-    File.read("/tmp/#{testcase}.out")
+    @_actual ||= File.read(actual_path)
   end
 
   # @return [String]
   def expected
-    File.read(File.expand_path("../expected/#{testcase}.out", file))
+    @_expected ||= File.read(File.expand_path(expected_path, filename))
+  end
+
+  # @return [String]
+  def actual_path
+    "/tmp/#{testcase}.out"
+  end
+
+  # @return [String]
+  def expected_path
+    "../expected/#{testcase}.out"
   end
 
 end # TestRunner

data/lib/vedeu/borders/border.rb

@@ -21,6 +21,9 @@ module Vedeu
       extend Forwardable
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
 
       # @!attribute [w] bottom_left
       # @return [String] The character to be used for the bottom left

data/lib/vedeu/borders/dsl.rb

@@ -15,7 +15,7 @@ module Vedeu
 
       # {include:file:docs/dsl/by_method/border.md}
       # @macro param_name
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @macro raise_missing_required
       # @return [Vedeu::Borders::Border]

data/lib/vedeu/borders/refresh.rb

@@ -202,7 +202,7 @@ module Vedeu
       # the block.
       #
       # @param size [Fixnum]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Array<void>]
       def build_collection(size, &block)
         Array.new(size) { |e| yield(e) }

data/lib/vedeu/borders/repository.rb

@@ -9,8 +9,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :borders, :repository)
-
       null Vedeu::Borders::Border, enabled: false
       real Vedeu::Borders::Border
 

data/lib/vedeu/buffers/buffer.rb

@@ -9,6 +9,7 @@ module Vedeu
     #
     class Buffer
 
+      include Vedeu::Common
       include Vedeu::Repositories::Model
 
       # The next buffer to be displayed; contains the content which

data/lib/vedeu/buffers/repository.rb

@@ -8,8 +8,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :buffers, :repository)
-
       null Vedeu::Buffers::Null
       real Vedeu::Buffers::Buffer
 

data/lib/vedeu/buffers/view.rb

@@ -10,9 +10,9 @@ module Vedeu
     #
     class View
 
-      include Vedeu::Repositories::Defaults
-      include Enumerable
       extend Forwardable
+      include Enumerable
+      include Vedeu::Repositories::Defaults
 
       def_delegators :geometry,
                      :bordered_height,
@@ -31,7 +31,7 @@ module Vedeu
 
       # Provides iteration over the buffer.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [Enumerator]
       def each(&block)
         current.each(&block)

data/lib/vedeu/cells/empty.rb

@@ -15,6 +15,9 @@ module Vedeu
     class Empty
 
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
       include Vedeu::Repositories::Defaults
 
       # @!attribute [r] name

data/lib/vedeu/colours/background.rb

@@ -19,15 +19,10 @@ module Vedeu
 
       # @return [String]
       def to_ast
-        return '' unless background?
+        return ''    unless background?
+        return ':bg' unless rgb?
 
-        if rgb?
-          ":bg_#{colour.to_s.slice(1..-1)}"
-
-        else
-          ':bg'
-
-        end
+        ":bg_#{colour.to_s.slice(1..-1)}"
       end
 
       # @return [Hash<Symbol => String>]

data/lib/vedeu/colours/foreground.rb

@@ -19,15 +19,10 @@ module Vedeu
 
       # @return [String]
       def to_ast
-        return '' unless foreground?
+        return ''    unless foreground?
+        return ':fg' unless rgb?
 
-        if rgb?
-          ":fg_#{colour.to_s.slice(1..-1)}"
-
-        else
-          ':fg'
-
-        end
+        ":fg_#{colour.to_s.slice(1..-1)}"
       end
 
       # @return [Hash<Symbol => String>]

data/lib/vedeu/configuration/api.rb

@@ -28,7 +28,7 @@ module Vedeu
       #   end
       #
       # @param default [Hash]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Vedeu::Configuration::API]
       def initialize(default, &block)
         @default = default

data/lib/vedeu/configuration/configuration.rb

@@ -43,6 +43,7 @@ module Vedeu
     yellow:   [:light_yellow,  :yellow],
   }.freeze
 
+  # @return [Array<Symbol>]
   LOG_TYPES_KEYS = Vedeu::LOG_TYPES.keys.freeze
 
   # Allows the customisation of Vedeu's behaviour through the
@@ -87,7 +88,7 @@ module Vedeu
       # @option opts stdin [File|IO]
       # @option opts stdout [File|IO]
       # @option opts stderr [File|IO]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Hash<Symbol => void>]
       def configure(opts = {}, &block)
         instance.configure(opts, &block)
@@ -387,7 +388,7 @@ module Vedeu
     # Set up default configuration and then allow the client
     # application to modify it via the configuration API.
     #
-    # @param block [Proc]
+    # @macro param_block
     # @return [Hash<Symbol => void>]
     def configure(opts = {}, &block)
       @options.merge!(opts)

data/lib/vedeu/cursors/cursor.rb

@@ -156,7 +156,7 @@ module Vedeu
       # visibility. When passed a block, will position the cursor,
       # yield and return the original position.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def to_s(&block)
         return escape_sequence.to_s unless block_given?

data/lib/vedeu/cursors/repository.rb

@@ -8,8 +8,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :cursors, :repository)
-
       class << self
 
         # {include:file:docs/dsl/by_method/cursor.md}

data/lib/vedeu/dsl/border.rb

@@ -33,7 +33,7 @@ module Vedeu
         #   end
         #
         # @macro param_name
-        # @param block [Proc]
+        # @macro param_block
         # @macro raise_requires_block
         # @macro raise_missing_required
         # @return [Vedeu::Borders::Border]

data/lib/vedeu/dsl/dsl.rb

@@ -61,7 +61,7 @@ module Vedeu
     # @param method [Symbol] The name of the method sought.
     # @param args [Array] The arguments which the method was to be
     #   invoked with.
-    # @param block [Proc] The optional block provided to the method.
+    # @macro param_block
     # @return [void]
     def method_missing(method, *args, &block)
       Vedeu.log(type:    :debug,

data/lib/vedeu/dsl/elements.rb

@@ -59,7 +59,7 @@ module Vedeu
       #     end
       #   end
       #
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @macro raise_fatal
       # @return [void]
@@ -112,7 +112,7 @@ module Vedeu
       #   block is given.
       # @param opts [Hash]
       # @option opts ... [void]
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_fatal
       # @return [void]
       def line(value = '', opts = {}, &block)
@@ -147,7 +147,7 @@ module Vedeu
       #   block is given.
       # @param opts [Hash]
       # @option opts ... [void]
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_fatal
       # @return [void]
       def stream(value = '', opts = {}, &block)
@@ -292,7 +292,7 @@ module Vedeu
 
       private
 
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [NilClass]
       def requires_block!(&block)

data/lib/vedeu/dsl/geometry.rb

@@ -15,7 +15,7 @@ module Vedeu
 
         # {include:file:docs/dsl/by_method/geometry.md}
         # @macro param_name
-        # @param block [Proc]
+        # @macro param_block
         # @macro raise_requires_block
         # @macro raise_missing_required
         # @return [Vedeu::Geometries::Geometry]
@@ -46,7 +46,7 @@ module Vedeu
 
         # {include:file:docs/dsl/by_method/geometry.md}
         # @macro param_name
-        # @param block [Proc]
+        # @macro param_block
         # @macro raise_requires_block
         # @macro raise_missing_required
         # @return [Vedeu::Geometries::Geometry]

data/lib/vedeu/dsl/helpers/attributes.rb

@@ -44,7 +44,7 @@ module Vedeu
       #   value.
       # @option options wordwrap [Boolean] Whether the value should be
       #   wordwrapped.
-      # @param block [Proc]
+      # @macro param_block
       # @return [Vedeu::DSL::Attributes]
       def initialize(context = nil,
                      model   = nil,

data/lib/vedeu/dsl/use.rb

@@ -8,27 +8,7 @@ module Vedeu
     #
     module Use
 
-      # Use the attribute of stored model.
-      #
-      # This DSL method provides access to a stored model by name.
-      # You can then request an attribute of that model for use within
-      # the current model. The models which current support this are
-      # Border, Geometry and Interface.
-      #
-      # @example
-      #   # Here the character used for :my_border is used in
-      #   # :my_other_border.
-      #   Vedeu.border :my_other_border do
-      #     top_right use(:my_border).top_right
-      #   end
-      #
-      # @note
-      #   - Only models of the same repository can be used in this
-      #     way.
-      #   - If the stored model cannot be found, a ModelNotFound
-      #     exception may be raised, or the request for an attribute
-      #     may raise a NoMethodError exception.
-      #
+      # {include:file:docs/dsl/by_method/use.md}
       # @macro param_name
       # @raise
       #   [Vedeu::Error::ModelNotFound|Vedeu::Error::NoMethodError]

data/lib/vedeu/dsl/view.rb

@@ -47,8 +47,7 @@ module Vedeu
 
       # {include:file:docs/dsl/by_method/view.md}
       # @macro param_name
-      # @param block [Proc] The directives you wish to send to this
-      #   view.
+      # @macro param_block
       # @macro raise_requires_block
       # @macro raise_missing_required
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
@@ -63,17 +62,7 @@ module Vedeu
         model.add(new_model)
       end
 
-      # Load content from an ERb template.
-      #
-      # @example
-      #   Vedeu.renders do
-      #     template_for(:my_interface,
-      #                  '/path/to/template.erb',
-      #                  @some_object, options)
-      #   end
-      #
-      # @todo More documentation required.
-      #
+      # {include:file:docs/dsl/by_method/template_for.md}
       # @macro param_name
       # @param filename [String] The filename (including path) to the
       #   template to be used. Yoy can use `File.dirname(__FILE__)` to
@@ -84,6 +73,7 @@ module Vedeu
       #   {Vedeu::DSL::Wordwrap}
       # @macro raise_missing_required
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
+      # @todo More documentation required.
       def template_for(name, filename, object = nil, options = {})
         raise Vedeu::Error::MissingRequired,
               'Cannot render template without the name of the ' \

data/lib/vedeu/dsl/views.rb

@@ -94,9 +94,7 @@ module Vedeu
       class << self
 
         # {include:file:docs/dsl/by_method/renders.md}
-        # @param block [Proc] The directives you wish to send to
-        #   render. Typically includes `view` with associated
-        #   sub-directives.
+        # @macro param_block
         # @macro raise_requires_block
         # @return [Vedeu::Views::Composition]
         def renders(&block)
@@ -107,9 +105,7 @@ module Vedeu
         alias render renders
 
         # {include:file:docs/dsl/by_method/views.md}
-        # @param block [Proc] The directives you wish to send to
-        #   render. Typically includes `view` with associated
-        #   sub-directives.
+        # @macro param_block
         # @macro raise_requires_block
         # @return [Vedeu::Views::Composition]
         def views(&block)
@@ -120,14 +116,17 @@ module Vedeu
 
         private
 
-        # @param block [Proc] The directives you wish to send to
-        #   render. Typically includes `view` with associated
-        #   sub-directives. The binding of the block is also accessed
-        #   so that we can ascertain the calling client application
-        #   class, this is so that if there methods being called
-        #   inside your views, Vedeu will redirect that call to the
-        #   client class instance instead. (This actually occurs
-        #   when Vedeu rescues from method_missing. See {Vedeu::DSL}.)
+        # Handles the directives you wish to send to render. Typically
+        # includes `view` with associated sub-directives. The binding
+        # of the block is also accessed so that we can ascertain the
+        # calling client application class, this is so that if there
+        # methods being called inside your views, Vedeu will redirect
+        # that call to the client class instance instead. (This
+        # actually occurs when Vedeu rescues from method_missing. See
+        # {Vedeu::DSL}.)
+        #
+        # @macro param_block
+        # @return [void]
         def client_binding(&block)
           eval('self', block.binding).tap do |client|
             Vedeu.log(type:    :debug,
@@ -139,10 +138,8 @@ module Vedeu
         # one or more view {Vedeu::Views::View} objects.
         #
         # @param refresh [Boolean]
-        # @param block [Proc] The directives you wish to send to
-        #   render. Typically includes `view` with associated
-        #   sub-directives.
-        # # @return [Vedeu::Views::Composition]
+        # @macro param_block
+        # @return [Vedeu::Views::Composition]
         def composition(refresh = false, &block)
           attrs = {
             client: client_binding(&block),

data/lib/vedeu/editor/lines.rb

@@ -58,7 +58,7 @@ module Vedeu
 
       # Provides iteration over the collection.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [Enumerator]
       def each(&block)
         collection.each(&block)

data/lib/vedeu/editor/repository.rb

@@ -8,8 +8,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :documents, :repository)
-
       real Vedeu::Editor::Document
       null Vedeu::Editor::Document
 

data/lib/vedeu/esc/background.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       extend self
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_black(&block)
         if block_given?
@@ -24,7 +24,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_red(&block)
         if block_given?
@@ -36,7 +36,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_green(&block)
         if block_given?
@@ -48,7 +48,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_yellow(&block)
         if block_given?
@@ -60,7 +60,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_blue(&block)
         if block_given?
@@ -72,7 +72,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_magenta(&block)
         if block_given?
@@ -84,7 +84,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_cyan(&block)
         if block_given?
@@ -96,7 +96,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_grey(&block)
         if block_given?
@@ -108,7 +108,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_default(&block)
         if block_given?
@@ -120,7 +120,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_dark_grey(&block)
         if block_given?
@@ -132,7 +132,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_red(&block)
         if block_given?
@@ -144,7 +144,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_green(&block)
         if block_given?
@@ -156,7 +156,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_yellow(&block)
         if block_given?
@@ -168,7 +168,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_blue(&block)
         if block_given?
@@ -180,7 +180,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_magenta(&block)
         if block_given?
@@ -192,7 +192,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_light_cyan(&block)
         if block_given?
@@ -204,7 +204,7 @@ module Vedeu
         end
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def on_white(&block)
         if block_given?

data/lib/vedeu/esc/colours.rb

@@ -23,7 +23,7 @@ module Vedeu
       end
 
       # @param named_colour [Symbol]
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def background_colour(named_colour, &block)
         return '' unless valid_name?(named_colour)
@@ -32,7 +32,7 @@ module Vedeu
       end
 
       # @param named_colour [Symbol]
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def colour(named_colour, &block)
         return '' unless valid_name?(named_colour)

data/lib/vedeu/esc/esc.rb

@@ -53,7 +53,7 @@ module Vedeu
 
       # Return the escape sequence to render a border character.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       # @yieldreturn [void] The border character to wrap with border
       #   on and off escape sequences.