options 2.0.0 → 2.1.1

data/README

@@ -26,6 +26,7 @@ INSTALL
   gem install options
 
 SAMPLES
+
   
   <========< samples/a.rb >========>
 
@@ -33,7 +34,7 @@ SAMPLES
 
     require 'options'
     
-    # options.rb makes is super easy to deal with keyword options in a safe and
+    # options.rb makes it super easy to deal with keyword options in a safe and
     # easy way.
     #
     
@@ -149,3 +150,30 @@ SAMPLES
     {:options=>{:k=>:v}}
 
 
+  <========< samples/d.rb >========>
+
+  ~ > cat samples/d.rb
+
+    require 'options'
+    
+    # options.rb makes it easy to provide good error messages when people
+    # misuse a method.
+    #
+    
+      def method(*args)
+        args, options = Options.parse(args)
+        options.validate(:force)
+    
+        force = options.getopt(:force, default=false)
+        p force
+      end
+    
+      method(:foo, :bar, :force => true)
+    
+    
+
+  ~ > ruby samples/d.rb
+
+    true
+
+

data/README.erb

@@ -0,0 +1,35 @@
+NAME
+  options.rb
+
+DESCRIPTION
+  options.rb simplifies the common idiom of dealing with keyword options in
+  ruby functions.  it also deals correctly with symbol vs string keywords and
+  prevents many subtle programming errors that can arise from doing so
+  incorrectly.  options.rb doesn't hack ruby's core with one exception: the
+  method Array#options.
+
+SYNOPSIS
+  require 'options'
+
+  def method(*args, &block)
+    args, options = Options.parse(args)
+
+    a = args.shift
+    b = args.shift
+
+    force = options.getopt(:force, default = false)
+    verbose = options.getopt([:verbose, :VERBOSE])
+    foo, bar = options.getopt(:foo, :bar)
+  end
+
+INSTALL
+  gem install options
+
+HISTORY
+  2.1.0:
+    - 1.9 compatibility
+    - Validation of passed options
+
+SAMPLES
+
+  <%= samples %>

data/Rakefile

@@ -0,0 +1,235 @@
+
+This.rubyforge_project = 'codeforpeople'
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "http://github.com/ahoward/#{ This.lib }/tree/master"
+
+
+task :default do
+  puts(Rake::Task.tasks.map{|task| task.name} - ['default'])
+end
+
+task :spec do
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+  end
+end
+
+
+task :gemspec do
+  ignore_extensions = 'git', 'svn', 'tmp', /sw./, 'bak', 'gem'
+  ignore_directories = 'pkg'
+  ignore_files = 'test/log'
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        dirname = File.expand_path(entry)
+        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
+      end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
+    end
+
+  lib         = This.lib
+  version     = This.version
+  files       = shiteless[Dir::glob("**/**")]
+  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+  has_rdoc    = true #File.exist?('doc')
+  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+
+  extensions = This.extensions
+  if extensions.nil?
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## #{ lib }.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = #{ lib.inspect }
+            spec.version = #{ version.inspect }
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = #{ lib.inspect }
+
+            spec.files = #{ files.inspect }
+            spec.executables = #{ executables.inspect }
+            
+            spec.require_path = "lib"
+
+            spec.has_rdoc = #{ has_rdoc.inspect }
+            spec.test_files = #{ test_files.inspect }
+            #spec.add_dependency 'lib', '>= version'
+            #spec.add_dependency 'fattr'
+
+            spec.extensions.push(*#{ extensions.inspect })
+
+            spec.rubyforge_project = #{ This.rubyforge_project.inspect }
+            spec.author = #{ This.author.inspect }
+            spec.email = #{ This.email.inspect }
+            spec.homepage = #{ This.homepage.inspect }
+          end
+        __
+      }
+    end
+
+  open("#{ lib }.gemspec", "w"){|fd| fd.puts template}
+  This.gemspec = "#{ lib }.gemspec"
+end
+
+task :gem => [:clean, :gemspec] do
+  Fu.mkdir_p This.pkgdir
+  before = Dir['*.gem']
+  cmd = "gem build #{ This.gemspec }"
+  `#{ cmd }`
+  after = Dir['*.gem']
+  gem = ((after - before).first || after.first) or abort('no gem!')
+  Fu.mv gem, This.pkgdir
+  This.gem = File.basename(gem)
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -Ilib #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'readme.erb')
+      Template{ IO.read('readme.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+task :release => [:clean, :gemspec, :gem] do
+  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
+  raise "which one? : #{ gems.inspect }" if gems.size > 1
+  raise "no gems?" if gems.size < 1
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.pkgdir }/#{ This.gem }"
+  puts cmd
+  system cmd
+end
+
+
+
+
+
+BEGIN {
+  $VERBOSE = nil
+
+  require 'ostruct'
+  require 'erb'
+  require 'fileutils'
+
+  Fu = FileUtils
+
+  This = OpenStruct.new
+
+  This.file = File.expand_path(__FILE__)
+  This.dir = File.dirname(This.file)
+  This.pkgdir = File.join(This.dir, 'pkg')
+
+  lib = ENV['LIB']
+  unless lib
+    lib = File.basename(Dir.pwd)
+  end
+  This.lib = lib
+
+  version = ENV['VERSION']
+  unless version
+    name = lib.capitalize
+    require "./lib/#{ lib }"
+    version = eval(name).send(:version)
+  end
+  This.version = version
+
+  abort('no lib') unless This.lib
+  abort('no version') unless This.version
+
+  module Util
+    def indent(s, n = 2)
+      s = unindent(s)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each do |line|
+      next if line =~ %r/^\s*$/
+      indent = line[%r/^\s*/] and break
+    end
+    indent ? s.gsub(%r/^#{ indent }/, "") : s
+  end
+    extend self
+  end
+
+  class Template
+    def initialize(&block)
+      @block = block
+      @template = block.call.to_s
+    end
+    def expand(b=nil)
+      ERB.new(Util.unindent(@template)).result(b||@block)
+    end
+    alias_method 'to_s', 'expand'
+  end
+  def Template(*args, &block) Template.new(*args, &block) end
+
+  Dir.chdir(This.dir)
+}

data/lib/options.rb

@@ -1,5 +1,5 @@
 module Options
-  VERSION = '2.0.0'
+  VERSION = '2.1.1'
 
   class << Options
     def version
@@ -46,8 +46,15 @@ module Options
     end
 
     def parse(args)
-      args.extend(Arguments) unless args.is_a?(Arguments)
-      args.options.pop
+      case args
+      when Array
+        args.extend(Arguments) unless args.is_a?(Arguments)
+        [args, args.options.pop]
+      when Hash
+        Options.for(args)
+      else
+        raise ArgumentError, "`args` should be and Array or Hash"
+      end
     end
   end
 
@@ -131,13 +138,13 @@ module Options
   def normalize!
     Options.normalize!(self)
   end
-  alias_method 'normalized!', 'normalized!'
+  alias_method 'normalized!', 'normalize!'
   alias_method 'to_options!', 'normalize!'
 
   def normalize
     Options.normalize(self)
   end
-  alias_method 'normalized', 'normalized'
+  alias_method 'normalized', 'normalize'
   alias_method 'to_options', 'normalize'
 
   def stringify!
@@ -163,6 +170,23 @@ module Options
   def pop!
     @popped = arguments.pop
   end
+
+  # Validates that the options provided are acceptable.
+  #
+  # @param [Symbol] *acceptable_options List of options that are
+  #   allowed
+  def validate(*acceptable_options)
+    remaining = (provided_options - acceptable_options).map{|opt| opt.to_s}.sort
+    raise ArgumentError, "Unrecognized options: #{remaining.join(', ')}" unless remaining.empty?
+    
+    self
+  end
+
+  protected
+
+  def provided_options
+    normalize!.keys
+  end
 end
 
 module Arguments

data/options.gemspec

@@ -1,26 +1,26 @@
-### gemspec: options-2.0.0
+## options.gemspec
+#
 
-  Gem::Specification::new do |spec|
-    spec.name = "options"
-    spec.version = "2.0.0"
-    spec.platform = Gem::Platform::RUBY
-    spec.summary = "options"
+Gem::Specification::new do |spec|
+  spec.name = "options"
+  spec.version = "2.1.1"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "options"
 
-    spec.files = ["gemspec.rb", "lib", "lib/options.rb", "options.gemspec", "README", "README.rb", "samples", "samples/a.rb", "samples/b.rb", "samples/c.rb"]
-    spec.executables = []
-    
-    spec.require_path = "lib"
+  spec.files = ["lib", "lib/options.rb", "options.gemspec", "Rakefile", "README", "README.erb", "samples", "samples/a.rb", "samples/b.rb", "samples/c.rb", "samples/d.rb", "spec", "spec/options_spec.rb", "spec/spec_helper.rb"]
+  spec.executables = []
+  
+  spec.require_path = "lib"
 
-    spec.has_rdoc = true
-    spec.test_files = nil
-    #spec.add_dependency 'lib', '>= version'
-    #spec.add_dependency 'fattr'
+  spec.has_rdoc = true
+  spec.test_files = nil
+  #spec.add_dependency 'lib', '>= version'
+  #spec.add_dependency 'fattr'
 
-    spec.extensions.push(*[])
-
-    spec.rubyforge_project = 'codeforpeople'
-    spec.author = "Ara T. Howard"
-    spec.email = "ara.t.howard@gmail.com"
-    spec.homepage = "http://github.com/ahoward/options/tree/master"
-  end
+  spec.extensions.push(*[])
 
+  spec.rubyforge_project = "codeforpeople"
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://github.com/ahoward/options/tree/master"
+end

data/samples/a.rb

@@ -1,6 +1,6 @@
 require 'options'
 
-# options.rb makes is super easy to deal with keyword options in a safe and
+# options.rb makes it super easy to deal with keyword options in a safe and
 # easy way.
 #
 

data/samples/d.rb

@@ -0,0 +1,17 @@
+require 'options'
+
+# options.rb makes it easy to provide good error messages when people
+# misuse a method.
+#
+
+  def method(*args)
+    args, options = Options.parse(args)
+    options.validate(:force)
+
+    force = options.getopt(:force, default=false)
+    p force
+  end
+
+  method(:foo, :bar, :force => true)
+
+

data/spec/options_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + "/spec_helper"
+require 'options'
+
+describe Options do 
+  describe "parsing" do 
+    it "should be able to handle an options hash" do 
+      opts = Options.parse({:this => 'that'})
+      opts.getopt(:this).should eql('that')
+    end
+
+    it "should be able to handle args list w/ options hash" do 
+      args, opts = Options.parse([:foo, {:this => 'that'}])
+      opts.getopt(:this).should eql('that')
+      args.should eql([:foo])
+    end
+  end
+
+  describe "validation" do 
+    it "should be able to detect extraneous options" do 
+      lambda{
+        Options.parse({:this => 'test'}).validate(:foo, :bar)
+      }.should raise_error(ArgumentError, "Unrecognized options: this")
+    end
+
+    it "should list all extraneous options in message" do 
+      lambda{
+        Options.parse({:this => 'test', :that => 'test'}).validate(:foo)
+      }.should raise_error(ArgumentError, "Unrecognized options: that, this")
+    end
+
+    it "should accept options from simple list" do 
+      lambda{
+        Options.parse({:foo => 'this', :bar => 'that'}).validate(:foo, :bar)
+      }.should_not raise_error
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'spec'
+require 'pathname'
+require 'pp'
+
+$LOAD_PATH.unshift Pathname(__FILE__).dirname + "../lib"
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: options
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-31 00:00:00 -06:00
+date: 2009-08-19 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -22,16 +22,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- gemspec.rb
 - lib
 - lib/options.rb
 - options.gemspec
+- Rakefile
 - README
-- README.rb
+- README.erb
 - samples
 - samples/a.rb
 - samples/b.rb
 - samples/c.rb
+- samples/d.rb
+- spec
+- spec/options_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/ahoward/options/tree/master
 post_install_message: 

data/README.rb

@@ -1,80 +0,0 @@
-#! /usr/bin/env ruby
-
-template = <<-__
-  NAME
-    options.rb
-
-  DESCRIPTION
-    options.rb simplifies the common idiom of dealing with keyword options in
-    ruby functions.  it also deals correctly with symbol vs string keywords and
-    prevents many subtle programming errors that can arise from doing so
-    incorrectly.  options.rb doesn't hack ruby's core with one exception: the
-    method Array#options.
-
-  SYNOPSIS
-    require 'options'
-
-    def method(*args, &block)
-      args, options = Options.parse(args)
-
-      a = args.shift
-      b = args.shift
-
-      force = options.getopt(:force, default = false)
-      verbose = options.getopt([:verbose, :VERBOSE])
-      foo, bar = options.getopt(:foo, :bar)
-    end
-
-  INSTALL
-    gem install options
-
-  SAMPLES
-    <%= samples %>
-__
-
-
-require 'erb'
-require 'pathname'
-
-$VERBOSE=nil
-
-def indent(s, n = 2)
-  s = unindent(s)
-  ws = ' ' * n
-  s.gsub(%r/^/, ws)
-end
-
-def unindent(s)
-  indent = nil
-  s.each do |line|
-    next if line =~ %r/^\s*$/
-    indent = line[%r/^\s*/] and break
-  end
-  indent ? s.gsub(%r/^#{ indent }/, "") : s
-end
-
-samples = ''
-prompt = '~ > '
-
-Dir.chdir(File.dirname(__FILE__))
-
-Dir['sample*/*'].sort.each do |sample|
-  samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
-
-  cmd = "cat #{ sample }" 
-  samples << indent(prompt + cmd, 2) << "\n\n" 
-  samples << indent(`#{ cmd }`, 4) << "\n" 
-
-  cmd = "ruby #{ sample }" 
-  samples << indent(prompt + cmd, 2) << "\n\n" 
-
-  cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -Ilib #{ sample })'" 
-  #cmd = "ruby -Ilib #{ sample }" 
-  samples << indent(`#{ cmd } 2>&1`, 4) << "\n" 
-end
-
-erb = ERB.new(unindent(template))
-result = erb.result(binding)
-#open('README', 'w'){|fd| fd.write result}
-#puts unindent(result)
-puts result

data/gemspec.rb

@@ -1,62 +0,0 @@
-#! /usr/bin/env ruby
-
-lib, version, *ignored = ARGV
-
-unless lib
-  lib = File.basename(Dir.pwd)
-end
-
-unless version
-  mod = lib.capitalize
-  require "./lib/#{ lib }"
-  version = eval(mod).send(:version)
-end
-
-abort('no lib') unless lib
-abort('no version') unless version
-
-puts "### gemspec: #{ lib }-#{ version }"
-
-$VERBOSE = nil
-
-shiteless = lambda{|list| list.delete_if{|file| file =~ %r/\.(git|svn|tmp|sw.|bak|gem)$/}}
-
-files       = shiteless[Dir::glob("**/**")]
-executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
-has_rdoc    = true #File.exist?('doc')
-test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
-
-extensions = []
-%w( Makefile configure extconf.rb rakefile Rakefile mkrf_conf ).each do |ext|
-  extensions << ext if File.exists?(ext)
-end
-
-template = <<-__
-
-  Gem::Specification::new do |spec|
-    spec.name = #{ lib.inspect }
-    spec.version = #{ version.inspect }
-    spec.platform = Gem::Platform::RUBY
-    spec.summary = #{ lib.inspect }
-
-    spec.files = #{ files.inspect }
-    spec.executables = #{ executables.inspect }
-    
-    spec.require_path = "lib"
-
-    spec.has_rdoc = #{ has_rdoc.inspect }
-    spec.test_files = #{ test_files.inspect }
-    #spec.add_dependency 'lib', '>= version'
-    #spec.add_dependency 'fattr'
-
-    spec.extensions.push(*#{ extensions.inspect })
-
-    spec.rubyforge_project = 'codeforpeople'
-    spec.author = "Ara T. Howard"
-    spec.email = "ara.t.howard@gmail.com"
-    spec.homepage = "http://github.com/ahoward/#{ lib }/tree/master"
-  end
-
-__
-
-puts template