usage_by_example 0.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6ff28e421846106e76d35e80132c514df0308c59506428c884b7fd0b5ff702
-  data.tar.gz: dee35110be4a6d05480e067e12f913def3d52459b455232ddfc686b70a0670aa
+  metadata.gz: c62f93055ec627514c29cf3c8c1415f09eeb300c99e78f05f16a73bfae365c69
+  data.tar.gz: 5b9d24119f0ad3390a7a9b995a6e93540e0157c2c0a06e2e4453b94c42f8db4c
 SHA512:
-  metadata.gz: 2305c27d269773f2ea7ef8112bfd618385442cc59e31b1450ee741693c8254df323f129bd10ff7e8913afc05afc57ac58be154f485f5599f8b4df3422df7064b
-  data.tar.gz: 28d398dcb1d4c5f71fa3aa14e43e646836d47bcf39c3287c7b109dbf773e80bdf75d13b04c05682553754f0378d392d04b3f7d8d1c5e79fba8cf89d317d5f4a1
+  metadata.gz: ac405ec17ecf15f372b3849c18e29598d56237f625e01906a85afb528c99273836b305873901cbcd2cf2869e907c3085a7225fc43478697d06814bafe8be5dea
+  data.tar.gz: b334f114b4aab13a32e07a700104215075d718efc93589859ca969f69ca21a9f93edc0ee872b0b201ceedc6f3bea4e2218f21d0dbd5d175cd70e9a785c13211d

data/README.md

@@ -1,35 +1,48 @@
-# UsageByExample
+# Usage by Example
 
-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.
+No-code options parser that automatically detects command-line options from the usage text of your application. This intuitive parser identifies optional and required argument names as well as option names without requiring any additional code, making it easy to manage user input for your command-line applications.
 
-TODO: Delete this and the text above, and describe your gem
+Features
 
-## Installation
+- Automatically detects optional and required argument names from usage text
+- Automatically detects option names and associated arguments (if any) from usage text
+- Parses those arguments and options from the command line (ARGV)
+- Raises errors for unknown options or missing required arguments
 
-Add this line to your application's Gemfile:
 
-```ruby
-gem 'usage_by_example'
-```
-
-And then execute:
+Example
 
-    $ bundle install
-
-Or install it yourself as:
+```ruby
+require 'usage_by_example'
 
-    $ gem install usage_by_example
+Options = UsageByExample.read(DATA).parse(ARGV)
 
-## Usage
+puts Options.include_secure?
+puts Options.include_verbose?
+puts Options.include_retries?
+puts Options.include_timeout?
+puts Options.argument_retries
+puts Options.argument_timeout
+puts Options.argument_mode
+puts Options.argument_host
+puts Options.argument_port
 
-TODO: Write usage instructions here
 
-## Development
+__END__
+Establishes a network connection to a designated host and port, enabling
+users to assess network connectivity and diagnose potential problems.
 
-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.
+Usage: connect [options] [mode] host port
 
-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).
+Options:
+  -s, --secure        Establish a secure connection (SSL/TSL)
+  -v, --verbose       Enable verbose output for detailed information
+  -r, --retries NUM   Specify the number of connection retries (default 3)
+  -t, --timeout NUM   Set the connection timeout in seconds (default 10)
 
-## Contributing
+Arguments:
+  [mode]              Optional connection mode (active or passive)
+  host                The target host to connect to (e.g., example.com)
+  port                The target port to connect to (e.g., 80)
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/usage_by_example.

data/lib/usage_by_example/version.rb

@@ -1,5 +1,31 @@
 # frozen_string_literal: true
 
 class UsageByExample
-  VERSION = "0.0.0"
+  VERSION = '1.1.0'
 end
+
+
+__END__
+
+# Major version bump when breaking changes or new features
+# Minor version bump when backward-compatible changes or enhancements
+# Patch version bump when backward-compatible bug fixes, security updates etc
+
+1.0.1
+
+  - Update readme file with features and an example
+  - Update the gemspec to include readme and ruby files only
+
+1.0.0
+
+  - Extract optional and required argument names from a usage text
+  - Extract option names and associated argument names (if any) from a usage text
+  - Include help option by default
+  - Parse options and arguments from command-line arguments aka ARGV
+  - Exit gracefully or raise exceptions, depending on the exit_on_error parameter
+  - Implement dynamic methods for checking options and getting arguments
+  - Ensure correct git tag and all changes committed when building gem
+
+0.0.0
+
+  - Prehistory starts here...

data/lib/usage_by_example.rb

@@ -5,6 +5,14 @@ require_relative "usage_by_example/version"
 
 class UsageByExample
 
+  attr_reader :argument_names_optional
+  attr_reader :argument_names_required
+  attr_reader :option_names
+
+  attr_reader :arguments
+  attr_reader :options
+
+
   def self.read(data)
     return new data.read
   end
@@ -46,7 +54,7 @@ class UsageByExample
     @option_names.update("-h" => :help, "--help" => :help)
   end
 
-  def parse(argv)
+  def parse(argv, exit_on_error: true)
     array = argv.dup
     @arguments = {}
     @options = {}
@@ -73,6 +81,9 @@ class UsageByExample
 
     # --- 2) Parse optional arguments ---------------------------------
 
+    # Check any start with --, ie excess options
+    # Check min_length - max_length here
+
     stash = array.pop(@argument_names_required.length)
     @argument_names_optional.each do |argument_name|
       break if array.empty?
@@ -95,25 +106,27 @@ class UsageByExample
     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
+    if exit_on_error
+      puts "ERROR: #{err.message}\n\n" unless err.message.empty?
+      puts @usage
+      exit
+    else
+      raise # Reraise the same exception
+    end
   end
 
   def method_missing(sym, *args, &block)
     case sym
-    when /^argument_(.*)$/
+    when /^argument_(\w+)$/
       val = @arguments[$1]
       block && val ? block.call(val) : val
-    when /^include_(.*)\?$/
+    when /^include_(\w+)\?$/
       @options[$1]
     else
       super

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usage_by_example
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adrian Kuhn
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,9 +17,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- Gemfile
-- Gemfile.lock
 - README.md
 - lib/usage_by_example.rb
 - lib/usage_by_example/version.rb

data/.rspec

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

data/Gemfile

@@ -1,8 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-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