git-hooks 0.5.0 → 0.6.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eb1b43db79e2fee7f1e80b606a5f179d9ef6e01
-  data.tar.gz: 4c406f7fa4c304979c38479a7b7e3aee4e3775d1
+  metadata.gz: 75034e9d934e19aee6f2737af93677be3aff90cd
+  data.tar.gz: a619eaf1a0d4e4b67b13c14537ec937592ee29bf
 SHA512:
-  metadata.gz: 8e738a492bf589e366da29a5355a85c54c5d7990e369b0479f2cd3a325b7c78b619bd1d0df26fb25932fdcc19ca30ae600699ffd9b9689f58b26d57f897a4eb8
-  data.tar.gz: ce5edbedf28705755913ef38b183ad64d8e60fe58dec7837be37350ff0779aad3c49213932ced1c7d755f476bc9e355b1142150702ee9904c05374c902dcebbe
+  metadata.gz: 5695f03af3ffbde6a7991a0f9845fca7d5184b329485a9c2e66254eebf339f13c8905c6c3d7b882cff61d6fc6ba7e5be3e8fb2a9ac7d337f5cef56d362db30c0
+  data.tar.gz: 43154d5d0cb3f0ca6efcf6ab6c205f749f128034fc2386039efc6cfb4a4fdc0d18815861c7fa31ede8e15654079c6615b3e4a8d8f4dad54d710aa008c1993be4

data/README.md

@@ -63,7 +63,24 @@ application's start-up code (e.g. `config/environments/development.rb` or
 GitHooks.validate_hooks!
 ```
 
-This will force `git_hooks` installation before your application's start.
+This will force `git_hooks` installation before you can run your application. Be
+sure not to call `GitHooks#validate_hooks!` on production environments though!
+
+### Problems with ruby version
+
+If you run `git` under other systems such as `gitk` or Emacs' `Magit`, you may
+encounter problems with the ruby version being used to run `GitHooks`. This
+happens because those applications don't source the `~/.bashrc` file, which is
+required by ruby version managers such as `Rbenv` and `Rvm`.
+
+In order to fix this problem, you can install the hooks by passing your ruby
+path to the `--ruby_path` option. For example:
+
+```sh
+$ git_hooks install pre-commit --ruby_path `which ruby`
+```
+
+You can also manually edit the `.git/hooks/{hook-name}` file though.
 
 ## Contributing
 

data/lib/git_hooks/cli.rb

@@ -6,13 +6,15 @@ module GitHooks
   class CLI < Thor
     desc 'install HOOK', 'Install some hook'
     option :force, type: :boolean
+    option :ruby_path, type: :string
     long_desc <<-LONGDESC
       Install some hook:
 
       $ git_hooks install pre-commit
     LONGDESC
     def install(hook)
-      GitHooks::Installer.new(hook).install(options[:force])
+      GitHooks::Installer.new(hook, options[:ruby_path])
+        .install(options[:force])
     end
 
     desc 'Init GitHooks on current folder', 'Create a configuration file'

data/lib/git_hooks/exceptions/unknown_hook_present.rb

@@ -1,8 +1,11 @@
 module GitHooks
   module Exceptions
-    class UnknowHookPresent < RuntimeError
+    class UnknownHookPresent < RuntimeError
       def initialize(hook)
-        super "There is a unknown #{hook} hook. If you are sure, use --force."
+        super <<-HEREDOC
+There is already a #{hook} hook installed.
+If you want to override it, use the --force option.
+HEREDOC
       end
     end
   end

data/lib/git_hooks/installer.rb

@@ -1,33 +1,44 @@
 module GitHooks
   class Installer
-    attr_accessor :hook
-
     HOOK_SAMPLE_FILE = 'hook.sample'
 
-    def initialize(hook)
+    def initialize(hook, ruby_path = nil)
       @hook = hook
+      @ruby_path = ruby_path
     end
 
     def install(force = false)
-      return true if installed?
+      throw Exceptions::UnknownHookPresent.new(hook) if !force && installed?
+
+      hook_script = hook_template
+      hook_script.gsub!('/usr/bin/env ruby', ruby_path) if ruby_path
+
+      File
+        .open(hook_path, 'w')
+        .write(hook_script)
 
-      FileUtils.symlink(
-        hook_template_path, File.join('.git', 'hooks', hook), force: force
-      )
-    rescue Errno::EEXIST
-      raise GitHooks::Exceptions::UnknowHookPresent, hook
+      FileUtils.chmod(0775, hook_path)
     end
 
     def installed?
-      hook_file = File.join(Dir.pwd, '.git', 'hooks', hook)
-
-      File.symlink?(hook_file) && File.realpath(hook_file) == hook_template_path
+      File.exist?(hook_path) &&
+        File.read(hook_path).match(/GitHooks.execute_pre_commits/)
     end
 
     private
 
+    attr_accessor :hook, :ruby_path
+
+    def hook_template
+      File.read(hook_template_path)
+    end
+
     def hook_template_path
       File.join(GitHooks.base_path, HOOK_SAMPLE_FILE)
     end
+
+    def hook_path
+      File.join('.git', 'hooks', hook)
+    end
   end
 end

data/lib/git_hooks/version.rb

@@ -1,3 +1,3 @@
 module GitHooks
-  VERSION = '0.5.0'
+  VERSION = '0.6.0.pre1'
 end

data/spec/git_hooks/installer_spec.rb

@@ -3,68 +3,55 @@ describe GitHooks::Installer do
 
   let(:hook) { 'pre-commit' }
 
-  let(:hook_real_path) do
+  let(:hook_template_path) do
     File.join(GitHooks.base_path, 'hook.sample')
   end
 
-  let(:absolute_path) do
-    File.join(GitHooks.base_path, '.git', 'hooks', hook)
+  let(:hook_path) do
+    File.join('.git', 'hooks', hook)
   end
 
   let(:git_hook_path) { ".git/hooks/#{hook}" }
+  let(:file) { instance_double(File, write: true) }
+
+  before do
+    allow(File).to receive(:open).and_return(file)
+    allow(FileUtils).to receive(:chmod).and_return(true)
+  end
 
   describe '#install' do
     subject(:install) { installer.install }
 
+    let(:installed?) { false }
+
     before do
-      allow(installer).to receive(:installed?).and_return(false)
-      allow(FileUtils).to receive(:symlink).and_return(true)
+      allow(installer).to receive(:installed?)
+        .and_return(installed?)
     end
 
-    it 'creates symlink' do
-      expect(FileUtils)
-        .to receive(:symlink)
-        .with(hook_real_path, git_hook_path, force: false)
+    it 'creates a new file' do
+      expect(File).to receive(:open)
+        .with(hook_path, 'w')
+
+      expect(file).to receive(:write)
+        .with(/GitHooks.execute_pre_commits/)
 
       install
     end
 
     it { is_expected.to be_truthy }
 
-    context 'when there is a unknown hook' do
-      before do
-        allow(FileUtils).to receive(:symlink).and_raise(Errno::EEXIST)
-      end
-
-      it 'raises an error' do
-        expect { install }.to raise_error(
-          GitHooks::Exceptions::UnknowHookPresent
-        )
-      end
-    end
-
     context 'when there is a unknown hook but I want to force installation' do
-      subject(:install) { installer.install true }
+      subject(:install) { installer.install(true) }
 
-      it 'creates symlink with force option' do
-        expect(FileUtils)
-          .to receive(:symlink)
-          .with(hook_real_path, git_hook_path, force: true)
-
-        install
-      end
+      let(:installed?) { true }
 
-      it { is_expected.to be_truthy }
-    end
-
-    context 'when hook is already installed' do
-      before do
-        allow(installer).to receive(:installed?).and_return(true)
-      end
+      it 'creates symlink with force option' do
+        expect(File).to receive(:open)
+          .with(hook_path, 'w')
 
-      it 'does not create symlink' do
-        expect(FileUtils)
-          .to_not receive(:symlink)
+        expect(file).to receive(:write)
+          .with(/GitHooks.execute_pre_commits/)
 
         install
       end
@@ -76,29 +63,22 @@ describe GitHooks::Installer do
   describe '#installed?' do
     subject(:installed?) { installer.installed? }
 
-    let(:symlink?) { true }
-
     before do
-      allow(File).to receive(:symlink?).and_return(symlink?)
-      allow(File).to receive(:realpath).and_return(hook_real_path)
-    end
-
-    it 'validates file is a symlink' do
-      expect(File).to receive(:symlink?).with(absolute_path)
-      installed?
+      allow(File).to receive(:read)
+        .and_return('GitHooks.execute_pre_commits')
     end
 
     it { is_expected.to be_truthy }
 
-    context 'when file is not a symlink' do
-      let(:symlink?) { false }
-
-      it { is_expected.to be_falsy }
+    it do
+      expect(File).to receive(:exist?).with(hook_path)
+      installed?
     end
 
-    context 'when is not the GitHooks file' do
+    context 'when the hook does not validate pre_commits' do
       before do
-        allow(File).to receive(:realpath).and_return('/tmp/foo')
+        allow(File).to receive(:read)
+          .and_return('echo yolo')
       end
 
       it { is_expected.to be_falsy }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-hooks
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0.pre1
 platform: ruby
 authors:
 - Rafael da Silva Almeida
@@ -193,9 +193,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2