vedeu 0.4.2 → 0.4.3

data/lib/vedeu/output/viewport.rb

@@ -78,40 +78,41 @@ module Vedeu
     def show
       return [] unless lines?
 
-      line_pad.map { |line| column_pad(line) }.compact
+      padded_lines.map { |line| padded_columns(line) }.compact
     end
 
-    # Pad the number of rows so that we always return an Array of the same
-    # length for each viewport.
+    # Returns the lines, padded where necessary for the viewport.
     #
     # @return [Array<Array<String>>]
-    def line_pad
-      visible_lines = lines[rows] || []
+    def padded_lines
+      visible = lines[rows] || []
 
-      if visible_lines.size < height
-        visible_lines + [" "] * (height - visible_lines.size)
-
-      else
-        visible_lines
-
-      end
+      pad(visible, :height)
     end
 
-    # Pads the number of columns so that we always return an Array of the same
-    # length for each line.
+    # Returns the columns, padded where necessary for the given line.
     #
     # @param line [Array<String>]
     # @return [Array<String>]
-    def column_pad(line)
-      visible_columns = line.chars[columns] || []
+    def padded_columns(line)
+      visible = line.chars[columns] || []
 
-      if visible_columns.size < width
-        visible_columns + [" "] * (width - visible_columns.size)
+      pad(visible, :width)
+    end
 
-      else
-        visible_columns
+    # Pads the number of rows or columns to always return an Array of the same
+    # length for each viewport or line respectively.
+    #
+    # @param visible [Array<Array<String>>|Array<String>]
+    # @param dimension [Symbol] The dimension to pad (:height or :width).
+    # @return [Array<Array<String>>|Array<String>]
+    def pad(visible, dimension)
+      dim  = send(dimension)
+      size = visible.size
 
-      end
+      return visible unless size < dim
+
+      visible + [" "] * (dim - size)
     end
 
     # Using the current cursor's y position, return a range of visible lines.
@@ -119,24 +120,8 @@ module Vedeu
     # Scrolls the content vertically when the stored cursor's y position for the
     # interface is outside of the visible area.
     #
-    # @note
-    #   [value, 0].max # this allows us to set a top that is greater than
-    #                  # the content height.
-    #
-    #   [[value, (content_height - height)].min, 0].max
-    #                  # this does not allow us to have a position
-    #                  # greater than the content height.
-    #
     # @return [Range]
     def rows
-      top = if oy >= bordered_height
-        [(oy - bordered_height), 0].max
-
-      else
-        0
-
-      end
-
       top..(top + (height - 1))
     end
 
@@ -145,27 +130,60 @@ module Vedeu
     # Scrolls the content horizontally when the stored cursor's x position for
     # the interface is outside of the visible area.
     #
-    # @note
-    #   [value, 0].max # this allows us to set a left that is greater
-    #                  # than the content width.
-    #
-    #   [[value, (content_width - width)].min, 0].max
-    #                  # this does not allow us to have a position
-    #                  # greater than the content width.
-    #
     # @return [Range]
     def columns
-      left = if ox >= bordered_width
-        [(ox - bordered_width), 0].max
+      left..(left + (width - 1))
+    end
 
-      else
-        0
+    # Returns the offset for the content based on the offset.
+    #
+    # @return [Fixnum]
+    def left
+      @left ||= reposition_x? ? reposition_x : 0
+    end
 
-      end
+    # Returns the offset for the content based on the offset.
+    #
+    # @return [Fixnum]
+    def top
+      @top ||= reposition_y? ? reposition_y : 0
+    end
 
-      left..(left + (width - 1))
+    # Returns a boolean indicating whether the x offset is greater than or equal
+    # to the bordered width.
+    #
+    # @return [Boolean]
+    def reposition_x?
+      ox >= bordered_width
+    end
+
+    # Returns a boolean indicating whether the y offset is greater than or equal
+    # to the bordered height.
+    #
+    # @return [Boolean]
+    def reposition_y?
+      oy >= bordered_height
     end
 
+    # Returns the number of columns to change the viewport by on the x axis,
+    # determined by the position of the x offset.
+    #
+    # @return [Fixnum]
+    def reposition_x
+      ((ox - bordered_width) <= 0) ? 0 : (ox - bordered_width)
+    end
+
+    # Returns the number of rows to change the viewport by on the y axis,
+    # determined by the position of the y offset.
+    #
+    # @return [Fixnum]
+    def reposition_y
+      ((oy - bordered_height) <= 0) ? 0 : (oy - bordered_height)
+    end
+
+    # When the viewport has a border, we need to account for that in our
+    # redrawing.
+    #
     # @return [Fixnum]
     def bordered_width
       return border.width if border?
@@ -173,6 +191,9 @@ module Vedeu
       width
     end
 
+    # When the viewport has a border, we need to account for that in our
+    # redrawing.
+    #
     # @return [Fixnum]
     def bordered_height
       return border.height if border?
@@ -180,11 +201,15 @@ module Vedeu
       height
     end
 
+    # Return the border associated with the interface we are drawing.
+    #
     # @return [Vedeu::Border]
     def border
       @border ||= Vedeu.borders.find(interface.name)
     end
 
+    # Returns a boolean indicating the interface we are drawing has a border.
+    #
     # @return [Boolean]
     def border?
       Vedeu.borders.registered?(interface.name)

data/lib/vedeu/output/virtual_terminal.rb

@@ -69,9 +69,10 @@ module Vedeu
     def write(y, x, data)
       cy, cx = Vedeu::PositionIndex[y, x]
 
-      return false unless read(y, x).is_a?(Vedeu::Char)
+      return false unless read(cy, cx).is_a?(Vedeu::Char)
 
       cells[cy][cx] = data
+
       true
     end
 

data/lib/vedeu/repositories/all.rb

@@ -43,14 +43,14 @@ module Vedeu
 
   # Allows the storing of events.
   #
-  class Events < Repository
+  class EventsRepository < Repository
 
-    # @return [Vedeu::Events]
+    # @return [Vedeu::EventsRepository]
     def self.events
-      @events ||= Vedeu::Events.new(Vedeu::Model::Collection)
+      @events ||= Vedeu::EventsRepository.new(Vedeu::Events)
     end
 
-  end # Events
+  end # EventsRepository
 
   # Allows the storing of interface/view geometry independent of the interface
   # instance.

data/lib/vedeu/repositories/repository.rb

@@ -11,8 +11,6 @@ module Vedeu
   #
   #   { 'models' => [Model] }
   #
-  # @api private
-  #
   class Repository
 
     include Vedeu::Common

data/lib/vedeu/support/coercions.rb

@@ -4,8 +4,6 @@ module Vedeu
 
   # Provides means to convert attributes into the correct model.
   #
-  # @api private
-  #
   module Coercions
 
     include Vedeu::Common

data/lib/vedeu/support/common.rb

@@ -2,8 +2,6 @@ module Vedeu
 
   # A module for common methods used throughout Vedeu.
   #
-  # @api private
-  #
   module Common
 
     # Returns a boolean indicating whether a variable has a useful value.

data/lib/vedeu/support/esc.rb

@@ -3,8 +3,6 @@ module Vedeu
   # Provides escape sequence strings for setting the cursor position and various
   # display related functions.
   #
-  # @api private
-  #
   module Esc
 
     extend self

data/lib/vedeu/support/log.rb

@@ -2,9 +2,92 @@ require 'vedeu/configuration/configuration'
 
 module Vedeu
 
-  # Provides the ability to log anything to the Vedeu log file.
+  # Allows the creation of a lock-less log device.
   #
-  # @api private
+  class MonoLogger < Logger
+
+    # Create a trappable Logger instance.
+    #
+    # @param logdev [String|IO] The filename (String) or IO object (typically
+    #   STDOUT, STDERR or an open file).
+    # @param shift_age [] Number of old log files to keep, or frequency of
+    #   rotation (daily, weekly, monthly).
+    # @param shift_size [] Maximum log file size (only applies when shift_age
+    #   is a number).
+    #
+    # @example
+    #   Logger.new(name, shift_age = 7, shift_size = 1048576)
+    #   Logger.new(name, shift_age = 'weekly')
+    #
+    def initialize(logdev, shift_age=nil, shift_size=nil)
+      @level = DEBUG
+      @default_formatter = Formatter.new
+      @formatter = nil
+      @logdev = nil
+      if logdev
+        @logdev = LocklessLogDevice.new(logdev)
+      end
+    end
+
+    # Ensures we can always write to the log file by creating a lock-less
+    # log device.
+    class LocklessLogDevice < LogDevice
+
+      # @param log []
+      # @return []
+      def initialize(log = nil)
+        @dev = nil
+        @filename = nil
+        @shift_age = nil
+        @shift_size = nil
+
+        if log.respond_to?(:write) && log.respond_to?(:close)
+          @dev = log
+
+        else
+          @dev = open_logfile(log)
+          @dev.sync = true
+          @filename = log
+
+        end
+      end
+
+      # @param message []
+      # @return []
+      def write(message)
+        @dev.write(message)
+
+      rescue Exception => ignored
+        warn("log writing failed. #{ignored}")
+
+      end
+
+      # @return []
+      def close
+        @dev.close rescue nil
+      end
+
+      private
+
+      # @param filename []
+      # @return []
+      def open_logfile(filename)
+        if (FileTest.exist?(filename))
+          open(filename, (File::WRONLY | File::APPEND))
+
+        else
+          logdev = open(filename, (File::WRONLY | File::APPEND | File::CREAT))
+          logdev.sync = true
+          logdev
+
+        end
+      end
+
+    end # LocklessLogDevice
+
+  end # MonoLogger
+
+  # Provides the ability to log anything to the Vedeu log file.
   #
   class Log
 
@@ -29,7 +112,7 @@ module Vedeu
 
       # @return [TrueClass]
       def logger
-        Logger.new(log_file).tap do |log|
+        MonoLogger.new(log_file).tap do |log|
           log.formatter = proc do |_, time, _, message|
             formatted_message(message, time)
           end

data/lib/vedeu/support/refresh.rb

@@ -2,8 +2,6 @@ module Vedeu
 
   # Refreshes the terminal.
   #
-  # @api private
-  #
   module Refresh
 
     extend self

data/lib/vedeu/support/sentence.rb

@@ -8,15 +8,11 @@ module Vedeu
   #
   class Sentence
 
-    class << self
-
-      # @param elements [Array]
-      # @param label [String]
-      # @return [String]
-      def construct(elements, label = 'elements')
-        new(elements, label).construct
-      end
-
+    # @param elements [Array]
+    # @param label [String]
+    # @return [String]
+    def self.construct(elements, label = 'elements')
+      new(elements, label).construct
     end
 
     # @param elements [Array]

data/lib/vedeu/support/terminal.rb

@@ -7,8 +7,6 @@ module Vedeu
   # This module is the direct interface between Vedeu and your terminal/
   # console, via Ruby's IO core library.
   #
-  # @api private
-  #
   module Terminal
 
     extend self

data/lib/vedeu/support/trace.rb

@@ -9,8 +9,6 @@ module Vedeu
   # this will make your application less responsive, and the tests
   # excruciatingly slow to run.
   #
-  # @api private
-  #
   class Trace
 
     # @todo

data/lib/vedeu/support/visible.rb

@@ -6,7 +6,7 @@ module Vedeu
   #
   class Visible
 
-    # @param visible [Boolean|Symbol]
+    # @param value [Boolean|Symbol]
     # @return [Visible]
     def self.coerce(value)
       if value.is_a?(self)

data/test/lib/vedeu/configuration/api_test.rb

@@ -6,9 +6,23 @@ module Vedeu
 
     describe API do
 
+      let(:described) { Vedeu::Config::API }
+      let(:instance)  { described.new }
+
       before { Configuration.reset! }
       after  { test_configuration }
 
+      describe 'alias_methods' do
+        it { instance.must_respond_to(:interactive) }
+        it { instance.must_respond_to(:standalone) }
+        it { instance.must_respond_to(:run_once) }
+        it { instance.must_respond_to(:drb) }
+        it { instance.must_respond_to(:cooked) }
+        it { instance.must_respond_to(:raw) }
+        it { instance.must_respond_to(:debug) }
+        it { instance.must_respond_to(:trace) }
+      end
+
       describe '.configure' do
         it 'returns the configuration singleton' do
           Vedeu.configure do