slop 0.2.0 → 1.0.0.rc1

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: slop
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  prerelease: 6
+  version: 1.0.0.rc1
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -14,24 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-14 00:00:00 +00:00
+date: 2011-03-16 00:00:00 +00:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
-  type: :development
-  version_requirements: *id001
+dependencies: []
+
 description: A simple DSL for gathering options and parsing the command line
 email: lee@jarvis.co
 executables: []
@@ -41,14 +23,21 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
+- .gitignore
+- .yardopts
 - LICENSE
 - README.md
+- Rakefile
 - lib/slop.rb
 - lib/slop/option.rb
-- spec/slop_spec.rb
-- spec/option_spec.rb
+- lib/slop/version.rb
+- slop.gemspec
+- test/helper.rb
+- test/option_test.rb
+- test/slop_test.rb
 has_rdoc: true
-homepage: http://rubydoc.info/github/injekt/slop
+homepage: http://github.com/injekt/slop
 licenses: []
 
 post_install_message: 
@@ -61,25 +50,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 1
-      version: 1.9.1
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Option gathering made easy
-test_files: []
-
+test_files: 
+- test/helper.rb
+- test/option_test.rb
+- test/slop_test.rb

data/spec/option_spec.rb

@@ -1,186 +0,0 @@
-require File.expand_path('../../lib/slop', __FILE__)
-
-describe Slop::Option do
-
-  describe "argument_value" do
-    it "should return the default value if no value is found" do
-      Slop::Option.new(:default => :foo).argument_value.should == :foo
-    end
-
-    it "is nil if there's no argument value and no default" do
-      Slop::Option.new().argument_value.should be_nil
-    end
-
-    it "converts arguments into an integer with the :as => Integer flag" do
-      opt = Slop::Option.new(:as => Integer)
-      opt.argument_value = "1"
-      opt.argument_value.should == 1
-      opt.argument_value.should be_kind_of Integer
-    end
-
-    it "converts arguments into a symbol with the :as => Symbol flag" do
-      opt = Slop::Option.new(:as => Symbol)
-      opt.argument_value = "lee"
-      opt.argument_value.should == :lee
-      opt.argument_value.should be_kind_of Symbol
-    end
-
-    describe "with the :as Array option" do
-      it "returns nil if no argument_value is set" do
-        Slop::Option.new(:as => Array).argument_value.should be_nil
-      end
-
-      it "returns an Array" do
-        opt = Slop::Option.new(:as => Array)
-        opt.argument_value = "foo"
-        opt.argument_value.should be_kind_of Array
-      end
-
-      it "uses , as the default delimiter" do
-        opt = Slop::Option.new(:as => Array)
-        opt.argument_value = "foo,bar"
-        opt.argument_value.should == ["foo", "bar"]
-        opt.argument_value = "foo:bar"
-        opt.argument_value.should == ["foo:bar"]
-      end
-
-      it "can use a custom delimiter" do
-        opt = Slop::Option.new(:as => Array, :delimiter => ':')
-        opt.argument_value = "foo,bar"
-        opt.argument_value.should == ["foo,bar"]
-        opt.argument_value = "foo:bar"
-        opt.argument_value = ["foo", "bar"]
-      end
-
-      it "can uses a custom limit" do
-        opt = Slop::Option.new(:as => Array, :limit => 3)
-        opt.argument_value = "foo,bar,baz,etc"
-        opt.argument_value.should == ["foo", "bar", "baz,etc"]
-      end
-    end
-  end
-
-  describe "has_flag?" do
-    it "is true if the option contains a flag" do
-      Slop::Option.new().has_flag?(:n).should be_false
-      Slop::Option.new(:flag => :n).has_flag?(:n).should be_true
-    end
-  end
-
-  describe "has_option?" do
-    it "is true if the option constains an.. option" do
-      Slop::Option.new().has_option?(:name).should be_false
-      Slop::Option.new(:option => :name).has_option?(:name).should be_true
-    end
-  end
-
-  describe "has_default?" do
-    it "is true if the option contains a default value" do
-      Slop::Option.new(:default => 'Lee').has_default?.should be_true
-      Slop::Option.new().has_default?.should be_false
-    end
-  end
-
-  describe "has_switch?" do
-    it "is true if the option contains a switchable value" do
-      Slop::Option.new().has_switch?.should be_false
-      Slop::Option.new(:switch => 'injekt').has_switch?.should be_true
-    end
-  end
-
-  describe "has_callback?" do
-    it "is true if the option has a callback" do
-      Slop::Option.new().has_callback?.should be_false
-      Slop::Option.new(:callback => proc { }).has_callback?.should be_true
-    end
-  end
-
-  describe "execute_callback" do
-    it "executes a callback" do
-      opt = Slop::Option.new(:callback => proc { 'foo' })
-      opt.execute_callback.should == 'foo'
-    end
-  end
-
-  describe "requires_argument?" do
-    it "returns true if the option requires an argument" do
-      Slop::Option.new().requires_argument?.should be_false
-      Slop::Option.new(:argument => true).requires_argument?.should be_true
-    end
-  end
-
-  describe "optional_argument?" do
-    it "returns true if the option argument is optional" do
-      Slop::Option.new(:argument => true).optional_argument?.should be_false
-      Slop::Option.new(:argument => true, :optional => true).optional_argument?.should be_true
-      Slop::Option.new(:optional => true).optional_argument?.should be_true
-    end
-  end
-
-  describe "[]" do
-    it "should return an options value" do
-      Slop::Option.new()[:foo].should be_nil
-      Slop::Option.new(:foo => 'bar')[:foo].should == 'bar'
-    end
-  end
-
-  describe "switch_argument_value" do
-    it "replaces an options argument value with the switch value" do
-      opt = Slop::Option.new(:default => 'foo', :switch => 'bar')
-      opt.argument_value.should == 'foo'
-      opt.switch_argument_value
-      opt.argument_value.should == 'bar'
-    end
-  end
-
-  describe "key" do
-    it "returns the option if both a flag and option exist" do
-      Slop::Option.new(:flag => :n, :option => :name).key.should == :name
-    end
-
-    it "returns the flag if there is no option" do
-      Slop::Option.new(:flag => :n).key.should == :n
-    end
-  end
-
-  describe "to_s" do
-    before :all do
-      o = Slop.new do
-        opt(:n, nil, "Your name", true)
-        opt(:a, :age, "Your age", :optional => true)
-        opt(:verbose, "Enable verbose mode")
-        opt(:p, :password, "Your password", true)
-      end
-      @opt = {}
-      @opt[:flag] = o.option_for(:n)
-      @opt[:optional] = o.option_for(:age)
-      @opt[:option] = o.option_for(:verbose)
-      @opt[:required] = o.option_for(:password)
-    end
-
-    it "starts with a tab space" do
-      @opt[:flag].to_s[0].should == "\t"
-    end
-
-    it "displays a flag if one exists" do
-      @opt[:flag].to_s[1, 2].should == "-n"
-    end
-
-    it "appends a comma to the flag if an option exists" do
-      @opt[:flag].to_s[3].should_not == ","
-      @opt[:optional].to_s[3].should == ","
-    end
-
-    it "displays an option if one exists" do
-      @opt[:option].to_s[5, 9].should == "--verbose"
-    end
-
-    it "adds square brackes to the option if the argument is optional" do
-      @opt[:optional].to_s[5, 11].should == "--age [age]"
-    end
-
-    it "adds angle brackets to the option if the argument is required" do
-      @opt[:required].to_s[5, 21].should == "--password <password>"
-    end
-  end
-end

data/spec/slop_spec.rb

@@ -1,204 +0,0 @@
-require File.expand_path('../../lib/slop', __FILE__)
-
-describe Slop do
-  before :all do
-    @slop = Slop.new do
-      option :v, :verbose, "Enable verbose mode"
-    end
-  end
-
-  it "is enumerable" do
-    Enumerable.instance_methods.each do |meth|
-      @slop.respond_to?(meth).should be_true
-    end
-  end
-
-  describe "banner" do
-    it "adds a banner to the beginning of the help string" do
-      o = Slop.new do
-        banner("foo bar")
-      end
-      o.to_s.should == "foo bar\n"
-    end
-  end
-
-  describe "::options" do
-    it "should return the last set of options" do
-      s = Slop.new { option(:f, :foo, "foo") }
-      Slop.options.should == s.options
-      p = Slop.new { option(:b, :bar, "bar") }
-      Slop.options.should == p.options
-    end
-  end
-
-  describe "option" do
-    it "adds an option" do
-      @slop.options.find do |opt|
-        opt.flag == :v
-      end.should be_kind_of(Slop::Option)
-    end
-
-    it "takes no more than 4 arguments" do
-      lambda do
-        Slop.new { option :a, :b, :c, :d, :e }
-      end.should raise_error(ArgumentError, "Argument size must be no more than 4")
-    end
-
-    it "accepts a block which assigns an option callback" do
-      s = Slop.parse("-v") do
-        opt(:v, :version, "Display version") { "Version 1" }
-      end
-      s.option_for(:version).callback.should be_kind_of(Proc)
-      s.option_for(:version).callback.call.should == "Version 1"
-    end
-
-    it "does not parse option values unless option.argument is true" do
-      Slop.parse("--name Lee") { opt :name }.value_for(:name).should be_nil
-      Slop.parse("--name Lee") { opt :name, true }.value_for(:name).should == "Lee"
-      Slop.parse("--name Lee") { opt :name, :argument => true }.value_for(:name).should == "Lee"
-    end
-  end
-
-  describe "options_hash" do
-    it "returns a hash" do
-      @slop.options_hash.should be_kind_of(Hash)
-    end
-  end
-
-  describe "option_for" do
-    it "returns an option" do
-      @slop.option_for(:v).should be_kind_of(Slop::Option)
-    end
-
-    it "returns nil otherwise" do
-      @slop.option_for(:nothing).should be_nil
-    end
-  end
-
-  describe "value_for/[]" do
-    it "returns the value of an option" do
-      s = Slop.parse("--name Lee") do
-        opt :n, :name, "Your name", true
-      end
-      s.value_for(:name).should == "Lee"
-    end
-
-    it "returns a default option if none is given" do
-      Slop.new { opt :name, true, :default => "Lee" }.value_for(:name).should == "Lee"
-      Slop.new { opt :name, true, :default => "Lee" }[:name].should == "Lee"
-    end
-
-    it "returns nil if an option does not exist" do
-      Slop.new.value_for(:name).should be_nil
-    end
-  end
-
-  describe "parse" do
-    it "returns self (Slop)" do
-      Slop.parse.should be_kind_of(Slop)
-    end
-
-    it "parses a string" do
-      Slop.parse("--name Lee") { opt :name, true }.value_for(:name).should == "Lee"
-    end
-
-    it "parses an array" do
-      Slop.parse(%w"--name Lee") { opt :name, true }.value_for(:name).should == "Lee"
-    end
-
-    it "raises MissingArgumentError if no argument is given to a compulsory option" do
-      lambda { Slop.parse("--name") { opt :name, true } }.should raise_error(Slop::MissingArgumentError, /name/)
-    end
-
-    it "does not raise MissingArgumentError if the optional attribute is true" do
-      Slop.parse("--name") { opt :name, true, :optional => true }.value_for(:name).should be_nil
-    end
-
-    it "does not require argument to be true if optional is true" do
-      Slop.parse("--name Lee") { opt :name, :optional => true }.value_for(:name).should == "Lee"
-    end
-
-    it "responds to both long options and single character flags" do
-      Slop.parse("--name Lee") { opt :name, true }[:name].should == "Lee"
-      Slop.parse("-n Lee") { opt :n, :name, true }[:name].should == "Lee"
-    end
-  end
-
-  describe "options" do
-    it "returns a set" do
-      @slop.options.should be_kind_of Set
-    end
-
-    it "contains a set of Slop::Option" do
-      @slop.options.each do |opt|
-        opt.should be_kind_of(Slop::Option)
-      end
-    end
-  end
-
-  describe "pad_options (private method)" do
-    before(:all) do
-      @args = [
-        [:n], [:n, :name], [:n, :name, "Desc"], [:n, :name, "Desc", true],
-        [:name], [:n, "Desc"], [:n, true], [:name, "Desc"], [:name, true]
-      ]
-    end
-
-    it "detects a description in place of an option, if one exists" do
-      valid = [ "Description here", "Description!", "de#scription" ]
-      invalid = [ "Description", "some-description" ] # these pass as valid options
-
-      valid.each do |v|
-        @slop.send(:pad_options, [:n, v]).should == [:n, nil, v, false]
-      end
-
-      invalid.each do |i|
-        @slop.send(:pad_options, [:n, i]).should == [:n, i, nil, false]
-      end
-    end
-
-    it "always returns an array of 4 elements" do
-      @args.each do |arr|
-        args = @slop.send(:pad_options, arr)
-        args.should be_kind_of(Array)
-        args.size.should == 4
-      end
-    end
-
-    it "ends with a true or false class object" do
-      @args.each do |arr|
-        [true, false].include?(@slop.send(:pad_options, arr).last).should be_true
-      end
-    end
-  end
-
-  describe "flag_or_option?" do
-    it "should be true if the string is a flag or an option" do
-      good = ["-f", "--flag"]
-      bad  = ["-flag", "f", "flag", "f-lag", "flag-", "--", "-"]
-      good.each {|g| @slop.send(:flag_or_option?, g).should be_true }
-      bad.each  {|b| @slop.send(:flag_or_option?, b).should be_false }
-    end
-  end
-
-  describe "help string" do
-    before :all do
-      @o = Slop.new do
-        banner("Usage: foo [options]")
-        opt(:n, :name, "Your name")
-        opt(:a, :age, "Your age")
-      end
-    end
-
-    it "starts with a banner if one exists" do
-      @o.to_s.split("\n").first.should == "Usage: foo [options]"
-    end
-
-    it "should include all options" do
-      @o.each do |option|
-        flag, opt, des = option.flag, option.option, option.description
-        [flag, opt, des].each {|a| @o.to_s.include?(a.to_s).should be_true }
-      end
-    end
-  end
-end