luban-cli 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3717edf51bdf2888b4d7d7d378b8ba777e7f2df
-  data.tar.gz: 23c48793a99823629c9b339a7b65f64f3be9dc27
+  metadata.gz: e6a17dc64fcd6ba46e069c6625848100fa33402c
+  data.tar.gz: 7415b6f89e06a8aa7ca5a15f0dd8682a75f6a247
 SHA512:
-  metadata.gz: d5dd0736e211101a179af588fab6892445fc3e6b77d4203237f383cb14267da9ce61dbdc565c6ffa8cf4a46fbf7feaba43c1347afbfc8cb27afa0b00e42222ab
-  data.tar.gz: abe9f13478171fd6c9bb4b5163f73919666b2f830c5a43896812da9e09e938da9ed16c23699486657b94752ef68849f902ff5384ffee6dcb6bce5e1026f636fa
+  metadata.gz: 9ccd92008a1cd6f97e489b42990c86ca9a6c83e99750787fa7dbcd97d9845f962007e2a1d906c05aaea6cdd3854bb6028b9fed25d12f9e84da40fe998b533ab4
+  data.tar.gz: a06c296c1ce5e5564d48d306ac3b13bf0e1f943fca349b89ba025a1cdb0098c79fcbfcd61ec17bbd9694006a71bba8e1055357b0003275d025bbc495bf3f63e4

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## Version 0.4.1 (Nov 05, 2015)
+
+Minor enhancements:
+  * After parsing, added any remaining command line arguments to opts[:__remaining__]
+    * This is useful to handle arguments provided after the double hyphen
+  * Used Ruby refinements to re-implement camelcase and snakecase handling
+
+Bug fixes:
+  * Filter empty default values for help message
+
 ## Version 0.4.0 (Oct 14, 2015)
 
 New features:

data/README.md

@@ -98,9 +98,9 @@ my_app 1.0.0
 $ ruby my_app.rb john -p mr -s jr
 Hi, Mr. John Jr.!
 
-ruby examples/hi.rb john -p mr -s jr -V
-Options: {:version=>false, :prefix=>"mr", :suffix=>"jr", :verbose=>true, :help=>false}
-Arguments: {:name=>"chi"}
+$ ruby my_app.rb john -p mr -s jr -V
+Options: {:version=>false, :prefix=>"mr", :suffix=>"jr", :verbose=>true, :help=>false, :__remaining__=>[]}
+Arguments: {:name=>"john"}
 Hi, Mr. John Jr.!
 ```
 
@@ -387,6 +387,24 @@ end
 
 ```
 
+## Option Parsing Termination
+
+It is a convention that a double hyphen is a signal to stop option interpretation and to read the remaining statements on the command line literally. Luban::CLI supports this convention and stores the remaining statements on the command line, if any, into the keyword argument :opts with a hash key :\__remaining\__, which is passed to the given action handler.
+
+The following refers to the simple example shown in the section Usage, which demonstrates the parsing result with remaining statements in option parsing termination.
+
+```ruby
+$ ruby my_app.rb john -p mr -s jr -V
+Options: {:version=>false, :prefix=>"mr", :suffix=>"jr", :verbose=>true, :help=>false, :__remaining__=>[]}
+Arguments: {:name=>"john"}
+Hi, Mr. John Jr.!
+
+$ ruby my_app.rb john -p mr -s jr -V -- --test here
+Options: {:version=>false, :prefix=>"mr", :suffix=>"jr", :verbose=>true, :help=>false, :__remaining__=>["--test", "here"]}
+Arguments: {:name=>"john"}
+Hi, Mr. John Jr.!
+```
+
 ## Commands
 
 Luban::CLI supports commands/subcommands. Commands can also be nested. However, all action handlers are preferred to be defined under the the application class; otherwise RuntimeError will be raised.

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

@@ -1,6 +1,8 @@
 module Luban
   module CLI
     class Base
+      using CoreRefinements
+      
       def command(cmd, base: Command, **opts, &blk)
         cmd = cmd.to_sym
         @commands[cmd] = command_class(cmd, base).new(self, cmd, **opts, &blk)
@@ -11,9 +13,9 @@ module Luban
       end
 
       def use_commands(module_name, **opts, &blk)
-        module_class = Object.const_get(camelcase(module_name.to_s), false)
+        module_class = Object.const_get(module_name.camelcase, false)
         module_class.constants(false).map { |c| module_class.const_get(c, false) }.each do |c|
-          command(snakecase(c.name), base: c, **opts, &blk) if c < Command
+          command(c.name.snakecase, base: c, **opts, &blk) if c < Command
         end
       end
 
@@ -32,7 +34,7 @@ module Luban
       protected
 
       def command_class(cmd, base)
-        class_name = camelcase(cmd)
+        class_name = cmd.camelcase
         if command_class_defined?(class_name)
           get_command_class(class_name)
         else
@@ -51,22 +53,6 @@ module Luban
       def define_command_class(class_name, base)
         self.class.send(:define_class, class_name, base: base, namespace: self.class)
       end
-
-      def camelcase(str)
-        str = str.to_s.dup
-        str.gsub!(/(\:|\/)(.?)/){ "::#{$2.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
   end
 end

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

@@ -96,7 +96,8 @@ module Luban
 
       def undef_singleton_method(method_name)
         # Undefine methods that are defined in the eigenclass
-        (class << self; self; end).send(:undef_method, method_name)
+        singleton_class.send(:undef_method, method_name)
+        #(class << self; self; end).send(:undef_method, method_name)
       end
 
       def configure(&blk)
@@ -260,7 +261,7 @@ module Luban
       end
 
       def add_parser_defaults
-        add_section("Defaults", options.values.map(&:default_str))
+        add_section("Defaults", options.values.map(&:default_str).reject { |d| d.empty? })
       end
 
       def add_parser_commands

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

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

data/lib/luban/cli/core_refinements.rb

@@ -0,0 +1,33 @@
+module Luban
+  module CLI
+    module CoreRefinements
+      refine String do
+        def camelcase
+          str = dup
+          str.gsub!(/(\:|\/)(.?)/){ "::#{$2.upcase}" }
+          str.gsub!(/(?:_+|-+)([a-z])/){ $1.upcase }
+          str.gsub!(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+          str
+        end
+
+        def snakecase
+          gsub(/::/, ':').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+        end
+      end
+
+      refine Symbol do
+        def camelcase
+          to_s.camelcase
+        end
+
+        def snakecase
+          to_s.snakecase
+        end
+      end
+    end
+  end
+end

data/lib/luban/cli/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module CLI
-    VERSION = "0.4.0"
+    VERSION = "0.4.2"
   end
 end

data/lib/luban/cli.rb

@@ -1,5 +1,6 @@
 require_relative "cli/error"
 require_relative "cli/version"
+require_relative "cli/core_refinements"
 require_relative "cli/base"
 require_relative "cli/command"
 require_relative "cli/application"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Rubyist Chi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - lib/luban/cli/base/parse.rb
 - lib/luban/cli/base/switch.rb
 - lib/luban/cli/command.rb
+- lib/luban/cli/core_refinements.rb
 - lib/luban/cli/error.rb
 - lib/luban/cli/version.rb
 - luban-cli.gemspec