vedeu 0.7.4 → 0.8.0

data/lib/vedeu/menus/menu.rb

@@ -201,7 +201,7 @@ module Vedeu
           client:     nil,
           collection: [],
           current:    0,
-          name:       '',
+          name:       ''.freeze,
           repository: Vedeu.menus,
           selected:   nil,
         }

data/lib/vedeu/models/focus.rb

@@ -216,7 +216,7 @@ module Vedeu
       # refresh event for that interface. Returns false when the
       # storage is empty.
       #
-      # @return [String|FalseClass]
+      # @return [String|Boolean]
       def update
         return false if storage.empty?
 

data/lib/vedeu/models/toggleable.rb

@@ -15,7 +15,7 @@ module Vedeu
 
     # Set the visible state to false and store the model.
     #
-    # @return [FalseClass]
+    # @return [Boolean]
     def hide
       @visible = false
 
@@ -24,7 +24,7 @@ module Vedeu
 
     # Set the visible state to true and store the model.
     #
-    # @return [TrueClass]
+    # @return [Boolean]
     def show
       @visible = true
 
@@ -34,7 +34,7 @@ module Vedeu
     # Toggle the visible state and store the model. When the model is
     # hidden, then it is shown, and vice versa.
     #
-    # @return [FalseClass|TrueClass]
+    # @return [Boolean]
     def toggle
       return hide if visible?
 
@@ -150,7 +150,7 @@ module Vedeu
     # @param klass [Class]
     # @return [void]
     def self.included(klass)
-      klass.send(:extend, ClassMethods)
+      klass.extend(Vedeu::Toggleable::ClassMethods)
     end
 
   end # Toggleable

data/lib/vedeu/null/generic.rb

@@ -24,7 +24,7 @@ module Vedeu
         @name       = @attributes.fetch(:name, '')
       end
 
-      # @return [FalseClass]
+      # @return [Boolean]
       def falsy
         false
       end
@@ -73,7 +73,7 @@ module Vedeu
         self
       end
 
-      # @return [FalseClass]
+      # @return [Boolean]
       def visible=(*)
         false
       end

data/lib/vedeu/output/all.rb

@@ -8,9 +8,7 @@ end # Vedeu
 
 require 'vedeu/output/compressor_cache'
 require 'vedeu/output/compressor'
-require 'vedeu/output/text'
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
-require 'vedeu/output/wordwrap'
 require 'vedeu/output/refresh'
 require 'vedeu/output/write'

data/lib/vedeu/output/compressor_cache.rb

@@ -44,7 +44,7 @@ module Vedeu
       # @return [Hash<Symbol => Array<void>>]
       def in_memory
         {
-          compressed: '',
+          compressed: ''.freeze,
           original:   [],
         }
       end

data/lib/vedeu/output/output.rb

@@ -58,17 +58,17 @@ module Vedeu
 
       # @return [Array]
       def buffer_update
-        buffer_update!
+        Vedeu::Buffers::Terminal.update(output)
       end
 
       # @return [Array]
       def buffer_write
-        buffer_write!
+        Vedeu::Buffers::Terminal.write(output)
       end
 
       # @return [Array<String>]
       def direct_write
-        direct_write!
+        Vedeu::Terminal.output(output.to_s)
       end
 
       # Send the view to the renderers. If the output is a
@@ -81,10 +81,10 @@ module Vedeu
       # @return [Array|String|NilClass]
       def render_output
         if escape_sequence?
-          direct_write!
+          direct_write
 
         else
-          buffer_write!
+          buffer_write
 
         end
       end
@@ -98,21 +98,6 @@ module Vedeu
 
       private
 
-      # @return [Array]
-      def buffer_update!
-        Vedeu::Buffers::Terminal.update(output)
-      end
-
-      # @return [Array]
-      def buffer_write!
-        Vedeu::Buffers::Terminal.write(output)
-      end
-
-      # @return [Array<String>]
-      def direct_write!
-        Vedeu::Terminal.output(output.to_s)
-      end
-
       # @return [Boolean]
       def escape_sequence?
         output.is_a?(Vedeu::Cells::Escape)

data/lib/vedeu/presentation/colour.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # Provides colour related presentation behaviour.
     #
+    # @api private
+    #
     module Colour
 
       include Vedeu::Repositories::Parent
@@ -12,17 +14,18 @@ module Vedeu
 
       # @return [Vedeu::Colours::Colour]
       def colour
-        @_colour ||= if @colour
+        @_colour ||= if colour?
                        Vedeu::Colours::Colour.coerce(@colour)
 
-                     elsif self.is_a?(Vedeu::Views::Char) && name
-                       Vedeu::Colours::Colour.coerce(interface.colour)
+                     elsif parent_colour?
+                       Vedeu::Colours::Colour.coerce(parent_colour)
 
-                     elsif self.respond_to?(:named_parent) && name
-                       Vedeu::Colours::Colour.coerce(named_parent.colour)
+                     elsif named_colour?
+                       Vedeu::Colours::Colour.coerce(named_colour)
 
-                     elsif parent && present?(parent.colour)
-                       Vedeu::Colours::Colour.coerce(parent.colour)
+                     elsif self.is_a?(Vedeu::Views::Char) && name
+                       # Currently used by Vedeu::Output::Viewport
+                       Vedeu::Colours::Colour.coerce(interface.colour)
 
                      else
                        Vedeu::Colours::Colour.new
@@ -38,6 +41,35 @@ module Vedeu
         @_colour = @colour = Vedeu::Colours::Colour.coerce(value)
       end
 
+      # @return [Boolean]
+      def colour?
+        present?(@colour)
+      end
+
+      private
+
+      # @return [Vedeu::Colours::Colour]
+      def named_colour
+        Vedeu.interfaces.by_name(name).colour
+      end
+
+      # @return [Boolean]
+      def named_colour?
+        return false if self.is_a?(Vedeu::Interfaces::Interface)
+
+        present?(name) && Vedeu.interfaces.registered?(name)
+      end
+
+      # @return [Vedeu::Colours::Colour]
+      def parent_colour
+        parent.colour
+      end
+
+      # @return [Boolean]
+      def parent_colour?
+        present?(parent) && parent.respond_to?(:colour?)
+      end
+
     end # Colour
 
   end # Presentation

data/lib/vedeu/presentation/style.rb

@@ -15,23 +15,37 @@ module Vedeu
     #
     class Style
 
+      class << self
+
+        include Vedeu::Common
+
+        # Produces new objects of the correct class from the value,
+        # ignores objects that have already been coerced.
+        #
+        # @param value [Object|NilClass]
+        # @return [Object]
+        def coerce(value)
+          return value if value.is_a?(Vedeu::Presentation::Style)
+          return new(value) unless value.is_a?(Hash)
+          return new unless present?(value[:style])
+
+          if value[:style].is_a?(Vedeu::Presentation::Style)
+            value[:style]
+
+          else
+            new(value[:style])
+
+          end
+        end
+
+      end # Eigenclass
+
       include Vedeu::Common
 
       # @!attribute [rw] value
       # @return [String|Symbol]
       attr_accessor :value
 
-      # Produces new objects of the correct class from the value,
-      # ignores objects that have already been coerced.
-      #
-      # @param value [Object|NilClass]
-      # @return [Object]
-      def self.coerce(value)
-        return value if value.is_a?(self)
-
-        new(value)
-      end
-
       # Return a new instance of Vedeu::Presentation::Style.
       #
       # @param value [Array<String|Symbol>|String|Symbol]

data/lib/vedeu/renderers/html.rb

@@ -36,7 +36,7 @@ module Vedeu
       def clear
         @output = Vedeu::Cells::Escape.new
 
-        ''
+        ''.freeze
       end
 
       # @param output [Vedeu::Models::Page]
@@ -49,14 +49,14 @@ module Vedeu
 
       # @return [String]
       def html_body
-        return '' if output.is_a?(Vedeu::Cells::Escape)
+        return ''.freeze if output.is_a?(Vedeu::Cells::Escape)
 
         out = ''
 
         output.each do |line|
-          out << "#{start_row_tag}\n"
+          out << "#{start_row_tag}\n".freeze
           line.each { |char| out << char.to_html(options) }
-          out << "#{end_row_tag}\n"
+          out << "#{end_row_tag}\n".freeze
         end
 
         out.freeze
@@ -108,12 +108,12 @@ module Vedeu
       # @return [Hash<Symbol => void>]
       def defaults
         {
-          content:       '',
-          end_tag:       '</td>',
-          end_row_tag:   '</tr>',
-          filename:      'out',
-          start_tag:     '<td',
-          start_row_tag: '<tr>',
+          content:       ''.freeze,
+          end_tag:       '</td>'.freeze,
+          end_row_tag:   '</tr>'.freeze,
+          filename:      'out'.freeze,
+          start_tag:     '<td'.freeze,
+          start_row_tag: '<tr>'.freeze,
           template:      default_template,
           timestamp:     false,
           write_file:    true,
@@ -122,7 +122,7 @@ module Vedeu
 
       # @return [String]
       def default_template
-        ::File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
+        ::File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'.freeze
       end
 
     end # HTML

data/lib/vedeu/repositories/assemblage.rb

@@ -19,6 +19,15 @@ module Vedeu
         collection[index]
       end
 
+      # Returns a boolean indicating whether the collection is not
+      # empty.
+      #
+      # @param block [Proc]
+      # @return [Boolean]
+      def any?(&block)
+        collection.any?(&block)
+      end
+
       # Provides iteration over the collection.
       #
       # @param block [Proc]

data/lib/vedeu/repositories/collection.rb

@@ -15,6 +15,7 @@ module Vedeu
       # @return [Array|Vedeu::Repositories::Collection]
       attr_reader :collection
       alias_method :all, :collection
+      alias_method :value, :collection
 
       # @!attribute [rw] parent
       # @return [Fixnum]

data/lib/vedeu/repositories/defaults.rb

@@ -21,7 +21,10 @@ module Vedeu
       # @return [void] A new instance of the class including this
       #   module.
       def initialize(attributes = {})
-        attrs = attributes.to_h.keep_if { |key, _| defaults.key?(key) }
+        fail Vedeu::Error::InvalidSyntax,
+             'Argument :attributes is not a Hash.' unless attributes.is_a?(Hash)
+
+        attrs = attributes.keep_if { |key, _| defaults.key?(key) }
 
         defaults.merge!(attrs).each do |key, value|
           instance_variable_set("@#{key}", value || defaults.fetch(key))

data/lib/vedeu/repositories/model.rb

@@ -33,28 +33,16 @@ module Vedeu
         # @param block [Proc] The block passed to the build method.
         # @return [Object] An instance of the model.
         def build(attributes = {}, &block)
-          attributes = defaults.merge!(attributes)
-
           model = new(attributes)
 
-          if block_given?
-            model.deputy(attributes[:client]).instance_eval(&block)
-          end
+          Vedeu.log(type:    :debug,
+                    message: "DSL building: '#{model.class.name}' for " \
+                             "'#{model.name}'".freeze)
 
-          model
-        end
+          model.deputy.instance_eval(&block) if block_given?
 
-        # Provide a convenient way to define the child or children of
-        # a model.
-        #
-        # @param klass [Class] The member (singular) or collection
-        #   (multiple) class name for the respective model.
-        # @return [void]
-        def child(klass)
-          send(:define_method, __callee__) { klass }
+          model
         end
-        alias_method :member,     :child
-        alias_method :collection, :child
 
         # Allow models to specify their repository using a class
         # method.
@@ -73,25 +61,7 @@ module Vedeu
         #   storing.
         # @return [Object] An instance of the model.
         def store(attributes = {}, &block)
-          if block_given?
-            new(attributes).store(&block)
-
-          else
-            new(attributes).store
-
-          end
-        end
-
-        private
-
-        # The default values for a new instance of this class.
-        #
-        # @return [Hash<Symbol => NilClass, String>]
-        def defaults
-          {
-            client: nil,
-            name:   '',
-          }
+          new(attributes).store(&block)
         end
 
       end # ClassMethods
@@ -102,7 +72,7 @@ module Vedeu
       # @param klass [Class]
       # @return [void]
       def self.included(klass)
-        klass.send(:extend, ClassMethods)
+        klass.extend(Vedeu::Repositories::Model::ClassMethods)
       end
 
       # @note If a block is given, store the model, return the model

data/lib/vedeu/repositories/parent.rb

@@ -11,18 +11,18 @@ module Vedeu
 
       # @return [NilClass|void]
       def parent
-        @_parent ||= present?(@parent) ? @parent : nil
+        present?(@parent) ? @parent : nil
       end
 
       # @return [NilClass|String|Symbol]
       def name
-        @_name ||= if present?(@name)
-                     @name
+        if present?(@name)
+          @name
 
-                   elsif parent && present?(parent.name)
-                     parent.name
+        elsif parent && present?(parent.name)
+          parent.name
 
-                   end
+        end
       end
 
     end # Parent