vedeu 0.8.14 → 0.8.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34e3c347f479d6c178f4aacae2dd5cee4018d555
-  data.tar.gz: 92cb71dfedee65fb74c2808c843bea8222802808
+  metadata.gz: 7873b236437abf97edd687af67588fd80c87b3e9
+  data.tar.gz: 4c2646bd4fb5366960fb0fef677d96aa929db230
 SHA512:
-  metadata.gz: 338a4fd459b7f6d89e56e3247921aa215069b5bf30b947084fbd55c5aec2a42d44cecaf6d8a4a5ca7e38fd0084b5908239bffe9a760c444476ff336e1c51ef16
-  data.tar.gz: a84a360d6c8f4153ca61aa89ea819178d866d9e9d4b306b23da5a9da57bba8146840155b24626a24108bd1a3a6addcdde33a93c0b8582379933a1462ab7f83a2
+  metadata.gz: 1538cf094b528f976340e281c7cab189cf42e5190a662dff3d2b0ce61aa8990f26b05c7059c4ea29a19fa7ef830d362008a448d78160d9fb3e4dce44ef46527f
+  data.tar.gz: 74dabd2d4fbd0aef2512601a521a105644d227d482be6a31ca3f0a6ef270e8ba6749f518141b54f35470c2c96313a36ba89b8395bb36ac1893e0cbed8a7b09e0

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if ENV['RUBOCOP'].to_i == 1
   guard :rubocop do
     watch(/.+\.rb$/)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'yard'

data/bin/vedeu

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'rake'
 bundler_message = 'Bundler is required. Please install bundler with ' \
                   "'gem install bundler'"

data/bin/vedeu_drb_client

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 

data/bin/vedeu_drb_server

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 lib_dir = '/Users/gavinlaking/Source/vedeu/lib/vedeu/distributed/../../../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 

data/bin/vedeu_test

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 

data/docs/configuration/background.md

@@ -0,0 +1,9 @@
+Configure the background colour for the client application.
+
+    # Set:
+    Vedeu.configure do
+      background '#330000'
+    end
+
+    # Get:
+    Vedeu.config.background

data/docs/configuration/foreground.md

@@ -0,0 +1,9 @@
+Configure the foreground colour for the client application.
+
+    # Set:
+    Vedeu.configure do
+      foreground '#00aa33'
+    end
+
+    # Get:
+    Vedeu.config.foreground

data/lib/vedeu/application/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vedeu/application/controller'
 require 'vedeu/application/helper'
 require 'vedeu/application/view'

data/lib/vedeu/common.rb

@@ -8,13 +8,14 @@ module Vedeu
   #
   module Common
 
-    # Returns a boolean indicating whether a variable is nil or empty.
+    # Returns a boolean indicating whether a variable is nil, false or
+    # empty.
     #
     # @param variable [String|Symbol|Array|Fixnum] The variable to
     #   check.
     # @return [Boolean]
     def absent?(variable)
-      !present?(variable)
+      variable == false || !present?(variable)
     end
 
     # Returns a boolean indicating whether the value is an Array.
@@ -25,7 +26,7 @@ module Vedeu
       value.is_a?(Array)
     end
 
-    # Returns a boolean indicating the value was a boolean.
+    # Returns a boolean indicating the value is a boolean.
     #
     # @param value [void]
     # @return [Boolean]
@@ -43,6 +44,17 @@ module Vedeu
       value.is_a?(TrueClass) || value.is_a?(FalseClass)
     end
 
+    # Returns a boolean indicating the value is empty.
+    #
+    # @param value [void]
+    # @return [Boolean]
+    def empty_value?(value)
+      return true if value.respond_to?(:empty?) && value.empty?
+      return true if value.nil?
+
+      false
+    end
+
     # Returns a boolean indicating whether the value is an escape
     # sequence object (e.g. {Vedeu::Cells::Escape}.)
     #
@@ -109,8 +121,8 @@ module Vedeu
     # @return [Boolean]
     def present?(variable)
       return true  if numeric?(variable)
-      return false if variable.nil?
-      return false if variable.respond_to?(:empty?) && variable.empty?
+      return false if variable.nil? || variable == false
+      return false if empty_value?(variable)
 
       true
     end

data/lib/vedeu/configuration/all.rb

@@ -4,22 +4,10 @@ module Vedeu
 
   # Namespace for configuration classes.
   #
+  # @api public
+  #
   module Config
 
-    module_function
-
-    # Custom log for configuration.
-    #
-    # @param from [String] Which configuration set the options.
-    # @param options [Hash<Symbol => void>] The configuration options set.
-    # @return [Hash<Symbol => void>] The options param.
-    def log(from, options)
-      options.each do |option, value|
-        Vedeu.log(type:    :config,
-                  message: "#{from} #{option}: #{value}")
-      end
-    end
-
   end # Config
 
 end # Vedeu

data/lib/vedeu/configuration/api.rb

@@ -13,8 +13,8 @@ module Vedeu
       include Vedeu::Common
 
       # @param (see #initialize)
-      def self.configure(&block)
-        new(&block).configuration
+      def self.configure(default, &block)
+        new(default, &block).configuration
       end
 
       # Returns a new instance of Vedeu::Config::API.
@@ -27,9 +27,12 @@ module Vedeu
       #     # ...
       #   end
       #
+      # @param default [Hash]
       # @param block [Proc]
       # @return [Vedeu::Configuration::API]
-      def initialize(&block)
+      def initialize(default, &block)
+        @default = default
+
         instance_eval(&block) if block_given?
       end
 
@@ -37,8 +40,22 @@ module Vedeu
       #
       # @return [Hash<Symbol => Boolean, Fixnum, String>]
       def configuration
-        Vedeu::Config
-          .log(Vedeu.esc.green { '[api]' }, options)
+        if options[:log].nil?          ||
+           options[:log] == false      ||
+           empty_value?(options[:log])
+          Vedeu.log(type:    :config,
+                    message: 'Logging has been disabled.')
+
+          return options
+        end
+
+        log_options!
+
+        if options[:log] != default[:log]
+          Vedeu.log(message: "Switching to '#{options[:log]}' for logging.\n")
+        end
+
+        options
       end
 
       # {include:file:docs/configuration/interactive.md}
@@ -228,17 +245,33 @@ module Vedeu
       end
       alias height= height
 
-      # Sets the location of the log file.
+      # Sets the location of the log file, or disables the log.
+      # By default, the log file is set to '/tmp/vedeu_bootstrap.log'.
       #
+      #   # Log messages will be sent to the path given.
       #   Vedeu.configure do
       #     log '/var/log/vedeu.log'
       #     # ...
       #   end
       #
-      # @param filename [String]
-      # @return [String]
-      def log(filename = '')
-        options[:log] = filename
+      #   # Log messages will be silently dropped.
+      #   Vedeu.configure do
+      #     log false
+      #     # ...
+      #   end
+      #
+      # @param filename_or_false [FalseClass|String]
+      # @return [NilClass|String]
+      def log(filename_or_false = false)
+        options[:log] = if filename_or_false.nil? ||
+                           filename_or_false == false ||
+                           empty_value?(filename_or_false)
+                          nil
+
+                        else
+                          filename_or_false
+
+                        end
       end
 
       # Log specific message types except those given. A complete list
@@ -493,13 +526,7 @@ module Vedeu
       end
       alias width= width
 
-      # Sets the background of the terminal.
-      #
-      #   Vedeu.configure do
-      #     background '#ff0000'
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/background.md}
       # @param value [String]
       # @return [Vedeu::Colours::Background]
       def background(value = nil)
@@ -508,13 +535,7 @@ module Vedeu
         options[:background] = value
       end
 
-      # Sets the foreground of the terminal.
-      #
-      #   Vedeu.configure do
-      #     foreground '#ffff00'
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/configuration/foreground.md}
       # @param value [String]
       # @return [Vedeu::Colours::Foreground]
       def foreground(value = nil)
@@ -557,6 +578,12 @@ module Vedeu
       end
       alias mouse mouse!
 
+      protected
+
+      # @!attribute [r] default
+      # @return [Hash]
+      attr_reader :default
+
       private
 
       # @macro raise_invalid_syntax
@@ -565,6 +592,14 @@ module Vedeu
               'Terminal mode can be set to either :cooked, :fake or :raw'
       end
 
+      # @return [Hash]
+      def log_options!
+        options.each do |option, value|
+          Vedeu.log(type:    :config,
+                    message: "#{option}: #{value.inspect}")
+        end
+      end
+
       # Returns the options set via the configuration API DSL or an
       # empty Hash when none were set.
       #

data/lib/vedeu/configuration/configuration.rb

@@ -18,9 +18,7 @@ module Vedeu
 
       include Vedeu::Common
 
-      # Return the configured background colour for the client
-      # application.
-      #
+      # {include:file:docs/configuration/background.md}
       # @return [String|Symbol]
       def background
         instance.options[:background]
@@ -121,9 +119,7 @@ module Vedeu
         instance.options[:drb_width]
       end
 
-      # Return the configured foreground colour for the client
-      # application.
-      #
+      # {include:file:docs/configuration/foreground.md}
       # @return [String|Symbol]
       def foreground
         instance.options[:foreground]
@@ -175,7 +171,9 @@ module Vedeu
       #
       # @return [Boolean]
       def log?
-        present?(log)
+        return false if log == false || log.nil?
+
+        true
       end
 
       # @return [Array<Symbol>]
@@ -372,6 +370,8 @@ module Vedeu
 
     end # Eigenclass
 
+    include Vedeu::Common
+
     # @!attribute [r] options
     # @return [Hash<Symbol => void>]
     attr_reader :options
@@ -391,7 +391,7 @@ module Vedeu
     def configure(opts = {}, &block)
       @options.merge!(opts)
 
-      @options.merge!(Config::API.configure(&block)) if block_given?
+      @options.merge!(Config::API.configure(defaults, &block)) if block_given?
 
       Vedeu::Configuration
     end
@@ -421,7 +421,7 @@ module Vedeu
         foreground:    :default,
         height:        nil,
         interactive:   true,
-        log:           nil,
+        log:           '/tmp/vedeu_bootstrap.log',
         log_except:    [],
         log_only:      [],
         mouse:         true,

data/lib/vedeu/logging/log.rb

@@ -23,16 +23,13 @@ module Vedeu
         #             message: 'A useful debugging message: Error!')
         #
         # @macro vedeu_logging_log_param_message
-        # @param force [Boolean] When evaluates to true will attempt
-        #   to write to the log file regardless of the Configuration
-        #   setting.
         # @param type [Symbol] Colour code messages in the log file
         #   depending on their source. See
         #   {Vedeu::Configuration.log_types}
         #
         # @return [String]
-        def log(message:, force: false, type: :info)
-          if (Vedeu.config.log? || force) && Vedeu.config.loggable?(type)
+        def log(message:, type: :info)
+          if Vedeu.config.log? && Vedeu.config.loggable?(type)
             output = log_entry(type, message)
             logger.debug(output)
             output

data/lib/vedeu/plugins/all.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'vedeu/plugins/plugins'
 require 'vedeu/plugins/plugin'

data/lib/vedeu/runtime/launcher.rb

@@ -109,7 +109,7 @@ module Vedeu
     #
     # @return [void]
     def terminate!
-      Vedeu.log(message: 'Exiting gracefully.')
+      Vedeu.log(message: "Exiting gracefully.\n")
 
       $stdin  = STDIN
       $stdout = STDOUT

data/lib/vedeu/version.rb

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

data/lib/vedeu/views/stream.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 require 'vedeu/dsl/all'
 require 'vedeu/cells/all'
 
-# frozen_string_literal: true
-
 module Vedeu
 
   module Views

data/test/lib/vedeu/common_test.rb

@@ -43,6 +43,12 @@ module Vedeu
         it { subject.must_equal(false) }
       end
 
+      context 'when the variable is false' do
+        let(:_value) { false }
+
+        it { subject.must_equal(true) }
+      end
+
       context 'when the variable is not nil or empty' do
         let(:_value) { 'not empty' }
 
@@ -107,6 +113,38 @@ module Vedeu
       end
     end
 
+    describe '#empty_value?' do
+      let(:_value) {}
+
+      subject { instance.empty_value?(_value) }
+
+      context 'when the value does not respond to :empty?' do
+        context 'when the value is nil' do
+          it { subject.must_equal(true) }
+        end
+
+        context 'whent the value is not nil' do
+          let(:_value) { :some_value }
+
+          it { subject.must_equal(false) }
+        end
+      end
+
+      context 'when the value responds to :empty?' do
+        context 'when the value is not empty' do
+          let(:_value) { [:some_value] }
+
+          it { subject.must_equal(false) }
+        end
+
+        context 'when the value is empty' do
+          let(:_value) { [] }
+
+          it { subject.must_equal(true) }
+        end
+      end
+    end
+
     describe '#boolean?' do
       subject { instance.boolean?(_value) }
 
@@ -277,6 +315,12 @@ module Vedeu
         it { subject.must_equal(true) }
       end
 
+      context 'when the variable is false' do
+        let(:_value) { false }
+
+        it { subject.must_equal(false) }
+      end
+
       context 'when the variable is not nil or empty' do
         let(:_value) { 'not empty' }
 

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

@@ -23,7 +23,8 @@ module Vedeu
     describe API do
 
       let(:described) { Vedeu::Config::API }
-      let(:instance)  { described.new }
+      let(:instance)  { described.new(default) }
+      let(:default)   { {} }
 
       after  { test_configuration }
 

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

@@ -65,10 +65,12 @@ module Vedeu
 
     describe '.log' do
       context 'when the log is not configured' do
-        it { described.log.must_equal(nil) }
+        it 'sends messages to the default log' do
+          described.log.must_equal('/tmp/vedeu_bootstrap.log')
+        end
       end
 
-      context 'when the log is configured' do
+      context 'when the log is configured with a filename' do
         before do
           Vedeu.configure do
             log '/tmp/vedeu.log'
@@ -77,21 +79,31 @@ module Vedeu
 
         it { described.log.must_equal('/tmp/vedeu.log') }
       end
+
+      context 'when the log is configured with false' do
+        before do
+          Vedeu.configure do
+            log false
+          end
+        end
+
+        it { described.log.must_equal(nil) }
+      end
     end
 
     describe '.log?' do
-      context 'when the log is not configured' do
-        it { described.log?.must_equal(false) }
+      context 'when the log is enabled' do
+        it { described.log?.must_equal(true) }
       end
 
-      context 'when the log is configured' do
+      context 'when the log is disabled' do
         before do
           Vedeu.configure do
-            log '/tmp/vedeu.log'
+            log false
           end
         end
 
-        it { described.log?.must_equal(true) }
+        it { described.log?.must_equal(false) }
       end
     end
 

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

@@ -14,14 +14,15 @@ module Vedeu
 
       let(:described) { Vedeu::Logging::Log }
       let(:_message)  { 'Some message...' }
-      let(:force)     { false }
       let(:type)      { :info }
 
       describe '.log' do
-        subject { described.log(message: _message, force: force, type: type) }
+        before { Vedeu.config.stubs(:log?).returns(enabled) }
 
-        context 'when :force is true' do
-          let(:force) { true }
+        subject { described.log(message: _message, type: type) }
+
+        context 'when the log is enabled' do
+          let(:enabled)  { true }
           let(:expected) {
             "\e[97m[info]     \e[39m\e[37mSome message...\e[39m"
           }
@@ -29,8 +30,8 @@ module Vedeu
           it { subject.must_equal(expected) }
         end
 
-        context 'when :force is false' do
-          let(:force) { false }
+        context 'when the log is disabled' do
+          let(:enabled)  { false }
 
           it { subject.must_equal(nil) }
         end

data/test/test_helper.rb

@@ -118,14 +118,13 @@ def test_configuration
 
   Vedeu.configure do
     colour_mode 16_777_216
-    # adds ~40ms to test run speed
-    # debug!
-    # profile!
 
-    # if debug! above is commented out, then only
-    # `Vedeu.log(type: <any type>, message: '...', force: true)`
-    # will be logged, otherwise every `Vedeu.log` will be logged.
+    # debug! # adds ~40ms to test run speed
+
     # log '/tmp/vedeu_test_helper.log'
+    log false
+
+    # profile!
   end
 
   # Vedeu::Repositories.reset!

data/vedeu.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -26,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest',           '5.8.4'
   spec.add_development_dependency 'minitest-reporters', '1.1.7'
   spec.add_development_dependency 'mocha',              '1.1.0'
-  spec.add_development_dependency 'rubocop',            '0.37.0'
+  spec.add_development_dependency 'rubocop',            '0.37.1'
   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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.8.14
+  version: 0.8.15
 platform: ruby
 authors:
 - Gavin Laking
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.37.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -243,9 +243,11 @@ files:
 - docs/chars.md
 - docs/colours_styles.md
 - docs/configuration.md
+- docs/configuration/background.md
 - docs/configuration/drb.md
 - docs/configuration/drb_host.md
 - docs/configuration/drb_port.md
+- docs/configuration/foreground.md
 - docs/configuration/interactive.md
 - docs/configuration/run_once.md
 - docs/configuration/standalone.md