console_runner 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3eeeb11fc8af9181f4f34e73958ec18bf239f573
-  data.tar.gz: 8ffe91d2115bcfd1cb0c8e1b952b4e9d92f4a113
+SHA256:
+  metadata.gz: dc2014166894d41a7a29fcecdbb09d715a26be5c626bf8f674b3cb0d6e7bf397
+  data.tar.gz: 734b4658c19fa4cbaa4dcca9669f3ea65c938d4a302d9ad8d198335afece95f4
 SHA512:
-  metadata.gz: 9e16be1daab6039f7741ca63d50e536337a935140a19cdd4705f588d1857af5847256ebdef7824a5ccc9d9e85a87d10a3d854bc6287b6f65991edad1fb7f98df
-  data.tar.gz: 4f808cfdbc2de11cc51e10f55f619e1f9975fed16a76f9fed71b897c1d9f0baa6efee70e0564259ebe1488c6dc51eaf2dbfa92be58f3582daea84c239c48f59e
+  metadata.gz: 55722733901c5424f0c194a29b8b9373b82be532dbe766c4eb0b09acf5cc386f949fa253540502f78c0b3dd5404b986049b8b895358e91031be5239b56e85e0d
+  data.tar.gz: 961eafb916dd30cc0513fc04f6dfcdf841fb4424ff3baa9b411e1f975b0a8f4cdce4541fe55edd7c5417789de04c3b734cee568e62eb69da9afec6719c92c441

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.5
-before_install: gem install bundler -v 1.13.6
+  - 2.5.1
+before_install: gem install bundler

data/console_runner.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.executables   = ['c_run']
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.5.1'
+
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'pry', '~> 0'

data/lib/command_line_parser.rb

@@ -4,7 +4,7 @@ require 'colorize'
 
 # Parses command line and configure #Optimist
 class CommandLineParser
-  attr_reader :method, :initialize_method
+  attr_reader :method, :initialize_method, :file_parser
   @debug = false
 
   # Generate tool help menu.
@@ -72,19 +72,44 @@ class CommandLineParser
       next unless method
       method.optimist_opts.each { |a| @parser.opt(*a) }
       maybe_help(method.text, action.name.to_s)
-      cmd_opts        = @parser.parse ARGV
-      given_attrs     = cmd_opts.keys.select { |k| k.to_s.include? '_given' }.map { |k| k.to_s.gsub('_given', '').to_sym }
-      method.cmd_opts = cmd_opts.select { |k, _| given_attrs.include? k }
-      method.default_values.each do |k, v|
-        param_name = k.to_sym
-        next if method.option_tags.map(&:name).include?(param_name.to_s)
-        method.cmd_opts[param_name] ||= v
+
+
+      # Read code defaults
+      # def droplet_create(name, region = 1, image = nil, size = nil, ssh_keys = nil)
+      argv_from_code_defaults = []
+      method.default_values.each do |k, param_value_from_code|
+        param_name_from_code = k.to_sym
+        next if method.option_tags.map(&:name).include?(param_name_from_code.to_s)
+        next if param_value_from_code == 'nil'
+
+        argv_from_code_defaults << "--#{param_name_from_code.to_s.gsub('_', '-')}"
+        argv_from_code_defaults << param_value_from_code
+      end
+      # Raise on constant found
+      constants = file_parser.constants
+      argv_from_code_defaults.map do |x|
+        existing_constant = constants.find { |c| c.name.to_s == x }
+        raise "Constants as default params values are not supported by console_runner: #{existing_constant.name}" if existing_constant
       end
+      parsed_code_default_args     = @parser.parse(argv_from_code_defaults)
+      params_names_from_code       = parsed_code_default_args.keys.select { |k| k.to_s.include? '_given' }.map { |k| k.to_s.gsub('_given', '').to_sym }
+      params_with_values_from_code = parsed_code_default_args.select { |k, _| params_names_from_code.include? k }
+      params_with_values_from_code.delete_if { |k, v| v == 'nil' }
+
+
+      parsed_cli_args            = @parser.parse ARGV
+      params_names_from_cl       = parsed_cli_args.keys.select { |k| k.to_s.include? '_given' }.map { |k| k.to_s.gsub('_given', '').to_sym }
+      params_with_values_from_cl = parsed_cli_args.select { |k, _| params_names_from_cl.include? k }
+
+
+      method.cmd_opts = params_with_values_from_code.merge(params_with_values_from_cl)
+      missed_params   = []
       method.required_parameters.each do |required_param|
         next if method.options_group? required_param
         next if method.cmd_opts[required_param.to_sym]
-        raise ConsoleRunnerError, "You must specify required parameter: #{required_param}"
+        missed_params << required_param
       end
+      raise ConsoleRunnerError, "You must specify required parameter: #{missed_params.join(', ')}" if missed_params.count.positive?
       ARGV.shift
     end
   end

data/lib/console_runner.rb

@@ -40,7 +40,7 @@ module ConsoleRunner
       c_line_parser.initialize_method.cmd_opts.map { |k, v| LOGGER.debug "\t#{k} = #{v}" }
     end
     LOGGER.debug "Executing ##{action.name} method..."
-    c_line_parser.method.cmd_opts.map { |k, v| LOGGER.debug  "\t#{k} = #{v}" }
+    c_line_parser.method.cmd_opts.map { |k, v| LOGGER.debug "\t#{k} = #{v}" }
     LOGGER.debug("Remaining arguments: #{ARGV.inspect}") if ARGV != []
     LOGGER.info SEPARATOR
 
@@ -75,6 +75,8 @@ module ConsoleRunner
       LOGGER.success 'Execution status: ' + status
     else
       LOGGER.error 'Execution status: ' + status
+      LOGGER.error e.message if e
+      LOGGER.error SEPARATOR
     end
 
   end

data/lib/console_runner/version.rb

@@ -1,3 +1,3 @@
 module ConsoleRunner
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/file_parser.rb

@@ -6,6 +6,7 @@ class FileParser
   RUNNABLE_TAG = :runnable
 
   attr_reader :clazz,
+              :constants,
               :runnable_methods,
               :initialize_method,
               :run_method
@@ -21,6 +22,7 @@ class FileParser
     runnable_classes = list_classes(:runnable)
     raise ConsoleRunnerError, 'At least one runnable Class should be specified in file' if runnable_classes.count != 1
     @clazz             = runnable_classes.first
+    @constants         = @clazz.constants
     all_methods        = list_methods(:all, clazz)
     @runnable_methods  = list_methods(:runnable, clazz)
     @initialize_method = all_methods.find { |m| m.name == :initialize }
@@ -47,20 +49,20 @@ class FileParser
     all_class_methods = clazz.children.select { |m| m.class == YARD::CodeObjects::MethodObject } if clazz
 
     case scope
-      when :all
-        if clazz
-          all_class_methods
-        else
-          all_methods
-        end
-      when RUNNABLE_TAG
-        if clazz
-          all_class_methods.select { |m| m.has_tag? RUNNABLE_TAG }
-        else
-          all_methods.select { |m| m.has_tag? RUNNABLE_TAG }
-        end
+    when :all
+      if clazz
+        all_class_methods
       else
-        raise ":scope can be :all or #{RUNNABLE_TAG}"
+        all_methods
+      end
+    when RUNNABLE_TAG
+      if clazz
+        all_class_methods.select { |m| m.has_tag? RUNNABLE_TAG }
+      else
+        all_methods.select { |m| m.has_tag? RUNNABLE_TAG }
+      end
+    else
+      raise ":scope can be :all or #{RUNNABLE_TAG}"
     end
   end
 
@@ -68,15 +70,15 @@ class FileParser
   #
   # @param [Symbol] scope :all - list all classes, :runnable - list only runnable classes
   # @return [Array(YARD::CodeObjects::ClassObject)]
-  def list_classes(scope= :all)
+  def list_classes(scope = :all)
     all_classes = @all_objects.select { |o| o.type == :class }
     case scope
-      when :all
-        all_classes
-      when RUNNABLE_TAG
-        all_classes.select { |m| m.has_tag? RUNNABLE_TAG }
-      else
-        raise ":scope can be :all or #{RUNNABLE_TAG}"
+    when :all
+      all_classes
+    when RUNNABLE_TAG
+      all_classes.select { |m| m.has_tag? RUNNABLE_TAG }
+    else
+      raise ":scope can be :all or #{RUNNABLE_TAG}"
     end
   end
 

data/lib/method_parser.rb

@@ -13,16 +13,16 @@ class MethodParser
   attr_accessor :cmd_opts
 
   TYPES_MAPPINGS = {
-    'String'         => :string,
-    'Integer'        => :int,
-    'Fixnum'         => :int,
-    'Float'          => :float,
-    'Boolean'        => :boolean,
-    'Array(String)'  => :strings,
-    'Array(Integer)' => :ints,
-    'Array(Fixnum)'  => :ints,
-    'Array(Float)'   => :floats,
-    'Array(Boolean)' => :booleans
+      'String'         => :string,
+      'Integer'        => :int,
+      'Fixnum'         => :int,
+      'Float'          => :float,
+      'Boolean'        => :boolean,
+      'Array(String)'  => :strings,
+      'Array(Integer)' => :ints,
+      'Array(Fixnum)'  => :ints,
+      'Array(Float)'   => :floats,
+      'Array(Boolean)' => :booleans
   }.freeze
 
   # @param [YARD::CodeObjects::MethodObject] method YARD method object to be parsed
@@ -31,16 +31,16 @@ class MethodParser
     @name                = @method.name
     @text                = FileParser.select_runnable_tags(@method).map(&:text).join("\n")
     @parameters          = @method.parameters
-    @default_values      = default_params
+    @default_values      = default_params.reject { |k, v| v.nil? }
     @param_tags          = FileParser.select_param_tags @method
     @option_tags         = FileParser.select_option_tags @method
-    @required_parameters = @param_tags.select { |t| t.tag_name == 'param' }.map(&:name)
+    @required_parameters = @param_tags.select { |t| t.tag_name == 'param' && !@default_values.keys.include?(t.name) }.map(&:name)
     @cmd_opts            = nil
     same_params          = param_tags_names & option_tags_names
     unless same_params.count.zero?
       raise(
-        ConsoleRunnerError,
-        "You have the same name for @param and @option attribute(s): #{same_params.join(', ')}.
+          ConsoleRunnerError,
+          "You have the same name for @param and @option attribute(s): #{same_params.join(', ')}.
 Use different names to `console_runner` be able to run #{@name} method."
       )
     end
@@ -61,23 +61,23 @@ Use different names to `console_runner` be able to run #{@name} method."
             option_text = option.pair.text
             option_type = option.pair.type
             result << [
-              option_name.to_sym,
-              "(Ruby class: #{option_type}) " + option_text.to_s,
-              type: parse_type(option_type)
+                option_name.to_sym,
+                "(Ruby class: #{option_type}) " + option_text.to_s,
+                type: parse_type(option_type)
             ]
           end
         else
           result << [
-            tag_name.to_sym,
-            "(Ruby class: #{tag_type}) " + tag_text.to_s,
-            type: parse_type(tag_type)
+              tag_name.to_sym,
+              "(Ruby class: #{tag_type}) " + tag_text.to_s,
+              type: parse_type(tag_type)
           ]
         end
       else
         result << [
-          tag_name.to_sym,
-          "(Ruby class: #{tag_type}) " + tag_text.to_s,
-          type: parse_type(tag_type)
+            tag_name.to_sym,
+            "(Ruby class: #{tag_type}) " + tag_text.to_s,
+            type: parse_type(tag_type)
         ]
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console_runner
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Yury Karpovich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -162,6 +162,7 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -190,7 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Command-line runner for ruby code.