tty-which 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03043a40c5cf44b4afbd6c213c373fd75299e8cc
-  data.tar.gz: 80a1f7dc2748814fb8d3b9d0f92fad214a2098a9
+SHA256:
+  metadata.gz: 71d6ccf2525833dd1fdedffa1690452661db9ab64dc7a7b090c925ec4307b84f
+  data.tar.gz: 7253c7d63d82fdb131156df0df2dd7317df52a5197484f2e50b2bf4c66aa746d
 SHA512:
-  metadata.gz: 5ef5e7498c79265dd91d347b33ab45afc7e4ce43e298d6339733cd554dec32bdcf256644340f9458e9283bcddc3332c1eebe736b16569bc3b681a2e3f32a0753
-  data.tar.gz: a116bc4bed3540b165351932a4d5644e53c66313ee87190e08b8e47f4a438b1f227c0b1de70aecaeb3eb115f3f2b7e06b37f137cffc3a52299d616b977ba8daa
+  metadata.gz: 4ac727c081a34d3daa6129a1c1c64d7b1fda940896929a05622c2f351aa3a83f2fb4965984bba43896e3a6ccc47e70bc2ad9c638b5da02b318b65972857b2c25
+  data.tar.gz: e4c39f2b23493180e21ab1fd80a31b9fd0a892ea775d52c91747e6941de03a6dff456ff06c73f2b2117ed50bf6e166972586a62c467210a4e77b31440ac1c49f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.4.0] - 2018-10-13
+
+### Added
+* Add ability to specify search paths for #which and #exist? calls
+
+### Changed
+* Change to freeze all strings
+* Change gemspec to require Ruby >= 2.0.0
+* Change gemspec to load files without calling git
+* Change gemspec to add rspec as dev dependency
+
 ## [v0.3.0] - 2017-03-20
 
 ### Changed
@@ -34,6 +45,8 @@
 
 * Initial implementation and release
 
+[v0.4.0]: https://github.com/piotrmurach/tty-which/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/tty-which/compare/v0.2.2...v0.3.0
 [v0.2.2]: https://github.com/piotrmurach/tty-which/compare/v0.2.1...v0.2.2
 [v0.2.1]: https://github.com/piotrmurach/tty-which/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/piotrmurach/tty-which/compare/v0.1.0...v0.2.0

data/README.md

@@ -1,4 +1,9 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
 # 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/piotrmurach/tty-which.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/2rpm67huf1nh98d0?svg=true)][appveyor]
@@ -34,11 +39,11 @@ Or install it yourself as:
 
 ## Usage
 
-**TTY::Which** has `which` method that searches the path for executable file.
+**TTY::Which** has `which` method that searches set of directories for an executable file based on the `PATH` environment variable.
 
-When the path to executable exists, an absolute path is returned, otherwise `nil`.
+When the path to an executable program exists, an absolute path is returned, otherwise `nil`.
 
-For example, to find location for a single executable do:
+For example, to find location for an executable program do:
 
 ```ruby
 TTY::Which.which('less')  # => '/usr/bin/less'
@@ -51,7 +56,14 @@ You can also check an absolute path to executable:
 TTY::Which.which('/usr/bin/ruby')  # => '/usr/bin/ruby'
 ```
 
-The `exist?` returns `true` if the executable exists in the path and `false` otherwise:
+You can also specify directly the paths to search using `:paths` keyword:
+
+```ruby
+TTY::Which.which('ruby', paths: ['/usr/local/bin', '/usr/bin', '/bin'])
+# => '/usr/local/bin/ruby'
+```
+
+When you're only interesting in knowning that an executable exists on the system use the `exist?` call:
 
 ```ruby
 TTY::Which.exist?('ruby') # => true
@@ -67,4 +79,4 @@ TTY::Which.exist?('ruby') # => true
 
 ## Copyright
 
-Copyright (c) 2015-2017 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015-2018 Piotr Murach. See LICENSE for further details.

data/lib/tty-which.rb

@@ -1,3 +1 @@
-# coding: utf-8
-
 require_relative 'tty/which'

data/lib/tty/which.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 require_relative 'which/version'
 
@@ -9,17 +9,22 @@ module TTY
     #
     # @param [String] command
     #   the command to search for
+    # @param [Array[String]] paths
+    #   the paths to look through
     #
     # @example
     #   which('ruby')                 # => '/usr/local/bin/ruby'
     #   which('/usr/local/bin/ruby')  # => '/usr/local/bin/ruby'
     #   which('foo')                  # => nil
     #
+    # @example
+    #   which('ruby', paths: ['/usr/locale/bin', '/usr/bin', '/bin'])
+    #
     # @return [String, nil]
     #   the absolute path to executable if found, `nil` otherwise
     #
     # @api public
-    def which(cmd, search_path = nil)
+    def which(cmd, paths: search_paths)
       if file_with_path?(cmd)
         return cmd if executable_file?(cmd)
         extensions.each do |ext|
@@ -29,7 +34,7 @@ module TTY
         return nil
       end
 
-      search_paths.each do |path|
+      paths.each do |path|
         if file_with_exec_ext?(cmd)
           exe = ::File.join(path, cmd)
           return ::File.absolute_path(exe) if executable_file?(exe)
@@ -48,14 +53,14 @@ module TTY
     # @param [String] command
     #   the executable to check
     #
-    # @param [String] search_path
+    # @param [String] paths
     #   paths to check
     #
     # @return [Boolean]
     #
     # @api public
-    def exist?(cmd, search_path = nil)
-      !which(cmd, search_path).nil?
+    def exist?(cmd, paths: search_paths)
+      !which(cmd, paths: paths).nil?
     end
     module_function :exist?
 

data/lib/tty/which/version.rb

@@ -1,7 +1,7 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module TTY
   module Which
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end # Which
 end # TTY

data/spec/unit/exist_spec.rb

@@ -1,15 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal
 
 RSpec.describe TTY::Which, '#exist?' do
   it "finds executable in the path" do
-    allow(TTY::Which).to receive(:which).with('ruby', nil).
+    allow(TTY::Which).to receive(:which).with('ruby', a_hash_including(:paths)).
       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)
+    allow(TTY::Which).to receive(:which).with('ruby', a_hash_including(:paths)).and_return(nil)
 
     expect(TTY::Which.exist?('ruby')).to be(false)
   end

data/spec/unit/which_spec.rb

@@ -46,6 +46,15 @@ RSpec.describe TTY::Which, '#which' do
 
       expect(Which.which(cmd)).to eq(expected_path)
     end
+
+    it "allows to search through custom paths" do
+      paths = %w(/usr/local/bin /usr/bin /bin)
+      allow(Which).to receive(:executable_file?).with('/usr/local/bin/ruby') { false }
+      allow(Which).to receive(:executable_file?).with('/usr/bin/ruby') { true }
+      allow(::File).to receive(:absolute_path).with('/usr/bin/ruby').and_return('/usr/bin/ruby')
+
+      expect(TTY::Which.which('ruby', paths: paths)).to eq('/usr/bin/ruby')
+    end
   end
 
   context "with extension" do

data/tty-which.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tty/which/version'
@@ -13,11 +12,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://piotrmurach.github.io/tty/"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = Dir['{lib,spec}/**/*.rb']
+  spec.files        += Dir['tasks/*', 'tty-which.gemspec']
+  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-which
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -51,15 +65,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - lib/tty-which.rb
 - lib/tty/which.rb
 - lib/tty/which/version.rb
@@ -86,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -94,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Platform independent implementation of Unix which command.
@@ -106,4 +115,3 @@ test_files:
 - spec/unit/file_with_exec_ext_spec.rb
 - spec/unit/search_paths_spec.rb
 - spec/unit/which_spec.rb
-has_rdoc: 

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---warnings

data/.travis.yml

@@ -1,26 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-script: "bundle exec rake ci"
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-  - ruby-head
-  - jruby-9000
-  - jruby-head
-  - rbx-3
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-3
-  fast_finish: true
-branches:
-  only: master
-notifications:
-  email: false

data/Gemfile

@@ -1,15 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem 'rspec',   '~> 3.5.0'
-  gem 'yard',    '~> 0.8.7'
-end
-
-group :metrics do
-  gem 'coveralls', '~> 0.8.13'
-  gem 'simplecov', '~> 0.11.2'
-  gem 'yardstick', '~> 0.9.9'
-  gem 'term-ansicolor', '=1.3.2'
-end

data/appveyor.yml

@@ -1,23 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake ci
-environment:
-  matrix:
-    - ruby_version: "193"
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
-matrix:
-  allow_failures:
-    - ruby_version: "193"