console_runner 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e60a3b7f4eac3e952a5d3e75fccd3e257253721
-  data.tar.gz: 10098a2cdeb54901b0f3b191b9ad0fadf9d0868c
+  metadata.gz: 39d8e37c222218501547763179826453d99b5208
+  data.tar.gz: 2cdc022889b7ce2bfa05ed217b4fa77a333ec5a4
 SHA512:
-  metadata.gz: 3c14f4e5dd3c23510073f83e5afc77293e6136d62586c40d9d96e67ddb06ebcb6b2c7dd69837a62872b1b97345f618704012ef3bc591c5146a7e93f39acbeace
-  data.tar.gz: 5c523a463ef96312d304e7b1d98886545ed1a83aaed01a58eb18436e94c910c5c32eacb49b0531c5c43a011514a39827e32f517ac9691ae271091b186a7b767b
+  metadata.gz: 581eca4768176a9458c70cde0e670b187cb0462215ef7d94cf9165f88efc7bac233a5d87e8a1b1c8b922d5d67acd1e389c8d9185c440392dfc35567ebae90044
+  data.tar.gz: 6127da22aeeb5bf37d8b0a65e697d5b82325e7be977683274f9c927aede4198fc18177256ecb41e95642b228d5a24912eeb447cdcd5e7abf1d0fcab328f2a6df

data/lib/command_line_parser.rb

@@ -8,23 +8,43 @@ class CommandLineParser
   # Generate tool help menu.
   # IMPORTANT! Should be executed before ARGV.shift
   def initialize(file_parser)
-    @file_parser  = file_parser
-    @sub_commands = @file_parser.runnable_methods.map { |m| m.name.to_s }
-    @parser       = Trollop::Parser.new
-    @parser.banner(FileParser.select_runnable_tags(@file_parser.clazz).map { |t| (t.text + "\n") }.join("\n"))
+    @file_parser       = file_parser
+    @sub_commands      = @file_parser.runnable_methods.map { |m| m.name.to_s }
+    @sub_commands_text = @file_parser.runnable_methods.map do |m|
+      [
+        m.name.to_s,
+        FileParser.select_runnable_tags(m).map(&:text).join("\n")
+      ]
+    end.to_h
+    @parser            = Trollop::Parser.new
+    @banner            = generate_banner
     @parser.stop_on @sub_commands
+    @init_method = nil
   end
 
-  def run(action)
-    if %w(-h --help).include?(ARGV[0].strip)
+  def generate_banner
+    result = FileParser.select_runnable_tags(@file_parser.clazz).map(&:text).join("\n")
+    result += "\n\n\tAvailable actions:\n"
+    result += @sub_commands_text.map do |c, text|
+      t = "\t\t- #{c}"
+      t += "\n\t\t\t#{text}" if text != ''
+      t
+    end.join("\n")
+    @parser.banner(result)
+    result
+  end
+
+  def raise_help
+    if %w(-h --help).include?(ARGV[0].to_s.strip)
       Trollop::with_standard_exception_handling(@parser) { raise Trollop::HelpNeeded }
     end
-    unless @sub_commands.include?(ARGV[0].strip)
-      raise ConsoleRunnerError, "You must provide one of available actions: #{@sub_commands.join ', '}"
-    end
+    return if @sub_commands.include?(ARGV[0].to_s.strip)
+    raise ConsoleRunnerError, "You must provide one of available actions: #{@sub_commands.join ', '}"
+  end
 
-    @init_method = nil
-    @init_method = MethodParser.new(@file_parser.initialize_method) if @file_parser.initialize_method
+  def run(action)
+    raise_help
+    @init_method ||= MethodParser.new(@file_parser.initialize_method) if @file_parser.initialize_method
     @method      = MethodParser.new action
     [@init_method, @method].each do |method|
       next unless method
@@ -42,9 +62,8 @@ class CommandLineParser
       end
       method.required_parameters.each do |required_param|
         next if method.options_group? required_param
-        unless method.cmd_opts[required_param.to_sym]
-          raise ConsoleRunnerError, "You must specify required parameter: #{required_param}"
-        end
+        next if method.cmd_opts[required_param.to_sym]
+        raise ConsoleRunnerError, "You must specify required parameter: #{required_param}"
       end
       ARGV.shift
     end

data/lib/console_runner.rb

@@ -1,55 +1,58 @@
 require 'file_parser'
 require 'command_line_parser'
-require 'runner'
 require 'console_runner/version'
 
 # console_runner logic is here
 module ConsoleRunner
-  file_from_arg = ARGV.shift
-  raise ConsoleRunnerError, 'Specify file to be executed' unless file_from_arg
-  file_path   = File.realpath file_from_arg
-  file_parser = FileParser.new(file_path)
-  cmd         = ARGV[0]
-  actions     = file_parser.runnable_methods.select { |m| m.name.to_s == cmd }
-  if actions.count > 1
-    raise(
-      ConsoleRunnerError,
-      "Class and Instance methods have the same name (#{cmd}). Actions names should be unique"
-    )
-  end
-  action      = actions.first
-  action      ||= file_parser.run_method
-  trol_config = CommandLineParser.new(file_parser)
-  trol_config.run(action)
+  begin
+    start_time = Time.now
+    success_status = true
+    puts "Start Time: #{start_time}"
+
+    file_from_arg = ARGV.shift
+    raise ConsoleRunnerError, 'Specify file to be executed' unless file_from_arg
+    file_path   = File.realpath file_from_arg
+    file_parser = FileParser.new(file_path)
+    cmd         = ARGV[0]
+    actions     = file_parser.runnable_methods.select { |m| m.name.to_s == cmd }
+    if actions.count > 1
+      raise(
+        ConsoleRunnerError,
+        "Class and Instance methods have the same name (#{cmd}). Actions names should be unique"
+      )
+    end
+    action        = actions.first
+    action        ||= file_parser.run_method
+    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 trol_config.init_method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
-  end
-  puts "Subcommand: #{action.name}"
-  puts 'Subcommand options:'
-  puts trol_config.method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
-  puts "Remaining arguments: #{ARGV.inspect}" if ARGV != []
-  puts '======================================================='
+    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")
+    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 '======================================================='
 
 
-  Runner.run {
     require file_path
     class_full_name = file_parser.clazz.title
     raise ConsoleRunnerError, "#{class_full_name} is not defined" unless Module.const_defined?(class_full_name)
     klass_obj     = Module.const_get(class_full_name)
     method_type   = action.scope
-    method_params = trol_config.method.params_array
+    method_params = c_line_parser.method.params_array
 
     case method_type
       when :class
         klass_obj.send(action.name, *method_params)
       when :instance
-        init_method = trol_config.init_method
+        init_method = c_line_parser.init_method
         init_params = []
         init_params = init_method.params_array if init_method
         obj         = klass_obj.new(*init_params)
@@ -57,7 +60,12 @@ module ConsoleRunner
       else
         raise ConsoleRunnerError, "Unknown method type: #{method_type}"
     end
-
-  }
-
+  rescue => e
+    success_status = false
+      raise e
+  ensure
+    finish_time = Time.now
+    puts "Execution status: #{success_status ? 'Success' : 'Error' }"
+    puts "Finish Time: #{finish_time} (Duration: #{((finish_time - start_time) / 60).round(2) } minutes)"
+  end
 end

data/lib/console_runner/version.rb

@@ -1,3 +1,3 @@
 module ConsoleRunner
-  VERSION = '0.1.13'
+  VERSION = '0.1.14'
 end

data/lib/console_runner_error.rb

@@ -1 +1,9 @@
-class ConsoleRunnerError < Exception; end
+class ConsoleRunnerError < StandardError
+
+  unless ENV['DEBUG'].to_s == 'true'
+    def backtrace
+      @object
+    end
+  end
+
+end

data/lib/file_parser.rb

@@ -27,6 +27,14 @@ class FileParser
     @run_method        = all_methods.find { |m| m.name == :run }
   end
 
+  # Select all @runnable tags from of specified object
+  #
+  # @param [YARD::CodeObjects::MethodObject, YARD::CodeObjects::ClassObject] yard_object YARD object
+  # @return [Array(YARD::Tags::Tag)]
+  def self.select_runnable_tags(yard_object)
+    yard_object.tags.select { |t| t.tag_name == RUNNABLE_TAG.to_s }
+  end
+
   private
 
   # List of methods
@@ -72,14 +80,6 @@ class FileParser
     end
   end
 
-  # Select all @runnable tags from of specified object
-  #
-  # @param [YARD::CodeObjects::MethodObject, YARD::CodeObjects::ClassObject] yard_object YARD object
-  # @return [Array(YARD::Tags::Tag)]
-  def self.select_runnable_tags(yard_object)
-    yard_object.tags.select { |t| t.tag_name == RUNNABLE_TAG.to_s }
-  end
-
   # Select all @option tags from of specified object
   #
   # @param [YARD::CodeObjects::MethodObject, YARD::CodeObjects::ClassObject] yard_object YARD object

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Yury Karpovich
@@ -163,7 +163,6 @@ files:
 - lib/console_runner_error.rb
 - lib/file_parser.rb
 - lib/method_parser.rb
-- lib/runner.rb
 homepage: https://github.com/yuri-karpovich/console_runner
 licenses:
 - MIT

data/lib/runner.rb

@@ -1,21 +0,0 @@
-module Runner
-
-  def self.run
-    start_time = Time.now
-    puts "Start Time: #{start_time}"
-    Thread.current[:id] = 'main'
-
-    yield
-
-    trap 'SIGCHLD' do
-      loop do
-        pid = Process.waitpid(-1, Process::WNOHANG) rescue nil
-        break unless pid
-      end
-    end
-
-    finish_time = Time.now
-    puts "Finish Time: #{finish_time} (Duration: #{((finish_time - start_time) / 60).round(2) } minutes)"
-  end
-
-end