git-hooks 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e9ac25d07132d4f6863fd59f76a6701a50f722e
-  data.tar.gz: 49d1ca7b2397c04777d52e2b4640a5adab33ba63
+  metadata.gz: 1eb1b43db79e2fee7f1e80b606a5f179d9ef6e01
+  data.tar.gz: 4c406f7fa4c304979c38479a7b7e3aee4e3775d1
 SHA512:
-  metadata.gz: 7a098c47f8872d7e8ecc6ac350d791d07f760e5e316e00a956b6dd9bd238b8582687b6218e55289d3b5de9fa7b0b4ad73875cf4c3ed5de25a054e5c79793ace1
-  data.tar.gz: 2927c77962ac840deac371dc161de5cf7502e76082df7ee183bfb626dc383ada485c353fbc94ed526ab758787da93e8908b4c1b882b58a76cfa506b63a838952
+  metadata.gz: 8e738a492bf589e366da29a5355a85c54c5d7990e369b0479f2cd3a325b7c78b619bd1d0df26fb25932fdcc19ca30ae600699ffd9b9689f58b26d57f897a4eb8
+  data.tar.gz: ce5edbedf28705755913ef38b183ad64d8e60fe58dec7837be37350ff0779aad3c49213932ced1c7d755f476bc9e355b1142150702ee9904c05374c902dcebbe

data/.git_hooks.yml

@@ -0,0 +1,8 @@
+---
+pre_commits:
+  GitHooks::PreCommit::TrailingWhitespace:
+  GitHooks::PreCommit::PreventDebugger:
+  GitHooks::PreCommit::PreventMaster:
+  GitHooks::PreCommit::Rubocop:
+    use_stash: true
+  GitHooks::PreCommit::Rspec:

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 rvm:
   - '2.0.0'
   - '2.1.0'
+  - '2.1.5'
+  - '2.2.0'
 script: bundle exec rspec

data/README.md

@@ -6,8 +6,8 @@
 
 # GitHooks
 
-Some usefull git hooks, it's written on ruby but can be used for other
-languages.
+This gem provides an interface to write useful git hooks in Ruby. Those hooks
+can be used when working in projects in any programming language.
 
 ## Installation
 
@@ -48,17 +48,21 @@ By now you will find the following built-in hooks:
  - Prevent commits with debugger.
  - Prevent commits with trailing white space.
 
+### Warning about `Rubocop` pre-commit `use_stash` option:
+
+This feature is yet experimental. Be aware that in some odd circumstances you
+may encounter merge conflicts when applying the stash.
+
 ### Ensure hooks existence
 
-To ensure that hooks exists on `.git/hooks`, include this line
+To ensure that hooks exists on `.git/hooks`, include the following line on your
+application's start-up code (e.g. `config/environments/development.rb` or
+`config/environments/test.rb` for a rails app).
 
 ```ruby
 GitHooks.validate_hooks!
 ```
 
-on your application's start up (e.g. `config/environments/development.rb` or
-`config/environments/test.rb` for a rails app).
-
 This will force `git_hooks` installation before your application's start.
 
 ## Contributing

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/git_hooks.yml.example

@@ -1,7 +1,8 @@
 ---
 pre_commits:
-- GitHooks::PreCommit::TrailingWhitespace
-- GitHooks::PreCommit::PreventDebugger
-- GitHooks::PreCommit::PreventMaster
-- GitHooks::PreCommit::Rubocop
-- GitHooks::PreCommit::Rspec
+  GitHooks::PreCommit::TrailingWhitespace:
+  GitHooks::PreCommit::PreventDebugger:
+  GitHooks::PreCommit::PreventMaster:
+  GitHooks::PreCommit::Rubocop:
+    use_stash: false
+  GitHooks::PreCommit::Rspec:

data/hook.sample

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 require 'git-hooks'
 
+puts 'Running pre-commit hooks...'
+
 GitHooks.execute_pre_commits

data/lib/git-hooks.rb

@@ -24,9 +24,10 @@ module GitHooks
     attr_writer :configurations
 
     def execute_pre_commits
-      configurations.pre_commits.each do |pre_commit|
+      configurations.pre_commits.each do |pre_commit, options|
         puts "Executing #{pre_commit}"
-        GitHooks::PreCommit.const_get(pre_commit).validate
+        pre_commit_checker = GitHooks::PreCommit.const_get(pre_commit)
+        pre_commit_checker.validate(options)
       end
     end
 
@@ -54,3 +55,19 @@ module GitHooks
     end
   end
 end
+
+# TODO: Fix this in the ruby-git gem.
+
+# Since the `Git` gem does not provide us with an api that allows you to use the
+# '--keep-index' option when stashing, we are stuck with this monkey patch.
+module Git
+  class Lib
+    def stash_pop(_ = nil)
+      command('stash pop')
+    end
+
+    def stash_save(message)
+      command('stash save', ['--keep-index', message])
+    end
+  end
+end

data/lib/git_hooks/pre_commit/prevent_debugger.rb

@@ -3,7 +3,7 @@ module GitHooks
     class PreventDebugger
       attr_reader :git_repository
 
-      def self.validate
+      def self.validate(*)
         new(GitHooks.configurations.git_repository).validate
       end
 

data/lib/git_hooks/pre_commit/prevent_master.rb

@@ -3,7 +3,7 @@ module GitHooks
     class PreventMaster
       attr_reader :git_repository
 
-      def self.validate
+      def self.validate(*)
         new(GitHooks.configurations.git_repository).validate
       end
 

data/lib/git_hooks/pre_commit/rspec.rb

@@ -1,16 +1,16 @@
 module GitHooks
   module PreCommit
     class Rspec
-      attr_reader :git_repository, :rspec_executor
-
-      def self.validate
+      def self.validate(*)
         new(
-          GitHooks.configurations.git_repository, RspecExecutor.new
+          GitHooks.configurations.git_repository,
+          RspecExecutor.new
         ).validate
       end
 
       def initialize(git_repository, rspec_executor)
-        @git_repository, @rspec_executor = git_repository, rspec_executor
+        @git_repository = git_repository
+        @rspec_executor = rspec_executor
       end
 
       def validate
@@ -18,6 +18,10 @@ module GitHooks
 
         abort 'Prevented broken commit' if rspec_executor.errors?
       end
+
+      protected
+
+      attr_reader :git_repository, :rspec_executor
     end
   end
 end

data/lib/git_hooks/pre_commit/rubocop.rb

@@ -1,32 +1,73 @@
 module GitHooks
   module PreCommit
     class Rubocop
-      attr_reader :git_repository, :rubocop_validator
+      RUBOCOP_STASH_NAME = 'rubocop-stash'
 
-      def self.validate
+      def self.validate(options = {})
         new(
-          GitHooks.configurations.git_repository, RubocopValidator.new
+          GitHooks.configurations.git_repository,
+          RubocopValidator.new,
+          options
         ).validate
       end
 
-      def initialize(git_repository, rubocop_validator)
-        @git_repository, @rubocop_validator = git_repository, rubocop_validator
+      def initialize(git, rubocop_validator, options = {})
+        @git = git
+        @rubocop_validator = rubocop_validator
+        @options = options
       end
 
       def validate
         abort 'Check rubocop offences' if offences?
       end
 
+      protected
+
+      attr_reader :git, :rubocop_validator, :options
+
       private
 
       def changed_files
-        git_repository
+        git
           .added_or_modified
-          .select { |file| File.extname(file) == '.rb' }
+          .select(&ruby_files)
       end
 
       def offences?
-        rubocop_validator.errors?(changed_files)
+        stash_me_maybe { rubocop_validator.errors?(changed_files) }
+      end
+
+      def ruby_files
+        -> (file) { File.extname(file) == '.rb' }
+      end
+
+      def stash_me_maybe(&blk)
+        return yield unless stash_around?
+
+        stash_around(&blk)
+      end
+
+      def stash_around
+        git.repository.lib.stash_save(RUBOCOP_STASH_NAME)
+        yield
+      ensure
+        git.repository.lib.stash_pop(rubocop_stash_id) if rubocop_stash?
+      end
+
+      def stash_around?
+        options['use_stash']
+      end
+
+      def rubocop_stash?
+        rubocop_stash_id
+      end
+
+      def rubocop_stash_id
+        Array(
+          git.repository.lib
+            .stashes_all
+            .rassoc(RUBOCOP_STASH_NAME)
+        ).first
       end
     end
   end

data/lib/git_hooks/pre_commit/trailing_whitespace.rb

@@ -3,7 +3,7 @@ module GitHooks
     class TrailingWhitespace
       attr_reader :git_repository, :trailing_whitespace_validator
 
-      def self.validate
+      def self.validate(*)
         new(
           GitHooks.configurations.git_repository,
           TrailingWhitespaceValidator.new

data/lib/git_hooks/version.rb

@@ -1,3 +1,3 @@
 module GitHooks
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/fixtures/git_hooks.yml

@@ -1,4 +1,5 @@
 ---
 pre_commits:
-- foo
-- bar
+  Rubocop:
+    use_stash: true
+  Rspec:

data/spec/git-hooks_spec.rb

@@ -0,0 +1,121 @@
+describe GitHooks do
+  subject(:git_hooks) { described_class }
+
+  let(:configs) do
+    GitHooks::Configurations.new(config_file: config_file)
+  end
+
+  let(:config_file) do
+    GitHooks::ConfigFile.new(fixture_path('git_hooks.yml'))
+  end
+
+  before do
+    GitHooks.configurations = configs
+    allow($stdout).to receive(:write)
+  end
+
+  describe '#validate_hooks!' do
+    subject { -> { git_hooks.validate_hooks! } }
+
+    let(:installed?) { true }
+    let(:installer) { instance_double(GitHooks::Installer) }
+
+    before do
+      allow(GitHooks::Installer)
+        .to receive(:new)
+        .with(GitHooks::PRE_COMMIT)
+        .and_return(installer)
+    end
+
+    before do
+      allow(installer).to receive(:installed?).and_return(installed?)
+    end
+
+    it { is_expected.to_not raise_error }
+
+    context 'but without pre-commit installed' do
+      let(:installed?) { false }
+
+      let(:message) do
+        "Please install pre-commit hook with `git_hooks install pre-commit'"
+      end
+
+      it do
+        is_expected.to raise_error(GitHooks::Exceptions::MissingHook, message)
+      end
+    end
+  end
+
+  describe '.base_path' do
+    subject { described_class.base_path }
+
+    it "has gem's root path" do
+      is_expected.to eq(
+        File.absolute_path(
+          File.join(File.expand_path(__FILE__), '..', '..')
+        )
+      )
+    end
+  end
+
+  describe '.configurations' do
+    subject(:configurations) { described_class.configurations }
+
+    before { GitHooks.configurations = nil }
+
+    let(:configs) { double(:probe) }
+
+    it 'creates with default params' do
+      expect(GitHooks::Configurations)
+        .to receive(:new)
+        .with(no_args)
+        .and_return(configs)
+
+      is_expected.to eq(configs)
+    end
+  end
+
+  describe 'configurations=' do
+    subject { -> { GitHooks.configurations = configs } }
+
+    let!(:configs) { double(:probe) }
+
+    before { GitHooks.configurations = nil }
+    after { GitHooks.configurations = nil }
+
+    it 'updates configurations' do
+      is_expected.to change { GitHooks.configurations }.to(configs)
+    end
+  end
+
+  describe '#execute_pre_commits' do
+    subject(:execute_pre_commits) { GitHooks.execute_pre_commits }
+
+    let(:rubocop_options) do
+      { 'use_stash' => true }
+    end
+
+    before do
+      allow(GitHooks::PreCommit::Rspec).to receive(:validate)
+      allow(GitHooks::PreCommit::Rubocop).to receive(:validate)
+    end
+
+    it 'instantiates each pre commit' do
+      expect(GitHooks::PreCommit).to receive(:const_get)
+        .with('Rubocop').and_call_original
+      expect(GitHooks::PreCommit).to receive(:const_get)
+        .with('Rspec').and_call_original
+
+      execute_pre_commits
+    end
+
+    it 'validates the hook, passing its options when available' do
+      expect(GitHooks::PreCommit::Rubocop).to receive(:validate)
+        .with(rubocop_options)
+      expect(GitHooks::PreCommit::Rspec).to receive(:validate)
+        .with(nil)
+
+      execute_pre_commits
+    end
+  end
+end

data/spec/git_hooks/config_file_spec.rb

@@ -4,7 +4,12 @@ module GitHooks
 
     let(:path) { 'some-not-existent-file' }
     let(:content) { { 'pre_commits' => pre_commits } }
-    let(:pre_commits) { %w(foo bar) }
+    let(:pre_commits) do
+      {
+        'Rubocop' => { 'use_stash' => true },
+        'Rspec' => nil
+      }
+    end
 
     describe '#pre_commits' do
       subject { config.pre_commits }
@@ -12,11 +17,11 @@ module GitHooks
       let(:path) { fixture_path('git_hooks.yml') }
 
       it 'has the pre commits specified on hook file' do
-        is_expected.to eq(%w(foo bar))
+        is_expected.to eq(pre_commits)
       end
 
       context 'when the given file does not exist' do
-        let(:path) { 'some-not-existent-file' }
+        let(:path) { 'some-non-existing-file' }
 
         it { is_expected.to eq([]) }
       end

data/spec/git_hooks/pre_commit/rspec_spec.rb

@@ -1,7 +1,7 @@
 module GitHooks
   module PreCommit
     describe Rspec do
-      subject(:rspec) { described_class.new git_repository, rspec_executor }
+      subject(:rspec) { described_class.new(git_repository, rspec_executor) }
 
       let(:git_repository) do
         instance_double(GitHooks::Git, clean?: clean?)

data/spec/git_hooks/pre_commit/rubocop_spec.rb

@@ -44,6 +44,44 @@ module GitHooks
 
           it { expect(-> { validate }).to_not raise_error }
         end
+
+        context 'with stash option' do
+          let(:rubocop) do
+            described_class.new(
+              git_repository, rubocop_validator, 'use_stash' => true
+            )
+          end
+
+          let(:repository) { instance_double(::Git::Base) }
+          let(:lib) { instance_double(::Git::Lib) }
+
+          before do
+            allow(repository).to receive(:lib).and_return(lib)
+            allow(git_repository).to receive(:repository).and_return(repository)
+            allow(lib).to receive(:stash_save).and_return(true)
+            allow(lib).to receive(:stash_pop).and_return(true)
+            allow(lib).to receive(:stashes_all).and_return([[0, 'rubocop-stash']])
+          end
+
+          it 'stashes working directory changes and reapplies them' do
+            expect(lib).to receive(:stash_save).with('rubocop-stash')
+            expect(lib).to receive(:stash_pop)
+
+            expect(-> { validate }).not_to raise_error
+          end
+
+          context 'with validation error' do
+            let(:errors?) { true }
+
+            it 'stashes working directory changes and reapplies them' do
+              expect(lib).to receive(:stash_save).with('rubocop-stash')
+              expect(lib).to receive(:stash_pop)
+
+              expect(-> { validate }).to raise_error(SystemExit)
+                .and output("Check rubocop offences\n").to_stderr
+            end
+          end
+        end
       end
 
       describe '.validate' do
@@ -62,7 +100,7 @@ module GitHooks
         end
 
         it 'creates object with git_repository and rubocop_validator' do
-          expect(Rubocop).to receive(:new).with(git, rubocop_validator)
+          expect(Rubocop).to receive(:new).with(git, rubocop_validator, {})
 
           validate
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-hooks
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rafael da Silva Almeida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -130,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".git_hooks.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -138,6 +139,7 @@ files:
 - CHANGELOG
 - Gemfile
 - README.md
+- Rakefile
 - bin/git_hooks
 - git-hooks.gemspec
 - git_hooks.yml.example
@@ -162,6 +164,7 @@ files:
 - lib/git_hooks/trailing_whitespace_validator.rb
 - lib/git_hooks/version.rb
 - spec/fixtures/git_hooks.yml
+- spec/git-hooks_spec.rb
 - spec/git_hooks/config_file_spec.rb
 - spec/git_hooks/configurations_spec.rb
 - spec/git_hooks/git_spec.rb
@@ -174,7 +177,6 @@ files:
 - spec/git_hooks/rspec_executor_spec.rb
 - spec/git_hooks/rubocop_validator_spec.rb
 - spec/git_hooks/trailing_space_validator.rb
-- spec/git_hooks_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/stupied4ever/ruby-git-hooks
 licenses:
@@ -202,6 +204,7 @@ specification_version: 4
 summary: Help to keep git hooks organized.
 test_files:
 - spec/fixtures/git_hooks.yml
+- spec/git-hooks_spec.rb
 - spec/git_hooks/config_file_spec.rb
 - spec/git_hooks/configurations_spec.rb
 - spec/git_hooks/git_spec.rb
@@ -214,6 +217,5 @@ test_files:
 - spec/git_hooks/rspec_executor_spec.rb
 - spec/git_hooks/rubocop_validator_spec.rb
 - spec/git_hooks/trailing_space_validator.rb
-- spec/git_hooks_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/git_hooks_spec.rb

@@ -1,89 +0,0 @@
-describe GitHooks do
-  describe '#validate_hooks!' do
-    subject { -> { described_class.validate_hooks! } }
-
-    before do
-      allow(GitHooks::Installer)
-        .to receive(:new)
-        .with(GitHooks::PRE_COMMIT)
-        .and_return(installer)
-
-      GitHooks.configurations = configs
-    end
-
-    let(:configs) do
-      GitHooks::Configurations.new(config_file: config_file)
-    end
-
-    let(:config_file) do
-      GitHooks::ConfigFile.new(fixture_path('git_hooks.yml'))
-    end
-
-    let(:installed?) { true }
-    let(:installer) { instance_double(GitHooks::Installer) }
-
-    before do
-      allow(installer).to receive(:installed?).and_return(installed?)
-    end
-
-    it { is_expected.to_not raise_error }
-
-    context 'but without pre-commit installed' do
-      let(:installed?) { false }
-
-      let(:message) do
-        "Please install pre-commit hook with `git_hooks install pre-commit'"
-      end
-
-      it do
-        is_expected.to raise_error(GitHooks::Exceptions::MissingHook, message)
-      end
-    end
-  end
-
-  describe '.base_path' do
-    subject { described_class.base_path }
-
-    it "has gem's root path" do
-      is_expected.to eq(
-        File.absolute_path(
-          File.join(File.expand_path(__FILE__), '..', '..')
-        )
-      )
-    end
-  end
-
-  describe '.configurations' do
-    subject(:configurations) { described_class.configurations }
-
-    before { GitHooks.configurations = nil }
-
-    let(:configs) { instance_double(GitHooks::Configurations) }
-
-    it 'creates with default params' do
-      expect(GitHooks::Configurations)
-        .to receive(:new)
-        .with(no_args)
-        .and_return(configs)
-
-      is_expected.to eq(configs)
-    end
-  end
-
-  describe 'configurations=' do
-    subject(:set_configurations) { GitHooks.configurations = configs }
-
-    let(:configs) { instance_double(GitHooks::Configurations) }
-
-    before do
-      GitHooks.configurations = nil
-      allow(GitHooks::Configurations).to receive(:new).and_return(nil)
-    end
-
-    it 'updates configurations' do
-      expect { set_configurations }.to change {
-        GitHooks.configurations
-      }.to(configs)
-    end
-  end
-end