args_parser 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 2012-05-09
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/args_parser.rb
+lib/args_parser/parser.rb
+samples/download_webpage.rb
+script/console
+script/destroy
+script/generate
+test/test_args_parser.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,70 @@
+= args_parser
+
+* http://github.com/shokai/args_parser
+
+== DESCRIPTION:
+
+ARGV parser - Parse args from command line. 
+
+== SYNOPSIS:
+
+  % ruby sample.rb -url http://example.com -o out.html
+
+parse ARGV
+
+  require 'rubygems'
+  require 'args_parser'
+  
+  parser = ArgsParser.parse ARGV do
+    arg :url, 'URL', :alias => :u
+    arg :output, 'output file', :alias => :o, :default => 'out.html'
+    arg :verbose, 'verbose mode'
+    arg :help, 'show help', :alias => :h
+  end
+  
+  if parser.has_option? :help or !parser.has_param?(:url, :output)
+    STDERR.puts parser.help
+    exit 1
+  end
+  
+  require 'open-uri'
+  puts 'download..' if parser[:verbose]
+  open(parser[:output], 'w+') do |f|
+    f.write open(parser[:url]).read
+  end
+  puts "saved! => #{parser[:output]}"
+
+
+== REQUIREMENTS:
+
+* Ruby 1.8.7+
+* Ruby 1.9.3+
+
+== INSTALL:
+
+* gem install args_parser
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Sho Hashimoto
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/args_parser'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'args_parser' do
+  self.developer 'Sho Hashimoto', 'hashimoto@shokai.org'
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['newgem','>= 1.5.3']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/args_parser.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'args_parser/parser'
+
+module ArgsParser
+  VERSION = '0.0.1'
+end

data/lib/args_parser/parser.rb

@@ -0,0 +1,134 @@
+
+module ArgsParser
+  def self.parse(argv=[], &block)
+    Parser.new(argv, &block)
+  end
+
+  class Parser
+    attr_reader :first
+
+
+    private
+    def params
+      @params ||=
+        Hash.new{|h,k|
+        h[k] = {
+          :default => nil,
+          :description => nil,
+          :value => nil,
+          :alias => nil,
+          :index => -1
+        }
+      }
+    end
+
+    def aliases
+      @aliases ||= Hash.new
+    end
+
+    public
+    def initialize(argv=[], &block)
+      unless block_given?
+        raise ArgumentError, 'initialize block was not given'
+      end
+      instance_eval &block
+      parse argv
+    end
+
+    def arg(name, description, opts={})
+      params[name][:default] = opts[:default]
+      params[name][:description] = description
+      params[name][:index] = params.keys.size
+      params[name][:alias] = opts[:alias]
+      aliases[opts[:alias]] = name if opts[:alias]
+    end
+
+    def args
+      params.keys
+    end
+
+    def parse(argv)
+      k = nil
+      argv.each_with_index do |arg, index|
+        unless k
+          if arg =~ /^-+[^-\s]+$/
+            k = arg.scan(/^-+([^-\s]+)$/)[0][0].strip.to_sym
+            k = aliases[k]  if aliases[k]
+          elsif index == 0
+            @first = arg
+          end
+        else
+          if arg =~ /^-+[^-\s]+$/
+            params[k][:value] = true
+            k = arg.scan(/^-+([^-\s]+)$/)[0][0].strip.to_sym
+            k = aliases[k]  if aliases[k]
+          else
+            params[k][:value] = arg
+            k = nil
+          end
+        end
+      end
+      if k
+        params[k][:value] = true
+      end
+    end
+
+    def [](key)
+      params[key][:value] || params[key][:default]
+    end
+
+    def []=(key, value)
+      params[key][:value] = value
+    end
+
+    def has_option?(*opt)
+      !(opt.flatten.map{|i|
+          self[i] == true
+        }.include? false)
+    end
+
+    def has_param?(*param_)
+      !(param_.flatten.map{|i|
+          v = self[i]
+          (v and v.kind_of? String) ? true : false
+        }.include? false)
+    end
+
+    def inspect
+      h = Hash.new
+      params.each do |k,v|
+        h[k] = v[:value]
+      end
+      h.inspect
+    end
+
+    def help
+      params_ = Array.new
+      params.each do |k,v|
+        v[:name] = k
+        params_ << v
+      end
+      params_ = params_.delete_if{|i|
+        i[:index] < 0
+      }.sort{|a,b|
+        a[:index] <=> b[:index]
+      }
+
+      len = params_.map{|i|
+        line = " -#{i[:name]}"
+        line += " (-#{i[:alias]})" if i[:alias]
+        line.size
+      }.max
+
+      "options:\n" + params_.map{|i|
+        line = " -#{i[:name]}"
+        line += " (-#{i[:alias]})" if i[:alias]
+        line = line.ljust(len+2)
+        line += i[:description].to_s
+        line += " : default - #{i[:default]}" if i[:default]
+        line
+      }.join("\n")
+    end
+
+  end
+end

data/samples/download_webpage.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'args_parser'
+## require File.dirname(__FILE__)+'/../lib/args_parser'
+
+parser = ArgsParser.parse ARGV do
+  arg :url, 'URL', :alias => :u
+  arg :output, 'output file', :alias => :o, :default => 'out.html'
+  arg :verbose, 'verbose mode'
+  arg :help, 'show help', :alias => :h
+end
+
+if parser.has_option? :help or !parser.has_param?(:url, :output)
+  STDERR.puts "Download WebPage\n=="
+  STDERR.puts parser.help
+  STDERR.puts "e.g.  ruby #{$0} -url http://example.com -o out.html"
+  exit 1
+end
+
+p parser
+
+require 'open-uri'
+
+puts 'download..' if parser[:verbose]
+data = open(parser[:url]).read
+puts data if parser[:verbose]
+
+open(parser[:output], 'w+') do |f|
+  f.write data
+end
+puts "saved! => #{parser[:output]}"

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/args_parser.rb'}"
+puts "Loading args_parser gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_args_parser.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestArgsParser < Test::Unit::TestCase
+  def setup
+    @argv = 'test --input ~/tmp -a --o ./out -h'.split(/\s+/)
+    @parser = ArgsParser.parse @argv do
+      arg :input, 'input dir', :alias => :i
+      arg :output, 'output dir', :alias => :o
+      arg :help, 'show help', :alias => :h
+    end
+  end
+
+  def test_first
+    assert @parser.first == 'test'
+  end
+
+  def test_arg
+    assert @parser[:input] == '~/tmp'
+  end
+
+  def test_alias
+    assert @parser[:output] == './out'
+  end
+
+  def test_missing_arg
+    assert @parser[:a] == true
+  end
+
+  def test_switch
+    assert @parser[:help] == true
+  end
+
+  def test_has_param?
+    assert (@parser.has_param? :input and @parser.has_param? :output)
+  end
+
+  def test_has_params?
+    assert @parser.has_param? :input, :output
+  end
+
+  def test_has_not_param?
+    assert !@parser.has_param?(:a)
+  end
+
+  def test_has_option?
+    assert (@parser.has_option? :help and @parser.has_option? :a)
+  end
+
+  def test_has_options?
+    assert @parser.has_option? :help, :a
+  end
+
+  def test_has_not_option?
+    assert !@parser.has_option?(:b)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/args_parser'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: args_parser
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sho Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 15
+        version: "2.15"
+  type: :development
+  version_requirements: *id003
+description: ARGV parser - Parse args from command line.
+email: 
+- hashimoto@shokai.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/args_parser.rb
+- lib/args_parser/parser.rb
+- samples/download_webpage.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_args_parser.rb
+- test/test_helper.rb
+- .gemtest
+homepage: http://github.com/shokai/args_parser
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: args_parser
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: ARGV parser - Parse args from command line.
+test_files: 
+- test/test_args_parser.rb
+- test/test_helper.rb