vedeu 0.4.40 → 0.4.41

data/lib/vedeu/output/render_border.rb

@@ -0,0 +1,230 @@
+module Vedeu
+
+  class RenderBorder
+
+    extend Forwardable
+    include Vedeu::Common
+
+    def_delegators :border,
+                   :bottom?,
+                   :bottom_left,
+                   :bottom_right,
+                   :bx,
+                   :bxn,
+                   :by,
+                   :byn,
+                   :colour,
+                   :enabled?,
+                   :height,
+                   :horizontal,
+                   :left?,
+                   :name,
+                   :right?,
+                   :style,
+                   :title,
+                   :top?,
+                   :top_left,
+                   :top_right,
+                   :width,
+                   :vertical
+
+    def_delegators :geometry,
+                   :x,
+                   :xn,
+                   :y,
+                   :yn
+
+    def_delegators :interface,
+                   :visible?
+
+    # @return [Array<Array<Vedeu::Char>>]
+    # @see Vedeu::RenderBorder#initialize
+    def self.with(border)
+      new(border).render
+    end
+
+    # Returns a new instance of Vedeu::RenderBorder.
+    #
+    # @param border [Vedeu::Border]
+    # @return [Vedeu::Renderers::Border]
+    def initialize(border)
+      @border = border
+    end
+
+    # @return [Array<Array<Vedeu::Char>>]
+    def render
+      return [] unless visible?
+      return [] unless enabled?
+
+      Vedeu.timer("Rendering border: #{name}") do
+        out = [top, bottom]
+
+        height.times do |y|
+          out << [left(y), right(y)]
+        end
+
+        out.flatten
+      end
+    end
+
+    protected
+
+    # @!attribute [r] border
+    # @return [Vedeu::Border]
+    attr_reader :border
+
+    private
+
+    # @param value [String]
+    # @param type [Symbol|NilClass]
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @return [Vedeu::Char]
+    def build(value, type = :border, iy = 0, ix = 0)
+      Vedeu::Char.new(value:    value,
+                      parent:   interface,
+                      colour:   colour,
+                      style:    style,
+                      position: Vedeu::Position[iy, ix],
+                      border:   type)
+    end
+
+    # Renders the bottom border for the interface.
+    #
+    # @return [String]
+    def bottom
+      return [] unless bottom?
+
+      out = []
+      out << build(bottom_left, :bottom_left, *[yn, x]) if left?
+      out << horizontal_border(:bottom_horizontal, yn)
+      out << build(bottom_right, :bottom_right, *[yn, xn]) if right?
+      out
+    end
+
+    # @return [Vedeu::Geometry]
+    def geometry
+      Vedeu.geometries.by_name(name)
+    end
+
+    # @param position [Symbol] Either :top_horizontal, or :bottom_horizontal.
+    # @return [Array<Vedeu::Char>]
+    def horizontal_border(position, y_coordinate)
+      width.times.each_with_object([]) do |ix, a|
+        a << build(horizontal, position, *[y_coordinate, (bx + ix)])
+      end
+    end
+
+    # The parent of a border is always an interface.
+    #
+    # @return [Vedeu::Interface]
+    def interface
+      @interface ||= Vedeu.interfaces.by_name(name)
+    end
+    alias_method :parent, :interface
+
+    # Renders the left border for the interface.
+    #
+    # @param iy [Fixnum]
+    # @return [String]
+    def left(iy = 0)
+      return [] unless left?
+
+      build(vertical, :left_vertical, *[(by + iy), x])
+    end
+
+    # Pads the title with a single whitespace either side.
+    #
+    # @example
+    #   title = 'Truncated!'
+    #   width = 20
+    #   # => ' Truncated! '
+    #
+    #   width = 10
+    #   # => ' Trunca '
+    #
+    # @return [String]
+    # @see #truncated_title
+    def padded_title
+      truncated_title.center(truncated_title.size + 2)
+    end
+
+    # Renders the right border for the interface.
+    #
+    # @param iy [Fixnum]
+    # @return [String]
+    def right(iy = 0)
+      return [] unless right?
+
+      build(vertical, :right_vertical, *[(by + iy), xn])
+    end
+
+    # Return boolean indicating whether this border has a non-empty title.
+    #
+    # @return [Boolean]
+    def title?
+      present?(title)
+    end
+
+    # From the second element of {#title_characters} remove the border from each
+    # {#horizontal_border} Vedeu::Char, and add the title character.
+    #
+    # @return [Array<Vedeu::Char>]
+    def titlebar
+      horizontal_border(:top_horizontal, y).each_with_index do |char, index|
+        if index >= 1 && index <= title_characters.size
+          char.border = nil
+          char.value  = title_characters[(index - 1)]
+        end
+      end
+    end
+
+    # @return [Array<String>]
+    def title_characters
+      @title_characters ||= padded_title.chars
+    end
+
+    # Renders the top border for the interface.
+    #
+    # @note
+    #   If a title has been specified, then the top border will include this
+    #   title unless the size of the interface is smaller than the padded title
+    #   length.
+    #
+    # @return [String]
+    def top
+      return [] unless top?
+
+      out = []
+      out << build(top_left, :top_left, *[y, x]) if left?
+      if title? && width > title_characters.size
+        out << titlebar
+
+      else
+        out << horizontal_border(:top_horizontal, y)
+
+      end
+      out << build(top_right, :top_right, *[y, xn]) if right?
+      out
+    end
+
+    # Truncates the title to the width of the interface, minus characters needed
+    # to ensure there is at least a single character of horizontal border and a
+    # whitespace on either side of the title.
+    #
+    # @example
+    #   title = 'Truncated!'
+    #   width = 20
+    #   # => 'Truncated!'
+    #
+    #   width = 10
+    #   # => 'Trunca'
+    #
+    # @return [String]
+    def truncated_title
+      title.chomp.slice(0..(width - 5))
+    end
+
+  end # RenderBorder
+
+end # Vedeu

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

@@ -13,6 +13,8 @@ module Vedeu
         new(output).render
       end
 
+      # Returns a new instance of Vedeu::Renderers::EscapeSequence.
+      #
       # @param output [Array<Array<Vedeu::Char>>]
       def initialize(output)
         @output = output
@@ -20,9 +22,6 @@ module Vedeu
 
       # @return [String]
       def render
-        Vedeu.log(type:    :debug,
-                  message: "#{self.class.name}:\n#{parsed}")
-
         parsed
       end
 

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

@@ -2,24 +2,24 @@ module Vedeu
 
   module Renderers
 
-    # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-    # and content suitable for a terminal, and writes them to a file in the /tmp
-    # directory.
+    # Writes the given output to a file.
     #
     # @api private
     class File
 
-      # @param output [Array<Array<Vedeu::Char>>]
-      # @param options [Hash]
       # @return [String]
+      # @see Vedeu::Renderers::File#initialize
       def self.render(output, options = {})
         new(output, options).render
       end
 
       # Returns a new instance of Vedeu::Renderers::File.
       #
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [String]
       # @param options [Hash]
+      # @option options filename [String] Provide a filename for the output.
+      #   Defaults to 'out'.
+      # @option options timestamp [Boolean] Append a timestamp to the filename.
       # @return [Vedeu::Renderers::File]
       def initialize(output, options = {})
         @output  = output
@@ -36,7 +36,7 @@ module Vedeu
       protected
 
       # @!attribute [r] output
-      # @return [Array<Array<Vedeu::Char>>]
+      # @return [String]
       attr_reader :output
       alias_method :parsed, :output
 
@@ -50,10 +50,10 @@ module Vedeu
       # @return [String]
       def filename
         if timestamp?
-          "out_#{timestamp}"
+          "#{options[:filename]}_#{timestamp}"
 
         else
-          'out'
+          options[:filename]
 
         end
       end
@@ -78,6 +78,7 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
+          filename:  'out',
           timestamp: false,
         }
       end

data/lib/vedeu/repositories/collections/all.rb

@@ -12,16 +12,16 @@ module Vedeu
   # A collection of {Vedeu::Event} instances.
   #
   # @api private
-  class Events < Vedeu::Collection
+  class EventCollection < Vedeu::Collection
 
-  end # Events
+  end # EventCollection
 
   # A collection of {Vedeu::Interface} instances.
   #
   # @api private
-  class Interfaces < Vedeu::Collection
+  class InterfaceCollection < Vedeu::Collection
 
-  end # Interfaces
+  end # InterfaceCollection
 
   # A collection of {Vedeu::Key} instances.
   #

data/lib/vedeu/repositories/repositories/all.rb

@@ -1,14 +1,14 @@
 require 'vedeu/repositories/repository'
 
 require_relative 'colours'
-require_relative 'background_colours'
-require_relative 'foreground_colours'
+require_relative 'backgrounds'
+require_relative 'foregrounds'
 require_relative 'borders'
 require_relative 'buffers'
 require_relative 'cursors'
-require_relative 'events_repository'
+require_relative 'events'
 require_relative 'geometries'
 require_relative 'groups'
-require_relative 'interfaces_repository'
+require_relative 'interfaces'
 require_relative 'keymaps'
 require_relative 'menus'

data/lib/vedeu/repositories/repositories/{background_colours.rb → backgrounds.rb}

@@ -3,16 +3,16 @@ module Vedeu
   # Store background colour escape sequences by HTML/CSS code.
   #
   # @api public
-  class BackgroundColours < Colours
+  class Backgrounds < Colours
 
     # @example
     #   Vedeu.background_colours
     #
-    # @return [Vedeu::BackgroundColours]
+    # @return [Vedeu::Backgrounds]
     def self.background_colours
       @background_colours ||= new
     end
 
-  end # BackgroundColours
+  end # Backgrounds
 
 end # Vedeu

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -45,6 +45,9 @@ module Vedeu
       elsif name
         Vedeu::Cursor.new(name: name).store
 
+      else
+        Vedeu::Cursor.new(name: Vedeu.focus).store
+
       end
     end
 

data/lib/vedeu/repositories/repositories/{events_repository.rb → events.rb}

@@ -3,14 +3,14 @@ module Vedeu
   # Allows the storing of events.
   #
   # @api public
-  class EventsRepository < Repository
+  class Events < Repository
 
     class << self
 
       # @example
       #   Vedeu.events
       #
-      # @return [Vedeu::EventsRepository]
+      # @return [Vedeu::Events]
       alias_method :events, :repository
 
       # Remove all stored models from the repository.
@@ -18,13 +18,13 @@ module Vedeu
       # @example
       #   Vedeu.events.reset
       #
-      # @return [Vedeu::EventsRepository]
+      # @return [Vedeu::Events]
       def reset!
-        @events = new(Vedeu::Events)
+        @events = new(Vedeu::EventCollection)
       end
 
     end
 
-  end # EventsRepository
+  end # Events
 
 end # Vedeu

data/lib/vedeu/repositories/repositories/{foreground_colours.rb → foregrounds.rb}

@@ -3,16 +3,16 @@ module Vedeu
   # Store foreground colour escape sequences by HTML/CSS code.
   #
   # @api public
-  class ForegroundColours < Colours
+  class Foregrounds < Colours
 
     # @example
     #   Vedeu.foreground_colours
     #
-    # @return [Vedeu::ForegroundColours]
+    # @return [Vedeu::Foregrounds]
     def self.foreground_colours
       @foreground_colours ||= new
     end
 
-  end # ForegroundColours
+  end # Foregrounds
 
 end # Vedeu

data/lib/vedeu/repositories/repositories/{interfaces_repository.rb → interfaces.rb}

@@ -3,14 +3,14 @@ module Vedeu
   # Allows the storing of interfaces and views.
   #
   # @api public
-  class InterfacesRepository < Repository
+  class Interfaces < Repository
 
     class << self
 
       # @example
       #   Vedeu.interfaces
       #
-      # @return [Vedeu::InterfacesRepository]
+      # @return [Vedeu::Interfaces]
       alias_method :interfaces, :repository
 
       # Remove all stored models from the repository.
@@ -18,7 +18,7 @@ module Vedeu
       # @example
       #   Vedeu.interfaces.reset!
       #
-      # @return [Vedeu::InterfacesRepository]
+      # @return [Vedeu::Interfaces]
       def reset!
         @interfaces = register(Vedeu::Interface)
       end
@@ -39,6 +39,6 @@ module Vedeu
       all.sort { |a, b| a.zindex <=> b.zindex }
     end
 
-  end # InterfacesRepository
+  end # Interfaces
 
 end # Vedeu

data/lib/vedeu/storage/associative_store.rb

@@ -9,6 +9,8 @@ module Vedeu
 
     include Vedeu::Store
 
+    # Returns a new instance of Vedeu::AssociativeStore.
+    #
     # @param storage [Hash]
     # @return [Vedeu::AssociativeStore]
     def initialize(storage = {})

data/lib/vedeu/storage/conveyor_store.rb

@@ -8,6 +8,8 @@ module Vedeu
 
     include Vedeu::Store
 
+    # Returns a new instance of Vedeu::ConveyorStore.
+    #
     # @param storage [Array]
     # @return [Vedeu::ConveyorStore]
     def initialize(storage = [])

data/lib/vedeu/storage/fifo_store.rb

@@ -9,6 +9,8 @@ module Vedeu
 
     include Vedeu::Store
 
+    # Returns a new instance of Vedeu::FifoStore.
+    #
     # @param storage [Array]
     # @return [Vedeu::FifoStore]
     def initialize(storage = [])

data/lib/vedeu/storage/store.rb

@@ -13,6 +13,13 @@ module Vedeu
       storage.each(&block)
     end
 
+    # Return a boolean indicating whether the storage is empty.
+    #
+    # @return [Boolean]
+    def empty?
+      storage.empty?
+    end
+
     # Returns a boolean indicating whether the named model is registered.
     #
     # @param name [String]
@@ -24,13 +31,6 @@ module Vedeu
     end
     alias_method :registered?, :exists?
 
-    # Return a boolean indicating whether the storage is empty.
-    #
-    # @return [Boolean]
-    def empty?
-      storage.empty?
-    end
-
     # Remove all currently stored data.
     #
     # @return [Array|Hash|Set]

data/lib/vedeu/support/options.rb

@@ -17,6 +17,8 @@ module Vedeu
       new(options)._build
     end
 
+    # Returns a new instance of Vedeu::Options.
+    #
     # @param options [Hash]
     # @return [Vedeu::Options]
     def initialize(options = {})

data/lib/vedeu/support/terminal.rb

@@ -39,14 +39,14 @@ module Vedeu
       keys_or_cmd = if raw_mode?
                       keys = console.getch
 
-                      if keys.ord == 27
+                      if keys.ord == 27 # \e
                         begin
-                          keys << console.read_nonblock(3)
+                          keys << console.read_nonblock(5)
                         rescue
                           nil
                         end
                         begin
-                          keys << console.read_nonblock(2)
+                          keys << console.read_nonblock(4)
                         rescue
                           nil
                         end

data/lib/vedeu/support/timer.rb

@@ -21,6 +21,8 @@ module Vedeu
 
     end
 
+    # Returns a new instance of Vedeu::Timer.
+    #
     # @param message [String]
     # @return [Vedeu::Timer]
     def initialize(message = '')

data/lib/vedeu/support/visibility.rb

@@ -31,6 +31,8 @@ module Vedeu
       new(model).toggle
     end
 
+    # Returns a new instance of Vedeu::Visibility.
+    #
     # @param model [void]
     # @return [Vedeu::Visibility]
     def initialize(model)

data/lib/vedeu/templating/directive.rb

@@ -15,6 +15,8 @@ module Vedeu
         new(code).process
       end
 
+      # Returns a new instance of Vedeu::Templating::Directive.
+      #
       # @param code [String]
       # @return [Vedeu::Templating::Directive]
       def initialize(code)

data/lib/vedeu/templating/preprocessor.rb

@@ -24,6 +24,8 @@ module Vedeu
         new(lines).process
       end
 
+      # Returns a new instance of Vedeu::Templating::Preprocessor.
+      #
       # @param lines [Array<String>]
       # @return [Vedeu::Templating::Preprocessor]
       def initialize(lines)

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.4.40'
+  VERSION = '0.4.41'
 
 end

data/lib/vedeu.rb

@@ -36,7 +36,9 @@ module Vedeu
   # @example
   #   class YourClassHere
   #     include Vedeu
-  #     ...
+  #
+  #     # ...
+  #   end
   #
   # @param receiver []
   # @return [void]

data/test/lib/vedeu/bindings_test.rb

@@ -25,6 +25,8 @@ module Vedeu
     context 'the cursor specific events are defined' do
       it { Vedeu.events.registered?(:_cursor_hide_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_show_).must_equal(true) }
+      it { Vedeu.events.registered?(:_hide_cursor_).must_equal(true) }
+      it { Vedeu.events.registered?(:_show_cursor_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_down_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_left_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_right_).must_equal(true) }
@@ -35,6 +37,15 @@ module Vedeu
       it { Vedeu.events.registered?(:_cursor_reset_).must_equal(true) }
     end
 
+    context 'the geometry specific events are defined' do
+      it { Vedeu.events.registered?(:_geometry_down_).must_equal(true) }
+      it { Vedeu.events.registered?(:_geometry_left_).must_equal(true) }
+      it { Vedeu.events.registered?(:_geometry_right_).must_equal(true) }
+      it { Vedeu.events.registered?(:_geometry_up_).must_equal(true) }
+      it { Vedeu.events.registered?(:_maximise_).must_equal(true) }
+      it { Vedeu.events.registered?(:_unmaximise_).must_equal(true) }
+    end
+
     context 'the drb specific events are defined' do
       it { Vedeu.events.registered?(:_drb_input_).must_equal(true) }
       it { Vedeu.events.registered?(:_drb_retrieve_output_).must_equal(true) }
@@ -68,6 +79,10 @@ module Vedeu
       it { Vedeu.events.registered?(:_refresh_).must_equal(true) }
     end
 
+    it { Vedeu.events.registered?(:_hide_interface_).must_equal(true) }
+    it { Vedeu.events.registered?(:_show_interface_).must_equal(true) }
+    it { Vedeu.events.registered?(:_toggle_interface_).must_equal(true) }
+
   end # Bindings
 
 end # Vedeu

data/test/lib/vedeu/buffers/buffer_test.rb

@@ -198,6 +198,18 @@ module Vedeu
       end
     end
 
+    describe '#toggle' do
+      subject { instance.toggle }
+
+      context 'when the interface is visible' do
+        # it { skip }
+      end
+
+      context 'when the interface is not visible' do
+        # it { skip }
+      end
+    end
+
     describe '#render' do
       before { Vedeu::Output.stubs(:render) }