console_runner 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92620ae23eba7d062d9302b75f3bf3f9b97d8b18
-  data.tar.gz: e7b17cb4a69c44f876315e2dbeaba1a87cf48a7d
+  metadata.gz: d0fdcaea27d9c7a47a33276fe97eaadb5063a1bb
+  data.tar.gz: f67cf5ec2116676fce4b14a7a8b4807f0a42fb17
 SHA512:
-  metadata.gz: 2efe3e3cdfe82eb5cecccac7a4a861efd59916824b7f1ea15da7df29a04265d0fccf596044311d2f4580ef9c22c6a7c8f9bd84abc638fdde41c127ffa89affdb
-  data.tar.gz: e179152ad9a70a59cce95f871a528077352a53b006d878c6c0bc3702fdcfac02183ab742938b094aea382f7c8547a6ce2dfb81af29931366ce2776b25967c307
+  metadata.gz: 50ff21a11dbb5b47c459807520468000c69c2279d426444a9a2d37376cf1d5695edbb5fd04253c9de4c3c059c28786491da6cbc4666f15778f5f4e09574731a3
+  data.tar.gz: 6dc150a981b78e4ff5d572efc948e92f179223f85196ea32a9cc4b370c7521bfc9c68e3db8ff646dea3e70f14dfcc0c5524f7546947a0486127ef690ccb6f64a

data/README.md

@@ -131,4 +131,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 [BS img]: https://travis-ci.org/yuri-karpovich/console_runner.svg?branch=master
 [DS img]: https://gemnasium.com/badges/github.com/yuri-karpovich/console_runner.svg
 [CC img]: https://codeclimate.com/github/yuri-karpovich/console_runner.png
-[CS img]: https://coveralls.io/repos/github/yuri-karpovich/console_runner/badge.svg
+[CS img]: https://coveralls.io/repos/github/yuri-karpovich/console_runner/badge.svg?branch=master

data/lib/cmd_parser.rb

@@ -1,95 +1,21 @@
 require 'trollop'
+require 'method_parser'
 
-# Parses command line
+# Parses command line and configure #Trollop
 class CmdParser
-
-  # Parses method code
-  class ParsedMethod
-    attr_reader :method, :name, :param_tags, :option_tags
-    attr_accessor :cmd_opts
-
-    def initialize(method)
-      @method      = method
-      @name        = @method.name
-      @parameters  = @method.parameters
-      @param_tags  = FileParser.select_param_tags @method
-      @option_tags = FileParser.select_option_tags @method
-      @cmd_opts    = nil
-    end
-
-    def params_array
-      expected_params = @parameters.map(&:first).map.with_index { |p, i| [i, p] }.to_h
-      options_groups  = {}
-      get_params      = {}
-
-      expected_params.each do |index, name|
-        if options_group?(name)
-          options_groups[index] = name
-          get_params[index]     = option_as_hash(name)
-        else
-          get_params[index] = @cmd_opts[name.to_sym]
-        end
-      end
-      get_params = get_params.to_a.sort_by { |a| a[0] }.reverse
-
-      stop_delete = false
-      get_params.delete_if do |a|
-        index  = a[0]
-        value  = a[1]
-        result = false
-
-        if options_groups[index]
-          result = value == {}
-        else
-          result = value == nil
-        end
-        stop_delete = true unless result
-        next if stop_delete
-        result
-      end
-
-      get_params.sort_by { |a| a[0] }.map { |a| a[1] }
-    end
-
-    def param_tags_names
-      param_tags.map { |t| t.name }
-    end
-
-    def option_tags_names
-      option_tags.map { |t| t.pair.name.gsub(':', '') }
-    end
-
-    def options_group?(param_name)
-      option_tags.any? { |t| t.name == param_name }
-    end
-
-    def default_params
-      @parameters.map do |array|
-        array.map do |a|
-          if a
-            ['"', "'"].include?(a[0]) && ['"', "'"].include?(a[-1]) ? a[1..-2] : a
-          else
-            a
-          end
-        end
-      end.to_h
-    end
-
-    private
-
-    def option_as_hash(options_group_name)
-      result = {}
-      option_tags.select { |t| t.name == options_group_name }.each do |t|
-        option_name         = t.pair.name.gsub(':', '')
-        option_value        = @cmd_opts[option_name.to_sym]
-        result[option_name] = option_value if option_value
-      end
-      result
-    end
-  end
-
   attr_reader :global_opts, :method, :init_method
-
+  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
+  }.freeze
   # Should be executed before ARGV.shift
   def initialize(runnable_methods, init_method= nil)
     clazz        = runnable_methods.first.parent
@@ -99,7 +25,7 @@ class CmdParser
     @parser.stop_on sub_commands
 
     if init_method
-      @init_method = ParsedMethod.new init_method
+      @init_method = MethodParser.new init_method
       same_methods = @init_method.param_tags_names & @init_method.option_tags_names
       raise "You have the same name for @param and @option attribute(s): #{same_methods.join(', ')}.
 Use different names to `console_runner` be able to run #{@init_method.name} method." if same_methods.count > 0
@@ -113,7 +39,7 @@ Use different names to `console_runner` be able to run #{@init_method.name} meth
           options = option_tags.select { |t| t.name == tag.name }
           if options.count > 0
             options.each do |option|
-              option_name = option.pair.name.gsub(':', '')
+              option_name = option.pair.name.delete(':')
               option_text = option.pair.text
               option_type = option.pair.type
               @parser.opt(option_name.to_sym, "(Ruby class: #{option_type}) " + option_text.to_s, type: CmdParser.parse_type(option_type))
@@ -138,14 +64,14 @@ Use different names to `console_runner` be able to run #{@init_method.name} meth
 
     if @init_method
       given_attrs           = @global_opts.keys.select { |k| k.to_s.include? '_given' }.map { |k| k.to_s.gsub('_given', '').to_sym }
-      @init_method.cmd_opts = @global_opts.select { |k, v| given_attrs.include? k }
+      @init_method.cmd_opts = @global_opts.select { |k, _| given_attrs.include? k }
     end
   end
 
-
+  # Parse method and configure #Trollop
   def parse_method(method)
     ARGV.shift
-    @method      = ParsedMethod.new method
+    @method      = MethodParser.new method
     same_methods = @method.param_tags_names & @method.option_tags_names
     raise "You have the same name for @param and @option attribute(s): #{same_methods.join(', ')}.
 Use different names to `console_runner` be able to run #{@method.name} method." if same_methods.count > 0
@@ -159,7 +85,7 @@ Use different names to `console_runner` be able to run #{@method.name} method."
         options = @method.option_tags.select { |t| t.name == tag.name }
         if options.count > 0
           options.each do |option|
-            option_name = option.pair.name.gsub(':', '')
+            option_name = option.pair.name.delete(':')
             option_text = option.pair.text
             option_type = option.pair.type
             @parser.opt(option_name.to_sym, "(Ruby class: #{option_type}) " + option_text.to_s, type: CmdParser.parse_type(option_type))
@@ -179,7 +105,7 @@ Use different names to `console_runner` be able to run #{@method.name} method."
       @parser.parse ARGV
     end
     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, v| given_attrs.include? k }
+    @method.cmd_opts = cmd_opts.select { |k, _| given_attrs.include? k }
     @method.default_params.each do |k, v|
       @method.cmd_opts[k.to_sym] ||= v
     end
@@ -193,30 +119,9 @@ Use different names to `console_runner` be able to run #{@method.name} method."
   end
 
   def self.parse_type(yard_type)
-    case yard_type
-      when 'String'
-        :string
-      when 'Integer'
-        :int
-      when 'Fixnum'
-        :int
-      when 'Float'
-        :float
-      when 'Boolean'
-        :boolean
-      when 'Array(String)'
-        :strings
-      when 'Array(Integer)'
-        :ints
-      when 'Array(Fixnum)'
-        :ints
-      when 'Array(Float)'
-        :floats
-      when 'Array(Boolean)'
-        :booleans
-      else
-        raise "Unsupported YARD type: #{yard_type}"
-    end
+    result = TYPES_MAPPINGS[yard_type]
+    raise "Unsupported YARD type: #{yard_type}" unless result
+    result
   end
 
 end

data/lib/console_runner/version.rb

@@ -1,3 +1,3 @@
 module ConsoleRunner
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/lib/console_runner.rb

@@ -1,13 +1,13 @@
-module ConsoleRunner
+require 'file_parser'
+require 'cmd_parser'
+require 'runner'
+require 'console_runner/version'
 
-  require 'file_parser'
-  require 'cmd_parser'
-  require 'runner'
 
+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
-  raise ConsoleRunnerError, "File doesn't exist: #{file_path}" unless File.exist? file_path
+  file_path   = File.realpath file_from_arg
   file_parser = FileParser.new(file_path)
 
 
@@ -59,7 +59,9 @@ Runnable class should be marked with @#{FileParser::RUNNABLE_TAG} tag"
       when :class
         klass_obj.send(action_method.name, *method_params)
       when :instance
-        init_params = cmd_parser.init_method.params_array
+        init_method = cmd_parser.init_method
+        init_params = []
+        init_params = init_method.params_array if init_method
         # TODO catch errors
         obj         = klass_obj.new(*init_params)
         obj.send(action_method.name, *method_params)

data/lib/file_parser.rb

@@ -1,17 +1,16 @@
 require 'yard'
-require 'console_runner/version'
 require 'console_runner_error'
 
 # Parses code in a file
 class FileParser
-  attr_reader :all_objects
-
   RUNNABLE_TAG = :runnable
 
+  attr_reader :all_objects
+
   # Parse file with #YARD::CLI::Stats
   #
-  # @param [String] file_path path to the file to be parsed,
-  # @return[Array]
+  # @param [String] file_path path to the file to be parsed
+  # @return[Array(YARD::CodeObjects)] array of #YARD::CodeObjects classes
   def initialize(file_path)
     raise ConsoleRunnerError "Cannot find file #{file_path}" unless File.exist?(file_path)
     code = YARD::CLI::Stats.new
@@ -19,11 +18,11 @@ class FileParser
     @all_objects = code.all_objects
   end
 
-
-  # List methods
+  # List of methods
   # @param [Symbol] scope :all - list all methods, :runnable - list only runnable methods
   # @param [YARD::CodeObjects::ClassObject, nil] clazz list methods of specified class only
-  def list_methods(scope= :all, clazz = nil)
+  # @return [Array(YARD::CodeObjects::MethodObject)]
+  def list_methods(scope = :all, clazz = nil)
     all_methods       = @all_objects.select { |o| o.type == :method }
     all_class_methods = []
     all_class_methods = clazz.children.select { |m| m.class == YARD::CodeObjects::MethodObject } if clazz
@@ -42,12 +41,14 @@ class FileParser
           all_methods.select { |m| m.has_tag? RUNNABLE_TAG }
         end
       else
-        raise ":key can be :all or #{RUNNABLE_TAG}"
+        raise ":scope can be :all or #{RUNNABLE_TAG}"
     end
   end
 
   # List classes
+  #
   # @param [Symbol] scope :all - list all classes, :runnable - list only runnable classes
+  # @return [Array(YARD::CodeObjects::ClassObject)]
   def list_classes(scope= :all)
     all_classes = @all_objects.select { |o| o.type == :class }
     case scope
@@ -56,18 +57,30 @@ class FileParser
       when RUNNABLE_TAG
         all_classes.select { |m| m.has_tag? RUNNABLE_TAG }
       else
-        raise ':key can be :all or :runnable'
+        raise ":scope can be :all or #{RUNNABLE_TAG}"
     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
+  # @return [Array(YARD::Tags::Tag)]
   def self.select_option_tags(yard_object)
     yard_object.tags.select { |t| t.tag_name == 'option' }
   end
 
+  # Select all @param tags from of specified object
+  #
+  # @param [YARD::CodeObjects::MethodObject, YARD::CodeObjects::ClassObject] yard_object YARD object
+  # @return [Array(YARD::Tags::Tag)]
   def self.select_param_tags(yard_object)
     yard_object.tags.select { |t| t.tag_name == 'param' }
   end
@@ -85,4 +98,4 @@ module YARD
       def print_undocumented_objects; end
     end
   end
-end
+end

data/lib/method_parser.rb

@@ -0,0 +1,99 @@
+# Parses method code
+class MethodParser
+  attr_reader :method,
+              :name,
+              :param_tags,    # All method parameters tags
+              :option_tags    # Only options tags
+
+  attr_accessor :cmd_opts
+
+  # @param [YARD::CodeObjects::MethodObject] method YARD method object to be parsed
+  def initialize(method)
+    @method      = method
+    @name        = @method.name
+    @parameters  = @method.parameters
+    @param_tags  = FileParser.select_param_tags @method
+    @option_tags = FileParser.select_option_tags @method
+    @cmd_opts    = nil
+  end
+
+  # Prepare
+  def params_array
+    expected_params = @parameters.map(&:first).map.with_index { |p, i| [i, p] }.to_h
+    options_groups  = {}
+    get_params      = {}
+
+    expected_params.each do |index, name|
+      if options_group?(name)
+        options_groups[index] = name
+        get_params[index]     = option_as_hash(name)
+      else
+        get_params[index] = @cmd_opts[name.to_sym]
+      end
+    end
+    get_params = get_params.to_a.sort_by { |a| a[0] }.reverse
+
+    stop_delete = false
+    get_params.delete_if do |a|
+      index  = a[0]
+      value  = a[1]
+      result = false
+
+      if options_groups[index]
+        result = value == {}
+      else
+        result = value == nil
+      end
+      stop_delete = true unless result
+      next if stop_delete
+      result
+    end
+
+    get_params.sort_by { |a| a[0] }.map { |a| a[1] }
+  end
+
+
+  # @return [Array(String)] Names of parameters
+  def param_tags_names
+    param_tags.map(&:name)
+  end
+
+  # @return [Array(String)] Names of options
+  def option_tags_names
+    option_tags.map { |t| t.pair.name.delete(':') }
+  end
+
+  # Check if the name is an option
+  #
+  # @param [String] param_name name of parameter to be verified
+  # @return [Boolean] true if current parameter name is an option key
+  def options_group?(param_name)
+    option_tags.any? { |t| t.name == param_name }
+  end
+
+  # @return [Hash] default values for parameters
+  def default_params
+    @parameters.map do |array|
+      array.map do |a|
+        if a
+          ['"', "'"].include?(a[0]) && ['"', "'"].include?(a[-1]) ? a[1..-2] : a
+        else
+          a
+        end
+      end
+    end.to_h
+  end
+
+  private
+
+  # @return [Hash] options parameter as Hash
+  def option_as_hash(options_group_name)
+    result = {}
+    option_tags.select { |t| t.name == options_group_name }.each do |t|
+      option_name         = t.pair.name.delete(':')
+      option_value        = @cmd_opts[option_name.to_sym]
+      result[option_name] = option_value if option_value
+    end
+    result
+  end
+end

data/lib/runner.rb

@@ -1,6 +1,6 @@
 module Runner
 
-  def self.run &block
+  def self.run
     start_time = Time.now
     puts "Start Time: #{start_time}"
     Thread.current[:id] = 'main'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Yury Karpovich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - lib/console_runner/version.rb
 - 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: