tty-which 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5024ca88ff5be5656247e0686827463e5f0cea3
-  data.tar.gz: ee9eaeddd82f8eede886aabb018842b87b5335fe
+  metadata.gz: b8ba3f124a38b56e73d335461e3871125afb27c9
+  data.tar.gz: 99374a1a7f27cf4250bf0c2f174a7502fc961dd0
 SHA512:
-  metadata.gz: 96fcfce47fd6a6ec990e74c21266890efc9ef0355dadd2b054a5ed23207902a095c2ae470869a26a726a124262b1065e7c4019baeb741082a7f70aac240217e5
-  data.tar.gz: bf4197d3b5588999005df72b4e9232ff523d75a04fc764fc70eb5d46121f8364dc678d5eeeaf254d7fb94914e77290c6c6f63f0a03e0d4bb907dfc1ad39559b4
+  metadata.gz: a1cba33feb5370384091a94eae956413e9fbab13459bda4c1cf7f91a3bec7e3248ae783f0947d46e48b3fa1b8fa04f9b0c260f442bf941407a081b45dcaebe2f
+  data.tar.gz: 1c757f67ba1e85ecbda97e8473fbe4145c8284988cae873b66723565942984a18dd16ba86d7ad28ff24f1802f1cf91bd91ad6f737cffdb98dbeb8f2d939aa64b

data/.travis.yml

@@ -1,11 +1,14 @@
+---
 language: ruby
-bundler_args: --without yard guard benchmarks
+sudo: false
+cache: bundler
 script: "bundle exec rake ci"
 rvm:
   - 1.9
   - 2.0
   - 2.1
   - 2.2
+  - 2.3.0
   - ruby-head
   - rbx-2
   - jruby-19mode
@@ -18,3 +21,5 @@ matrix:
   fast_finish: true
 branches:
   only: master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change log
+
+## [v0.2.0] - 2016-07-01
+
+### Added
+* Add Which#exist? to check if file exists based on found path
+
+### Changed
+* Change Which#search_paths to allow for paths argument
+* Rename Which#executable_file_with_ext? to #file_with_exec_ext?
+* Rename Which#path_with_executable_file? to #file_with_path?
+
+### Fixed
+* Fix bug with Which#file_with_exec_ext? when comparing extensions
+
+## [v0.1.0] - 2015-05-30
+
+* Initial implementation and release
+
+[v0.2.0]: https://github.com/piotrmurach/tty-which/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-which/compare/v0.1.0

data/Gemfile

@@ -3,13 +3,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rake',    '~> 10.4.2'
-  gem 'rspec',   '~> 3.2.0'
+  gem 'rspec',   '~> 3.5.0'
   gem 'yard',    '~> 0.8.7'
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.8.1'
-  gem 'simplecov', '~> 0.10.0'
+  gem 'coveralls', '~> 0.8.13'
+  gem 'simplecov', '~> 0.11.2'
   gem 'yardstick', '~> 0.9.9'
 end

data/README.md

@@ -1,17 +1,20 @@
-# TTY::Which
+# TTY::Which [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 [![Gem Version](https://badge.fury.io/rb/tty-which.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/peter-murach/tty-which.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/peter-murach/tty-which/badges/gpa.svg)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/peter-murach/tty-which/badge.svg?branch=master)][coveralls]
-[![Inline docs](http://inch-ci.org/github/peter-murach/tty-which.svg?branch=master)][inchpages]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-which.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-which/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-which/badge.svg?branch=master)][coveralls]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-which.svg?branch=master)][inchpages]
 
+[gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-which
-[travis]: http://travis-ci.org/peter-murach/tty-which
-[codeclimate]: https://codeclimate.com/github/peter-murach/tty-which
-[coveralls]: https://coveralls.io/r/peter-murach/tty-which
-[inchpages]: http://inch-ci.org/github/peter-murach/tty-which
+[travis]: http://travis-ci.org/piotrmurach/tty-which
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-which
+[coveralls]: https://coveralls.io/github/piotrmurach/tty-which
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-which
 
-> Platform independent implementation of Unix `which` utility that searches for executable file in the path.
+> Platform independent implementation of Unix `which` utility that searches for executable file in the path variable.
+
+**TTY::Which** provides cross-platform executables search component for [TTY](https://github.com/piotrmurach/tty) toolkit.
 
 ## Installation
 
@@ -29,24 +32,32 @@ Or install it yourself as:
 
 ## Usage
 
-**TTY::Which** exposes `which` method that searches the path for executable file that would be run had the command been invoked.
+**TTY::Which** has `which` method that searches the path for executable file.
+
+When the path to executable exists, an absolute path is returned, otherwise `nil`.
 
-For example, to find location for a single command do:
+For example, to find location for a single executable do:
 
 ```ruby
 TTY::Which.which('less')  # => '/usr/bin/less'
 TTY::Which.which('git')   # => 'C:\Program Files\Git\bin\git'
 ```
 
-You can also check an absolute path:
+You can also check an absolute path to executable:
 
 ```ruby
 TTY::Which.which('/usr/bin/ruby')  # => '/usr/bin/ruby'
 ```
 
+The `exist?` returns `true` if the executable exists in the path and `false` otherwise:
+
+```ruby
+TTY::Which.exist?('ruby') # => ruby
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/peter-murach/tty-which/fork )
+1. Fork it ( https://github.com/piotrmurach/tty-which/fork )
 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`)
@@ -54,4 +65,4 @@ TTY::Which.which('/usr/bin/ruby')  # => '/usr/bin/ruby'
 
 ## Copyright
 
-Copyright (c) 2015 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015-2016 Piotr Murach. See LICENSE for further details.

data/lib/tty/which.rb

@@ -5,7 +5,6 @@ require 'tty/which/version'
 module TTY
   # A class responsible for finding an executable in the PATH
   module Which
-    extend self
     # Find an executable in a platform independent way
     #
     # @param [String] command
@@ -21,7 +20,7 @@ module TTY
     #
     # @api public
     def which(cmd, search_path = nil)
-      if path_with_executable_file?(cmd)
+      if file_with_path?(cmd)
         return cmd if executable_file?(cmd)
         extensions.each do |ext|
           exe = File.join(cmd, ext)
@@ -32,7 +31,7 @@ module TTY
 
       search_path ||= search_paths
       search_path.each do |path|
-        if executable_file_with_ext?(cmd)
+        if file_with_exec_ext?(cmd)
           exe = File.join(path, cmd)
           return File.absolute_path(exe) if executable_file?(exe)
         end
@@ -43,23 +42,46 @@ module TTY
       end
       nil
     end
+    module_function :which
 
-    private
+    # Check if executable exists in the path
+    #
+    # @param [String] command
+    #   the executable to check
+    #
+    # @param [String] search_path
+    #   paths to check
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def exist?(cmd, search_path = nil)
+      !which(cmd, search_path).nil?
+    end
+    module_function :exist?
 
     # Find default system paths
     #
+    # @param [String] path
+    #   the path to search through
+    #
+    # @example
+    #   search_paths("/usr/local/bin:/bin")
+    #   # => ['/bin']
+    #
     # @return [Array[String]]
     #   the array of paths to search
     #
     # @api private
-    def search_paths
-      paths = if ENV['PATH']
-                ENV['PATH'].split(File::PATH_SEPARATOR)
+    def search_paths(path = ENV['PATH'])
+      paths = if path && !path.empty?
+                path.split(File::PATH_SEPARATOR)
               else
                 %w(/usr/local/bin /usr/ucb /usr/bin /bin)
               end
       paths.select { |path| Dir.exist?(path) }
     end
+    module_function :search_paths
 
     # All files that contain a '.' in name
     #
@@ -78,6 +100,7 @@ module TTY
       return [''] unless path_ext
       path_ext.split(';').select { |part| part.include?('.') }
     end
+    module_function :extensions
 
     # Determines if filename is an executable file
     #
@@ -101,23 +124,26 @@ module TTY
       path ||= filename
       File.file?(path) && File.executable?(path)
     end
+    module_function :executable_file?
 
-    # Check if command itself has extension
+    # Check if command itself has executable extension
     #
     # @param [String] filename
-    #   the path to file
+    #   the path to executable file
     #
     # @example
-    #   executable_file_with_ext?("file.bat") # => true
+    #   file_with_exec_ext?("file.bat")
+    #   # => true
     #
     # @return [Boolean]
     #
     # @api private
-    def executable_file_with_ext?(filename)
+    def file_with_exec_ext?(filename)
       extension = File.extname(filename)
       return false if extension.empty?
-      extensions.any? { |ext| extension.casecmp(ext) }
+      extensions.any? { |ext| extension.casecmp(ext).zero? }
     end
+    module_function :file_with_exec_ext?
 
     # Check if executable file is part of absolute/relative path
     #
@@ -127,8 +153,9 @@ module TTY
     # @return [Boolean]
     #
     # @api private
-    def path_with_executable_file?(cmd)
+    def file_with_path?(cmd)
       File.expand_path(cmd) == cmd
     end
+    module_function :file_with_path?
   end # Which
 end # TTY

data/lib/tty/which/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Which
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end # Which
 end # TTY

data/spec/unit/executable_file_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Which, '#executable_file?' do
+  it "checks if file is executable" do
+    allow(File).to receive(:join).with('/usr/local/bin', 'ruby').
+      and_return('/usr/local/bin/ruby')
+
+    allow(File).to receive(:file?).and_return(true)
+    allow(File).to receive(:executable?).with('/usr/local/bin/ruby').and_return(true)
+
+    expect(TTY::Which.executable_file?('ruby', '/usr/local/bin')).to eq(true)
+  end
+end

data/spec/unit/exist_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Which, '#exist?' do
+  it "finds executable in the path" do
+    allow(TTY::Which).to receive(:which).with('ruby', nil).
+      and_return('/usr/loca/bin/ruby')
+
+    expect(TTY::Which.exist?('ruby')).to be(true)
+  end
+
+  it "fails to find executable in the path" do
+    allow(TTY::Which).to receive(:which).with('ruby', nil).and_return(nil)
+
+    expect(TTY::Which.exist?('ruby')).to be(false)
+  end
+end

data/spec/unit/file_with_exec_ext_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Which, "#file_with_exec_ext?" do
+  it "detects executable extension" do
+    filename = 'file.exe'
+    allow(TTY::Which).to receive(:extensions).and_return(['.EXE', '.BAT', '.CMD'])
+
+    expect(TTY::Which.file_with_exec_ext?(filename)).to eq(true)
+  end
+
+  it "fails to detect executable extension" do
+    filename = 'file.unknown'
+    allow(TTY::Which).to receive(:extensions).and_return(['.EXE', '.BAT'])
+
+    expect(TTY::Which.file_with_exec_ext?(filename)).to eq(false)
+  end
+end
+

data/spec/unit/search_paths_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Which, '#search_paths' do
+  it "defauls search paths" do
+    allow(ENV).to receive(:[]).with('PATH').and_return([])
+    allow(Dir).to receive(:exist?).and_return(true)
+
+    expect(TTY::Which.search_paths).to eq([
+      '/usr/local/bin', '/usr/ucb', '/usr/bin', '/bin'])
+  end
+
+  it "finds paths in path environment" do
+    path = "/bin:/usr/bin:/usr/local/bin:/opt/local/bin"
+    allow(ENV).to receive(:[]).with('PATH').and_return(path)
+    allow(Dir).to receive(:exist?).and_return(true)
+
+    expect(TTY::Which.search_paths).to eq([
+      '/bin', '/usr/bin', '/usr/local/bin', '/opt/local/bin'])
+  end
+
+  it "accepts paths to search as an argument" do
+    path = "/bin:/usr/bin:/usr/local/bin:/opt/local/bin"
+    allow(Dir).to receive(:exist?).and_return(true)
+
+    expect(TTY::Which.search_paths(path)).to eq([
+      '/bin', '/usr/bin', '/usr/local/bin', '/opt/local/bin'])
+  end
+end

data/spec/unit/which_spec.rb

@@ -8,23 +8,23 @@ RSpec.describe TTY::Which, '#which' do
     let(:path) { "/bin:/usr/bin:/usr/local/bin:/opt/local/bin" }
     let(:cmds) { %w(/usr/bin/ls /bin/sh /usr/bin/ruby /usr/local/git/bin/git) }
 
-    before {
+    before do
       allow(ENV).to receive(:[]).with('PATHEXT').and_return(nil)
       allow(ENV).to receive(:[]).with('PATH').and_return(path)
       stub_const("File::PATH_SEPARATOR", ':')
       stub_const("File::SEPARATOR", '/')
       allow(Dir).to receive(:exist?) { true }
-    }
+    end
 
     it "handles path with executable file /bin/sh" do
-      allow(Which).to receive(:path_with_executable_file?) { true }
+      allow(Which).to receive(:file_with_path?) { true }
       allow(Which).to receive(:executable_file?) { true }
 
       expect(Which.which('/bin/sh')).to eq('/bin/sh')
     end
 
     it "fails to find path executable" do
-      allow(Which).to receive(:path_with_executable_file?) { true }
+      allow(Which).to receive(:file_with_path?) { true }
       allow(Which).to receive(:executable_file?) { false }
 
       expect(Which.which('/bin/sh')).to eq(nil)
@@ -34,8 +34,8 @@ RSpec.describe TTY::Which, '#which' do
       dir_path = "/usr/local/bin"
       cmd = "git"
       expected_path = "#{dir_path}/#{cmd}"
-      allow(Which).to receive(:path_with_executable_file?) { false }
-      allow(Which).to receive(:executable_file_with_ext?) { false }
+      allow(Which).to receive(:file_with_path?) { false }
+      allow(Which).to receive(:file_with_exec_ext?) { false }
 
       allow(File).to receive(:join)
       allow(File).to receive(:join).with(dir_path, cmd).and_return(expected_path)
@@ -52,16 +52,16 @@ RSpec.describe TTY::Which, '#which' do
     let(:path) { "C:\\Program Files\\Git\\bin;" }
     let(:exts) { ".com;.exe;.bat;.cmd" }
 
-    before {
+    before do
       allow(ENV).to receive(:[]).with('PATHEXT').and_return(exts)
       allow(ENV).to receive(:[]).with('PATH').and_return(path)
       stub_const("File::PATH_SEPARATOR", ';')
       stub_const("File::SEPARATOR", '\\')
       allow(Dir).to receive(:exist?) { true }
-    }
+    end
 
     it "handles path with executable file C:\\Program Files\\Git\\bin\\git" do
-      allow(Which).to receive(:path_with_executable_file?) { true }
+      allow(Which).to receive(:file_with_path?) { true }
       allow(Which).to receive(:executable_file?).with(any_args) { false }
 
       path_with_exe_file = 'C:\Program Files\Git\bin\git'
@@ -81,8 +81,8 @@ RSpec.describe TTY::Which, '#which' do
       dir_path = "C:\\Program Files\\Git\\bin"
       cmd = 'git.exe'
       expected_path = "#{dir_path}\\#{cmd}"
-      allow(Which).to receive(:path_with_executable_file?) { false }
-      allow(Which).to receive(:executable_file_with_ext?).with(cmd) { true }
+      allow(Which).to receive(:file_with_path?) { false }
+      allow(Which).to receive(:file_with_exec_ext?).with(cmd) { true }
 
       allow(File).to receive(:join).with(dir_path, any_args)
       allow(File).to receive(:join).with(dir_path, cmd).and_return(expected_path)
@@ -99,8 +99,8 @@ RSpec.describe TTY::Which, '#which' do
       dir_path = "C:\\Program Files\\Git\\bin"
       cmd = 'git'
       expected_path = "#{dir_path}\\#{cmd}.exe"
-      allow(Which).to receive(:path_with_executable_file?) { false }
-      allow(Which).to receive(:executable_file_with_ext?).with(cmd) { false }
+      allow(Which).to receive(:file_with_path?) { false }
+      allow(Which).to receive(:file_with_exec_ext?).with(cmd) { false }
 
       allow(File).to receive(:join).with(dir_path, any_args)
       allow(File).to receive(:join).with(dir_path, "#{cmd}.exe").

data/tty-which.gemspec

@@ -10,13 +10,14 @@ Gem::Specification.new do |spec|
   spec.email         = [""]
   spec.summary       = %q{Platform independent implementation of Unix which command.}
   spec.description   = %q{Platform independent implementation of Unix which command.}
-  spec.homepage      = ""
+  spec.homepage      = "http://piotrmurach.github.io/tty/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rake'
 end

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: tty-which
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-30 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 description: Platform independent implementation of Unix which command.
 email:
 - ''
@@ -31,10 +51,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -43,12 +63,16 @@ files:
 - lib/tty/which.rb
 - lib/tty/which/version.rb
 - spec/spec_helper.rb
+- spec/unit/executable_file_spec.rb
+- spec/unit/exist_spec.rb
+- spec/unit/file_with_exec_ext_spec.rb
+- spec/unit/search_paths_spec.rb
 - spec/unit/which_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
 - tty-which.gemspec
-homepage: ''
+homepage: http://piotrmurach.github.io/tty/
 licenses:
 - MIT
 metadata: {}
@@ -58,21 +82,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Platform independent implementation of Unix which command.
 test_files:
 - spec/spec_helper.rb
+- spec/unit/executable_file_spec.rb
+- spec/unit/exist_spec.rb
+- spec/unit/file_with_exec_ext_spec.rb
+- spec/unit/search_paths_spec.rb
 - spec/unit/which_spec.rb
 has_rdoc: 

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0