tty-which 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5024ca88ff5be5656247e0686827463e5f0cea3
+  data.tar.gz: ee9eaeddd82f8eede886aabb018842b87b5335fe
+SHA512:
+  metadata.gz: 96fcfce47fd6a6ec990e74c21266890efc9ef0355dadd2b054a5ed23207902a095c2ae470869a26a726a124262b1065e7c4019baeb741082a7f70aac240217e5
+  data.tar.gz: bf4197d3b5588999005df72b4e9232ff523d75a04fc764fc70eb5d46121f8364dc678d5eeeaf254d7fb94914e77290c6c6f63f0a03e0d4bb907dfc1ad39559b4

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

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

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - rbx-2
+  - jruby-19mode
+matrix:
+  include:
+    - rvm: jruby-head
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',    '~> 10.4.2'
+  gem 'rspec',   '~> 3.2.0'
+  gem 'yard',    '~> 0.8.7'
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.8.1'
+  gem 'simplecov', '~> 0.10.0'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Piotr Murach
+
+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.md

@@ -0,0 +1,57 @@
+# TTY::Which
+[![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]
+
+[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
+
+> Platform independent implementation of Unix `which` utility that searches for executable file in the path.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tty-which'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-which
+
+## Usage
+
+**TTY::Which** exposes `which` method that searches the path for executable file that would be run had the command been invoked.
+
+For example, to find location for a single command 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:
+
+```ruby
+TTY::Which.which('/usr/bin/ruby')  # => '/usr/bin/ruby'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/peter-murach/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`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2015 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+require 'bundler/gem_tasks'
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]

data/lib/tty-which.rb

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

data/lib/tty/which.rb

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+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
+    #   the command to search for
+    #
+    # @example
+    #   which('ruby')                 # => '/usr/local/bin/ruby'
+    #   which('/usr/local/bin/ruby')  # => '/usr/local/bin/ruby'
+    #   which('foo')                  # => nil
+    #
+    # @return [String, nil]
+    #   the absolute path to executable if found, `nil` otherwise
+    #
+    # @api public
+    def which(cmd, search_path = nil)
+      if path_with_executable_file?(cmd)
+        return cmd if executable_file?(cmd)
+        extensions.each do |ext|
+          exe = File.join(cmd, ext)
+          return File.absolute_path(exe) if executable_file?(exe)
+        end
+        return nil
+      end
+
+      search_path ||= search_paths
+      search_path.each do |path|
+        if executable_file_with_ext?(cmd)
+          exe = File.join(path, cmd)
+          return File.absolute_path(exe) if executable_file?(exe)
+        end
+        extensions.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return File.absolute_path(exe) if executable_file?(exe)
+        end
+      end
+      nil
+    end
+
+    private
+
+    # Find default system paths
+    #
+    # @return [Array[String]]
+    #   the array of paths to search
+    #
+    # @api private
+    def search_paths
+      paths = if ENV['PATH']
+                ENV['PATH'].split(File::PATH_SEPARATOR)
+              else
+                %w(/usr/local/bin /usr/ucb /usr/bin /bin)
+              end
+      paths.select { |path| Dir.exist?(path) }
+    end
+
+    # All files that contain a '.' in name
+    #
+    # @example
+    #   extensions('.exe;cmd;.bat')
+    #   # => ['.exe','.bat']
+    #
+    # @param [String] path_ext
+    #   a string of semicolon separated filename extensions
+    #
+    # @return [Array[String]]
+    #   an array with valid file extensions
+    #
+    # @api private
+    def extensions(path_ext = ENV['PATHEXT'])
+      return [''] unless path_ext
+      path_ext.split(';').select { |part| part.include?('.') }
+    end
+
+    # Determines if filename is an executable file
+    #
+    # @example Basic usage
+    #   executable_file?('/usr/bin/less') # => true
+    #
+    # @example Executable in directory
+    #   executable_file?('less', '/usr/bin') # => true
+    #   executable_file?('less', '/usr') # => false
+    #
+    # @param [String] filename
+    #   the path to file
+    # @param [String] dir
+    #   the directory within which to search for filename
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def executable_file?(filename, dir = nil)
+      path = File.join(dir, filename) if dir
+      path ||= filename
+      File.file?(path) && File.executable?(path)
+    end
+
+    # Check if command itself has extension
+    #
+    # @param [String] filename
+    #   the path to file
+    #
+    # @example
+    #   executable_file_with_ext?("file.bat") # => true
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def executable_file_with_ext?(filename)
+      extension = File.extname(filename)
+      return false if extension.empty?
+      extensions.any? { |ext| extension.casecmp(ext) }
+    end
+
+    # Check if executable file is part of absolute/relative path
+    #
+    # @param [String] cmd
+    #   the executable to check
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def path_with_executable_file?(cmd)
+      File.expand_path(cmd) == cmd
+    end
+  end # Which
+end # TTY

data/lib/tty/which/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module TTY
+  module Which
+    VERSION = "0.1.0"
+  end # Which
+end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require 'tty-which'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/which_spec.rb

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+RSpec.describe TTY::Which, '#which' do
+
+  before { stub_const("Which", described_class) }
+
+  context "without extension" 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 {
+      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 }
+    }
+
+    it "handles path with executable file /bin/sh" do
+      allow(Which).to receive(:path_with_executable_file?) { 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(:executable_file?) { false }
+
+      expect(Which.which('/bin/sh')).to eq(nil)
+    end
+
+    it "searches executable file git" 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(File).to receive(:join)
+      allow(File).to receive(:join).with(dir_path, cmd).and_return(expected_path)
+      allow(Which).to receive(:executable_file?) { false }
+      allow(Which).to receive(:executable_file?).with(expected_path) { true }
+      allow(File).to receive(:absolute_path).with(expected_path).
+        and_return(expected_path)
+
+      expect(Which.which(cmd)).to eq(expected_path)
+    end
+  end
+
+  context "with extension" do
+    let(:path) { "C:\\Program Files\\Git\\bin;" }
+    let(:exts) { ".com;.exe;.bat;.cmd" }
+
+    before {
+      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 }
+    }
+
+    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(:executable_file?).with(any_args) { false }
+
+      path_with_exe_file = 'C:\Program Files\Git\bin\git'
+      expected_path = "#{path_with_exe_file}.exe"
+
+      allow(File).to receive(:join).with(path_with_exe_file, any_args).
+        and_return(path_with_exe_file)
+      allow(File).to receive(:join).with(path_with_exe_file, '.exe').
+        and_return(expected_path)
+      allow(Which).to receive(:executable_file?).with(expected_path) { true }
+      allow(File).to receive(:absolute_path).and_return(expected_path)
+
+      expect(Which.which(path_with_exe_file)).to eq(expected_path)
+    end
+
+    it "searches path for executable git.exe" 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(File).to receive(:join).with(dir_path, any_args)
+      allow(File).to receive(:join).with(dir_path, cmd).and_return(expected_path)
+      allow(Which).to receive(:executable_file?).with(any_args) { false }
+      allow(Which).to receive(:executable_file?).with(expected_path) { true }
+      allow(File).to receive(:absolute_path).with(expected_path).
+        and_return(expected_path)
+
+      expect(Which.which(cmd)).to eq(expected_path)
+      expect(File).to have_received(:absolute_path).with(expected_path)
+    end
+
+    it "searches path for executable git" 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(File).to receive(:join).with(dir_path, any_args)
+      allow(File).to receive(:join).with(dir_path, "#{cmd}.exe").
+        and_return(expected_path)
+      allow(Which).to receive(:executable_file?).with(any_args) { false }
+      allow(Which).to receive(:executable_file?).with(expected_path) { true }
+      allow(File).to receive(:absolute_path).with(expected_path).
+        and_return(expected_path)
+
+      expect(Which.which(cmd)).to eq(expected_path)
+      expect(File).to have_received(:absolute_path).with(expected_path)
+    end
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-which')
+  ARGV.clear
+  IRB.start
+end

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-which.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/which/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-which"
+  spec.version       = TTY::Which::VERSION
+  spec.authors       = ["Piotr Murach"]
+  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.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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: tty-which
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-30 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Platform independent implementation of Unix which command.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tty-which.rb
+- lib/tty/which.rb
+- lib/tty/which/version.rb
+- spec/spec_helper.rb
+- spec/unit/which_spec.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-which.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Platform independent implementation of Unix which command.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/which_spec.rb
+has_rdoc: