commander 4.3.8 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64fa723701dbdd02b99e8522367448ba136d498d
-  data.tar.gz: 078d26f2f3610bc4a1bcd44f50d350dc836f2276
+  metadata.gz: 0e9fa3f3fbb6475cdf02ae043991c17ec9058107
+  data.tar.gz: 39f8b6530783b95688fa20d4b6ac4b7bb43ec0ab
 SHA512:
-  metadata.gz: 76874e8b7f1f227cde4bcd7601f1b97c2fd131c1a4119b40cd79742341957c540fa7c554632f74bd857bf37adc2947b3c1ad0febaac2da891cf0cbe02cdfe77c
-  data.tar.gz: c4351aadda2c05e041e32d3adc950705d6cbb00123cc4cfeb7c4ff080d30ffe6325e2327036efb5ed89488e621001ea3236dcb0174f54fb3d708760dea45eec6
+  metadata.gz: 612b57dc06491d404d072a6e8eec9da8c1727e65fe23afa48c36c183e7ff706de9cb1c4bc3f5adfef67d03ee2be9ac8dab0f9eb6328dbfe758479c9ead834a0f
+  data.tar.gz: 2141c0258fd8b2818c7f3eacf02809a32dcc68326822920bb8756215ab777bb46d10b58848d959eeb8b95da864d150331e79d15f61ab938b4fef946b6b9d008e

data/.rubocop_todo.yml

@@ -20,7 +20,7 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 230
+  Enabled: false
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 4.4.0 / 2016-02-19
+
+* Add modular style template initialization. (@lebogan)
+* Allow option names that start with a global option name.
+* Fix handling of negatable global flags. (@mfurtak)
+
 === 4.3.8 / 2016-02-09
 
 * Fix regression for deprecation warnings.

data/README.md

@@ -37,6 +37,10 @@ To generate a quick template for a commander app, run:
 
     $ commander init yourfile.rb
 
+To generate a quick modular style template for a commander app, run:
+
+    $ commander init --modular yourfile.rb
+
 ## Example
 
 For more option examples view the `Commander::Command#option` method. Also

data/bin/commander

@@ -8,30 +8,78 @@ program :version, Commander::VERSION
 program :description, 'Commander utility program.'
 
 command :init do |c|
-  c.syntax = 'commander init <file>'
+  c.syntax = 'commander init [option] <file>'
   c.summary = 'Initialize a commander template'
   c.description = 'Initialize an empty <file> with a commander template,
     allowing very quick creation of commander executables.'
-  c.example 'Create a new file with a commander template.', 'commander init bin/my_executable'
-  c.action do |args, _options|
+  c.example 'Create a new classic style template file.', 'commander init bin/my_executable'
+  c.example 'Create a new modular style template file.', 'commander init --modular bin/my_executable'
+  c.option '-m', '--modular', 'Initialize a modular style template'
+  c.action do |args, options|
     file = args.shift || abort('file argument required.')
     name = ask 'Machine name of program: '
     description = ask 'Describe your program: '
     commands = ask_for_array 'List the commands you wish to create: '
     begin
-      File.open(file, 'w') do |f|
-        f.write <<-"...".gsub!(/^ {10}/, '')
+      if options.modular
+        File.open(file, 'w') do |f|
+          f.write <<-"...".gsub!(/^ {10}/, '')
+          #!/usr/bin/env ruby
+
+          require 'rubygems'
+          require 'commander'
+
+          class MyApplication
+            include Commander::Methods
+            # include whatever modules you need
+
+            def run
+              program :name, '#{name}'
+              program :version, '0.0.1'
+              program :description, '#{description}'
+
+          ...
+          commands.each do |command|
+            f.write <<-"...".gsub!(/^ {12}/, '')
+                command :#{command} do |c|
+                  c.syntax = '#{name} #{command} [options]'
+                  c.summary = ''
+                  c.description = ''
+                  c.example 'description', 'command example'
+                  c.option '--some-switch', 'Some switch that does something'
+                  c.action do |args, options|
+                    # Do something or c.when_called #{name.capitalize}::Commands::#{command.capitalize}
+                  end
+                end
+
+            ...
+          end
+          f.write <<-"...".gsub!(/^ {12}/, '')
+                run!
+              end
+            end
+
+            MyApplication.new.run if $0 == __FILE__
+          ...
+        end
+
+        File.chmod(0755, file)
+        say "Initialized modular template in #{file}"
+      else
+        File.open(file, 'w') do |f|
+          f.write <<-"...".gsub!(/^ {10}/, '')
           #!/usr/bin/env ruby
 
           require 'rubygems'
           require 'commander/import'
 
+          program :name, '#{name}'
           program :version, '0.0.1'
           program :description, '#{description}'
 
-        ...
-        commands.each do |command|
-          f.write <<-"...".gsub!(/^ {12}/, '')
+          ...
+          commands.each do |command|
+            f.write <<-"...".gsub!(/^ {12}/, '')
             command :#{command} do |c|
               c.syntax = '#{name} #{command} [options]'
               c.summary = ''
@@ -43,11 +91,12 @@ command :init do |c|
               end
             end
 
-          ...
+            ...
+          end
         end
+        File.chmod 0755, file
+        say "Initialized template in #{file}"
       end
-      File.chmod 0755, file
-      say "Initialized template in #{file}"
     rescue => e
       abort e
     end

data/lib/commander/runner.rb

@@ -335,9 +335,11 @@ module Commander
           switches.map! { |s| s[0, s.index('=') || s.index(' ') || s.length] }
         end
 
+        switches = expand_optionally_negative_switches(switches)
+
         past_switch, arg_removed = false, false
         args.delete_if do |arg|
-          if switches.any? { |s| arg[0, s.length] == s }
+          if switches.any? { |s| s[0, arg.length] == arg }
             arg_removed = !switch_has_arg
             past_switch = true
           elsif past_switch && !arg_removed && arg !~ /^-/
@@ -350,6 +352,20 @@ module Commander
       end
     end
 
+    # expand switches of the style '--[no-]blah' into both their
+    # '--blah' and '--no-blah' variants, so that they can be
+    # properly detected and removed
+    def expand_optionally_negative_switches(switches)
+      switches.reduce([]) do |memo, val|
+        if val =~ /\[no-\]/
+          memo << val.gsub(/\[no-\]/, '')
+          memo << val.gsub(/\[no-\]/, 'no-')
+        else
+          memo << val
+        end
+      end
+    end
+
     ##
     # Parse global command options.
 

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '4.3.8'
+  VERSION = '4.4.0'
 end

data/spec/runner_spec.rb

@@ -110,6 +110,28 @@ describe Commander do
       end.run!
       expect(quiet).to be true
     end
+
+    it 'should be inherited by commands when the positive form of a [no-] option' do
+      quiet = nil
+      new_command_runner 'foo', '--quiet' do
+        global_option('--[no-]quiet', 'Suppress output') {}
+        command :foo do |c|
+          c.when_called { |_, options| quiet = options.quiet }
+        end
+      end.run!
+      expect(quiet).to be true
+    end
+
+    it 'should be inherited by commands when the negative form of a [no-] option' do
+      quiet = nil
+      new_command_runner 'foo', '--no-quiet' do
+        global_option('--[no-]quiet', 'Suppress output') {}
+        command :foo do |c|
+          c.when_called { |_, options| quiet = options.quiet }
+        end
+      end.run!
+      expect(quiet).to be false
+    end
   end
 
   describe '#parse_global_options' do
@@ -270,6 +292,40 @@ describe Commander do
       command_runner.remove_global_options options, args
       expect(args).to eq(%w(alpha beta))
     end
+
+    it 'should remove a switch that is the positive form of the [no-] option' do
+      options, args = [], []
+      options << { switches: ['-g', '--[no-]good'] }
+      options << { switches: ['-y', '--yes ARG'] }
+      options << { switches: ['-a', '--alternative=ARG'] }
+      args << '--good' << 'alpha'
+      args << '--yes' << 'deleted'
+      args << '-a' << 'deleted'
+      args << 'beta'
+      command_runner.remove_global_options options, args
+      expect(args).to eq(%w(alpha beta))
+    end
+
+    it 'should remove a switch that is the negative form of the [no-] option' do
+      options, args = [], []
+      options << { switches: ['-g', '--[no-]good'] }
+      options << { switches: ['-y', '--yes ARG'] }
+      options << { switches: ['-a', '--alternative=ARG'] }
+      args << '--no-good' << 'alpha'
+      args << '--yes' << 'deleted'
+      args << '-a' << 'deleted'
+      args << 'beta'
+      command_runner.remove_global_options options, args
+      expect(args).to eq(%w(alpha beta))
+    end
+
+    it 'should not remove options that start with a global option name' do
+      options, args = [], []
+      options << { switches: ['-v', '--version'] }
+      args << '--versionCode' << 'something'
+      command_runner.remove_global_options options, args
+      expect(args).to eq(%w(--versionCode something))
+    end
   end
 
   describe '--trace' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.3.8
+  version: 4.4.0
 platform: ruby
 authors:
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline