cmd_executable 0.1.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9abe4451b735f5bb2d9280739e22812008eb2621984f34b7e42c7041d86cb0dc
-  data.tar.gz: bc54ef0b966b6866b270a8b9fd6f6cf8b1b411fbea79cc57c71d85ed21a3bab7
+  metadata.gz: ebca555d7972dd6bd32d9baa1fb29055caa0d5aa4c4f1d77efecc8ef4cd0f9d6
+  data.tar.gz: daca2dd878419fa0e5fbc7c9be940ce66bc418038453cfc90165ae095a1e21e8
 SHA512:
-  metadata.gz: 4ca959fea731ab8ee1d1be217f322359aae743e40167e74937a443c14e8d97a04d0454ccb2bc183044f0d14a2fbbeceeaeb793c6510918119689813ca2dc3ba8
-  data.tar.gz: 1fd4c29f26b3092b5ab6e93572df2adb1ac43ae49b8335ccd452c11f596ef3914fe019f8369bb6980b5ddace50dd5167cbd0e900bc0f8bc53b11ef2ee4e542ad
+  metadata.gz: 7e2771593c1c188bbd89c5681a09f14d171cb970ea7bfbd6b34d28e739d77e847e2fb2c577dd2b28aba96f11ee9fa5b33025e519e572fb993ed142db27582a56
+  data.tar.gz: 753b1d39d8522b79e7941e3a0796a3b3f36ebb0452ae7712b45d66d012cfeb06f8fb65fe8f62684399147bd6dcaa55924b18662e099ed1339cd5bc7338fd96c3

data/.github/workflows/gem-push.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: toshiki670
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/README.md

@@ -14,24 +14,40 @@ 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
 ```
 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 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

@@ -9,12 +9,14 @@ Gem::Specification.new do |spec|
   spec.email         = ['toshiki.dev@protonmail.ch']
 
   spec.summary       = 'The command executable module.'
-  spec.description   = 'Please include CmdExecutable'
-  spec.homepage      = 'https://github.com/toshiki670/cmd_executable/wiki'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.description   = <<-'DESC'
+    This module adds a method "executable?(command)".
+    it's return true if given command usable on Linux.
+  DESC
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.homepage      = 'https://github.com/toshiki670/cmd_executable'
+  spec.license       = 'MIT'
+  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'
@@ -29,9 +31,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
+  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_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,10 @@ 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
+    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,96 @@
+# 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?
+    end
+
+    def command
+      parse if @command.nil?
+      @command
+    end
+
+    private
+
+    def command_class_validate?
+      @raw.is_a?(String) ||
+        @raw.is_a?(Symbol)
+    end
+
+    def parse
+      raise CmdExecutable::ParserError unless validate?
+
+      path = @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 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 parse_dirname(path)
+      return path unless basename_exist?(path)
+
+      dir = File.dirname(path)
+      return '' if dir.match?(a_dot_only_regex)
+
+      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
+  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
+      STDOUT.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.5'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,86 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: cmd_executable
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.1
 platform: ruby
 authors:
 - Toshiki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.85.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.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: '0'
-description: Please include CmdExecutable
+        version: '1.0'
+description: |2
+      This module adds a method "executable?(command)".
+      it's return true if given command usable on Linux.
 email:
 - toshiki.dev@protonmail.ch
 executables:
@@ -88,11 +118,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/release.yml"
+- ".github/workflows/gem-push.yml"
 - ".github/workflows/ruby_check.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -103,13 +132,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:
-  allowed_push_host: https://rubygems.org
-  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: 
@@ -120,14 +150,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The command executable module.

data/.github/workflows/release.yml

@@ -1,50 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Release
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  release:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
-      with:
-        ruby-version: 2.7
-    - name: Install dependencies
-      run: |
-        bundle config set path 'vendor/bundle'
-        bundle install --jobs=8
-    - name: Create credentials
-      run: |
-        mkdir -p ~/.gem
-        echo '---' > ~/.gem/credentials
-        echo ":rubygems_api_key: $RUBYGEMS_API_ACCESS_KEY" >> ~/.gem/credentials
-        chmod 0600 ~/.gem/credentials
-    - name: Setup git
-      run: |
-        git config push.default current
-        git config user.email "toshiki.dev@protonmail.ch"
-        git config user.name "Toshiki"
-    - name: Release
-      run: |
-        bundle exec rake build
-        bundle exec rake release
-    - name: Remove credentials
-      run: shred -u ~/.gem/credentials

data/.travis.yml

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