vedeu 0.4.2 → 0.4.3

data/lib/vedeu/models/group.rb

@@ -3,8 +3,6 @@ module Vedeu
   # Interfaces can be associated with one another by being members of the same
   # Group. A Group is a collection of interface names.
   #
-  # @api private
-  #
   class Group
 
     include Vedeu::Model

data/lib/vedeu/models/menu.rb

@@ -5,8 +5,6 @@ module Vedeu
   # Converts the collection passed into a list of menu items which can be
   # navigated using the instance methods or events provided.
   #
-  # @api private
-  #
   class Menu
 
     include Vedeu::Model
@@ -25,34 +23,30 @@ module Vedeu
     # @return [Fixnum]
     attr_accessor :selected
 
-    class << self
-
-      # Register a menu by name which will display a collection of items for
-      # your users to select; and provide interactivity within your application.
-      #
-      # @param name  [String] The name of the menu. Used to reference the
-      #   menu throughout your application's execution lifetime.
-      # @param block [Proc] A set of attributes which define the features of the
-      #   menu. See {Vedeu::DSL::Menu#items} and {Vedeu::DSL::Menu#name}.
-      #
-      # @example
-      #   Vedeu.menu 'my_interface' do
-      #     items [:item_1, :item_2, :item_3]
-      #     ...
-      #
-      #   Vedeu.menu do
-      #     name 'menus_must_have_a_name'
-      #     items Track.all_my_favourites
-      #     ...
-      #
-      # @raise [InvalidSyntax] The required block was not given.
-      # @return [API::Menu]
-      def menu(name = '', &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
-
-        build({ name: name }, &block).store
-      end
+    # Register a menu by name which will display a collection of items for
+    # your users to select; and provide interactivity within your application.
+    #
+    # @param name  [String] The name of the menu. Used to reference the
+    #   menu throughout your application's execution lifetime.
+    # @param block [Proc] A set of attributes which define the features of the
+    #   menu. See {Vedeu::DSL::Menu#items} and {Vedeu::DSL::Menu#name}.
+    #
+    # @example
+    #   Vedeu.menu 'my_interface' do
+    #     items [:item_1, :item_2, :item_3]
+    #     ...
+    #
+    #   Vedeu.menu do
+    #     name 'menus_must_have_a_name'
+    #     items Track.all_my_favourites
+    #     ...
+    #
+    # @raise [InvalidSyntax] The required block was not given.
+    # @return [API::Menu]
+    def self.menu(name = '', &block)
+      fail InvalidSyntax, 'block not given' unless block_given?
 
+      build({ name: name }, &block).store
     end
 
     # Returns a new instance of Menu.

data/lib/vedeu/models/model.rb

@@ -3,8 +3,6 @@ module Vedeu
   # When included into a class, provides the mechanism to store the class in a
   # repository for later retrieval.
   #
-  # @api private
-  #
   module Model
 
     attr_reader :repository

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

@@ -9,15 +9,14 @@ module Vedeu
   # Though a multi-character String can be passed as a value, only the first
   # character is returned in the escape sequence.
   #
-  # @api private
-  #
   class Char
 
     include Vedeu::Presentation
 
     attr_accessor :border,
-      :parent,
-      :position
+      :parent
+
+    attr_reader :value
 
     # Returns a new instance of Char.
     #
@@ -35,7 +34,6 @@ module Vedeu
       @border   = @attributes[:border]
       @colour   = @attributes[:colour]
       @parent   = @attributes[:parent]
-      @position = Vedeu::Position.coerce(@attributes[:position])
       @style    = @attributes[:style]
       @value    = @attributes[:value]
     end
@@ -52,11 +50,15 @@ module Vedeu
       self.class == other.class && value == other.value
     end
 
-    # @return [String] The character.
-    def value
-      return '' unless @value
+    # @return [Vedeu::Position]
+    def position
+      @position ||= Vedeu::Position.coerce(attributes[:position])
+    end
 
-      @value
+    # @param value [Vedeu::Position]
+    # @return [Vedeu::Position]
+    def position=(value)
+      @position = Vedeu::Position.coerce(value)
     end
 
     # @return [Fixnum|NilClass]
@@ -76,6 +78,8 @@ module Vedeu
 
     private
 
+    attr_reader :attributes
+
     # The default values for a new instance of this class.
     #
     # @return [Hash]
@@ -86,7 +90,7 @@ module Vedeu
         parent:   nil,
         position: nil,
         style:    nil,
-        value:    nil,
+        value:    '',
       }
     end
 

data/lib/vedeu/models/view/composition.rb

@@ -10,30 +10,27 @@ module Vedeu
 
   # A composition is a collection of interfaces.
   #
-  # @api private
-  #
   class Composition
 
-    include Vedeu::Presentation
     include Vedeu::Model
+    include Vedeu::Presentation
 
     collection Vedeu::Interfaces
     member     Vedeu::Interface
 
-    attr_reader  :interfaces
-    alias_method :value, :interfaces
-
     # Returns a new instance of Composition.
     #
     # @param attributes [Hash]
-    # @option attributes colour []
+    # @option attributes colour [Vedeu::Colour]
     # @option attributes interfaces []
-    # @option attributes style []
+    # @option attributes style [Vedeu::Style]
     # @return [Composition]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
-      @interfaces = @attributes[:interfaces]
+
       @colour     = @attributes[:colour]
+      @interfaces = @attributes[:interfaces]
+      @repository = Vedeu.interfaces
       @style      = @attributes[:style]
     end
 
@@ -47,6 +44,7 @@ module Vedeu
     def interfaces
       collection.coerce(@interfaces, self)
     end
+    alias_method :value, :interfaces
 
     private
 

data/lib/vedeu/models/view/interface.rb

@@ -13,7 +13,6 @@ module Vedeu
   # {Vedeu::Geometry}. It is a container for {Vedeu::Line} and {Vedeu::Stream}
   # objects.
   #
-  # @api private
   class Interface
 
     extend Forwardable

data/lib/vedeu/models/view/line.rb

@@ -8,8 +8,6 @@ module Vedeu
   # {Vedeu::Stream} objects. A line's width is determined by the
   # {Vedeu::Interface} it belongs to.
   #
-  # @api private
-  #
   class Line
 
     include Vedeu::Model
@@ -25,11 +23,12 @@ module Vedeu
 
     # Returns a new instance of Line.
     #
+    # @param attributes [Hash]
     # @option attributes streams [Vedeu::Streams]
     # @option attributes parent [Vedeu::Interface]
     # @option attributes colour [Vedeu::Colour]
     # @option attributes style [Vedeu::Style]
-    # @return [Line]
+    # @return [Vedeu::Line]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
       @colour     = @attributes[:colour]

data/lib/vedeu/models/view/stream.rb

@@ -7,8 +7,6 @@ module Vedeu
   # {Vedeu::Line} which you wish to colour and style independently of the other
   # characters in that line.
   #
-  # @api private
-  #
   class Stream
 
     include Vedeu::Model
@@ -31,7 +29,6 @@ module Vedeu
     # @option attributes parent [Vedeu::Line]
     # @option attributes colour [Vedeu::Colour]
     # @option attributes style [Vedeu::Style]
-    # @option attributes client [Object]
     # @return [Vedeu::Stream]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)

data/lib/vedeu/output/all.rb

@@ -9,6 +9,7 @@ require 'vedeu/output/compositor'
 require 'vedeu/output/presentation'
 require 'vedeu/output/style'
 require 'vedeu/output/position_index'
+require 'vedeu/output/index_position'
 require 'vedeu/output/virtual_buffer'
 require 'vedeu/output/html_char'
 require 'vedeu/output/html_renderer'

data/lib/vedeu/output/background.rb

@@ -3,8 +3,6 @@ module Vedeu
   # The class represents one half (the other, can be found at
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
   #
-  # @api private
-  #
   class Background < Translator
 
     private

data/lib/vedeu/output/colour.rb

@@ -6,8 +6,6 @@ module Vedeu
   # foreground and background colours of a character or collection of
   # characters.
   #
-  # @api private
-  #
   class Colour
 
     include Vedeu::Coercions

data/lib/vedeu/output/compositor.rb

@@ -9,8 +9,6 @@ module Vedeu
   # Combines stored interface layout/geometry with an interface view/buffer
   # to create a single view to be sent to the terminal for output.
   #
-  # @api private
-  #
   class Compositor
 
     # Convenience method to initialize a new Compositor and call its {#compose}

data/lib/vedeu/output/foreground.rb

@@ -7,8 +7,6 @@ module Vedeu
   # The class represents one half (the other, can be found at
   # {Vedeu::Background}) of a terminal colour escape sequence.
   #
-  # @api private
-  #
   class Foreground < Translator
 
     private

data/lib/vedeu/output/html_renderer.rb

@@ -8,6 +8,12 @@ module Vedeu
       new(output).render
     end
 
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.to_file(output)
+      new(output).to_file
+    end
+
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [Vedeu::HTMLRenderer]
     def initialize(output)

data/lib/vedeu/output/index_position.rb

@@ -0,0 +1,35 @@
+module Vedeu
+
+  # Converts an index into a position for the terminal.
+  #
+  class IndexPosition
+
+    attr_reader :y,
+      :x
+
+    alias_method :first, :y
+    alias_method :last, :x
+
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Array]
+    def self.[](y, x)
+      new(y, x).[]
+    end
+
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Vedeu::IndexPosition]
+    def initialize(y, x)
+      @y = (y <= 0) ? 1 : (y + 1)
+      @x = (x <= 0) ? 1 : (x + 1)
+    end
+
+    # @return [Array]
+    def []
+      [y, x]
+    end
+
+  end # IndexPosition
+
+end # Vedeu

data/lib/vedeu/output/output.rb

@@ -27,6 +27,8 @@ module Vedeu
     def render
       if Vedeu::Configuration.drb?
         Vedeu.trigger(:_drb_store_output_, virtual_view)
+
+        HTMLRenderer.to_file(VirtualBuffer.retrieve)
       end
 
       Terminal.output(Renderer.render(virtual_view, interface.cursor))
@@ -73,7 +75,7 @@ module Vedeu
       viewport.each_with_index do |line, iy|
         row = []
         line.each_with_index do |char, ix|
-          row << if char.is_a?(Vedeu::Char) && char.position.nil?
+          row << if char.is_a?(Vedeu::Char) && (char.x != ix || char.y != iy)
             char.position = origin(iy, ix)
             char
 

data/lib/vedeu/output/position_index.rb

@@ -21,8 +21,8 @@ module Vedeu
     # @param x [Fixnum]
     # @return [Vedeu::PositionIndex]
     def initialize(y, x)
-      @y = [(y - 1), 1].max
-      @x = [(x - 1), 1].max
+      @y = ((y - 1) <= 1) ? 1 : (y - 1)
+      @x = ((x - 1) <= 1) ? 1 : (x - 1)
     end
 
     # @return [Array]

data/lib/vedeu/output/presentation.rb

@@ -3,8 +3,6 @@ module Vedeu
   # This module allows the sharing of presentation concerns between the models:
   # Interface, Line and Stream.
   #
-  # @api private
-  #
   module Presentation
 
     # @return [Vedeu::Background|NilClass]

data/lib/vedeu/output/style.rb

@@ -6,7 +6,6 @@ module Vedeu
   # Converts the style value or value collection into a terminal escape
   # sequence. Unrecognised values are discarded- an empty string is returned.
   #
-  # @api private
   class Style
 
     include Vedeu::Common

data/lib/vedeu/output/translator.rb

@@ -21,8 +21,6 @@ module Vedeu
   # a 24-bit representation.
   #
   # @todo More documentation required (create a fancy chart!)
-  # @api private
-  #
   class Translator
 
     include Vedeu::Coercions
@@ -52,14 +50,14 @@ module Vedeu
       if no_colour?
         ''
 
-      elsif named?
-        named
+      elsif rgb?
+        rgb
 
       elsif numbered?
         numbered
 
-      elsif rgb?
-        rgb
+      elsif named?
+        named
 
       else
         ''
@@ -124,6 +122,20 @@ module Vedeu
       [numbered_prefix, css_to_numbered, 'm'].join
     end
 
+    # Returns a boolean indicated whether the colour is an HTML/CSS colour.
+    #
+    # @return [Boolean]
+    def rgb?
+      colour.is_a?(String) && valid_rgb?
+    end
+
+    # Returns a boolean indicated whether the colour is a valid HTML/CSS colour.
+    #
+    # @return [Boolean]
+    def valid_rgb?
+      !!(colour =~ /^#([A-Fa-f0-9]{6})$/)
+    end
+
     # Returns an escape sequence.
     #
     # @return [String]
@@ -145,20 +157,6 @@ module Vedeu
       colour >= 0 && colour <= 255
     end
 
-    # Returns a boolean indicated whether the colour is an HTML/CSS colour.
-    #
-    # @return [Boolean]
-    def rgb?
-      colour.is_a?(String) && valid_rgb?
-    end
-
-    # Returns a boolean indicated whether the colour is a valid HTML/CSS colour.
-    #
-    # @return [Boolean]
-    def valid_rgb?
-      !!(colour =~ /^#([A-Fa-f0-9]{6})$/)
-    end
-
     # Returns a collection of converted HTML/CSS octets as their decimal
     # equivalents.
     #