vedeu 0.4.29 → 0.4.30

data/lib/vedeu/geometry/coordinate.rb

@@ -117,7 +117,7 @@ module Vedeu
 
     private
 
-    # @return (see Vedeu::Borders#by_name)
+    # @see Vedeu::Borders#by_name
     def border
       @border ||= Vedeu.borders.by_name(name)
     end

data/lib/vedeu/geometry/geometry.rb

@@ -9,18 +9,6 @@ module Vedeu
   # Calculates and provides interface geometry determined by both the client's
   # requirements and the terminal's current viewing area.
   #
-  # Geometry for Vedeu, as the same for ANSI terminals, has the origin at
-  # top-left, y = 1, x = 1. The 'y' coordinate is deliberately first.
-  #
-  #       x    north    xn           # north:  y - 1
-  #     y +--------------+           # top:    y
-  #       |     top      |           # west:   x - 1
-  #       |              |           # left:   x
-  #  west | left   right | east      # right:  xn
-  #       |              |           # east:   xn + 1
-  #       |    bottom    |           # bottom: yn
-  #    yn +--------------+           # south:  yn + 1
-  #            south
   class Geometry
 
     extend Forwardable

data/lib/vedeu/geometry/position_validator.rb

@@ -58,7 +58,7 @@ module Vedeu
 
     private
 
-    # @return (see Vedeu::Borders#by_name)
+    # @see Vedeu::Borders#by_name
     def border
       @border ||= Vedeu.borders.by_name(name)
     end

data/lib/vedeu/input/keymap.rb

@@ -1,4 +1,4 @@
-require 'vedeu/dsl/components/keymap'
+require 'vedeu/dsl/keymap'
 
 module Vedeu
 

data/lib/vedeu/models/interface.rb

@@ -141,6 +141,7 @@ module Vedeu
 
     private
 
+    # @see Vedeu::Cursors#by_name
     def cursor
       @cursor ||= Vedeu.cursors.by_name(name)
     end

data/lib/vedeu/models/panel.rb

@@ -1,7 +1,9 @@
 module Vedeu
 
+  # Abstract interface class without the baggage.
   class Panel
 
+    # @return [Vedeu::Panel]
     def initialize
     end
 

data/lib/vedeu/null/geometry.rb

@@ -23,7 +23,7 @@ module Vedeu
                      :height,
                      :width
 
-      # @!attribute [rw] maximise
+      # @!attribute [rw] maximised
       # @return [Boolean]
       attr_accessor :maximised
 
@@ -36,7 +36,8 @@ module Vedeu
       # @param name [String|NilClass]
       # @return [Vedeu::Null::Geometry]
       def initialize(name = nil)
-        @name = name
+        @name      = name
+        @maximised = false
       end
 
       # @return [FalseClass]

data/lib/vedeu/output/border.rb

@@ -120,22 +120,22 @@ module Vedeu
 
     # @return [Fixnum]
     def bx
-      (enabled? && left?) ? x + 1 : x
+      @bx ||= (enabled? && left?) ? x + 1 : x
     end
 
     # @return [Fixnum]
     def bxn
-      (enabled? && right?) ? xn - 1 : xn
+      @bxn ||= (enabled? && right?) ? xn - 1 : xn
     end
 
     # @return [Fixnum]
     def by
-      (enabled? && top?) ? y + 1 : y
+      @by ||= (enabled? && top?) ? y + 1 : y
     end
 
     # @return [Fixnum]
     def byn
-      (enabled? && bottom?) ? yn - 1 : yn
+      @byn ||= (enabled? && bottom?) ? yn - 1 : yn
     end
 
     # Returns the width of the interface determined by whether a left, right,
@@ -159,7 +159,7 @@ module Vedeu
       return [] unless visible?
       return [] unless enabled?
 
-      Vedeu::Timer.for(:timer, "Rendering border: #{name}") do
+      Vedeu.timer("Rendering border: #{name}") do
         out = [top, bottom]
 
         height.times do |y|
@@ -300,7 +300,7 @@ module Vedeu
     #
     # @return [Boolean]
     def title?
-      defined_value?(title)
+      present?(title)
     end
 
     # @param value [String]

data/lib/vedeu/output/clear.rb

@@ -76,7 +76,7 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     def clear
       if visible?
-        Vedeu::Timer.for(:timer, "Clearing: #{name}") do
+        Vedeu.timer("Clearing: #{name}") do
           y, x = *position
 
           @clear ||= Array.new(height) do |iy|
@@ -84,7 +84,7 @@ module Vedeu
               Vedeu::Char.new(value:    ' ',
                               colour:   clear_colour,
                               style:    style,
-                              position: [y + iy, x + ix])
+                              position: Vedeu::Position[y + iy, x + ix])
             end
           end
         end
@@ -111,7 +111,7 @@ module Vedeu
 
     private
 
-    # @return (see Vedeu::Borders#by_name)
+    # @see Vedeu::Borders#by_name
     def border
       @border ||= Vedeu.borders.by_name(name)
     end
@@ -143,7 +143,7 @@ module Vedeu
       }
     end
 
-    # @return (see Vedeu::Geometries#by_name)
+    # @see Vedeu::Geometries#by_name
     def geometry
       @geometry ||= Vedeu.geometries.by_name(name)
     end

data/lib/vedeu/output/compressor.rb

@@ -5,6 +5,12 @@ module Vedeu
   # sequence, resulting in a smaller payload being sent to the renderer.
   class Compressor
 
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.render(output)
+      new(output).render
+    end
+
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [Vedeu::Compressor]
     def initialize(output)
@@ -16,14 +22,14 @@ module Vedeu
     # @note Takes approximately ~70ms for 2100 chars. (2015-05-24)
     # @return [String]
     def render
-      Array(output).flatten.map do |char|
-        out = ''
+      out = ''
+      Array(output).flatten.each do |char|
         out << char.position.to_s
         out << colour_for(char)
         out << style_for(char)
         out << char.value
-        out
-      end.join
+      end
+      out
     end
 
     protected

data/lib/vedeu/output/html_char.rb

@@ -36,7 +36,7 @@ module Vedeu
 
     # @return [String]
     def td_style
-      return '' unless border || defined_value?(value)
+      return '' unless border || present?(value)
 
       " style='" \
       "background:#{bg};" \
@@ -47,7 +47,7 @@ module Vedeu
 
     # @return [String]
     def td_value
-      return ' ' if border || !defined_value?(value)
+      return ' ' if border || !present?(value)
 
       value
     end
@@ -102,10 +102,10 @@ module Vedeu
       type_to_html        = char.send(type).send(:to_html)
       parent_type_to_html = char.send(parent_type).send(:to_html)
 
-      if defined_value?(type_to_html)
+      if present?(type_to_html)
         type_to_html
 
-      elsif defined_value?(parent_type_to_html)
+      elsif present?(parent_type_to_html)
         parent_type_to_html
 
       else

data/lib/vedeu/output/refresh.rb

@@ -12,7 +12,7 @@ module Vedeu
     def all
       message = 'Refreshing all interfaces'
 
-      Vedeu::Timer.for(:timer, message) do
+      Vedeu.timer(message) do
         Vedeu.interfaces.zindexed.each { |model| by_name(model.name) }
       end
     end
@@ -32,7 +32,7 @@ module Vedeu
     def by_group(group_name)
       message = "Refreshing group: '#{group_name}'"
 
-      Vedeu::Timer.for(:timer, message) do
+      Vedeu.timer(message) do
         Vedeu.groups.find!(group_name).members.each { |name|
           Vedeu.interfaces.by_name(name)
         }.sort { |a, b| a.zindex <=> b.zindex }.each { |name| by_name(name) }
@@ -47,7 +47,7 @@ module Vedeu
     def by_name(name)
       message = "Refreshing interface: '#{name}'"
 
-      Vedeu::Timer.for(:timer, message) { Vedeu.buffers.by_name(name).render }
+      Vedeu.timer(message) { Vedeu.buffers.by_name(name).render }
     end
 
   end # Refresh

data/lib/vedeu/output/renderers/file.rb

@@ -57,7 +57,7 @@ module Vedeu
 
       # @return [String]
       def parsed
-        @parsed ||= Vedeu::Compressor.new(output).render
+        @parsed ||= Vedeu::Compressor.render(output)
       end
 
       # @return [Float]

data/lib/vedeu/output/renderers/terminal.rb

@@ -35,8 +35,8 @@ module Vedeu
 
       # @return [String]
       def parsed
-        Vedeu::Timer.for(:timer, 'Compression') do
-          Vedeu::Compressor.new(output).render
+        Vedeu.timer('Compression') do
+          Vedeu::Compressor.render(output)
         end
       end
 

data/lib/vedeu/output/renderers/text.rb

@@ -35,7 +35,7 @@ module Vedeu
 
       # @return [String]
       def parsed
-        Vedeu::Compressor.new(output).render
+        Vedeu::Compressor.render(output)
       end
 
     end # Text

data/lib/vedeu/output/style.rb

@@ -66,7 +66,7 @@ module Vedeu
     #
     # @return [String]
     def to_s
-      return '' unless defined_value?(value)
+      return '' unless present?(value)
 
       @sequences ||= Array(value).flatten.map { |v| Vedeu::Esc.string(v) }.join
     end

data/lib/vedeu/output/translator.rb

@@ -44,14 +44,6 @@ module Vedeu
       end
     end
 
-    # Convert a CSS/HTML colour string into a terminal escape sequence.
-    #
-    # @param colour [Fixnum|String|Symbol]
-    # @return [String]
-    def self.escape_sequence(colour = '')
-      new(colour).escape_sequence
-    end
-
     # Return a new instance of Vedeu::Translator.
     #
     # @param colour [Fixnum|String|Symbol]

data/lib/vedeu/output/viewport.rb

@@ -52,7 +52,7 @@ module Vedeu
     def render
       return [] unless visible?
 
-      Vedeu::Timer.for(:timer, "Rendering: #{name}") do
+      Vedeu.timer("Rendering: #{name}") do
         out = []
 
         show.each_with_index do |line, iy|

data/lib/vedeu/repositories/all.rb

@@ -30,7 +30,7 @@ module Vedeu
       @storage ||= Set.new
     end
 
-  end
+  end # Repositories
 
 end # Vedeu
 

data/lib/vedeu/repositories/repository.rb

@@ -156,7 +156,7 @@ module Vedeu
     # @return [void] The model instance which was stored.
     def store(model)
       fail MissingRequired, "Cannot store model '#{model.class}' without a " \
-                            'name attribute.' unless defined_value?(model.name)
+                            'name attribute.' unless present?(model.name)
 
       log_store(model)
 

data/lib/vedeu/support/common.rb

@@ -8,7 +8,7 @@ module Vedeu
     #
     # @param variable [String|Symbol|Array|Fixnum] The variable to check.
     # @return [Boolean]
-    def defined_value?(variable)
+    def present?(variable)
       return true if variable.is_a?(Fixnum)
       return true unless variable.nil? || variable.empty?
 

data/lib/vedeu/support/template.rb

@@ -3,7 +3,7 @@ module Vedeu
   # Generic class to loading a template and parsing it via ERb.
   class Template
 
-    # @param see Vedeu::Template#new
+    # @param (see Vedeu::Template#new)
     # @return [void]
     def self.parse(object, path, options = {})
       new(object, path, options).parse

data/lib/vedeu/support/timer.rb

@@ -3,19 +3,20 @@ module Vedeu
   # Measure the duration. Used for debugging.
   class Timer
 
-    # @param type [Symbol]
-    # @param message [String]
-    # @param block [Proc]
-    # @return [void]
-    def self.for(type = :debug, message = '', &block)
-      new(type, message).measure(&block)
+    class << self
+
+      # @param message [String]
+      # @param block [Proc]
+      # @return [void]
+      def timer(message = '', &block)
+        new(message).measure(&block)
+      end
+
     end
 
-    # @param type [Symbol]
     # @param message [String]
     # @return [Vedeu::Timer]
-    def initialize(type = :debug, message = '')
-      @type    = type
+    def initialize(message = '')
       @message = message
       @started = Time.now.to_f
     end
@@ -27,7 +28,7 @@ module Vedeu
 
       elapsed = ((Time.now.to_f - started) * 1000).to_i
 
-      Vedeu.log(type: type, message: "#{message} took #{elapsed}ms.")
+      Vedeu.log(type: :timer, message: "#{message} took #{elapsed}ms.")
 
       work
     end
@@ -42,10 +43,6 @@ module Vedeu
     # @return [String]
     attr_reader :message
 
-    # @!attribute [r] type
-    # @return [Symbol]
-    attr_reader :type
-
   end # Timer
 
 end # Vedeu

data/lib/vedeu/templating/all.rb

@@ -1,3 +1,12 @@
+module Vedeu
+
+  # Provides means to use templates with Vedeu.
+  module Templating
+
+  end # Templating
+
+end # Vedeu
+
 require_relative 'helpers'
 require_relative 'directive'
 require_relative 'preprocessor'

data/lib/vedeu/templating/helpers.rb

@@ -2,8 +2,14 @@ module Vedeu
 
   module Templating
 
+    # Provide helpers to be used with your Vedeu templates.
     module Helpers
 
+      # @example
+      #   Roses are {{ background('#ff0000', 'red') }},
+      #   violets are {{ bg('#0000ff', 'blue') }},
+      #   {{ background('#00ff00'), 'The test suite is all green!' }}
+      #
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
       # @return [Vedeu::Stream]
@@ -25,7 +31,7 @@ module Vedeu
 
       # @example
       #   Roses are {{ foreground('#ff0000', 'red') }},
-      #   violets are {{ fg('#0000ff', 'blue') }}
+      #   violets are {{ fg('#0000ff', 'blue') }},
       #   {{ foreground('#00ff00'), 'The test suite is all green!' }}
       #
       # @param value [String] The HTML/CSS colour.
@@ -39,7 +45,7 @@ module Vedeu
 
       private
 
-      # @param see Vedeu::Templating::Helpers#colours
+      # @see Vedeu::Templating::Helpers#colours
       def define_colour(attributes = {})
         attributes.delete_if do |k, v|
           [:background, :foreground].include?(k) == false || v.nil? || v.empty?
@@ -48,7 +54,7 @@ module Vedeu
         Vedeu::Colour.new(attributes)
       end
 
-      # @param see Vedeu::Templating::Helpers#colours
+      # @see Vedeu::Templating::Helpers#colours
       def define_stream(attributes = {}, &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 

data/lib/vedeu/templating/preprocessor.rb

@@ -11,7 +11,7 @@ module Vedeu
     #
     # process
     #   converts JSON streams into line/stream objects with correct attributes
-
+    #
     # Pre-processes a template, to convert all lines and lines with directives
     # into Vedeu::Streams.
     class Preprocessor
@@ -52,6 +52,9 @@ module Vedeu
 
       # Return a pattern to remove directive markers and spaces.
       #
+      # @example
+      #   line containing {{ or }}
+      #
       # @return [Regexp]
       def markers
         /({{\s*|\s*}})/

data/lib/vedeu/version.rb

@@ -0,0 +1,3 @@
+module Vedeu
+  VERSION = '0.4.30'
+end