vedeu 0.4.25 → 0.4.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb6dc29e78bc70eab80c780ef16626cddbdcdf0b
-  data.tar.gz: e83efc8abd484c8436ae562fd393bfb745706475
+  metadata.gz: 2bba3e9391ad8c7f14484b09adc03826c64cdff5
+  data.tar.gz: 166ea2c63e70165ec7a7b33902e8946d7f14c3b5
 SHA512:
-  metadata.gz: fe72d64a341a1447e93f85ffcc7213d3e598ad682ab912689be1c3a0b825c82c9dcaa4402513a9b738f0f9b43b18257d8d161ef384573248588c1690a40d2e4f
-  data.tar.gz: 183b719c6624c17c606fc29a3d163cd2b6ded9138a9943c032292f50a0155c8c47abc2474cfcd0da284a506c0830d48761cbcf18e679808b9daae2aaa17458db
+  metadata.gz: b18d838e63f6d47ed70ad102e5db5157bbebebbf34faf0acdcc7cbdc34cfbf13348ee2d24cb3e765d478d1f7076290c5053c1092f60d1087bf8093c97d42b603
+  data.tar.gz: c10f07257a95dde84f961448fe4ba6d07a2539235258be5163792eeb1c345af2052786d2e006a1dd54f3452cf931aa10faf037e9fd559ef7073803186e98c393

data/lib/vedeu.rb

@@ -81,8 +81,3 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/all'
-
-require 'vedeu/support/trace'
-Vedeu::Trace.call
-# force tracing
-# Vedeu::Trace.call({ trace: true })

data/lib/vedeu/output/border.rb

@@ -361,16 +361,17 @@ module Vedeu
     # @param ix [Fixnum]
     # @return [Vedeu::Position]
     def position(name, iy = 0, ix = 0)
-      case name
-      when :top_horizontal    then Vedeu::Position.coerce([y, (bx + ix)])
-      when :bottom_horizontal then Vedeu::Position.coerce([yn, (bx + ix)])
-      when :left_vertical     then Vedeu::Position.coerce([(by + iy), x])
-      when :right_vertical    then Vedeu::Position.coerce([(by + iy), xn])
-      when :bottom_left       then Vedeu::Position.coerce([yn, x])
-      when :bottom_right      then Vedeu::Position.coerce([yn, xn])
-      when :top_left          then Vedeu::Position.coerce([y, x])
-      when :top_right         then Vedeu::Position.coerce([y, xn])
-      end
+      coords = case name
+               when :top_horizontal    then [y, (bx + ix)]
+               when :bottom_horizontal then [yn, (bx + ix)]
+               when :left_vertical     then [(by + iy), x]
+               when :right_vertical    then [(by + iy), xn]
+               when :bottom_left       then [yn, x]
+               when :bottom_right      then [yn, xn]
+               when :top_left          then [y, x]
+               when :top_right         then [y, xn]
+               end
+      Vedeu::Position.coerce(coords)
     end
 
   end # Border

data/lib/vedeu/output/presentation.rb

@@ -8,13 +8,13 @@ module Vedeu
     # @return [Vedeu::Background]
     def background
       @background ||= if colour
-        colour.background
+                        colour.background
 
-      else
-        Vedeu::Background.new
-        # @todo: Should this be: parent_background
+                      else
+                        Vedeu::Background.new
+                        # @todo: Should this be: parent_background
 
-      end
+                      end
     end
 
     # @return [Vedeu::Background]
@@ -37,13 +37,13 @@ module Vedeu
     # @return [Vedeu::Foreground]
     def foreground
       @foreground ||= if colour
-        colour.foreground
+                        colour.foreground
 
-      else
-        Vedeu::Foreground.new
-        # @todo: Should this be: parent_foreground
+                      else
+                        Vedeu::Foreground.new
+                        # @todo: Should this be: parent_foreground
 
-      end
+                      end
     end
 
     # @return [Vedeu::Foreground]

data/lib/vedeu/repositories/registerable.rb

@@ -34,6 +34,18 @@ module Vedeu
         end
       end
 
+      # Returns the repositories registered.
+      #
+      # @note
+      #   If the repository is 'Geometries', for example, then @models will be
+      #   either an empty Geometries repository or the collection of stored
+      #   models.
+      #
+      # @return [void]
+      def repository
+        @models ||= reset!
+      end
+
     end # ClassMethods
 
     # When this module is included in a class, provide ClassMethods as class

data/lib/vedeu/repositories/repositories/borders.rb

@@ -7,10 +7,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Borders]
-      def borders
-        @borders ||= reset!
-      end
-      alias_method :repository, :borders
+      alias_method :borders, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Buffers]
-      def buffers
-        @buffers ||= reset!
-      end
-      alias_method :repository, :buffers
+      alias_method :buffers, :repository
 
       # Remove all stored models from the repository.
       #

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

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Cursors]
-      def cursors
-        @cursors ||= reset!
-      end
-      alias_method :repository, :cursors
+      alias_method :cursors, :repository
 
       # @return [Vedeu::Cursor]
       def cursor

data/lib/vedeu/repositories/repositories/events_repository.rb

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::EventsRepository]
-      def events
-        @events ||= reset!
-      end
-      alias_method :repository, :events
+      alias_method :events, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -7,10 +7,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Geometries]
-      def geometries
-        @geometries ||= reset!
-      end
-      alias_method :repository, :geometries
+      alias_method :geometries, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/repositories/repositories/groups.rb

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Groups]
-      def groups
-        @groups ||= reset!
-      end
-      alias_method :repository, :groups
+      alias_method :groups, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/repositories/repositories/interfaces_repository.rb

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::InterfacesRepository]
-      def interfaces
-        @interfaces ||= reset!
-      end
-      alias_method :repository, :interfaces
+      alias_method :interfaces, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/repositories/repositories/keymaps.rb

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Keymaps]
-      def keymaps
-        @keymaps ||= reset!
-      end
-      alias_method :repository, :keymaps
+      alias_method :keymaps, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/repositories/repositories/menus.rb

@@ -6,10 +6,7 @@ module Vedeu
     class << self
 
       # @return [Vedeu::Menus]
-      def menus
-        @menus ||= reset!
-      end
-      alias_method :repository, :menus
+      alias_method :menus, :repository
 
       # Remove all stored models from the repository.
       #

data/lib/vedeu/support/all.rb

@@ -3,5 +3,4 @@ require_relative 'options'
 require_relative 'template'
 require_relative 'terminal'
 require_relative 'timer'
-require_relative 'trace'
 require_relative 'visibility'

data/test/lib/vedeu/api_test.rb

@@ -18,7 +18,7 @@ module Vedeu
         describe '.borders' do
           subject { Vedeu.borders }
 
-          # it { subject.must_be_instance_of(Vedeu::Borders) }
+          it { subject.must_be_instance_of(Vedeu::Borders) }
         end
       end
 
@@ -26,7 +26,7 @@ module Vedeu
         describe '.buffers' do
           subject { Vedeu.buffers }
 
-          # it { subject.must_be_instance_of(Vedeu::Buffers) }
+          it { subject.must_be_instance_of(Vedeu::Buffers) }
         end
       end
 
@@ -34,7 +34,7 @@ module Vedeu
         describe '.canvas' do
           subject { Vedeu.canvas }
 
-          # it { subject.must_be_instance_of(Vedeu::Canvas) }
+          it { subject.must_be_instance_of(Vedeu::Canvas) }
         end
       end
 
@@ -48,7 +48,7 @@ module Vedeu
         describe '.configuration' do
           subject { Vedeu.configuration }
 
-          # it { subject.must_be_instance_of(Vedeu::Configuration) }
+          it { subject.must_be_instance_of(Vedeu::Configuration) }
         end
       end
 
@@ -66,7 +66,7 @@ module Vedeu
         describe '.cursors' do
           subject { Vedeu.cursors }
 
-          # it { subject.must_be_instance_of(Vedeu::Cursors) }
+          it { subject.must_be_instance_of(Vedeu::Cursors) }
         end
       end
 
@@ -152,7 +152,7 @@ module Vedeu
         describe '.events' do
           subject { Vedeu.events }
 
-          # it { subject.must_be_instance_of(Vedeu::EventsRepository) }
+          it { subject.must_be_instance_of(Vedeu::EventsRepository) }
         end
       end
 
@@ -204,7 +204,7 @@ module Vedeu
         describe '.geometries' do
           subject { Vedeu.geometries }
 
-          # it { subject.must_be_instance_of(Vedeu::Geometries) }
+          it { subject.must_be_instance_of(Vedeu::Geometries) }
         end
       end
 
@@ -212,7 +212,7 @@ module Vedeu
         describe '.groups' do
           subject { Vedeu.groups }
 
-          # it { subject.must_be_instance_of(Vedeu::Groups) }
+          it { subject.must_be_instance_of(Vedeu::Groups) }
         end
       end
 
@@ -220,7 +220,7 @@ module Vedeu
         describe '.interfaces' do
           subject { Vedeu.interfaces }
 
-          # it { subject.must_be_instance_of(Vedeu::InterfacesRepository) }
+          it { subject.must_be_instance_of(Vedeu::InterfacesRepository) }
         end
       end
 
@@ -228,7 +228,7 @@ module Vedeu
         describe '.keymaps' do
           subject { Vedeu.keymaps }
 
-          # it { subject.must_be_instance_of(Vedeu::Keymaps) }
+          it { subject.must_be_instance_of(Vedeu::Keymaps) }
         end
       end
 
@@ -260,7 +260,7 @@ module Vedeu
         describe '.menus' do
           subject { Vedeu.menus }
 
-          # it { subject.must_be_instance_of(Vedeu::Menus) }
+          it { subject.must_be_instance_of(Vedeu::Menus) }
         end
       end
 

data/test/lib/vedeu/repositories/repositories/borders_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::Borders }
 
-    describe '.borders' do
-      subject { described.borders }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
     describe '#by_name' do
       let(:_name) { 'carbon' }
 

data/test/lib/vedeu/repositories/repositories/buffers_test.rb

@@ -7,12 +7,6 @@ module Vedeu
     let(:described) { Vedeu::Buffers }
     let(:instance)  { described.buffers }
 
-    describe '.buffers' do
-      subject { instance }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
     describe '#by_name' do
       let(:_name) { 'carbon' }
 

data/test/lib/vedeu/repositories/repositories/cursors_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::Cursors }
 
-    describe '.cursors' do
-      subject { described.cursors }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
     describe '.cursor' do
       subject { Vedeu.cursor }
 

data/test/lib/vedeu/repositories/repositories/events_repository_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::EventsRepository }
 
-    describe '.events' do
-      subject { described.events }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
   end # EventsRepository
 
 end # Vedeu

data/test/lib/vedeu/repositories/repositories/geometries_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::Geometries }
 
-    describe '.geometries' do
-      subject { described.geometries }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
     describe '#by_name' do
       let(:_name) { 'carbon' }
 

data/test/lib/vedeu/repositories/repositories/groups_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::Groups }
 
-    describe '.groups' do
-      subject { described.groups }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
     describe '#by_name' do
       let(:_name) { 'carbon' }
 

data/test/lib/vedeu/repositories/repositories/interfaces_repositories_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::InterfacesRepository }
 
-    describe '.interfaces' do
-      subject { described.interfaces }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
   end # InterfacesRepository
 
 end # Vedeu

data/test/lib/vedeu/repositories/repositories/keymaps_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::Keymaps }
 
-    describe '.keymaps' do
-      subject { described.keymaps }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
   end # Keymaps
 
 end # Vedeu

data/test/lib/vedeu/repositories/repositories/menus_test.rb

@@ -6,12 +6,6 @@ module Vedeu
 
     let(:described) { Vedeu::Menus }
 
-    describe '.menus' do
-      subject { described.menus }
-
-      it { subject.must_be_instance_of(described) }
-    end
-
   end # Menus
 
 end # Vedeu

data/test/test_helper.rb

@@ -47,10 +47,6 @@ require 'support/helpers/model_test_class'
 #  # Minitest::Reporters::SpecReporter.new
 # )
 
-# trace method execution with (optionally) local variables
-# require 'vedeu/support/log'
-# Vedeu::Trace.call({ watched: 'call', klass: /^Vedeu/ })
-
 def test_configuration
   Vedeu::Configuration.reset!
 

data/vedeu.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'vedeu'
-  spec.version       = '0.4.25'
+  spec.version       = '0.4.26'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = 'A terminal case of wonderland.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.25
+  version: 0.4.26
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -431,7 +431,6 @@ files:
 - lib/vedeu/support/template.rb
 - lib/vedeu/support/terminal.rb
 - lib/vedeu/support/timer.rb
-- lib/vedeu/support/trace.rb
 - lib/vedeu/support/visibility.rb
 - lib/vedeu/traps.rb
 - logs/.gitkeep
@@ -550,7 +549,6 @@ files:
 - test/lib/vedeu/support/options_test.rb
 - test/lib/vedeu/support/template_test.rb
 - test/lib/vedeu/support/terminal_test.rb
-- test/lib/vedeu/support/trace_test.rb
 - test/lib/vedeu/support/visibility_test.rb
 - test/lib/vedeu/traps_test.rb
 - test/lib/vedeu_test.rb
@@ -701,7 +699,6 @@ test_files:
 - test/lib/vedeu/support/options_test.rb
 - test/lib/vedeu/support/template_test.rb
 - test/lib/vedeu/support/terminal_test.rb
-- test/lib/vedeu/support/trace_test.rb
 - test/lib/vedeu/support/visibility_test.rb
 - test/lib/vedeu/traps_test.rb
 - test/lib/vedeu_test.rb

data/lib/vedeu/support/trace.rb

@@ -1,197 +0,0 @@
-module Vedeu
-
-  # :nocov:
-  # This class currently provides the means to trace each method call which
-  # occurs inside Vedeu. This is very useful (to me!) for debugging. Running
-  # this will make your application less responsive, and the tests
-  # excruciatingly slow to run.
-  class Trace
-
-    # @todo
-    #   Replace this class with this:
-    #
-    # def self.trace
-    #   trace = TracePoint.new(:call) do |tp|
-    #     if tp.defined_class.to_s.match(/Troo/)
-    #       Vedeu.log(type: :debug,
-    #                 message: [tp.defined_class.to_s,
-    #                           tp.method_id.to_s].join(' '))
-    #     end
-    #   end
-    #   trace.enable
-    # end
-
-    # @param options [Hash]
-    # @option option event [Symbol]
-    # @option option trace [Boolean]
-    # @return [void]
-    def self.call(options = {})
-      new(options).trace
-    end
-
-    # Returns a new instance of Vedeu::Trace
-    #
-    # @param options [Hash]
-    # @return [Trace]
-    def initialize(options = {})
-      @options = options
-    end
-
-    # Performs the trace operation. Building strings which include:
-    # - (class_count) a count of classes registered with Vedeu,
-    # - (classname) the class name being traced,
-    # - (id) the method name being traced,
-    # - (vars) any local variables belonging to the method.
-    #
-    # @note
-    #   Arguments to set_trace_func proc:
-    #     |event, file, line, id, binding, name|
-    #
-    # @todo Deprecate, and use TracePoint instead.
-    #
-    # @return [NilClass|String]
-    def trace
-      set_trace_func proc { |event, _, _, id, binding, name|
-        if event == watched && id != :log && classes.include?(name.to_s)
-          vars = variables(binding)
-
-          if vars.empty?
-            log_this(format('%s %-25s #%-20s', count, name, id))
-
-          else
-            log_this(format("%s %-25s #%-20s\n%s\n", count, name, id, vars))
-
-          end
-        end
-      } if trace?
-    end
-
-    private
-
-    # Writes the message to the log file.
-    #
-    # @param message [String]
-    # @return [String]
-    def log_this(message)
-      Vedeu::Log.logger.debug(message)
-
-      message
-    end
-
-    # Provides inspection of the local variables set within the method being
-    # traced. Makes the log file extremely noisy, but very useful for hunting
-    # down bugs.
-    #
-    # @param binding [Class]
-    # @return [String]
-    def variables(binding)
-      binding.eval('local_variables').each do |var|
-        variable = Vedeu::Esc.green { var.to_s }
-        value    = binding.local_variable_get(var)
-        klass    = Vedeu::Esc.magenta { value.class.to_s }
-        output   = (value.is_a?(Proc)) ? '#<Proc:...' : value.inspect
-        content  = colour(value.class.to_s, output)
-
-        format('%33s %-10s = %s %s', ' ', variable, klass, content)
-      end.join("\n")
-    end
-
-    # @return [String]
-    def watched
-      options[:event]
-    end
-
-    # @return [Boolean]
-    def trace?
-      options[:trace]
-    end
-
-    # @return [Hash]
-    def options
-      defaults.merge!(@options)
-    end
-
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        trace: Vedeu::Configuration.trace?,
-        event: 'call',
-      }
-    end
-
-    # @return [Hash]
-    def colour(klass, output)
-      {
-        'Array'    => :yellow,
-        'Fixnum'   => :cyan,
-        'Hash'     => :blue,
-        'NilClass' => :red,
-        'String'   => :green,
-        'Symbol'   => :magenta,
-      }.fetch(klass, :white) { |colour| Vedeu::Esc.send(colour) { output } }
-    end
-
-    # Returns the number of Vedeu classes/modules. (Useful for debugging.)
-    #
-    # @return [String]
-    def count
-      @count ||= "(#{classes.size}/#{vedeu_classes.size})"
-    end
-
-    # Returns the classes to be traced, without exceptions or ignored classes.
-    #
-    # @return [Set]
-    def classes
-      @classes ||= vedeu_classes - vedeu_exceptions - ignored_classes
-    end
-
-    # Returns all the classes defined within Vedeu.
-    #
-    # @return [Set]
-    def vedeu_classes
-      @vedeu_classes ||= Vedeu.constants.collect do |c|
-        Vedeu.const_get(c).to_s
-      end.to_set
-    end
-
-    # Returns all the exceptions defined within Vedeu.
-    #
-    # @todo Vedeu should produce this set.
-    #
-    # @return [Set]
-    def vedeu_exceptions
-      Vedeu::EXCEPTIONS.to_set
-    end
-
-    # Returns a set of classes to ignore during tracing.
-    #
-    # @todo Make this configurable at runtime.
-    #
-    # @return [Set]
-    def ignored_classes
-      Set.new [
-        'Vedeu::Coercions',
-        'Vedeu::Colour',
-        'Vedeu::Common',
-        'Vedeu::Configuration',
-        'Vedeu::Esc',
-        'Vedeu::Event',
-        'Vedeu::Geometry',
-        'Vedeu::Log',
-        'Vedeu::Position',
-        'Vedeu::Presentation',
-        'Vedeu::Repository',
-        'Vedeu::Stream',
-        'Vedeu::Style',
-        'Vedeu::Terminal',
-        'Vedeu::Trace',
-        'Vedeu::Translator',
-      ]
-    end
-
-  end # Trace
-  # :nocov:
-
-end # Vedeu

data/test/lib/vedeu/support/trace_test.rb

@@ -1,35 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  describe Trace do
-
-    let(:described) { Vedeu::Trace }
-    let(:instance)  { described.new(options) }
-    let(:options)   { {} }
-
-    describe '#initialize' do
-      it { instance.must_be_instance_of(described) }
-      it { instance.instance_variable_get('@options').must_equal(options) }
-    end
-
-    describe '.call' do
-      subject { described.call(options) }
-
-      context 'when trace is enabled in the configuration' do
-      end
-
-      context 'when trace is disabled in the configuration' do
-        context 'and not enabled via the options' do
-
-        end
-        context 'but enabled via the options' do
-          let(:options) { { trace: true } }
-
-        end
-      end
-    end
-
-  end # Trace
-
-end # Vedeu