vedeu 0.8.27 → 0.8.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d982f2ff8445c7766e1ea4f8ebc1686a73bc9e9
-  data.tar.gz: ac882d53395e9f4d88493b712cd58c1484132bc0
+  metadata.gz: bd49dbbe4583758d2452063e9161fec5c9bc4d79
+  data.tar.gz: f4eeeda050db0fc5e52a03dae4bbcc2176073d23
 SHA512:
-  metadata.gz: bcd158b827af91247492e2c69a452ea941c395202643e06a02e3c17c0f6eaec4a5fb7e81a7a324ef457eb0b70b5ea2cd9f539a83121bdc7edcc7702197d68a71
-  data.tar.gz: 278c0088c5c2f06f0dcab500e8598513a80b9ba2814736962d2a7cf348075b883afc2a091e1573583f1cab68f01667b2895186a15c8860933a2d1691f955054a
+  metadata.gz: cd89d6b6433e244b82c6333b25b308791c99668cb34af1bb26f559b36e41db0b0ac1409048fa4a1f97914f7f46b05d60171a610cf109e9a963003ea15db91a96
+  data.tar.gz: 33269aa82e2aaf0759c7eb75795e5dd2ed1185fc14c61d14b4aea61eafe52f3b0a92507c0f41ac1bc465967b5ca67cce880e5e068328e346ac11f719b8bfb5ea

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.1

data/Dockerfile

@@ -43,19 +43,19 @@ RUN tar -xzvf chruby-0.3.9.tar.gz && cd chruby-0.3.9/ && make install
 RUN wget -O ruby-install-0.5.0.tar.gz https://github.com/postmodern/ruby-install/archive/v0.5.0.tar.gz
 RUN tar -xzvf ruby-install-0.5.0.tar.gz && cd ruby-install-0.5.0/ && make install
 
-# Install Ruby 2.2.2
-RUN ruby-install ruby 2.2.2
+# Install Ruby 2.3.1
+RUN ruby-install ruby 2.3.1
 RUN chown -R vedeu:vedeu /opt/rubies
 
 # Setup Chruby
 RUN echo '[ -n "$BASH_VERSION" ] || [ -n "$ZSH_VERSION" ] || return' >> /etc/profile.d/chruby.sh
 RUN echo 'source /usr/local/share/chruby/chruby.sh' >> /etc/profile.d/chruby.sh
 RUN echo 'source /usr/local/share/chruby/auto.sh' >> $HOME/.bashrc
-RUN echo 'chruby ruby-2.2.2' >> $HOME/.bash_profile
+RUN echo 'chruby ruby-2.3.1' >> $HOME/.bash_profile
 RUN echo "---\n:benchmark: false\n:bulk_threshold: 1000\n:backtrace: false\n:verbose: true\ngem: --no-ri --no-rdoc" >> $HOME/.gemrc
 
 # Setup PATH
-ENV PATH /opt/rubies/ruby-2.2.2/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/vedeu/gem/bin
+ENV PATH /opt/rubies/ruby-2.3.1/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/vedeu/gem/bin
 
 RUN gem install bundler
 

data/integrations/dsl_app_geometry_001.rb

@@ -13,7 +13,7 @@ class DSLApp
 
   Vedeu.configure do
     debug!
-    log '/tmp/vedeu_integrations.log'
+    log Dir.tmpdir + '/vedeu_views_dsl.log'
     renderers [
                 Vedeu::Renderers::Terminal.new(
                   filename:   Dir.tmpdir + "/#{TESTCASE}.out",

data/integrations/dsl_app_geometry_002.rb

@@ -13,7 +13,7 @@ class DSLApp
 
   Vedeu.configure do
     debug!
-    log '/tmp/vedeu_integrations.log'
+    log Dir.tmpdir + '/vedeu_views_dsl.log'
     renderers [
                 Vedeu::Renderers::Terminal.new(
                   filename:   Dir.tmpdir + "/#{TESTCASE}.out",

data/integrations/dsl_app_geometry_003.rb

@@ -13,7 +13,7 @@ class DSLApp
 
   Vedeu.configure do
     debug!
-    log '/tmp/vedeu_integrations.log'
+    log Dir.tmpdir + '/vedeu_views_dsl.log'
     renderers [
                 Vedeu::Renderers::Terminal.new(
                   filename:   Dir.tmpdir + "/#{TESTCASE}.out",

data/integrations/dsl_app_geometry_004.rb

@@ -13,7 +13,7 @@ class DSLApp
 
   Vedeu.configure do
     debug!
-    log '/tmp/vedeu_integrations.log'
+    log Dir.tmpdir + '/vedeu_views_dsl.log'
     renderers [
                 Vedeu::Renderers::Terminal.new(
                   filename:   Dir.tmpdir + "/#{TESTCASE}.out",

data/lib/vedeu/events/trigger.rb

@@ -86,9 +86,13 @@ module Vedeu
       # @return [Array<void>|void]
       def results
         @results ||= registered_events.map do |event|
-          Vedeu.log(type: :event, message: message)
+          Vedeu.outdent do
+            Vedeu.log(type: :event, message: message)
 
-          event.trigger(*args)
+            Vedeu.indent do
+              event.trigger(*args)
+            end
+          end
         end
       end
 

data/lib/vedeu/logging/log.rb

@@ -16,6 +16,27 @@ module Vedeu
 
       class << self
 
+        # @api private
+        # @!attribute [rw] count
+        # @return [Fixnum] Used by tests to access the `count`
+        #   instance variable.
+        attr_accessor :count
+
+        # Used by {Vedeu::Events::Trigger} to indent log messages to
+        # show activity which occurs as part of that event triggering.
+        #
+        # @api private
+        # @macro param_block
+        # @return [NilClass|void]
+        def indent(&block)
+          @count ||= 0
+          @count += 1
+
+          yield if block_given?
+        ensure
+          outdent
+        end
+
         # Write a message to the Vedeu log file.
         #
         # @example
@@ -57,6 +78,25 @@ module Vedeu
           $stderr.puts log_entry(type, message)
         end
 
+        # Used by {Vedeu::Events::Trigger} to outdent log messages to
+        # show activity which occurs as part of the previous event
+        # triggering.
+        #
+        # @api private
+        # @macro param_block
+        # @return [void]
+        def outdent(&block)
+          result = yield if block_given?
+
+          if @count && @count > 0
+            @count -= 1
+          else
+            @count = 0
+          end
+
+          result
+        end
+
         # {include:file:docs/dsl/by_method/log_timestamp.md}
         # @return [String]
         def timestamp
@@ -75,13 +115,10 @@ module Vedeu
 
         private
 
-        # @return [Boolean]
-        def logger
-          MonoLogger.new(Vedeu.config.log).tap do |log|
-            log.formatter = proc do |_, _, _, message|
-              formatted_message(message)
-            end
-          end
+        # @param type [Symbol] The type of log message.
+        # @return [Array<Symbol>]
+        def colours(type)
+          Vedeu::LOG_TYPES.fetch(type, [:default, :default])
         end
 
         # {include:file:docs/dsl/by_method/log_timestamp.md}
@@ -91,6 +128,11 @@ module Vedeu
           "#{timestamp}#{message}\n" if message
         end
 
+        # @return [String]
+        def indentation
+          ' ' * (@count ||= 0) * 2
+        end
+
         # Returns the message:
         #
         #     [type] message
@@ -112,13 +154,16 @@ module Vedeu
         # @macro vedeu_logging_log_param_message
         # @return [String]
         def log_message(type, message)
-          Vedeu.esc.colour(colours(type)[1]) { message }
+          Vedeu.esc.colour(colours(type)[1]) { indentation + message }
         end
 
-        # @param type [Symbol] The type of log message.
-        # @return [Array<Symbol>]
-        def colours(type)
-          Vedeu::LOG_TYPES.fetch(type, [:default, :default])
+        # @return [Boolean]
+        def logger
+          MonoLogger.new(Vedeu.config.log).tap do |log|
+            log.formatter = proc do |_, _, _, message|
+              formatted_message(message)
+            end
+          end
         end
 
       end # Eigenclass
@@ -127,6 +172,9 @@ module Vedeu
 
   end # Logging
 
+  # @api public
+  # @!method indent
+  #   @see Vedeu::Logging::Log.indent
   # @api public
   # @!method log
   #   @see Vedeu::Logging::Log.log
@@ -139,10 +187,15 @@ module Vedeu
   # @api public
   # @!method log_timestamp
   #   @see Vedeu::Logging::Log.log_timestamp
+  # @api public
+  # @!method outdent
+  #   @see Vedeu::Logging::Log.outdent
   def_delegators Vedeu::Logging::Log,
+                 :indent,
                  :log,
                  :log_stdout,
                  :log_stderr,
-                 :log_timestamp
+                 :log_timestamp,
+                 :outdent
 
 end # Vedeu

data/lib/vedeu/plugins/plugins.rb

@@ -64,7 +64,7 @@ module Vedeu
 
     protected
 
-    # @!attribute [r] input
+    # @!attribute [rw] plugins
     # @return [Array<String>]
     attr_accessor :plugins
 

data/lib/vedeu/presentation/parent.rb

@@ -4,6 +4,8 @@ module Vedeu
 
   module Presentation
 
+    # Provide access to the parent class for a {Vedeu::Views}
+    # instance.
     #
     # @api private
     #

data/lib/vedeu/repositories/cache.rb

@@ -4,6 +4,12 @@ module Vedeu
 
   module Repositories
 
+    # Allow the storing of values for a finite period to save repeated
+    # computation.
+    #
+    # @note
+    #   This class is not currently used and will be used in future.
+    #
     # @api private
     #
     class Cache

data/lib/vedeu/version.rb

@@ -3,6 +3,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.8.27'
+  VERSION = '0.8.28'
 
 end # Vedeu

data/test/lib/vedeu/logging/log_test.rb

@@ -16,6 +16,55 @@ module Vedeu
       let(:_message)  { 'Some message...' }
       let(:type)      { :info }
 
+      describe '.count' do
+        it { described.must_respond_to(:count) }
+      end
+
+      describe '.count=' do
+        it { described.must_respond_to(:count=) }
+      end
+
+      describe '.indent' do
+        context 'when the block is given' do
+          subject { described.indent { :block_given } }
+
+          it { subject.must_equal(:block_given) }
+        end
+
+        context 'when the block is not given' do
+          subject { described.indent }
+
+          it { subject.must_equal(nil) }
+        end
+
+        context 'when the indentation count > 0' do
+          before { described.count = 2 }
+          after  { described.count = nil }
+
+          subject { described.indent { :block_given } }
+
+          it { subject; described.count.must_equal(2) }
+        end
+
+        context 'when the indentation count is 0' do
+          before { described.count = 0 }
+          after  { described.count = nil }
+
+          subject { described.indent { :block_given } }
+
+          it { subject; described.count.must_equal(0) }
+        end
+
+        context 'when the indentation count < 0' do
+          before { described.count = -2 }
+          after  { described.count = nil }
+
+          subject { described.indent { :block_given } }
+
+          it { subject; described.count.must_equal(0) }
+        end
+      end
+
       describe '.log' do
         before { Vedeu.config.stubs(:log?).returns(enabled) }
 
@@ -63,6 +112,57 @@ module Vedeu
         end
       end
 
+      describe '.log_timestamp' do
+        it { described.must_respond_to(:log_timestamp) }
+      end
+
+      describe '.outdent' do
+        context 'when the block is given' do
+          subject { described.outdent { :block_given } }
+
+          it { subject.must_equal(:block_given) }
+        end
+
+        context 'when the block is not given' do
+          subject { described.outdent }
+
+          it { subject.must_equal(nil) }
+        end
+
+        context 'when the indentation count > 0' do
+          before { described.count = 2 }
+          after  { described.count = nil }
+
+          subject { described.outdent { :block_given } }
+
+          it { subject; described.count.must_equal(1) }
+        end
+
+        context 'when the indentation count is 0' do
+          before { described.count = 0 }
+          after  { described.count = nil }
+
+          subject { described.outdent { :block_given } }
+
+          it { subject; described.count.must_equal(0) }
+        end
+
+        context 'when the indentation count < 0' do
+          before { described.count = -2 }
+          after  { described.count = nil }
+
+          subject { described.outdent { :block_given } }
+
+          it { subject; described.count.must_equal(0) }
+        end
+      end
+
+      describe '.timestamp' do
+        subject { described.timestamp }
+
+        # @todo Add more tests.
+      end
+
     end # Log
 
   end # Logging

data/vedeu.gemspec

@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-minitest',     '2.4.4'
   spec.add_development_dependency 'guard-rubocop',      '1.2.0'
   spec.add_development_dependency 'minitest',           '5.8.4'
-  spec.add_development_dependency 'minitest-reporters', '1.1.8'
+  spec.add_development_dependency 'minitest-reporters', '1.1.9'
   spec.add_development_dependency 'mocha',              '1.1.0'
   spec.add_development_dependency 'rubocop',            '0.39.0'
   spec.add_development_dependency 'simplecov',          '0.11.2'
   spec.add_development_dependency 'simplecov-console',  '0.3.0'
   spec.add_development_dependency 'yard',               '0.8.7.6'
 
-  spec.add_dependency 'bundler',       '~> 1.11'
+  spec.add_dependency 'bundler',       '~> 1.12'
   spec.add_dependency 'rake',          '~> 10.5'
   spec.add_dependency 'thor',          '0.19.1'
   spec.add_dependency 'vedeu_cli',     '0.0.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.8.27
+  version: 0.8.28
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.8
+        version: 1.1.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.8
+        version: 1.1.9
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement