optparse 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de11374b27b7f909eda2151c07df0a81eb3385fadedcfcf017e2407f5bbab30
-  data.tar.gz: 9b94b1a58d6ecccec7c516bfa6fdb8ed7eb7d58fb079c5fb77af86d9214a0b2b
+  metadata.gz: f8070528a5fa8e91d067053a532c9771c71f63d16d6a31622c7ca3c6e487c425
+  data.tar.gz: e854fcd1fe22dd596fe2650e4141e59124d0f78ae492de3164b250a4d18cc9de
 SHA512:
-  metadata.gz: 4361581a6e38d86d531b988fabe314682ae4c600e459780facdca18b2addd2b639fa77b1fbeb0d5120c44f6c4c4b67fbcceb3fbeb26dfc2df6c4185007efd780
-  data.tar.gz: a9bc19932e9eec5854f70b7c1e4a4f0ade1b0d95779d6a29339499ed238500d60d1add5b24cb59be8582a839fa32834521fc655c76231ab6c727986559b81842
+  metadata.gz: 3e246c2d76a0b033b8f31e4d0c850050281b6722e3d7d4ae5e11de16bc00ad337f75243b2b932b915cc45406294038d7b770c3e2150d3faab5bc674135ce6355
+  data.tar.gz: 75b3d9526ad311161ad01507616dbd60ec97714a1440d10b15702bf360a3f0d081a5cade68d25d6bed50f56ed19599d657e7fb4e56d130b50b51861d501b08ce

data/README.md

@@ -57,4 +57,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/optparse.
-

data/lib/optparse.rb

@@ -72,10 +72,10 @@
 #   require 'optparse'
 #
 #   options = {}
-#   OptionParser.new do |opts|
-#     opts.banner = "Usage: example.rb [options]"
+#   OptionParser.new do |parser|
+#     parser.banner = "Usage: example.rb [options]"
 #
-#     opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+#     parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
 #       options[:verbose] = v
 #     end
 #   end.parse!
@@ -96,15 +96,15 @@
 #     def self.parse(options)
 #       args = Options.new("world")
 #
-#       opt_parser = OptionParser.new do |opts|
-#         opts.banner = "Usage: example.rb [options]"
+#       opt_parser = OptionParser.new do |parser|
+#         parser.banner = "Usage: example.rb [options]"
 #
-#         opts.on("-nNAME", "--name=NAME", "Name to say hello to") do |n|
+#         parser.on("-nNAME", "--name=NAME", "Name to say hello to") do |n|
 #           args.name = n
 #         end
 #
-#         opts.on("-h", "--help", "Prints this help") do
-#           puts opts
+#         parser.on("-h", "--help", "Prints this help") do
+#           puts parser
 #           exit
 #         end
 #       end
@@ -241,10 +241,10 @@
 #   require 'optparse'
 #
 #   params = {}
-#   OptionParser.new do |opts|
-#     opts.on('-a')
-#     opts.on('-b NUM', Integer)
-#     opts.on('-v', '--verbose')
+#   OptionParser.new do |parser|
+#     parser.on('-a')
+#     parser.on('-b NUM', Integer)
+#     parser.on('-v', '--verbose')
 #   end.parse!(into: params)
 #
 #   p params
@@ -419,7 +419,7 @@
 # have any questions, file a ticket at http://bugs.ruby-lang.org.
 #
 class OptionParser
-  OptionParser::Version = "0.1.0"
+  OptionParser::Version = "0.1.1"
 
   # :stopdoc:
   NoArgument = [NO_ARGUMENT = :NONE, nil].freeze
@@ -1091,6 +1091,7 @@ XXX
     @summary_width = width
     @summary_indent = indent
     @default_argv = ARGV
+    @require_exact = false
     add_officious
     yield self if block_given?
   end
@@ -1164,6 +1165,10 @@ XXX
   # Strings to be parsed in default.
   attr_accessor :default_argv
 
+  # Whether to require that options match exactly (disallows providing
+  # abbreviated long option as short option).
+  attr_accessor :require_exact
+
   #
   # Heading banner preceding summary.
   #
@@ -1305,13 +1310,16 @@ XXX
   private :notwice
 
   SPLAT_PROC = proc {|*a| a.length <= 1 ? a.first : a} # :nodoc:
+
+  # :call-seq:
+  #   make_switch(params, block = nil)
   #
   # Creates an OptionParser::Switch from the parameters. The parsed argument
   # value is passed to the given block, where it can be processed.
   #
   # See at the beginning of OptionParser for some full examples.
   #
-  # +opts+ can include the following elements:
+  # +params+ can include the following elements:
   #
   # [Argument style:]
   #   One of the following:
@@ -1498,11 +1506,16 @@ XXX
       nolong
   end
 
+  # :call-seq:
+  #   define(*params, &block)
+  #
   def define(*opts, &block)
     top.append(*(sw = make_switch(opts, block)))
     sw[0]
   end
 
+  # :call-seq:
+  #   on(*params, &block)
   #
   # Add option switch and handler. See #make_switch for an explanation of
   # parameters.
@@ -1513,11 +1526,16 @@ XXX
   end
   alias def_option define
 
+  # :call-seq:
+  #   define_head(*params, &block)
+  #
   def define_head(*opts, &block)
     top.prepend(*(sw = make_switch(opts, block)))
     sw[0]
   end
 
+  # :call-seq:
+  #   on_head(*params, &block)
   #
   # Add option switch like with #on, but at head of summary.
   #
@@ -1527,11 +1545,17 @@ XXX
   end
   alias def_head_option define_head
 
+  # :call-seq:
+  #   define_tail(*params, &block)
+  #
   def define_tail(*opts, &block)
     base.append(*(sw = make_switch(opts, block)))
     sw[0]
   end
 
+  #
+  # :call-seq:
+  #   on_tail(*params, &block)
   #
   # Add option switch like with #on, but at tail of summary.
   #
@@ -1583,6 +1607,9 @@ XXX
           opt.tr!('_', '-')
           begin
             sw, = complete(:long, opt, true)
+            if require_exact && !sw.long.include?(arg)
+              raise InvalidOption, arg
+            end
           rescue ParseError
             raise $!.set_option(arg, true)
           end
@@ -1607,6 +1634,7 @@ XXX
                 val = arg.delete_prefix('-')
                 has_arg = true
               rescue InvalidOption
+                raise if require_exact
                 # if no short options match, try completion with long
                 # options.
                 sw, = complete(:long, opt)
@@ -1618,7 +1646,12 @@ XXX
           end
           begin
             opt, cb, val = sw.parse(val, argv) {|*exc| raise(*exc) if eq}
+          rescue ParseError
+            raise $!.set_option(arg, arg.length > 2)
+          else
             raise InvalidOption, arg if has_arg and !eq and arg == "-#{opt}"
+          end
+          begin
             argv.unshift(opt) if opt and (!rest or (opt = opt.sub(/\A-*/, '-')) != '-')
             val = cb.call(val) if cb
             setter.call(sw.switch_name, val) if setter
@@ -1749,7 +1782,7 @@ XXX
   #
   def visit(id, *args, &block)
     @stack.reverse_each do |el|
-      el.send(id, *args, &block)
+      el.__send__(id, *args, &block)
     end
     nil
   end

data/lib/optparse/kwargs.rb

@@ -2,6 +2,9 @@
 require 'optparse'
 
 class OptionParser
+  # :call-seq:
+  #   define_by_keywords(options, method, **params)
+  #
   def define_by_keywords(options, meth, **opts)
     meth.parameters.each do |type, name|
       case type

data/misc/rb_optparse.bash

@@ -0,0 +1,21 @@
+# -*- bash -*-
+#
+# Completion for bash:
+#
+# (1) install this file,
+#
+# (2) load the script, and
+#      . ~/.profile.d/rb_optparse.bash
+#
+# (3) define completions in your .bashrc,
+#      rb_optparse command_using_optparse_1
+#      rb_optparse command_using_optparse_2
+
+_rb_optparse() {
+  COMPREPLY=($("${COMP_WORDS[0]}" "--*-completion-bash=${COMP_WORDS[COMP_CWORD]}"))
+  return 0
+}
+
+rb_optparse () {
+  [ $# = 0 ] || complete -o default -F _rb_optparse "$@"
+}

data/misc/rb_optparse.zsh

@@ -0,0 +1,39 @@
+# -*- zsh -*-
+#
+# Completion for zsh:
+# (based on <http://d.hatena.ne.jp/rubikitch/20071002/zshcomplete>)
+#
+# (1) install this file.
+#      mkdir -p ~/.zsh.d
+#      cp rb_optparse.zsh ~/.zsh.d/rb_optparse.zsh
+#
+# (2) load the script, and add a directory to fpath before compinit.
+#      echo '. ~/.zsh.d/rb_optparse.zsh' >> "${ZDOTDIR:-~}/.zshrc"
+#      echo 'fpath=(~/.zsh.d/Completion $fpath)' >> "${ZDOTDIR:-~}/.zshrc"
+#      echo 'autoload -U compinit; compinit' >> "${ZDOTDIR:-~}/.zshrc"
+#
+# (3) restart zsh.
+#
+# (4) generate completion files once.
+#      generate-complete-function/ruby/optparse COMMAND1
+#      generate-complete-function/ruby/optparse COMMAND2
+#
+
+generate-complete-function/ruby/optparse ()
+{
+    local cmpl="_${1:t}"
+    mkdir -p "${ZSH_COMPLETION_DIR-$HOME/.zsh.d/Completion}"
+    $1 "--*-completion-zsh=${1:t}" >! "${ZSH_COMPLETION_DIR-$HOME/.zsh.d/Completion}/$cmpl"
+    if [[ $(type -w "$cmpl") == "${cmpl}: function" ]]; then
+        unfunction "$cmpl"
+        autoload -U "$cmpl"
+    else
+        compinit "$cmpl"
+    fi
+}
+
+compdef _command generate-complete-function/ruby/optparse
+
+for cmd in "$@"; do
+    generate-complete-function/ruby/optparse "$cmd"
+done

data/optparse.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{OptionParser is a class for command-line option analysis.}
   spec.description   = %q{OptionParser is a class for command-line option analysis.}
   spec.homepage      = "https://github.com/ruby/optparse"
-  spec.license       = ["Ruby", "BSD-2-Clause"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
 
@@ -24,7 +23,9 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f|
+      f.match(%r{\A(?:(?:test|spec|features)/|Gemfile|\.(?:editor|git))})
+    }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }

data/rakelib/changelogs.rake

@@ -0,0 +1,34 @@
+task "build" => "changelogs"
+
+changelog = proc do |output, ver = nil, prev = nil|
+  ver &&= Gem::Version.new(ver)
+  range = [[prev], [ver, "HEAD"]].map {|ver, branch| ver ? "v#{ver.to_s}" : branch}.compact.join("..")
+  IO.popen(%W[git log --format=fuller --topo-order --no-merges #{range}]) do |log|
+    line = log.gets
+    FileUtils.mkpath(File.dirname(output))
+    File.open(output, "wb") do |f|
+      f.print "-*- coding: utf-8 -*-\n\n", line
+      log.each_line do |line|
+        line.sub!(/^(?!:)(?:Author|Commit)?(?:Date)?: /, '  \&')
+        line.sub!(/ +$/, '')
+        f.print(line)
+      end
+    end
+  end
+end
+
+tags = IO.popen(%w[git tag -l v[0-9]*]).grep(/v(.*)/) {$1}
+tags.sort_by! {|tag| tag.scan(/\d+/).map(&:to_i)}
+tags.inject(nil) do |prev, tag|
+  task("logs/ChangeLog-#{tag}") {|t| changelog[t.name, tag, prev]}
+  tag
+end
+
+desc "Make ChangeLog"
+task "ChangeLog", [:ver, :prev] do |t, ver: nil, prev: tags.last|
+  changelog[t.name, ver, prev]
+end
+
+changelogs = ["ChangeLog", *tags.map {|tag| "logs/ChangeLog-#{tag}"}]
+task "changelogs" => changelogs
+CLOBBER.concat(changelogs) << "logs"

data/rakelib/epoch.rake

@@ -0,0 +1,5 @@
+task "build" => "date_epoch"
+
+task "date_epoch" do
+  ENV["SOURCE_DATE_EPOCH"] = IO.popen(%W[git -C #{__dir__} log -1 --format=%ct], &:read).chomp
+end

data/rakelib/version.rake

@@ -0,0 +1,47 @@
+class << (helper = Bundler::GemHelper.instance)
+  def mainfile
+    "lib/#{File.basename(gemspec.loaded_from, ".gemspec")}.rb"
+  end
+
+  def update_version
+    File.open(mainfile, "r+b") do |f|
+      d = f.read
+      if d.sub!(/^(\s*OptionParser::Version\s*=\s*)".*"/) {$1 + gemspec.version.to_s.dump}
+        f.rewind
+        f.truncate(0)
+        f.print(d)
+      end
+    end
+  end
+
+  def commit_bump
+    sh(%W[git -C #{File.dirname(gemspec.loaded_from)} commit -m bump\ up\ to\ #{gemspec.version}
+          #{mainfile}])
+  end
+
+  def version=(v)
+    gemspec.version = v
+    update_version
+    commit_bump
+  end
+end
+
+major, minor, teeny = helper.gemspec.version.segments
+
+task "bump:teeny" do
+  helper.version = Gem::Version.new("#{major}.#{minor}.#{teeny+1}")
+end
+
+task "bump:minor" do
+  helper.version = Gem::Version.new("#{major}.#{minor+1}.0")
+end
+
+task "bump:major" do
+  helper.version = Gem::Version.new("#{major+1}.0.0")
+end
+
+task "bump" => "bump:teeny"
+
+task "tag" do
+  helper.__send__(:tag_version)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optparse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nobu Nakada
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies: []
 description: OptionParser is a class for command-line option analysis.
 email:
@@ -17,15 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
 - COPYING
-- Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/optionparser.rb
 - lib/optparse.rb
 - lib/optparse/ac.rb
@@ -35,7 +29,12 @@ files:
 - lib/optparse/time.rb
 - lib/optparse/uri.rb
 - lib/optparse/version.rb
+- misc/rb_optparse.bash
+- misc/rb_optparse.zsh
 - optparse.gemspec
+- rakelib/changelogs.rake
+- rakelib/epoch.rake
+- rakelib/version.rake
 homepage: https://github.com/ruby/optparse
 licenses:
 - Ruby
@@ -58,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: OptionParser is a class for command-line option analysis.

data/.github/workflows/test.yml

@@ -1,24 +0,0 @@
-name: test
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
-    strategy:
-      matrix:
-        ruby: [ 2.7, 2.6, 2.5, head ]
-        os: [ ubuntu-latest, macos-latest ]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: |
-        gem install bundler --no-document
-        bundle install
-    - name: Run test
-      run: rake test

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem "rake"
-gem "test-unit"

data/Gemfile.lock

@@ -1,17 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    power_assert (1.2.0)
-    rake (13.0.1)
-    test-unit (3.3.5)
-      power_assert
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake
-  test-unit
-
-BUNDLED WITH
-   2.2.0.dev

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "optparse"
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install