vedeu 0.4.52 → 0.4.53

data/lib/vedeu/output/refresh.rb

@@ -4,13 +4,23 @@ module Vedeu
 
   # Refreshes the terminal.
   #
-  # @api private
+  # @note
+  #   In the cases of {#all} and {#by_group}, the interfaces will be refreshed
+  #   in z-index order, meaning that interfaces with a lower z-index will be
+  #   drawn first. This means overlapping interfaces will be drawn as specified.
+  #
+  # @api public
   module Refresh
 
     module_function
 
     # Refresh all registered interfaces.
     #
+    # @example
+    #   Vedeu.trigger(:_refresh_)
+    #
+    #   Vedeu::Refresh.all
+    #
     # @return [Array]
     def all
       Vedeu.timer('Refresh All') do
@@ -27,10 +37,10 @@ module Vedeu
 
     # Refresh an interface, or collection of interfaces belonging to a group.
     #
-    # @note
-    #   The group of interfaces will be refreshed in z-index order, meaning that
-    #   interfaces with a lower z-index will be draw first. This means
-    #   overlapping interfaces will be drawn as specified.
+    # @example
+    #   Vedeu.trigger(:_refresh_group_, group_name)
+    #
+    #   Vedeu::Refresh.by_group(group_name)
     #
     # @param group_name [String] The name of the group to be refreshed.
     # @return [Array|ModelNotFound] A collection of the names of interfaces
@@ -43,6 +53,11 @@ module Vedeu
 
     # Refresh an interface by name.
     #
+    # @example
+    #   Vedeu.trigger(:_refresh_, name)
+    #
+    #   Vedeu::Refresh.by_name(name)
+    #
     # @param name [String] The name of the interface to be refreshed using the
     #   named buffer.
     # @return [Array|ModelNotFound]

data/lib/vedeu/output/refresh_group.rb

@@ -7,6 +7,8 @@ module Vedeu
   # @api private
   class RefreshGroup
 
+    include Vedeu::Common
+
     # @param name [String]
     # @return [void]
     def self.by_name(name)
@@ -44,7 +46,10 @@ module Vedeu
 
     # @return [Set]
     def members
-      Vedeu.groups.find!(name).members
+      fail Vedeu::MissingRequired,
+        'Cannot refresh group with an empty group name.' unless present?(name)
+
+      Vedeu.groups.by_name(name).members
     end
 
   end # RefreshGroup

data/lib/vedeu/output/render_border.rb

@@ -177,7 +177,7 @@ module Vedeu
     end
 
     # From the second element of {#title_characters} remove the border from each
-    # {#horizontal_border} Vedeu::Char, and add the title character.
+    # {#build_horizontal} Vedeu::Char, and add the title character.
     #
     # @return [Array<Vedeu::Char>]
     def titlebar

data/lib/vedeu/output/renderers/all.rb

@@ -1,3 +1,4 @@
+require_relative 'renderer_options'
 require_relative 'escape_sequence'
 require_relative 'file'
 require_relative 'html'

data/lib/vedeu/output/renderers/escape_sequence.rb

@@ -7,6 +7,8 @@ module Vedeu
     # @api private
     class EscapeSequence
 
+      include Vedeu::RendererOptions
+
       # Returns a new instance of Vedeu::Renderers::EscapeSequence.
       #
       # @param options [Hash]
@@ -24,22 +26,6 @@ module Vedeu
         end.join
       end
 
-      private
-
-      # Combines the options provided at instantiation with the default values.
-      #
-      # @return [Hash<Symbol => void>]
-      def options
-        defaults.merge!(@options)
-      end
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
-      def defaults
-        {}
-      end
-
     end # EscapeSequence
 
   end # Renderers

data/lib/vedeu/output/renderers/null.rb

@@ -7,6 +7,8 @@ module Vedeu
     # @api private
     class Null
 
+      include Vedeu::RendererOptions
+
       # Returns a new instance of Vedeu::Renderers::Null.
       #
       # @param options [Hash]
@@ -21,22 +23,6 @@ module Vedeu
         output
       end
 
-      private
-
-      # Combines the options provided at instantiation with the default values.
-      #
-      # @return [Hash<Symbol => void>]
-      def options
-        defaults.merge!(@options)
-      end
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
-      def defaults
-        {}
-      end
-
     end # Null
 
   end # Renderers

data/lib/vedeu/output/renderers/renderer_options.rb

@@ -0,0 +1,26 @@
+module Vedeu
+
+  # Provides shared functionality to Vedeu::Renderer classes.
+  #
+  # @api private
+  module RendererOptions
+
+    private
+
+    # Combines the options provided at instantiation with the default values.
+    #
+    # @return [Hash<Symbol => void>]
+    def options
+      defaults.merge!(@options)
+    end
+
+    # The default values for a new instance of this class.
+    #
+    # @return [Hash<Symbol => void>]
+    def defaults
+      {}
+    end
+
+  end # RendererOptions
+
+end # Vedeu

data/lib/vedeu/output/renderers/terminal.rb

@@ -8,6 +8,8 @@ module Vedeu
     # @api private
     class Terminal
 
+      include Vedeu::RendererOptions
+
       # Returns a new instance of Vedeu::Renderers::Terminal.
       #
       # @param options [Hash]
@@ -32,20 +34,6 @@ module Vedeu
         end
       end
 
-      # Combines the options provided at instantiation with the default values.
-      #
-      # @return [Hash<Symbol => void>]
-      def options
-        defaults.merge!(@options)
-      end
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
-      def defaults
-        {}
-      end
-
     end # Terminal
 
   end # Renderers

data/lib/vedeu/output/renderers/text.rb

@@ -8,6 +8,8 @@ module Vedeu
     # @api private
     class Text
 
+      include Vedeu::RendererOptions
+
       # Returns a new instance of Vedeu::Renderers::Text.
       #
       # @param options [Hash]
@@ -22,22 +24,6 @@ module Vedeu
         Vedeu::Compressor.render(output)
       end
 
-      private
-
-      # Combines the options provided at instantiation with the default values.
-      #
-      # @return [Hash<Symbol => void>]
-      def options
-        defaults.merge!(@options)
-      end
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
-      def defaults
-        {}
-      end
-
     end # Text
 
   end # Renderers

data/lib/vedeu/repositories/all.rb

@@ -12,17 +12,39 @@ module Vedeu
       storage.add(klass)
     end
 
+    # List all models stored in each registered repository.
+    #
+    # @return [Array]
+    def registered
+      all.map do |repository|
+        registered = repository.send(:registered)
+
+        Vedeu.log(type:    :debug,
+                  message: "Repository '#{repository.class.name}':" \
+                           " #{registered.inspect}")
+
+        registered
+      end
+    end
+
     # Remove all stored models from the repository.
     #
     # @return [TrueClass]
     def reset!
-      storage.map(&:repository).map { |repository| repository.send(:reset) }
+      all.map { |repository| repository.send(:reset) }
 
       true
     end
 
     private
 
+    # Access all the repositories stored.
+    #
+    # @return [Array]
+    def all
+      storage.map(&:repository)
+    end
+
     # Access to the storage for this repository.
     #
     # @return [Array]

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.4.52'
+  VERSION = '0.4.53'
 
 end

data/test/lib/vedeu/bindings/system_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Bindings
+
+    describe System do
+
+      context 'the system events needed by Vedeu to run are defined' do
+        it { Vedeu.bound?(:_clear_).must_equal(true) }
+        it { Vedeu.bound?(:_clear_group_).must_equal(true) }
+        it { Vedeu.bound?(:_cleanup_).must_equal(true) }
+        it { Vedeu.bound?(:_command_).must_equal(true) }
+        it { Vedeu.bound?(:_exit_).must_equal(true) }
+        it { Vedeu.bound?(:_initialize_).must_equal(true) }
+        it { Vedeu.bound?(:_keypress_).must_equal(true) }
+        it { Vedeu.bound?(:_log_).must_equal(true) }
+        it { Vedeu.bound?(:_mode_switch_).must_equal(true) }
+        it { Vedeu.bound?(:_refresh_).must_equal(true) }
+        it { Vedeu.bound?(:_refresh_cursor_).must_equal(true) }
+        it { Vedeu.bound?(:_refresh_group_).must_equal(true) }
+        it { Vedeu.bound?(:_resize_).must_equal(true) }
+      end
+
+      context 'the geometry specific events are defined' do
+        it { Vedeu.bound?(:_maximise_).must_equal(true) }
+        it { Vedeu.bound?(:_unmaximise_).must_equal(true) }
+      end
+
+      context 'the focus specific events are defined' do
+        it { Vedeu.bound?(:_focus_by_name_).must_equal(true) }
+        it { Vedeu.bound?(:_focus_next_).must_equal(true) }
+        it { Vedeu.bound?(:_focus_prev_).must_equal(true) }
+      end
+
+      context 'the refresh event for all registered interfaces is defined' do
+        it { Vedeu.bound?(:_refresh_).must_equal(true) }
+      end
+
+    end # System
+
+  end # Bindings
+
+end # Vedeu

data/test/lib/vedeu/output/refresh_group_test.rb

@@ -20,8 +20,16 @@ module Vedeu
     describe '#by_name' do
       subject { instance.by_name }
 
-      # @todo
-      # it { skip }
+      context 'when the name is not present' do
+        let(:_name) { '' }
+
+        it { proc { subject }.must_raise(Vedeu::MissingRequired) }
+      end
+
+      context 'when the name is present' do
+        # @todo
+        # it { skip }
+      end
     end
 
   end # RefreshGroup

data/test/lib/vedeu/output/refresh_test.rb

@@ -34,32 +34,15 @@ module Vedeu
     end
 
     describe '.by_group' do
-      let(:_name)  { 'aluminium' }
-      let(:buffer) { Vedeu::Null::Buffer.new(_name) }
+      let(:group_name) { 'elements' }
+      let(:_name)      { 'aluminium' }
 
       subject { described.by_group(group_name) }
 
-      context 'when there are no registered groups' do
-        let(:group_name) { '' }
-
-        before { Vedeu.groups.reset }
-
-        it { proc { subject }.must_raise(ModelNotFound) }
-      end
-
-      context 'when there are registered groups' do
-        let(:group_name) { 'elements' }
-
-        before do
-          Vedeu::Group.new(name: group_name, members: _name).store
-        end
-
-        it do
-          Vedeu.buffers.expects(:by_name).with(_name).returns(buffer)
-          buffer.expects(:render)
-          subject
-        end
-      end
+      it {
+        Vedeu::RefreshGroup.expects(:by_name).with(group_name)
+        subject
+      }
     end
 
     describe '.by_name' do

data/test/lib/vedeu/output/renderers/renderer_options_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module Vedeu
+
+  describe RendererOptions do
+
+    # @todo
+    # it { skip }
+
+  end # RendererOptions
+
+end # Vedeu

data/test/lib/vedeu/templating/preprocessor_test.rb

@@ -15,6 +15,14 @@ module Vedeu
           "More text here\n"
         ]
       }
+      let(:expected) {
+        [
+          Vedeu::Stream.new(value: 'Some text here'),
+          Vedeu::Stream.new(value: 'Yay!',
+                            colour: Vedeu::Colour.coerce(foreground: '#0f0')),
+          Vedeu::Stream.new(value: 'More text here')
+        ]
+      }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
@@ -22,19 +30,12 @@ module Vedeu
       end
 
       describe '.process' do
-        it { described.must_respond_to(:process) }
+        subject { described.process(lines) }
+
+        it { subject.must_equal(expected) }
       end
 
       describe '#process' do
-        let(:expected) {
-          [
-            Vedeu::Stream.new(value: 'Some text here'),
-            Vedeu::Stream.new(value: 'Yay!',
-                              colour: Vedeu::Colour.coerce({ foreground: '#0f0' })),
-            Vedeu::Stream.new(value: 'More text here')
-          ]
-        }
-
         subject { instance.process }
 
         it { subject.must_equal(expected) }