vedeu 0.3.1 → 0.3.2

data/lib/vedeu/models/geometry.rb

@@ -55,7 +55,8 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          client: nil
+          client: nil,
+          name:   '',
         }
       end
 

data/lib/vedeu/models/model.rb

@@ -23,6 +23,10 @@ module Vedeu
 
     end # ClassMethods
 
+    # When this module is included in a class, provide ClassMethods as class
+    # methods for the class.
+    #
+    # @param klass [Class]
     def self.included(klass)
       klass.send :extend, ClassMethods
     end

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

@@ -17,6 +17,13 @@ module Vedeu
     attr_reader :position
 
     class << self
+
+      # @param value []
+      # @param parent []
+      # @param colour []
+      # @param style []
+      # @param position []
+      # @return [Vedeu::Char]
       def coerce(value = nil, parent = nil, colour = nil, style = nil, position = nil)
         if value.is_a?(self)
           value
@@ -37,6 +44,7 @@ module Vedeu
 
         end
       end
+
     end
 
     # Returns a new instance of Char.
@@ -62,11 +70,13 @@ module Vedeu
       "<#{self.class.name} (value:#{@value})>"
     end
 
+    # @param other []
     # @return [Boolean]
     def ==(other)
       eql?(other)
     end
 
+    # @param other []
     # @return [Boolean]
     def eql?(other)
       self.class == other.class && value == other.value

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

@@ -2,7 +2,8 @@ require 'vedeu/models/collection'
 
 module Vedeu
 
+  # A collection of {Vedeu::Char} instances.
   class Chars < Vedeu::Model::Collection
-  end
+  end # Chars
 
-end
+end # Vedeu

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

@@ -25,10 +25,8 @@ module Vedeu
     collection Vedeu::Lines
     member     Vedeu::Line
 
-    attr_accessor :border,
-      :colour,
+    attr_accessor :colour,
       :delay,
-      :geometry,
       :group,
       :name,
       :parent,
@@ -108,10 +106,8 @@ module Vedeu
       @colour = colour
       @style  = style
 
-      @border   = nil
-      @delay    = 0.0
-      @geometry = nil
-      @group    = ''
+      @delay  = 0.0
+      @group  = ''
 
       @repository = Vedeu.interfaces
     end
@@ -125,10 +121,8 @@ module Vedeu
     # @return [Hash]
     def attributes
       {
-        border:   border,
         colour:   colour,
         delay:    delay,
-        geometry: geometry,
         group:    group,
         name:     name,
         parent:   parent,
@@ -140,7 +134,16 @@ module Vedeu
     #
     # @return [Boolean]
     def border?
-      !!(border)
+      Vedeu.borders.registered?(name)
+    end
+
+    # Returns the border object belonging to the interface.
+    #
+    # @return [Vedeu::Border|NilClass]
+    def border
+      if border?
+        Vedeu.borders.find(name)
+      end
     end
 
     # @return [Vedeu::Cursor]
@@ -148,6 +151,11 @@ module Vedeu
       Vedeu.cursors.by_name(name)
     end
 
+    # @return [Vedeu::Geometry]
+    def geometry
+      Vedeu.geometries.find(name)
+    end
+
     # Returns log friendly output.
     #
     # @return [String]
@@ -169,19 +177,6 @@ module Vedeu
       lines.any?
     end
 
-    # Renders the interface with a border if one is defined.
-    #
-    # @return [Array]
-    def render
-      if border?
-        border.render
-
-      else
-        viewport
-
-      end
-    end
-
     # @return [Interface]
     def store
       super
@@ -193,11 +188,6 @@ module Vedeu
       store_group
     end
 
-    # return [Array]
-    def viewport
-      Vedeu::Viewport.show(self)
-    end
-
   end # Interface
 
 end # Vedeu

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

@@ -2,7 +2,8 @@ require 'vedeu/models/collection'
 
 module Vedeu
 
+  # A collection of {Vedeu::Interface} instances.
   class Interfaces < Vedeu::Model::Collection
-  end
+  end # Interfaces
 
-end
+end # Vedeu

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

@@ -2,7 +2,8 @@ require 'vedeu/models/collection'
 
 module Vedeu
 
+  # A collection of {Vedeu::Line} instances.
   class Lines < Vedeu::Model::Collection
-  end
+  end # Lines
 
-end
+end # Vedeu

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

@@ -73,7 +73,7 @@ module Vedeu
     end
 
     # @param child [Vedeu::Stream]
-    # @return [Vedeu::Line]
+    # @return [Vedeu::Streams]
     def add(child)
       parent.add(child)
     end

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

@@ -2,7 +2,8 @@ require 'vedeu/models/collection'
 
 module Vedeu
 
+  # A collection of {Vedeu::Stream} instances.
   class Streams < Vedeu::Model::Collection
-  end
+  end # Streams
 
-end
+end # Vedeu

data/lib/vedeu/output/border.rb

@@ -15,6 +15,7 @@ module Vedeu
     include Vedeu::Model
 
     attr_accessor :attributes
+    attr_reader   :name
 
     class << self
 
@@ -22,7 +23,7 @@ module Vedeu
       def build(attributes = {}, &block)
         attributes = defaults.merge(attributes)
 
-        model = new(attributes[:interface], attributes)
+        model = new(attributes)
         model.deputy(attributes[:client]).instance_eval(&block) if block_given?
         model
       end
@@ -35,7 +36,7 @@ module Vedeu
       def defaults
         {
           client:    nil,
-          interface: nil,
+          name:      '',
         }
       end
 
@@ -43,26 +44,27 @@ module Vedeu
 
     # Returns a new instance of Border.
     #
-    # @param interface [Interface]
     # @param attributes [Hash]
+    # @option attributes bottom_left [String]
+    # @option attributes bottom_right [String]
     # @option attributes colour
-    # @option attributes style
     # @option attributes enabled [Boolean]
+    # @option attributes horizontal [String]
+    # @option attributes name [String]
+    # @option attributes style
     # @option attributes show_bottom [Boolean]
     # @option attributes show_left [Boolean]
     # @option attributes show_right [Boolean]
     # @option attributes show_top [Boolean]
-    # @option attributes horizontal [String]
-    # @option attributes vertical [String]
-    # @option attributes bottom_left [String]
-    # @option attributes bottom_right [String]
     # @option attributes top_left [String]
     # @option attributes top_right [String]
+    # @option attributes vertical [String]
     # @return [Border]
-    def initialize(interface, attributes = {})
-      @interface  = interface
+    def initialize(attributes = {})
       @attributes = defaults.merge(attributes)
+      @name       = @attributes[:name]
       @colour     = Colour.coerce(@attributes[:colour])
+      @repository = Vedeu.borders
       @style      = Style.coerce(@attributes[:style])
     end
 
@@ -177,13 +179,10 @@ module Vedeu
     #
     # @return [Boolean]
     def to_s
+      render = Vedeu::Viewport.new(interface).render
       render.map { |line| line.flatten.join }.join("\n")
     end
 
-    private
-
-    attr_reader :colour, :interface, :style
-
     # Renders the bottom border for the interface.
     #
     # @return [String]
@@ -235,6 +234,10 @@ module Vedeu
       out
     end
 
+    private
+
+    attr_reader :colour, :style
+
     # Renders the bottom left border character with escape codes for colour and
     # style for the interface.
     #
@@ -360,25 +363,30 @@ module Vedeu
       [interface.colour, interface.style]
     end
 
+    # @return [Vedeu::Interface]
+    def interface
+      @_interface ||= Vedeu.interfaces.find(name)
+    end
+
     # The default values for a new instance of this class.
     #
     # @return [Hash]
     def defaults
       {
+        bottom_left:  "\x6D", # └
+        bottom_right: "\x6A", # ┘
+        colour:       {},
         enabled:      false,
+        horizontal:   "\x71", # ─
+        name:         '',
         show_bottom:  true,
         show_left:    true,
         show_right:   true,
         show_top:     true,
-        bottom_right: "\x6A", # ┘
-        top_right:    "\x6B", # ┐
-        top_left:     "\x6C", # ┌
-        bottom_left:  "\x6D", # └
-        horizontal:   "\x71", # ─
-        colour:       {},
         style:        [],
+        top_left:     "\x6C", # ┌
+        top_right:    "\x6B", # ┐
         vertical:     "\x78", # │
-        interface:    nil,
       }
     end
 

data/lib/vedeu/output/compositor.rb

@@ -47,10 +47,8 @@ module Vedeu
     # @return [Array<Interface>]
     def compose
       buffer.map do |view|
-        view.border   = interface.border   unless view.border
         view.colour   = interface.colour   unless view.colour
         view.style    = interface.style    unless view.style
-        view.geometry = interface.geometry unless view.geometry
 
         Output.render(view)
       end
@@ -60,11 +58,12 @@ module Vedeu
 
     attr_reader :name
 
+    # @return [Vedeu::Interface]
     def buffer
       Vedeu.buffers.find(name).content
     end
 
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     def interface
       @interface ||= Vedeu.interfaces.find(name)
     end

data/lib/vedeu/output/output.rb

@@ -54,7 +54,7 @@ module Vedeu
 
       Vedeu.log("Rendering view: '#{interface.name}'")
 
-      interface.render.each_with_index do |line, index|
+      viewport.each_with_index do |line, index|
         out << interface.origin(index)
         out << line.join
       end
@@ -62,6 +62,10 @@ module Vedeu
       out.join
     end
 
+    def viewport
+      @_viewport ||= Vedeu::Viewport.new(interface).render
+    end
+
   end # Output
 
 end # Vedeu

data/lib/vedeu/output/viewport.rb

@@ -11,19 +11,11 @@ module Vedeu
     extend Forwardable
 
     def_delegators :interface,
-      :border,
-      :border?,
       :geometry,
       :lines,
       :lines?,
       :cursor
 
-    def_delegators :border,
-      :bottom?,
-      :left?,
-      :right?,
-      :top?
-
     def_delegators :cursor,
       :ox,
       :oy
@@ -32,11 +24,6 @@ module Vedeu
       :height,
       :width
 
-    # @see Viewport#show
-    def self.show(interface)
-      new(interface).show
-    end
-
     # Returns an instance of Viewport.
     #
     # @param interface [Interface] An instance of interface.
@@ -45,31 +32,55 @@ module Vedeu
       @interface = interface
     end
 
-    # Returns the visible content for the interface.
-    #
-    # @note If there are no lines of content, we return an empty array. If there
-    #   are no more columns of content we return a space enclosed in an array;
-    #   this prevents a weird line hopping bug which occurs when the current
-    #   line has no more content, but subsequent lines do.
+    # Returns the interface with border (if enabled) and the content for the
+    # interface.
     #
-    # @return [Array]
-    def show
-      return [] unless lines?
+    # @return [Array<Array<String>>]
+    def render
+      if border?
+        out = []
 
-      line_pad.map { |line| column_pad(line) }.compact
+        out << border.top if border.top?
+
+        show[0...bordered_height].each do |line|
+          out << [border.left, line[0...bordered_width], border.right].flatten
+        end
+
+        out << border.bottom if border.bottom?
+
+        out
+
+      else
+        show
+
+      end
     end
 
     # Returns a string representation of the viewport.
     #
     # @return [String]
     def to_s
-      show.map(&:join).join("\n")
+      render.map(&:join).join("\n")
     end
 
     private
 
     attr_reader :interface
 
+    # Returns the visible content for the interface.
+    #
+    # @note If there are no lines of content, we return an empty array. If there
+    #   are no more columns of content we return a space enclosed in an array;
+    #   this prevents a weird line hopping bug which occurs when the current
+    #   line has no more content, but subsequent lines do.
+    #
+    # @return [Array]
+    def show
+      return [] unless lines?
+
+      line_pad.map { |line| column_pad(line) }.compact
+    end
+
     # Pad the number of rows so that we always return an Array of the same
     # length for each viewport.
     #
@@ -169,6 +180,16 @@ module Vedeu
       height
     end
 
+    # @return [Vedeu::Border]
+    def border
+      @_border ||= Vedeu.borders.find(interface.name)
+    end
+
+    # @return [Boolean]
+    def border?
+      Vedeu.borders.registered?(interface.name)
+    end
+
   end # Viewport
 
 end # Vedeu