executable_pathname 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a31bb2ba7bd7c869b1a8ce3c824ad56e38c7b4e
+  data.tar.gz: b208c1e54c053fb4645bdc26d123ddf0025b1fac
+SHA512:
+  metadata.gz: 67e9e86aa69b8af4ed8f9d70a2f81d0f622cd55a9239d2e533fbb6eb555ffe39cf3e1c5dff4e54c178f7a06a6e6a83608eedc74eba3a0197e86a3de3c1a80a74
+  data.tar.gz: de5df95b42f4ba293f84814584251bd0458154c9e879886cfdb8e927a07a5304055c789e963db802974dbb823801b171a08dce4d3180629b423feff59457b131

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alan.stebbens@procore.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in executable_pathname.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Alan Stebbens
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alan Stebbens
+
+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,111 @@
+# ExecutablePathname
+
+The `executable_pathname` gem provides additional methods for inspecting executable pathnames, within a subclass of the Pathname class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'executable_pathname'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install executable_pathname
+
+## Usage
+
+    require 'executable_pathname'
+
+### Class Methods
+
+    .valid_executable?(path)
+
+Returns true if `path` is a _valid_ executable file, where validity is
+determined by examining the file, and ensuring that if it is a "hash-bang"
+script, that the hash-bang path exists, or is likely to exist.
+
+    .path_list
+
+Returns the current environment variable `PATH` split into an array.
+
+    .remote_path_list
+
+Returns the remote path list, as an array, which is obtained from the envar `REMOTE_PATH`, if defined, or defaults to `'/bin:/usr/bin:/usr/local/bin'` _(split into an array)_.
+
+    .new(path)
+
+Creates a new instance of an `ExecutablePathname`, with the below instance methods.
+
+### Instance Methods
+
+    #first_line
+
+Returns the first line of the file at `path`, if text.
+
+    #shbang?
+
+Returns true if the first line of the file at `path` starts with `#!`.  "shbang" is a contraction of "hash bang".
+
+    #shbang_paths
+
+Returns the paths from the hash-bang line.  If the hash-bang line looks like this:
+
+    #!/path/to/some/file arg1 arg2
+
+then the resulting array from `shbang_paths` is `['/path/to/some/file', 'arg1', 'arg2']`.
+
+    #env_shbang?
+
+Returns true if the `first_line` value contains at least two paths, the first of which ends with `/env`
+
+    #valid_shbang?
+
+Returns true if the `first_line` is a valid hash-bang, where validity is
+determined by the actual existence of the first path, or the probable existence
+of the path, based on it being one of the well-known paths from `REMOTE_PATH`.
+
+    #invalid_shbang?
+
+Returns false if the `first_line` value is not a valid hash-bang.
+
+    #valid_env_shbang?
+
+Returns false if the `first_line` value is not a valid `env` hash-bang path.
+
+    #executable_file?
+
+Returns true if the instance is an executable file.
+
+    #valid_executable?
+
+Returns true if the instance is a _valid_ executable file; that is, if the
+hash-bang path exists, or is in a well-known path.
+
+    #well_known_path?
+
+Returns true if the instance path is in one of the REMOTE_PATH directories.
+
+    #remove_execute_permissions
+
+Removes the execute permissions on the instance.  An error is raised if the
+instance path does not exist.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aks/executable_pathname. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "executable_pathname"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/executable_pathname.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "executable_pathname/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "executable_pathname"
+  spec.version       = ExecutablePathname::VERSION
+  spec.authors       = ["Alan Stebbens"]
+  spec.email         = ["aks@stebbens.org"]
+
+  spec.summary       = %q{Additional methods for inspecting executable pathnames as subclass to Pathname}
+  spec.description   = %q{Provide additional methods to inspect executable files, as a Pathname subclass}
+  spec.homepage      = "https://github.com/aks/executable_pathname"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6.0"
+  spec.add_development_dependency "activesupport", "~> 5.1.3"
+  spec.add_development_dependency "fuubar", "~> 2.2.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.5.0"
+end

data/lib/executable_pathname.rb

@@ -0,0 +1,102 @@
+require 'pathname'
+
+require "executable_pathname/version"
+
+class ExecutablePathname < Pathname
+
+  # Absolute paths must exist or be in a well-known directory path.  Relative
+  # paths must exist within one of the PATH directories, or within a well-known
+  # directory path
+
+  # Define the envar REMOTE_PATH as the colon-separated list of well-known
+  # directory paths that will be referenced on remote hosts.  The default is
+  # '/bin:/usr/bin:/usr/local/bin'
+
+  def self.valid_executable?(name)
+    case name
+    when %r{^/}, %r{.+/.+}
+      pn = new(name)
+      return true if pn.valid_executable?
+    else
+      path_list.each do |dirname|
+        pn = new(File.join(dirname, name))
+        return true if pn.valid_executable?
+      end
+    end
+    false
+  end
+
+  def self.path_list
+    @@path_list ||= ENV['PATH'].split(':')
+  end
+
+  def self.remote_path_list
+    (ENV['REMOTE_PATH'] || '/bin:/usr/bin:/usr/local/bin').split(':')
+  end
+
+  def initialize(path)
+    super(path)
+    @first_line = nil
+    @shbang_paths = nil
+  end
+
+  def first_line
+    @first_line ||= open { |io|
+      line = io.gets
+      line.chomp if line
+    }
+  rescue Errno::ENOENT, Errno::EACCES, IOError
+    nil
+  end
+
+  def shbang?
+    first_line && first_line[0..1] == '#!'
+  end
+
+  def shbang_paths
+    @shbang_paths ||= first_line &&
+      case first_line
+      when /^#!\s*(\S+)\s+(\S+.)/ then [$1, $2.chomp]
+      when /^#!\s*(\S+)/          then [$1.chomp]
+      else []
+      end
+  end
+
+  def env_shbang?
+    shbang_paths && shbang_paths.size > 1 && shbang_paths[0].end_with?('env')
+  end
+
+  def valid_shbang?
+    shbang? && (env_shbang? ? valid_env_shbang? : valid_shbang_command?)
+  end
+
+  def invalid_shbang?
+    shbang? && (env_shbang? ? !valid_env_shbang? : !valid_shbang_command?)
+  end
+
+  def valid_env_shbang?
+    env_shbang? && valid_shbang_command? && shbang_paths.last.split('/').size == 1
+  end
+
+  def valid_shbang_command?
+    shbang_paths.size > 0 && ExecutablePathname.valid_executable?(shbang_paths[0])
+  end
+
+  def executable_file?
+    exist? && file? && executable?
+  end
+
+  def valid_executable?
+    exist? && executable_file? && (!shbang? || valid_shbang?)
+  end
+
+  def well_known_path?
+    return false unless exist?
+    ExecutablePathname.remote_path_list.any? {|rp| (shbang? ? shbang_paths.first : to_path).start_with?(rp)}
+  end
+
+  def remove_execute_permissions
+    chmod(stat.mode & ~0111)
+  end
+
+end

data/lib/executable_pathname/version.rb

@@ -0,0 +1,4 @@
+require 'pathname'
+class ExecutablePathname < Pathname
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: executable_pathname
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alan Stebbens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Provide additional methods to inspect executable files, as a Pathname
+  subclass
+email:
+- aks@stebbens.org
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- executable_pathname.gemspec
+- lib/executable_pathname.rb
+- lib/executable_pathname/version.rb
+homepage: https://github.com/aks/executable_pathname
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Additional methods for inspecting executable pathnames as subclass to Pathname
+test_files: []