getopt 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fb3a945490a612eaf1e604f83dea2a0e1adecd5b3469c83e214bcb99eacd076
-  data.tar.gz: 13521ceb0616ee5e34e6434e6b2c94dc12be959eec7ca210977c1b5ce903c723
+  metadata.gz: e45a7211aea22472efcebd09ba6aa5b344eac0441213144d6c8c408d0adfabf5
+  data.tar.gz: 2a95d618c4ededa6de05a091429c85dc38cdd5f43d75618587e5a74d589bcd50
 SHA512:
-  metadata.gz: 528a9e0c5f0c7aed85fc510e8f823b75b9b40b8f5142a8373474a4f643005ce1ab497f42657802f30dc8b0f002a6154ada4b246a93fa2ee9cc84c197f7621140
-  data.tar.gz: 2ff2aaf442063fbb69d5a96eff5e098b2e10d7472922263424ee9fd3d0539916d08201b04635de80b3abec9a8b40ebe24732eb9ef5ddd705c488d4209b198865
+  metadata.gz: ecda8ad35cfaac66dd59c0432796a7901f22f351ee2fd347aff8e4f0a730a5ca963fe428608de5988a7f00bd367c1d3e6b4f3865bc44cb4762a06962b831ca3c
+  data.tar.gz: 9b5308a4a046cb6df55353114bd396749c75443d75e4c8c1f2c886702420e16a2bb57cec3fc253ee17f2cea9d9dfbad9a2d5e84e60cb984aae09cfa389380962

data/CHANGES.md

@@ -1,6 +1,10 @@
+# 1.7.0 - 13-Feb-2026
+* Added the NEGATABLE option so you can do --no-whatever.
+* A few warnings were cleaned up, along with rubocop updates.
+* Some administrative stuff, updated Rakefile, Gemfile, etc.
+
 ## 1.6.0 - 2-Mar-2021
-* Switch from test-unit to rspec, and update the Rakefile and gemspec accordingly.
-* Added a Gemfile.
+* Switched tests to use rspec.
 
 ## 1.5.1 - 23-Mar-2020
 * Properly add a LICENSE file since the Apache-2.0 license requires it.

data/Gemfile

@@ -1,3 +1,2 @@
-source 'https://rubygems.org' do
-  gemspec
-end
+source 'https://rubygems.org'
+gemspec

data/MANIFEST.md

@@ -14,5 +14,5 @@
 * lib/getopt/long.rb
 * lib/getopt/std.rb
 * lib/getopt/version.rb
-* test/test_getopt_long.rb
-* test/test_getopt_std.rb
+* spec/getopt_long_spec.rb
+* spec/getopt_std_spec.rb

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/djberg96/getopt/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/getopt/actions/workflows/ruby.yml)
+
 ## Description
 The getopt Ruby library is a simple command line parsing library. It implements
 a `Getopt::Std` class for basic command line parsing, as well as a `Getopt::Long`
@@ -5,6 +7,9 @@ class for more advanced command line parsing.
 
 ## Installation
 `gem install getopt`
+
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/getopt/main/certs/djberg96_pub.pem)`
    
 ## Synopsis
 ### Getopt::Std
@@ -123,8 +128,6 @@ only once.
 
 ## Future Plans
 
-* Add support for negatable options so that you can do "--no-foo", for example.
-
 * Add support for numeric types, so that you don't have to manually convert
   strings to numbers.
 

data/Rakefile

@@ -1,14 +1,15 @@
 require 'rake'
 require 'rake/clean'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace :gem do
   desc "Create the getopt gem"
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('getopt.gemspec'))
+    spec = Gem::Specification.load('getopt.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -22,6 +23,8 @@ end
 
 namespace :spec do
   RSpec::Core::RakeTask.new(:all) do |t|
+    t.verbose = false
+    t.rspec_opts = '-f documentation -w'
     t.pattern = FileList['spec/*_spec.rb']
   end
 
@@ -34,4 +37,11 @@ namespace :spec do
   end
 end
 
+RuboCop::RakeTask.new
+
+# Clean up afterwards
+Rake::Task[:spec].enhance do
+  Rake::Task[:clean].invoke
+end
+
 task :default => 'spec:all'

data/getopt.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'getopt'
-  spec.version    = '1.6.0'
+  spec.version    = '1.7.0'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -14,14 +14,19 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/getopt',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/getopt/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/getopt/blob/master/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/getopt/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/getopt',
-    'wiki_uri'          => 'https://github.com/djberg96/getopt/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/getopt',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/getopt/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/getopt/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/getopt/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/getopt',
+    'wiki_uri'              => 'https://github.com/djberg96/getopt/wiki',
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/getopt',
+    'funding_uri'           => 'https://github.com/sponsors/djberg96'
   }
 
   spec.description = <<-EOF

data/lib/getopt/long.rb

@@ -1,244 +1,266 @@
+# frozen_string_literal: true
+
 require_relative 'version'
 
 # The Getopt module serves as a namespace only
 module Getopt
+  REQUIRED  = 0 # Argument is required if switch is provided.
+  BOOLEAN   = 1 # Value of argument is true if provided, false otherwise.
+  OPTIONAL  = 2 # Argument is optional if switch is provided.
+  INCREMENT = 3 # Argument is incremented by 1 each time the switch appears.
+  NEGATABLE = 4 # Automatically provide --no-<switch> to set value to false.
+
+  # INTEGER   = 5 # Argument automatically converted to integer if provided.
+  # FLOAT     = 6 # Argument automatically converted to float if provided.
+
+  # The Getopt::Long class encapsulates longhanded parameter parsing options
+  class Long
+    include Getopt::Version
+
+    # Error raised if an illegal option or argument is passed
+    class Error < StandardError; end
+
+    # Takes an array of switches. Each array consists of up to three
+    # elements that indicate the name and type of switch. Returns a hash
+    # containing each switch name, minus the '-', as a key. The value
+    # for each key depends on the type of switch and/or the value provided
+    # by the user.
+    #
+    # The long switch _must_ be provided. The short switch defaults to the
+    # first letter of the short switch. The default type is BOOLEAN.
+    #
+    # Example:
+    #
+    #  opts = Getopt::Long.getopts(
+    #     ['--debug'                   ],
+    #     ['--verbose', '-v'           ],
+    #     ['--level',   '-l', INCREMENT]
+    #  )
+    #
+    # See the README file for more information.
+    #
+    def self.getopts(*switches)
+      if switches.empty?
+        raise ArgumentError, 'no switches provided'
+      end
 
-   REQUIRED  = 0 # Argument is required if switch is provided.
-   BOOLEAN   = 1 # Value of argument is true if provided, false otherwise.
-   OPTIONAL  = 2 # Argument is optional if switch is provided.
-   INCREMENT = 3 # Argument is incremented by 1 each time the switch appears.
-
-   # NEGATABLE = 4 # Automatically provide negative switch equivalent.
-   # INTEGER   = 5 # Argument automatically converted to integer if provided.
-   # FLOAT     = 6 # Argument automatically converted to float if provided.
-
-   # The Getopt::Long class encapsulates longhanded parameter parsing options
-   class Long
-      include Getopt::Version
+      hash  = {} # Hash returned to user
+      valid = [] # Tracks valid switches
+      types = {} # Tracks argument types
+      syns  = {} # Tracks long and short arguments, or multiple shorts
+      negs  = {} # Tracks negated switches (maps --no-foo to --foo)
 
-      # Error raised if an illegal option or argument is passed
-      class Error < StandardError; end
+      # If a string is passed, split it and convert it to an array of arrays
+      if switches.first.is_a?(String)
+        switches = switches.join.split
+        switches.map!{ |switch| [switch] }
+      end
 
-      # Takes an array of switches. Each array consists of up to three
-      # elements that indicate the name and type of switch. Returns a hash
-      # containing each switch name, minus the '-', as a key. The value
-      # for each key depends on the type of switch and/or the value provided
-      # by the user.
-      #
-      # The long switch _must_ be provided. The short switch defaults to the
-      # first letter of the short switch. The default type is BOOLEAN.
-      #
-      # Example:
-      #
-      #  opts = Getopt::Long.getopts(
-      #     ['--debug'                   ],
-      #     ['--verbose', '-v'           ],
-      #     ['--level',   '-l', INCREMENT]
-      #  )
-      #
-      # See the README file for more information.
-      #
-      def self.getopts(*switches)
-         if switches.empty?
-            raise ArgumentError, 'no switches provided'
-         end
-
-         hash  = {} # Hash returned to user
-         valid = [] # Tracks valid switches
-         types = {} # Tracks argument types
-         syns  = {} # Tracks long and short arguments, or multiple shorts
-
-         # If a string is passed, split it and convert it to an array of arrays
-         if switches.first.kind_of?(String)
-            switches = switches.join.split
-            switches.map!{ |switch| switch = [switch] }
-         end
-
-         # Set our list of valid switches, and proper types for each switch
-         switches.each{ |switch|
-            valid.push(switch[0])       # Set valid long switches
-
-            # Set type for long switch, default to BOOLEAN.
-            if switch[1].kind_of?(Integer)
-               switch[2] = switch[1]
-               types[switch[0]] = switch[2]
-               switch[1] = switch[0][1..2]
-            else
-               switch[2] ||= BOOLEAN
-               types[switch[0]] = switch[2]
-               switch[1] ||= switch[0][1..2]
-            end
+      # Set our list of valid switches, and proper types for each switch
+      switches.each do |switch|
+        valid.push(switch[0]) # Set valid long switches
+
+        # Set type for long switch, default to BOOLEAN.
+        if switch[1].is_a?(Integer)
+          switch[2] = switch[1]
+          types[switch[0]] = switch[2]
+          switch[1] = switch[0][1..2]
+        else
+          switch[2] ||= BOOLEAN
+          types[switch[0]] = switch[2]
+          switch[1] ||= switch[0][1..2]
+        end
+
+        # Create synonym hash.  Default to first char of long switch for
+        # short switch, e.g. "--verbose" creates a "-v" synonym.  The same
+        # synonym can only be used once - first one wins.
+        syns[switch[0]] = switch[1] unless syns[switch[1]]
+        syns[switch[1]] = switch[0] unless syns[switch[1]]
+
+        switch[1] = [switch[1]]
+
+        switch[1].each do |char|
+          types[char] = switch[2]  # Set type for short switch
+          valid.push(char)         # Set valid short switches
+        end
+
+        # For NEGATABLE switches, register the --no- variant
+        if switch[2] == NEGATABLE
+          negated = switch[0].sub(/^--/, '--no-')
+          valid.push(negated)
+          types[negated] = NEGATABLE
+          negs[negated] = switch[0] # Map --no-foo back to --foo
+        end
+      end
 
-            # Create synonym hash.  Default to first char of long switch for
-            # short switch, e.g. "--verbose" creates a "-v" synonym.  The same
-            # synonym can only be used once - first one wins.
-            syns[switch[0]] = switch[1] unless syns[switch[1]]
-            syns[switch[1]] = switch[0] unless syns[switch[1]]
-
-            switch[1] = [switch[1]]
-
-            switch[1].each{ |char|
-               types[char] = switch[2]  # Set type for short switch
-               valid.push(char)         # Set valid short switches
-            }
-         }
-
-         re_long     = /^(--\w+[-\w+]*)?$/
-         re_short    = /^(-\w)$/
-         re_long_eq  = /^(--\w+[-\w+]*)?=(.*?)$|(-\w?)=(.*?)$/
-         re_short_sq = /^(-\w)(\S+?)$/
-
-         ARGV.each_with_index{ |opt, index|
-
-            # Allow either -x -v or -xv style for single char args
-            if re_short_sq.match(opt)
-               chars = opt.split("")[1..-1].map{ |s| s = "-#{s}" }
-
-               chars.each_with_index{ |char, i|
-                  unless valid.include?(char)
-                     raise Error, "invalid switch '#{char}'"
-                  end
-
-                  # Grab the next arg if the switch takes a required arg
-                  if types[char] == REQUIRED
-                     # Deal with a argument squished up against switch
-                     if chars[i+1]
-                        arg = chars[i+1..-1].join.tr('-', '')
-                        ARGV.push(char, arg)
-                        break
-                     else
-                        arg = ARGV.delete_at(index+1)
-                        if arg.nil? || valid.include?(arg) # Minor cheat here
-                           err = "no value provided for required argument '#{char}'"
-                           raise Error, err
-                        end
-                        ARGV.push(char, arg)
-                     end
-                  elsif types[char] == OPTIONAL
-                     if chars[i+1] && !valid.include?(chars[i+1])
-                        arg = chars[i+1..-1].join.tr("-","")
-                        ARGV.push(char, arg)
-                        break
-                     elsif
-                        if ARGV[index+1] && !valid.include?(ARGV[index+1])
-                           arg = ARGV.delete_at(index+1)
-                           ARGV.push(char, arg)
-                        end
-                     else
-                        ARGV.push(char)
-                     end
-                  else
-                     ARGV.push(char)
-                  end
-               }
-               next
-            end
+      re_long     = /^(--\w+[-\w+]*)?$/
+      re_short    = /^(-\w)$/
+      re_long_eq  = /^(--\w+[-\w+]*)?=(.*?)$|(-\w?)=(.*?)$/
+      re_short_sq = /^(-\w)(\S+?)$/
 
-            if match = re_long.match(opt) || match = re_short.match(opt)
-               switch = match.captures.first
-            end
+      ARGV.each_with_index do |opt, index|
+        # Allow either -x -v or -xv style for single char args
+        if re_short_sq.match(opt)
+          chars = opt.chars[1..].map{ |s| "-#{s}" }
 
-            if match = re_long_eq.match(opt)
-               switch, value = match.captures.compact
-               ARGV.push(switch, value)
-               next
+          chars.each_with_index do |char, i|
+            unless valid.include?(char)
+              raise Error, "invalid switch '#{char}'"
             end
 
-            # Make sure that all the switches are valid.  If 'switch' isn't
-            # defined at this point, it means an option was passed without
-            # a preceding switch, e.g. --option foo bar.
-            unless valid.include?(switch)
-               switch ||= opt
-               raise Error, "invalid switch '#{switch}'"
-            end
-
-            # Required arguments
-            if types[switch] == REQUIRED
-               nextval = ARGV[index+1]
-
-               # Make sure there's a value for mandatory arguments
-               if nextval.nil?
-                  err = "no value provided for required argument '#{switch}'"
-                  raise Error, err
-               end
-
-               # If there is a value, make sure it's not another switch
-               if valid.include?(nextval)
-                  err = "cannot pass switch '#{nextval}' as an argument"
+            # Grab the next arg if the switch takes a required arg
+            if types[char] == REQUIRED
+              # Deal with a argument squished up against switch
+              if chars[i + 1]
+                arg = chars[i + 1..].join.tr('-', '')
+                ARGV.push(char, arg)
+                break
+              else
+                arg = ARGV.delete_at(index + 1)
+                if arg.nil? || valid.include?(arg) # Minor cheat here
+                  err = "no value provided for required argument '#{char}'"
                   raise Error, err
-               end
-
-               # If the same option appears more than once, put the values
-               # in array.
-               if hash[switch]
-                  hash[switch] = [hash[switch], nextval].flatten
-               else
-                  hash[switch] = nextval
-               end
-               ARGV.delete_at(index+1)
+                end
+                ARGV.push(char, arg)
+              end
+            elsif types[char] == OPTIONAL
+              if chars[i + 1] && !valid.include?(chars[i + 1])
+                arg = chars[i + 1..].join.tr('-', '')
+                ARGV.push(char, arg)
+                break
+              elsif ARGV[index + 1] && !valid.include?(ARGV[index + 1])
+                arg = ARGV.delete_at(index + 1)
+                ARGV.push(char, arg)
+              else
+                ARGV.push(char)
+              end
+            else
+              ARGV.push(char)
             end
+          end
+          next
+        end
+
+        match = re_long.match(opt) || re_short.match(opt)
+        switch = match.captures.first if match
+
+        if match = re_long_eq.match(opt)
+          switch, value = match.captures.compact
+          ARGV.push(switch, value)
+          next
+        end
+
+        # Make sure that all the switches are valid.  If 'switch' isn't
+        # defined at this point, it means an option was passed without
+        # a preceding switch, e.g. --option foo bar.
+        unless valid.include?(switch)
+          switch ||= opt
+          raise Error, "invalid switch '#{switch}'"
+        end
+
+        # Required arguments
+        if types[switch] == REQUIRED
+          nextval = ARGV[index + 1]
+
+          # Make sure there's a value for mandatory arguments
+          if nextval.nil?
+            err = "no value provided for required argument '#{switch}'"
+            raise Error, err
+          end
+
+          # If there is a value, make sure it's not another switch
+          if valid.include?(nextval)
+            err = "cannot pass switch '#{nextval}' as an argument"
+            raise Error, err
+          end
+
+          # If the same option appears more than once, put the values in array.
+          if hash[switch]
+            hash[switch] = [hash[switch], nextval].flatten
+          else
+            hash[switch] = nextval
+          end
+
+          ARGV.delete_at(index + 1)
+        end
+
+        # For boolean arguments set the switch's value to true.
+        if types[switch] == BOOLEAN
+          if hash.key?(switch)
+            raise Error, 'boolean switch already set'
+          end
+          hash[switch] = true
+        end
+
+        # For increment arguments, set the switch's value to 0, or
+        # increment it by one if it already exists.
+        if types[switch] == INCREMENT
+          if hash.key?(switch)
+            hash[switch] += 1
+          else
+            hash[switch] = 1
+          end
+        end
+
+        # For negatable arguments, --foo sets true, --no-foo sets false.
+        # The value is stored under the base switch name (without --no-).
+        if types[switch] == NEGATABLE
+          base_switch = negs[switch] || switch
+          if hash.key?(base_switch)
+            raise Error, 'negatable switch already set'
+          end
+          hash[base_switch] = !negs.key?(switch) # true unless it's a --no- variant
+        end
+
+        # For optional argument, there may be an argument.  If so, it
+        # cannot be another switch.  If not, it is set to true.
+        if types[switch] == OPTIONAL
+          nextval = ARGV[index + 1]
+          if valid.include?(nextval)
+            hash[switch] = true
+          else
+            hash[switch] = nextval
+            ARGV.delete_at(index + 1)
+          end
+        end
+      end
 
-            # For boolean arguments set the switch's value to true.
-            if types[switch] == BOOLEAN
-               if hash.has_key?(switch)
-                  raise Error, 'boolean switch already set'
-               end
-               hash[switch] = true
-            end
+      # rubocop:disable Style/CombinableLoops
 
-            # For increment arguments, set the switch's value to 0, or
-            # increment it by one if it already exists.
-            if types[switch] == INCREMENT
-               if hash.has_key?(switch)
-                  hash[switch] += 1
-               else
-                  hash[switch] = 1
-               end
-            end
-
-            # For optional argument, there may be an argument.  If so, it
-            # cannot be another switch.  If not, it is set to true.
-            if types[switch] == OPTIONAL
-               nextval = ARGV[index+1]
-               if valid.include?(nextval)
-                  hash[switch] = true
-               else
-                  hash[switch] = nextval
-                  ARGV.delete_at(index+1)
-               end
-            end
-         }
-
-         # Set synonymous switches to the same value, e.g. if -t is a synonym
-         # for --test, and the user passes "--test", then set "-t" to the same
-         # value that "--test" was set to.
-         #
-         # This allows users to refer to the long or short switch and get
-         # the same value
-         hash.dup.each{ |switch, val|
-            if syns.keys.include?(switch)
-               syns[switch] = [syns[switch]]
-               syns[switch].each{ |key|
-                  hash[key] = val
-               }
-            end
-         }
-
-         # Get rid of leading "--" and "-" to make it easier to reference
-         hash.dup.each{ |key, value|
-            if key =~ /^-/
-               if key[0,2] == '--'
-                  nkey = key.sub('--', '')
-               else
-                  nkey = key.sub('-', '')
-               end
-               hash.delete(key)
-               hash[nkey] = value
-            end
-         }
+      # Set synonymous switches to the same value, e.g. if -t is a synonym
+      # for --test, and the user passes "--test", then set "-t" to the same
+      # value that "--test" was set to.
+      #
+      # This allows users to refer to the long or short switch and get
+      # the same value
+      hash.dup.each do |switch, val|
+        # Skip negated switches - they've already been mapped to base switch
+        next if negs.key?(switch)
+
+        if syns.keys.include?(switch)
+          syns[switch] = [syns[switch]]
+          syns[switch].each do |key|
+            hash[key] = val
+          end
+        end
+      end
 
-         hash
+      # Get rid of leading "--" and "-" to make it easier to reference
+      hash.dup.each do |key, value|
+        if key =~ /^-/
+          if key[0, 2] == '--'
+            nkey = key.sub('--', '')
+          else
+            nkey = key.sub('-', '')
+          end
+          hash.delete(key)
+          hash[nkey] = value
+        end
       end
 
-   end
+      # rubocop:enable Style/CombinableLoops
+
+      hash
+    end
+  end
 end