luban-cli 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cef4bc2d5883cf60fc715d577ce581b4b99a37d
-  data.tar.gz: f9621b3ad7ef039ff84595cc6dc5950059519019
+  metadata.gz: 5cefeb5c04a0122c4ddbcfe60ec89f10fa448986
+  data.tar.gz: 63308ba45f262576aa6208d7017accbbefcc71fd
 SHA512:
-  metadata.gz: 1e7ccbaef417438934e5d2a49d587c138d7c230122d0b96241935e3cc211b38e3a755f9c7302268229ccc110ae1d9712b5d08ec7b4e271eb616947020488808a
-  data.tar.gz: cebee1212f04f353fefb7457e0fcd65abd89cf8d4c008139684e497862ba26309fdfbea473c060773ce1865451d6767b33f71c09cf083565efbe4ce0409b70d5
+  metadata.gz: c9783ade21c7ca9ae041262c692730fd3db7fe6cd8eaa880ff910568d57729a88688c5583edbb297b6996797d4d04deb88e7231551e9686e189d2339a0904539
+  data.tar.gz: a3724c927f17da7c1933b69ccd82e06371c982040bf8e7840f6cf569049974373ec4961551afe7d49d0f405715da63748fa5ca206242bf989914117b6067500f

data/CHANGELOG.md

@@ -1,26 +1,24 @@
 # Change log
 
-## Version 0.1.0 (Mar 31, 2015)
+## Version 0.3.2 (Apr 28, 2015)
 
-Bootstrapped Luban::CLI
+Minor enhancements:
+  * Add use_commands DSL to inject command definitions to a given Luban app or command
+  * Add an example to demonstrate command injection
 
-New features:
-  * Support general command-line parsing
-    * Support options
-    * Support switches (boolean options)
-    * Support arguments
-    * Support subcommand
-  * Provide base class (Luban::CLI::Base) for command-line application
+Bug fixes:
+  * Add validation to help command
+  * Command dispatching within the correct context
 
-## Version 0.2.0 (Apr 02, 2015)
+## Version 0.3.1 (Apr 15, 2015)
 
 Minor enhancements:
-  * Refactor error class
-  * Refactor argument validation
-  * Validate required options/arguments in Luban::CLI::Base
-  * Create singleton action handler method on application instance
-  * Move parse error handling to action handler
-  * Exclude examples and spec from the gem itself
+  * Simplify keyword arguments for dispatch_command and action handler
+  * Include command chain as part of action method name for commands
+  * Enrich README with more documentation
+
+Bug fixes:
+  * Handle validation for multiple values correctly
 
 ## Version 0.3.0 (Apr 11, 2015)
 
@@ -40,12 +38,24 @@ Bug fixes:
   * Dispatch command under the right class context
   * Show correct command chain between program name and synopsis when composing parser banner
 
-## Version 0.3.1 (Apr 15, 2015)
+## Version 0.2.0 (Apr 02, 2015)
 
 Minor enhancements:
-  * Simplify keyword arguments for dispatch_command and action handler
-  * Include command chain as part of action method name for commands
-  * Enrich README with more documentation
+  * Refactor error class
+  * Refactor argument validation
+  * Validate required options/arguments in Luban::CLI::Base
+  * Create singleton action handler method on application instance
+  * Move parse error handling to action handler
+  * Exclude examples and spec from the gem itself
 
-Bug fixes:
-  * Handle validation for multiple values correctly
+## Version 0.1.0 (Mar 31, 2015)
+
+Bootstrapped Luban::CLI
+
+New features:
+  * Support general command-line parsing
+    * Support options
+    * Support switches (boolean options)
+    * Support arguments
+    * Support subcommand
+  * Provide base class (Luban::CLI::Base) for command-line application

data/README.md

@@ -180,13 +180,13 @@ Invalid value of argument AGE: 90 (Luban::CLI::Argument::InvalidArgumentValue)
 ... ...
 
 $ ruby my_app.rb john male 30 2
-{:cmd=>nil, :argv=>[], :args=>{:name=>"john", :gender=>:male, :age=>30, :level=>2, :email=>nil}, :opts=>{:help=>false}}
+{:args=>{:name=>"john", :gender=>:male, :age=>30, :level=>2, :email=>nil}, :opts=>{:help=>false}}
 
 $ ruby my_app.rb john male 30 2 john@company.com
-{:cmd=>nil, :argv=>[], :args=>{:name=>"john", :gender=>:male, :age=>30, :level=>2, :email=>["john@company.com"]}, :opts=>{:help=>false}}
+{:args=>{:name=>"john", :gender=>:male, :age=>30, :level=>2, :email=>["john@company.com"]}, :opts=>{:help=>false}}
 
 $ ruby my_app.rb john male 30 2 john@company.com john@personal.com
-{:cmd=>nil, :argv=>[], :args=>{:name=>"john", :gender=>:male, :age=>30, :level=>2, :email=>["john@company.com", "john@personal.com"]}, :opts=>{:help=>false}}
+{:args=>{:name=>"john", :gender=>:male, :age=>30, :level=>2, :email=>["john@company.com", "john@personal.com"]}, :opts=>{:help=>false}}
 ```
 
 ### option
@@ -222,10 +222,10 @@ MyApp.new.run
 
 ```
 $ ruby my_app.rb --require bundler
-{:cmd=>nil, :argv=>[], :args=>{}, :opts=>{:libraries=>["bundler"], :help=>false}}
+{:args=>{}, :opts=>{:libraries=>["bundler"], :help=>false}}
 
 $ ruby my_app.rb -r bundler,rails
-{:cmd=>nil, :argv=>[], :args=>{}, :opts=>{:libraries=>["bundler", "rails"], :help=>false}}
+{:args=>{}, :opts=>{:libraries=>["bundler", "rails"], :help=>false}}
 ```
 
 Occassionally an option might take an optional argument, e.g. --inplace [EXTENSION]. This kind of option is called nullable option. The nullable option is set to true if the optional argument is not provided; otherwise, the value of the option is set to the value of the argument. To declare a nullable option, you can explicitly turn off nullable modifier which is off by default.
@@ -248,13 +248,13 @@ MyApp.new.run
 
 ```
 $ ruby my_app.rb
-{:cmd=>nil, :argv=>[], :args=>{}, :opts=>{:inplace=>nil, :help=>false}}
+{:args=>{}, :opts=>{:inplace=>nil, :help=>false}}
 
 $ ruby my_app.rb --inplace
-{:cmd=>nil, :argv=>[], :args=>{}, :opts=>{:inplace=>true, :help=>false}}
+{:args=>{}, :opts=>{:inplace=>true, :help=>false}}
 
 $ ruby my_app.rb --inplace .bak 
-{:cmd=>nil, :argv=>[], :args=>{}, :opts=>{:inplace=>".bak", :help=>false}}
+{:args=>{}, :opts=>{:inplace=>".bak", :help=>false}}
 ```
 
 ### switch
@@ -449,6 +449,62 @@ 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. 
 
+### 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.
+
+Below is an example demonstrating how command injection is supposed to work.
+
+```ruby
+module App
+  module ControlTasks
+    class Task1Command < Luban::CLI::Command
+      configure do
+        ... ...
+      end
+    end
+
+    class Task2Command < Luban::CLI::Command
+      configure do
+        ... ...
+      end
+    end
+  end
+end
+
+class MyApp < Luban::CLI::Application
+  configure do
+    ... ...
+  end
+
+  # Inject Luban commands directly defined under the given module
+  use_commands 'app:control_tasks'
+
+  # Alternatively, commands can be injected individually
+  # The following has the same effect
+  # command 'app:control_tasks:task1'
+  # command 'app:control_tasks:task2'
+end
+```
+
+```
+$ ruby my_app.rb app:control_tasks:task1
+
+$ ruby my_app.rb app:control_tasks:task2
+```
+
+As shown above, there are a few naming conventions about the command class naming and injection:
+
+* Command class should has suffix "Command"
+  * For instances, Task1Command, Task2Command
+* Module name to be injected should be fully qualified
+  * namespaces/modules should be in snake case and
+  * Separated by colon as the delimiter
+  * For instances, 'app:control_tasks'
+* Alternatively, commands can be injected individually
+  * Command name should be fully qualified
+  * Suffix "Command" is no more needed
+
 ## Applications
 
 Luban::CLI provides a base class for cli application, Luban::CLI::Application. You can define your own cli application by inheriting it as examples shown in the previous sections. 

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

@@ -61,7 +61,7 @@ module Luban
       def default_prefix; ''; end
 
       def action_method
-        @action_method ||= "#{@prefix}#{@action_name}"
+        @action_method ||= "#{@prefix}#{@action_name.to_s.gsub(':', '_')}"
       end
 
       def parser
@@ -94,7 +94,12 @@ module Luban
 
       def dispatch_command(context, cmd:, argv:)
         validate_command(cmd)
-        context.send(commands[cmd].action_method, argv)
+        cmd_method = commands[cmd].action_method
+        if respond_to?(cmd_method)
+          send(cmd_method, argv)
+        else          
+          context.send(cmd_method, argv)
+        end
       end
 
       def validate_command(cmd)

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

@@ -12,10 +12,12 @@ module Luban
           if block_given?
             command(**opts, &blk)
           else
+            validator = method(:has_command?)
             command(:help, **opts) do
               desc "List all commands or help for one command"
               argument :command, "Command to help for", 
-                       type: :symbol, required: false
+                       type: :symbol, required: false,
+                       assure: validator
               action :show_help_for_command
             end
           end

data/lib/luban/cli/command.rb

@@ -13,7 +13,7 @@ module Luban
       def default_prefix; '__command_'; end
 
       def action_method
-        @action_method ||= "#{@prefix}#{command_chain.map(&:to_s).join('_')}"
+        @action_method ||= "#{@prefix}#{command_chain.map(&:to_s).join('_').gsub(':', '_')}"
       end
 
       protected

data/lib/luban/cli/commands.rb

@@ -18,6 +18,31 @@ module Luban
         def has_commands?
           !commands.empty?
         end
+
+        def use_commands(mod_name)
+          mod_class = Kernel.const_get(camelcase(mod_name.to_s))
+          mod_class.constants.map { |c| mod_class.const_get(c) }.each do |c|
+            command(snakecase(c.name.sub(/Command$/, ''))) if c < Luban::CLI::Command
+          end
+        end
+
+        protected
+
+        def camelcase(str)
+          str = str.to_s.dup
+          str.gsub!(/\:(.?)/){ "::#{$1.upcase}" }
+          str.gsub!(/(?:_+|-+)([a-z])/){ $1.upcase }
+          str.gsub!(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+          str
+        end
+
+        def snakecase(str)
+          str.gsub(/::/, ':').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+        end
       end
 
       module ClassMethods
@@ -28,10 +53,11 @@ module Luban
         end
 
         def command_class(cmd)
-          "#{classify(cmd)}Command"
+          "#{camelcase(cmd)}Command"
         end
 
         def command(app = self, cmd, **opts, &blk)
+          cmd = cmd.to_sym
           cmd_class = command_class(cmd)
           klass = if self.const_defined?(command_class(cmd))
                     self.const_get(command_class(cmd))
@@ -44,16 +70,6 @@ module Luban
         def undef_command(cmd)
           undef_method(commands.delete(cmd).action_method)
         end
-
-        protected
-
-        def classify(cmd)
-          cmd = cmd.to_s.dup
-          cmd.gsub!(/\/(.?)/){ "::#{$1.upcase}" }
-          cmd.gsub!(/(?:_+|-+)([a-z])/){ $1.upcase }
-          cmd.gsub!(/(\A|\s)([a-z])/){ $1 + $2.upcase }
-          cmd
-        end
       end
 
       module InstanceMethods
@@ -64,6 +80,7 @@ module Luban
         end
 
         def command(cmd, **opts, &blk)
+          cmd = cmd.to_sym
           if self.is_a?(Command)
             opts[:command_chain] = self.command_chain.clone.push(cmd)
             self.class.command(self.app, cmd, **opts, &blk)

data/lib/luban/cli/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module CLI
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Rubyist Chi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler