clamp 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c164c63137c57502ad15e11ab471b2607661868298e5330a8a4961dfea629537
-  data.tar.gz: 297e0abb1ead811d567eea7e668a91ba7c99654657a358016abb5cdbfd13168d
+  metadata.gz: 43f15a863374d1abf2505c8b102de45e94f05146649728354c3d5593ff8f3a01
+  data.tar.gz: 5e9d629fa2e5947ba0060dfb831198ffa4a313a5faa7318b4efb4fd651bbb158
 SHA512:
-  metadata.gz: 3773151ffa64b908d26c569877bb27704bf68efe658d9b6ebd48c009bcbc1a4d0a3fce2c4f16a02ed379e126dd436ef018ff1eac56334fcc8f467402fad6c995
-  data.tar.gz: 8104ea9b1d9a42669234cb0d82cc441efd7a6f94ed5cba542a502ae1cb2797d977530a07bbe649d98dab551e9078b434711e091e9d0b3716799522c04436d8c9
+  metadata.gz: 8e68d1317f82da6b7275eb56ad1ef5be9b34fd2390e8819efd488558424c20e550ea4e625d90fa0d5d1303decd0ecd68e11138c4fc505fa66c876a00bd2de107
+  data.tar.gz: f16d43d5234ac429d1839f822177f55d1aee7e1d4eb94c49c6bcd2585c5a9049099a4bd426df01d2c8f409e7957d44c84a34c83adcc6a3710f62efcd11421d7e

data/.editorconfig

@@ -7,3 +7,4 @@ end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+max_line_length = 120

data/.gitignore

@@ -2,6 +2,7 @@
 .bundle
 .markdownlint*
 .rvmrc
+.ruby-version
 .yardoc
 doc
 pkg/*

data/.rubocop.yml

@@ -1,9 +1,13 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
-Eval:
-  Exclude:
-    - "Rakefile"
+Layout/LineLength:
+  Max: 120
 
 Layout/EmptyLinesAroundBlockBody:
   Enabled: false
@@ -21,9 +25,6 @@ Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 30
 
@@ -34,7 +35,7 @@ Naming/FileName:
   Exclude:
     - "bin/*"
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: false
 
 Style/ClassAndModuleChildren:
@@ -65,3 +66,6 @@ Style/StringLiterals:
 
 Style/WordArray:
   Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 2.3
   - 2.5
   - 2.6
+  - 2.7
+  - 3.0

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.3 (2025-07-31)
+
+* Raise an error if no value is provided for a non-flag switch.
+
 ## 1.3.2 (2020-08-20)
 
 * Fix Ruby warnings.

data/CODEOWNERS

@@ -0,0 +1 @@
+*	@mdub

data/Gemfile

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
 group :development do
   gem "guard-rspec", "~> 4.7", require: false
   gem "highline"
-  gem "listen", "~> 3.0"
-  gem "rake", "~> 12.3"
-  gem "rubocop", "~> 0.57.2", "<= 0.58", require: false
+  gem "listen", "~> 3.9"
+  gem "pry-byebug", "~> 3.11"
+  gem "rake", "~> 13.3"
+  gem "rubocop", "~> 1.79.0", require: false
+  gem "rubocop-rake", "~> 0.7.1", require: false
+  gem "rubocop-rspec", "~> 3.6.0", require: false
 end
 
 group :test do
-  gem "rspec", "~> 3.7"
+  gem "rspec", "~> 3.13"
 end

data/Guardfile

@@ -7,7 +7,7 @@
 # directories %w(app lib config test spec features) \
 #  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
 
-## Note: if you are using the `directories` clause above and you are not
+## NOTE: if you are using the `directories` clause above and you are not
 ## watching the project directory ('.'), then you will want to move
 ## the Guardfile to a watched dir and symlink it back, e.g.
 #
@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'

data/Rakefile

@@ -6,8 +6,6 @@ Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 
-task "default" => "spec"
-
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
   t.rspec_opts = ["--colour", "--format", "documentation"]
@@ -17,4 +15,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task "default" => "rubocop"
+task "default" => ["spec", "rubocop"]

data/clamp.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |s|
   TEXT
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = ">= 2.5", "< 4"
+  s.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/clamp/attribute/declaration.rb

@@ -30,6 +30,7 @@ module Clamp
 
       def define_default_for(attribute)
         return false if attribute.default_value.nil?
+
         define_method(attribute.default_method) do
           attribute.default_value
         end

data/lib/clamp/attribute/definition.rb

@@ -20,8 +20,8 @@ module Clamp
 
       def help_rhs
         rhs = description
-        comments = required_indicator || default_description
-        rhs += " (#{comments})" if comments
+        comments = [required_indicator, default_description].compact
+        rhs += " (#{comments.join(', ')})" unless comments.empty?
         rhs
       end
 
@@ -95,7 +95,9 @@ module Clamp
           ("$#{@environment_variable}" if defined?(@environment_variable)),
           (@default_value.inspect if defined?(@default_value))
         ].compact
+
         return nil if default_sources.empty?
+
         "#{Clamp.message(:default)}: " + default_sources.join(", #{Clamp.message(:or)} ")
       end
 

data/lib/clamp/attribute/instance.rb

@@ -70,8 +70,9 @@ module Clamp
         return if self.defined?
         return if attribute.environment_variable.nil?
         return unless ENV.key?(attribute.environment_variable)
+
         # Set the parameter value if it's environment variable is present
-        value = ENV[attribute.environment_variable]
+        value = ENV.fetch(attribute.environment_variable, nil)
         begin
           take(value)
         rescue ArgumentError => e

data/lib/clamp/help.rb

@@ -14,7 +14,7 @@ module Clamp
       @declared_usage_descriptions << usage
     end
 
-    attr_reader :declared_usage_descriptions
+    attr_reader :declared_usage_descriptions, :description
 
     def description=(description)
       @description = description.dup
@@ -29,8 +29,6 @@ module Clamp
       self.description = description
     end
 
-    attr_reader :description
-
     def derived_usage_description
       parts = ["[OPTIONS]"]
       parts += parameters.map(&:name)
@@ -84,7 +82,7 @@ module Clamp
       end
 
       def add_usage(invocation_path, usage_descriptions)
-        line Clamp.message(:usage_heading) + ":"
+        line "#{Clamp.message(:usage_heading)}:"
         usage_descriptions.each do |usage|
           line "    #{invocation_path} #{usage}".rstrip
         end
@@ -92,11 +90,12 @@ module Clamp
 
       def add_description(description)
         return unless description
+
         line
         line description.gsub(/^/, "  ")
       end
 
-      DETAIL_FORMAT = "    %-29s %s".freeze
+      DETAIL_FORMAT = "    %-29s %s"
 
       def add_list(heading, items)
         line

data/lib/clamp/messages.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Clamp #:nodoc:
+module Clamp # :nodoc:
 
   # Message lookup, to allow localization.
   #
@@ -21,8 +21,6 @@ module Clamp #:nodoc:
       init_default_messages
     end
 
-    private
-
     DEFAULTS = {
       too_many_arguments: "too many arguments",
       option_required: "option '%<option>s' is required",
@@ -42,6 +40,8 @@ module Clamp #:nodoc:
       options_heading: "Options"
     }.freeze
 
+    private
+
     def messages
       init_default_messages unless defined?(@messages)
       @messages

data/lib/clamp/option/declaration.rb

@@ -40,6 +40,7 @@ module Clamp
 
       def declare_implicit_help_option
         return false if effective_options.find { |o| o.handles?("--help") }
+
         help_switches = ["--help"]
         help_switches.unshift("-h") unless effective_options.find { |o| o.handles?("-h") }
         option help_switches, :flag, "print help" do
@@ -55,6 +56,7 @@ module Clamp
 
       def options_declared_on(ancestor)
         return [] unless ancestor.is_a?(Clamp::Option::Declaration)
+
         ancestor.declared_options
       end
 

data/lib/clamp/option/definition.rb

@@ -16,7 +16,9 @@ module Clamp
         @description = description
         super(options)
         @multivalued = options[:multivalued]
+
         return unless options.key?(:required)
+
         @required = options[:required]
         # Do some light validation for conflicting settings.
         raise ArgumentError, "Specifying a :default value with :required doesn't make sense" if options.key?(:default)
@@ -37,13 +39,13 @@ module Clamp
         @type == :flag
       end
 
-      def flag_value(switch)
-        !(switch =~ /^--no-(.*)/ && switches.member?("--\[no-\]#{Regexp.last_match(1)}"))
+      def flag_set?(switch)
+        !(switch =~ /^--no-(.*)/ && switches.member?("--[no-]#{Regexp.last_match(1)}"))
       end
 
       def read_method
         if flag?
-          super + "?"
+          "#{super}?"
         else
           super
         end
@@ -51,8 +53,10 @@ module Clamp
 
       def extract_value(switch, arguments)
         if flag?
-          flag_value(switch)
+          flag_set?(switch)
         else
+          raise ArgumentError, Clamp.message(:no_value_provided) if arguments.empty?
+
           arguments.shift
         end
       end
@@ -63,7 +67,7 @@ module Clamp
 
       def help_lhs
         lhs = switches.join(", ")
-        lhs += " " + type unless flag?
+        lhs += " #{type}" unless flag?
         lhs
       end
 
@@ -81,6 +85,7 @@ module Clamp
 
       def infer_attribute_name
         raise Clamp::DeclarationError, "You must specify either a long-switch or an :attribute_value" unless long_switch
+
         inferred_name = long_switch.sub(/^--(\[no-\])?/, "").tr("-", "_")
         inferred_name += "_list" if multivalued?
         inferred_name

data/lib/clamp/option/parsing.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Clamp #:nodoc:
+module Clamp # :nodoc:
 
   class << self
 
@@ -29,11 +29,16 @@ module Clamp #:nodoc:
         until remaining_arguments.empty?
           unless remaining_arguments.first.start_with?("-")
             break unless argument_buffer.size < argument_buffer_limit
+
             argument_buffer << remaining_arguments.shift
+
             next
           end
+
           switch = remaining_arguments.shift
+
           break if switch == "--"
+
           handle_switch(switch)
         end
         remaining_arguments.unshift(*argument_buffer)
@@ -42,8 +47,8 @@ module Clamp #:nodoc:
       def handle_switch(switch)
         switch = split_trailing_switches(switch)
         option = find_option(switch)
-        value = option.extract_value(switch, remaining_arguments)
         begin
+          value = option.extract_value(switch, remaining_arguments)
           option.of(self).take(value)
         rescue ArgumentError => e
           signal_usage_error Clamp.message(:option_argument_error, switch: switch, message: e.message)
@@ -55,7 +60,7 @@ module Clamp #:nodoc:
         when /\A(-\w)(.+)\z/m # combined short options
           switch = Regexp.last_match(1)
           if find_option(switch).flag?
-            remaining_arguments.unshift("-" + Regexp.last_match(2))
+            remaining_arguments.unshift("-#{Regexp.last_match(2)}")
           else
             remaining_arguments.unshift(Regexp.last_match(2))
           end

data/lib/clamp/parameter/declaration.rb

@@ -33,7 +33,9 @@ module Clamp
 
       def parameter_buffer_limit
         return 0 unless Clamp.allow_options_after_parameters
+
         return Float::INFINITY if inheritable_parameters.any?(&:multivalued?)
+
         inheritable_parameters.size
       end
 
@@ -41,6 +43,7 @@ module Clamp
 
       def superclass_inheritable_parameters
         return [] unless superclass.respond_to?(:inheritable_parameters, true)
+
         superclass.inheritable_parameters
       end
 

data/lib/clamp/parameter/definition.rb

@@ -32,19 +32,22 @@ module Clamp
 
       def consume(arguments)
         raise ArgumentError, Clamp.message(:no_value_provided) if required? && arguments.empty?
+
         arguments.shift(multivalued? ? arguments.length : 1)
       end
 
-      private
+      ELLIPSIS_SUFFIX = / \.\.\.$/.freeze
+      OPTIONAL = /^\[(.*)\]/.freeze
 
-      ELLIPSIS_SUFFIX = / \.\.\.$/
-      OPTIONAL = /^\[(.*)\]/
+      VALID_ATTRIBUTE_NAME = /^[a-z0-9_]+$/.freeze
 
-      VALID_ATTRIBUTE_NAME = /^[a-z0-9_]+$/
+      private
 
       def infer_attribute_name
         inferred_name = name.downcase.tr("-", "_").sub(ELLIPSIS_SUFFIX, "").sub(OPTIONAL) { Regexp.last_match(1) }
-        raise "cannot infer attribute_name from #{name.inspect}" unless inferred_name =~ VALID_ATTRIBUTE_NAME
+
+        raise "cannot infer attribute_name from #{name.inspect}" unless inferred_name.match? VALID_ATTRIBUTE_NAME
+
         inferred_name += "_list" if multivalued?
         inferred_name
       end

data/lib/clamp/parameter/parsing.rb

@@ -18,13 +18,11 @@ module Clamp
 
       def set_parameters_from_command_line
         self.class.parameters.each do |parameter|
-          begin
-            parameter.consume(remaining_arguments).each do |value|
-              parameter.of(self).take(value)
-            end
-          rescue ArgumentError => e
-            signal_usage_error Clamp.message(:parameter_argument_error, param: parameter.name, message: e.message)
+          parameter.consume(remaining_arguments).each do |value|
+            parameter.of(self).take(value)
           end
+        rescue ArgumentError => e
+          signal_usage_error Clamp.message(:parameter_argument_error, param: parameter.name, message: e.message)
         end
       end
 

data/lib/clamp/subcommand/declaration.rb

@@ -31,8 +31,9 @@ module Clamp
       def find_subcommand_class(*names)
         names.inject(self) do |command_class, name|
           return nil unless command_class
+
           subcommand = command_class.find_subcommand(name)
-          subcommand.subcommand_class if subcommand
+          subcommand&.subcommand_class
         end
       end
 
@@ -42,6 +43,7 @@ module Clamp
 
       def default_subcommand=(name)
         raise Clamp::DeclarationError, "default_subcommand must be defined before subcommands" if has_subcommands?
+
         @default_subcommand = name
       end
 

data/lib/clamp/subcommand/execution.rb

@@ -25,6 +25,7 @@ module Clamp
         subcommand = subcommand_class.new(invocation_path_for(name), context)
         self.class.inheritable_attributes.each do |attribute|
           next unless attribute.of(self).defined?
+
           attribute.of(subcommand).set(attribute.of(self).get)
         end
         subcommand
@@ -38,6 +39,7 @@ module Clamp
       def find_subcommand_class(name)
         subcommand_def = self.class.find_subcommand(name)
         return subcommand_def.subcommand_class if subcommand_def
+
         subcommand_missing(name)
       end
 

data/lib/clamp/subcommand/parsing.rb

@@ -13,6 +13,7 @@ module Clamp
 
       def parse_subcommand
         return false unless self.class.has_subcommands?
+
         extend(Subcommand::Execution)
       end
 

data/lib/clamp/truthy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Clamp #:nodoc:
+module Clamp # :nodoc:
 
   TRUTHY_VALUES = %w[1 yes enable on true].freeze
 

data/lib/clamp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clamp
-  VERSION = "1.3.2".freeze
+  VERSION = "1.3.3"
 end