optparse-off 0.0.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 KITAITI Makoto
+
+MIT License
+
+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/README.markdown

@@ -0,0 +1,85 @@
+OptionParser#off
+================
+
+Add a functionality which remove options already added to OptionParser.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'optparse-off'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optparse-off
+
+Usage
+-----
+
+    require 'optparse/off'
+    
+    opts = OptionParser.new
+    opts.on '-n'
+    opts.off '-n'
+    opts.parse '-n' #=> invalid option: -n (OptionParser::InvalidOption)
+
+Use case
+--------
+
+Let you use a simple framework for command-line applications.
+
+    # command.rb
+    require 'optparse'
+    
+    class Command
+      def initialize
+        @opts = OptionParser.new
+        @opts.on '--dry-run' do |switch|
+          @dry_run = switch
+        end
+      end
+      
+      def run
+        @opts.parse!
+      end
+    end
+
+And then create a command to report something, offing `--dry-run' option:
+
+    # report.rb
+    require 'optparse/off'
+    require 'command'
+
+    # This class don't need `--dry-run' option
+    class Report < Command
+      def initialize
+        super
+        
+        # Add an additional option specified to this command
+        @opts.on '--notifier=NOTIFIER', [:email, :irc, :and_so_on] do |notifier|
+          @notifier = notifiler
+        end
+        
+        # Off the `--dry-run' option
+        @opts.off '--dry-run'
+      end
+      
+      def run
+        super
+        # process reporting
+      end
+    end
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'rake/testtask'
+require 'yard'
+require "bundler/gem_tasks"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.loader = :direct
+  dir = File.dirname(__FILE__)
+  t.test_files = FileList["#{dir}/test/**/test*.rb"]
+end
+
+YARD::Rake::YardocTask.new

data/lib/optparse/off.rb

@@ -0,0 +1,18 @@
+require 'optparse'
+
+class OptionParser
+  def off(short_option=nil, long_option=nil)
+    sw = make_switch([short_option, long_option])
+    sw[1].each do |so|
+      top.short.delete so
+    end
+    sw[2].each do |lo|
+      top.long.delete lo
+    end
+    top.list.delete_if do |switch|
+      switch.short.delete short_option
+      switch.long.delete long_option
+      switch.short.empty? && switch.long.empty?
+    end
+  end
+end

data/optparse-off.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |gem|
+  gem.name          = "optparse-off"
+  gem.version       = '0.0.1'
+  gem.authors       = ["KITAITI Makoto"]
+  gem.email         = ["KitaitiMakoto@gmail.com"]
+  gem.description   = %q{Add a functionality which remove options already added to OptionParser}
+  gem.summary       = %q{Add removing-option functionality to OptionParser}
+  gem.homepage      = ""
+
+  gem.files         = %w[lib/optparse/off.rb test/test_off.rb README.markdown Rakefile LICENSE.txt optparse-off.gemspec]
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/test_off.rb

@@ -0,0 +1,58 @@
+gem 'test-unit'
+require 'test/unit'
+require 'optparse/off'
+
+class TestOptionParserOff < Test::Unit::TestCase
+  def setup
+    @opt = OptionParser.new
+  end
+
+  data 'single short', {
+    :def_opts => %w[-n],
+    :off_opts => %w[-n],
+    :argv     => %w[-n],
+    :expected => OptionParser::InvalidOption
+  }
+  data 'single short, single long, short arg', {
+    :def_opts => %w[-n --lines],
+    :off_opts => %w[-n],
+    :argv     => %w[-n],
+    :expected => OptionParser::InvalidOption
+  }
+  data 'single short, single long, off short, long arg', {
+    :def_opts => %w[-n --lines],
+    :off_opts => %w[-n],
+    :argv     => %w[--lines],
+    :expected => {'lines' => true}
+  }
+  data 'single short, single long, off short, short arg', {
+    :def_opts => %w[-n --lines],
+    :off_opts => %w[-n],
+    :argv     => %w[-n],
+    :expected => OptionParser::InvalidOption
+  }
+  data 'single short, single long, off long, long arg', {
+    :def_opts => %w[-n --lines],
+    :off_opts => %w[--lines],
+    :argv     => %w[--lines],
+    :expected => OptionParser::InvalidOption
+  }
+  data 'single short, single long, off both, long arg', {
+    :def_opts => %w[-n --lines],
+    :off_opts => %w[-n --lines],
+    :argv     => %w[--lines],
+    :expected => OptionParser::InvalidOption
+  }
+  def test_opt_off(data)
+    @opt.def_option *data[:def_opts]
+    @opt.off *data[:off_opts]
+    if data[:expected].kind_of?(Class) and data[:expected] < Exception
+      assert_raise data[:expected] do
+        @opt.parse data[:argv]
+      end
+    else
+      assert_equal data[:expected], @opt.getopts(data[:argv])
+    end
+  end
+end
+

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: optparse-off
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- KITAITI Makoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-12 00:00:00.000000000Z
+dependencies: []
+description: Add a functionality which remove options already added to OptionParser
+email:
+- KitaitiMakoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/optparse/off.rb
+- test/test_off.rb
+- README.markdown
+- Rakefile
+- LICENSE.txt
+- optparse-off.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Add removing-option functionality to OptionParser
+test_files:
+- test/test_off.rb
+has_rdoc: