switches.rb 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e900150793418981ab52b35828a2fc696a5e7b826d4eba77047d96cc7532dfe
-  data.tar.gz: f4e598c29f7dbaf2c61b8e685151732afba5770b94085cbe06a413f85151b692
+  metadata.gz: 3522ecf029cdd554e02bb72d5620de851dfeb091421cfa2efea8c9d115f8d935
+  data.tar.gz: 75a81b0ca90c8d6125e4bbac37cc5840291b17bbaef5598050db2c97d27a2742
 SHA512:
-  metadata.gz: fe23cc64afe81e073164650ef50b64ae208cfc57cc82a9e6e57efc4925f8cd87853b0b5726f2dea6cbe528cf9348fc1499e9e5fe6febf2e9f4348eb96a1b2e9e
-  data.tar.gz: 4ab5f810b80fc2716684aaa46481a2e83db7bf628a6a81bdfe25c4f1ed588eaf3fb090fd011e92df3592ec93962e2915b2ec3f0821c4d93081f04624e207a7cc
+  metadata.gz: 852da32c748e8b771122eb84e54fb4aaba785a0a973c5b377cfa0c89fd36e6095812dfa96bb466ecd47a637fbd994b14fb6868a1db6a1a0c870e97570a389fc6
+  data.tar.gz: c6ffc907d26d8219cee5e6b011a1f0746574139867b7ae4249c7589262394be5b13022d28a04cad9cffc6429f62b88a4acb67c4b5c121c12f0af4405a16bc0c5

data/CHANGELOG

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 20260812
+
+0.10.2: Recover the in-source change log into the CHANGELOG, and move the Notes to the README.
+
+1. + CHANGELOG: the 0.9.0 to 0.9.13 series, recovered from the "Changes since 0.8:" log that lived in the lib/Switches.rb header. The items are reproduced as written; the versions carry no reliable dates and are left undated.
+2. + README.md: a Notes section, carrying the notes from the lib/Switches.rb header — the unusable "-?" switch, the clash between Switches methods and OptionParser methods, the required/optional demarcation, and the bang interface methods.
+3. - lib/Switches.rb: the "# Changes since 0.8:" log (now in the CHANGELOG) and the "# Notes:" section (now in the README). The rest of the header — Description, Todo, Ideas, Dependencies — stays.
+
+
 ## 20260809
 
 0.10.1: Get the specs running again, under rspec 3 and rake.
@@ -28,4 +37,132 @@
 
 0.9.14: Turn switches into a gem, convert the README to markdown, and remove the examples directory.
 
-Nothing before 0.9.14 is recorded here: switches began in 2009, and its pre-gem history — the 0.4.0 to 0.9.13 series noted in the source header — carries no reliable per-version dates.
+The 0.9.0 to 0.9.13 series below is recovered from the "Changes since 0.8:" log that was kept in the lib/Switches.rb header (removed in 0.10.2); the items are reproduced as they were written there. switches began in 2009 and this pre-gem history carries no reliable per-version dates, so these entries are undated. Nothing before 0.9.0 — the 0.4.0 to 0.8.x Options era — is recorded.
+
+0.9.13: Swap a couple of @settings.instance_variable_get(:@table)'s for OpenStruct#to_h's.
+
+1. Swapped out a couple of @settings.instance_variable_get(:@table)'s for OpenStruct#to_h's.
+
+0.9.12: Remove the default aliases for default_to, which clashed with the mail gem's Mail::Message#default.
+
+1. - Object#default.
+2. - NilClass#default.
+
+0.9.11: Fix the defaults overwriting the supplied settings.
+
+1. ~ Switches#set_switches_with_defaults to check if a setting had been set before applying a default value.
+
+0.9.10: OpenStruct#to_h and Switches#to_h.
+
+1. + OpenStruct#to_h.
+2. ~ Switches#to_h.
+
+0.9.9: A large batch — full missing-switch reporting, required_perform, default_is, and Array/Module helpers.
+
+1. ~ Switches#check_required_switches, so as it now assembles the complete list of missing switches rather than failing on and reporting only the first.
+2. + Switches#required_perform
+3. + Switches#required_perform!
+4. - OptionParse#soft_parse, since this was never used here, but only in Attributes.
+5. + Object#default_is(et.al.)
+6. + NilClass#default_is(et.al.) overrides Object#default_is for the specific case of nil.
+7. /switches_defaults/switches_with_defaults/.
+8. + Array#peek_options.
+9. + Array#poke_options!.
+10. + Array#all_but_last.
+11. + Array#last!.
+12. + Module#alias_methods.
+13. ~ CastingInterfaceMethods, to make use of Array#poke_options.
+14. + CastingInterfaceMethods#flag.
+15. + Switches.as_h (and associated aliased interfaces).
+16. ~ Switches#initialize, arguments are now a splat with the intention of allowing both casting_interface_methods and as_h being specified as a hash supplied to the initialiser.
+17. ~ Switches, to make use of Module#alias_methods.
+18. ~ Switches, to make use of Array#peek_options and Array#poke_options!.
+19. + Switches#required_perform.
+20. + Switches#required_perform!.
+21. + Switches#switches_with_defaults.
+22. + Switches#switches_with_castings.
+23. + Swtiches#to_h.
+24. + Switches#set_if_required_switch.
+25. + Switches#set_switches_with_defaults.
+26. ~ Switches#parse!, + set_switches_with_defaults() and + to_h().
+27. ~ Switches#do_set, + set_if_required_switch().
+28. ~ Switches#do_action, + set_if_required_switch().
+29. ~ Switches#on_args, so as it can handle castings.
+
+0.9.8: Add #perform and #perform!, plus #do_action and the #on_args changes to support them.
+
+1. ~ Switches#on_args, so as if a block is supplied which is not returning a String, then it will not be placed into the on_args argument list.
+2. + Switches#perform, interface for actions which don't require an argument.
+3. + Switches#perform!, interface for actions which do require an argument.
+4. + Switches#do_action, executes a block when called by either of #perform or #perform!.
+
+0.9.7: Some small tidyups and removal of the self-run section.
+
+1. ~ Switches#on_args, shorter when handling casting arguments.
+2. /unused_switches/unset_switches/.
+3. ~ Switches#check_required_switches, so that the message is not being assigned until a switch is missing.
+4. Removed the self-run section and moved it to ./test/run.rb.
+
+0.9.6: Fix the setting of defaults overriding supplied switch values.
+
+1. ~ Switches#set_unused_switches, to make use of #switch_defaults and #unused_switches.
+2. + Switches#switch_defaults, as an interface method since it might be useful for querying at some point?
+3. + Switches#unused_switches, also as an interface method since it might also be useful for querying at some point?
+4. ~ Switches#on_args, so as to enable alternate hash keys (:type and :class) for type casting.
+5. ~ self-run section to reflect the optionalness/optionality(?) of summaries.
+
+0.9.5: Add default values for switches.
+
+1. ~ CastingInterfaceMethods to extract any options before pushing a cast option, since it was overwriting for those casting interface methods.
+2. ~ Switches#initialize, + @defaults.
+3. /Switches#set_unused_switches_to_nil/Switches#set_unused_switches/.
+4. ~ Switches#set_unused_switches, so as it handles setting unused switches with a default.
+
+0.9.4: Add the casting interface methods.
+
+1. + CastingInterfaceMethods#integer(!).
+2. + CastingInterfaceMethods#float(!).
+3. + CastingInterfaceMethods#array(!).
+4. + CastingInterfaceMethods#regex(p)(!).
+5. + CastingInterfaceMethods#boolean(!).
+6. ~ Switches#initialize + include_casting_interface_methods.
+7. /String#short_arg?/String#short_switch?/.
+8. /String#long_arg?/String#long_switch?/.
+9. ~ Switches#on_args - boolean_switch.
+
+0.9.3: Rename the library file.
+
+1. /Options.rb/Switches.rb/.
+
+0.9.2: Add casting to nominated Ruby classes.
+
+1. ~ Switches#on_args + options.
+2. + Array#extract_options!.
+3. + Switches#allowed.
+4. + Switches#allowed!.
+5. + Swithces#mandatory.
+6. + Switches#necessary.
+7. ~ Switches#do_set + ...options.
+8. ~ Switches#on_args + ...options[:cast].
+9. ~ self-run section to do a simple test of casting.
+
+0.9.1: Remove ! from the switch-setting methods and move those to the Switches interface methods.
+
+1. + Switches#do_set.
+2. ~ Switches#set.
+3. + Switches#set!.
+4. + Switches#required!.
+5. - String#required_arg?.
+6. ~ Switches#on_args + requires_argument.
+
+0.9.0: Rename the project from Options to Switches, since there are required switches now and required options don't make sense.
+
+1. /Options/Switches/.
+2. /RequiredOptionMissing/RequiredSwitchMissing/.
+3. /String#boolean_arg?/String#boolean_switch?/.
+4. Other references to options changed to switches.
+5. + Switches#required/mandatory/necessary.
+6. + Swtiches#optional.
+7. + Switches#supplied_switches.
+8. + Switches#set_unused_switches_to_nil.
+9. ~ self-run section to reflect new interface.

data/README.md

@@ -183,6 +183,13 @@ 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.
+- 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.
+
 ## Contributing
 
 1. Fork it ( https://github.com/thoran/HTTP/fork )

data/lib/Switches.rb

@@ -15,130 +15,9 @@
 # 2. Do away with optional arguments entirely.  Since when does anyone want to specify a non-boolean switch and then supply no arguments anyway?...  OK, maybe sometimes, but this is pretty obscure IMO.  OK, bad idea.  These can be used as action oriented sub-commands.  
 # 3. Allow for any one of the switches OpenStruct methods to assign values for any of the other associated methods, so as it is more than a read once switch and can be used for storage through out the application; although this might be stepping on Attributes.rb's toes?...  
 
-# Notes: 
-# 1. A limitation is the inability to use the switch, "-?", since there is no Ruby method, #?.  
-# 2. An additional limitation is that the Switches class cannot have methods which are the same as any OptionParser methods since these will be forwarded to the OptionParser instance, @op.  
-# 3. In 0.9.0 there is finally now a clear demarcation between switch arguments and switches themselves being mandatory or optional.  
-# 4. It mostly makes sense that the Switches interface methods are bang methods, since it is modifying that switch in place with a required argument, rather than relying upon a default or otherwise set value elsewhere and presumably later than when the switch was set.  
-
 # Dependencies: 
 # 1. Standard Ruby Library.  
 
-# Changes since 0.8:
-# (Renamed this project/class from Options to Switches since there are required switches now and required options don't make sense.)
-# 1. /Options/Switches/.  
-# 2. /RequiredOptionMissing/RequiredSwitchMissing/.  
-# 3. /String#boolean_arg?/String#boolean_switch?/.  
-# 4. Other references to options changed to switches.  
-# 5. + Switches#required/mandatory/necessary.  
-# 6. + Swtiches#optional.  
-# 7. + Switches#supplied_switches.  
-# 8. + Switches#set_unused_switches_to_nil.  
-# 9. ~ self-run section to reflect new interface.  
-# 0/1 (Removed ! from switch setting methods and moved those to the Switches interface methods.)
-# 10. + Switches#do_set.  
-# 11. ~ Switches#set.  
-# 12. + Switches#set!.  
-# 13. + Switches#required!.  
-# 14. - String#required_arg?.  
-# 15. ~ Switches#on_args + requires_argument.  
-# 1/2 (Added casting to nominated Ruby classes.)
-# 16. ~ Switches#on_args + options.  
-# 17. + Array#extract_options!.  
-# 18. + Switches#allowed.  
-# 19. + Switches#allowed!.  
-# 20. + Swithces#mandatory.  
-# 21. + Switches#necessary.  
-# 22. ~ Switches#do_set + ...options.  
-# 23. ~ Switches#on_args + ...options[:cast].  
-# 24. ~ self-run section to do a simple test of casting.  
-# 2/3 (Renaming the library file.)
-# 25. /Options.rb/Switches.rb/.  
-# 3/4 (+ casting interface methods)
-# 26. + CastingInterfaceMethods#integer(!).  
-# 27. + CastingInterfaceMethods#float(!).  
-# 28. + CastingInterfaceMethods#array(!).  
-# 29. + CastingInterfaceMethods#regex(p)(!).  
-# 30. + CastingInterfaceMethods#boolean(!).  
-# 31. ~ Switches#initialize + include_casting_interface_methods.  
-# 32. /String#short_arg?/String#short_switch?/.  
-# 33. /String#long_arg?/String#long_switch?/.  
-# 34. ~ Switches#on_args - boolean_switch.  
-# 4/5 (Added default values for switches.)
-# 35. ~ CastingInterfaceMethods to extract any options before pushing a cast option, since it was overwriting for those casting interface methods.  
-# 36. ~ Switches#initialize, + @defaults.  
-# 37. /Switches#set_unused_switches_to_nil/Switches#set_unused_switches/.  
-# 38. ~ Switches#set_unused_switches, so as it handles setting unused switches with a default.  
-# 5/6 (Setting of defaults was overriding supplied switch values.)
-# 39. ~ Switches#set_unused_switches, to make use of #switch_defaults and #unused_switches.  
-# 40. + Switches#switch_defaults, as an interface method since it might be useful for querying at some point?  
-# 41. + Switches#unused_switches, also as an interface method since it might also be useful for querying at some point?  
-# 42. ~ Switches#on_args, so as to enable alternate hash keys (:type and :class) for type casting.  
-# 43. ~ self-run section to reflect the optionalness/optionality(?) of summaries.  
-# 6/7 (Some small tidyups and removal of self-run section.)
-# 44. ~ Switches#on_args, shorter when handling casting arguments.  
-# 45. /unused_switches/unset_switches/.  
-# 46. ~ Switches#check_required_switches, so that the message is not being assigned until a switch is missing.  
-# 47. Removed the self-run section and moved it to ./test/run.rb.  
-# 7/8 (Addition of #perform and #perform! methods, as well the #do_action method and changes to #on_args to facilitate #perform* methods.)
-# 48. ~ Switches#on_args, so as if a block is supplied which is not returning a String, then it will not be placed into the on_args argument list.  
-# 49. + Switches#perform, interface for actions which don't require an argument.  
-# 50. + Switches#perform!, interface for actions which do require an argument.  
-# 51. + Switches#do_action, executes a block when called by either of #perform or #perform!.  
-# 8/9
-# 52. ~ Switches#check_required_switches, so as it now assembles the complete list of missing switches rather than failing on and reporting only the first.  
-# 53. + Switches#required_perform
-# 54. + Switches#required_perform!
-# 55. - OptionParse#soft_parse, since this was never used here, but only in Attributes.  
-# 56. + Object#default_is(et.al.)
-# 57. + NilClass#default_is(et.al.) overrides Object#default_is for the specific case of nil.  
-# 58. /switches_defaults/switches_with_defaults/.  
-# 59. + Array#peek_options.  
-# 60. + Array#poke_options!.  
-# 61. + Array#all_but_last.  
-# 62. + Array#last!.  
-# 63. + Module#alias_methods.  
-# 64. ~ CastingInterfaceMethods, to make use of Array#poke_options.  
-# 65. + CastingInterfaceMethods#flag.  
-# 66. + Switches.as_h (and associated aliased interfaces).  
-# 67. ~ Switches#initialize, arguments are now a splat with the intention of allowing both casting_interface_methods and as_h being specified as a hash supplied to the initialiser.  
-# 68. ~ Switches, to make use of Module#alias_methods.  
-# 69. ~ Switches, to make use of Array#peek_options and Array#poke_options!.  
-# 70. + Switches#required_perform.  
-# 71. + Switches#required_perform!.  
-# 72. + Switches#switches_with_defaults.  
-# 73. + Switches#switches_with_castings.  
-# 74. + Swtiches#to_h.  
-# 75. + Switches#set_if_required_switch.  
-# 76. + Switches#set_switches_with_defaults.  
-# 77. ~ Switches#parse!, + set_switches_with_defaults() and + to_h().  
-# 78. ~ Switches#do_set, + set_if_required_switch().  
-# 79. ~ Switches#do_action, + set_if_required_switch().  
-# 80. ~ Switches#on_args, so as it can handle castings.  
-# 9/10
-# 81. + OpenStruct#to_h.  
-# 82. ~ Switches#to_h.  
-# 10/11 (Whoops!  The defaults were overwriting the supplied settings.)
-# 83. ~ Switches#set_switches_with_defaults to check if a setting had been set before applying a default value.  
-# 10/11
-# 84. 
-# 11/12 (Removed default aliases for default_to, since it clashes with the mail gem's Mail::Message#default method.)
-# 85. - Object#default.  
-# 86. - NilClass#default.  
-# 12/13
-# 87. Swapped out a couple of @settings.instance_variable_get(:@table)'s for OpenStruct#to_h's.  
-# 13/14
-# 88. README is now markdown.
-# 89. - examples directory
-# 90. Version number bump to 0.9.14.
-# 91. Turned into a gem (+ switches.gemspec).
-# 14/15
-# 92. switches gem name taken, so renamed the gem to switches.rb.
-# 93. Version number bump to 0.9.15.
-# 94. Tidied some comments in spec/all.rb.
-# 15/16
-# 95. + Gemfile
-
 require 'optparse'
 require 'Kernel/require_gem'
 

data/switches.rb.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'switches.rb' # I would have preferred 'switches', but there's a gem with the name of switches.
 
-  s.version = '0.10.1'
+  s.version = '0.10.2'
   s.date = '2026-08-09'
 
   s.summary = "The easiest way to provide switches to a Ruby program."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switches.rb
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - thoran
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.18
 specification_version: 4
 summary: The easiest way to provide switches to a Ruby program.
 test_files: []