cmd_executable 0.1.10 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce5fd019de148751a28b2194e37a0dec11e33c3cdd719166a6fca3649e2503f
-  data.tar.gz: 065f28effc5cb309f5d30c7d9e82657ed9e2c1a5847601cea2c13eb502a9fdce
+  metadata.gz: abe5b341ee72889b2f6fef8fb49674f4a264139c99930a568e454fa39f602595
+  data.tar.gz: 057b080db6987e538dde260cc789eb4033d4821f437da68baebd8bbdf9b52413
 SHA512:
-  metadata.gz: f5e0c6c721becae2ce0245faeb7af15f4637a6c2b621b35085b8c5e856438ab170bbb328f25c2e7eb943c530014a2aac1921073a22671403f3cc061c8b9190ad
-  data.tar.gz: d3ef5f7f5cfcaa2fa33a1940d5d333296302c0ee5a5f5d916dd7afc4d2f217baaeb25b63ec0371c4702122fd1554e57a0fb2d03e48585ccfab8f97526e44061a
+  metadata.gz: 179e29ce611cb66c883b3619b46102a82356c8b76eee5060efdbd78b1363bd67abb5dc3adae80698fa7d9493aa868de0376312c92ada9f327bfc4af7375d9c7f
+  data.tar.gz: 7518809cc0626aa005aa844d881f4191e6e44cadb674f884873f2775860d498f0e4d4fd8e5a2fb6534ea2ed62448f36be6b79c7d943e6af1d4c1a026d0ddda7b

data/README.md

@@ -14,24 +14,48 @@ gem 'cmd_executable'
 
 And then execute:
 
-    $ bundle install
+    `$ bundle install`
 
 Or install it yourself as:
 
-    $ gem install cmd_executable
+    `$ gem install cmd_executable`
 
 ## Usage
+### as Module (include)
 ```
 require 'cmd_executable'
 
 class Klass
- include 'CmdExecutable'
-
- def instance_method
-   executable?('ls')
- end
+  include CmdExecutable
+
+  def instance_method
+    executable?('/bin/ls')
+    executable?('ls')
+    executable?(:ls)
+    executable?('./bin/setup')
+  end
 end
 ```
+### as Module method
+```
+CmdExecutable.executable?('/bin/ls')
+CmdExecutable.executable?('ls')
+CmdExecutable.executable?(:ls)
+CmdExecutable.executable?('./bin/setup')
+```
+
+### as CLI
+Check executable? :
+
+    `$ cmd_executable -c [/path/to/command]`
+    or
+    `$ cmd_executable -c [../path/to/command]`
+    or
+    `$ cmd_executable -c [command]`
+
+Show help :
+
+    `$ cmd_executable -h`
 
 ## Development
 

data/cmd_executable.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.homepage      = 'https://github.com/toshiki670/cmd_executable'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/toshiki670/cmd_executable'
@@ -33,7 +33,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'pry-doc', '~> 1.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.85.0'
+  spec.add_development_dependency 'stream_capture', '~> 1.0'
+
+  spec.add_dependency 'thor', '~> 1.0'
 end

data/exe/cmd_executable

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'cmd_executable'
+require 'cmd_executable/runner'
+
+CmdExecutable::Runner.start(ARGV)

data/lib/cmd_executable.rb

@@ -23,6 +23,8 @@
 # THE SOFTWARE.
 
 require 'English'
+require 'cmd_executable/parser'
+require 'cmd_executable/runner'
 require 'cmd_executable/version'
 
 # Command Executable
@@ -31,7 +33,7 @@ require 'cmd_executable/version'
 #   require 'cmd_executable'
 #
 #   class Klass
-#     include 'CmdExecutable'
+#     include CmdExecutable
 #
 #     def instance_method
 #       executable?('ls')
@@ -41,13 +43,14 @@ module CmdExecutable
   class CmdExecutableError < StandardError; end
 
   def executable?(command)
-    path = File.split(command).yield_self do |dirname, basename|
-      dirname = File.absolute_path?(dirname) ? dirname : ''
-      dirname += File::SEPARATOR if dirname.rindex(File::SEPARATOR)
-      dirname + basename.split.first
-    end
+    CmdExecutable.executable?(command)
+  end
+
+  def self.executable?(command)
+    parsed = CmdExecutable::Parser.new(command)
+    raise CmdExecutable::ParserError, parsed.raw unless parsed.validate?
 
-    `type '#{path}' > /dev/null 2>&1`.yield_self do
+    `type "#{parsed.command}" > /dev/null 2>&1`.yield_self do
       $CHILD_STATUS.success?
     end
   end

data/lib/cmd_executable/parser.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Toshiki
+#
+# 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.
+
+require 'English'
+
+module CmdExecutable
+  class ParserError < StandardError; end
+
+  # Parser for CmdExecutable
+  class Parser
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw
+      @raw.freeze
+    end
+
+    def validate?
+      !@raw.nil? &&
+        command_class_validate? &&
+        !@raw.empty? &&
+        !include_invalid_char?
+    end
+
+    def command
+      parse if @command.nil?
+      @command
+    end
+
+    private
+
+    def command_class_validate?
+      @raw.is_a?(String) ||
+        @raw.is_a?(Symbol)
+    end
+
+    def include_invalid_char?
+      @raw.match?(/\r\n|\r|\n/) ||
+        @raw.match?(/\$\(.*\)/)
+    end
+
+    def parse
+      raise CmdExecutable::ParserError, @raw unless validate?
+
+      path = escape_char(@raw.to_s.chomp)
+      @dirname = parse_dirname(path)
+      @basename = parse_basename(path)
+      @command = @dirname + @basename
+      self
+    end
+
+    def no_separator_at_the_right_end_regex
+      /(?<!#{File::SEPARATOR})\Z/
+    end
+
+    def a_dot_only_regex
+      /\A\.\Z/
+    end
+
+    def current_path_at_the_left_regex
+      /\A\.#{File::SEPARATOR}/
+    end
+
+    def basename_exist?(path)
+      path.match?(no_separator_at_the_right_end_regex)
+    end
+
+    def no_right_separator_exists?(dir)
+      dir.match?(no_separator_at_the_right_end_regex)
+    end
+
+    def current_path?(path)
+      path.match?(current_path_at_the_left_regex)
+    end
+
+    def parse_dirname(path)
+      return path unless basename_exist?(path)
+
+      dir = File.dirname(path)
+      return '' if dir.match?(a_dot_only_regex) && !current_path?(path)
+
+      no_right_separator_exists?(dir) ? (dir + File::SEPARATOR) : dir
+    end
+
+    def parse_basename(path)
+      return '' unless basename_exist?(path)
+
+      File.basename(path).split.first
+    end
+
+    def escape_char(path)
+      path.gsub(/"/, '\"')
+    end
+  end
+end

data/lib/cmd_executable/runner.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Toshiki
+#
+# 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.
+
+require 'cmd_executable'
+require 'thor'
+
+module CmdExecutable
+  # CLI Runner
+  #
+  # Usage on CLI:
+  #   $ cmd_executable ls
+  #   > OK
+  class Runner < Thor
+    include CmdExecutable
+
+    def self.exit_on_failure?
+      true
+    end
+
+    map '-c' => :check
+
+    desc '-c [/path/to/command]', "It's return true if given command usable on Linux."
+    def check(command = '')
+      if executable?(command)
+        puts 'OK'
+        exit 0
+      else
+        puts 'NOT FOUND'
+        exit 1
+      end
+    rescue CmdExecutable::ParserError => e
+      warn "Invalid command: `#{e.message}'"
+      exit 16
+    end
+
+    map %w[-v --version] => :version
+    desc '-v --version', 'Show version.'
+    def version
+      puts CmdExecutable::VERSION
+    end
+  end
+end

data/lib/cmd_executable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CmdExecutable
-  VERSION = '0.1.10'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmd_executable
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 1.2.1
 platform: ruby
 authors:
 - Toshiki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.85.0
+- !ruby/object:Gem::Dependency
+  name: stream_capture
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |2
       This module adds a method "executable?(command)".
       it's return true if given command usable on Linux.
@@ -94,7 +136,6 @@ files:
 - ".github/workflows/ruby_check.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -105,6 +146,8 @@ files:
 - cmd_executable.gemspec
 - exe/cmd_executable
 - lib/cmd_executable.rb
+- lib/cmd_executable/parser.rb
+- lib/cmd_executable/runner.rb
 - lib/cmd_executable/version.rb
 homepage: https://github.com/toshiki670/cmd_executable
 licenses:
@@ -121,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4