switches.rb 0.10.5 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 073acfd47105841bff0a6643eebf2a8f1af398224feac75af268715a7dc666fa
-  data.tar.gz: ed0d87dd771ff98dbf4da3f8622fc6c6622ad78a630ec3c1f1108b07416c89cf
+  metadata.gz: 60984de78f4a7074bd1f41f4293bcf5c4fb4d837c138bb59f2b7d3519cf17372
+  data.tar.gz: ed1fd8d58a77fd2335d047dea552326759291b7f985cc027004b0bde774e603b
 SHA512:
-  metadata.gz: 5f4d4da5a5632926928b9bb357d1bad5bfc7e34f4e727d59887cd0ead5b7fd0b01c1de5468f563cea9137ca0bc730715026624b85ee71a7bd176ac3fe78193b6
-  data.tar.gz: 15d4316951b1ddb6e7bb5647e90964b1df3720d7b43d3313034a99f134d41008e91711f7c603654c64b9aba3a43c4e9daa6507333ee6f6a9ee7bbe3001498e8b
+  metadata.gz: '080a361c32b9e9db115abe54e677cbd4ceff39d8f895c8a2d4e4819bf27b81393e5f3636550f12b52e547d9aa58398302d29506fe67c0ff9e2215a27f78f6aa9'
+  data.tar.gz: 4dc836fb4dc0195323b31013af2367657eb1d8ac21cb87a1ec09d0dc7b2d0e6aebe164ae49475a866053765ec5b9047734d64e580076fcf78f75c802107dc569

data/CHANGELOG

@@ -2,6 +2,26 @@
 
 ## 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.
+2. ~ lib/Switches.rb: a declared switch takes precedence over an OptionParser method of the same name, + Switches#declared_switch?. Making the forwarding work otherwise shadows any switch sharing a name with the parser, and OptionParser has version, help, release, load, order, top, base, parse, warn, abort and banner among its 61, several of which are switches a program would reasonably want. The rule is that the program's own declarations beat the wrapper's interface, which also leaves any existing program's switches reading as they did.
+3. ~ lib/Switches.rb: + Switches::NEVER_FORWARDED, the names Ruby may call implicitly, which are excluded from the forwarded set. The set has always been built by subtraction — everything the parser responds to, less everything Switches defines — which admits any such name Switches does not happen to define. OptionParser#to_a is `summarize("#{banner}".split(/^/))`, so without the exclusion Array(switches) and [*switches] answer with the parser's help. That was latent for as long as the branch was dead and became reachable the moment it was not, so it is part of this fix rather than a consequence of it. to_h was never at risk, but only because Switches happens to define it; the constant makes the exclusion deliberate rather than incidental.
+4. ~ lib/Switches.rb: + Switches#option_parser_methods, memoised, since the difference was recomputed upon every settings read, and + Switches#option_parser_method?.
+5. + spec/all.rb: forwarding of a writer, of a method taking an argument, and of a reader, each checked through the parser's own help output rather than by reading back what was written; that a declared switch wins over the OptionParser method of the same name, read and written; that a name which is neither still reaches the settings; and that #to_a, Array() and the splat are answered by the switches rather than the parser.
+6. ~ README.md: the Notes entry claiming a Switches instance can't define a method whose name matches an OptionParser method now describes what happens, which is the reverse: the switch wins.
+
+Not done: #respond_to_missing?, which ordinarily accompanies #method_missing. Note that it would not have prevented the to_a case above — Ruby's conversion check falls back to calling #method_missing directly when the ordinary dispatch fails, so Array() reaches #to_a whatever respond_to? answers. It wants deciding alongside the collision question below, both being about which names the object should own.
+
+Still outstanding: the converse fault, where #method_missing does not fire at all because the method exists. A switch named after a method Object already has — :tap, :class, :display, :hash, :method, :type — never reaches the settings, and Kernel#tap without a block raises LocalJumpError nowhere near the declaration.
+
 0.10.5: Specify and document that a multi-word switch may be supplied hyphenated, and name that form when it is missing.
 
 1. + spec/all.rb: multi-word switches, in both their underscored and their hyphenated form, for a boolean, an optional argument (#set), a required argument (#set!) and a required switch (#required); that either form counts as supplied for a required switch; and that the setting is named for the symbol declared whichever form was supplied. This behaviour is OptionParser's rather than this library's — a long switch is filed under a lookup key with its underscores turned to hyphens, and whatever is supplied is converted the same way before the lookup, so --update_template and --update-template have always been the one switch. It went untested and undocumented here, which left it resting upon an implementation detail of a library this one only wraps. The specs now pin it, and would fail here rather than in a caller's script were it ever to change.

data/README.md

@@ -192,7 +192,8 @@ switches.class # => Hash
 ## Notes
 
 - The switch `-?` can't be used, since there is no Ruby method `#?` for it to map to.
-- A `Switches` instance can't define a method whose name matches an `OptionParser` method, since such calls are forwarded to the underlying `OptionParser` instance.
+- 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.
 - A long switch whose name carries an underscore may be supplied in its hyphenated form as well, so `s.boolean(:update_template)` accepts both `--update_template` and `--update-template`. This comes from `OptionParser`, which files a long switch under a lookup key with its underscores turned to hyphens and applies the same conversion to whatever is supplied, so the two forms are one switch rather than two. The setting is named for the symbol declared, and so remains `#update_template?` whichever form was supplied. Declaring the attribute hyphenated, as `:'update-template'`, buys nothing and costs the accessor, which would then be reachable only through `#send`.

data/lib/Switches/VERSION.rb

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

data/lib/Switches.rb

@@ -150,9 +150,13 @@ module CastingInterfaceMethods
 end
 
 class RequiredSwitchMissing < RuntimeError; end
+class SwitchNameCollision < ArgumentError; end
 
 class Switches
   
+  # Names Ruby may call implicitly, and which must reach the settings rather than OptionParser.  #to_a would otherwise answer Array() and the splat with the parser's help.
+  NEVER_FORWARDED = [:to_a, :to_ary, :to_h, :to_hash, :to_s, :to_str, :pretty_print]
+  
   class << self
     
     def as_h(*args)
@@ -254,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}
@@ -265,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
@@ -277,13 +283,33 @@ class Switches
   end
   
   def method_missing(method_name, *args, &block)
-    if (@op.methods - Switches.instance_methods).include?(method_name.to_s)
-      @op.send(method_name.to_s, *args, &block)
+    if option_parser_method?(method_name) && !declared_switch?(method_name)
+      @op.send(method_name, *args, &block)
     else
-      @settings.send(method_name.to_s, *args, &block)
+      @settings.send(method_name, *args, &block)
     end
   end
   
+  def option_parser_methods
+    @option_parser_methods ||= @op.methods - Switches.instance_methods - NEVER_FORWARDED
+  end
+  
+  def option_parser_method?(method_name)
+    option_parser_methods.include?(method_name.to_sym)
+  end
+  
+  def declared_switch?(method_name)
+    @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,102 @@ 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
+      Switches.new(&block)
+    end
+
+    it "forwards a writer to the OptionParser" do
+      expect(build{|s| s.banner = 'Usage: tap-audit [options]'}.help).to match(/\AUsage: tap-audit \[options\]/)
+    end
+
+    it "forwards a method taking an argument to the OptionParser" do
+      expect(build{|s| s.separator 'Options:'}.help).to match(/^Options:$/)
+    end
+
+    it "forwards a reader to the OptionParser" do
+      switches = build{|s| s.program_name = 'tap-audit'}
+      expect(switches.program_name).to eq('tap-audit')
+      expect(switches.help).to match(/\AUsage: tap-audit/)
+    end
+
+    it "prefers a declared switch to the OptionParser method of the same name" do
+      ARGV.clear
+      %w{--version 2.1}.each{|a| ARGV << a}
+      expect(Switches.new{|s| s.set(:version)}.version).to eq('2.1')
+    end
+
+    it "prefers a declared switch when it is written to as well" do
+      switches = build{|s| s.set(:banner)}
+      switches.banner = 'a setting, not the banner'
+      expect(switches.to_h[:banner]).to eq('a setting, not the banner')
+    end
+
+    it "falls through to the settings for a name which is neither" do
+      expect(build{|s| s.set(:port)}.nonesuch).to eq(nil)
+    end
+
+    it "does not forward #to_a, which OptionParser answers with its help" do
+      expect(build{|s| s.set(:port)}.to_a).to eq(nil)
+    end
+
+    it "leaves Array() with the switches rather than the parser's help" do
+      switches = build{|s| s.set(:port)}
+      expect(Array(switches)).to eq([switches])
+    end
+
+    it "leaves the splat with the switches rather than the parser's help" do
+      switches = build{|s| s.set(:port)}
+      expect([*switches]).to eq([switches])
+    end
+  end
+
   describe "multi-word switches" do
     def build(switches_string = '')
       ARGV.clear

metadata

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