vedeu 0.6.7 → 0.6.8

data/lib/vedeu/models/cell.rb

@@ -1,70 +1,77 @@
 module Vedeu
 
-  # A Cell represents a single square of the terminal.
-  #
-  class Cell
+  module Models
 
-    # @!attribute [r] colour
-    # @return [NilClass|String]
-    attr_reader :colour
+    # A Cell represents a single square of the terminal.
+    #
+    class Cell
 
-    # @!attribute [r] style
-    # @return [NilClass|Array<Symbol|String>|Symbol|String]
-    attr_reader :style
+      # @!attribute [r] colour
+      # @return [NilClass|String]
+      attr_reader :colour
 
-    # @!attribute [r] value
-    # @return [NilClass|String]
-    attr_reader :value
+      # @!attribute [r] style
+      # @return [NilClass|Array<Symbol|String>|Symbol|String]
+      attr_reader :style
 
-    # @!attribute [r] x
-    # @return [NilClass|Fixnum]
-    attr_reader :x
+      # @!attribute [r] value
+      # @return [NilClass|String]
+      attr_reader :value
 
-    # @!attribute [r] y
-    # @return [NilClass|Fixnum]
-    attr_reader :y
+      # @!attribute [r] x
+      # @return [NilClass|Fixnum]
+      attr_reader :x
 
-    # Returns a new instance of Vedeu::Cell.
-    #
-    # @param attributes [Hash<Symbol => Array<Symbol|String>,
-    #                                   Fixnum, String, Symbol]
-    # @option attributes colour [NilClass|String]
-    # @option attributes style [NilClass|Array<Symbol|String>|Symbol|String]
-    # @option attributes value [NilClass|String]
-    # @option attributes x [NilClass|Fixnum]
-    # @option attributes y [NilClass|Fixnum]
-    # @return [Vedeu::Cell]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
+      # @!attribute [r] y
+      # @return [NilClass|Fixnum]
+      attr_reader :y
 
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
+      # Returns a new instance of Vedeu::Models::Cell.
+      #
+      # @param attributes [Hash<Symbol => Array<Symbol|String>,
+      #                                   Fixnum, String, Symbol]
+      # @option attributes colour [NilClass|String]
+      # @option attributes style
+      #   [NilClass|Array<Symbol|String>|Symbol|String]
+      # @option attributes value [NilClass|String]
+      # @option attributes x [NilClass|Fixnum]
+      # @option attributes y [NilClass|Fixnum]
+      # @return [Vedeu::Models::Cell]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
 
-    # An object is equal when its values are the same.
-    #
-    # @param other [Vedeu::Cell]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && value == other.value && x == other.x &&
-        y == other.y
-    end
-    alias_method :==, :eql?
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
 
-    private
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Models::Cell]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && value == other.value && x == other.x &&
+          y == other.y
+      end
+      alias_method :==, :eql?
 
-    # Returns the default options/attributes for this class.
-    #
-    # @return [Hash<Symbol => void>]
-    def defaults
-      {
-        colour: nil,
-        style:  nil,
-        value:  nil,
-        x:      nil,
-        y:      nil,
-      }
-    end
+      private
+
+      # Returns the default options/attributes for this class.
+      #
+      # @return [Hash<Symbol => void>]
+      def defaults
+        {
+          colour: nil,
+          style:  nil,
+          value:  nil,
+          x:      nil,
+          y:      nil,
+        }
+      end
+
+    end # Cell
 
-  end # Cell
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/escape.rb

@@ -1,64 +1,69 @@
 module Vedeu
 
-  # Represents an invisible escape character sequence.
-  #
-  class Escape
+  module Models
 
-    # @!attribute [r] value
-    # @return [String]
-    attr_reader :value
-
-    # Returns a new instance of Vedeu::Escape.
+    # Represents an invisible escape character sequence.
     #
-    # @param attributes [String]
-    # @option attributes position [Vedeu::Geometry::Position|Array<Fixnum>]
-    # @option attributes value [String]
-    # @return [Vedeu::Escape]
-    def initialize(attributes = {})
-      defaults.merge!(attributes).each do |key, value|
-        instance_variable_set("@#{key}", value)
+    class Escape
+
+      # @!attribute [r] value
+      # @return [String]
+      attr_reader :value
+
+      # Returns a new instance of Vedeu::Models::Escape.
+      #
+      # @param attributes [String]
+      # @option attributes position
+      #   [Vedeu::Geometry::Position|Array<Fixnum>]
+      # @option attributes value [String]
+      # @return [Vedeu::Models::Escape]
+      def initialize(attributes = {})
+        defaults.merge!(attributes).each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
       end
-    end
 
-    # @return [NilClass]
-    def null
-      nil
-    end
-    alias_method :background, :null
-    alias_method :colour,     :null
-    alias_method :foreground, :null
-    alias_method :style,      :null
+      # @return [NilClass]
+      def null
+        nil
+      end
+      alias_method :background, :null
+      alias_method :colour,     :null
+      alias_method :foreground, :null
+      alias_method :style,      :null
 
-    # 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
-    end
-    alias_method :==, :eql?
+      # 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
+      end
+      alias_method :==, :eql?
 
-    # @return [String]
-    def position
-      Vedeu::Geometry::Position.coerce(@position)
-    end
+      # @return [String]
+      def position
+        Vedeu::Geometry::Position.coerce(@position)
+      end
 
-    # @return [String]
-    def to_s
-      "#{position}#{value}"
-    end
-    alias_method :to_str, :to_s
+      # @return [String]
+      def to_s
+        "#{position}#{value}"
+      end
+      alias_method :to_str, :to_s
 
-    private
+      private
+
+      # @return [Hash]
+      def defaults
+        {
+          position: [1, 1],
+          value:    '',
+        }
+      end
 
-    # @return [Hash]
-    def defaults
-      {
-        position: [1, 1],
-        value:    '',
-      }
-    end
+    end # Escape
 
-  end # Escape
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/page.rb

@@ -1,89 +1,94 @@
 module Vedeu
 
-  # A Page represents an array of Vedeu::Row objects.
-  #
-  class Page
+  module Models
 
-    include Enumerable
+    # A Page represents an array of Vedeu::Models::Row objects.
+    #
+    class Page
+
+      include Enumerable
 
-    # @!attribute [r] rows
-    # @return [Array<NilClass|Vedeu::Row>]
-    attr_reader :rows
+      # @!attribute [r] rows
+      # @return [Array<NilClass|Vedeu::Models::Row>]
+      attr_reader :rows
 
-    # @param value [Vedeu::Page|Vedeu::Row|Array<void>|void]
-    # @return [Vedeu::Page]
-    def self.coerce(value)
-      if value.is_a?(Vedeu::Page)
-        value
+      # @param value
+      #   [Vedeu::Models::Page|Vedeu::Models::Row|Array<void>|void]
+      # @return [Vedeu::Models::Page]
+      def self.coerce(value)
+        if value.is_a?(Vedeu::Models::Page)
+          value
 
-      elsif value.is_a?(Vedeu::Row)
-        Vedeu::Page.new([value])
+        elsif value.is_a?(Vedeu::Models::Row)
+          Vedeu::Models::Page.new([value])
 
-      elsif value.is_a?(Array) && value.empty?
-        Vedeu::Page.new([Vedeu::Row.coerce(value)])
+        elsif value.is_a?(Array) && value.empty?
+          Vedeu::Models::Page.new([Vedeu::Models::Row.coerce(value)])
 
-      elsif value.is_a?(Array)
-        values = value.map do |v|
-          if v.is_a?(Vedeu::Row)
-            v
+        elsif value.is_a?(Array)
+          values = value.map do |v|
+            if v.is_a?(Vedeu::Models::Row)
+              v
 
-          else
-            Vedeu::Row.coerce(v)
+            else
+              Vedeu::Models::Row.coerce(v)
 
+            end
           end
+          Vedeu::Models::Page.new(values)
+
+        else
+          fail Vedeu::Error::InvalidSyntax,
+               'Cannot coerce as value is not an Array.'
+
         end
-        Vedeu::Page.new(values)
+      end
 
-      else
-        fail Vedeu::Error::InvalidSyntax,
-             'Cannot coerce as value is not an Array.'
+      # Returns an instance of Vedeu::Models::Page.
+      #
+      # @param rows [Array<NilClass|Vedeu::Models::Row>]
+      # @return [Vedeu::Models::Page]
+      def initialize(rows = [])
+        @rows = rows || []
+      end
 
+      # Provides iteration over the collection.
+      #
+      # @param block [Proc]
+      # @return [Enumerator]
+      def each(&block)
+        rows.each(&block)
       end
-    end
 
-    # Returns an instance of Vedeu::Page.
-    #
-    # @param rows [Array<NilClass|Vedeu::Row>]
-    # @return [Vedeu::Page]
-    def initialize(rows = [])
-      @rows = rows || []
-    end
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Models::Page]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && rows == other.rows
+      end
+      alias_method :==, :eql?
 
-    # Provides iteration over the collection.
-    #
-    # @param block [Proc]
-    # @return [Enumerator]
-    def each(&block)
-      rows.each(&block)
-    end
+      # @param index [Fixnum]
+      # @return [NilClass|Vedeu::Models::Row]
+      def row(index = nil)
+        return nil if index.nil?
 
-    # An object is equal when its values are the same.
-    #
-    # @param other [Vedeu::Page]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && rows == other.rows
-    end
-    alias_method :==, :eql?
-
-    # @param index [Fixnum]
-    # @return [NilClass|Vedeu::Row]
-    def row(index = nil)
-      return nil if index.nil?
-
-      rows[index]
-    end
-
-    # @param row_index [Fixnum]
-    # @param cell_index [Fixnum]
-    # @return [NilClass|void]
-    def cell(row_index = nil, cell_index = nil)
-      return nil if row_index.nil? || cell_index.nil?
-      return nil unless row(row_index)
-
-      row(row_index)[cell_index]
-    end
-
-  end # Page
+        rows[index]
+      end
+
+      # @param row_index [Fixnum]
+      # @param cell_index [Fixnum]
+      # @return [NilClass|void]
+      def cell(row_index = nil, cell_index = nil)
+        return nil if row_index.nil? || cell_index.nil?
+        return nil unless row(row_index)
+
+        row(row_index)[cell_index]
+      end
+
+    end # Page
+
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/row.rb

@@ -1,66 +1,70 @@
 module Vedeu
 
-  # A Row represents an array of Vedeu::Cell objects.
-  #
-  class Row
+  module Models
 
-    include Enumerable
+    # A Row represents an array of Vedeu::Models::Cell objects.
+    #
+    class Row
+
+      include Enumerable
 
-    # @!attribute [r] cells
-    # @return [Array<NilClass|void>]
-    attr_reader :cells
+      # @!attribute [r] cells
+      # @return [Array<NilClass|void>]
+      attr_reader :cells
 
-    # @param value [Vedeu::Row|Array<void>|void]
-    # @return [Vedeu::Row]
-    def self.coerce(value)
-      if value.is_a?(self)
-        value
+      # @param value [Vedeu::Models::Row|Array<void>|void]
+      # @return [Vedeu::Models::Row]
+      def self.coerce(value)
+        if value.is_a?(self)
+          value
 
-      elsif value.is_a?(Array)
-        new(value.compact)
+        elsif value.is_a?(Array)
+          new(value.compact)
 
-      elsif value.nil?
-        new
+        elsif value.nil?
+          new
 
-      else
-        new([value])
+        else
+          new([value])
 
+        end
       end
-    end
 
-    # Returns an instance of Vedeu::Row.
-    #
-    # @param cells [Array<NilClass|void>]
-    # @return [Vedeu::Row]
-    def initialize(cells = [])
-      @cells = cells || []
-    end
+      # Returns an instance of Vedeu::Models::Row.
+      #
+      # @param cells [Array<NilClass|void>]
+      # @return [Vedeu::Models::Row]
+      def initialize(cells = [])
+        @cells = cells || []
+      end
 
-    # Provides iteration over the collection.
-    #
-    # @param block [Proc]
-    # @return [Enumerator]
-    def each(&block)
-      cells.each(&block)
-    end
+      # Provides iteration over the collection.
+      #
+      # @param block [Proc]
+      # @return [Enumerator]
+      def each(&block)
+        cells.each(&block)
+      end
 
-    # An object is equal when its values are the same.
-    #
-    # @param other [Vedeu::Row]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && cells == other.cells
-    end
-    alias_method :==, :eql?
-
-    # @param index [Fixnum]
-    # @return [NilClass|void]
-    def cell(index)
-      return nil if index.nil?
-
-      cells[index]
-    end
-
-  end # Row
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Models::Row]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && cells == other.cells
+      end
+      alias_method :==, :eql?
+
+      # @param index [Fixnum]
+      # @return [NilClass|void]
+      def cell(index)
+        return nil if index.nil?
+
+        cells[index]
+      end
+
+    end # Row
+
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/views/all.rb

@@ -9,6 +9,7 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/models/views/char'
+require 'vedeu/models/views/html_char'
 require 'vedeu/models/views/collections/chars'
 require 'vedeu/models/views/stream'
 require 'vedeu/models/views/collections/streams'

data/lib/vedeu/models/views/char.rb

@@ -128,7 +128,7 @@ module Vedeu
 
       # @return [String]
       def to_html
-        @to_html ||= Vedeu::HTMLChar.render(self)
+        @to_html ||= Vedeu::Views::HTMLChar.render(self)
       end
 
       private