vedeu 0.7.4 → 0.8.0

data/lib/vedeu/views/lines.rb

@@ -8,6 +8,37 @@ module Vedeu
     #
     class Lines < Vedeu::Repositories::Collection
 
+      # @param (see Vedeu::Repositories::Collection#initialize)
+      # @raise [Vedeu::Error::InvalidSyntax] When the collection
+      #   cannot be coerced since it is unrecognised or unsupported.
+      # @return [Vedeu::Views::Lines]
+      def self.coerce(collection = [], parent = nil, name = nil)
+        if collection.is_a?(Vedeu::Views::Lines)
+          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::Line)
+          end
+
+          new(coerced_collection, parent, name)
+
+        elsif collection.is_a?(Vedeu::Views::Line)
+          new([collection], parent, name)
+
+        else
+          fail Vedeu::Error::InvalidSyntax,
+               'Cannot coerce for Vedeu::View::Lines, as collection ' \
+               'unrecognised.'.freeze
+
+        end
+      end
+
+      alias_method :lines, :value
+
     end # Lines
 
   end # Views

data/lib/vedeu/views/stream.rb

@@ -1,3 +1,5 @@
+require 'vedeu/dsl/all'
+
 module Vedeu
 
   module Views
@@ -8,30 +10,50 @@ module Vedeu
     #
     class Stream
 
+      # Provides DSL methods for Vedeu::Views::Stream 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::Chars
-      member     Vedeu::Views::Char
+      deputy     Vedeu::Views::Stream::DSL
+      entity     Vedeu::Views::Char
+      parent     Vedeu::Views::Streams
 
-      # @!attribute [rw] parent
-      # @return [Vedeu::Views::Line]
-      attr_accessor :parent
+      def_delegators :value,
+                     :chars,
+                     :size
 
-      # @!attribute [rw] value
-      # @return [String]
-      attr_accessor :value
       alias_method :content, :value
       alias_method :text,    :value
+      alias_method :chars=, :value=
+      alias_method :chars?, :value?
+
+      # @!attribute [w] value
+      # @return [String]
+      attr_writer :value
 
       # Returns a new instance of Vedeu::Views::Stream.
       #
       # @param attributes [Hash]
       # @option attributes client [void]
       # @option attributes colour [Vedeu::Colours::Colour]
-      # @option attributes style [Vedeu::Presentation::Style]
+      # @option attributes name [String|Symbol]
       # @option attributes parent [Vedeu::Views::Line]
+      # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes value [String]
       # @return [Vedeu::Views::Stream]
       def initialize(attributes = {})
@@ -47,84 +69,15 @@ 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 characters, each element is the escape
-      # sequences of colours and styles for this stream, the character
-      # itself, and the escape sequences of colours and styles for the
-      # parent of the stream ({Vedeu::Views::Line}).
-      #
-      # @return [Array]
-      def chars
-        return [] if value.empty?
-
-        @chars ||= value.chars.map do |char|
-          member.new(value:    char,
-                     name:     name,
-                     parent:   parent,
-                     colour:   colour,
-                     style:    style,
-                     position: nil)
-        end
-      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::Stream] The DSL instance for this model.
-      def deputy(client = nil)
-        Vedeu::DSL::Stream.new(self, client)
-      end
-
       # An object is equal when its values are the same.
       #
       # @param other [Vedeu::Views::Char]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && value == other.value &&
-          colour == other.colour && style == other.style &&
-          parent == other.parent
+        self.class == other.class && value == other.value
       end
       alias_method :==, :eql?
 
-      # Returns the size of the content in characters without
-      # formatting.
-      #
-      # @return [Fixnum]
-      def size
-        value.size
-      end
-
-      private
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash]
-      def defaults
-        {
-          client: nil,
-          colour: nil,
-          name:   nil,
-          parent: nil,
-          style:  nil,
-          value:  '',
-        }
-      end
-
     end # Stream
 
   end # Views

data/lib/vedeu/views/streams.rb

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

data/lib/vedeu/views/value.rb

@@ -0,0 +1,150 @@
+module Vedeu
+
+  module Views
+
+    # Provides view model methods for Vedeu::Views.
+    #
+    # @api private
+    #
+    module Value
+
+      # Provides view model class methods for Vedeu::Views.
+      #
+      # @api private
+      #
+      module ClassMethods
+
+        # @!attribute [w] collection_klass
+        # @return [void]
+        attr_reader :collection_klass
+
+        # @!attribute [w] deputy_klass
+        # @return [void]
+        attr_reader :deputy_klass
+
+        # @!attribute [w] entity_klass
+        # @return [void]
+        attr_reader :entity_klass
+
+        # @!attribute [w] parent_klass
+        # @return [void]
+        attr_reader :parent_klass
+
+        # @param model [void]
+        # @return [void]
+        def collection(model)
+          @collection_klass = model
+        end
+
+        # @param model [void]
+        # @return [void]
+        def deputy(model)
+          @deputy_klass = model
+        end
+
+        # @param model [void]
+        # @return [void]
+        def entity(model)
+          @entity_klass = model
+        end
+
+        # @param model [void]
+        # @return [void]
+        def parent(model)
+          @parent_klass = model
+        end
+
+      end # ClassMethods
+
+      # Provides view model instance methods for Vedeu::Views.
+      #
+      # @api private
+      #
+      module InstanceMethods
+
+        include Vedeu::Common
+
+        # 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.
+        #
+        # @!attribute [rw] client
+        # @return [void]
+        attr_accessor :client
+
+        # @!attribute [rw] parent
+        # @return [void]
+        attr_accessor :parent
+
+        # @return [Boolean]
+        def client?
+          present?(client)
+        end
+
+        # @return [void]
+        def collection
+          self.class.collection_klass
+        end
+
+        # Returns a DSL instance responsible for defining the DSL
+        # methods of this model.
+        #
+        # @return [void]
+        def deputy
+          self.class.deputy_klass.new(self, client)
+        end
+
+        # @return [void]
+        def entity
+          self.class.entity_klass
+        end
+
+        # @return [Boolean]
+        def parent?
+          present?(parent)
+        end
+
+        # @return [void]
+        def value
+          @_value ||= if present?(@value)
+                        collection.coerce(@value, self)
+
+                      else
+                        collection.coerce([], self)
+
+                      end
+        end
+
+        # @param value [void]
+        # @return [void]
+        def value=(value)
+          @_value = @value = collection.coerce(value, self)
+        end
+
+        # Returns a boolean indicating whether this model has a
+        # non-empty value.
+        #
+        # @return [Boolean]
+        def value?
+          value.any?
+        end
+
+      end # InstanceMethods
+
+      # When this module is included in a class, provide ClassMethods
+      # as class methods and InstanceMethods as instance methods for
+      # the given class.
+      #
+      # @param klass [Class]
+      # @return [void]
+      def self.included(klass)
+        klass.extend(Vedeu::Views::Value::ClassMethods)
+        klass.include(Vedeu::Views::Value::InstanceMethods)
+      end
+
+    end # Value
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/views/view.rb

@@ -1,3 +1,5 @@
+require 'vedeu/dsl/all'
+
 module Vedeu
 
   module Views
@@ -7,16 +9,36 @@ module Vedeu
     #
     class View
 
+      # Provides DSL methods for Vedeu::Views::View objects.
+      #
+      # @api public
+      #
+      class DSL
+
+        include Vedeu::DSL
+        include Vedeu::DSL::Border
+        include Vedeu::DSL::Cursors
+        include Vedeu::DSL::Elements
+        include Vedeu::DSL::Geometry
+        include Vedeu::DSL::Use
+
+      end # DSL
+
+      extend Forwardable
       include Vedeu::Repositories::Model
       include Vedeu::Repositories::Parent
       include Vedeu::Presentation
+      include Vedeu::Views::Value
 
       collection Vedeu::Views::Lines
-      member     Vedeu::Views::Line
+      deputy     Vedeu::Views::View::DSL
+      entity     Vedeu::Views::Line
 
-      # @!attribute [rw] client
-      # @return [Fixnum|Float]
-      attr_accessor :client
+      def_delegators :value,
+                     :lines
+
+      alias_method :lines=, :value=
+      alias_method :lines?, :value?
 
       # @!attribute [rw] cursor_visible
       # @return [Boolean]
@@ -24,17 +46,9 @@ module Vedeu
       alias_method :cursor_visible?, :cursor_visible
 
       # @!attribute [rw] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_accessor :name
 
-      # @!attribute [rw] parent
-      # @return [Vedeu::Views::Composition]
-      attr_accessor :parent
-
-      # @!attribute [w] lines
-      # @return [Array<Vedeu::Views::Line>]
-      attr_writer :lines
-
       # @!attribute [rw] zindex
       # @return [Fixnum]
       attr_accessor :zindex
@@ -60,14 +74,14 @@ module Vedeu
       # @param child [Vedeu::Views::Line]
       # @return [Vedeu::Views::Lines]
       def add(child)
-        @value = value.add(child)
+        @_value = value.add(child)
       end
       alias_method :<<, :add
 
       # @return [Hash]
       def attributes
         {
-          client:         @client,
+          client:         client,
           colour:         colour,
           cursor_visible: cursor_visible,
           name:           name,
@@ -78,26 +92,8 @@ module Vedeu
         }
       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::View] The DSL instance for this model.
-      def deputy(client = nil)
-        Vedeu::DSL::View.new(self, client)
-      end
-
-      # @return [Vedeu::Views::Lines]
-      def value
-        collection.coerce(@value, self)
-      end
-      alias_method :lines, :value
-
       # Store the view and immediately refresh it; causing to be
-      # pushed to the Terminal. Called by {Vedeu::DSL::View.renders}.
+      # pushed to the Terminal. Called by {Vedeu::DSL::Views.renders}.
       #
       # @return [Vedeu::Views::View]
       def store_immediate
@@ -110,7 +106,7 @@ module Vedeu
 
       # When a name is given, the view is stored with this name. This
       # view will be shown next time a refresh event is triggered with
-      # this name. Called by {Vedeu::DSL::View.views}.
+      # this name. Called by {Vedeu::DSL::Views.views}.
       #
       # @raise [Vedeu::Error::InvalidSyntax] The name is not defined.
       # @return [Vedeu::Views::View]
@@ -146,7 +142,7 @@ module Vedeu
           client:         nil,
           colour:         Vedeu::Configuration.colour,
           cursor_visible: true,
-          name:           '',
+          name:           ''.freeze,
           parent:         nil,
           style:          :normal,
           value:          [],