option_parser_usage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48ea8ccb44efc9c7e89385293a14a0c0daf823bad7cb24f15a80f60c91f49424
+  data.tar.gz: 96f7dc93de75511696b285fbd8ab372b7ff3f2f6640ba4e4a7b3d427ec96bd6a
+SHA512:
+  metadata.gz: '09ea5f0b3dc5c936bd2cb04e3384c798fa7b6076447240211531b9fe8568c6fdd07872e8145737db96ba8fa11efe3554d6197f845489a4cb1d66ccb375556f24'
+  data.tar.gz: a39a8d02b64f2b780a6ae484d968f2bb273fed824adbb08ae5f197881b3fc636c99b363398a5cb5d978e0550ab4ad8e62cc8757739aa46da6091b4f507f30945

data/LICENSE.txt

@@ -0,0 +1,7 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# OptionParserUsage
+
+Tooling for creating [usage][] specs from `OptionParser` definitions.
+
+## Installation
+
+Add `gem "option_parser_usage"` to your gemfile and then `bundle install`.
+
+## Usage
+
+Example: 
+
+```ruby
+require 'optparse'
+require 'option_parser_usage'
+
+myparser = OptionParser.new do |p|
+  p.program_name = "myprog"
+  p.version =  "1.2.3"
+  p.banner = "my test program"
+
+  p.on("--foo", "enables foo")
+  p.on("--bar BAR", "requires argument BAR")
+  p.on("--baz [BAZ]", "optional argument BAZ")
+end
+
+puts OptionParserUsage.usage_for_parser(myparser)
+
+# Alternatively
+OptionParserUsage.monkeypatch!
+puts myparser.to_usage_spec
+```
+
+This will print (twice)
+
+```
+bin myprog
+version "1.2.3"
+about "my test program"
+flag --foo {
+    help "enables foo"
+}
+flag --bar {
+    arg <BAR> required=#true
+    help "requires argument BAR"
+}
+flag --baz {
+    arg "[BAZ]" required=#false
+    help "optional argument BAZ"
+}
+```
+
+### Monkeypatching
+
+```
+OptionParserUsage.monkeypatch!
+# undo with OptionParserUsage.unmonkeypatch!
+```
+
+This monkeypatch adds `#to_usage_spec` to `OptionParser` instances.
+
+```
+OptionParserUsage.document_officious_help!
+# undo with OptionParserUsage.undocument_officious_help!
+```
+
+This monkeypatch changes the default `-h/--help` switch internal to the `OptionParser` to be documented so it can be exposed in docs
+
+Both monkeypatches alter global state with all the requisite warnings about doing that.
+
+### Limitations
+
+`OptionParser` supports a style of flag that cannot be properly rendered in usage as far as I can tell. `--foo=[FOO]` will enable either `--foo` or `--foo=val` but not `--foo val` (`val` will be left as a positional argument). Generating a usage spec will raise an error if one of these is encountered.
+
+Positional arguments and generally anything parsed outside of the `OptionParser` will not be represented in the generated config.
+
+## Development
+
+`bundle install` for the dev dependencies
+
+`bundle exec rspec` to run the tests
+
+`bundle exec standardrb --fix` to lint and autocorrect
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/packrat386/option_parser_usage.
+
+[usage]: https://usage.jdx.dev/

data/lib/option_parser_usage.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "kdl"
+
+module OptionParserUsage
+  VERSION = "0.1.0"
+
+  NotSupportedError = Class.new(StandardError)
+
+  def self.monkeypatch!
+    OptionParser.class_exec do
+      def to_usage_spec
+        OptionParserUsage.usage_for_parser(self)
+      end
+    end
+  end
+
+  def self.unmonkeypatch!
+    OptionParser.remove_method(:to_usage_spec)
+  rescue NameError => e
+    raise if e.name != :to_usage_spec
+  end
+
+  def self.document_officious_help!
+    return unless @original_help.nil?
+
+    @original_help = OptionParser::Officious["help"]
+
+    OptionParser::Officious["help"] = proc do |parser|
+      switch = @original_help.call(parser)
+      switch.instance_variable_set(:@desc, ["shows option summary"])
+      switch.instance_variable_set(:@short, ["-h"])
+      switch.instance_variable_set(:@long, ["--help"])
+
+      switch
+    end
+  end
+
+  def self.undocument_officious_help!
+    return if @original_help.nil?
+
+    OptionParser::Officious["help"] = @original_help
+
+    @original_help = nil
+  end
+
+  def self.usage_for_parser(parser)
+    ::KDL.build do |spec|
+      spec.node "bin", parser.program_name
+      spec.node "version", parser.version if parser.version
+      spec.node "about", parser.banner
+
+      parser.instance_variable_get(:@stack).map { [_1.long.values, _1.short.values] }.flatten.uniq.select { switch_has_doc?(_1) }.each do |s|
+        spec.node "flag", primary_flag(s) do
+          flag_aliases(s).each { spec.node "alias", _1 }
+
+          if s.arg
+            spec.node "arg", flag_arg(s), required: flag_arg_required?(s)
+          end
+
+          if s.desc.length > 0
+            spec.node "help", s.desc.first
+          end
+
+          if s.desc.length > 1
+            spec.node "help_long", s.desc.join("\n")
+          end
+        end
+      end
+    end
+  end
+
+  # private
+
+  def self.primary_flag(switch)
+    if switch.long
+      switch.long.first
+    else
+      switch.short.first
+    end
+  end
+
+  def self.flag_aliases(switch)
+    [switch.long, switch.short].flatten.compact.reject { _1 == primary_flag(switch) }
+  end
+
+  def self.switch_has_doc?(switch)
+    !(switch.long.nil? && switch.short.nil?)
+  end
+
+  def self.flag_arg(switch)
+    case switch
+    when OptionParser::Switch::RequiredArgument
+      switch.arg.gsub(/^\s*([[:word:]]+)\s*$/, '<\1>')
+    when OptionParser::Switch::PlacedArgument
+      switch.arg.gsub(/^\s*=?\[([[:word:]]+)\]\s*$/, '[\1]')
+    else
+      raise NotSupportedError.new("switch type not supported: #{switch.class}")
+    end
+  end
+
+  def self.flag_arg_required?(switch)
+    case switch
+    when OptionParser::Switch::RequiredArgument
+      true
+    else
+      false
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: option_parser_usage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Coyle
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'see: https://usage.jdx.dev/'
+email:
+- packrat386@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/option_parser_usage.rb
+homepage: https://github.com/packrat386/option_parser_usage
+licenses: []
+metadata:
+  homepage_uri: https://github.com/packrat386/option_parser_usage
+  source_code_uri: https://github.com/packrat386/option_parser_usage
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: tooling to create usage specs from OptionParser
+test_files: []