opt_parse_builder 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28f64f160f1a3940a3884f5f56ecba366ba6078be1c3032b625f0cded4124259
-  data.tar.gz: d81a3b030a5e8b60b97577148c5e91810c7a9125e0f08c6ad01e68f76a0d58ff
+  metadata.gz: ae59f7036ba75769d0965d67ec2b8d79c9d1965d3867898ee40b1a6e39d63395
+  data.tar.gz: d92e59065fc880fb4b0182f4a9f3d608bc88d69333a37267f7edaae36efd41b2
 SHA512:
-  metadata.gz: d48ea90e1d556a24a649124d33ca1329c743384066da239472c240aec47b9b113785a9e321365b2fac1b4f90ef08e9a370664693c330b326e0a510f666d650d4
-  data.tar.gz: 68ccc121fe7a7703f16d2bac471a69abcf0af241a7c85aef53554de9c1609bb464e2a8a5eba3ad1fd39a382d91d5f433cab554e55be6a072347ed96d24fb2f27
+  metadata.gz: 688195cd6207f2a4dbb5aebb66851efe094a17a1e3c55d87cd38f62ffe72cc15acd665c1ad64e203abe806f8a5cb767dd4ff46123f4c521f003b70e570a883b8
+  data.tar.gz: 97a98d23c58dbbeda7136b5399455bde1d00840c2748409f8ae85dce667d06f4b114ac7e00ea110bd5bdd8a58758af11ba0d34b975960acea67db21cc80aa325

data/.gitignore

@@ -1,2 +1,4 @@
 html
 *.gem
+temp
+.claude/

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.2
+ruby-3.4.7

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # -*- mode: fundamental -*-
-	
+
 # Development
 
+# 1.0.0 - 2025-11-28
+
+* Declare API stability by bumping version to 1.0.0
+* Update gems
+* Update Ruby to 3.4.7
+
+# 0.2.0 - 2025-07-06
+
+* Update gems
+* Update Ruby to 3.4.4
+
+# 0.1.0 - 2020-11-28
+
 * Initial release

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    opt_parse_builder (0.1.0)
+    opt_parse_builder (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.4.4)
-    rake (13.0.1)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    diff-lcs (1.6.2)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
 
 PLATFORMS
   ruby
@@ -32,4 +32,4 @@ DEPENDENCIES
   rspec (~> 3.10)
 
 BUNDLED WITH
-   2.1.4
+   2.7.2

data/README.md

@@ -2,8 +2,8 @@
 
 A Ruby Gem for processing CLI arguments using optparse.  Adds to
 optparse a compact builder-style DSL, operand (positional argument)
-parsing, and composability for sharing argument definitions within a
-suite of commands.
+parsing, and easy sharing of argument definitions within a suite of
+commands.
 
 Features:
 
@@ -37,7 +37,7 @@ Features:
 * Fully documented - Includes full code documentation and examples.
 
 * Stable API - Uses [semantic
-  versioning](ttps://semver.org/spec/v2.0.0.html).  Promises not to
+  versioning](#label-Versioning).  Promises not to
   break your program without incrementing the major version number.
 
 * Programmed simply - Easy to understand and modify.
@@ -125,9 +125,15 @@ parser = OptParseBuilder.build_parser do |args|
 end
 ```
 
+### Use in program suites
+
 This is especially useful where a suite of programs share some
 arguments in common.  Instead of defining common arguments over and
-over, you can define them once and then reuse them in each program:
+over, you can define them once and then reuse them in each program.
+
+*Design note* This is the reason this library was created.  Other
+solutions I found for sharing common CLI options required the programs
+to be part of a framework; I wanted something that worked by itself.
 
 ```ruby
 # common_arguments.rb
@@ -172,6 +178,8 @@ ARG_PARSER = OptParseBuilder.build_parser do |args|
 end
 ```
 
+### Switching between required and optional
+
 When adding a pre-built operand to a parser, you can change change
 it from required to optional:
 
@@ -323,6 +331,9 @@ A value option parsed by OptParse:
       arg.on "Number of iterations (default _DEFAULT_)"
     end
 
+The string "_DEFAULT_" is replaced with the default value (in this
+example, "100").
+
 Applicable builder methods:
 
 * key
@@ -393,6 +404,34 @@ Applicable builder methods:
 * banner (optional)
 * separator (optional)
 
+# Error handling and abnormal termination
+
+The invokation of help via "-h" or "--help" prints out the program
+help and ends the program with exitcode 0.
+
+Errors during building result in an uncaught BuildError.
+
+OptParse errors are handled by Kernel#abort, which prints the error to
+$stderr and ends the program with exit code 1.
+
+# Ruby versions supported
+
+* 2.5
+* 2.6
+* 2.7
+* 3.0
+
+# Versioning
+
+This library uses [semantic
+versioning](https://semver.org/spec/v2.0.0.html).  As long as you
+stick to the public API, upgrades to this library will not break your
+program without incrementing the major version number.
+
+The public API is that document using RDOC comments.
+If a class or method is documented with `# :nodoc:`, then it's not
+part of the public API.
+
 # Development
 
 After checking out the repo, run `bundle` to install dependencies.

data/doc/publishing.md

@@ -0,0 +1,42 @@
+Publishing a New Release
+
+# Checklist
+
+* Run tests: `rake`
+* Update `lib/opt_parse_builder/version.rb`
+* Update `CHANGELOG.md` with version and date
+* Commit: `git commit -am "Bump version to X.X.X"`
+* Release: `rake release`
+* Verify at https://rubygems.org/gems/opt_parse_builder
+
+# Notes
+
+Semantic Versioning: MAJOR.MINOR.PATCH (breaking.feature.bugfix)
+
+What `rake release` does:
+
+* Builds the gem
+* Creates git tag vX.X.X
+* Pushes tag to GitHub
+* Publishes gem to rubygems.org
+
+Dry run: `gem_push=no rake release` (tags but doesn't publish)
+
+# Troubleshooting
+
+No RubyGems credentials: `gem signin`
+
+Release failed mid-way:
+
+```bash
+git tag -d vX.X.X              # Delete local tag
+git push origin :vX.X.X        # Delete remote tag
+rake release                   # Try again
+```
+
+Manual publish (if rake release fails):
+
+```bash
+gem build opt_parse_builder.gemspec
+gem push opt_parse_builder-X.X.X.gem
+```

data/examples/hello_world.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require "opt_parse_builder"
+require_relative "lib/setup_example"
 
 ARG_PARSER = OptParseBuilder.build_parser do |args|
   args.banner "A simple example"

data/examples/lib/setup_example.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+lib_dir = File.join(__dir__, "../../lib")
+if File.directory?(lib_dir)
+  $:.prepend lib_dir
+end
+                    
+require "opt_parse_builder"

data/lib/opt_parse_builder/argument_builder.rb

@@ -41,7 +41,7 @@ module OptParseBuilder
     #
     #     arg = OptParseBuilder.build_argument do |arg|
     #       arg.key :quiet
-    #       arg.on "-q", "Be very veru quiet", "We're hunting rabbit!"
+    #       arg.on "-q", "Be very very quiet", "We're hunting rabbit!"
     #     end
     #
     # You may split up a long argument list by calling this method
@@ -49,7 +49,7 @@ module OptParseBuilder
     #
     #     arg = OptParseBuilder.build_argument do |arg|
     #       arg.key :quiet
-    #       arg.on "-q", "Be very veru quiet",
+    #       arg.on "-q", "Be very very quiet",
     #       arg.on "We're hunting rabbit!"
     #     end
     #

data/lib/opt_parse_builder/version.rb

@@ -1,6 +1,6 @@
 module OptParseBuilder
 
   # Library version.  Follows Semantic Versioning 2.0
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
   
 end

data/rake/rdoc.rake

@@ -1,7 +1,22 @@
 require 'rdoc/task'
 
+RDOC_PATHS = [
+  "README.md",
+  "lib",
+]
+
 RDoc::Task.new do |rdoc|
   rdoc.main = "README.md"
   rdoc.markup = :markdown
-  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+  rdoc.rdoc_files.include(RDOC_PATHS)
+end
+
+desc "Print RDOC coverage report"
+task "rdoc:coverage" do
+  command = [
+    "rdoc",
+    "--coverage-report",
+    *RDOC_PATHS,
+  ]
+  system(*command)
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Wayne Conrad
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,7 +71,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- doc/publishing.md
 - examples/hello_world.rb
+- examples/lib/setup_example.rb
 - lib/opt_parse_builder.rb
 - lib/opt_parse_builder/argument.rb
 - lib/opt_parse_builder/argument_builder.rb
@@ -104,7 +105,6 @@ homepage: https://github.com/wconrad/opt_parse_builder
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -119,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Builder DSL for optparse, with more
 test_files: []