vedeu 0.4.5 → 0.4.6

data/lib/vedeu/output/wordwrap.rb

@@ -4,16 +4,32 @@ module Vedeu
   #
   class Wordwrap
 
+    # @see {Vedeu::Wordwrap#initialize}
+    def self.for(text, options = {})
+      new(text, options).content
+    end
+
     # @param text [String]
     # @param options [Hash]
-    # @option options ellipsis [String]
-    # @option options width [Fixnum]
+    # @option options ellipsis [String] For when using mode `:prune`.
+    # @option options mode [Symbol] One of :default, :prune, :wrap
+    # @option options width [Fixnum] The width in characters to prune or wrap to.
     # @return [Vedeu::Wordwrap]
     def initialize(text, options = {})
       @text    = text
       @options = defaults.merge!(options)
     end
 
+    # @return [Vedeu::Lines]
+    def content
+      case(mode)
+      when :prune then to_line_objects(prune)
+      when :wrap  then to_line_objects(wrap)
+      else
+        to_line_objects(split_lines)
+      end
+    end
+
     # @return [Array<String>|String]
     def prune
       return text if text.size <= pruned_width
@@ -60,26 +76,15 @@ module Vedeu
       end
     end
 
-    # @return [Vedeu::Lines]
-    def as_lines
-      if __callee__ == :prune_as_lines
-        to_line_objects(prune)
-
-      elsif __callee__ == :wrap_as_lines
-        to_line_objects(wrap)
-
-      else
-        to_line_objects(split_lines)
-
-      end
-    end
-    alias_method :prune_as_lines, :as_lines
-    alias_method :wrap_as_lines, :as_lines
-
     private
 
-    attr_reader :text,
-      :options
+    # @!attribute [r] text
+    # @return [String]
+    attr_reader :text
+
+    # @!attribute [r] options
+    # @return [Hash]
+    attr_reader :options
 
     # @param text_as_lines [Array<String>]
     # @return [Vedeu::Lines]
@@ -137,6 +142,11 @@ module Vedeu
       options.fetch(:ellipsis)
     end
 
+    # @return [Symbol]
+    def mode
+      options.fetch(:mode)
+    end
+
     # @return [Fixnum]
     def width
       options.fetch(:width)
@@ -146,6 +156,7 @@ module Vedeu
     def defaults
       {
         ellipsis: '...',
+        mode:     :default,
         width:    70,
       }
     end

data/lib/vedeu/repositories/all.rb

@@ -1,3 +1,6 @@
+require 'vedeu/repositories/collection'
+require 'vedeu/repositories/collections'
+require 'vedeu/repositories/model'
 require 'vedeu/repositories/repository'
 
 module Vedeu

data/lib/vedeu/repositories/collection.rb

@@ -0,0 +1,83 @@
+module Vedeu
+
+  # Convert an Array into an object which has some meaning in the context it
+  # is being used.
+  #
+  class Collection
+
+    include Enumerable
+
+    # @!attribute [rw] parent
+    # @return [Fixnum]
+    attr_accessor :parent
+
+    # @!attribute [rw] name
+    # @return [String]
+    attr_accessor :name
+
+    # @param collection [Array|Vedeu::Collection]
+    # @param parent [void]
+    # @param name [String|NilClass]
+    # @return [Vedeu::Collection]
+    def self.coerce(collection = [], parent = nil, name = nil)
+      if collection.kind_of?(Vedeu::Collection)
+        collection
+
+      else
+        new(Array(collection), parent, name)
+
+      end
+    end
+
+    # @param collection []
+    # @param parent [void]
+    # @param name [String|NilClass]
+    # @return [Vedeu::Collection]
+    def initialize(collection = [], parent = nil, name = nil)
+      @collection = collection
+      @parent     = parent
+      @name       = name
+    end
+
+    # @param value [Fixnum]
+    # @return [void]
+    def [](value)
+      @collection[value]
+    end
+
+    # @param other [Vedeu::Collection]
+    # @return [Vedeu::Collection]
+    def add(*other)
+      self.class.new(@collection += other, parent, name)
+    end
+    alias_method :<<, :add
+
+    # @return [Array]
+    def all
+      @collection
+    end
+
+    # @param block [Proc]
+    # @return [Enumerator]
+    def each(&block)
+      @collection.each(&block)
+    end
+
+    # @return [Boolean]
+    def empty?
+      @collection.empty?
+    end
+
+    # @return [Fixnum]
+    def size
+      @collection.size
+    end
+
+    # @return [String]
+    def to_s
+      @collection.map(&:to_s).join
+    end
+
+  end # Collection
+
+end # Vedeu

data/lib/vedeu/repositories/collections.rb

@@ -0,0 +1,35 @@
+require 'vedeu/repositories/collection'
+
+module Vedeu
+
+  # A collection of {Vedeu::Char} instances.
+  #
+  class Chars < Vedeu::Collection
+  end # Chars
+
+  # A collection of {Vedeu::Event} instances.
+  #
+  class Events < Vedeu::Collection
+  end # Events
+
+  # A collection of {Vedeu::Interface} instances.
+  #
+  class Interfaces < Vedeu::Collection
+  end # Interfaces
+
+  # A collection of {Vedeu::Key} instances.
+  #
+  class Keys < Vedeu::Collection
+  end # Keys
+
+  # A collection of {Vedeu::Line} instances.
+  #
+  class Lines < Vedeu::Collection
+  end # Lines
+
+  # A collection of {Vedeu::Stream} instances.
+  #
+  class Streams < Vedeu::Collection
+  end # Streams
+
+end # Vedeu

data/lib/vedeu/{models → repositories}/model.rb

@@ -5,6 +5,8 @@ module Vedeu
   #
   module Model
 
+    # @!attribute [r] repository
+    # @return [Vedeu::Repository]
     attr_reader :repository
 
     # When {Vedeu::Model} is included in a class, the methods within this module

data/lib/vedeu/repositories/repository.rb

@@ -16,7 +16,13 @@ module Vedeu
     include Vedeu::Common
     include Enumerable
 
-    attr_reader :model, :storage
+    # @!attribute [r] model
+    # @return [void]
+    attr_reader :model
+
+    # @!attribute [r] storage
+    # @return [void]
+    attr_reader :storage
 
     # @param model [Class]
     # @param storage [Class|Hash]

data/lib/vedeu/support/log.rb

@@ -138,7 +138,7 @@ module Vedeu
 
       # @return [String]
       def message_type(type)
-        Esc.send(message_types.fetch(type, :default)) { "[#{type}]".ljust(9) }
+        Vedeu::Esc.send(message_types.fetch(type, :default)) { "[#{type}]".ljust(9) }
       end
 
       # @return [Hash]

data/lib/vedeu/support/sentence.rb

@@ -41,7 +41,13 @@ module Vedeu
 
     private
 
-    attr_reader :elements, :label
+    # @!attribute [r] elements
+    # @return [Array]
+    attr_reader :elements
+
+    # @!attribute [r] label
+    # @return [String]
+    attr_reader :label
 
     # @return [Boolean]
     def one?

data/lib/vedeu/support/template.rb

@@ -17,7 +17,7 @@ module Vedeu
     # @param path [String]
     # @return [Template]
     def initialize(object, path)
-      @object, @path = object, path
+      @object, @path = object, path.to_s
     end
 
     # @return [void]
@@ -27,13 +27,25 @@ module Vedeu
 
     private
 
-    attr_reader :object, :path
+    # @!attribute [r] object
+    # @return [Class]
+    attr_reader :object
 
     # @return [String]
     def load
       File.read(path)
     end
 
+    # @raise [MissingRequired] when the path is empty.
+    # @raise [MissingRequired] when the path does not exist.
+    # @return [String]
+    def path
+      fail MissingRequired, 'No path to template specified.' if @path.empty?
+      fail MissingRequired, 'Template file cannot be found.' unless File.exist?(@path)
+
+      @path
+    end
+
   end # Template
 
 end # Vedeu

data/lib/vedeu/support/terminal.rb

@@ -167,7 +167,7 @@ module Vedeu
     #
     # @return [Symbol]
     def mode
-      @mode ||= Configuration.terminal_mode
+      @mode ||= Vedeu::Configuration.terminal_mode
     end
 
     # Returns a coordinate tuple of the format [y, x], where `y` is the row/line
@@ -214,8 +214,8 @@ module Vedeu
     #
     # @return [Fixnum]
     def width
-      if Configuration.drb?
-        Configuration.drb_width
+      if Vedeu::Configuration.drb?
+        Vedeu::Configuration.drb_width
 
       else
         size.last
@@ -232,8 +232,8 @@ module Vedeu
     #
     # @return [Fixnum]
     def height
-      if Configuration.drb?
-        Configuration.drb_height
+      if Vedeu::Configuration.drb?
+        Vedeu::Configuration.drb_height
 
       else
         size.first
@@ -259,7 +259,7 @@ module Vedeu
 
     # @return [VirtualTerminal]
     def virtual
-      @virtual ||= VirtualTerminal.new(height, width)
+      @virtual ||= Vedeu::VirtualTerminal.new(height, width)
     end
 
   end # Terminal

data/lib/vedeu/support/trace.rb

@@ -90,11 +90,11 @@ module Vedeu
         valclass = value.class.to_s
         output   = (value.is_a?(Proc)) ? '#<Proc:...' : value.inspect
 
-        content  = Esc.send(class_colour.fetch(valclass, :white)) { output }
+        content  = Vedeu::Esc.send(class_colour.fetch(valclass, :white)) { output }
 
         entries << sprintf("%33s %-10s = %s %s", " ",
-                                                 Esc.green { variable },
-                                                 Esc.magenta { valclass },
+                                                 Vedeu::Esc.green { variable },
+                                                 Vedeu::Esc.magenta { valclass },
                                                  content)
       end
       entries.join("\n")
@@ -232,7 +232,7 @@ module Vedeu
         # 'Vedeu::Menu',
         # 'Vedeu::Menus',
         # 'Vedeu::Model',
-        # 'Vedeu::Model::Collection',
+        # 'Vedeu::Collection',
         # 'Vedeu::MoveCursor',
         # 'Vedeu::Node',
         # 'Vedeu::Output',

data/lib/vedeu/support/visible.rb

@@ -36,10 +36,10 @@ module Vedeu
     # @return [String]
     def cursor
       if visible?
-        Esc.string('show_cursor')
+        Vedeu::Esc.string('show_cursor')
 
       else
-        Esc.string('hide_cursor')
+        Vedeu::Esc.string('hide_cursor')
 
       end
     end
@@ -56,12 +56,12 @@ module Vedeu
 
     # @return [Visible]
     def hide
-      Visible.new(false)
+      Vedeu::Visible.new(false)
     end
 
     # @return [Visible]
     def show
-      Visible.new(true)
+      Vedeu::Visible.new(true)
     end
 
     # @return [Visible]

data/test/lib/vedeu/dsl/composition_test.rb

@@ -32,6 +32,29 @@ module Vedeu
         end
       end
 
+      describe '#template_for' do
+        let(:_name)    {}
+        let(:filename) {}
+        let(:object)   {}
+        let(:content)  { "Hydrogen\nCarbon\nOxygen\nNitrogen" }
+        let(:as_lines) {
+          [
+            Vedeu::Line.new({ streams: [Vedeu::Stream.new({ value: 'Hydrogen' })] }),
+            Vedeu::Line.new({ streams: [Vedeu::Stream.new({ value: 'Carbon' })] }),
+            Vedeu::Line.new({ streams: [Vedeu::Stream.new({ value: 'Oxygen' })] }),
+            Vedeu::Line.new({ streams: [Vedeu::Stream.new({ value: 'Nitrogen' })] })
+          ]
+        }
+
+        before do
+          Vedeu::Template.expects(:parse).with(object, filename).returns(content)
+        end
+
+        subject { instance.template_for(_name, filename, object) }
+
+        it { subject.must_be_instance_of(Vedeu::Interfaces) }
+      end
+
     end # Composition
 
   end # DSL

data/test/lib/vedeu/geometry/index_position_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+
+module Vedeu
+
+  describe IndexPosition do
+
+    let(:described) { Vedeu::IndexPosition }
+    let(:instance)  { described.new(iy, ix, oy, ox) }
+    let(:iy)        { 6 }
+    let(:ix)        { 17 }
+    let(:oy)        { 3 }
+    let(:ox)        { 5 }
+
+    describe 'alias methods' do
+      it { instance.must_respond_to(:first) }
+      it { instance.must_respond_to(:last) }
+    end
+
+    describe '#initialize' do
+      it { instance.must_be_instance_of(described) }
+      it { instance.instance_variable_get('@oy').must_equal(3) }
+      it { instance.instance_variable_get('@ox').must_equal(5) }
+      it { instance.instance_variable_get('@iy').must_equal(6) }
+      it { instance.instance_variable_get('@ix').must_equal(17) }
+    end
+
+    describe '.[]' do
+      subject { described[iy, ix] }
+
+      it { subject.must_be_instance_of(Array) }
+      it { subject.must_equal([7, 18]) }
+    end
+
+    describe '#[]' do
+      subject { instance.[] }
+
+      it { subject.must_be_instance_of(Array) }
+      it { subject.must_equal([9, 22]) }
+    end
+
+    describe '#to_position' do
+      subject { instance.to_position }
+
+      it { subject.must_be_instance_of(Vedeu::Position) }
+    end
+
+    describe '#y' do
+      subject { instance.y }
+
+      context 'when iy is <= 0' do
+        let(:iy) { -2 }
+
+        context 'and oy is <= 1' do
+          let(:oy) { -6 }
+
+          it { subject.must_equal(1) }
+        end
+
+        context 'and oy is > 1' do
+          let(:oy) { 4 }
+
+          it { subject.must_equal(4) }
+        end
+      end
+
+      context 'when iy is > 0' do
+        let(:iy) { 3 }
+
+        context 'and oy is <= 1' do
+          let(:oy) { -7 }
+
+          it { subject.must_equal(4) }
+        end
+
+        context 'and oy is > 1' do
+          let(:oy) { 5 }
+
+          it { subject.must_equal(8) }
+        end
+      end
+    end
+
+    describe '#x' do
+      subject { instance.x }
+
+      context 'when ix is <= 0' do
+        let(:ix) { -2 }
+
+        context 'and ox is <= 1' do
+          let(:ox) { -6 }
+
+          it { subject.must_equal(1) }
+        end
+
+        context 'and ox is > 1' do
+          let(:ox) { 4 }
+
+          it { subject.must_equal(4) }
+        end
+      end
+
+      context 'when ix is > 0' do
+        let(:ix) { 3 }
+
+        context 'and ox is <= 1' do
+          let(:ox) { -7 }
+
+          it { subject.must_equal(4) }
+        end
+
+        context 'and ox is > 1' do
+          let(:ox) { 5 }
+
+          it { subject.must_equal(8) }
+        end
+      end
+    end
+
+  end # IndexPosition
+
+end # Vedeu

data/test/lib/vedeu/{output → geometry}/position_index_test.rb

@@ -41,6 +41,12 @@ module Vedeu
       it { subject.must_equal([5, 16]) }
     end
 
+    describe '#to_position' do
+      subject { instance.to_position }
+
+      it { subject.must_be_instance_of(Vedeu::Position) }
+    end
+
     describe 'attr_reader' do
       context '#y' do
         subject { instance.y }

data/test/lib/vedeu/input/keymap_test.rb

@@ -46,7 +46,7 @@ module Vedeu
       subject { instance.key_defined?(input) }
 
       context 'when the input is defined' do
-        let(:keys) { Vedeu::Model::Collection.new([key]) }
+        let(:keys) { Vedeu::Keys.new([key]) }
 
         it { subject.must_be_instance_of(TrueClass) }
       end
@@ -65,7 +65,7 @@ module Vedeu
         let(:key_a) { Vedeu::Key.new('a') { :key_a } }
         let(:key_b) { Vedeu::Key.new('b') { :key_b } }
         let(:key_c) { Vedeu::Key.new('c') { :key_c } }
-        let(:keys)  { Vedeu::Model::Collection.new([key_a, key_b, key_c]) }
+        let(:keys)  { Vedeu::Keys.new([key_a, key_b, key_c]) }
 
         it { subject.must_be_instance_of(Array) }
         it { subject.must_equal([:key_b]) }

data/test/lib/vedeu/models/{view/char_test.rb → char_test.rb}

@@ -8,15 +8,15 @@ module Vedeu
     let(:instance)      { described.new(attributes) }
     let(:attributes)    {
       {
-        colour: colour,
-        parent: parent,
+        colour:   colour,
+        parent:   parent,
         position: position,
-        style: style,
-        value: value,
+        style:    style,
+        value:    value,
       }
     }
     let(:value)         { 'a' }
-    let(:parent)        { Line.new(parent_attributes) }
+    let(:parent)        { Vedeu::Line.new(parent_attributes) }
     let(:parent_attributes) {
       {
         streams: [],
@@ -25,6 +25,7 @@ module Vedeu
         style:   parent_style,
       }
     }
+    let(:border)        { nil }
     let(:colour)        { nil }
     let(:style)         { nil }
     let(:position)      { nil }
@@ -32,7 +33,8 @@ module Vedeu
     let(:parent_style)  { nil }
 
     describe '#initialize' do
-      it { instance.must_be_instance_of(Char) }
+      it { instance.must_be_instance_of(described) }
+      it { instance.instance_variable_get('@border').must_equal(border) }
       it { instance.instance_variable_get('@colour').must_equal(colour) }
       it { instance.instance_variable_get('@parent').must_equal(parent) }
       it { instance.instance_variable_get('@style').must_equal(style) }
@@ -41,6 +43,20 @@ module Vedeu
       it { instance.must_respond_to(:value) }
     end
 
+    describe '#inspect' do
+      let(:colour)   { Vedeu::Colour.new({ foreground: '#00ff00',
+                                           background: '#005500' }) }
+      let(:position) { Vedeu::Position.new(17, 2) }
+      let(:style)    { Vedeu::Style.new('underline') }
+
+
+      subject { instance.inspect }
+
+      it { subject.must_equal(
+        "<Vedeu::Char '\\e[17;2H\\e[38;2;0;255;0m\\e[48;2;0;85;0m\\e[4ma\\e[17;2H'>"
+      ) }
+    end
+
     describe '#to_html' do
       subject { instance.to_html }
 
@@ -53,7 +69,7 @@ module Vedeu
       it { subject.must_be_instance_of(String) }
 
       context 'when a position is specified' do
-        let(:position) { Position.new(17, 2) }
+        let(:position) { Vedeu::Position.new(17, 2) }
 
         it { subject.must_equal("\e[17;2Ha\e[17;2H") }
       end
@@ -65,12 +81,12 @@ module Vedeu
       end
 
       context 'when a colour is specified' do
-        let(:colour) { Colour.new({ foreground: '#00ff00',
-                                    background: '#005500' }) }
+        let(:colour) { Vedeu::Colour.new({ foreground: '#00ff00',
+                                           background: '#005500' }) }
 
         context 'when a parent colour is specified' do
-          let(:parent_colour) { Colour.new({ foreground: '#ff0000',
-                                             background: '#550000' }) }
+          let(:parent_colour) { Vedeu::Colour.new({ foreground: '#ff0000',
+                                                    background: '#550000' }) }
 
           it { subject.must_equal("\e[38;2;0;255;0m\e[48;2;0;85;0ma\e[38;2;255;0;0m\e[48;2;85;0;0m") }
         end
@@ -89,10 +105,10 @@ module Vedeu
       end
 
       context 'when a style is specified' do
-        let(:style) { Style.new('underline') }
+        let(:style) { Vedeu::Style.new('underline') }
 
         context 'when a parent style is specified' do
-          let(:parent_style) { Style.new('bold') }
+          let(:parent_style) { Vedeu::Style.new('bold') }
 
           it { subject.must_equal("\e[4ma\e[1m") }
         end
@@ -118,7 +134,7 @@ module Vedeu
     end
 
     describe '#x' do
-      let(:position) { Position.new(17, 2) }
+      let(:position) { Vedeu::Position.new(17, 2) }
 
       subject { instance.x }
 
@@ -134,7 +150,7 @@ module Vedeu
     end
 
     describe '#y' do
-      let(:position) { Position.new(17, 2) }
+      let(:position) { Vedeu::Position.new(17, 2) }
 
       subject { instance.y }