switches.rb 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc49f311d672f64884c36a8b1645d17be83d83df5e630a272a4740db00a48448
-  data.tar.gz: 9a5b8accb318737020f7d1c03dfee96ae21529dafe357aabc62abcbd5314dc5a
+  metadata.gz: 60984de78f4a7074bd1f41f4293bcf5c4fb4d837c138bb59f2b7d3519cf17372
+  data.tar.gz: ed1fd8d58a77fd2335d047dea552326759291b7f985cc027004b0bde774e603b
 SHA512:
-  metadata.gz: 0171a8d12cacc99884b6606f08fb5fbf2ac048e5f9d8ed147e3bfe224a2724d2ecb6fc6d077edc9e533a2a7d4dfd2a0fb9c8563f63824ed0cd78506f6c708795
-  data.tar.gz: 7888b090acfe50edc7ded58b12b005232be881e0c9489edb07dec7fd126ec7afb8ef1a1cb926682e0eec96bd19efc4a5f26e9a555341f637e3caa60a905f04b8
+  metadata.gz: '080a361c32b9e9db115abe54e677cbd4ceff39d8f895c8a2d4e4819bf27b81393e5f3636550f12b52e547d9aa58398302d29506fe67c0ff9e2215a27f78f6aa9'
+  data.tar.gz: 4dc836fb4dc0195323b31013af2367657eb1d8ac21cb87a1ec09d0dc7b2d0e6aebe164ae49475a866053765ec5b9047734d64e580076fcf78f75c802107dc569

data/CHANGELOG

@@ -2,6 +2,13 @@
 
 ## 20260816
 
+0.12.0: Refuse a switch whose accessor is a method the instance already has, rather than losing it.
+
+1. + lib/Switches.rb: Switches#check_switch_names, called first in #do_set and #do_action, which raises where respond_to?(accessor) is true, #method_missing firing only where no method exists.
+2. + lib/Switches.rb: SwitchNameCollision < ArgumentError.
+3. ~ README.md: + a Notes entry for the refusal, and for the booleans and OptionParser names it does not cover.
+4. + spec/all.rb: the refusal through #set and #perform, the message, that nothing reaches the parser first, and the two legal cases.
+
 0.11.0: Forward to OptionParser, which #method_missing has never actually done.
 
 1. ~ lib/Switches.rb: #method_missing tested (@op.methods - Switches.instance_methods).include?(method_name.to_s), which compares a String against an array of Symbols and so was never true. Every call fell through to the settings OpenStruct, which accepts anything, so s.banner = '...' — documented in the README's "With a banner" example — silently became a setting named banner while the parser kept its default of "Usage: <program_name> [options]". The comparison is now made in symbols, and the forwarding works: #banner=, #separator, #program_name= and the other 58 OptionParser methods reach the parser.

data/README.md

@@ -192,6 +192,7 @@ switches.class # => Hash
 ## Notes
 
 - The switch `-?` can't be used, since there is no Ruby method `#?` for it to map to.
+- A switch whose accessor would be a method the instance already has is refused at declaration, with a `SwitchNameCollision`. `s.set(:tap)` raises, `#tap` being `Kernel#tap` and so never reaching the settings; so do `Switches`' own methods, `s.set(:settings)` and `s.set(:set)` among them. The same name is fine as a boolean, since `s.boolean(:tap)` reads back through `#tap?`, and fine where the collision is with `OptionParser` rather than the instance, a declared switch winning over the parser.
 - A call which is neither a switch nor a `Switches` method is forwarded to the underlying `OptionParser`, which is what makes `s.banner = '...'` and `s.separator '...'` work. A declared switch wins over an `OptionParser` method of the same name, so `s.set(:version)` still reads back through `#version`; without that rule a switch called `--version`, `--help`, `--load` or `--order` would be shadowed by the parser, all four being names `OptionParser` has. The names Ruby may call implicitly — `#to_a`, `#to_s` and the rest of `Switches::NEVER_FORWARDED` — are never forwarded, since `OptionParser#to_a` answers with the help and would otherwise be what `Array(switches)` and `[*switches]` gave you.
 - There is a clear demarcation between whether a switch's argument is required and whether the switch itself is required.
 - The bang interface methods (for example `set!` and `required!`) modify the switch in place with a required argument, rather than relying on a default or a value set elsewhere and later.

data/lib/Switches/VERSION.rb

@@ -2,5 +2,5 @@
 # Switches::VERSION
 
 class Switches
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/lib/Switches.rb

@@ -150,6 +150,7 @@ module CastingInterfaceMethods
 end
 
 class RequiredSwitchMissing < RuntimeError; end
+class SwitchNameCollision < ArgumentError; end
 
 class Switches
   
@@ -257,6 +258,7 @@ class Switches
   private
   
   def do_set(requires_argument, *attrs, &block)
+    check_switch_names(*attrs)
     set_if_required_switch(*attrs)
     options = attrs.extract_options!
     @all_switches = @all_switches + attrs.collect{|a| a.to_s}
@@ -268,6 +270,7 @@ class Switches
   end
   
   def do_action(requires_argument, *attrs, &block)
+    check_switch_names(*attrs)
     attrs.each do |attr|
       @settings.send(attr.to_s + '=', nil) # Needs to be set prior to checking for required switches, since that check relies upon the key having been set in @settings.  
     end
@@ -299,6 +302,14 @@ class Switches
     @all_switches.include?(method_name.to_s.delete_suffix('='))
   end
   
+  def check_switch_names(*attrs)
+    attrs.each do |attr|
+      next unless attr.is_a?(Symbol) || attr.is_a?(String)
+      next unless respond_to?(attr.to_s)
+      raise SwitchNameCollision, "switch, #{switch_string(attr)}, is already #{method(attr.to_s).owner}##{attr}, so it would never reach the settings"
+    end
+  end
+
   def switch_string(attr)
     attr = attr.to_s
     "-#{attr.long_switch? ? '-' : ''}#{attr.delete('?')}"

data/spec/all.rb

@@ -164,6 +164,51 @@ describe Switches do
     end
   end
 
+  describe "switch names which collide with a method" do
+    def build(&block)
+      ARGV.clear
+      Switches.new(&block)
+    end
+
+    it "refuses a switch named after a core method" do
+      expect{build{|s| s.set(:tap)}}.to raise_error(SwitchNameCollision, /Kernel#tap/)
+    end
+
+    it "refuses a switch named after a Switches method" do
+      expect{build{|s| s.set(:settings)}}.to raise_error(SwitchNameCollision, /Switches#settings/)
+    end
+
+    it "refuses a colliding name declared through #perform" do
+      expect{build{|s| s.perform(:display){}}}.to raise_error(SwitchNameCollision)
+    end
+
+    it "names the switch in the form it would be supplied in" do
+      expect{build{|s| s.set(:instance_variable_get)}}.to raise_error(SwitchNameCollision, /--instance_variable_get/)
+    end
+
+    it "raises before the switch is declared to the parser" do
+      switches = Switches.new
+      begin; switches.set(:tap); rescue SwitchNameCollision; end
+      expect(switches.to_h).to eq({})
+    end
+
+    it "accepts the name as a boolean, the accessor then carrying a question mark" do
+      ARGV.clear
+      ARGV << '--tap'
+      expect(Switches.new{|s| s.boolean(:tap)}.tap?).to eq(true)
+    end
+
+    it "accepts a name OptionParser has, a declared switch winning over the parser" do
+      ARGV.clear
+      %w{--banner text}.each{|a| ARGV << a}
+      expect(Switches.new{|s| s.set(:banner)}.banner).to eq('text')
+    end
+
+    it "raises a SwitchNameCollision, which is an ArgumentError" do
+      expect(SwitchNameCollision.ancestors).to include(ArgumentError)
+    end
+  end
+
   describe "OptionParser methods" do
     def build(&block)
       ARGV.clear

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switches.rb
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - thoran