vedeu 0.6.69 → 0.6.70

data/lib/vedeu/models/focus.rb

@@ -69,13 +69,14 @@ module Vedeu
       # @example
       #   Vedeu.focus
       #
-      # @return [String]
+      # @return [NilClass|String|Symbol]
       def current
-        return storage[0] unless storage.empty?
+        return nil if storage.empty?
 
-        no_interfaces_registered!
+        storage[0]
       end
       alias_method :focus, :current
+      alias_method :name, :current
 
       # Returns a boolean indicating whether the named interface is
       # focussed.
@@ -90,6 +91,14 @@ module Vedeu
       end
       alias_method :focussed?, :current?
 
+      # Returns a boolean indicating whether there are interfaces
+      # registered.
+      #
+      # @return [Boolean]
+      def focus?
+        !storage.empty?
+      end
+
       # Put the next interface relative to the current interfaces in
       # focus.
       #
@@ -97,7 +106,7 @@ module Vedeu
       #   Vedeu.trigger(:_focus_next_)
       #   Vedeu.focus_next
       #
-      # @return [String]
+      # @return [String|Symbol]
       def next_item
         storage.rotate!
 
@@ -108,7 +117,7 @@ module Vedeu
       # Put the next visible interface relative to the current
       # interfaces in focus.
       #
-      # @return [String]
+      # @return [String|Symbol]
       def next_visible_item
         return update unless visible_items?
 
@@ -128,7 +137,7 @@ module Vedeu
       #   Vedeu.trigger(:_focus_prev_)
       #   Vedeu.focus_previous
       #
-      # @return [String]
+      # @return [String|Symbol]
       def prev_item
         storage.rotate!(-1)
 
@@ -140,7 +149,7 @@ module Vedeu
       # Put the previous visible interface relative to the current
       # interfaces in focus.
       #
-      # @return [String]
+      # @return [String|Symbol]
       def prev_visible_item
         return update unless visible_items?
 
@@ -196,13 +205,6 @@ module Vedeu
         Vedeu.interfaces.by_name(current)
       end
 
-      # @raise [Vedeu::Error::Fatal]
-      def no_interfaces_registered!
-        fail Vedeu::Error::Fatal,
-             'No interfaces or views have been registered, therefore the ' \
-             'focus table is empty.'.freeze
-      end
-
       # @raise [Vedeu::Error::ModelNotFound]
       def not_registered!
         fail Vedeu::Error::ModelNotFound,
@@ -244,6 +246,8 @@ module Vedeu
 
   # @!method focus
   #   @see Vedeu::Models::Focus#focus
+  # @!method focus?
+  #   @see Vedeu::Models::Focus#focus?
   # @!method focus_by_name
   #   @see Vedeu::Models::Focus#focus_by_name
   # @!method focussed?
@@ -254,6 +258,7 @@ module Vedeu
   #   @see Vedeu::Models::Focus#focus_previous
   def_delegators Vedeu::Models::Focus,
                  :focus,
+                 :focus?,
                  :focus_by_name,
                  :focussed?,
                  :focus_next,

data/lib/vedeu/models/page.rb

@@ -91,6 +91,11 @@ module Vedeu
         rows[index]
       end
 
+      # @return [Fixnum]
+      def size
+        rows.size
+      end
+
     end # Page
 
   end # Models

data/lib/vedeu/models/row.rb

@@ -82,6 +82,11 @@ module Vedeu
         Vedeu::Views::Char.new(value: Vedeu::EscapeSequences::Esc.reset)
       end
 
+      # @return [Fixnum]
+      def size
+        cells.size
+      end
+
     end # Row
 
   end # Models

data/lib/vedeu/models/toggleable.rb

@@ -134,7 +134,12 @@ module Vedeu
       # @param name [String|Symbol]
       # @return [Boolean]
       def cursor_visible?(name)
-        Vedeu.buffers.by_name(name).cursor_visible?
+        buffer(name).cursor_visible?
+      end
+
+      # @return [Vedeu::Buffers::Buffer]
+      def buffer(name)
+        Vedeu.buffers.by_name(name)
       end
 
     end # ClassMethods

data/lib/vedeu/null/all.rb

@@ -13,4 +13,3 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/null/generic'
-require 'vedeu/null/view'

data/lib/vedeu/output/all.rb

@@ -12,7 +12,5 @@ require 'vedeu/output/text'
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
 require 'vedeu/output/wordwrap'
-require 'vedeu/output/presentation/all'
 require 'vedeu/output/refresh'
-require 'vedeu/output/renderers/all'
 require 'vedeu/output/write'

data/lib/vedeu/output/compressor.rb

@@ -12,6 +12,7 @@ module Vedeu
     class Compressor
 
       include Vedeu::Common
+      include Vedeu::Renderers::Options
 
       # @param (see #initialize)
       # @return [String]
@@ -37,7 +38,7 @@ module Vedeu
       #   - Takes approximately ~25ms for 2100 chars. (2015-07-25)
       # @return [String]
       def render
-        return cached if Vedeu::Configuration.compression?
+        return cached if compress?
 
         uncompress
       end

data/lib/vedeu/output/wordwrap.rb

@@ -137,6 +137,11 @@ module Vedeu
         options[:ellipsis]
       end
 
+      # @return [Vedeu::Geometries::Geometry]
+      def geometry
+        Vedeu.geometry.by_name(name)
+      end
+
       # Returns the word wrapping mode. One of :default, :prune or
       #   :wrap;
       #
@@ -174,7 +179,7 @@ module Vedeu
       # @return [Fixnum]
       def width
         return options[:width] if present?(options[:width])
-        return Vedeu.geometries.by_name(name).width if registered?
+        return geometry.width if registered?
 
         fail Vedeu::Error::MissingRequired,
              'The text provided cannot be wrapped or pruned because a :width ' \

data/lib/vedeu/output/write.rb

@@ -32,6 +32,8 @@ module Vedeu
       def initialize(output = nil, options = {})
         @output  = output
         @options = options
+        @colour  = options[:colour]
+        @style   = options[:style]
       end
 
       # @return [NilClass]

data/lib/vedeu/presentation/all.rb

@@ -0,0 +1,17 @@
+module Vedeu
+
+  # This module allows the sharing of presentation concerns between
+  # the models: Interface, View, Line and Stream.
+  #
+  module Presentation
+
+  end # Presentation
+
+end # Vedeu
+
+require 'vedeu/presentation/background'
+require 'vedeu/presentation/foreground'
+require 'vedeu/presentation/colour'
+require 'vedeu/presentation/styles'
+require 'vedeu/presentation/style'
+require 'vedeu/presentation/presentation'

data/lib/vedeu/presentation/background.rb

@@ -0,0 +1,47 @@
+module Vedeu
+
+  module Presentation
+
+    module Colour
+
+      module Background
+
+        include Vedeu::Repositories::Parent
+
+        # When the background colour for the model exists, return it,
+        # otherwise returns the parent background colour, or an empty
+        # Vedeu::Colours::Background.
+        #
+        # @return [Vedeu::Colours::Background]
+        def background
+          @background ||= if colour && present?(colour.background)
+                            colour.background
+
+                          elsif self.is_a?(Vedeu::Views::Char) && name
+                            interface.colour.background
+
+                          elsif parent && present?(parent.background)
+                            parent.background
+
+                          else
+                            Vedeu::Colours::Background.new
+
+                          end
+        end
+
+        # Allows the setting of the background colour by coercing the
+        # given value into a Vedeu::Colours::Background colour.
+        #
+        # @return [Vedeu::Colours::Background]
+        def background=(value)
+          @background = colour.background = value
+          @_colour = @colour = colour
+        end
+
+      end # Background
+
+    end # Colour
+
+  end # Presentation
+
+end # Vedeu

data/lib/vedeu/presentation/colour.rb

@@ -0,0 +1,42 @@
+module Vedeu
+
+  module Presentation
+
+    # Provides colour related presentation behaviour.
+    #
+    module Colour
+
+      include Vedeu::Repositories::Parent
+      include Vedeu::Presentation::Colour::Background
+      include Vedeu::Presentation::Colour::Foreground
+
+      # @return [Vedeu::Colours::Colour]
+      def 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 && present?(parent.colour)
+                       Vedeu::Colours::Colour.coerce(parent.colour)
+
+                     else
+                       Vedeu::Colours::Colour.new
+
+                     end
+      end
+
+      # Allows the setting of the model's colour by coercing the given
+      # value into a Vedeu::Colours::Colour.
+      #
+      # @return [Vedeu::Colours::Colour]
+      def colour=(value)
+        @_colour = @colour = Vedeu::Colours::Colour.coerce(value)
+      end
+
+    end # Colour
+
+  end # Presentation
+
+end # Vedeu

data/lib/vedeu/presentation/foreground.rb

@@ -0,0 +1,47 @@
+module Vedeu
+
+  module Presentation
+
+    module Colour
+
+      module Foreground
+
+        include Vedeu::Repositories::Parent
+
+        # When the foreground colour for the model exists, return it,
+        # otherwise returns the parent foreground colour, or an empty
+        # Vedeu::Colours::Foreground.
+        #
+        # @return [Vedeu::Colours::Foreground]
+        def foreground
+          @foreground ||= if colour && present?(colour.foreground)
+                            colour.foreground
+
+                          elsif self.is_a?(Vedeu::Views::Char) && name
+                            interface.colour.foreground
+
+                          elsif parent && present?(parent.foreground)
+                            parent.foreground
+
+                          else
+                            Vedeu::Colours::Foreground.new
+
+                          end
+        end
+
+        # Allows the setting of the foreground colour by coercing the
+        # given value into a Vedeu::Colours::Foreground colour.
+        #
+        # @return [Vedeu::Colours::Foreground]
+        def foreground=(value)
+          @foreground = colour.foreground = value
+          @_colour = @colour = colour
+        end
+
+      end # Foreground
+
+    end # Colour
+
+  end # Presentation
+
+end # Vedeu

data/lib/vedeu/presentation/styles.rb

@@ -0,0 +1,45 @@
+module Vedeu
+
+  module Presentation
+
+    # Provides style related presentation behaviour.
+    #
+    module Styles
+
+      include Vedeu::Common
+      include Vedeu::Repositories::Parent
+
+      # When the style for the model exists, return it, otherwise
+      # returns the parent style, or an empty
+      # {Vedeu::Presentation::Style}.
+      #
+      # @return [Vedeu::Presentation::Style]
+      def style
+        @_style ||= if @style
+                      Vedeu::Presentation::Style.coerce(@style)
+
+                    elsif self.is_a?(Vedeu::Views::Char) && name
+                      Vedeu::Presentation::Style.coerce(interface.style)
+
+                    elsif parent && present?(parent.style)
+                      Vedeu::Presentation::Style.coerce(parent.style)
+
+                    else
+                      Vedeu::Presentation::Style.new
+
+                    end
+      end
+
+      # Allows the setting of the style by coercing the given value
+      # into a {Vedeu::Presentation::Style}.
+      #
+      # @return [Vedeu::Presentation::Style]
+      def style=(value)
+        @_style = @style = Vedeu::Presentation::Style.coerce(value)
+      end
+
+    end # Style
+
+  end # Presentation
+
+end # Vedeu

data/lib/vedeu/{output/renderers → renderers}/all.rb

@@ -140,8 +140,8 @@ module Vedeu
 
 end # Vedeu
 
-require 'vedeu/output/renderers/options'
-require 'vedeu/output/renderers/file'
-require 'vedeu/output/renderers/html'
-require 'vedeu/output/renderers/json'
-require 'vedeu/output/renderers/terminal'
+require 'vedeu/renderers/options'
+require 'vedeu/renderers/file'
+require 'vedeu/renderers/html'
+require 'vedeu/renderers/json'
+require 'vedeu/renderers/terminal'

data/lib/vedeu/{output/renderers → renderers}/options.rb

@@ -12,8 +12,12 @@ module Vedeu
       # @return [Hash<Symbol => void>]
       attr_writer :options
 
+      # Returns a boolean indicating whether the content should be
+      # compressed if compression is available.
+      #
+      # @return [Boolean]
       def compress?
-        options[:compression] || false
+        options[:compression] || Vedeu::Configuration.compression? || false
       end
 
       private

data/lib/vedeu/{output/renderers → renderers}/terminal.rb

@@ -35,7 +35,7 @@ module Vedeu
       # @param output [Vedeu::Models::Page]
       # @return [Array<Array<Vedeu::Views::Char>>]
       def parse(output)
-        Vedeu::Output::Compressor.render(output)
+        Vedeu::Output::Compressor.render(output, options)
       end
 
     end # Terminal

data/lib/vedeu/repositories/all.rb

@@ -13,6 +13,7 @@ require 'vedeu/repositories/collection'
 require 'vedeu/repositories/defaults'
 require 'vedeu/repositories/repositories'
 require 'vedeu/repositories/model'
+require 'vedeu/repositories/parent'
 require 'vedeu/repositories/store'
 require 'vedeu/repositories/registerable'
 require 'vedeu/repositories/repository'

data/lib/vedeu/repositories/parent.rb

@@ -0,0 +1,32 @@
+module Vedeu
+
+  module Repositories
+
+    # When included into a class, provides the mechanism to retrieve
+    # the parent object for the class if available.
+    #
+    module Parent
+
+      include Vedeu::Common
+
+      # @return [NilClass|void]
+      def parent
+        @_parent ||= present?(@parent) ? @parent : nil
+      end
+
+      # @return [NilClass|String|Symbol]
+      def name
+        @_name ||= if present?(@name)
+                     @name
+
+                   elsif parent && present?(parent.name)
+                     parent.name
+
+                   end
+      end
+
+    end # Parent
+
+  end # Repositories
+
+end # Vedeu

data/lib/vedeu/repositories/repositories.rb

@@ -44,6 +44,7 @@ module Vedeu
 
       true
     end
+    alias_method :reset, :reset!
 
     private
 

data/lib/vedeu/runtime/flags.rb

@@ -26,6 +26,7 @@ module Vedeu
         def reset!
           instance.reset!
         end
+        alias_method :reset, :reset!
 
       end # Eigenclass
 
@@ -44,6 +45,7 @@ module Vedeu
       def reset!
         self.options = defaults
       end
+      alias_method :reset, :reset!
 
       private
 

data/lib/vedeu/templating/view_template.rb

@@ -76,10 +76,15 @@ module Vedeu
       #
       # @return (see Vedeu::Interfaces::Repository#by_name)
       def interface
-        Vedeu.interfaces.by_name(options[:name])
+        Vedeu.interfaces.by_name(name)
       end
       alias_method :interface?, :interface
 
+      # @return [String|Symbol]
+      def name
+        options[:name]
+      end
+
       # Returns the stream directives for the line.
       #
       # @param line [String]

data/lib/vedeu/version.rb

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

data/lib/vedeu/views/all.rb

@@ -0,0 +1,20 @@
+module Vedeu
+
+  # View related models.
+  #
+  module Views
+
+  end # Views
+
+end # Vedeu
+
+require 'vedeu/views/chars'
+require 'vedeu/views/char'
+require 'vedeu/views/html_char'
+require 'vedeu/views/streams'
+require 'vedeu/views/stream'
+require 'vedeu/views/lines'
+require 'vedeu/views/line'
+require 'vedeu/views/view_collection'
+require 'vedeu/views/view'
+require 'vedeu/views/composition'

data/lib/vedeu/{models/views → views}/char.rb

@@ -2,14 +2,6 @@ module Vedeu
 
   module Views
 
-    # A collection of {Vedeu::Views::Char} instances.
-    #
-    # @api private
-    #
-    class Chars < Vedeu::Repositories::Collection
-
-    end # Chars
-
     # A Char represents a single character of the terminal. It is a
     # container for the a single character in a
     # {Vedeu::Views::Stream}.
@@ -20,12 +12,9 @@ module Vedeu
     class Char
 
       include Comparable
+      include Vedeu::Repositories::Parent
       include Vedeu::Presentation
 
-      # @!attribute [r] attributes
-      # @return [Hash]
-      attr_reader :attributes
-
       # @!attribute [rw] border
       # @return [NilClass|Symbol]
       attr_accessor :border
@@ -56,11 +45,22 @@ module Vedeu
       # @option attributes value [String]
       # @return [Vedeu::Views::Char]
       def initialize(attributes = {})
-        @attributes = attributes
-        @border     = @attributes[:border]
-        @name       = @attributes[:name]
-        @parent     = @attributes[:parent]
-        @value      = @attributes[:value]
+        defaults.merge!(attributes).each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # @return [Hash<Symbol => void>]
+      def attributes
+        {
+          border:   @border,
+          # colour:   colour,
+          name:     @name,
+          parent:   @parent,
+          position: position,
+          style:    @style,
+          value:    value,
+        }
       end
 
       # @return [Boolean]
@@ -96,16 +96,15 @@ module Vedeu
 
       # @return [Vedeu::Geometries::Position]
       def position
-        @position ||= Vedeu::Geometries::Position.coerce(@attributes[:position])
+        @_position ||= Vedeu::Geometries::Position.coerce(@position)
       end
 
       # Sets the position of the Vedeu::Views::Char.
       #
-      # @param value [Vedeu::Geometries::Position]
+      # @param value [Array<void>|Hash<void>|Vedeu::Geometries::Position]
       # @return [Vedeu::Geometries::Position]
       def position=(value)
-        @position = @attributes[:position] = Vedeu::Geometries::Position
-                                             .coerce(value)
+        @_position = @position = Vedeu::Geometries::Position.coerce(value)
       end
 
       # @return [String]
@@ -166,6 +165,19 @@ module Vedeu
         }
       end
 
+      # @return [Hash<Symbol => void>]
+      def defaults
+        {
+          border:   nil,
+          colour:   nil,
+          name:     nil,
+          parent:   nil,
+          position: nil,
+          style:    nil,
+          value:    '',
+        }
+      end
+
       # @return [Hash<Symbol => String>]
       def parent_to_hash
         return {} unless parent