luban-cli 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83a10043132409c7e0d1bf93e9543307a4810cbe
-  data.tar.gz: 9d8f68f187e40c65457e8146cfb8b09adf5c1fa6
+  metadata.gz: 5e7c0fc5fe7b473f10f9eeb1ea5b3077b4036754
+  data.tar.gz: 9a1e0c3cd85467992f749f48dc1386419c3ce1ea
 SHA512:
-  metadata.gz: 2e595eb672e72a9668f49dec03a3b92a09e97c214f1d5911bd9c6a0e237796c1b65ce3a5d0321daa51ef5702aa93b058ef0ac8f5bb1aeb0e53d4f3de25360ae4
-  data.tar.gz: 1345813a8edbe2e4168971df568a4a9444f1893dee73e0e0188bda87d15b7952a85ae1479298b98fbd87db01c33ba156edc31af47260bb8bce0010c8b4a07fed
+  metadata.gz: 6bb0b97497b42f8061fa4a88043deef23129ab8969a0c412b1eab7de0ea1949f2865702477f50fbb51ab2085ee35c6f019347b340b9b8d7424e0530edeb54905
+  data.tar.gz: 86eebc55192192cffa51ee3551277e5e68d9e00cfc533e1497e641311dbe1d430941284574eeb5d59e072f373f8c9e49092278224dc741df27a4a0ef6d7997ea

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## Version 0.4.7 (Sept 28, 2016)
+
+Minor enhancements:
+  * Updated README with description for tasks
+
+Bug fixes:
+  * Properly handled any remaining command line arguments to opts[:__remaining__] when action method does not removes command line arguments destructively
+
 ## Version 0.4.6 (Sept 27, 2016)
 
 New features:

data/README.md

@@ -481,6 +481,64 @@ end
 
 DSL method #auto_help_command is used to define a command to list all commands or help for one command. Under rare circumstances that you need to customize the help command (i.e., use a different command name like :manual), you can use DSL method #help_command which accepts the same parameters that for #command. 
 
+### Tasks
+
+A task is a special command that supports common options shared among other tasks, and usually it is the last command in a command chain. 
+
+In a typical use case, all commands have a set of common options in addition to their own. Tasks can be defined to solve this issue in a DRY way with an instance method, #add_common_task_options, in where the common options are defined. Here is a simple example demonstrating the usage of tasks: 
+
+```ruby
+require 'luban/cli'
+
+class MyApp < Luban::CLI::Application
+  configure do
+    version '1.0.0'
+    desc 'Short description for the application'
+    long_desc 'Long description for the application'
+
+    command :tasks do
+      desc 'Description for tasks'
+
+      task :task1 do
+        desc 'Description for task 1'
+        argument :arg1, 'Description for arg1', type: :string
+        action :exec_tasks_task1
+      end
+
+      task :task2 do
+        desc 'Description for task 2'
+        option :opt1, 'Description for opt1', type: :integer
+        action :exec_tasks_task2
+      end
+    end
+  end
+
+  def exec_tasks_task1(**params)
+    puts params.inspect
+  end
+
+  def exec_tasks_task2(**params)
+    puts params.inspect
+  end
+
+  protected
+
+  def add_common_task_options(task)
+    task.switch :dry_run, "Run as a simulation", short: :d
+    task.switch :verbose, "Turn on verbose mode", short: :V
+  end
+end
+
+MyApp.start
+
+$ ruby my_app.rb tasks task1 arg1 -d -V
+{:args=>{:arg1=>"arg1"}, :opts=>{:help=>nil, :dry_run=>true, :verbose=>true, :__remaining__=>[]}}
+
+$ ruby my_app.rb tasks task2 -d
+{:args=>{}, :opts=>{:opt1=>nil, :help=>nil, :dry_run=>true, :verbose=>nil, :__remaining__=>[]}}
+
+```
+
 ### Command injection
 
 Commands can be defined directly within the Luban app class like examples shown in the previous sections. In addition, commands can be defined separately and injected into a given Luban app later. Command definition can be also namespaced by using module. With this feature, commands can be designed in a more re-usable and scalable way. This feature also implies that Luban CLI application supports namespaced commands.

data/lib/luban/cli/base/dsl.rb

@@ -131,7 +131,7 @@ module Luban
         else
           validate_required_options
           validate_required_arguments
-          result[:opts][:__remaining__] = argv
+          result[:opts][:__remaining__] = result[:argv]
           yield args: result[:args], opts: result[:opts]
           if has_commands?
             dispatch_command(cmd: result[:cmd], argv: result[:argv])

data/lib/luban/cli/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module CLI
-    VERSION = "0.4.6"
+    VERSION = "0.4.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Rubyist Chi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler