mcli 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ba7853c0e14c2f1998e4d1dcce81cf5c99eb5d414ec720db0d4612a3b397d1
-  data.tar.gz: b0a1caa1a951a1bec4468e384a494fffc6c8e83f6ec15e60ff93354e9cc86d7e
+  metadata.gz: 0011cb49282f8d026747d15ceaff822cedafb0e56920a0dcc952d35bc3d44c5e
+  data.tar.gz: 744d35d6c593b620a5fd8aa996abb789af17411116560b136a3c824aba37cd84
 SHA512:
-  metadata.gz: 844fb154e3d2cca1395b478b9d306866f2491bf69ff478cdb3dce12e8ade22f168ba9a6edbf2b8df72d9cab6a6f9072654819a0c4f1b14f6803904d2a9f9ec98
-  data.tar.gz: 2a6fd377bab075c2b873e01f2839ea4329ae615493dac1386a530434e8bad5ed6d7b54eff0dffc79e2adb94a9645ffe372731c5b84bf1675b93b12ebf1a19338
+  metadata.gz: 1acacb7282ef455e98d85caaa33e1396c79fb388962fc247df65d371b5efcf3ac7e74d061e146ae021ae9243970b54acb19053f4f600ffd0078df474b73e2446
+  data.tar.gz: 3c74baee24bcf1d03761877cd1b3b2e2d88357220f273cfc682631f8a2a6e326975ed5df5f194bc303481cbba94c29a8f8294287eee04d326997b5086c4da4d4

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.commands[:_root] || 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,8 +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)
     end
 
     def capture_all!
@@ -64,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

@@ -4,6 +4,10 @@ class MCLI::CommandGroup
       commands[command_name] = command_klass
     end
 
+    def register_root(command_klass)
+      @root_command = command_klass
+    end
+
     def commands
       @commands ||= {}
     end
@@ -11,6 +15,19 @@ class MCLI::CommandGroup
     def clear
       @commands = {}
     end
+
+    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.3.0"
+  VERSION = "0.8.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.3.0
+  version: 0.8.0
 platform: ruby
 authors:
 - John Thomas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2021-01-17 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: []