cmd_executable 0.1.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2afa4096ae4f4725dfc86a931af507f5e372535e8b48ccd62e8f7ffbd6576b8d
-  data.tar.gz: 48757e7931d24467727cddbfb05c6af9f4a9fa32d33de70f0cb439e05975814a
+  metadata.gz: 2be28fc8b7b25d870c1ecd8043f8e170e7778671ab748db457a5e11d416711b7
+  data.tar.gz: 8e5fd645751d0beec7b4b29873de947252c87ae20ceef72704af7892f20b8dc6
 SHA512:
-  metadata.gz: 01ae2b36a2381bc78638d67336bbb953bd7acc924d267718865bf1f4bdcc7ae12f1aa2a6e4819e514deea2bb4f39fd472293949116a2a22b9c07a42b2bbf09c5
-  data.tar.gz: 3ccc53e35f9080d02360724de21f0f86131361ab2e135cc0d833c2818003788bb7595b72132aaabf3aae452530c358372e9ff6e2849702751a3f6d0f84755f55
+  metadata.gz: 0745f442bea47b45b4b3024599be749d1cdc21e7ec52d8ab3de6cba1d679ea2d1e5ded411cc194896165fcad528d0d92d6305f318b2edb5f5ab501c0d83a814e
+  data.tar.gz: 2827fbf6270af7564eb8fec73ab55985c7a366f2521bc4b16f600e43f463dfce38f8fe439432369b96230812f1e96189a67d4c7c1f4ef9794d1a84756cbb77ca

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

@@ -14,9 +14,9 @@ Gem::Specification.new do |spec|
     it's return true if given command usable on Linux.
   DESC
 
-  spec.homepage      = 'https://github.com/toshiki670/cmd_executable/wiki'
+  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 ArgumentError 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,114 @@
+# 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
+    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 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,56 @@
+# 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
+
+    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
+    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.9'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmd_executable
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 1.2.0
 platform: ruby
 authors:
 - Toshiki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-06-13 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,12 +146,14 @@ 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/wiki
+homepage: https://github.com/toshiki670/cmd_executable
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/toshiki670/cmd_executable/wiki
+  homepage_uri: https://github.com/toshiki670/cmd_executable
   source_code_uri: https://github.com/toshiki670/cmd_executable
   changelog_uri: https://github.com/toshiki670/cmd_executable/releases
 post_install_message: 
@@ -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