vedeu 0.2.9 → 0.2.10

data/lib/vedeu/input/input.rb

@@ -6,6 +6,8 @@ module Vedeu
   # @api private
   class Input
 
+    # Instantiate Input and capture keypress(es).
+    #
     # @return [String|Symbol]
     def self.capture
       new.capture

data/lib/vedeu/models/colour.rb

@@ -41,6 +41,8 @@ module Vedeu
 
     private
 
+    # The default values for a new instance of Colour.
+    #
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/models/event.rb

@@ -134,21 +134,29 @@ module Vedeu
       nil
     end
 
+    # Return the amount of time in seconds to debounce the event by.
+    #
     # @return [Fixnum|Float]
     def debounce
       options[:debounce] || defaults[:debounce]
     end
 
+    # Return the amount of time in seconds to throttle the event by.
+    #
     # @return [Fixnum|Float]
     def delay
       options[:delay] || defaults[:delay]
     end
 
+    # Combines the options provided at instantiation with the default values.
+    #
     # @return [Hash]
     def options
       defaults.merge!(@options)
     end
 
+    # The default values for a new instance of Event.
+    #
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/support/log.rb

@@ -1,137 +1,36 @@
-require 'fileutils'
-require 'time'
-
 module Vedeu
 
-  # Allows the creation of a lock-less log device.
+  # Provides the ability to log anything to the Vedeu log file.
   #
   # @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)
-      @progname = nil
-      @level = DEBUG
-      @default_formatter = Formatter.new
-      @formatter = nil
-      @logdev = nil
-      if logdev
-        @logdev = LocklessLogDevice.new(logdev)
-      end
-    end
+  class Log
 
-    # Ensures we can always write to the log file by creating a lock-less
-    # log device.
-    class LocklessLogDevice < LogDevice
+    class << self
 
-      # @return []
-      def initialize(log = nil)
-        @dev = @filename = @shift_age = @shift_size = nil
-        if log.respond_to?(:write) and log.respond_to?(:close)
-          @dev = log
-        else
-          @dev = open_logfile(log)
-          @dev.sync = true
-          @filename = log
+      # @return [TrueClass]
+      def logger
+        Logger.new(Configuration.log).tap do |log|
+          log.formatter = proc do |_, time, _, message|
+            [timestamp(time.utc.iso8601), message, "\n"].join
+          end
         end
       end
 
-      # @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
 
-      # @return []
-      def open_logfile(filename)
-        if (FileTest.exist?(filename))
-          open(filename, (File::WRONLY | File::APPEND))
-        else
-          create_logfile(filename)
-        end
-      end
+      # Returns a formatted (red, underlined) UTC timestamp,
+      # eg. 2014-10-24T12:34:56Z
+      #
+      # @return [String]
+      def timestamp(utc_time)
+        return '' if @last_seen == utc_time
 
-      # @return []
-      def create_logfile(filename)
-        logdev = open(filename, (File::WRONLY | File::APPEND | File::CREAT))
-        logdev.sync = true
-        add_log_header(logdev)
-        logdev
-      end
+        @last_seen = utc_time
 
-      # @return []
-      def add_log_header(file)
-        file.write(
-          "# Logfile created on %s by %s\n" % [Time.now.to_s, Logger::ProgName]
-        )
+        "\n\e[4m\e[31m" + utc_time + "\e[39m\e[24m\n"
       end
-    end
-
-  end
-
-  # Provides the ability to Log anything to the Vedeu log file which is
-  # hard-coded to reside in `$HOME/.vedeu/vedeu.log`.
-  #
-  # @api private
-  class Log
-
-    # @return [TrueClass]
-    def self.logger
-      @logger ||= MonoLogger.new(filename).tap do |log|
-        log.formatter = proc do |_, time, _, message|
-          utc_time = time.utc.iso8601
-
-          [timestamp(utc_time), message, "\n"].join
-        end
-      end
-    end
-
-    private
-
-    def self.timestamp(utc_time)
-      return "" if @last_seen == utc_time
-
-      @last_seen = utc_time
-
-      "\n\e[4m\e[31m" + utc_time + "\e[39m\e[24m\n"
-    end
-
-    # @return [String]
-    def self.filename
-      @_filename ||= directory + '/vedeu.log'
-    end
-
-    # @return [String]
-    def self.directory
-      FileUtils.mkdir_p(path) unless File.directory?(path)
-
-      path
-    end
 
-    # @return [String]
-    def self.path
-      Dir.home + '/.vedeu'
-    end
+    end # Log eigenclass
 
   end # Log
 

data/lib/vedeu/support/registrar.rb

@@ -6,12 +6,23 @@ module Vedeu
   # @api private
   class Registrar
 
+    REPOSITORIES = [Buffers, Cursors, Focus, Groups, Interfaces, Offsets]
+
     # @param attributes [Hash]
     # @return [TrueClass|MissingRequired]
     def self.record(attributes = {})
       new(attributes).record
     end
 
+    # Removes all entities from all repositories. Use with caution.
+    #
+    # @return [TrueClass]
+    def self.reset!
+      REPOSITORIES.each { |repository| repository.reset }
+
+      true
+    end
+
     # @param attributes [Hash]
     # @return [Registrar]
     def initialize(attributes = {})
@@ -22,9 +33,7 @@ module Vedeu
     #
     # @return [TrueClass|MissingRequired]
     def record
-      [Buffers, Offsets, Interfaces, Cursors, Groups, Focus].map do |repository|
-        repository.add(attributes)
-      end
+      REPOSITORIES.each { |repository| repository.add(attributes) }
 
       true
     end

data/test/lib/vedeu/api/interface_test.rb

@@ -361,7 +361,11 @@ module Vedeu
 
       describe '#x' do
         it 'sets the attribute to the block if a block is given' do
-          skip
+          Vedeu.interface 'iron' do
+            x { 9 }
+          end
+
+          Vedeu.use('iron').geometry.x.must_equal(9)
         end
 
         it 'sets the attribute to the value if a block is not given' do
@@ -375,7 +379,11 @@ module Vedeu
 
       describe '#y' do
         it 'sets the attribute to the block if a block is given' do
-          skip
+          Vedeu.interface 'iron' do
+            y { 6 }
+          end
+
+          Vedeu.use('iron').geometry.y.must_equal(6)
         end
 
         it 'sets the attribute to the value if a block is not given' do

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

@@ -2,12 +2,12 @@ require 'test_helper'
 
 module Vedeu
 
-  module Configuration
+  module Config
 
     describe API do
 
-      before { Configuration.reset }
-      after  { Configuration.reset }
+      before { Configuration.reset! }
+      after  { test_configuration }
 
       describe '.configure' do
         it 'returns the default configuration' do
@@ -15,9 +15,10 @@ module Vedeu
             # ...
           end.must_equal(
             {
-              colour_mode: 16777216,
+              colour_mode: 256,
               debug: false,
               interactive: true,
+              log: '/tmp/vedeu.log',
               once: false,
               system_keys: {
                 exit:        'q',
@@ -208,6 +209,13 @@ module Vedeu
         end
       end
 
+      describe '#log' do
+        it 'sets the options to the desired value' do
+          configuration = Vedeu.configure { log('/tmp/vedeu_api_test.log') }
+          configuration[:log].must_equal('/tmp/vedeu_api_test.log')
+        end
+      end
+
       describe 'redefining system keys' do
         methods_and_keys = {
           exit_key:        :exit,
@@ -245,6 +253,6 @@ module Vedeu
 
     end # API
 
-  end # Configuration
+  end # Config
 
 end # Vedeu

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

@@ -2,89 +2,99 @@ require 'test_helper'
 
 module Vedeu
 
-  module Configuration
+  module Config
 
     describe CLI do
 
-      # describe '#colour_mode' do
-      #   it '--colour-mode' do
-      #     Configuration.configure(['--colour-mode', '16777216'])
-      #     Configuration.colour_mode.must_equal(16777216)
-      #   end
-
-      #   it '--colour-mode' do
-      #     Configuration.configure(['--colour-mode', '256'])
-      #     Configuration.colour_mode.must_equal(256)
-      #   end
-
-      #   it '--colour-mode' do
-      #     Configuration.configure(['--colour-mode', '16'])
-      #     Configuration.colour_mode.must_equal(16)
-      #   end
-
-      #   it '--colour-mode' do
-      #     Configuration.configure(['--colour-mode', '348'])
-      #     Configuration.colour_mode.must_equal(8)
-      #   end
-      # end
-
-      # describe '#debug?' do
-      #   it '--debug' do
-      #     Configuration.configure(['--debug'])
-      #     Configuration.debug?.must_equal(true)
-      #   end
-      # end
-
-      # describe '#interactive?' do
-      #   it '--interactive' do
-      #     Configuration.configure(['--interactive'])
-      #     Configuration.interactive?.must_equal(true)
-      #   end
-
-      #   it '--noninteractive' do
-      #     Configuration.configure(['--noninteractive'])
-      #     Configuration.interactive?.must_equal(false)
-      #   end
-
-      #   it '--standalone' do
-      #     Configuration.configure(['--standalone'])
-      #     Configuration.interactive?.must_equal(false)
-      #   end
-      # end
-
-      # describe '#once?' do
-      #   it '--run-once' do
-      #     Configuration.configure(['--run-once'])
-      #     Configuration.once?.must_equal(true)
-      #   end
-
-      #   it '--run-many' do
-      #     Configuration.configure(['--run-many'])
-      #     Configuration.once?.must_equal(false)
-      #   end
-      # end
-
-      # describe '#terminal_mode' do
-      #   it '--cooked' do
-      #     Configuration.configure(['--cooked'])
-      #     Configuration.terminal_mode.must_equal(:cooked)
-      #   end
-
-      #   it '--raw' do
-      #     Configuration.configure(['--raw'])
-      #     Configuration.terminal_mode.must_equal(:raw)
-      #   end
-      # end
-
-      # describe '#trace?' do
-      #   it '--trace' do
-      #     Configuration.configure(['--trace'])
-      #     Configuration.trace?.must_equal(true)
-      #   end
-      # end
+      before { Configuration.reset! }
+      after  { test_configuration }
+
+      describe '#colour_mode' do
+        it '--colour-mode' do
+          Configuration.configure(['--colour-mode', '16777216'])
+          Configuration.colour_mode.must_equal(16777216)
+        end
+
+        it '--colour-mode' do
+          Configuration.configure(['--colour-mode', '256'])
+          Configuration.colour_mode.must_equal(256)
+        end
+
+        it '--colour-mode' do
+          Configuration.configure(['--colour-mode', '16'])
+          Configuration.colour_mode.must_equal(16)
+        end
+
+        it '--colour-mode' do
+          Configuration.configure(['--colour-mode', '348'])
+          Configuration.colour_mode.must_equal(8)
+        end
+      end
+
+      describe '#debug?' do
+        it '--debug' do
+          Configuration.configure(['--debug'])
+          Configuration.debug?.must_equal(true)
+        end
+      end
+
+      describe '#interactive?' do
+        it '--interactive' do
+          Configuration.configure(['--interactive'])
+          Configuration.interactive?.must_equal(true)
+        end
+
+        it '--noninteractive' do
+          Configuration.configure(['--noninteractive'])
+          Configuration.interactive?.must_equal(false)
+        end
+
+        it '--standalone' do
+          Configuration.configure(['--standalone'])
+          Configuration.interactive?.must_equal(false)
+        end
+      end
+
+      describe '#log' do
+        it '--log' do
+          Configuration.configure(['--log', '/tmp/vedeu_cli_test.log'])
+          Configuration.log.must_equal('/tmp/vedeu_cli_test.log')
+        end
+      end
+
+      describe '#once?' do
+        it '--run-once' do
+          Configuration.configure(['--run-once'])
+          Configuration.once?.must_equal(true)
+        end
+
+        it '--run-many' do
+          Configuration.configure(['--run-many'])
+          Configuration.once?.must_equal(false)
+        end
+      end
+
+      describe '#terminal_mode' do
+        it '--cooked' do
+          Configuration.configure(['--cooked'])
+          Configuration.terminal_mode.must_equal(:cooked)
+        end
+
+        it '--raw' do
+          Configuration.configure(['--raw'])
+          Configuration.terminal_mode.must_equal(:raw)
+        end
+      end
+
+      describe '#trace?' do
+        it '--trace' do
+          Configuration.configure(['--trace'])
+          Configuration.trace?.must_equal(true)
+        end
+      end
 
     end # CLI
 
-  end # Configuration
+  end # Config
 
 end # Vedeu