switches.rb 0.10.4 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea74840ee7d4c44d9a22e7e6c4464eb0417fd4ac0d65e0683465600188e2d903
-  data.tar.gz: 7f68a8a35001b0ff0445d605f276b3205c0651e3ab5a582e970fe5d4a771ea0a
+  metadata.gz: 073acfd47105841bff0a6643eebf2a8f1af398224feac75af268715a7dc666fa
+  data.tar.gz: ed0d87dd771ff98dbf4da3f8622fc6c6622ad78a630ec3c1f1108b07416c89cf
 SHA512:
-  metadata.gz: 284df213837788db6c63752a357d763e16a84ea37331eb405365a6754335e8372a70a7dc880caddd3f6220d4530ccf901a4bfff12e3e9482ebbc7b22433e0bf2
-  data.tar.gz: 2b067b99909da06acaa0e366dae1ac41307f5347cd44383a3a036bac06e21eac521b6d670ac2ff07b6eac6f3332f9b07ddcee590c51e1466f039823569465f94
+  metadata.gz: 5f4d4da5a5632926928b9bb357d1bad5bfc7e34f4e727d59887cd0ead5b7fd0b01c1de5468f563cea9137ca0bc730715026624b85ee71a7bd176ac3fe78193b6
+  data.tar.gz: 15d4316951b1ddb6e7bb5647e90964b1df3720d7b43d3313034a99f134d41008e91711f7c603654c64b9aba3a43c4e9daa6507333ee6f6a9ee7bbe3001498e8b

data/CHANGELOG

@@ -2,6 +2,13 @@
 
 ## 20260816
 
+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.
+2. ~ lib/Switches.rb: the missing-switch message names the hyphenated form, so a switch declared :access_token is reported as --access-token, in place of the --access_token built from the symbol verbatim. Cosmetic, and it says the form to prefer at a command line.
+3. ~ lib/Switches.rb: + Switches#switch_string, which builds the switch string for an attribute, in place of the identical construction #on_args and #check_required_switches each carried.
+4. ~ README.md: + a multi-word switch to the Usage section, and + a note recording where the behaviour comes from, that the setting is named for the symbol declared, and that declaring the attribute hyphenated buys nothing and costs the accessor.
+
 0.10.4: Declare ostruct as a runtime dependency, in place of installing it at require time.
 
 1. ~ lib/Switches.rb: require 'ostruct', in place of the require_gem 'ostruct' introduced in 0.10.0. require_gem rescues the LoadError and shells out to gem install, so the dependency went unannounced and was satisfied silently into whatever GEM_HOME was set — which, under a Homebrew formula's wrapper, means the program installing a gem into its own keg. A library should announce what it needs and fail loudly without it.

data/README.md

@@ -135,6 +135,12 @@ switches = Switches.new do |s|
   s.set(:a){'This is the -a switch.'}
 end
 
+# With a multi-word switch, which may be supplied in either its underscored or its hyphenated form
+switches = Switches.new do |s|
+  s.boolean(:update_template)
+end
+# --update_template and --update-template both set it, and the setting remains #update_template?
+
 # With a banner
 switches = Switches.new do |s|
   s.banner = 'Here is a banner for the switches.'
@@ -189,6 +195,7 @@ switches.class # => Hash
 - A `Switches` instance can't define a method whose name matches an `OptionParser` method, since such calls are forwarded to the underlying `OptionParser` instance.
 - 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`.
 
 ## Contributing
 

data/lib/Switches/VERSION.rb

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

data/lib/Switches.rb

@@ -284,12 +284,17 @@ class Switches
     end
   end
   
+  def switch_string(attr)
+    attr = attr.to_s
+    "-#{attr.long_switch? ? '-' : ''}#{attr.delete('?')}"
+  end
+  
   def on_args(requires_argument, options, *attrs, &block)
     on_args = []
     attrs.collect{|e| e.to_s}.each do |attr|
       @defaults[attr] = options[:default] if options[:default]
       @castings[attr] = (options[:cast] || options[:type] || options[:class]) if (options[:cast] || options[:type] || options[:class])
-      on_args << "-#{attr.long_switch? ? '-' : ''}#{attr.to_s.delete('?')}"
+      on_args << switch_string(attr)
     end
     if requires_argument
       on_args << (on_args.pop + ' REQUIRED_ARGUMENT')
@@ -310,7 +315,7 @@ class Switches
     messages = []
     @required_switches.each do |required_switch|
       unless supplied_switches.include?(required_switch)
-        messages << "required switch, -#{required_switch.long_switch? ? '-' : ''}#{required_switch.to_s.delete('?')}, is missing"
+        messages << "required switch, #{switch_string(required_switch).tr('_', '-')}, is missing"
       end
     end
     unless messages.empty?

data/spec/all.rb

@@ -164,6 +164,89 @@ describe Switches do
     end
   end
 
+  describe "multi-word switches" do
+    def build(switches_string = '')
+      ARGV.clear
+      switches_string.split.each{|a| ARGV << a}
+      Switches.new do |s|
+        s.boolean :update_template
+        s.set :access_token
+      end
+    end
+
+    it "sets a boolean switch supplied in its underscored form" do
+      expect(build('--update_template').update_template?).to eq(true)
+    end
+
+    it "sets a boolean switch supplied in its hyphenated form" do
+      expect(build('--update-template').update_template?).to eq(true)
+    end
+
+    it "sets a switch to the argument supplied in its underscored form" do
+      expect(build('--access_token abc123').access_token).to eq('abc123')
+    end
+
+    it "sets a switch to the argument supplied in its hyphenated form" do
+      expect(build('--access-token abc123').access_token).to eq('abc123')
+    end
+
+    it "names the setting for the symbol declared, whichever form is supplied" do
+      expect(build('--update-template --access-token abc123').to_h).to eq({update_template?: true, access_token: 'abc123'})
+    end
+  end
+
+  describe "multi-word switches with a required argument" do
+    def build(switches_string = '')
+      ARGV.clear
+      switches_string.split.each{|a| ARGV << a}
+      Switches.new do |s|
+        s.set! :access_token
+      end
+    end
+
+    it "sets the switch to the argument supplied in its underscored form" do
+      expect(build('--access_token abc123').access_token).to eq('abc123')
+    end
+
+    it "sets the switch to the argument supplied in its hyphenated form" do
+      expect(build('--access-token abc123').access_token).to eq('abc123')
+    end
+
+    it "raises OptionParser::MissingArgument when no argument is supplied to the underscored form" do
+      expect{build('--access_token')}.to raise_error(OptionParser::MissingArgument)
+    end
+
+    it "raises OptionParser::MissingArgument when no argument is supplied to the hyphenated form" do
+      expect{build('--access-token')}.to raise_error(OptionParser::MissingArgument)
+    end
+  end
+
+  describe "multi-word required switches" do
+    def build(switches_string = '')
+      ARGV.clear
+      switches_string.split.each{|a| ARGV << a}
+      Switches.new do |s|
+        s.required :access_token
+      end
+    end
+
+    it "counts the underscored form as supplied" do
+      expect(build('--access_token abc123').access_token).to eq('abc123')
+    end
+
+    it "counts the hyphenated form as supplied" do
+      expect(build('--access-token abc123').access_token).to eq('abc123')
+    end
+
+    it "raises RequiredSwitchMissing when neither form is supplied" do
+      expect{build}.to raise_error(RequiredSwitchMissing)
+    end
+
+    it "names the hyphenated form in the RequiredSwitchMissing message" do
+      expect{build}.to raise_error(RequiredSwitchMissing, /--access-token/)
+    end
+  end
+
   describe "#perform" do
     def build(switches_string = '', &block)
       ARGV.clear

metadata

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