ruby_fire_cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 411d5d7472a24d6087de5f0df31c701a676814b6
+  data.tar.gz: 3fcd91eab2ef0d8069dbb7adf8f99149e93113ee
+SHA512:
+  metadata.gz: a4eeaf81c60544e5d850c23670df17663ab052b361acfd7208cd355bce55b242edc3f02ebb6e18d6babf6abae8abe47760a6dee84ac0a6853cbaf7df95fd0362
+  data.tar.gz: ef41d662bf9b68498e688a62f8e4e3e40de25e504ff17eb4963e0fa841ab10d82fc9598e22cd99479f398a3b098497b2a01b668a5d9596597691a0c2734d9d44

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: Zt5KZXhBj3awn9OS5Hy6pDuVEGSrWWSjT

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.idea/
+*.gem

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_fire_cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yury Karpovich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,238 @@
+# RubyFIreCLI
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+
+This gem automatically generating command line interfaces (CLIs) from Ruby object. No special code modifications required!.
+`ruby_fire_cli` is a smart mix of [YARD](http://yardoc.org/) and [Trollop](http://manageiq.github.io/trollop/) gems. 
+It's an analog of [Python Fire](https://github.com/google/python-fire) in Ruby language.  
+> 1. it parses [YARD](http://yardoc.org/) annotations of classes and methods to 'understand' your code
+> 2. it generates friendly unix-like help menu for your tool (using [Trollop](http://manageiq.github.io/trollop/) gem)
+> 3. it parses command-line input and run your Ruby code in a proper way 
+
+Just 4 simple steps to make your code runnable from terminal:
+1. Just add `@runnable` tag in 
+
+One thing you need to do is to add an [YARD](http://yardoc.org/) tag annotation `@runnable`.
+
+## Usage
+`ruby_fire_cli` extends [YARD](http://yardoc.org/) with a new tag: `@runnable`. You need to set this tag in a Class and Method annotation. After that it will be possible to call this method from command-line.
+Usage instructions are as simple as one, two, three:
+1. Add `@runnable` tag
+2. Now you can run your tool from terminal by `rcli /path/to/class.rb_file` command
+3. PROFIT! 
+
+### Example
+1. Install `ruby_fire_cli` gem
+2. Put some code to `/home/user/project/my_class.rb`
+```ruby
+# @runnable
+class MyClass
+
+    # @runnable
+    def say_hello
+      puts 'Hello!'
+    end
+    
+end
+```
+3. Run terminal command to run `say_hello` method
+```bash
+rcli /home/user/project/my_class.rb say_hello
+
+-> Hello!
+```
+
+Read FAQ for more examples.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_fire_cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_fire_cli
+
+## FAQ
+#### **Can I add documentation for my tool and customize help page content?**
+Yes. Any text placed after `@runnable` tag will be displayed on the help page. You can add any additional information about how to use your tool there.
+> **Tip**: You can use multi-line text as well
+
+##### Example:
+```ruby
+# @runnable This tool can talk to you. Run it when you are lonely.
+#   Written in Ruby.  
+class MyClass
+
+    def initialize
+      @hello_msg = 'Hello!' 
+      @bye_msg = 'Good Bye!' 
+    end
+    
+    # @runnable Say 'Hello' to you.
+    # @param [String] name Your name
+    def say_hello(name)
+      puts @hello_msg + ', ' + name
+    end
+    
+    # @runnable Say 'Good Bye' to you.
+    def say_bye
+      puts @bye_msg
+    end
+    
+end
+```
+
+```bash
+ ~> rcli /projects/example/my_class.rb  --help
+Options:
+  --debug    Run in debug mode.
+
+This tool can talk to you. Run it when you are lonely.
+Written in Ruby.
+
+Available actions:
+        - say_hello
+                Say 'Hello' to you.
+        - say_bye
+                Say 'Good Bye' to you.
+```
+
+```bash
+ ~> rcli /projects/example/my_class.rb  say_hello -h
+Options:
+  -d, --debug    Run in debug mode.
+  -h, --help     Show this message
+  --name=<s>     (Ruby class: String) Your name
+
+Say 'Hello' to you.
+
+```
+#### **Can I send parameters to my methods?**
+Yes, `ruby_fire_cli` parses YARD annotation (`@param` and `@option` tags) and check the list of parameters for your method.
+
+> *Restriction*: You can use Hash parameters as well (for storing options). But you cannot use the same name for parameter and for option. 
+> 
+> For example, `def limit(number, options = {number: 5})...` - `number` name is not allowed. You should use another parameter name.
+
+##### Example:
+```ruby
+# @runnable This tool can talk to you. Run it when you are lonely.
+#   Written in Ruby.  
+class MyClass
+
+    def initialize
+      @hello_msg = 'Hello' 
+      @bye_msg = 'Good Bye' 
+    end
+    
+    # @runnable Say 'Hello' to you.
+    # @param [String] name Your name
+    # @param [Hash] options options
+    # @option options [Boolean] :second_meet Have you met before?
+    # @option options [String] :prefix Your custom prefix
+    def say_hello(name, options = {})
+      second_meet = nil
+      second_meet = 'Nice to see you again!' if options['second_meet']
+      prefix = options['prefix']
+      message = @hello_msg + ', '
+      message += "#{prefix} " if prefix
+      message += "#{name}. "
+      message += second_meet if second_meet
+      puts message
+    end
+    
+end
+```
+```bash
+~> rcli /projects/example/my_class.rb  say_hello -h 
+Options:
+  -d, --debug      Run in debug mode.
+  -h, --help       Show this message
+  --name=<s>       (Ruby class: String) Your name
+  --second-meet    (Ruby class: Boolean) Have you met before?
+  --prefix=<s>     (Ruby class: String) Your custom prefix
+
+Say 'Hello' to you.
+```
+```bash
+~> rcli /projects/example/my_class.rb  say_hello -n John --second-meet --prefix Mr. 
+Hello, Mr. John. Nice to see you again!
+```
+
+#### **Can I use optional parameters?**
+Yes. All parameters with `@option` YARD tag are optional. 
+
+`--second-meet` and `--prefix` parameters are optional in the following example:
+```ruby
+# @runnable Say 'Hello' to you.
+    # @param [String] name Your name
+    # @param [Hash] options options
+    # @option options [Boolean] :second_meet Have you met before?
+    # @option options [String] :prefix Your custom prefix
+```
+Another approach is to use *default values* for parameters. 
+Parameter `--name` in the following example is optional because it has the default value `Chuck`.
+```ruby
+    # @runnable Say 'Hello' to you.
+    # @param [String] name Your name
+    # @param [Hash] options options
+    # @option options [Boolean] :second_meet Have you met before?
+    # @option options [String] :prefix Your custom prefix
+    def say_hello(name = 'Chuck', options = {})
+      second_meet = nil
+      second_meet = 'Nice to see you again!' if options['second_meet']
+      prefix = options['prefix']
+      message = @hello_msg + ', '
+      message += "#{prefix} " if prefix
+      message += "#{name}. "
+      message += second_meet if second_meet
+      puts message
+    end
+```
+```bash
+-> rcli /projects/example/my_class.rb  say_hello  
+Hello, Chuck. 
+```
+#### **Is it works only for class methods?**
+`ruby_fire_cli` works with both methods - **class** and **instance** methods. It's clear how it works with **class** method - method is called without any preconditions.
+**Instance** method will be called in accordance with following logic:
+ 1. call `:initialize` method 
+ 2. call specified action method
+
+#### **My `require` code doesn't work well. How can I fix it?**
+Use `require_relative ` method instead.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yuri-karpovich/ruby_fire_cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[Gem Version]: https://rubygems.org/gems/ruby_fire_cli
+[Build Status]: https://travis-ci.org/yuri-karpovich/ruby_fire_cli
+[travis pull requests]: https://travis-ci.org/yuri-karpovich/ruby_fire_cli/pull_requests
+[Code Climate]: https://codeclimate.com/github/yuri-karpovich/ruby_fire_cli
+[Coverage Status]: https://coveralls.io/github/yuri-karpovich/ruby_fire_cli
+
+[GV img]: https://badge.fury.io/rb/ruby_fire_cli.svg
+[BS img]: https://travis-ci.org/yuri-karpovich/ruby_fire_cli.svg?branch=master
+[CC img]: https://codeclimate.com/github/yuri-karpovich/ruby_fire_cli.png
+[CS img]: https://coveralls.io/repos/github/yuri-karpovich/ruby_fire_cli/badge.svg?branch=master

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ruby_fire_cli'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/console_runner.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_fire_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'ruby_fire_cli'
+  spec.version = RubyFireCLI::VERSION
+  spec.authors = ['Yury Karpovich']
+  spec.email   = %w(spoonest@gmail.com yuri.karpovich@gmail.com)
+
+  spec.summary     = 'Command-line runner for ruby code.'
+  spec.description = 'This gem provides you an ability to run any Ruby method ' \
+    'from command-line (no any code modifications required!!!)'
+  spec.homepage    = 'https://github.com/yuri-karpovich/ruby_fire_cli'
+  spec.license     = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = ['rcli']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_dependency 'trollop', '~> 2.1'
+  spec.add_dependency 'yard', '~> 0.9'
+  spec.add_dependency 'colorize', '~> 0.8'
+end

data/exe/rcli

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require_relative '../test/simple_cov' if ENV['rcliNER_SCOV'].to_s == 'true'
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'ruby_fire_cli'

data/lib/command_line_parser.rb

@@ -0,0 +1,92 @@
+require 'trollop'
+require 'method_parser'
+require 'colorize'
+
+# Parses command line and configure #Trollop
+class CommandLineParser
+  attr_reader :method, :initialize_method
+  @debug = false
+
+  # 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 }
+    @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
+    @parser.opt(:debug, 'Run in debug mode.', type: :flag)
+    @parser.stop_on @sub_commands
+    @initialize_method = nil
+  end
+
+  def self.debug?
+    @debug
+  end
+
+  def self.debug=(value)
+    return if @debug
+    ENV['CR_DEBUG'] = 'true'
+    @debug          = value
+  end
+
+  def tool_banner
+    result = FileParser.select_runnable_tags(@file_parser.clazz).map(&:text).join("\n")
+    result += "\n\nAvailable actions:\n"
+    result += @sub_commands_text.map do |c, text|
+      t = "\t- #{c}"
+      t += "\n\t\t#{text}" if text != ''
+      t
+    end.join("\n")
+    result
+  end
+
+  def maybe_help(banner, action_name = nil)
+    action = action_name
+    scope  = ARGV
+    if action_name
+      action_index = ARGV.index(action)
+      scope        = ARGV[0..action_index] if action_index
+    end
+    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 }
+    raise RubyFireCLIError, "You must provide one of available actions: #{sub_commands.join ', '}"
+  end
+
+  def run(action)
+    maybe_help(tool_banner, action ? action.name.to_s : nil)
+    raise RubyFireCLIError, 'Cannot find any @runnable action' unless action
+    raise_on_action_absence @sub_commands
+    @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)
+      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
+      end
+      method.required_parameters.each do |required_param|
+        next if method.options_group? required_param
+        next if method.cmd_opts[required_param.to_sym]
+        raise RubyFireCLIError, "You must specify required parameter: #{required_param}"
+      end
+      ARGV.shift
+    end
+  end
+
+end

data/lib/file_parser.rb

@@ -0,0 +1,114 @@
+require 'yard'
+require 'ruby_fire_cli_error'
+
+# Parses code in a file
+class FileParser
+  RUNNABLE_TAG = :runnable
+
+  attr_reader :clazz,
+              :runnable_methods,
+              :initialize_method,
+              :run_method
+
+  # Parse file with #YARD::CLI::Stats
+  #
+  # @param [String] file_path path to the file to be parsed
+  def initialize(file_path)
+    raise RubyFireCLIError "Cannot find file #{file_path}" unless File.exist?(file_path)
+    code = YARD::CLI::Stats.new
+    code.run(file_path)
+    @all_objects     = code.all_objects
+    runnable_classes = list_classes(:runnable)
+    raise RubyFireCLIError, 'At least one runnable Class should be specified in file' if runnable_classes.count != 1
+    @clazz             = runnable_classes.first
+    all_methods        = list_methods(:all, clazz)
+    @runnable_methods  = list_methods(:runnable, clazz)
+    @initialize_method = all_methods.find { |m| m.name == :initialize }
+    @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
+  # @param [Symbol] scope :all - list all methods, :runnable - list only runnable methods
+  # @param [YARD::CodeObjects::ClassObject, nil] clazz list methods of specified class only
+  # @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
+
+    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
+      else
+        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
+      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
+
+  # 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
+
+end
+
+# YARD::Tags::Library.define_tag "Run in Console", :runnable, :with_types_and_name
+YARD::Tags::Library.define_tag 'Console Tool Description', FileParser::RUNNABLE_TAG
+
+module YARD
+  module CLI
+    class Stats < Yardoc
+      def print_statistics;
+      end
+
+      def print_undocumented_objects;
+      end
+    end
+  end
+end

data/lib/method_parser.rb

@@ -0,0 +1,162 @@
+# Parses method code
+class MethodParser
+  attr_reader :method,
+              :name,
+              :text,
+              :parameters,
+              :param_tags, # All method parameters tags
+              :option_tags, # Only options tags
+              :trollop_opts,
+              :default_values,
+              :required_parameters
+
+  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
+  }.freeze
+
+  # @param [YARD::CodeObjects::MethodObject] method YARD method object to be parsed
+  def initialize(method)
+    @method              = method
+    @name                = @method.name
+    @text                = FileParser.select_runnable_tags(@method).map(&:text).join("\n")
+    @parameters          = @method.parameters
+    @default_values      = default_params
+    @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)
+    @cmd_opts            = nil
+    same_params          = param_tags_names & option_tags_names
+    unless same_params.count.zero?
+      raise(
+          RubyFireCLIError,
+          "You have the same name for @param and @option attribute(s): #{same_params.join(', ')}.
+Use different names to `ruby_fire_cli` be able to run #{@name} method."
+      )
+    end
+    @trollop_opts = prepare_opts_for_trollop
+  end
+
+  def prepare_opts_for_trollop
+    result = []
+    param_tags.each do |tag|
+      tag_name = tag.name
+      tag_text = tag.text
+      tag_type = tag.type
+      if tag_type == "Hash"
+        options = option_tags.select { |t| t.name == tag.name }
+        if options.count > 0
+          options.each do |option|
+            option_name = option.pair.name.delete(':')
+            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)
+            ]
+          end
+        else
+          result << [
+            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)
+        ]
+      end
+    end
+    result
+  end
+
+  def params_array
+    options_groups = {}
+    get_params     = {}
+    @parameters.map(&:first).map.with_index { |p, i| [i, p] }.to_h.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      = value.nil?
+      result      = value == {} if options_groups[index]
+      stop_delete = true unless result
+      next if stop_delete
+    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
+
+
+  private
+
+  def parse_type(yard_type)
+    result = TYPES_MAPPINGS[yard_type]
+    raise RubyFireCLIError, "Unsupported YARD type: #{yard_type}" unless result
+    result
+  end
+
+  # @return [Hash] default values for parameters
+  def default_params
+    @parameters.to_a.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
+
+  # @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/ruby_fire_cli.rb

@@ -0,0 +1,73 @@
+require 'file_parser'
+require 'command_line_parser'
+require 'ruby_fire_cli/version'
+
+# ruby_fire_cli logic is here
+module RubyFireCLI
+  CommandLineParser.debug = ARGV.any? { |a| %w(-d --debug).include? a }
+  SEPARATOR               = '==================================='.freeze
+  begin
+    start_time     = Time.now
+    success_status = true
+    puts "#{SEPARATOR}\nStart Time: #{start_time}\n#{SEPARATOR}".blue
+    file_from_arg = ARGV.shift
+    raise RubyFireCLIError, 'Specify file to be executed' unless file_from_arg
+    file_path      = File.realpath file_from_arg
+    file_parser    = FileParser.new(file_path)
+    next_arguments = ARGV.dup
+    %w(-d --debug -h --help).each { |a| next_arguments.delete a }
+    cmd     = next_arguments[0]
+    actions = file_parser.runnable_methods.select { |m| m.name.to_s == cmd }
+    if actions.count > 1
+      raise(
+          RubyFireCLIError,
+          "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)
+
+    debug_message = SEPARATOR
+    if c_line_parser.initialize_method
+      debug_message += "\ninitialize method execution\n"
+      debug_message += c_line_parser.initialize_method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
+    end
+    debug_message += "\n#{action.name} method execution\n"
+    debug_message += c_line_parser.method.cmd_opts.map { |k, v| "     #{k} = #{v}" }.join("\n")
+    debug_message += "\nRemaining arguments: #{ARGV.inspect}" if ARGV != []
+    debug_message += "\n#{SEPARATOR}"
+    puts debug_message if CommandLineParser.debug?
+
+    require file_path
+    class_full_name = file_parser.clazz.title
+    raise RubyFireCLIError, "#{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 = c_line_parser.method.params_array
+
+    case method_type
+      when :class
+        klass_obj.send(action.name, *method_params)
+      when :instance
+        init_method = c_line_parser.initialize_method
+        init_params = []
+        init_params = init_method.params_array if init_method
+        obj         = klass_obj.new(*init_params)
+        obj.send(action.name, *method_params)
+      else
+        raise RubyFireCLIError, "Unknown method type: #{method_type}"
+    end
+  rescue => e
+    success_status = false
+    raise e
+  ensure
+    finish_time = Time.now
+    status      = success_status ? 'Success'.green : 'Error'.red
+    puts "\n#{SEPARATOR}".blue
+    puts 'Execution status: '.blue + status
+    puts "Finish Time: #{finish_time} (Duration: #{((finish_time - start_time) / 60).round(2) } minutes)
+#{SEPARATOR}\n".blue
+  end
+end

data/lib/ruby_fire_cli/version.rb

@@ -0,0 +1,3 @@
+module RubyFireCLI
+  VERSION = '1.0.0'.freeze
+end

data/lib/ruby_fire_cli_error.rb

@@ -0,0 +1,11 @@
+class RubyFireCLIError < StandardError
+
+  def backtrace
+    if CommandLineParser.debug?
+      super
+    else
+      @object
+    end
+  end
+
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: ruby_fire_cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yury Karpovich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: This gem provides you an ability to run any Ruby method from command-line
+  (no any code modifications required!!!)
+email:
+- spoonest@gmail.com
+- yuri.karpovich@gmail.com
+executables:
+- rcli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- console_runner.gemspec
+- exe/rcli
+- lib/command_line_parser.rb
+- lib/file_parser.rb
+- lib/method_parser.rb
+- lib/ruby_fire_cli.rb
+- lib/ruby_fire_cli/version.rb
+- lib/ruby_fire_cli_error.rb
+homepage: https://github.com/yuri-karpovich/ruby_fire_cli
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Command-line runner for ruby code.
+test_files: []