options_by_example 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9973ed4bcfac2c5bdd856347b1956fe52fc134c0c120e288548d164179e3578
-  data.tar.gz: a9f55ef81262189094c8718713a55a93c05b5d64d5655ef6fd1ce5db1ddddb29
+  metadata.gz: eb87e6b0c01a7f99d70d600c6adc142d96cae3fc18b122c2259c926504fb198b
+  data.tar.gz: e21e7dd4f0a4a77fb7e2a84b4edc77293023730388e0fcbf4abe2d0e5344d5c5
 SHA512:
-  metadata.gz: 1670b512ab6a4517bc38141a403d88798f5ca250b23dd7c7d3958a542dc9c1aeeca42b1d7ecfc76219c553d14c3a96e4662806712e1abc410b0f5a675254d3e2
-  data.tar.gz: b82aaa8cca78d5c92166c64268fc49edb20507b504bd87bec50446d1de9877b497169a4f657457e9fc6469fe6a38a7baabe488aeccf95c6a6ca10a584eafe843
+  metadata.gz: 7e5b59dc4a4b9ad41edeaadaf98fa3ee23abe4f262cfbb9ba93752dba66ff5868b704024a3d534b43386977caefe6a4eecea4a5e80c22f5c351f679ec2488bc3
+  data.tar.gz: 7ecce96f859a83e3dc702740c3d5e72c957d44a42387dff4a70db249bc54fc1df45484bf5ff099e9bbd66d9dae06a548d179f107aa5f6cb87395a36a54551bc0

data/lib/options_by_example/parser.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+
+class OptionsByExample
+
+  class PrintUsageMessage < StandardError
+  end
+
+  class Parser
+
+    attr_reader :options
+    attr_reader :arguments
+
+    def initialize(argument_names_required, argument_names_optional, option_names)
+      @argument_names_required = argument_names_required
+      @argument_names_optional = argument_names_optional
+      @option_names = option_names
+
+      @arguments = {}
+      @options = {}
+    end
+
+    def parse(array)
+
+      # Separate command-line options and their respective arguments into
+      # chunks plus handling any remaining arguments. This organization
+      # facilitates further processing and validation of the input.
+
+      @chunks = []
+      @remainder = current = []
+      array.each do |each|
+        @chunks << current = [] if each.start_with?(?-)
+        current << each
+      end
+
+      find_help_option
+      find_unknown_options
+      parse_options
+
+      validate_number_of_arguments
+      parse_required_arguments
+      parse_optional_arguments
+
+      raise "Internal error: unreachable state" unless @remainder.empty?
+    end
+
+    private
+
+    def find_help_option
+      @chunks.each do |option, *args|
+        case option
+        when '-h', '--help'
+          raise PrintUsageMessage
+        end
+      end
+    end
+
+    def find_unknown_options
+      @chunks.each do |option, *args|
+        raise "Found unknown option '#{option}'" unless @option_names.include?(option)
+      end
+    end
+
+    def parse_options
+      @chunks.each do |option, *args|
+        if @remainder.any?
+          raise "Unexpected arguments found before option '#{option}', please provide all options before arguments"
+        end
+
+        option_name, argument_name = @option_names[option]
+        @options[option_name] = true
+
+        if argument_name
+          raise "Expected argument for option '#{option}', got none" if args.empty?
+          @arguments[option_name] = args.shift
+        end
+
+        @remainder = args
+      end
+    end
+
+    def validate_number_of_arguments
+      min_length = @argument_names_required.size
+      max_length = @argument_names_optional.size + min_length
+      if @remainder.size > max_length
+        range = [min_length, max_length].uniq.join(?-)
+        raise "Expected #{range} arguments, but received too many"
+      end
+    end
+
+    def parse_required_arguments
+      stash = @remainder.pop(@argument_names_required.length)
+      @argument_names_required.each do |argument_name|
+        raise "Missing required argument '#{argument_name}'" if stash.empty?
+        @arguments[argument_name] = stash.shift
+      end
+    end
+
+    def parse_optional_arguments
+      @argument_names_optional.each do |argument_name|
+        break if @remainder.empty?
+        @arguments[argument_name] = @remainder.shift
+      end
+    end
+  end
+end

data/lib/options_by_example/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class OptionsByExample
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end
 
 
@@ -11,6 +11,16 @@ __END__
 # Minor version bump when backward-compatible changes or enhancements
 # Patch version bump when backward-compatible bug fixes, security updates etc
 
+2.0.0
+
+  - Replaced dynamic methods with explicit methods for options and arguments
+  - Removed ability to call dynamic methods with undeclared names
+
+1.3.0
+
+  - Extracted parsing functionality into class
+  - Better error messages
+
 1.2.0
 
   - Ensure compatibility with Ruby versions 1.9.3 and newer

data/lib/options_by_example.rb

@@ -1,38 +1,34 @@
 # frozen_string_literal: true
 
 require 'options_by_example/version'
+require 'options_by_example/parser'
 
 
 class OptionsByExample
 
-  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
 
   def initialize(text)
-    @usage = text.gsub('$0', File.basename($0)).gsub(/\n+\Z/, "\n\n")
+    @usage_message = text.gsub('$0', File.basename($0)).gsub(/\n+\Z/, "\n\n")
 
-    # ---- 1) Parse argument names ------------------------------------
+    # --- 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+)*)/
+    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)
+    @argument_names_optional = $3.to_s.split.map { |match| match.tr('[]', '').downcase }
+    @argument_names_required = $5.to_s.split.map(&:downcase)
 
-    # ---- 2) Parse option names --------------------------------------
+    # --- 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:
@@ -46,93 +42,61 @@ class OptionsByExample
     @option_names = {}
     text.scan(/((--?\w+)(, --?\w+)*) ?(\w+)?/) do
       opts = $1.split(", ")
-      opts.each { |each| @option_names[each] = [opts.last.tr('-', ''), ($4.downcase if $4)] }
+      opts.each { |each| @option_names[each] = [opts.last.tr('-', ''), $4] }
     end
 
-    # ---- 3) Include help option by default --------------------------
-
-    @option_names.update("-h" => :help, "--help" => :help)
+    initialize_argument_accessors
+    initialize_option_accessors
   end
 
-  def parse(argv, options = nil)
-    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 ---------------------------------
-
-    # 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?
-      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
+  def parse(argv)
+    parse_without_exit argv
+  rescue PrintUsageMessage
+    puts @usage_message
+    exit 0
+  rescue RuntimeError => err
+    puts "ERROR: #{err.message}"
+    exit 1
+  end
 
-    # --- 4) Expect to be done ----------------------------------------
+  def parse_without_exit(argv)
+    parser = Parser.new(
+      @argument_names_required,
+      @argument_names_optional,
+      @option_names,
+    )
 
-    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_required.size
-      max_length = @argument_names_optional.size + min_length
-      raise "Expected #{min_length}#{"-#{max_length}" if max_length > min_length} arguments, got more"
-    end
+    parser.parse argv
+    @arguments = parser.arguments
+    @options = parser.options
 
     return self
+  end
 
-  rescue RuntimeError => err
-    exit_on_error = options ? options[:exit_on_error] : true
-    if exit_on_error
-      puts "ERROR: #{err.message}\n\n" unless err.message.empty?
-      puts @usage
-      exit
-    else
-      raise # Reraise the same exception
+  private
+
+  def initialize_argument_accessors
+    [
+      *@argument_names_required,
+      *@argument_names_optional,
+      *@option_names.values.select(&:last).map(&:first),
+    ].each do |argument_name|
+      instance_eval %{
+        def argument_#{argument_name}
+          val = @arguments["#{argument_name}"]
+          val && block_given? ? (yield val) : val
+        end
+      }
     end
   end
 
-  def method_missing(sym, *args, &block)
-    case sym
-    when /^argument_(\w+)$/
-      val = @arguments[$1]
-      block && val ? block.call(val) : val
-    when /^include_(\w+)\?$/
-      @options[$1]
-    else
-      super
+  def initialize_option_accessors
+    @option_names.each_value do |option_name, _|
+      instance_eval %{
+        def include_#{option_name}?
+          @options.include? "#{option_name}"
+        end
+      }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: options_by_example
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Adrian Kuhn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/options_by_example.rb
+- lib/options_by_example/parser.rb
 - lib/options_by_example/version.rb
 homepage: https://github.com/akuhn/options_by_example
 licenses:
@@ -26,6 +27,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/akuhn/options_by_example
   source_code_uri: https://github.com/akuhn/options_by_example
+  changelog_uri: https://github.com/akuhn/options_by_example/blob/master/lib/options_by_example/version.rb
 post_install_message:
 rdoc_options: []
 require_paths: