bogo-cli 0.2.14 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e1628dc08e306638c61210f8c9afcd3b86eb3e2ddf2c15f9649835616bbdae5
-  data.tar.gz: 68e1430dd4308355dac73e6bf1c4f8afc6b44d3e12fadf80e3ea6afce888ae51
+  metadata.gz: e3656ca0e9a54167aca89ef17945dcea51c9e5eddfcb5863bf961d29e607669c
+  data.tar.gz: '027490a1df8c80fc7b21740219710ca14a22ee6750d273f4fcd59fd410a345a1'
 SHA512:
-  metadata.gz: b15becb12dacf2f1e9366c72428c7001aa3118badeb8ef007aafd7bfd98e50e58fc0e8ca63993d6a384e59f6e2cfae2de7d5c0ad6e5bf553d5e618f8b2e270d9
-  data.tar.gz: 695dc796b33108aa26f544a4dc129a30a511df08287ebd656a7ab61051abaa8faba320f07f8fa964ced0a5153e9d42aa8350944492eafd52276dd51ae17a099e
+  metadata.gz: 65be75f9b91e26d4f2e7e6367ebd005a0e85dece0090927f65de924c9e19cc362bb5d5a7d890311f5917c14e0553b7b0a67a7d73ff3eacc2e6dd68ce6dba9f59
+  data.tar.gz: 56fb3b1c21a3063228d96ee1145fd2546760e257d165b653ad5716efd2ea2dcd7b5ab3bda719089eb3f3bb2b12e1b84e3ce38291fa2c355e6268e02724c530ce

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.2.16
+* Provide default UI instance and use for error output
+* Automatically configure logger on command setup
+
 # v0.2.14
 * Prevent unexpected exception when no original is wrapped (#11)
 

data/bogo-cli.gemspec

@@ -1,20 +1,20 @@
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
-require 'bogo-cli/version'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + "/lib/"
+require "bogo-cli/version"
 Gem::Specification.new do |s|
-  s.name = 'bogo-cli'
+  s.name = "bogo-cli"
   s.version = Bogo::Cli::VERSION.version
-  s.summary = 'CLI Helper libraries'
-  s.author = 'Chris Roberts'
-  s.email = 'code@chrisroberts.org'
-  s.homepage = 'https://github.com/spox/bogo-cli'
-  s.description = 'CLI Helper libraries'
-  s.require_path = 'lib'
-  s.license = 'Apache 2.0'
-  s.add_runtime_dependency 'bogo', '>= 0.1.6', '< 0.6'
-  s.add_runtime_dependency 'bogo-config', '>= 0.1.15', '< 0.5'
-  s.add_runtime_dependency 'bogo-ui'
-  s.add_runtime_dependency 'slop', '~> 3'
-  s.add_development_dependency 'rake', '~> 10'
-  s.add_development_dependency 'minitest'
-  s.files = Dir['lib/**/*'] + %w(bogo-cli.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+  s.summary = "CLI Helper libraries"
+  s.author = "Chris Roberts"
+  s.email = "code@chrisroberts.org"
+  s.homepage = "https://github.com/spox/bogo-cli"
+  s.description = "CLI Helper libraries"
+  s.require_path = "lib"
+  s.license = "Apache 2.0"
+  s.add_runtime_dependency "bogo", ">= 0.2.14", "< 0.6"
+  s.add_runtime_dependency "bogo-config", ">= 0.1.15", "< 0.5"
+  s.add_runtime_dependency "bogo-ui"
+  s.add_runtime_dependency "slop", "~> 3"
+  s.add_development_dependency "rake", "~> 10"
+  s.add_development_dependency "minitest"
+  s.files = Dir["lib/**/*"] + %w(bogo-cli.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
 end

data/lib/bogo-cli/command.rb

@@ -1,11 +1,19 @@
-require 'bogo-ui'
-require 'bogo-config'
-require 'bogo-cli'
+require "bogo-ui"
+require "bogo-config"
+require "bogo-cli"
 
 module Bogo
   module Cli
     # Abstract command class
     class Command
+      # Get or set default UI
+      #
+      # @param u [Bogo::Ui]
+      # @return [Bogo::Ui]
+      def self.ui(u = nil)
+        @ui = u if u
+        @ui
+      end
 
       include Bogo::Memoization
 
@@ -22,24 +30,25 @@ module Bogo
       #
       # @return [self]
       def initialize(cli_opts, args)
-        if(cli_opts.is_a?(Slop))
+        if (cli_opts.is_a?(Slop))
           process_cli_options(cli_opts)
         else
           @defaults = Smash.new
           @options = cli_opts.to_hash.to_smash(:snake)
           [@options, *@options.values].compact.each do |hsh|
             next unless hsh.is_a?(Hash)
-            hsh.delete_if{|k,v| v.nil?}
+            hsh.delete_if { |k, v| v.nil? }
           end
         end
         @arguments = validate_arguments!(args)
         load_config!
         ui_args = Smash.new(
           :app_name => options.fetch(:app_name,
-            self.class.name.split('::').first
-          )
+                                     self.class.name.split("::").first),
         ).merge(config)
         @ui = options.delete(:ui) || Ui.new(ui_args)
+        Bogo::Cli::Command.ui(ui)
+        configure_logger!
       end
 
       # Execute the command
@@ -51,6 +60,16 @@ module Bogo
 
       protected
 
+      # Configure the default logger based on current
+      # command configuration options
+      def configure_logger!
+        if config[:debug] || !ENV["DEBUG"].to_s.empty?
+          Bogo::Logger.logger.level = :debug
+        else
+          Bogo::Logger.logger.level = config.fetch(:log, :fatal)
+        end
+      end
+
       # Provides top level options with command specific options
       # merged to provide custom overrides
       #
@@ -66,12 +85,12 @@ module Bogo
         Smash[
           options.fetch(
             Bogo::Utility.snake(
-              self.class.name.split('::').last
+              self.class.name.split("::").last
             ),
             Hash.new
-          ).map{|k,v|
-            unless(v.nil?)
-              [k,v]
+          ).map { |k, v|
+            unless (v.nil?)
+              [k, v]
             end
           }.compact
         ]
@@ -82,16 +101,16 @@ module Bogo
       #
       # @return [Hash]
       def load_config!
-        if(options[:config])
+        if (options[:config])
           config_inst = Config.new(options[:config])
-        elsif(self.class.const_defined?(:DEFAULT_CONFIGURATION_FILES))
+        elsif (self.class.const_defined?(:DEFAULT_CONFIGURATION_FILES))
           path = self.class.const_get(:DEFAULT_CONFIGURATION_FILES).detect do |check|
             full_check = File.expand_path(check)
             File.exists?(full_check)
           end
           config_inst = Config.new(path) if path
         end
-        if(config_inst)
+        if (config_inst)
           options.delete(:config)
           defaults_inst = Smash[
             config_class.new(
@@ -145,20 +164,20 @@ module Bogo
         ui.info("#{msg}... ", :nonewline)
         begin
           result = yield
-          ui.puts ui.color('complete!', :green, :bold)
-          if(result)
-            ui.puts '---> Results:'
+          ui.puts ui.color("complete!", :green, :bold)
+          if (result)
+            ui.puts "---> Results:"
             case result
             when Hash
-              result.each do |k,v|
-                ui.puts '    ' << ui.color("#{k}: ", :bold) << v
+              result.each do |k, v|
+                ui.puts "    " << ui.color("#{k}: ", :bold) << v
               end
             else
               ui.puts result
             end
           end
         rescue => e
-          ui.puts ui.color('error!', :red, :bold)
+          ui.puts ui.color("error!", :red, :bold)
           ui.error "Reason - #{e}"
           raise
         end
@@ -171,15 +190,15 @@ module Bogo
       # @param cli_opts [Slop]
       # @return [NilClass]
       def process_cli_options(cli_opts)
-        unless(cli_opts.is_a?(Slop))
+        unless (cli_opts.is_a?(Slop))
           raise TypeError.new "Expecting type `Slop` but received type `#{cli_opts.class}`"
         end
         @options = Smash.new
         @defaults = Smash.new
         cli_opts.each do |cli_opt|
-          unless(cli_opt.value.nil?)
+          unless (cli_opt.value.nil?)
             opt_key = Bogo::Utility.snake(cli_opt.key)
-            if(cli_opt.default?)
+            if (cli_opt.default?)
               @defaults[opt_key] = cli_opt.value
             else
               @options[opt_key] = cli_opt.value
@@ -195,20 +214,18 @@ module Bogo
       # @return [Array<String>]
       def validate_arguments!(list)
         chk_idx = list.find_index do |item|
-          item.start_with?('-')
+          item.start_with?("-")
         end
-        if(chk_idx)
+        if (chk_idx)
           marker = list.find_index do |item|
-            item == '--'
+            item == "--"
           end
-          if(marker.nil? || chk_idx.to_i < marker)
+          if (marker.nil? || chk_idx.to_i < marker)
             raise ArgumentError.new "Unknown CLI option provided `#{list[chk_idx]}`"
           end
         end
         list
       end
-
     end
-
   end
 end

data/lib/bogo-cli/setup.rb

@@ -1,32 +1,34 @@
 # Trigger shutdown on INT or TERM signals
-o_int = Signal.trap('INT'){
+o_int = Signal.trap("INT") {
   o_int.call if o_int.respond_to?(:call)
-  if(Bogo::Cli.exit_on_signal == false)
-    Thread.main.raise SignalException.new('SIGINT')
+  if (Bogo::Cli.exit_on_signal == false)
+    Thread.main.raise SignalException.new("SIGINT")
   else
     exit 0
   end
 }
 
-o_term = Signal.trap('TERM'){
+o_term = Signal.trap("TERM") {
   o_int.call if o_int.respond_to?(:call)
-  if(Bogo::Cli.exit_on_signal == false)
-    Thread.main.raise SignalException.new('SIGTERM')
+  if (Bogo::Cli.exit_on_signal == false)
+    Thread.main.raise SignalException.new("SIGTERM")
   else
     exit 0
   end
 }
 
-require 'bogo-cli'
+require "bogo-cli"
 
 class Slop
   def bogo_cli_run(*args, &block)
     slop_run(*args, &block)
     old_runner = @runner
-    @runner = proc{|*args| old_runner.call(*args); exit 0}
+    @runner = proc { |*args| old_runner.call(*args); exit 0 }
   end
+
   alias_method :slop_run, :run
   alias_method :run, :bogo_cli_run
+
   class Option
     def default?
       @value.nil?
@@ -50,23 +52,45 @@ module Bogo
             end
             puts slop_result.help
             exit -1
-          rescue Bogo::Config::FileLoadError => e
-            $stderr.puts "ERROR: #{[e, e.original].compact.join(' - ')}"
-            if(ENV['DEBUG'] && e.original)
-              $stderr.puts "Stacktrace: #{e.original.class}: #{e.original.message}\n#{e.original.backtrace.join("\n")}"
-            end
-            exit e.respond_to?(:exit_code) ? e.exit_code : -1
-          rescue StandardError, ScriptError => e
-            if(ENV['DEBUG'])
-              $stderr.puts "ERROR: #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
-            else
-              $stderr.puts "ERROR: #{e.class}: #{e.message}"
+          rescue StandardError, ScriptError => err
+            output_error err.message
+            if ENV["DEBUG"]
+              output_debug "Stacktrace: #{err.class}: " \
+                "#{err.message}\n#{err.backtrace.join("\n")}"
+              if err.respond_to?(:original) && err.original
+                msg = "Original Stacktrace: #{err.original.class}: " \
+                  "#{err.original.message}\n#{err.original.backtrace.join("\n")}"
+                output_debug msg
+              end
             end
-            exit e.respond_to?(:exit_code) ? e.exit_code : -1
+            exit err.respond_to?(:exit_code) ? err.exit_code : -1
           end
           true
         end
 
+        # Write error message to UI. Uses formatted
+        # ui if available and falls back to stderr.
+        #
+        # @param string [String]
+        def output_error(string)
+          if Command.ui
+            Command.ui.error string
+          else
+            $stderr.puts "ERROR: #{string}"
+          end
+        end
+
+        # Write debug message to UI. Uses formatted
+        # ui if available and falls back to stderr.
+        #
+        # @param string [String]
+        def output_debug(string)
+          if Command.ui
+            Command.ui.debug string
+          else
+            $stderr.puts "DEBUG: #{string}"
+          end
+        end
       end
     end
   end

data/lib/bogo-cli/version.rb

@@ -1,6 +1,6 @@
 module Bogo
   module Cli
     # Current library version
-    VERSION = Gem::Version.new('0.2.14')
+    VERSION = Gem::Version.new("0.2.16")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.16
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bogo
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.14
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.6'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.14
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.6'