vedeu 0.8.17 → 0.8.18

data/lib/vedeu/configuration/configuration.rb

@@ -2,6 +2,48 @@
 
 module Vedeu
 
+  # The defined message types for Vedeu with their respective
+  # colours. When used, produces a log entry of the format:
+  #
+  #     [type] message
+  #
+  # The 'type' will be shown as the first colour defined in the
+  # value array, whilst the 'message' will be shown using the
+  # last colour.
+  #
+  # @return [Hash<Symbol => Array<Symbol>>]
+  LOG_TYPES = {
+    blue:     [:light_blue,    :blue],
+    buffer:   [:light_green,   :green],
+    compress: [:white,         :light_grey],
+    config:   [:light_blue,    :blue],
+    create:   [:light_cyan,    :cyan],
+    cursor:   [:light_green,   :green],
+    cyan:     [:light_cyan,    :cyan],
+    debug:    [:white,         :light_grey],
+    drb:      [:light_blue,    :blue],
+    dsl:      [:light_blue,    :blue],
+    editor:   [:light_blue,    :blue],
+    error:    [:light_red,     :red],
+    event:    [:light_magenta, :magenta],
+    green:    [:light_green,   :green],
+    info:     [:white,         :light_grey],
+    input:    [:light_yellow,  :yellow],
+    magenta:  [:light_magenta, :magenta],
+    output:   [:light_yellow,  :yellow],
+    red:      [:light_red,     :red],
+    render:   [:light_green,   :green],
+    reset:    [:light_cyan,    :cyan],
+    store:    [:light_cyan,    :cyan],
+    test:     [:white,         :light_grey],
+    timer:    [:light_blue,    :blue],
+    update:   [:light_cyan,    :cyan],
+    white:    [:white,         :light_grey],
+    yellow:   [:light_yellow,  :yellow],
+  }.freeze
+
+  LOG_TYPES_KEYS = Vedeu::LOG_TYPES.keys.freeze
+
   # Allows the customisation of Vedeu's behaviour through the
   # configuration API.
   #
@@ -186,48 +228,6 @@ module Vedeu
         instance.options[:log_only]
       end
 
-      # The defined message types for Vedeu with their respective
-      # colours. When used, produces a log entry of the format:
-      #
-      #     [type] message
-      #
-      # The 'type' will be shown as the first colour defined in the
-      # value array, whilst the 'message' will be shown using the
-      # last colour.
-      #
-      # @return [Hash<Symbol => Array<Symbol>>]
-      def log_types
-        {
-          blue:     [:light_blue,    :blue],
-          buffer:   [:light_green,   :green],
-          compress: [:white,         :light_grey],
-          config:   [:light_blue,    :blue],
-          create:   [:light_cyan,    :cyan],
-          cursor:   [:light_green,   :green],
-          cyan:     [:light_cyan,    :cyan],
-          debug:    [:white,         :light_grey],
-          drb:      [:light_blue,    :blue],
-          dsl:      [:light_blue,    :blue],
-          editor:   [:light_blue,    :blue],
-          error:    [:light_red,     :red],
-          event:    [:light_magenta, :magenta],
-          green:    [:light_green,   :green],
-          info:     [:white,         :light_grey],
-          input:    [:light_yellow,  :yellow],
-          magenta:  [:light_magenta, :magenta],
-          output:   [:light_yellow,  :yellow],
-          red:      [:light_red,     :red],
-          render:   [:light_green,   :green],
-          reset:    [:light_cyan,    :cyan],
-          store:    [:light_cyan,    :cyan],
-          test:     [:white,         :light_grey],
-          timer:    [:light_blue,    :blue],
-          update:   [:light_cyan,    :cyan],
-          white:    [:white,         :light_grey],
-          yellow:   [:light_yellow,  :yellow],
-        }
-      end
-
       # Returns true if the given type was included in the :log_only
       # configuration option or not included in the :log_except
       # option.
@@ -235,20 +235,20 @@ module Vedeu
       # @param type [Symbol]
       # @return [Boolean]
       def loggable?(type)
-        return false unless log_types.keys.include?(type)
-        return true if log_only.empty? && log_except.empty?
+        return false unless log?
+        return false unless Vedeu::LOG_TYPES_KEYS.include?(type)
+        return true  if log_only.empty? && log_except.empty?
 
-        types = if log_except.any?
-                  log_types.keys - log_except
-                else
-                  log_types.keys
-                end
+        if log_except.any?
+          Vedeu::LOG_TYPES_KEYS - log_except
+
+        elsif log_only.any?
+          log_only
 
-        if log_only.any?
-          log_only.include?(type)
         else
-          types.include?(type) ? true : false
-        end
+          Vedeu::LOG_TYPES_KEYS
+
+        end.include?(type)
       end
 
       # Returns whether mouse support was enabled or disabled.

data/lib/vedeu/distributed/all.rb

@@ -31,4 +31,3 @@ require 'vedeu/distributed/uri'
 require 'vedeu/distributed/server'
 require 'vedeu/distributed/client'
 require 'vedeu/distributed/subprocess'
-require 'vedeu/distributed/test_application'

data/lib/vedeu/distributed/subprocess.rb

@@ -4,8 +4,7 @@ module Vedeu
 
   module Distributed
 
-    # @example
-    #   Vedeu::TestApplication.build
+    # Creates a subprocess of the DRb server.
     #
     class Subprocess
 
@@ -16,7 +15,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Distributed::Subprocess.
       #
-      # @param application [Vedeu::TestApplication]
+      # @param application [void]
       # @return [Vedeu::Distributed::Subprocess]
       def initialize(application)
         @application = application
@@ -50,7 +49,7 @@ module Vedeu
       protected
 
       # @!attribute [r] application
-      # @return [Vedeu::TestApplication]
+      # @return [void]
       attr_reader :application
 
       # @!attribute [r] pid

data/lib/vedeu/error.rb

@@ -98,16 +98,21 @@ module Vedeu
     # Raised to remind me (or client application developers) that the
     # subclass implements the functionality sought.
     #
-    # @see Vedeu::Colours::Translator
-    #
     # @!macro [new] raise_not_implemented
-    #    @raise [Vedeu::Error::NotImplemented] When a subclass of the
-    #      current class actually implements the method. Usually an
-    #      indicator that the subclass should be used instead of the
-    #      current class.
+    #    @raise [Vedeu::Error::NotImplemented] When the method called
+    #      should be handled by a subclass of the current class, or
+    #      by the class including or extending the current module.
     #
     class NotImplemented < StandardError
 
+      # Returns an error message.
+      #
+      # @return [String]
+      def message
+        'Subclasses of this class or classes including/extending ' \
+        'this module should implement this method.'
+      end
+
     end # NotImplemented
 
     # Raised when trying to access an interface column less than 1 or

data/lib/vedeu/events/trigger.rb

@@ -41,7 +41,7 @@ module Vedeu
       #
       # @return [Array]
       def trigger
-        if results.empty?
+        if Vedeu.config.debug? && results.empty?
           Vedeu.log(type:    :event,
                     message: "No action for: '#{name.inspect}'")
         end

data/lib/vedeu/groups/group.rb

@@ -193,5 +193,4 @@ module Vedeu
                  :show_group,
                  :toggle_group
 
-
 end # Vedeu

data/lib/vedeu/logging/log.rb

@@ -24,12 +24,11 @@ module Vedeu
         #
         # @macro vedeu_logging_log_param_message
         # @param type [Symbol] Colour code messages in the log file
-        #   depending on their source. See
-        #   {Vedeu::Configuration.log_types}
+        #   depending on their source. See {Vedeu::LOG_TYPES}
         #
         # @return [String]
         def log(message:, type: :info)
-          if Vedeu.config.log? && Vedeu.config.loggable?(type)
+          if Vedeu.config.loggable?(type)
             output = log_entry(type, message)
             logger.debug(output)
             output
@@ -38,8 +37,8 @@ module Vedeu
 
         # {include:file:docs/dsl/by_method/log_stdout.md}
         # @macro vedeu_logging_log_param_message
-        # @param type [Symbol] See {Vedeu::Configuration.log_types}
-        #   for valid values.
+        # @param type [Symbol] See {Vedeu::LOG_TYPES} for valid
+        #   values.
         # @return [String]
         def log_stdout(message:, type: :info)
           log(message: message, type: type)
@@ -49,8 +48,8 @@ module Vedeu
 
         # {include:file:docs/dsl/by_method/log_stderr.md}
         # @macro vedeu_logging_log_param_message
-        # @param type [Symbol] See {Vedeu::Logging::Log.types}
-        #   for valid values.
+        # @param type [Symbol] See {Vedeu::LOG_TYPES} for valid
+        #   values.
         # @return [String]
         def log_stderr(message:, type: :error)
           log(message: message, type: type)
@@ -100,7 +99,7 @@ module Vedeu
         # @macro vedeu_logging_log_param_message
         # @return [String]
         def log_entry(type, message)
-          colours = Vedeu.config.log_types.fetch(type, [:default, :default])
+          colours = Vedeu::LOG_TYPES.fetch(type, [:default, :default])
 
           [
             Vedeu.esc.colour(colours[0]) { "[#{type}]".ljust(11) },

data/lib/vedeu/renderers/support/options.rb

@@ -53,7 +53,7 @@ module Vedeu
 
       # @macro raise_not_implemented
       def write
-        raise Vedeu::Error::NotImplemented, 'Including classes implement this.'
+        raise Vedeu::Error::NotImplemented
       end
 
       private
@@ -81,7 +81,7 @@ module Vedeu
 
       # @macro raise_not_implemented
       def content
-        raise Vedeu::Error::NotImplemented, 'Including classes implement this.'
+        raise Vedeu::Error::NotImplemented
       end
 
       # @macro defaults_method

data/lib/vedeu/support/point.rb

@@ -79,7 +79,7 @@ module Vedeu
     # @macro raise_invalid_syntax
     # @return [Fixnum]
     def max
-      return @max if numeric?(@max) || @max == Float::INFINITY
+      return @max if numeric?(@max)
 
       raise Vedeu::Error::InvalidSyntax,
             "Expecting 'max' to be a Fixnum or Float::INFINITY."

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/coercers/coercer_test.rb

@@ -8,13 +8,19 @@ module Vedeu
 
     describe Coercer do
 
-      let(:described) { Vedeu::Coercers::Coercer }
-      let(:instance)  { described.new(_value) }
-      let(:_value)    {}
+      let(:described)  { Vedeu::Coercers::Coercer }
+      let(:instance)   { described.new(_value, attributes) }
+      let(:_value)     {}
+      let(:attributes) {
+        {}
+      }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
         it { instance.instance_variable_get('@value').must_equal(_value) }
+        it do
+          instance.instance_variable_get('@attributes').must_equal(attributes)
+        end
       end
 
       describe '.coerce' do

data/test/lib/vedeu/coercers/editor_line_test.rb

@@ -35,19 +35,26 @@ module Vedeu
         end
 
         context 'when the value is a String' do
-          context 'when the value is empty' do
-            let(:_value) { '' }
+          let(:_value) { '' }
+
+          it { subject.must_be_instance_of(klass) }
 
-            it { subject.must_be_instance_of(klass) }
+          context 'when the value is empty' do
             it { subject.collection.must_equal('') }
           end
 
-          context 'when the value is an String' do
+          context 'when the value is not empty' do
             let(:_value) { 'some value...' }
 
-            it { subject.must_be_instance_of(klass) }
             it { subject.collection.must_equal(_value) }
           end
+
+          context 'when the value contains a line feed' do
+            let(:_value)   { "some value...\n" }
+            let(:expected) { 'some value...' }
+
+            it { subject.collection.must_equal(expected) }
+          end
         end
 
         context 'when the value is not already the target class or ' \

data/test/lib/vedeu/common_test.rb

@@ -270,6 +270,12 @@ module Vedeu
         it { subject.must_equal(true) }
       end
 
+      context 'when the value is a Float::INFINITY' do
+        let(:_value) { Float::INFINITY }
+
+        it { subject.must_equal(true) }
+      end
+
       context 'when the value is not numeric' do
         it { subject.must_equal(false) }
       end

data/test/lib/vedeu/configuration/configuration_test.rb

@@ -141,12 +141,6 @@ module Vedeu
       end
     end
 
-    describe '.log_types' do
-      subject { described.log_types }
-
-      it { subject.must_be_instance_of(Hash) }
-    end
-
     describe '.loggable?' do
       subject { described.loggable?(type) }
 

data/test/lib/vedeu/error_test.rb

@@ -7,31 +7,41 @@ module Vedeu
   module Error
 
     describe ActionNotFound do
-    end
+    end # ActionNotFound
 
     describe ControllerNotFound do
-    end
+    end # ControllerNotFound
 
     describe Fatal do
-    end
+    end # Fatal
 
     describe Interrupt do
-    end
+    end # Interrupt
 
     describe InvalidSyntax do
-    end
+    end # InvalidSyntax
 
     describe MissingRequired do
-    end
+    end # MissingRequired
 
     describe ModelNotFound do
-    end
+    end # ModelNotFound
 
     describe ModeSwitch do
-    end
+    end # ModeSwitch
 
     describe NotImplemented do
-    end
+
+      let(:described) { Vedeu::Error::NotImplemented }
+      let(:instance)  { described.new }
+
+      describe '#message' do
+        subject { instance.message }
+
+        it { subject.must_be_instance_of(String) }
+      end
+
+    end # NotImplemented
 
     describe OutOfRange do
 

data/test/lib/vedeu/repositories/assemblage_test.rb

@@ -6,7 +6,7 @@ module Vedeu
 
   module Repositories
 
-    class CollectionTestClass
+    class AssemblageTestClass
 
       include Vedeu::Repositories::Assemblage
 
@@ -21,7 +21,7 @@ module Vedeu
     describe Assemblage do
 
       let(:described)  { Vedeu::Repositories::Assemblage }
-      let(:included_described) { Vedeu::Repositories::CollectionTestClass }
+      let(:included_described) { Vedeu::Repositories::AssemblageTestClass }
       let(:included_instance)  { included_described.new(collection) }
       let(:collection) { 'Some text...'.chars }