vedeu 0.7.4 → 0.8.0

data/lib/vedeu/repositories/registerable.rb

@@ -17,7 +17,7 @@ module Vedeu
         # @return [Symbol]
         def null(klass, attributes = {})
           define_method(:null_model)      { klass }
-          define_method(:null_attributes) { attributes }
+          define_method(:null_attributes) { attributes || {} }
         end
 
         # The real model is the usual model to use for a given
@@ -62,13 +62,27 @@ module Vedeu
 
       end # ClassMethods
 
+      # When {Vedeu::Repositories::Registerable} is included in a
+      # class, the methods within this module are included as instance
+      # methods on that class.
+      #
+      module InstanceMethods
+
+        # @return [Boolean]
+        def null_model?
+          self.respond_to?(:null_model) && present?(:null_model)
+        end
+
+      end # InstanceMethods
+
       # When this module is included in a class, provide ClassMethods
       # as class methods for the class.
       #
       # @param klass [Class]
       # @return [void]
       def self.included(klass)
-        klass.send(:extend, ClassMethods)
+        klass.extend(Vedeu::Repositories::Registerable::ClassMethods)
+        klass.include(Vedeu::Repositories::Registerable::InstanceMethods)
       end
 
     end # Registerable

data/lib/vedeu/repositories/repositories.rb

@@ -38,7 +38,7 @@ module Vedeu
 
     # Remove all stored models from the repository.
     #
-    # @return [TrueClass]
+    # @return [Boolean]
     def reset!
       all.map { |repository| repository.send(:reset) }
 

data/lib/vedeu/repositories/repository.rb

@@ -67,17 +67,7 @@ module Vedeu
 
         return find(name) if registered?(name)
 
-        attrs = if null_attributes.any?
-                  null_attributes.merge!(name: name)
-
-                else
-                  {
-                    name: name
-                  }
-
-                end
-
-        null_model.new(attrs)
+        null_model.new(null_attributes.merge(name: name)) if null_model?
       end
 
       # Return the model for the interface currently in focus.
@@ -143,7 +133,7 @@ module Vedeu
       # when the model does not exist.
       #
       # @param name [String|Symbol]
-      # @return [Hash|FalseClass]
+      # @return [Hash|Boolean]
       def remove(name)
         return false if empty?
         return false unless registered?(name)

data/lib/vedeu/runtime/flags.rb

@@ -12,7 +12,7 @@ module Vedeu
 
         # @return [Boolean]
         def ready!
-          Vedeu.log(type: :info, message: 'Vedeu ready!')
+          Vedeu.log(message: 'Vedeu ready!')
 
           instance.options[:ready] = true
         end

data/lib/vedeu/terminal/terminal.rb

@@ -35,7 +35,12 @@ module Vedeu
     # @param streams [String|Array]
     # @return [Array]
     def output(*streams)
-      streams.each { |stream| console.print(stream) }
+      streams.each do |stream|
+        Vedeu.log(type:    :output,
+                  message: "Writing to terminal #{stream.size} bytes".freeze)
+
+        console.print(stream)
+      end
     end
     alias_method :write, :output
 
@@ -47,7 +52,7 @@ module Vedeu
     # @example
     #   Vedeu.resize
     #
-    # @return [TrueClass]
+    # @return [Boolean]
     def resize
       Vedeu.trigger(:_clear_)
 

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.7.4'.freeze
+  VERSION = '0.8.0'.freeze
 
 end

data/lib/vedeu/views/all.rb

@@ -8,6 +8,9 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/views/default_attributes'
+require 'vedeu/views/value'
+
 require 'vedeu/views/chars'
 require 'vedeu/views/char'
 require 'vedeu/views/html_char'
@@ -15,6 +18,6 @@ require 'vedeu/views/streams'
 require 'vedeu/views/stream'
 require 'vedeu/views/lines'
 require 'vedeu/views/line'
-require 'vedeu/views/view_collection'
+require 'vedeu/views/views'
 require 'vedeu/views/view'
 require 'vedeu/views/composition'

data/lib/vedeu/views/char.rb

@@ -14,7 +14,6 @@ module Vedeu
     class Char
 
       include Comparable
-      include Vedeu::Geometries::Positionable
       include Vedeu::Repositories::Parent
       include Vedeu::Presentation
 
@@ -57,7 +56,7 @@ module Vedeu
       def attributes
         {
           border:   @border,
-          # colour:   colour,
+          colour:   colour,
           name:     @name,
           parent:   @parent,
           position: position,
@@ -107,9 +106,11 @@ module Vedeu
       # @return [String]
       def text
         if border
-          ' '
+          ' '.freeze
+
         else
           @value
+
         end
       end
 
@@ -159,7 +160,7 @@ module Vedeu
           parent:   nil,
           position: nil,
           style:    nil,
-          value:    '',
+          value:    ''.freeze,
         }
       end
 

data/lib/vedeu/views/chars.rb

@@ -8,6 +8,48 @@ module Vedeu
     #
     class Chars < Vedeu::Repositories::Collection
 
+      # @param collection [void]
+      # @param parent [Vedeu::Views::Stream]
+      # @param name [NilClass|Symbol|String]
+      # @raise [Vedeu::Error::InvalidSyntax] When the collection
+      #   cannot be coerced since it is unrecognised or unsupported.
+      # @return [Vedeu::Views::Chars]
+      def self.coerce(collection = [], parent = nil, name = nil)
+        if collection.is_a?(Vedeu::Views::Chars)
+          collection
+
+        elsif collection.is_a?(Array)
+          return new(collection, parent, name) if collection.empty?
+
+          coerced_collection = []
+          collection.each do |element|
+            coerced_collection << element if element.is_a?(Vedeu::Views::Char)
+          end
+
+          new(coerced_collection, parent, name)
+
+        elsif collection.is_a?(Vedeu::Views::Stream)
+
+        elsif collection.is_a?(String)
+          return new([], parent, name) if collection.empty?
+
+          if parent && parent.attributes
+            new_collection = Vedeu::DSL::Text.new(collection,
+                                                  parent.attributes).chars
+
+            new(new_collection, parent, name)
+          end
+
+        else
+          fail Vedeu::Error::InvalidSyntax,
+               'Cannot coerce for Vedeu::View::Streams, as collection ' \
+               'unrecognised.'.freeze
+
+        end
+      end
+
+      alias_method :chars, :value
+
     end # Chars
 
   end # Views

data/lib/vedeu/views/composition.rb

@@ -1,3 +1,5 @@
+require 'vedeu/dsl/all'
+
 module Vedeu
 
   module Views
@@ -8,13 +10,15 @@ module Vedeu
 
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
+      include Vedeu::Views::Value
 
-      collection Vedeu::Views::ViewCollection
-      member     Vedeu::Views::View
+      collection Vedeu::Views::Views
+      deputy     Vedeu::DSL::View
+      entity     Vedeu::Views::View
 
-      # @!attribute [r] parent
-      # @return [NilClass] Composition objects do not have a parent.
-      attr_reader :parent
+      alias_method :views,  :value
+      alias_method :views=, :value=
+      alias_method :views?, :value?
 
       # Returns a new instance of Vedeu::Views::Composition.
       #
@@ -22,7 +26,7 @@ module Vedeu
       # @option attributes client [void]
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes style [Vedeu::Presentation::Style]
-      # @option attributes value [Vedeu::Views::ViewCollection]
+      # @option attributes value [Vedeu::Views::Views]
       # @return [Vedeu::Views::Composition]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
@@ -31,7 +35,7 @@ module Vedeu
       end
 
       # @param child [Vedeu::Views::View]
-      # @return [Vedeu::Views::ViewCollection]
+      # @return [Vedeu::Views::Views]
       def add(child)
         @value = value.add(child)
       end
@@ -40,33 +44,14 @@ module Vedeu
       # @return [Hash]
       def attributes
         {
-          client: @client,
-          colour: @colour,
-          parent: @parent,
-          style:  @style,
+          client: client,
+          colour: colour,
+          parent: parent,
+          style:  style,
           value:  value,
         }
       end
 
-      # Returns a DSL instance responsible for defining the DSL
-      # methods of this model.
-      #
-      # @param client [Object|NilClass] The client binding represents
-      #   the client application object that is currently invoking a
-      #   DSL method. It is required so that we can send messages to
-      #   the client application object should we need to.
-      # @return [Vedeu::DSL::Composition] The DSL instance for this
-      #   model.
-      def deputy(client = nil)
-        Vedeu::DSL::Composition.new(self, client)
-      end
-
-      # @return [Vedeu::Views::ViewCollection]
-      def value
-        collection.coerce(@value, self)
-      end
-      alias_method :views, :value
-
       private
 
       # The default values for a new instance of this class.

data/lib/vedeu/views/default_attributes.rb

@@ -0,0 +1,74 @@
+module Vedeu
+
+  module Views
+
+    # Provides the default attributes for variaus Vedeu::Views models.
+    #
+    # @api private
+    #
+    module DefaultAttributes
+
+      include Vedeu::Repositories::Defaults
+
+      # @!attribute [r] align
+      # @return [Vedeu::Coercers::Alignment]
+      attr_reader :align
+
+      # @!attribute [r] pad
+      # @return [String]
+      attr_reader :pad
+
+      # @!attribute [r] truncate
+      # @return [Boolean]
+      attr_reader :truncate
+
+      # @!attribute [r] width
+      # @return [Fixnum|NilClass]
+      attr_reader :width
+
+      # @!attribute [r] wordwrap
+      # @return [Boolean]
+      attr_reader :wordwrap
+
+      # @return [Hash<Symbol => void>]
+      def attributes
+        {
+          align:    align,
+          client:   client,
+          colour:   colour,
+          name:     name,
+          pad:      pad,
+          parent:   parent,
+          style:    style,
+          truncate: truncate,
+          width:    width,
+          wordwrap: wordwrap,
+        }
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash<Symbol => Array<void>|NilClass>]
+      def defaults
+        {
+          align:    nil,
+          client:   nil,
+          colour:   nil,
+          name:     nil,
+          pad:      ' '.freeze,
+          parent:   nil,
+          style:    nil,
+          truncate: false,
+          value:    ''.freeze,
+          width:    nil,
+          wordwrap: false,
+        }
+      end
+
+    end # DefaultAttributes
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/views/html_char.rb

@@ -118,8 +118,8 @@ module Vedeu
       # @return [Hash<Symbol => String>]
       def defaults
         {
-          start_tag: '<td',
-          end_tag:   '</td>',
+          start_tag: '<td'.freeze,
+          end_tag:   '</td>'.freeze,
         }
       end
 

data/lib/vedeu/views/line.rb

@@ -1,3 +1,5 @@
+require 'vedeu/dsl/all'
+
 module Vedeu
 
   module Views
@@ -8,16 +10,34 @@ module Vedeu
     #
     class Line
 
+      # Provides DSL methods for Vedeu::Views::Line objects.
+      #
+      # @api public
+      #
+      class DSL
+
+        include Vedeu::DSL
+        include Vedeu::DSL::Elements
+
+      end # DSL
+
+      extend Forwardable
+      include Vedeu::Views::DefaultAttributes
       include Vedeu::Repositories::Model
       include Vedeu::Repositories::Parent
       include Vedeu::Presentation
+      include Vedeu::Views::Value
 
       collection Vedeu::Views::Streams
-      member     Vedeu::Views::Stream
+      deputy     Vedeu::Views::Line::DSL
+      entity     Vedeu::Views::Stream
+      parent     Vedeu::Views::Lines
+
+      def_delegators :value,
+                     :streams
 
-      # @!attribute [rw] parent
-      # @return [Vedeu::Views::View]
-      attr_accessor :parent
+      alias_method :streams=, :value=
+      alias_method :streams?, :value?
 
       # Returns a new instance of Vedeu::Views::Line.
       #
@@ -42,42 +62,18 @@ module Vedeu
       end
       alias_method :<<, :add
 
-      # @return [Hash<Symbol => void>]
-      def attributes
-        {
-          client: @client,
-          colour: @colour,
-          name:   name,
-          parent: parent,
-          style:  @style,
-          value:  value,
-        }
-      end
-
       # Returns an array of all the characters with formatting for
       # this line.
       #
       # @return [Array]
       # @see Vedeu::Views::Stream
       def chars
-        return [] if value.empty?
+        return [] unless value?
 
-        @chars ||= value.flat_map(&:chars)
+        @chars ||= streams.flat_map(&:chars)
       end
 
-      # Returns a DSL instance responsible for defining the DSL
-      # methods of this model.
-      #
-      # @param client [Object|NilClass] The client binding represents
-      #   the client application object that is currently invoking a
-      #   DSL method. It is required so that we can send messages to
-      #   the client application object should we need to.
-      # @return [Vedeu::DSL::Line] The DSL instance for this model.
-      def deputy(client = nil)
-        Vedeu::DSL::Line.new(self, client)
-      end
-
-      # An object is equal when its values are the same./
+      # An object is equal when its values are the same.
       #
       # @param other [Vedeu::Repositories::Collection]
       # @return [Boolean]
@@ -94,28 +90,6 @@ module Vedeu
         value.map(&:size).inject(0, :+)
       end
 
-      # @return [Vedeu::Views::Streams]
-      def value
-        collection.coerce(@value, self)
-      end
-      alias_method :streams, :value
-
-      private
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => Array<void>|NilClass>]
-      def defaults
-        {
-          client: nil,
-          colour: nil,
-          name:   nil,
-          parent: nil,
-          style:  nil,
-          value:  [],
-        }
-      end
-
     end # Line
 
   end # Views