usage_by_example 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6ff28e421846106e76d35e80132c514df0308c59506428c884b7fd0b5ff702
-  data.tar.gz: dee35110be4a6d05480e067e12f913def3d52459b455232ddfc686b70a0670aa
+  metadata.gz: 573271b147430fa57fbc9033ba649e3f06781682e84c5fcc9a6c0f3a298384cc
+  data.tar.gz: eb7d882376968b14dbeff1e751aa41ac8ca4fbb9c45e990e291664b62b105554
 SHA512:
-  metadata.gz: 2305c27d269773f2ea7ef8112bfd618385442cc59e31b1450ee741693c8254df323f129bd10ff7e8913afc05afc57ac58be154f485f5599f8b4df3422df7064b
-  data.tar.gz: 28d398dcb1d4c5f71fa3aa14e43e646836d47bcf39c3287c7b109dbf773e80bdf75d13b04c05682553754f0378d392d04b3f7d8d1c5e79fba8cf89d317d5f4a1
+  metadata.gz: ea9e30bf8524063648804609da775df4f608908748cfcd46f580d77c7cbcd3a753681857e42b6328496dd5d5914a4f711a6b9b946cd68d0a06fe10357dc2622e
+  data.tar.gz: cce5f456d605e05c2d09938baa14c71ac0320df8a69de179920ab60a365c09d2caabbbe00f352a85d0245c34dd7e9e8ad3184c0472afe4a6b7833eb15f3c03a0

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --require spec_helper
+--order random

data/Gemfile

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in usage_by_example.gemspec
-gemspec
+gemspec # Specify your gem's dependencies in usage_by_example.gemspec
+
+gem 'pry'
+gem 'rspec'
 
-gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,18 +1,37 @@
 PATH
   remote: .
   specs:
-    usage_by_example (0.0.0)
+    usage_by_example (1.0.0.beta)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (13.0.6)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
 
 PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
-  rake (~> 13.0)
+  pry
+  rspec
   usage_by_example!
 
 BUNDLED WITH

data/lib/usage_by_example/version.rb

@@ -1,5 +1,26 @@
 # frozen_string_literal: true
 
 class UsageByExample
-  VERSION = "0.0.0"
+  VERSION = '1.0.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.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.0.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: