console_runner 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 536a22f5c750f346fc7688315a6c309a36a3af1c
-  data.tar.gz: b5466496a8650cd2b9c5ec8d4b73bb46e18a870f
+  metadata.gz: dfc0511852127d604ae309cfc39364d21107e0b6
+  data.tar.gz: 4aad476abc1e57409be5b61925deacc2e30b4354
 SHA512:
-  metadata.gz: c5df1a7e4eda87dafbb436f4e1aadc6ef562d58529b8eedeed9713ac8a6f9ce29a8cab33f51562b9a09b984b0564ff4d32a1a6b4797bf57dff7255aafc493c8e
-  data.tar.gz: 5ed013791df3f7a7dd0b0efbe1cd6614b956899fb0508c572bef1bcde52c830b6e46e0b23716ef6e302d5fbc4714010e28993f99e8d4346f0a56b2d020387b10
+  metadata.gz: 7c8ce2344ea0ed28c89a0df3c3d46adc04b1a6eda040c39a6b6264e3729a78dc06ad8eec97e7ac29672aaa24a11d9ad7767f0b7ab4eb7a875b46325bc7272064
+  data.tar.gz: 71373f02f65eec0cecf438eb72d4f33bd7c09bb076d7509e7df2ff5dad612b91babbce3d408e321e8afec1c14c6839f421b0108c318ef8cf5998db84ae6fd28b

data/README.md

@@ -25,8 +25,85 @@ Or install it yourself as:
     $ gem install console_runner
 
 ## Usage
+Usage is simple. First of all you need to add `gem 'console_runner'` in your `Gemfile`.
+Then you need to specify `@runnable` tag in your class and method annotations. For example,
+ 
+```ruby
+# This is basic Ruby class with YARD annotation.
+# Nothing special here except @runnable tag. This is a `console_runner` tag that
+# shows that this class can be runnable via bash command line.
+#
+# You can mark any method (class method or instance method) with @runnable tag to show you want the method to be executable.
+# We name class method as *class action* and instance method as *instance action* or just *action*.
+# Instance action requires #initialize method to be executed first. `console_runner` tool invokes #initialize
+# method automatically.
+#
+# @author Yuri Karpovich
+#
+# @runnable This is your "smart" assistant tool.
+#   NOTE: This message will be shown in your tool in --help menu.
+#
+# @since 0.1.0
+class SimpleSiri
+
+  def initialize
+    @name = 'Siri'
+    @age = Random.rand 100
+  end
+
+  # Say something
+  #
+  # @runnable
+  # @return [String]
+  # @param [String] what_to_say ask name or age of Siri
+  def say(what_to_say)
+    case what_to_say.downcase
+      when 'name'
+        puts 'My name is ' + @name
+      when 'age'
+        puts "I'm #{@age} years old"
+      else
+        puts "I don't know".green
+    end
+  end
+
+end
+```
+
+Then you can run the tool in your console:
+```bash
+c_run ruby_class.rb say --help
+
+This is your "smart" assistant tool.
+NOTE: This message will be shown in your tool in --help menu.
+  -h, --help               Show this message
+  -w, --what-to-say=<s>    (Ruby class: String) ask name or age of Siri
+```
+
+```bash
+ c_run ruby_class.rb say -w age
+ 
+=======================================================
+Global options:
+     help = false
+INIT: initialize
+INIT options:
+
+Subcommand: say
+Subcommand options:
+     what_to_say = age
+=======================================================
+Start Time: 2017-04-11 21:39:40 +0300
+I'm 78 years old
+Finish Time: 2017-04-11 21:39:40 +0300 (Duration: 0.0 minutes)
+
+```
 
-TODO: Write usage instructions here
+## ToDo
+- fix help menu for action: action help text should be displayed.
+- add tests for class actions
+- add tests for same methods naming
+- write good readme
 
 ## Development
 

data/lib/console_runner/version.rb

@@ -1,3 +1,3 @@
 module ConsoleRunner
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

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