usage_by_example 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa6ff28e421846106e76d35e80132c514df0308c59506428c884b7fd0b5ff702
+  data.tar.gz: dee35110be4a6d05480e067e12f913def3d52459b455232ddfc686b70a0670aa
+SHA512:
+  metadata.gz: 2305c27d269773f2ea7ef8112bfd618385442cc59e31b1450ee741693c8254df323f129bd10ff7e8913afc05afc57ac58be154f485f5599f8b4df3422df7064b
+  data.tar.gz: 28d398dcb1d4c5f71fa3aa14e43e646836d47bcf39c3287c7b109dbf773e80bdf75d13b04c05682553754f0378d392d04b3f7d8d1c5e79fba8cf89d317d5f4a1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in usage_by_example.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    usage_by_example (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  rake (~> 13.0)
+  usage_by_example!
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,35 @@
+# UsageByExample
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/usage_by_example`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'usage_by_example'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install usage_by_example
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/usage_by_example.

data/lib/usage_by_example/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class UsageByExample
+  VERSION = "0.0.0"
+end

data/lib/usage_by_example.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative "usage_by_example/version"
+
+
+class UsageByExample
+
+  def self.read(data)
+    return new data.read
+  end
+
+  def initialize(text)
+    @usage = text.gsub('$0', File.basename($0)).gsub(/\n+\Z/, "\n\n")
+
+    # ---- 1) Parse argument names ------------------------------------
+    #
+    # Parse the usage string and extract both optional argument names
+    # and required argument names, for example:
+    #
+    # Usage: connect [options] [mode] host port
+
+    text =~ /Usage: (\w+|\$0) \[options\](( \[\w+\])*)(( \w+)*)/
+    raise RuntimeError, "Expected usage string, got none" unless $1
+    @argument_names_optional = $2.to_s.split.map { |match| match.tr('[]', '').downcase }
+    @argument_names_required = $4.to_s.split.map(&:downcase)
+
+    # ---- 2) Parse option names --------------------------------------
+    #
+    # Parse the usage message and extract option names, their short and
+    # long forms, and the associated argument name (if any), eg:
+    #
+    # Options:
+    #   -s, --secure        Use secure connection
+    #   -v, --verbose       Enable verbose output
+    #   -r, --retries NUM   Number of connection retries (default 3)
+    #   -t, --timeout NUM   Connection timeout in seconds (default 10)
+
+    @option_names = {}
+    text.scan(/((--?\w+)(, --?\w+)*) ?(\w+)?/) do
+      opts = $1.split(", ")
+      opts.each { |each| @option_names[each] = [opts.last.tr('-', ''), $4&.downcase] }
+    end
+
+    # ---- 3) Include help option by default --------------------------
+
+    @option_names.update("-h" => :help, "--help" => :help)
+  end
+
+  def parse(argv)
+    array = argv.dup
+    @arguments = {}
+    @options = {}
+
+    # --- 1) Parse options --------------------------------------------
+
+    most_recent_option = nil
+    until array.empty? do
+      break unless array.first.start_with?(?-)
+      most_recent_option = option = array.shift
+      option_name, argument_name = @option_names[option]
+      raise "Got unknown option #{option}" if option_name.nil?
+      raise if option_name == :help # Show usage without error message
+      @options[option_name] = true
+
+      # Consume argument, if expected by most recent option
+      if argument_name
+        argument = array.shift
+        raise "Expected argument for option #{option}" unless /^[^-]/ === argument
+        @arguments[option_name] = argument
+        most_recent_option = nil
+      end
+    end
+
+    # --- 2) Parse optional arguments ---------------------------------
+
+    stash = array.pop(@argument_names_required.length)
+    @argument_names_optional.each do |argument_name|
+      break if array.empty?
+      argument = array.shift
+      raise "Expected more arguments, got option #{option}" unless /^[^-]/ === argument
+      @arguments[argument_name] = argument
+    end
+
+    # --- 3) Parse required arguments ---------------------------------
+
+    @argument_names_required.each do |argument_name|
+      raise "Expected required argument #{argument_name.upcase}, got none" if stash.empty?
+      argument = stash.shift
+      raise "Expected more arguments, got option #{option}" unless /^[^-]/ === argument
+      @arguments[argument_name] = argument
+    end
+
+    # --- 4) Expect to be done ----------------------------------------
+
+    if not array.empty?
+      # Custom error message if most recent option did not require argument
+      raise "Got unexpected argument for option #{most_recent_option}" if most_recent_option
+      min_length = @argument_names.length
+      max_length = @argument_names.length + @argument_names_optional.length
+      raise "Expected #{min_length}#{"-#{max_length}" if max_length > min_length} arguments, got more"
+    end
+
+    return self
+
+  rescue RuntimeError => err
+    puts "ERROR: #{err.message}\n\n" unless err.message.empty?
+    puts @usage
+    exit
+  end
+
+  def method_missing(sym, *args, &block)
+    case sym
+    when /^argument_(.*)$/
+      val = @arguments[$1]
+      block && val ? block.call(val) : val
+    when /^include_(.*)\?$/
+      @options[$1]
+    else
+      super
+    end
+  end
+end
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: usage_by_example
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Adrian Kuhn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- akuhn@iam.unibe.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/usage_by_example.rb
+- lib/usage_by_example/version.rb
+homepage: https://github.com/akuhn/usage_by_example
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/akuhn/usage_by_example
+  source_code_uri: https://github.com/akuhn/usage_by_example
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: No-code options parser that extracts arguments directly from usage text.
+test_files: []