vedeu 0.8.20 → 0.8.21

data/lib/vedeu/interfaces/repository.rb

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

data/lib/vedeu/logging/debug.rb

@@ -37,7 +37,7 @@ module Vedeu
       # {include:file:docs/dsl/by_method/profile.md}
       # @param filename [String] Optional, and defaults to being
       #   written to the /tmp directory.
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [void]
       # @yieldreturn [void] The section of the application to profile.

data/lib/vedeu/logging/log.rb

@@ -99,12 +99,26 @@ module Vedeu
         # @macro vedeu_logging_log_param_message
         # @return [String]
         def log_entry(type, message)
-          colours = Vedeu::LOG_TYPES.fetch(type, [:default, :default])
+          log_type(type) + log_message(type, message)
+        end
+
+        # @param type [Symbol] The type of log message.
+        # @return [String]
+        def log_type(type)
+          Vedeu.esc.colour(colours(type)[0]) { "[#{type}]".ljust(11) }
+        end
 
-          [
-            Vedeu.esc.colour(colours[0]) { "[#{type}]".ljust(11) },
-            Vedeu.esc.colour(colours[1]) { message },
-          ].join
+        # @param type [Symbol] The type of log message.
+        # @macro vedeu_logging_log_param_message
+        # @return [String]
+        def log_message(type, message)
+          Vedeu.esc.colour(colours(type)[1]) { message }
+        end
+
+        # @param type [Symbol] The type of log message.
+        # @return [Array<Symbol>]
+        def colours(type)
+          Vedeu::LOG_TYPES.fetch(type, [:default, :default])
         end
 
       end # Eigenclass

data/lib/vedeu/logging/timer.rb

@@ -14,7 +14,7 @@ module Vedeu
 
         # {include:file:docs/dsl/by_method/timer.md}
         # @param message [String]
-        # @param block [Proc]
+        # @macro param_block
         # @macro raise_requires_block
         # @return [void] The return value of the executed block.
         def timer(message = '', &block)
@@ -36,7 +36,7 @@ module Vedeu
       # code took in milliseconds when debugging is enabled and a
       # block was Useful for debugging performance.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [void|NilClass] The return value of the executed
       #   block if given, or nil if debugging is disabled.

data/lib/vedeu/menus/dsl.rb

@@ -18,8 +18,7 @@ module Vedeu
         # within your application.
         #
         # @macro param_name
-        # @param block [Proc] A set of attributes which define the
-        #   features of the menu.
+        # @macro param_block
         #
         # @example
         #   Vedeu.menu :my_interface do
@@ -49,7 +48,7 @@ module Vedeu
 
         # Returns the client object which called the DSL method.
         #
-        # @param block [Proc]
+        # @macro param_block
         # @return [Object]
         def client(&block)
           eval('self', block.binding)

data/lib/vedeu/menus/repository.rb

@@ -8,8 +8,6 @@ module Vedeu
     #
     class Repository < Vedeu::Repositories::Repository
 
-      singleton_class.send(:alias_method, :menus, :repository)
-
       real Vedeu::Menus::Menu
       null Vedeu::Menus::Menu
 

data/lib/vedeu/models/page.rb

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

data/lib/vedeu/models/row.rb

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

data/lib/vedeu/output/compressor_cache.rb

@@ -17,9 +17,10 @@ module Vedeu
       extend Vedeu::Repositories::Storage
 
       # @param content [Array<void>]
+      # @param compression [Boolean]
       # @return [String]
       def cache(content, compression = false)
-        write(content) unless empty?(content) || cached?(content)
+        write(content, compression) unless empty?(content) || cached?(content)
 
         compression ? read(:compress) : read(:uncompress)
       end
@@ -78,13 +79,18 @@ module Vedeu
       end
 
       # @param content [Array<void>]
+      # @param compression [Boolean]
       # @return [Hash<Symbol => Array<void>>]
-      def write(content)
+      def write(content, compression)
         storage[:original] = content
 
-        storage[:uncompress] = uncompress(content)
+        if compression
+          storage[:compress] = compress(content)
 
-        storage[:compress] = compress(content)
+        else
+          storage[:uncompress] = uncompress(content)
+
+        end
       end
 
     end # CompressorCache

data/lib/vedeu/output/compressors/simple.rb

@@ -28,9 +28,7 @@ module Vedeu
 
         # @return [String]
         def with
-          Vedeu.log(type:    :compress,
-                    message: "No compression for #{original_size} objects -> " \
-                             "#{compress_size} characters")
+          Vedeu.log(type: :compress, message: message)
 
           compress
         end
@@ -53,6 +51,12 @@ module Vedeu
           compress.size
         end
 
+        # @return [String]
+        def message
+          "No compression for #{original_size} objects " \
+          "-> #{compress_size} characters"
+        end
+
         # @return [Fixnum]
         def original_size
           content.size

data/lib/vedeu/output/write.rb

@@ -14,6 +14,9 @@ module Vedeu
     class Write
 
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
 
       # @api public
       # @param (see #initialize)

data/lib/vedeu/presentation/colour.rb

@@ -148,7 +148,7 @@ module Vedeu
       # Renders the colour attributes of the receiver and yields (to
       # then render the styles).
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def render_colour(&block)
         "#{colour}#{yield}"

data/lib/vedeu/presentation/position.rb

@@ -52,7 +52,7 @@ module Vedeu
 
       private
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def render_position(&block)
         return position.to_s { yield } if position?

data/lib/vedeu/presentation/presentation.rb

@@ -4,10 +4,6 @@ module Vedeu
 
   module Presentation
 
-    include Vedeu::Presentation::Colour
-    include Vedeu::Presentation::Position
-    include Vedeu::Presentation::Styles
-
     # Converts the colours and styles to escape sequences, and when
     # the parent model has previously set the colour and style,
     # reverts back to that for consistent formatting.

data/lib/vedeu/presentation/styles.rb

@@ -57,7 +57,7 @@ module Vedeu
       # Renders the style attributes of the receiver and yields (to
       # then render the next model, or finally, the content).
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [String]
       def render_style(&block)
         "#{style}#{yield}"

data/lib/vedeu/renderers/all.rb

@@ -73,7 +73,7 @@ module Vedeu
     end
 
     # @param renderer [void]
-    # @param block [Proc]
+    # @macro param_block
     def perform(renderer, &block)
       if Vedeu.config.threaded?
         threaded(renderer) { yield }
@@ -89,7 +89,7 @@ module Vedeu
       @_mutex ||= Mutex.new
     end
 
-    # @param block [Proc]
+    # @macro param_block
     # @return [void]
     def threaded(renderer, &block)
       Thread.new(renderer) do
@@ -101,7 +101,7 @@ module Vedeu
       end
     end
 
-    # @param block [Proc]
+    # @macro param_block
     # @return [void]
     def toggle_cursor(&block)
       Vedeu.trigger(:_hide_cursor_)
@@ -111,7 +111,7 @@ module Vedeu
       Vedeu.trigger(:_show_cursor_)
     end
 
-    # @param block [Proc]
+    # @macro param_block
     # @return [void]
     def unthreaded(&block)
       toggle_cursor do

data/lib/vedeu/repositories/assemblage.rb

@@ -24,7 +24,7 @@ module Vedeu
       # Returns a boolean indicating whether the collection is not
       # empty.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [Boolean]
       def any?(&block)
         collection.any?(&block)
@@ -32,7 +32,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/repositories/model.rb

@@ -9,9 +9,6 @@ module Vedeu
     #
     module Model
 
-      # This is used by including classes.
-      include Vedeu::Common
-
       # @!attribute [rw] repository
       # @return [Vedeu::Repositories::Repository]
       attr_accessor :repository
@@ -29,7 +26,7 @@ module Vedeu
         #
         # @param attributes [Hash] A collection of attributes specific
         #   to the model.
-        # @param block [Proc] The block passed to the build method.
+        # @macro param_block
         # @return [Object] An instance of the model.
         def build(attributes = {}, &block)
           model = new(attributes)
@@ -56,8 +53,7 @@ module Vedeu
         #
         # @param attributes [Hash] A collection of attributes specific
         #   to the model.
-        # @param block [Proc] A block of code to be executing whilst
-        #   storing.
+        # @macro param_block
         # @return [Object] An instance of the model.
         def store(attributes = {}, &block)
           new(attributes).store(&block)

data/lib/vedeu/repositories/registerable.rb

@@ -53,6 +53,16 @@ module Vedeu
         def repository
           @models ||= reset!
         end
+        alias borders    repository
+        alias buffers    repository
+        alias cursors    repository
+        alias documents  repository
+        alias events     repository
+        alias geometries repository
+        alias groups     repository
+        alias interfaces repository
+        alias keymaps    repository
+        alias menus      repository
 
         # Remove all stored models from the repository.
         #

data/lib/vedeu/repositories/store.rb

@@ -17,7 +17,7 @@ module Vedeu
       alias all storage
       alias clear reset!
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [Enumerator]
       def each(&block)
         storage.each(&block)

data/lib/vedeu/runtime/application.rb

@@ -79,7 +79,7 @@ module Vedeu
       # Runs the application loop either once, or forever (exceptions
       # and signals permitting).
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [void]
       def runner(&block)
         if Vedeu.config.once?
@@ -115,7 +115,7 @@ module Vedeu
       # stopped when an uncaught exception occurs or when either the
       # `:_mode_switch_` or `:_exit_` event is triggered.
       #
-      # @param block [Proc]
+      # @macro param_block
       # @return [void]
       def run_many(&block)
         Vedeu::Runtime::MainLoop.start! { yield }
@@ -124,7 +124,7 @@ module Vedeu
         Vedeu::Runtime::Application.restart
       end
 
-      # @param block [Proc]
+      # @macro param_block
       # @return [void]
       def run_once(&block)
         # Vedeu.debug(binding)

data/lib/vedeu/runtime/launcher.rb

@@ -91,7 +91,7 @@ module Vedeu
 
     private
 
-    # @param block [Proc]
+    # @macro param_block
     # @return [void]
     def optionally_profile(&block)
       if Vedeu.config.profile?

data/lib/vedeu/templating/helpers.rb

@@ -11,7 +11,7 @@ module Vedeu
       include Vedeu::View
 
       # @param value [String] The HTML/CSS colour.
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [Vedeu::Views::Stream]
       def background(value, &block)
@@ -24,7 +24,7 @@ module Vedeu
       #   colour.
       # @option attributes background [String] The HTML/CSS background
       #   colour.
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [Vedeu::Views::Stream]
       def colour(attributes = {}, &block)
@@ -32,7 +32,7 @@ module Vedeu
       end
 
       # @param value [String] The HTML/CSS colour.
-      # @param block [Proc]
+      # @macro param_block
       # @macro raise_requires_block
       # @return [Vedeu::Views::Stream]
       def foreground(value, &block)
@@ -41,7 +41,7 @@ module Vedeu
       alias fg foreground
 
       # @param value [Symbol]
-      # @param block [Proc]
+      # @macro param_block
       # @return [Vedeu::Views::Stream]
       def style(value, &block)
         define_stream(style: value, &block)

data/lib/vedeu/terminal/terminal.rb

@@ -24,7 +24,7 @@ module Vedeu
     # exit, attempts to restore the screen. See
     # {Vedeu::Terminal#restore_screen}.
     #
-    # @param block [Proc]
+    # @macro param_block
     # @macro raise_requires_block
     # @return [Array]
     def open(&block)
@@ -65,7 +65,7 @@ module Vedeu
       true
     end
 
-    # @param block [Proc]
+    # @macro param_block
     # @param mode [Symbol]
     # @return [void]
     def initialize_screen(mode, &block)

data/lib/vedeu/version.rb

@@ -3,6 +3,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.8.20'
+  VERSION = '0.8.21'
 
 end

data/lib/vedeu/views/composition.rb

@@ -12,6 +12,9 @@ module Vedeu
 
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
       include Vedeu::Views::Value
 
       collection Vedeu::Views::Views

data/lib/vedeu/views/line.rb

@@ -27,6 +27,9 @@ module Vedeu
       include Vedeu::Views::DefaultAttributes
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
       include Vedeu::Views::Value
 
       collection Vedeu::Views::Streams

data/lib/vedeu/views/stream.rb

@@ -28,6 +28,9 @@ module Vedeu
       include Vedeu::Views::DefaultAttributes
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
 
       include Vedeu::Views::Value
       collection Vedeu::Views::Chars

data/lib/vedeu/views/view.rb

@@ -29,6 +29,9 @@ module Vedeu
       extend Forwardable
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Presentation::Colour
+      include Vedeu::Presentation::Position
+      include Vedeu::Presentation::Styles
       include Vedeu::Views::Value
 
       collection Vedeu::Views::Lines

data/lib/vedeu.rb

@@ -65,6 +65,9 @@ end # Vedeu
 #   Provide additional behaviour as singleton methods to the including
 #   class or module.
 #
+# @!macro [new] param_block
+#   @param block [Proc]
+#
 # @!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`.

data/test/lib/vedeu/borders/repository_test.rb

@@ -10,8 +10,6 @@ module Vedeu
 
       let(:described) { Vedeu::Borders::Repository }
 
-      it { described.must_respond_to(:borders) }
-
     end # Repository
 
   end # Borders

data/test/lib/vedeu/buffers/repository_test.rb

@@ -11,8 +11,6 @@ module Vedeu
       let(:described) { Vedeu::Buffers::Repository }
       let(:instance)  { described.buffers }
 
-      it { described.must_respond_to(:buffers) }
-
     end # Repository
 
   end # Buffers

data/test/lib/vedeu/cursors/repository_test.rb

@@ -10,8 +10,6 @@ module Vedeu
 
       let(:described) { Vedeu::Cursors::Repository }
 
-      it { described.must_respond_to(:cursors) }
-
       describe '.cursor' do
         before { Vedeu::Models::Focus.reset }
 

data/test/lib/vedeu/dsl/border_test.rb

@@ -8,6 +8,14 @@ module Vedeu
 
     include Vedeu::DSL::Border
 
+    def model
+      self
+    end
+
+    def name
+      :vedeu_dsl_border_test_class
+    end
+
   end # DSLBorderTestClass
 
   module DSL
@@ -16,7 +24,7 @@ module Vedeu
 
       let(:described) { Vedeu::DSL::Border }
       let(:included_described) { Vedeu::DSLBorderTestClass }
-      let(:instance)  { Class.include(described).new }
+      let(:instance)  { included_described.new }
       let(:_name)     { :vedeu_dsl_border }
 
       describe '.included' do
@@ -28,18 +36,6 @@ module Vedeu
       describe '#border' do
         subject { instance.border(_name) {} }
 
-        context 'when the name is not given' do
-          let(:_name) {}
-
-          it 'uses the name of the model' do
-            # @todo Add more tests.
-          end
-        end
-
-        context 'when the name is given' do
-          # @todo Add more tests.
-        end
-
         context 'when the block is not given' do
           subject { instance.border(_name) }
 
@@ -47,16 +43,30 @@ module Vedeu
         end
 
         context 'when the block is given' do
-          subject { instance.border { } }
+          context 'when the name is not given' do
+            let(:_name) {}
+
+            it 'uses the name of the model' do
+              subject.must_be_instance_of(Vedeu::Borders::Border)
+              subject.name.must_equal(:vedeu_dsl_border_test_class)
+            end
+          end
 
-          # @todo Add more tests.
+          context 'when the name is given' do
+            it 'uses the given name' do
+              subject.must_be_instance_of(Vedeu::Borders::Border)
+              subject.name.must_equal(:vedeu_dsl_border)
+            end
+          end
         end
       end
 
       describe '#border!' do
         subject { instance.border! }
 
-        # @todo Add more tests.
+        it 'builds and stores a default border' do
+          subject.must_be_instance_of(Vedeu::Borders::Border)
+        end
       end
 
     end # Border

data/test/lib/vedeu/editor/repository_test.rb

@@ -22,8 +22,6 @@ module Vedeu
 
       let(:described) { Vedeu::Editor::Repository }
 
-      it { described.must_respond_to(:documents) }
-
     end # Repository
 
   end # Editor

data/test/lib/vedeu/events/repository_test.rb

@@ -10,8 +10,6 @@ module Vedeu
 
       let(:described) { Vedeu::Events::Repository }
 
-      it { described.must_respond_to(:events) }
-
       describe '.reset!' do
         subject { described.reset! }
 

data/test/lib/vedeu/geometries/repository_test.rb

@@ -23,10 +23,6 @@ module Vedeu
 
       let(:described) { Vedeu::Geometries::Repository }
 
-      after { Vedeu.geometries.reset }
-
-      it { described.must_respond_to(:geometries) }
-
     end # Repository
 
   end # Geometries

data/test/lib/vedeu/groups/repository_test.rb

@@ -10,8 +10,6 @@ module Vedeu
 
       let(:described) { Vedeu::Groups::Repository }
 
-      it { described.must_respond_to(:groups) }
-
       describe '#by_name' do
         let(:_name) { 'carbon' }
 

data/test/lib/vedeu/input/repository_test.rb

@@ -10,8 +10,6 @@ module Vedeu
 
       let(:described) { Vedeu::Input::Repository }
 
-      it { described.must_respond_to(:keymaps) }
-
     end # Repository
 
   end # Input