mcli 0.4.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a66749c3036b67941be0bd467f468a50bed5c65bf6339fa38e4f6860ae1576
-  data.tar.gz: ee8160680bd44f9e119b5703ac336e5794996ae86e75882e5c16209e524b3530
+  metadata.gz: ecec8bb6514b3d3a92a27fdff45e246b0974770648d0f683be216eecfac14856
+  data.tar.gz: 274fcd6a72fa0925731e16e3c0f24e0671f203af503b11e1841c0f3236c76617
 SHA512:
-  metadata.gz: 0aff53ff9cb2ac7cb05f984348851e6697cdba511fd3580be155d3fff4c3fc532569d18d8f6193634d6c11876938f5ecafea2605e98c2eaf62d171358febd261
-  data.tar.gz: a1523561c64404be6211ef640f667fb8932d9e31eb50fff3f06fddf8a9c0134dff1c7066d6dae681ec074596ce49769e909ed325e77dc682b75bc5aa236a7e51
+  metadata.gz: c55e84020a939b109b1241303cdd6ca387e91d3bc45c5b73c503a1db7b3ffb078f801c47b44b3b5398d4be8fda3c667af39c54261dedb77b4bbb46346e0bd88b
+  data.tar.gz: 87217cb01f495f7646c4b8969cea3ac8e1e87c273e98e92a88de7449d8648c5f588172edad239a30beccb6e81c180bcdd605eee8b574b297abccf4912f1a3785

data/README.md

@@ -200,7 +200,7 @@ Heads: false
 #!/usr/bin/env ruby
 require 'mcli'
 
-class Options < MCLI::Command
+class Capture < MCLI::Command
   register_as :capture
   capture_all!
 
@@ -217,6 +217,70 @@ $ ./capture.rb capture --toast=cool one two -a ok three
 ["--toast=cool", "one", "two", "-a", "ok", "three"]
 ```
 
+##### Register a command as the root command
+```ruby
+#root.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Root < MCLI::Command
+  register_as_root
+  option 'option'
+
+  def run
+    puts "#{arg.inspect}"
+    puts "#{options[:root]}"
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./root.rb arg --option opt
+[arg]
+opt
+```
+
+##### Register nested commands
+```ruby
+#nestable.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Nestable < MCLI::Command
+  register_as :nestable
+  capture_all!
+
+  def run
+    NestedGroup.call(args)
+  end
+
+  class NestedGroup < MCLI::CommandGroup
+  end
+end
+
+class NestedCommand < MCLI::Command
+  register_as :command, to: Nestable::Group
+  capture_all!
+
+  def run
+    puts args.inspect
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./nestable.rb nestable command --toast=cool one two -a ok three
+["--toast=cool", "one", "two", "-a", "ok", "three"]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/mcli.rb

@@ -9,12 +9,7 @@ require 'mcli/null_command'
 module MCLI
   class << self
     def run
-      command = ARGV.shift
-
-      CommandGroup.commands.fetch(command.to_s.to_sym) do |command|
-        ARGV.unshift(command)
-        CommandGroup.root_command || NullCommand
-      end.call
+      CommandGroup.call(ARGV.dup)
     end
   end
 end

data/lib/mcli/command.rb

@@ -16,7 +16,7 @@ class MCLI::Command
       end
     end
 
-    parser.parse!
+    parser.parse!(@args)
 
     self.class.options
       .select { |option| option.required == true }
@@ -37,6 +37,8 @@ class MCLI::Command
 
   def create_parser
     OptionParser.new.tap do |parser|
+      parser.program_name = self.class.command_name
+
       parser.on("-h", "--help", "Help") do
         raise MCLI::HelpError.new
       end
@@ -44,6 +46,11 @@ class MCLI::Command
   end
 
   class << self
+    def description(desc=nil)
+      @description = desc unless desc.nil?
+      @description ||= ''
+    end
+
     def option(option_name, opts={})
       options << Option.new(option_name, opts)
     end
@@ -52,12 +59,13 @@ class MCLI::Command
       @options ||= []
     end
 
-    def register_as(command_name)
-      MCLI::CommandGroup.register(command_name, self)
+    def register_as(command_name, to: default_command_group)
+      @command_name = command_name
+      to.register(command_name, self)
     end
 
-    def register_as_root
-      MCLI::CommandGroup.register_root(self)
+    def register_as_root(to: default_command_group)
+      to.register_root(self)
     end
 
     def capture_all!
@@ -68,8 +76,16 @@ class MCLI::Command
       @capture_all
     end
 
-    def call
-      new(ARGV).tap do |command|
+    def command_name
+      @command_name
+    end
+
+    def default_command_group
+      MCLI::CommandGroup
+    end
+
+    def call(args)
+      new(args).tap do |command|
         begin
           command.parse unless capture_all?
           command.run

data/lib/mcli/command/option.rb

@@ -17,7 +17,7 @@ class MCLI::Command::Option
     [].tap do |args|
       args << "-#{@alias}"                   if @alias
       args << "--#{@name} #{@name.upcase}"   if @required && !@boolean
-      args << "--#{@name} [#{@name.upcase}]" if !@required && !@boolean
+      args << "--#{@name} [#{@default || @name.upcase}]" if !@required && !@boolean
       args << "--[no-]#{@name}"              if @boolean
     end
   end

data/lib/mcli/command_group.rb

@@ -19,6 +19,15 @@ class MCLI::CommandGroup
     def root_command
       @root_command
     end
+
+    def call(args)
+      command = args.shift
+
+      commands.fetch(command.to_s.to_sym) do |command|
+        args.unshift(command)
+        root_command || MCLI::NullCommand
+      end.call(args)
+    end
   end
 end
 

data/lib/mcli/version.rb

@@ -1,3 +1,3 @@
 module MCLI
-  VERSION = "0.4.0"
+  VERSION = "0.9.0"
 end

data/mcli.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/mcli}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,58 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: mcli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.9.0
 platform: ruby
 authors:
 - John Thomas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+        version: '0'
+description:
 email:
 - thomas07@vt.edu
 executables:
@@ -82,7 +82,7 @@ homepage: https://github.com/thomas07vt/mcli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Create CLI tools using ruby objects with a nice API
 test_files: []