set_git_hooks_dir 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3637ad5c65ac7fe48a2c7ab69e143e8804c6b87882ccdba405a9e3cb1911e131
-  data.tar.gz: a16e8a152237f9ba1decd81cc404dcc8d1b17d8724d6b294c34a4d4f3bcc6e5b
+  metadata.gz: 976195685caba3b76712236bc1bd6b7d47531ed7313dddfab5f2f3a29d8d8064
+  data.tar.gz: 8d107ed8fa79b2b0933a6e8916b165518072058ba967c2938de1fbfadfff5e17
 SHA512:
-  metadata.gz: 44b8cb7180b48f2aebe1946068e855b8cf02d7b0e619ebd7587bba0edbd24f952ccca3b0576f966798bd153eeed6577750978970480cc10cdec5012ee8e4c696
-  data.tar.gz: 63b5cd78456dba45cad8d807bf6a95f1ed7cf8572f01fb6344b0189ac7dc840b72656ac1c4657996d7d00eda870f08a710cfebdbf562c00e1d9b42b0e0f51fc7
+  metadata.gz: 87fba99429a671ec0c18ef760864d8668dafe91be0b8597406d27e045d1f4fb362eb55aab0f7b065501cf3f9cd38d8540c425b64b5e80db5fb6be6b506e92183
+  data.tar.gz: d617440c4336aaece2109608205a23a32abec4a9543142ed5cf517bccceeb31f06575f5e029b9b4c9a6dbd1049c2751e7f537e8a4342158d60b6d666f11b14bd

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 rhysd
+
+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,38 @@
+`set_git_hooks_dir` Ruby package
+================================
+[![gem][gem-badge]][gem]
+
+## Usage
+
+See https://github.com/rhysd/set-git-hooks-dir#readme for the usage.
+
+## Details
+
+This gem aims to be used as both bundler and rubygems plugins so that this gem can hook the package installation and
+configure Git hooks properly.
+
+So why can't this gem be a simple rubygems plugin? The answer is that bundler doesn't run rubygems plugin's install
+hooks on `bundle install`. bundler downloads gems from rubygems.org and stores the downloaded gems to the
+[`BUNDLE_PATH`][path] directory and makes them loadable. However, this doesn't mean *installing* the gems. It just
+*stores*. It is very confusing that `gem install` *installs* a gem but `bundle install` does not *install* a gem. The
+following issue mentions this behavior:
+
+https://github.com/rubygems/bundler/issues/5429
+
+> Running `bundle install` with `path` gems does not install those gems. The `path` feature is a shortcut to add the
+> path to `$LOAD_PATH`, and does not do any of the usual gem installation procedures.
+
+The detailed behavior of this gem in each cases are as follows:
+
+- On `bundle install`, this gem works as a bundler plugin. bundler loads the plugin on installation and it configures
+  Git hooks.
+- On `gem install`, this gem works as a rubygems plugin. rubygems runs a install hook of the plugin and the hook
+  configures Git hooks.
+
+## License
+
+This npm package is distributed under [the MIT license](LICENSE).
+
+[gem-badge]: https://img.shields.io/gem/v/set_git_hooks_dir
+[gem]: https://rubygems.org/gems/set_git_hooks_dir
+[path]: https://bundler.io/v1.12/man/bundle-config.1.html#LIST-OF-AVAILABLE-KEYS

data/lib/rubygems_plugin.rb

@@ -4,6 +4,5 @@ require 'rubygems/installer'
 require_relative 'set_git_hooks_dir'
 
 Gem.post_install do |installer|
-  puts "Setting Git hooks from rubygems plugin #{installer.spec.name}"
   SetGitHooksDir.setup '.git-hooks' if installer.spec.name == 'set_git_hooks_dir'
 end

data/lib/set_git_hooks_dir.rb

@@ -7,12 +7,7 @@ class SetGitHooksDir
     SKIP_ENV_VARS = %w[SET_GIT_HOOKS_DIR_SKIP GITHUB_ACTION CI JENKINS_URL].freeze
 
     def setup(hooks_dir)
-      if SKIP_ENV_VARS.lazy.filter_map { |n| ENV[n] }.any? { |v| !v.empty? }
-        puts 'CI environment is detected. Skip setting Git hooks'
-        return
-      end
-
-      puts "Start setting hooks directory: #{hooks_dir}"
+      return if SKIP_ENV_VARS.lazy.filter_map { |n| ENV[n] }.any? { |v| !v.empty? }
 
       hooks_dir = Pathname.new hooks_dir
       cwd = Pathname.pwd
@@ -20,20 +15,13 @@ class SetGitHooksDir
                   .filter_map { |dir| dir + '.git' if (dir + hooks_dir).directory? }
                   .find { |dotgit| dotgit.exist? }
 
-      puts "Repository config directory: #{dotgit}"
-
       raise StandardError.new("Git hooks directory #{hooks_dir} was not found at any root of GitHub repository in #{cwd}") unless dotgit
-      if dotgit.directory? && File.read(dotgit + 'config').include?("\n\thooksPath = ")
-        puts 'core.hooksPath is already set. Skip setting Git hooks'
-        return
-      end
+      return if dotgit.directory? && File.read(dotgit + 'config').include?("\n\thooksPath = ")
 
       git = ENV['SET_GIT_HOOKS_DIR_GIT']
       git = 'git' if git.nil? || git.empty?
-      puts "Running `#{git} config core.hooksPath #{hooks_dir}`"
       out = `#{git} config core.hooksPath #{hooks_dir}`
       raise StandardError.new("`#{git} config core.hooksPath #{hooks_dir}` failed with status #{$?.exitstatus}: #{out}") unless $?.success?
-      puts 'Done!'
     end
   end
 end

data/plugins.rb

@@ -9,9 +9,11 @@ require 'set_git_hooks_dir'
 #
 # https://github.com/rubygems/bundler/issues/5429
 #
-# To enable automatic hooks configuration in both `gem install` and
-# `bundle install` cases, this package needs to be installed as a bundler
-# plugin.
+# To enable automatic hooks configuration via `bundle install`, this package needs to be installed as a bundler plugin.
+# For the case of `gem install`, `lib/rubygems_plugin.rb` remains (though I don't know the use case).
 
-puts 'Setting Git hooks from bundler plugin'
-SetGitHooksDir.setup '.git-hooks'
+begin
+  SetGitHooksDir.setup '.git-hooks'
+rescue StandardError => exc
+  raise Bundler::BundlerError.new exc.message
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: set_git_hooks_dir
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - rhysd
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
+date: 2024-06-30 00:00:00.000000000 Z
 dependencies: []
 description: set_git_hooks_dir is a deadly simple gem to configure your Git hooks
   on package installation
-email: lin90162@yahoo.co.jp
+email:
+- lin90162@yahoo.co.jp
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- LICENSE
+- README.md
 - lib/rubygems_plugin.rb
 - lib/set_git_hooks_dir.rb
 - plugins.rb
 homepage: https://rubygems.org/gems/set_git_hooks_dir
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://rubygems.org/gems/set_git_hooks_dir
+  source_code_uri: https://github.com/rhysd/set-git-hooks-dir
 post_install_message:
 rdoc_options: []
 require_paths: