git-hookshot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38a586de567df197046bb142aef1928af9e6f49b
+  data.tar.gz: 35d0acecec864c5517763e76b4a7d4fea4a95d8f
+SHA512:
+  metadata.gz: ab46b3db0ad3b92024245ebebf086ce90cf6bff608e7edc07c714d9c8f52248fc3a76b4ae6a2c945367b0fcdd0c4ab0d93e76bd3fdca14827a8ca87aad32b02d
+  data.tar.gz: e0ab3c33a2495720c815151525386a75e3a2815135468e780cb693a5bcf8b2d2c341474e87a934c17f279fbfe9282dbed76c59d2ebd6dd863935ff4ce0609f28

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from: "https://raw.githubusercontent.com/brandonweiss/rubocop-config/6265b818701ec1d8d91dfc39514c0bd074f3af82/default.yml"
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "bin/*"
+    - "exe/*"
+    - "vendor/**/*"
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - "test/**/*"
+
+Style/FileName:
+  Exclude:
+    - "lib/git-hookshot.rb"

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,3 @@
+script:
+  - bundle exec rubocop
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in git-hookshot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    git-hookshot (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    fakefs (0.11.0)
+    minitest (5.10.3)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (12.0.0)
+    ruby-progressbar (1.8.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  fakefs (~> 0.11.0)
+  git-hookshot!
+  minitest (~> 5.10.3)
+  minitest-reporters (~> 1.1.14)
+  rake (~> 12.0.0)
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brandon Weiss
+
+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,59 @@
+# git-hookshot
+
+<img src="https://cloud.githubusercontent.com/assets/4727/20847858/9d3c4ef8-b884-11e6-8bcc-8c2c493c60b3.png" width="60%">
+
+git-hookshot allows you to share git hooks in Ruby projects among all the collaborators _automatically_, without them having to do anything. It automatically symLINKs them to the internal git hooks directory when installing gems with Bundler.
+
+There are several other tools somewhat similar to this, but all of them require each collaborator working on a repository to run a specific command that generates the git hooks, and if they don’t then nothing happens. On a large project that can result in an untenable situation where unintentionally everyone has a different development experience.
+
+npm has install hooks that can be easily hooked into it but Bundler and RubyGems don’t really. And yet a way has been found…
+
+⚠️ **Caveat emptor** ⚠️
+
+This entire gem runs on 🔮 dark magic 🔮. What it does isn’t intended to be possible to do, but it draws on the arcane power of defining gem install hooks _inside_ the gemspec in order to setup the git hooks during bundling and then dynamically overwrite the `post_install_message` in order to surface the explanatory output from the depths of where the gem install hook is called. I wouldn’t think too much about it. _If you gaze long into an abyss, the abyss also gazes into you._
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "git-hookshot"
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install git-hookshot
+```
+
+## Usage
+
+git-hookshot is automatically run when bundling and will figure out what the right thing to do is given the state of your git hooks.
+
+If you’re the first person to start using git-hookshot and you have no shared hooks, it will create empty shared hooks in `.hooks/` and symlink them to the internal git hook files at `.git/hooks/`. If you have existing internal git hooks they will be safely moved out of the way and a suffix of `.old` will be added to them.
+
+You should add whatever logic you want to whatever hooks you want and then commit them to the repository.
+
+When another collaborator pulls your changes which add git-hookshot and the shared git hooks Bundler will complain that there are new gems that need to be installed. When they bundle, git-hookshot will see the shared git hooks and create symlinks to the internal git hooks directory, enabling the shared git hooks. Collaborators don’t have to do anything extra—it just works.
+
+git-hookshot can also be manually called with `bundle exec git-hookshot` if you need to re-generate a symlink or something.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/brandonweiss/git-hookshot.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hookshot"
+
+# 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

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/exe/git-hookshot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require "git-hookshot"
+
+Hookshot.link

data/git-hookshot.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hookshot/version"
+
+Gem.pre_install do |installer|
+  require "hookshot"
+
+  output = Hookshot.with_captured_stdout do
+    current_working_directory = `lsof -p #{Process.ppid} | grep cwd`.split(" ").last
+    Hookshot.link(current_working_directory: current_working_directory)
+  end
+
+  installer.spec.post_install_message = output
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-hookshot"
+  spec.version       = Hookshot::VERSION
+  spec.authors       = ["Brandon Weiss"]
+  spec.email         = ["desk@brandonweiss.me"]
+
+  spec.summary       = "Share git hooks in Ruby projects among all the collaborators automatically"
+  spec.description   = "Share git hooks in Ruby projects among all the collaborators automatically, without them having to do anything"
+  spec.homepage      = "https://github.com/brandonweiss/git-hookshot"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 12.0.0"
+  spec.add_development_dependency "minitest", "~> 5.10.3"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1.14"
+  spec.add_development_dependency "fakefs", "~> 0.11.0"
+end

data/lib/git-hookshot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "hookshot"

data/lib/hookshot.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "hookshot/git_hook"
+require "hookshot/git_hooks_directory"
+require "hookshot/hook"
+require "hookshot/hooks_directory"
+require "hookshot/version"
+
+require "pathname"
+require "fileutils"
+
+module Hookshot
+
+  def self.link(current_working_directory: nil)
+    @current_working_directory = current_working_directory
+
+    HooksDirectory.create_with_default_hooks unless HooksDirectory.exists?
+
+    HooksDirectory.hooks.each do |hook|
+      git_hook = GitHook.new(name: hook.name)
+
+      next if git_hook.symlink?
+      git_hook.backup if git_hook.file?
+
+      git_hook.symlink(to: hook)
+    end
+  end
+
+  def self.current_working_directory
+    path = @current_working_directory || Dir.pwd
+    Pathname.new(path)
+  end
+
+  def self.with_captured_stdout
+    old_stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = old_stdout
+  end
+
+end

data/lib/hookshot/git_hook.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Hookshot
+  class GitHook
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def symlink?
+      File.symlink?(path)
+    end
+
+    def file?
+      File.exist?(path)
+    end
+
+    def backup
+      puts "Existing #{path} found, moving to #{path}.old…"
+      FileUtils.move(path, "#{path}.old")
+    end
+
+    def symlink(to:)
+      puts "Symlinking #{path} to #{to.path}…"
+      File.symlink(to.path.to_s, path.to_s)
+    end
+
+    private def path
+      GitHooksDirectory.path.join(@name)
+    end
+
+  end
+end

data/lib/hookshot/git_hooks_directory.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Hookshot
+  module GitHooksDirectory
+
+    def self.path
+      Hookshot.current_working_directory.join(".git/hooks")
+    end
+
+  end
+end

data/lib/hookshot/hook.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hookshot
+  class Hook
+
+    attr_reader :name
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def create
+      puts "Creating empty #{@name} hook at #{path}…"
+      FileUtils.touch(path)
+    end
+
+    def path
+      HooksDirectory.path.join(@name)
+    end
+
+  end
+end

data/lib/hookshot/hooks_directory.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Hookshot
+  module HooksDirectory
+
+    DEFAULT_HOOK_NAMES = %w[
+      applypatch-msg
+      commit-msg
+      post-applypatch
+      post-checkout
+      post-commit
+      post-merge
+      post-receive
+      post-rewrite
+      post-update
+      pre-applypatch
+      pre-auto-gc
+      pre-commit
+      pre-push
+      pre-rebase
+      pre-receive
+      prepare-commit-msg
+      update
+    ].freeze
+
+    def self.exists?
+      Dir.exist?(path)
+    end
+
+    def self.create_with_default_hooks
+      create
+      create_default_hooks
+    end
+
+    private_class_method def self.create
+      puts "`.hooks` directory not found. Creating it…"
+      Dir.mkdir(path.to_s)
+    end
+
+    private_class_method def self.create_default_hooks
+      DEFAULT_HOOK_NAMES.each do |git_hook|
+        Hook.new(name: git_hook).create
+      end
+    end
+
+    def self.hooks
+      Dir.glob("#{path}/*").map do |file|
+        Hook.new(name: File.basename(file))
+      end
+    end
+
+    def self.path
+      Hookshot.current_working_directory.join(".hooks")
+    end
+
+  end
+end

data/lib/hookshot/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hookshot
+
+  VERSION = "0.1.0"
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: git-hookshot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Weiss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.14
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: Share git hooks in Ruby projects among all the collaborators automatically,
+  without them having to do anything
+email:
+- desk@brandonweiss.me
+executables:
+- git-hookshot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/git-hookshot
+- git-hookshot.gemspec
+- lib/git-hookshot.rb
+- lib/hookshot.rb
+- lib/hookshot/git_hook.rb
+- lib/hookshot/git_hooks_directory.rb
+- lib/hookshot/hook.rb
+- lib/hookshot/hooks_directory.rb
+- lib/hookshot/version.rb
+homepage: https://github.com/brandonweiss/git-hookshot
+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: Share git hooks in Ruby projects among all the collaborators automatically
+test_files: []