vedeu 0.3.0 → 0.3.1

data/lib/vedeu/support/position_validator.rb

@@ -29,20 +29,29 @@ module Vedeu
 
     attr_accessor :x, :y
 
+    # @param interface [Interface]
+    # @param x [Fixnum]
+    # @param y [Fixnum]
+    # @return [PositionValidator]
     def self.validate(interface, x, y)
       new(interface, x, y).validate
     end
 
+    # @param interface [Interface]
+    # @param x [Fixnum]
+    # @param y [Fixnum]
+    # @return [PositionValidator]
     def initialize(interface, x, y)
       @interface = interface
       @x         = x
       @y         = y
     end
 
+    # @return [PositionValidator]
     def validate
       terminal_validation
       interface_validation
-      border_validation
+      border_validation if border?
 
       self
     end
@@ -66,14 +75,26 @@ module Vedeu
     end
 
     def border_validation
-      if border?
-        @x = left + 1   if left?   && x < (left + 1)
-        @x = right - 2  if right?  && x > (right - 1)
-        @y = top + 1    if top?    && y < (top + 1)
-        @y = bottom - 2 if bottom? && y > (bottom - 1)
-      end
+      @x = left + 1   if left?   && x < (left + 1)
+      @x = right - 2  if right?  && x > (right - 1)
+      @y = top + 1    if top?    && y < (top + 1)
+      @y = bottom - 2 if bottom? && y > (bottom - 1)
     end
 
+    # def x
+    #   @x = [[[[@x, tx].max, txn].min, left].max, right].min
+    #   @x = border? && left?  ? [@x, (left + 1)].max  : @x
+    #   @x = border? && right? ? [@x, (right - 2)].min : @x
+    #   @x
+    # end
+
+    # def y
+    #   @y = [[[[@y, ty].max, tyn].min, top].max, bottom].min
+    #   @y = border? && top?    ? [@y, (top + 1)].max    : @y
+    #   @y = border? && bottom? ? [@y, (bottom - 2)].min : @y
+    #   @y
+    # end
+
   end # PositionValidator
 
 end # Vedeu

data/lib/vedeu/support/sentence.rb

@@ -1,19 +1,32 @@
 module Vedeu
 
+  # Take a collection of words (elements) and form a sentence from them.
+  #
+  # @example
+  #   elements = ['Hydrogen', 'Helium', 'Lithium']
+  #   Vedeu::Sentence.construct(elements) # => 'Hydrogen, Helium and Lithium'
+  #
   class Sentence
 
     class << self
 
+      # @param elements [Array]
+      # @param label [String]
+      # @return [String]
       def construct(elements, label = 'elements')
         new(elements, label).construct
       end
 
-    end # Sentence eigenclass
+    end
 
+    # @param elements [Array]
+    # @param label [String]
+    # @return [Vedeu::Sentence]
     def initialize(elements, label)
       @elements, @label = elements, label
     end
 
+    # @return [String]
     def construct
       if one?
         first
@@ -34,30 +47,37 @@ module Vedeu
 
     attr_reader :elements, :label
 
+    # @return [Boolean]
     def one?
       count == 1
     end
 
+    # @return [Boolean]
     def two?
       count == 2
     end
 
+    # @return [Boolean]
     def many?
       count > 2
     end
 
+    # @return [String]
     def but_last
       elements[0...-1].join(', ')
     end
 
+    # @return [String]
     def first
       elements.first
     end
 
+    # @return [String]
     def last
       elements[-1]
     end
 
+    # @return [Fixnum]
     def count
       elements.size
     end

data/lib/vedeu/support/terminal.rb

@@ -1,5 +1,4 @@
 require 'vedeu/configuration/configuration'
-require 'vedeu/support/common'
 require 'vedeu/support/esc'
 require 'vedeu/support/log'
 
@@ -11,7 +10,6 @@ module Vedeu
   # @api private
   module Terminal
 
-    include Vedeu::Common
     extend self
 
     # Opens a terminal screen in either `raw` or `cooked` mode. On exit,

data/lib/vedeu/support/trace.rb

@@ -166,40 +166,86 @@ module Vedeu
         # 'Vedeu::API',
         # 'Vedeu::Application',
         # 'Vedeu::Background',
+        # 'Vedeu::Bindings',
+        # 'Vedeu::Border',
+        # 'Vedeu::BoundingArea',
+        # 'Vedeu::Buffer',
+        # 'Vedeu::Char',
+        # 'Vedeu::Chars',
         'Vedeu::Coercions',
         'Vedeu::Colour',
-        'Vedeu::Translator',
         'Vedeu::Common',
         # 'Vedeu::Composition',
         # 'Vedeu::Compositor',
+        # 'Vedeu::Config::API',
+        # 'Vedeu::Config::CLI',
         'Vedeu::Configuration',
+        # 'Vedeu::Console',
+        # 'Vedeu::ContentGeometry',
+        # 'Vedeu::Coordinate',
         # 'Vedeu::Cursor',
-        # 'Vedeu::Cursors',
+        # 'Vedeu::DisplayBuffer',
+        # 'Vedeu::DSL::Border',
+        # 'Vedeu::DSL::Colour',
+        # 'Vedeu::DSL::Composition',
+        # 'Vedeu::DSL::Geometry',
+        # 'Vedeu::DSL::Interface',
+        # 'Vedeu::DSL::Keymap',
+        # 'Vedeu::DSL::Line',
+        # 'Vedeu::DSL::Menu',
+        # 'Vedeu::DSL::Stream',
+        # 'Vedeu::DSL::Style',
+        # 'Vedeu::DSL::Text',
+        # 'Vedeu::DSL::Use',
+        # 'Vedeu::DSL::View',
         'Vedeu::Esc',
         'Vedeu::Event',
         # 'Vedeu::Focus',
         # 'Vedeu::Foreground',
         'Vedeu::Geometry',
         # 'Vedeu::Grid',
+        # 'Vedeu::Group',
         # 'Vedeu::Input',
         # 'Vedeu::Interface',
+        # 'Vedeu::Interfaces',
         # 'Vedeu::Keymap',
+        # 'Vedeu::Keys',
+        # 'Vedeu::Key',
         # 'Vedeu::Launcher',
         # 'Vedeu::Line',
+        # 'Vedeu::Lines',
         'Vedeu::Log',
+        # 'Vedeu::Mapper',
         # 'Vedeu::Menu',
         # 'Vedeu::Menus',
+        # 'Vedeu::Model',
+        # 'Vedeu::Model::Collection',
+        # 'Vedeu::MoveCursor',
+        # 'Vedeu::Node',
+        # 'Vedeu::Output',
         'Vedeu::Position',
+        # 'Vedeu::PositionValidator',
         'Vedeu::Presentation',
+        # 'Vedeu::Read',
         # 'Vedeu::Refresh',
         # 'Vedeu::Render',
         'Vedeu::Repository',
+        # 'Vedeu::Sentence',
         'Vedeu::Stream',
+        # 'Vedeu::Streams',
         'Vedeu::Style',
         'Vedeu::Terminal',
+        # 'Vedeu::Text',
+        # 'Vedeu::ToggleCursor',
         'Vedeu::Trace',
+        'Vedeu::Translator',
+        # 'Vedeu::Traps',
+        # 'Vedeu::Trigger',
         # 'Vedeu::View',
         # 'Vedeu::Viewport',
+        # 'Vedeu::Visible',
+        # 'Vedeu::Write',
+        # 'Vedeu::Writer',
       ]
     end
 

data/lib/vedeu/support/visible.rb

@@ -47,10 +47,12 @@ module Vedeu
       end
     end
 
+    # @return [Boolean]
     def visible?
       @visible
     end
 
+    # @return [Boolean]
     def invisible?
       !@visible
     end

data/test/lib/vedeu/cursor/all_test.rb

@@ -27,7 +27,7 @@ module Vedeu
   describe '.cursors' do
     subject { Vedeu.cursors }
 
-    it { subject.must_be_instance_of(Vedeu::Cursors) }
+    it { subject.must_be_instance_of(Vedeu::Repository) }
   end
 
 end # Vedeu

data/test/lib/vedeu/events/event_test.rb

@@ -16,26 +16,6 @@ module Vedeu
       it { subject.must_be_instance_of(TrueClass) }
     end
 
-    # describe '.unbind' do
-    #   let(:event_name) { :chlorine }
-
-    #   before do
-    #     Vedeu.bind(:chlorine) { :some_event }
-    #   end
-
-    #   subject { instance.unbind(event_name) }
-
-    #   context 'when the event exists' do
-    #     it { subject.must_be_instance_of(TrueClass) }
-    #   end
-
-    #   context 'when the event does not exist' do
-    #     let(:event_name) { :does_not_exist }
-
-    #     it { subject.must_be_instance_of(FalseClass) }
-    #   end
-    # end
-
     describe '#initialize' do
       subject { instance }
 
@@ -67,20 +47,20 @@ module Vedeu
       it 'returns the result of calling the closure when debouncing' do
         event = Event.new(event_name, { debounce: 0.0025 }, closure)
         event.trigger.must_equal(nil)
-        sleep 0.0015
+        sleep 0.001
         event.trigger.must_equal(nil)
-        sleep 0.0015
+        sleep 0.001
         event.trigger.must_equal(:event_triggered)
-        sleep 0.0015
+        sleep 0.001
         event.trigger.must_equal(nil)
       end
 
       it 'returns the result of calling the closure when throttling' do
-        event = Event.new(event_name, { delay: 0.0025 }, closure)
+        event = Event.new(event_name, { delay: 0.002 }, closure)
         event.trigger.must_equal(:event_triggered)
-        sleep 0.0015
+        sleep 0.001
         event.trigger.must_equal(nil)
-        sleep 0.0015
+        sleep 0.001
         event.trigger.must_equal(:event_triggered)
       end
 
@@ -92,9 +72,7 @@ module Vedeu
 
     describe '#unbind' do
       context 'when the event exists' do
-        before do
-          Vedeu.bind(:gallium) { :some_action }
-        end
+        before { Vedeu.bind(:gallium) { :some_action } }
 
         it { Vedeu.unbind(:gallium).must_equal(true) }
       end

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

@@ -8,13 +8,13 @@ module Vedeu
     let(:instance)  { described.new(input) { :output } }
     let(:input)     { 'a' }
 
-    describe '.define' do
-      subject { described.define(input) { :output } }
+    describe '.build' do
+      subject { described.build(input) { :output } }
 
       it { subject.must_be_instance_of(Key) }
 
       context 'when the required block is not given' do
-        subject { described.define(input) }
+        subject { described.build(input) }
 
         it { proc { subject }.must_raise(InvalidSyntax) }
       end

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

@@ -15,7 +15,7 @@ module Vedeu
 
       it { subject.must_be_instance_of(Keymap) }
       it { subject.instance_variable_get('@name').must_equal(map_name) }
-      it { subject.instance_variable_get('@keys').must_be_instance_of(Vedeu::Model::Collection) }
+      it { subject.instance_variable_get('@keys').must_be_instance_of(Array) }
       it { subject.instance_variable_get('@repository').must_equal(Vedeu.keymaps) }
     end
 
@@ -32,7 +32,7 @@ module Vedeu
       end
 
       context 'when the key is not already defined' do
-        it { subject.must_be_instance_of(Vedeu::Model::Collection) }
+        it { subject.must_be_instance_of(Vedeu::Keys) }
       end
     end
 
@@ -75,7 +75,7 @@ module Vedeu
     describe '#keys' do
       subject { instance.keys }
 
-      it { subject.must_be_instance_of(Vedeu::Model::Collection) }
+      it { subject.must_be_instance_of(Vedeu::Keys) }
     end
 
     describe '#name' do

data/test/lib/vedeu/output/wordwrap_test.rb

@@ -0,0 +1,266 @@
+require 'test_helper'
+
+module Vedeu
+
+  describe Wordwrap do
+
+    let(:described) { Vedeu::Wordwrap }
+    let(:instance)  { described.new(text, options) }
+    let(:text)      { '' }
+    let(:options)   {
+      {
+        ellipsis: '...',
+        width:    width,
+      }
+    }
+    let(:width)     { 30 }
+
+    let(:text_line) {
+      "Krypton (from Greek: κρυπτός kryptos 'the hidden one')."
+    }
+    let(:text_block) {
+      "Krypton (from Greek: κρυπτός kryptos 'the hidden one') is a chemical " \
+      "element with symbol Kr and atomic number 36. It is a member of group " \
+      "18 (noble gases) elements."
+    }
+    let(:text_newlines) {
+      "Krypton is a colorless, odorless, tasteless noble gas.\n"            \
+      "It occurs in trace amounts in the atmosphere.\n"                     \
+      "It is isolated by fractionally distilling liquefied air.\n"          \
+      "Krypton is often used with other rare gases in fluorescent lamps.\n"
+    }
+    let(:text_blanklines) {
+      "Krypton (from Greek: κρυπτός kryptos 'the hidden one').\n\n"     \
+      "It is a chemical element with symbol Kr and atomic number 36.\n" \
+      "It is a member of group 18 (noble gases) elements.\n\n"          \
+      "-- Wikipedia"
+    }
+    let(:text_line_objects) {
+      [
+        Vedeu::Line.new("Krypton is a colorless, odorless, tasteless noble gas."),
+        Vedeu::Line.new("It occurs in trace amounts in the atmosphere."),
+        Vedeu::Line.new("It is isolated by fractionally distilling liquefied air."),
+        Vedeu::Line.new("Krypton is often used with other rare gases in fluorescent lamps.")
+      ]
+    }
+
+    describe '#initialize' do
+      subject { instance }
+
+      it { subject.must_be_instance_of(described) }
+      it { subject.instance_variable_get('@text').must_equal(text) }
+      it { subject.instance_variable_get('@options').must_equal(options) }
+    end
+
+    describe '#prune' do
+      let(:text) { text_line }
+
+      subject { instance.prune }
+
+      context 'when the text is <= the pruning width' do
+        let(:width) { 80 }
+
+        it { subject.must_be_instance_of(String) }
+
+        it { subject.must_equal(
+          "Krypton (from Greek: κρυπτός kryptos 'the hidden one')."
+        ) }
+      end
+
+      context 'when the text is > the pruning width' do
+        context 'with a single line of text' do
+          it { subject.must_equal("Krypton (from Greek: κρυπτός...") }
+        end
+
+        context 'with a text block' do
+          let(:text) { text_block }
+
+          it { subject.must_equal("Krypton (from Greek: κρυπτός...") }
+        end
+
+        context 'with a text block containing newlines' do
+          let(:text) { text_newlines }
+
+          it { subject.must_equal([
+              "Krypton is a colorless, odor...",
+              "It occurs in trace amounts i...",
+              "It is isolated by fractional...",
+              "Krypton is often used with o..."
+            ])
+          }
+        end
+
+        context 'with a text block containing newlines and blank lines' do
+          let(:text) { text_blanklines }
+
+          it { subject.must_equal([
+            "Krypton (from Greek: κρυπτός...",
+            "",
+            "It is a chemical element wit...",
+            "It is a member of group 18 (...",
+            "",
+            "-- Wikipedia..."
+            ])
+          }
+        end
+      end
+    end
+
+    describe '#wrap' do
+      subject { instance.wrap }
+
+      context 'with a single line of text' do
+        let(:text) { text_line }
+
+        it { subject.must_equal([
+            "Krypton (from Greek: κρυπτός",
+            "kryptos 'the hidden one')."
+          ])
+        }
+      end
+
+      context 'with a text block' do
+        let(:text) { text_block }
+
+        it { subject.must_equal([
+          "Krypton (from Greek: κρυπτός",
+          "kryptos 'the hidden one') is",
+          "a chemical element with",
+          "symbol Kr and atomic number",
+          "36. It is a member of group",
+          "18 (noble gases) elements."
+          ])
+        }
+      end
+
+      context 'with a text block containing newlines' do
+        let(:text) { text_newlines }
+
+        it { subject.must_equal([
+          "Krypton is a colorless,",
+          "odorless, tasteless noble",
+          "gas.",
+          "It occurs in trace amounts",
+          "in the atmosphere.",
+          "It is isolated by",
+          "fractionally distilling",
+          "liquefied air.",
+          "Krypton is often used with",
+          "other rare gases in",
+          "fluorescent lamps."
+          ])
+        }
+      end
+
+      context 'with a text block containing newlines and blank lines' do
+        let(:text) { text_blanklines }
+
+        it { subject.must_equal([
+          "Krypton (from Greek: κρυπτός",
+          "kryptos 'the hidden one').",
+          "",
+          "It is a chemical element",
+          "with symbol Kr and atomic",
+          "number 36.",
+          "It is a member of group 18",
+          "(noble gases) elements.",
+          "",
+          "-- Wikipedia"
+          ])
+        }
+      end
+    end
+
+    describe '#as_lines' do
+      subject { instance.as_lines }
+
+      it { subject.must_be_instance_of(Vedeu::Lines) }
+
+      context 'with a single line of text' do
+        let(:text) { text_line }
+
+        it { subject.size.must_equal(1) }
+      end
+
+      context 'with a text block' do
+        let(:text) { text_block }
+
+        it { subject.size.must_equal(1) }
+      end
+
+      context 'with a text block containing newlines' do
+        let(:text) { text_newlines }
+
+        it { subject.size.must_equal(4) }
+      end
+
+      context 'with a text block containing newlines and blank lines' do
+        let(:text) { text_blanklines }
+
+        it { subject.size.must_equal(6) }
+      end
+
+      context 'alias method #prune_as_lines' do
+        subject { instance.prune_as_lines }
+
+        it { subject.must_be_instance_of(Vedeu::Lines) }
+
+        context 'with a single line of text' do
+          let(:text) { text_line }
+
+          it { subject.size.must_equal(1) }
+        end
+
+        context 'with a text block' do
+          let(:text) { text_block }
+
+          it { subject.size.must_equal(1) }
+        end
+
+        context 'with a text block containing newlines' do
+          let(:text) { text_newlines }
+
+          it { subject.size.must_equal(4) }
+        end
+
+        context 'with a text block containing newlines and blank lines' do
+          let(:text) { text_blanklines }
+
+          it { subject.size.must_equal(6) }
+        end
+      end
+
+      context 'alias method #wrap_as_lines' do
+        subject { instance.wrap_as_lines }
+
+        it { subject.must_be_instance_of(Vedeu::Lines) }
+
+        context 'with a single line of text' do
+          let(:text) { text_line }
+
+          it { subject.size.must_equal(2) }
+        end
+
+        context 'with a text block' do
+          let(:text) { text_block }
+
+          it { subject.size.must_equal(6) }
+        end
+
+        context 'with a text block containing newlines' do
+          let(:text) { text_newlines }
+
+          it { subject.size.must_equal(11) }
+        end
+
+        context 'with a text block containing newlines and blank lines' do
+          let(:text) { text_blanklines }
+
+          it { subject.size.must_equal(10) }
+        end
+      end
+    end
+
+  end # Wordwrap
+
+end # Vedeu