console_runner 0.1.31 → 0.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: becac25f066c347b5251cae62e828e6d680a7ff7
-  data.tar.gz: 869470a975fd0887238a96ba2910a65ee664531e
+  metadata.gz: 0ad8a81a76873b3609f96f246f2fa9921bdfabb0
+  data.tar.gz: 510c5ee696731b32c5443fb1b9934e0b80761f08
 SHA512:
-  metadata.gz: 411ce109baeec14e087e73827b6170c49940972182f716e544696790e09b1b16eab530d62f189b31a20af5333aee1f897c4fd65747d9dca8bf227b71fbe51ba1
-  data.tar.gz: a89ed3c0453241a195255df922bad9066ab4cf562fed8767ce946ac74fe58a94a0a600bc35319c18b399cb09edc1ca7efa83d5b702749ae39412858f5ca2aa4c
+  metadata.gz: 7f0775041c7e1d50ac39df2a821ee98a2b6c53fe11cdcbdc0a97afe6a44ce998784220622f6687be33ad4bb74611bd6805a66adaf83758690ba779bb1fba8371
+  data.tar.gz: 6c35467b3d493e4f5ec1fac5513952d2a214b21da25fd207425af852cfe60b0c845f6cdbda51849283234e0b8729f42006da70c8b30559729bbbdca26dcee1b1

data/README.md

@@ -67,9 +67,10 @@ Or install it yourself as:
 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:**
+##### Example:
 ```ruby
 # @runnable This tool can talk to you. Run it when you are lonely.
+#   Written in Ruby.  
 class MyClass
 
     def initialize
@@ -78,8 +79,9 @@ class MyClass
     end
     
     # @runnable Say 'Hello' to you.
-    def say_hello
-      puts @hello_msg
+    # @param [String] name Your name
+    def say_hello(name)
+      puts @hello_msg + ', ' + name
     end
     
     # @runnable Say 'Good Bye' to you.
@@ -91,11 +93,124 @@ end
 ```
 
 ```bash
-TODO example
+ ~> c_run /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.
 ```
 
-## ToDo
-- fix help menu for action: action help text should be displayed, list of available actions should be displayed
+```bash
+ ~> c_run /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, `console_runner` 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
+~> c_run /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
+~> c_run /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
+-> c_run /projects/example/my_class.rb  say_hello  
+Hello, Chuck. 
+```
+#### **Is it works only for class methods?**
+`console_runner` works with both methods - class and instance methods. It's clear how it works with class method - method is called without any preconditions.
+Class method will be called in accordance with following logic:
+ 1. call `:initialize` method 
+ 2. cal action method
+
+#### **My `require` code doesn't work well. How can I fix it?**
+Use `require_relative ` method instead.
 
 ## Development
 

data/lib/command_line_parser.rb

@@ -76,7 +76,9 @@ class CommandLineParser
       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|
-        method.cmd_opts[k.to_sym] ||= 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

data/lib/console_runner/version.rb

@@ -1,3 +1,3 @@
 module ConsoleRunner
-  VERSION = '0.1.31'
+  VERSION = '0.1.32'
 end

metadata

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