argos 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db10ec4b4ba706521829ff94256f6aeeb535583d
+  data.tar.gz: 9a05741bec97fcbe78f1a895ece95f82722c7cb9
+SHA512:
+  metadata.gz: 2de75d97e7d47de815118087efd18b254c6e763be3825a7beb70aa3c4521cca54ff0334911bf3b14955f6152699f75195c23197f2fb1fb0af0807019b5a041f6
+  data.tar.gz: a3ae1af737afd333e7d8a8f14f15cce213ee94f9d41e8c573d748fe78bad76df77e74c008881852f69a1c6ed76877a6285b523893120556ceccc434756fe5a98

data/COPYING

@@ -0,0 +1,22 @@
+Copyright (c) 2006-2014, Joel VanderWerf, vjoel@users.sourceforge.net
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,97 @@
+argos
+====
+
+A slim command-line parser that does one thing well: turn an array of
+strings, such as ARGV, into a hash of recognized options and their
+arguments, leaving unrecognized strings in the original array.
+
+Argos was Odysseus' faithful dog, who was good at recognizing ;)
+
+Installation
+------------
+
+Install as gem:
+
+    gem install 'argos'
+
+or simply copy argos.rb into your project's lib dir.
+
+Synopsis
+--------
+
+     require 'argos'
+
+     optdef = {
+       "v"   => true,
+       "n"   => proc {|arg| Integer(arg)}
+     }
+
+     argv = %w{-v -n10 filename}
+     opts = Argos.parse_options(argv, optdef)
+     p opts    # ==> {"v"=>true, "n"=>10}
+     p argv    # ==> ["filename"]
+
+See also [example dir](example/).
+
+Features
+--------
+
+- Operates on ARGV or any given array of strings.
+
+- Output is a hash of {option => value, ...}.
+
+- You can merge this hash on top of a hash of defaults if you want.
+
+- Supports both long ("--foo") and short ("-f") options.
+
+- A long option with an argument is --foo=bar or --foo bar.
+
+- A short option with an argument is -fbar or -f bar.
+
+- The options -x and --x are synonymous.
+
+- Short options with no args can be combined as -xyz in place of -x -y -z.
+
+- If -z takes an argument, then -xyz foo is same as -x -y -z foo.
+
+- The string "--" terminates option parsing, leaving the rest untouched.
+
+- The string "-" is not considered an option.
+
+- ARGV (or other given array) is modified: it has all parsed options
+  and arguments removed, so you can use ARGF to treat the rest as input files.
+
+- Unrecognized arguments are left in the argument array. You can catch them
+  with grep(/^-./), in case you want to pass them on to another program or
+  warn the user.
+
+- Argument validation and conversion are in terms of an option definition
+  hash, which specifies which options are allowed, the number of arguments
+  for each (0 or 1), and how to generate the value from the argument, if any.
+
+- Repetition of args ("-v -v", or "-vv") can be handled by closures. See
+  the example below.
+
+- Everything is ducky. For example, handlers only need an #arity method
+  and a #[] method to be recognized as callable. Otherwise they are treated
+  as static objects.
+
+
+Limitations
+-----------
+
+- A particular option takes either 0 args or 1 arg. There are no optional
+  arguments, in the sense of both "-x" and "-x3" being accepted.
+
+- Options lose their ordering in the output hash (but they are parsed in
+  order and you can keep track using state in the handler closures).
+
+- There is no usage/help output.
+
+
+About
+-----
+
+Copyright (C) 2006-2014 Joel VanderWerf, mailto:vjoel@users.sourceforge.net.
+
+License is BSD. See [COPYING](COPYING).

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rake'
+require 'rake/testtask'
+
+PRJ = "argos"
+
+def version
+  @version ||= begin
+    require 'argos'
+    warn "Argos::VERSION not a string" unless Argos::VERSION.kind_of? String
+    Argos::VERSION
+  end
+end
+
+def tag
+  @tag ||= "#{PRJ}-#{version}"
+end
+
+desc "Run tests"
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.libs << "ext"
+  t.test_files = FileList["test/**/*.rb"]
+end
+
+desc "Commit, tag, and push repo; build and push gem"
+task :release => "release:is_new_version" do
+  require 'tempfile'
+  
+  sh "gem build #{PRJ}.gemspec"
+
+  file = Tempfile.new "template"
+  begin
+    file.puts "release #{version}"
+    file.close
+    sh "git commit --allow-empty -a -v -t #{file.path}"
+  ensure
+    file.close unless file.closed?
+    file.unlink
+  end
+
+  sh "git tag #{tag}"
+  sh "git push"
+  sh "git push --tags"
+  
+  sh "gem push #{tag}.gem"
+end
+
+namespace :release do
+  desc "Diff to latest release"
+  task :diff do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git diff #{latest}"
+  end
+
+  desc "Log to latest release"
+  task :log do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git log #{latest}.."
+  end
+
+  task :is_new_version do
+    abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
+  end
+end

data/example/args.rb

@@ -0,0 +1,39 @@
+require 'argos'
+
+v = 0
+defaults = {
+  "v"     => v,
+  "port"  => 4000,
+  "host"  => "localhost"
+}
+
+optdef = {
+  "x"     => true,
+  "y"     => "y",
+  "z"     => 3,
+  "v"     => proc {v+=1}, # no argument, but call the proc to get the value
+  "port"  => proc {|arg| Integer(arg)},
+  "n"     => proc {|arg| Integer(arg)},
+  "t"     => proc {|arg| Float(arg)},
+  "cmd"   => proc {|arg| arg.split(",")}
+}
+
+ARGV.replace %w{
+  -xyzn5 somefile --port 5000 -t -1.23 -vv -v --unrecognized-option
+  --cmd=ls,-l otherfile -- --port
+}
+
+begin
+  cli_opts = Argos.parse_options(ARGV, optdef)
+rescue Argos::OptionError => ex
+  $stderr.puts ex.message
+  exit
+end
+
+opts = defaults.merge cli_opts
+
+p opts
+p ARGV
+unless ARGV.empty?
+  puts "Some arg-looking strings were not handled:", *ARGV.grep(/^-./)
+end

data/lib/argos.rb

@@ -0,0 +1,98 @@
+module Argos
+  VERSION = "1.0"
+
+  module_function
+
+  # Raised (a) when an option that takes an argument occurs at the end of the
+  # argv list, with no argument following it, or (b) when a handler barfs.
+  class OptionError < ArgumentError; end
+  
+  # Called when an option that takes an argument occurs at the end of the
+  # argv list, with no argument following it.
+  def argument_missing opt
+    raise OptionError, "#{opt}: no argument provided."
+  end
+  
+  def handle opt, handler, *args # :nodoc
+    args.empty? ?  handler[] : handler[args[0]]
+  rescue => ex
+    raise OptionError, "#{opt}: #{ex}"
+  end
+
+  # Returns the hash of parsed options and argument values. The +argv+ array
+  # is modified: every recognized option and argument is deleted.
+  #
+  # The +optdef+ hash defines the options and their arguments.
+  #
+  # Each key is an option name (without "-" chars).
+  #
+  # The value for a key in +optdef+
+  # is used to generate the value for the same key in the options hash
+  # returned by this method.
+  #
+  # If the value has an #arity method and arity > 0, the value is considered to
+  # be a handler; it is called with the argument string to return the value
+  # associated with the option in the hash returned by the method.
+  #
+  # If the arity <= 0, the value is considered to be a handler for an option
+  # without arguments; it is called with no arguments to return the value of
+  # the option.
+  #
+  # If there is no arity method, the object itself is used as the value of
+  # the option.
+  #
+  # Only one kind of input will cause an exception (not counting exceptions
+  # raised by handler code or by bugs):
+  #
+  # - An option is found at the end of the list, and it requires an argument.
+  #   This results in a call to #argument_missing, which by default raises
+  #   OptionError.
+  #
+  def parse_options argv, optdef
+    orig = argv.dup; argv.clear
+    opts = {}
+
+    loop do
+      case (argstr=orig.shift)
+      when nil, "--"
+        argv.concat orig
+        break
+
+      when /^(--)([^=]+)=(.*)/, /^(-)([^-])(.+)/
+        short = ($1 == "-"); opt = $2; arg = $3
+        unless optdef.key?(opt)
+          argv << argstr
+          next
+        end
+        handler = optdef[opt]
+        arity = (handler.arity rescue nil)
+        opts[opt] =
+          case arity
+          when nil;   orig.unshift("-#{arg}") if short; handler
+          when 0,-1;  orig.unshift("-#{arg}") if short; handle(opt, handler)
+          else        handle(opt, handler, arg)
+          end
+
+      when /^--(.+)/, /^-(.)$/
+        opt = $1
+        unless optdef.key?(opt)
+          argv << argstr
+          next
+        end
+        handler = optdef[opt]
+        arity = (handler.arity rescue nil)
+        opts[opt] =
+          case arity
+          when nil;   handler
+          when 0,-1;  handle(opt, handler)
+          else        handle(opt, handler, orig.shift || argument_missing(opt))
+          end
+
+      else
+        argv << argstr
+      end
+    end
+
+    opts
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: argos
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Joel VanderWerf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies: []
+description: 'A slim command-line parser that does one thing well: turn an array of
+  arguments into a hash of recognized options and their arguments.'
+email: vjoel@users.sourceforge.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+files:
+- COPYING
+- README.md
+- Rakefile
+- example/args.rb
+- lib/argos.rb
+homepage: https://github.com/vjoel/argos
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- argos
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Minimal command-line parser
+test_files: []
+has_rdoc: