console_runner 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 324b6b2410dcad3c02f00d4cae6bfd73c353c43b
-  data.tar.gz: b8f40d069aec62595cc75608bbaa2f1b59f8e1d9
+  metadata.gz: e978670a0d9f1fa5854543027f3e737d33b1730a
+  data.tar.gz: e77dc5ea5ddc94e142ee6020b9ac35b9f6224d1c
 SHA512:
-  metadata.gz: 24cd3d1bd2049ae0c9417ffb3f495611bcb39d912f7f289cbfd01b93dbca5f3feb049bea137bf235c66bb2847469e91ef5c5922fbe2f959f129bf4ba9be9455e
-  data.tar.gz: 2ce249177a0213d3cf07ef1419bda487bc729551c40e77dfaa473cef7a428745501d011129dba9656f9959e1937d365a12ef60269f764e70e5d0e3b52b378d2e
+  metadata.gz: e0bb91b568388bbbf2c481b30001d4ac9745c0617fe4c598fc2473971453aebfec3ad3a5c794e4747e66372faab9880019829023eddc936c3438340049e90396
+  data.tar.gz: 540f4dc2cf8eb1bafeb0f36efcecfbca7f9e2a19666300e618bd33b26754e1de35fb7b32014900d2c111ef108931b6501937a38cc889b4e507302898e25b2b97

data/lib/command_line_parser.rb

@@ -4,7 +4,8 @@ require 'colorize'
 
 # Parses command line and configure #Trollop
 class CommandLineParser
-  attr_reader :method, :init_method
+  attr_reader :method, :initialize_method
+  @debug = false
 
   # Generate tool help menu.
   # IMPORTANT! Should be executed before ARGV.shift
@@ -18,16 +19,21 @@ class CommandLineParser
       ]
     end.to_h
     @parser            = Trollop::Parser.new
+    @parser.opt(:debug, 'Run in debug mode.', type: :flag)
     @parser.stop_on @sub_commands
-    @init_method = nil
+    @initialize_method = nil
+  end
+
+  def self.debug?
+    @debug
   end
 
   def tool_banner
     result = FileParser.select_runnable_tags(@file_parser.clazz).map(&:text).join("\n")
-    result += "\n\n\tAvailable actions:\n"
+    result += "\n\nAvailable actions:\n"
     result += @sub_commands_text.map do |c, text|
-      t = "\t\t- #{c}"
-      t += "\n\t\t\t#{text}" if text != ''
+      t = "\t- #{c}"
+      t += "\n\t\t#{text}" if text != ''
       t
     end.join("\n")
     result
@@ -35,28 +41,29 @@ class CommandLineParser
 
   def maybe_help(banner, action_name = nil)
     action = action_name
-    scope = ARGV
+    scope  = ARGV
     if action_name
       action_index = ARGV.index(action)
-      scope = ARGV[0..action_index] if action_index
+      scope        = ARGV[0..action_index] if action_index
     end
-    return unless scope.any?{|a| %w(-h --help).include? a }
+    @debug = scope.any? { |a| %w(-d --debug).include? a }
+    return unless scope.any? { |a| %w(-h --help).include? a }
     @parser.banner("\n" + banner)
     Trollop::with_standard_exception_handling(@parser) { raise Trollop::HelpNeeded }
   end
 
   def raise_on_action_absence(sub_commands)
-    return if ARGV.any? {|a| sub_commands.include? a }
+    return if ARGV.any? { |a| sub_commands.include? a }
     raise ConsoleRunnerError, "You must provide one of available actions: #{sub_commands.join ', '}"
   end
 
   def run(action)
-    maybe_help(tool_banner, action ? action.name.to_s : nil )
+    maybe_help(tool_banner, action ? action.name.to_s : nil)
     raise ConsoleRunnerError, 'Cannot find any @runnable action' unless action
     raise_on_action_absence @sub_commands
-    @init_method ||= MethodParser.new(@file_parser.initialize_method) if @file_parser.initialize_method
-    @method      = MethodParser.new action
-    [@init_method, @method].each do |method|
+    @initialize_method ||= MethodParser.new(@file_parser.initialize_method) if @file_parser.initialize_method
+    @method            = MethodParser.new action
+    [@initialize_method, @method].each do |method|
       next unless method
       method.trollop_opts.each { |a| @parser.opt(*a) }
       maybe_help(method.text, action.name.to_s)

data/lib/console_runner.rb

@@ -4,11 +4,12 @@ require 'console_runner/version'
 
 # console_runner logic is here
 module ConsoleRunner
+  SEPARATOR = '==================================='.freeze
   begin
-    start_time = Time.now
+    start_time     = Time.now
     success_status = true
-    puts "===================================
-    Start Time: #{start_time}".blue
+    puts "#{SEPARATOR}
+Start Time: #{start_time}".blue
 
     file_from_arg = ARGV.shift
     raise ConsoleRunnerError, 'Specify file to be executed' unless file_from_arg
@@ -27,19 +28,16 @@ module ConsoleRunner
     c_line_parser = CommandLineParser.new(file_parser)
     c_line_parser.run(action)
 
-
-    puts '======================================================='
-    puts 'Global options:'
-    if file_parser.initialize_method
-      puts "INIT: #{file_parser.initialize_method.name}"
-      puts 'INIT options:'
-      puts c_line_parser.init_method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
+    debug_message = "#{SEPARATOR}\n"
+    if c_line_parser.initialize_method
+      debug_message += ":initialize method:\n"
+      debug_message += c_line_parser.initialize_method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
     end
-    puts "Subcommand: #{action.name}"
-    puts 'Subcommand options:'
-    puts c_line_parser.method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
-    puts "Remaining arguments: #{ARGV.inspect}" if ARGV != []
-    puts '======================================================='
+    debug_message += "#{action.name} method:\n"
+    debug_message += c_line_parser.method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
+    debug_message +=  "Remaining arguments: #{ARGV.inspect}" if ARGV != []
+    debug_message += SEPARATOR
+    puts debug_message if CommandLineParser.debug?
 
 
     require file_path
@@ -53,7 +51,7 @@ module ConsoleRunner
       when :class
         klass_obj.send(action.name, *method_params)
       when :instance
-        init_method = c_line_parser.init_method
+        init_method = c_line_parser.initialize_method
         init_params = []
         init_params = init_method.params_array if init_method
         obj         = klass_obj.new(*init_params)
@@ -63,13 +61,13 @@ module ConsoleRunner
     end
   rescue => e
     success_status = false
-      raise e
+    raise e
   ensure
     finish_time = Time.now
-    status = success_status ? 'Success'.green : 'Error'.red
+    status      = success_status ? 'Success'.green : 'Error'.red
     puts 'Execution status: '.blue + status
-    puts "===================================
-    Finish Time: #{finish_time} (Duration: #{((finish_time - start_time) / 60).round(2) } minutes)
+    puts "#{SEPARATOR}
+Finish Time: #{finish_time} (Duration: #{((finish_time - start_time) / 60).round(2) } minutes)
 ".blue
   end
 end

data/lib/console_runner/version.rb

@@ -1,3 +1,3 @@
 module ConsoleRunner
-  VERSION = '0.1.17'
+  VERSION = '0.1.18'
 end

data/lib/console_runner_error.rb

@@ -1,8 +1,10 @@
 class ConsoleRunnerError < StandardError
 
-  unless ENV['DEBUG'].to_s == 'true'
-    def backtrace
+  def backtrace
+    if CommandLineParser.debug?
       @object
+    else
+      super
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Yury Karpovich