git-hooks 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e07e1353c42ad407566f44a3cc3339ca748f70d
-  data.tar.gz: fd51f0a58982531b6109b4816fecd8839a3cd4fe
+  metadata.gz: 134a66f85a7fbcb6e4d5edbb6be43b7aaa210c75
+  data.tar.gz: 7dd95a4d4f3d174146ae10f718844663e422bc1c
 SHA512:
-  metadata.gz: b24efcfec922f5d3053b1761f2f8a40874f875429f43fa52bbe9f9509ac6b121c24bd039a054abefd69eefa5e4fab7e219a8428157ad4b7f7a8dd09fce14e6a7
-  data.tar.gz: d6b4df7bba7a3f3d2faeb7df0bf660b0157548352e1c806e466cb6d87de6978fd1b4ea60f9dcb3645553bba18cc79ac6747696f68bc49f9ab9ff74e713529b71
+  metadata.gz: 7396e5185a8e6c14e55b1ef9c661e303f73fc17301ae4e4734a9dd63891143c1113934d3eb9c7ff7979b69860df345ab06fcfc479cb8c9f146edb36b7e3b694e
+  data.tar.gz: 1595ef10574f31d95ee5d09057cac9792a7d97db2d9035e6f254c755cce0b6088419b6fad0dae70696d4c52685a2c56d43b3e3c8f1248372086f214406215446

data/CHANGELOG

@@ -1,9 +1,3 @@
-0.2.1
-
-* Change Exceptions::MissingHook message
-* Add trailing_whitespace on readme and yaml example
-* Fix undefined method `git_repository'
-
 0.2.0
 
 * Add whitespace validation (by @rranelli)

data/README.md

@@ -6,11 +6,12 @@
 
 # GitHooks
 
-Some usefull git hooks, it's written on ruby but can be used for other languages.
+Some usefull git hooks, it's written on ruby but can be used for other
+languages.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
     gem 'git-hooks'
 
@@ -23,9 +24,10 @@ Or install it yourself as:
     $ gem install git-hooks
 
 ## Usage
-### Install git_hooks on project.
+### Install git_hooks on your project.
 
 ```bash
+$ cd /path/to/project
 $ git_hooks install pre-commit [--force]
 ```
 
@@ -34,28 +36,30 @@ $ git_hooks install pre-commit [--force]
 Create a `.git_hooks.yml` on project root.
 
 ```bash
+$ cd /path/to/project
 $ git_hooks init
 ```
 
-By now you will find only some simple hooks to:
+By now you will find the following built-in hooks:
 
- - Prevent commit on master.
- - Prevent commit with rubocop offences.
- - Prevent commit with broken rspec tests.
- - Prevent commit with debugger
- - Prevent trailing whitespace
+ - Prevent commits on master branch.
+ - Prevent commits with rubocop offenses.
+ - Prevent commits with broken rspec tests.
+ - Prevent commits with debugger.
+ - Prevent commits with trailing white space.
 
 ### Ensure hooks existence
 
-To ensure that hooks exists on `.git/hooks`, include on your application
-start up (probably  `config/environments/development.rb` or
-`config/environments/test.rb`)
+To ensure that hooks exists on `.git/hooks`, include this line
 
 ```ruby
 GitHooks.validate_hooks!
 ```
 
-This will force `git_hooks` installation before your application start.
+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/lib/git-hooks.rb

@@ -23,6 +23,7 @@ module GitHooks
 
     def execute_pre_commits
       configurations.pre_commits.each do |pre_commit|
+        puts "Executing #{pre_commit}"
         GitHooks::PreCommit.const_get(pre_commit).validate
       end
     end

data/lib/git_hooks/pre_commit/prevent_debugger.rb

@@ -12,23 +12,31 @@ module GitHooks
       end
 
       def validate
-        abort 'Prevented to commit with debugger' if any_debugger?
+        abort(
+          "Prevented commit with debugger in #{files_with_debugger}"
+        ) if files_with_debugger.any?
       end
 
       private
 
-      def any_debugger?
-        git_repository.added_or_modified.any? do |file_name|
-          File.read(file_name) =~ debugger_regex
-        end
+      def files_with_debugger
+        git_repository
+          .added_or_modified
+          .select(&ruby_files)
+          .select(&contains_debugger?)
+      end
+
+      def ruby_files
+        -> (file) { File.extname(file) == '.rb' }
+      end
+
+      def contains_debugger?
+        -> (file) { File.read(file) =~ debugger_regex }
       end
 
       def debugger_regex
         Regexp.union(
-          %w(
-            binding.pry binding.remote_pry
-            save_and_open_page debugger
-          )
+          %w(binding.pry binding.remote_pry save_and_open_page debugger)
         )
       end
     end

data/lib/git_hooks/pre_commit/trailing_whitespace.rb

@@ -16,19 +16,21 @@ module GitHooks
       end
 
       def validate
-        abort 'Check presence of trailling space' if offences?
+        abort(
+          "Prevented commit with trailing whitespace in files #{offenses}"
+        ) if offenses.any?
       end
 
-      private
-
       def changed_files
         git_repository
           .added_or_modified
           .select { |file| File.extname(file) == '.rb' }
       end
 
-      def offences?
-        trailing_whitespace_validator.errors?(changed_files)
+      def offenses
+        changed_files.map do |file|
+          trailing_whitespace_validator.errors?([file])
+        end
       end
     end
   end

data/lib/git_hooks/version.rb

@@ -1,3 +1,3 @@
 module GitHooks
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/git_hooks/pre_commit/prevent_debugger_spec.rb

@@ -36,6 +36,12 @@ module GitHooks
 
             it { is_expected.to raise_error(SystemExit) }
           end
+
+          context 'when the modified file is not a ruby code file' do
+            let(:files) { ['some_text_file.txt'] }
+
+            it { is_expected.not_to raise_error }
+          end
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-hooks
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Rafael da Silva Almeida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop