which_works 0.2.0 → 1.0.0

data/README.md

@@ -15,8 +15,8 @@ Which.which('unknown')       #=> nil
 Which.which('/usr/bin/svn')  #=> "/usr/bin/svn"
 Which.which('/usr/bin/foo')  #=> nil
 
-# the :all option finds all executable files,
-# not just the first one found
+# the :all option returns all executable files,
+# not just the first one found in the path
 Which.which('svn', :all => true)   #=> [ "/opt/local/bin/svn", "/usr/bin/svn" ]
 
 # the :array option always returns an array
@@ -27,6 +27,18 @@ Which.which('ls', 'screen', :array => true)  #=> [ "/bin/ls", "/usr/bin/screen"
 # combined options
 Which.which('ls', 'svn', :all => true, :array => true)
 #=> [ "/bin/ls", "/opt/local/bin/svn", "/usr/bin/svn" ]
+
+# you can change the default options
+Which.options = { :all => true }
+Which.options[:array] = true
+Which.which('ls')       #=> [ "/bin/ls" ]
+Which.which('svn')      #=> [ "/opt/local/bin/svn", "/usr/bin/svn" ]
+
+# default options can be overridden as usual
+Which.which('ls', :array => false)  #=> "/bin/ls"
+
+# see the current default options
+Which.options     #=> { :all => true, :array => true }
 ```
 
 Tested with <a href="https://www.relishapp.com/rspec">RSpec</a>, <a href="https://github.com/thoughtbot/shoulda">shoulda</a> and <a href="http://travis-ci.org/#!/AlphaHydrae/which_works">Travis CI</a>.

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/AlphaHydrae/which_works"
   gem.license = "MIT"
   gem.summary = %Q{Ruby UNIX-like which.}
-  gem.description = %Q{Ruby UNIX-like which.}
+  gem.description = %Q{Locates a program file in the user's path. The which method takes a list of command names and searches the path for each executable file that would be run had these commands actually been invoked.}
   gem.email = "hydrae.alpha@gmail.com"
   gem.authors = ["AlphaHydrae"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/which_works.rb

@@ -30,6 +30,7 @@ module Which
     
     found = []
     options = programs.last.kind_of?(Hash) ? programs.pop : {}
+    options = @@options.merge options
 
     programs.each do |program|
 
@@ -44,6 +45,7 @@ module Which
 
           # using expand_path makes it work with absolute program paths
           absolute_path = File.expand_path "#{program}#{ext}", path
+          next if found.include? absolute_path
 
           if File.executable? absolute_path
             program_found = true
@@ -62,4 +64,32 @@ module Which
       found
     end
   end
+
+  # Returns the default options for {#which}. The returned
+  # hash can be modified directly.
+  #
+  # == Examples
+  #   Which.options                 #=> {}
+  #   Which.options = { :all => true }
+  #   Which.options                 #=> { :all => true }
+  #   Which.options[:array] = true  #=> { :all => true, :array => true }
+  def self.options
+    @@options
+  end
+
+  # Sets the default options for {#which}.
+  #
+  # == Examples
+  #   Which.options = { :all => true, :array => true }
+  #   Which.which('ls')       #=> [ "/bin/ls" ]
+  #   Which.which('svn')      #=> [ "/opt/local/bin/svn", "/usr/bin/svn" ]
+  def self.options= options
+    raise ArgumentError, "Default options must be a hash, #{options.class.name} given." unless options.kind_of?(Hash)
+    @@options = options.dup
+  end
+
+  private
+
+  # Default options for {#which}.
+  @@options = Hash.new
 end

data/spec/all_spec.rb

@@ -17,4 +17,8 @@ describe ':all option' do
   it "should not find anything when given no command to find" do
     Which.which({ :all => true }).should be_nil
   end
+
+  it "should only find one executable file when given an absolute path" do
+    Which.which('/opt/local/bin/svn', :all => true).should == '/opt/local/bin/svn'
+  end
 end

data/spec/options_spec.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+describe 'Default Options' do
+
+  before :each do
+    WhichSpecHelper.stub_unix!
+    Which.options.clear
+  end
+
+  it "should have no options by default" do
+    Which.options.should == {}
+  end
+
+  it "should allow to set the :all option to true by default" do
+    Which.options = { :all => true }
+    Which.which('svn').should == [ '/opt/local/bin/svn', '/usr/bin/svn' ]
+  end
+
+  it "should allow to set the :array option to true by default" do
+    Which.options = { :array => true }
+    Which.which('ls').should == [ '/bin/ls' ]
+  end
+
+  it "should allow to set all options to true by default" do
+    Which.options = { :all => true, :array => true }
+    Which.which('ls').should == [ '/bin/ls' ]
+    Which.which('svn').should == [ '/opt/local/bin/svn', '/usr/bin/svn' ]
+  end
+
+  it "should allow to clear default options" do
+    Which.options = { :all => true, :array => true }
+    Which.options = {}
+    Which.options.should == {}
+    Which.which('ls').should == '/bin/ls'
+  end
+
+  it "should return the default options" do
+    Which.options = { :all => true, :array => false }
+    Which.options.should == { :all => true, :array => false }
+  end
+
+  it "should copy the given options" do
+    options = { :all => true, :array => true }
+    Which.options = options
+    Which.options.should == options
+    Which.options.should_not equal(options)
+  end
+
+  it "should return its internal default options hash" do
+    Which.options[:array] = true
+    Which.options[:all] = 42
+    Which.options[:array].should be_true
+    Which.options[:all].should == 42
+  end
+
+  it "should allow to override the :all option" do
+    Which.options = { :all => true, :array => true }
+    Which.which('svn', :all => false).should == [ '/opt/local/bin/svn' ]
+  end
+
+  it "should allow to override the :array option" do
+    Which.options = { :all => true, :array => true }
+    Which.which('ls', :array => false).should == '/bin/ls'
+  end
+
+  it "should allow to override all options" do
+    Which.options = { :all => true, :array => true }
+    Which.which('ls', :all => false, :array => false).should == '/bin/ls'
+    Which.which('svn', :all => false, :array => false).should == '/opt/local/bin/svn'
+  end
+
+  it "should only accept a hash as default options" do
+    [ nil, false, true, String.new, Array.new, 2, 4.5 ].each do |invalid|
+      lambda{ Which.options = invalid }.should raise_error(ArgumentError)
+    end
+  end
+end

data/which_works.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "which_works"
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["AlphaHydrae"]
-  s.date = "2012-03-10"
-  s.description = "Ruby UNIX-like which."
+  s.date = "2012-03-11"
+  s.description = "Locates a program file in the user's path. The which method takes a list of command names and searches the path for each executable file that would be run had these commands actually been invoked."
   s.email = "hydrae.alpha@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "spec/array_spec.rb",
     "spec/basic_spec.rb",
     "spec/helper.rb",
+    "spec/options_spec.rb",
     "which_works.gemspec"
   ]
   s.homepage = "http://github.com/AlphaHydrae/which_works"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: which_works
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-10 00:00:00.000000000Z
+date: 2012-03-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70349900379000 !ruby/object:Gem::Requirement
+  requirement: &70324806494120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70349900379000
+  version_requirements: *70324806494120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70349900378040 !ruby/object:Gem::Requirement
+  requirement: &70324806493580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70349900378040
+  version_requirements: *70324806493580
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70349900375720 !ruby/object:Gem::Requirement
+  requirement: &70324806493040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.11.3
   type: :development
   prerelease: false
-  version_requirements: *70349900375720
+  version_requirements: *70324806493040
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70349900374340 !ruby/object:Gem::Requirement
+  requirement: &70324806492460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349900374340
+  version_requirements: *70324806492460
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70349900372640 !ruby/object:Gem::Requirement
+  requirement: &70324806491920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70349900372640
+  version_requirements: *70324806491920
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70349900370600 !ruby/object:Gem::Requirement
+  requirement: &70324806491400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *70349900370600
+  version_requirements: *70324806491400
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70349900367500 !ruby/object:Gem::Requirement
+  requirement: &70324806490800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *70349900367500
+  version_requirements: *70324806490800
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70349900364380 !ruby/object:Gem::Requirement
+  requirement: &70324806490220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.6.8
   type: :development
   prerelease: false
-  version_requirements: *70349900364380
+  version_requirements: *70324806490220
 - !ruby/object:Gem::Dependency
   name: travis-lint
-  requirement: &70349900362880 !ruby/object:Gem::Requirement
+  requirement: &70324806489620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,8 +109,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70349900362880
-description: Ruby UNIX-like which.
+  version_requirements: *70324806489620
+description: Locates a program file in the user's path. The which method takes a list
+  of command names and searches the path for each executable file that would be run
+  had these commands actually been invoked.
 email: hydrae.alpha@gmail.com
 executables: []
 extensions: []
@@ -133,6 +135,7 @@ files:
 - spec/array_spec.rb
 - spec/basic_spec.rb
 - spec/helper.rb
+- spec/options_spec.rb
 - which_works.gemspec
 homepage: http://github.com/AlphaHydrae/which_works
 licenses:
@@ -149,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4071309635441737713
+      hash: 1669874747922136134
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: