vedeu 0.4.5 → 0.4.6

data/lib/vedeu/dsl/composition.rb

@@ -1,4 +1,4 @@
-require 'vedeu/models/view/interface'
+require 'vedeu/models/interface'
 
 module Vedeu
 
@@ -38,7 +38,7 @@ module Vedeu
       #     ...
       #
       # @raise [InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Model::Collection<Vedeu::Interface>]
+      # @return [Vedeu::Interfaces<Vedeu::Interface>]
       def view(name = '', &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
@@ -47,11 +47,40 @@ module Vedeu
         model.add(new_model)
       end
 
+      # Load content from an ERb template.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     template_for('my_interface',
+      #                  '/path/to/template.erb',
+      #                  @some_object, options)
+      #
+      # @todo More documentation required.
+      #
+      # @param name [String] The name of interface for which this template's
+      #   content belongs to.
+      # @param filename [String] The filename (including path) to the template
+      #   to be used.
+      # @param object [Object] The object for which the values of template's
+      #   variables can be obtained.
+      # @param options [Hash] See {Vedeu::Wordwrap}
+      # @return [Vedeu::Interfaces<Vedeu::Interface>]
+      def template_for(name, filename, object = nil, options = {})
+        content = Vedeu::Template.parse(object, filename)
+        lines   = Vedeu::Wordwrap.for(content, options)
+
+        new_model = model.member.build(new_attributes(name).merge!({ lines: lines }))
+
+        model.add(new_model)
+      end
+
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Composition]
       attr_reader :model
 

data/lib/vedeu/dsl/group.rb

@@ -60,9 +60,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Group]
       attr_reader :model
 

data/lib/vedeu/dsl/interface.rb

@@ -2,7 +2,7 @@ require 'vedeu/cursor/cursor'
 require 'vedeu/models/focus'
 require 'vedeu/models/geometry'
 require 'vedeu/models/group'
-require 'vedeu/models/view/line'
+require 'vedeu/models/line'
 require 'vedeu/output/border'
 require 'vedeu/support/common'
 
@@ -209,9 +209,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Interface]
       attr_reader :model
 

data/lib/vedeu/dsl/line.rb

@@ -113,9 +113,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Line]
       attr_reader :model
 

data/lib/vedeu/dsl/shared/style.rb

@@ -11,7 +11,7 @@ module Vedeu
 
       # Define a style or styles for an interface, line or a stream.
       #
-      # @param value [Array|Symbol|String]
+      # @param value [Array<Symbol>|Array<String>|Symbol|String]
       #
       # @example
       #   interface 'my_interface' do

data/lib/vedeu/dsl/shared/text.rb

@@ -1,6 +1,5 @@
 require 'vedeu/output/text'
-require 'vedeu/models/view/line'
-require 'vedeu/models/view/stream'
+require 'vedeu/models/all'
 
 module Vedeu
 

data/lib/vedeu/dsl/stream.rb

@@ -36,9 +36,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Stream]
       attr_reader :model
 

data/lib/vedeu/dsl/view.rb

@@ -1,4 +1,4 @@
-require 'vedeu/models/view/composition'
+require 'vedeu/models/composition'
 
 module Vedeu
 

data/lib/vedeu/events/all.rb

@@ -1,4 +1,4 @@
-require 'vedeu/events/events'
+require 'vedeu/repositories/collections'
 require 'vedeu/events/event'
 require 'vedeu/events/trigger'
 

data/lib/vedeu/events/event.rb

@@ -1,5 +1,4 @@
-require 'vedeu/models/model'
-require 'vedeu/repositories/repository'
+require 'vedeu/repositories/all'
 require 'vedeu/events/trigger'
 
 module Vedeu
@@ -82,7 +81,7 @@ module Vedeu
       #
       # @return [TrueClass]
       def bind(name, options = {}, &block)
-        Vedeu.log(type: :event, message: "Binding: '#{name}'")
+        Vedeu.log(type: :event, message: "Binding: '#{name.inspect}'")
 
         new(name, options, block).bind
       end
@@ -96,7 +95,7 @@ module Vedeu
       def unbind(name)
         return false unless Vedeu.events.registered?(name)
 
-        Vedeu.log(type: :event, message: "Unbinding: '#{name}")
+        Vedeu.log(type: :event, message: "Unbinding: '#{name.inspect}'")
 
         Vedeu.events.remove(name)
         true
@@ -156,12 +155,29 @@ module Vedeu
 
     private
 
-    attr_reader   :closure, :name
-    attr_accessor :deadline, :executed_at, :now
+    # @!attribute [r] closure
+    # @return [String]
+    attr_reader :closure
+
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+
+    # @!attribute [rw] deadline
+    # @return [String]
+    attr_accessor :deadline
+
+    # @!attribute [rw] executed_at
+    # @return [String]
+    attr_accessor :executed_at
+
+    # @!attribute [rw] now
+    # @return [String]
+    attr_accessor :now
 
     # Execute the code stored in the event closure.
     #
-    # @param args []
+    # @param args [void]
     # @return [void]
     def execute(*args)
       reset_deadline
@@ -170,7 +186,7 @@ module Vedeu
 
       reset_time
 
-      Vedeu.log(type: :event, message: "Triggering: '#{name}'")
+      Vedeu.log(type: :event, message: "Triggering: '#{name.inspect}'")
 
       closure.call(*args)
     end
@@ -192,7 +208,7 @@ module Vedeu
     def throttle_expired?
       return true if elapsed_time > delay
 
-      Vedeu.log(type: :event, message: "Throttling: '#{name}'")
+      Vedeu.log(type: :event, message: "Throttling: '#{name.inspect}'")
 
       false
     end
@@ -216,7 +232,7 @@ module Vedeu
     def debounce_expired?
       return true if set_executed > deadline
 
-      Vedeu.log(type: :event, message: "Debouncing: '#{name}'")
+      Vedeu.log(type: :event, message: "Debouncing: '#{name.inspect}'")
 
       false
     end

data/lib/vedeu/events/trigger.rb

@@ -40,9 +40,17 @@ module Vedeu
 
     private
 
-    attr_reader :name,
-      :args,
-      :repository
+    # @!attribute [r] name
+    # @return [Symbol]
+    attr_reader :name
+
+    # @!attribute [r] args
+    # @return [Array]
+    attr_reader :args
+
+    # @!attribute [r]
+    # @return [Vedeu::Repository]
+    attr_reader :repository
 
     # @return [Array<void>|void]
     def results

data/lib/vedeu/geometry/all.rb

@@ -2,7 +2,9 @@ require 'vedeu/geometry/bounding_area'
 require 'vedeu/geometry/content_geometry'
 require 'vedeu/geometry/coordinate'
 require 'vedeu/geometry/grid'
+require 'vedeu/geometry/index_position'
 require 'vedeu/geometry/limit'
+require 'vedeu/geometry/position_index'
 require 'vedeu/geometry/position'
 require 'vedeu/geometry/position_validator'
 

data/lib/vedeu/geometry/bounding_area.rb

@@ -5,8 +5,13 @@ module Vedeu
   #
   class BoundingArea
 
-    attr_reader :height,
-      :width
+    # @!attribute [r] height
+    # @return [Fixnum]
+    attr_reader :height
+
+    # @!attribute [r] width
+    # @return [Fixnum]
+    attr_reader :width
 
     # Returns an instance of BoundingArea.
     #

data/lib/vedeu/geometry/content_geometry.rb

@@ -41,6 +41,8 @@ module Vedeu
 
     private
 
+    # @!attribute [r] interface
+    # @return [Vedeu::Interface]
     attr_reader :interface
 
     # Returns the number of lines of content for this interface.

data/lib/vedeu/geometry/coordinate.rb

@@ -4,10 +4,21 @@ module Vedeu
   #
   class Coordinate
 
-    attr_reader :height,
-      :width,
-      :x,
-      :y
+    # @!attribute [r] height
+    # @return [Fixnum]
+    attr_reader :height
+
+    # @!attribute [r] width
+    # @return [Fixnum]
+    attr_reader :width
+
+    # @!attribute [r] x
+    # @return [Fixnum]
+    attr_reader :x
+
+    # @!attribute [r] y
+    # @return [Fixnum]
+    attr_reader :y
 
     # @param height [Fixnum]
     # @param width [Fixnum]
@@ -157,8 +168,6 @@ module Vedeu
 
     private
 
-    attr_reader :height, :width
-
     # Returns the maximum y index for an area.
     #
     # @example

data/lib/vedeu/geometry/grid.rb

@@ -50,6 +50,8 @@ module Vedeu
 
     private
 
+    # @!attribute [r] value
+    # @return [Fixnum]
     attr_reader :value
 
     # Returns the width of a single column in characters.
@@ -61,7 +63,7 @@ module Vedeu
 
     # @return [Fixnum]
     def actual
-      Terminal.width
+      Vedeu::Terminal.width
     end
 
     # @return [Boolean]

data/lib/vedeu/geometry/index_position.rb

@@ -0,0 +1,77 @@
+module Vedeu
+
+  # Converts an index into a position for the terminal.
+  #
+  # When the optional offset `oy` and `ox` params are given, the they are used
+  # for the starting position.
+  #
+  class IndexPosition
+
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @param oy [Fixnum]
+    # @param ox [Fixnum]
+    # @return [Array]
+    def self.[](iy, ix, oy = 1, ox = 1)
+      new(iy, ix, oy, ox).[]
+    end
+
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @param oy [Fixnum]
+    # @param ox [Fixnum]
+    # @return [Vedeu::IndexPosition]
+    def initialize(iy, ix, oy = 1, ox = 1)
+      @iy = iy
+      @ix = ix
+      @oy = oy
+      @ox = ox
+    end
+
+    # @return [Array]
+    def []
+      [y, x]
+    end
+
+    # @return [Vedeu::Position]
+    def to_position
+      Vedeu::Position.new(y, x)
+    end
+
+    # @return [Fixnum]
+    def y
+      (iy <= 0) ? oy : (iy + oy)
+    end
+    alias_method :first, :y
+
+    # @return [Fixnum]
+    def x
+      (ix <= 0) ? ox : (ix + ox)
+    end
+    alias_method :last, :x
+
+    private
+
+    # @return [Fixnum]
+    def iy
+      @_iy ||= (@iy <= 0) ? 0 : @iy
+    end
+
+    # @return [Fixnum]
+    def ix
+      @_ix ||= (@ix <= 0) ? 0 : @ix
+    end
+
+    # @return [Fixnum]
+    def oy
+      @_oy ||= (@oy <= 1) ? 1 : @oy
+    end
+
+    # @return [Fixnum]
+    def ox
+      @_ox ||= (@ox <= 1) ? 1 : @ox
+    end
+
+  end # IndexPosition
+
+end # Vedeu

data/lib/vedeu/geometry/limit.rb

@@ -35,7 +35,21 @@ module Vedeu
 
     private
 
-    attr_reader :v, :vn, :min, :max
+    # @!attribute [r] v
+    # @return [Fixnum]
+    attr_reader :v
+
+    # @!attribute [r] vn
+    # @return [Fixnum]
+    attr_reader :vn
+
+    # @!attribute [r] min
+    # @return [Fixnum]
+    attr_reader :min
+
+    # @!attribute [r] max
+    # @return [Fixnum]
+    attr_reader :max
 
   end # Limit
 

data/lib/vedeu/geometry/position.rb

@@ -4,8 +4,13 @@ module Vedeu
   #
   class Position
 
-    attr_reader  :y,
-      :x
+    # @!attribute [r] y
+    # @return [Fixnum]
+    attr_reader :y
+
+    # @!attribute [r] x
+    # @return [Fixnum]
+    attr_reader :x
 
     alias_method :first, :y
     alias_method :last, :x

data/lib/vedeu/{output → geometry}/position_index.rb

@@ -4,8 +4,13 @@ module Vedeu
   #
   class PositionIndex
 
-    attr_reader :y,
-      :x
+    # @!attribute [r] y
+    # @return [Fixnum]
+    attr_reader :y
+
+    # @!attribute [r] x
+    # @return [Fixnum]
+    attr_reader :x
 
     alias_method :first, :y
     alias_method :last, :x
@@ -30,6 +35,11 @@ module Vedeu
       [y, x]
     end
 
+    # @return [Vedeu::Position]
+    def to_position
+      Vedeu::Position.new(y, x)
+    end
+
   end # PositionIndex
 
 end # Vedeu

data/lib/vedeu/geometry/position_validator.rb

@@ -32,7 +32,13 @@ module Vedeu
       :top,
       :bottom
 
-    attr_accessor :x, :y
+    # @!attribute [rw] x
+    # @return [Fixnum]
+    attr_accessor :x
+
+    # @!attribute [rw] x
+    # @return [Fixnum]
+    attr_accessor :y
 
     # @param interface [Interface]
     # @param x [Fixnum]
@@ -63,6 +69,8 @@ module Vedeu
 
     private
 
+    # @!attribute [r] interface
+    # @return [Vedeu::Interface]
     attr_reader :interface
 
     # Validate the x and y coordinates are within the dimensions of the

data/lib/vedeu/input/all.rb

@@ -1,6 +1,5 @@
 require 'vedeu/repositories/all'
 require 'vedeu/input/mapper'
-require 'vedeu/input/keys'
 require 'vedeu/input/key'
 require 'vedeu/input/input'
 require 'vedeu/input/keymap'

data/lib/vedeu/input/input.rb

@@ -32,6 +32,8 @@ module Vedeu
 
     private
 
+    # @!attribute [r] reader
+    # @return [IO]
     attr_reader :reader
 
     # Returns the input from the terminal.

data/lib/vedeu/input/keymap.rb

@@ -1,6 +1,7 @@
 require 'vedeu/exceptions'
-require 'vedeu/models/model'
+require 'vedeu/repositories/all'
 require 'vedeu/dsl/components/all'
+require 'vedeu/input/key'
 
 module Vedeu
 
@@ -13,12 +14,13 @@ module Vedeu
     collection Vedeu::Keys
     member     Vedeu::Key
 
+    # @!attribute [rw] name
+    # @return [String]
     attr_accessor :name
 
     # @param attributes [Hash]
     # @option attributes name [String] The name of the keymap.
-    # @option attributes keys [Vedeu::Model::Collection|Array] A collection of
-    #   keys.
+    # @option attributes keys [Vedeu::Keys|Array] A collection of keys.
     # @option attributes repository [Vedeu::Repository] This model's storage.
     # @return [Vedeu::Keymap]
     def initialize(attributes = {})

data/lib/vedeu/input/mapper.rb

@@ -63,7 +63,13 @@ module Vedeu
 
     private
 
-    attr_reader :key, :repository
+    # @!attribute [r] key
+    # @return [String|Symbol]
+    attr_reader :key
+
+    # @!attribute [r] repository
+    # @return [Vedeu::Repository]
+    attr_reader :repository
 
     # Is the key a global key?
     #

data/lib/vedeu/launcher.rb

@@ -63,7 +63,7 @@ module Vedeu
     def execute!
       $stdin, $stdout, $stderr = @stdin, @stdout, @stderr
 
-      Application.start(configuration)
+      Vedeu::Application.start(configuration)
 
       @exit_code = 0
 

data/lib/vedeu/models/all.rb

@@ -1,12 +1,15 @@
-require 'vedeu/models/collection'
+require 'vedeu/repositories/all'
 
-require 'vedeu/models/view/all'
+require 'vedeu/models/char'
+require 'vedeu/models/stream'
+require 'vedeu/models/line'
+require 'vedeu/models/interface'
+require 'vedeu/models/composition'
 
 require 'vedeu/models/focus'
 require 'vedeu/models/geometry'
 require 'vedeu/models/group'
 require 'vedeu/models/menu'
-require 'vedeu/models/model'
 
 module Vedeu
 end # Vedeu