hookspec 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afc57729bc6b91c5eba0e84e859146e4186f6014
-  data.tar.gz: 20c9320c3132f0eb7b828a4f7d7a8277d7492d8f
+  metadata.gz: 841483393b2aee20b0bf2547b0f8ccbfc36ccafe
+  data.tar.gz: c34b2e0bd560c367da38b76be5559c464bc1a6b0
 SHA512:
-  metadata.gz: 7be531ad357f544dc8df8ec9f8a29595d69e1e924c5627abf1bcf09b3bd7bc8db1664b271327fde63c368f2e1e1b7c398adc4c69211b2a32a402e118cf388da9
-  data.tar.gz: 4b47c06432e9d6f7aedc7955642bb8ec957b40813915f8cfbe284dc367e24decbee28525c7e4aeabc40c457a8530aca30395dab7fcd622a2cbfa54bf6eec4933
+  metadata.gz: 6dcf1d20a384fbae7c42fdafb9564d4649f50e4a66bb8d9ca4b161947a1e6c961adf0f68c810a6715547d7dc571d990f5600f31a149510b8e4377cd63717b073
+  data.tar.gz: 3b4cf3fe649ec433932608823b212390e9b0928fe596c80bc1c381a197a82fb71912683a624633cb5e9786681fcb6356641c353fe0c3d0257822ab53c712f69e

data/README.md

@@ -3,7 +3,7 @@ hookspec
 
 ## Lastest version
 
-v1.0.0(beta)
+v1.1.0(beta)
 
 ## About
 
@@ -25,15 +25,37 @@ After hookspec gem is installed, you can use 'hookspec' command. Execute the com
 
 New a spec file under git\_hooks/[hook\_type]/ named like _FILENAME_\_spec.rb
 
-    # assert branch is not master branch
-    require 'hookspec'
+### Sample: Check push branch
 
-    describe "push" do
-      let (:git_env) {HookSpec::GitEnv.new}
-      it 'master branch can not be pushed' do
-        expect(git_env).not_to be_branch('master')
+```ruby
+# assert branch is not master branch
+require 'hookspec'
+
+describe "push" do
+  let (:git_env) {HookSpec::GitEnv.new}
+  it 'master branch can not be pushed' do
+    expect(git_env).not_to be_branch('master')
+  end
+end
+```
+
+### Sample: Check with rubocop
+
+`install rubocop first`
+
+```ruby
+describe "rubocop check" do
+  let (:git_env) {HookSpec::GitEnv.new}
+  it 'rubocop must pass' do
+    git_env.diff(model: 'cached', filter: 'AM').each do |f| 
+      if f.end_with?('.rb')
+        `rubocop #{f}`
+        expect($?).to be_nil
       end
     end
+  end
+end
+```
 
 ## Supported hook\_type
 
@@ -62,15 +84,17 @@ New a spec file under git\_hooks/[hook\_type]/ named like _FILENAME_\_spec.rb
 
 #### how to validate include certain file or not
 
-    it 'show not include certain files' do
-      expect(git_env.diffs_of_local[:D]).not_to include_file('README.md')
+    it 'commit not delete certain files' do
+      expect(git_env.diff(model: 'cached', filter: 'D').not_to include_file('README.md')
     end
 
-Provide three diff type of diffs:
+* use git\_env.diff(model: `model_name`, filter: `filters`)
+* filters: A|C|D|M|R|T|U|X|B
 
-* git\_env.diffs\_of\_local: unstaged files hashed by status types(A|C|D|M|R|T|U|X|B)
-* git\_env.diffs\_of\_cached: cached files hashed by status types(A|C|D|M|R|T|U|X|B)
-* git\_env.diffs\_of\_commited: last commited files hashed by status types(A|C|D|M|R|T|U|X|B)
+```ruby
+# get cached file list with filter 'AM'
+git_env.diff(model: 'cached', filter: 'AM')
+```
 
 #### how to get git configure
 

data/lib/hookspec/git_env.rb

@@ -4,84 +4,51 @@ module HookSpec
     AGAINST = '4b825dc642cb6eb9a060e54bf8d69288fbee4904'
 
     def initialize
-      @current_branch    = nil
-      @cached_diffs_info = nil
-      @commit_diffs_info = nil
-      @local_diffs_info  = nil
-      @all_files         = nil
     end
 
     def current_branch
-      return @current_branch unless @current_branch.nil?
-      @current_branch = `git rev-parse --abbrev-ref HEAD`.chomp!
+      `git rev-parse --abbrev-ref HEAD`.chomp
     end
 
     def files
-      return @all_files unless @all_files.nil?
-      @all_files = `git ls-files`.chomp!.split
+      `git ls-files`.chomp.split
     end
 
-    # diff files with status
-    def diffs_of_commit
-      return @commit_diffs_info unless @commit_diffs_info.nil?
-
-      against = get_against
-
-      diff = `git diff HEAD^ HEAD --name-status`.chomp!
-      @commit_diffs_info = classify(diff)
-    end
-
-    def diffs_of_cached
-      return @cached_diffs_info unless @cached_diffs_info.nil?
-
-      diff = `git diff --cached --name-status`.chomp!
-      @cached_diffs_info = classify(diff)
-    end
-
-    def diffs_of_local
-      return @local_diffs_info unless @local_diffs_info.nil?
-
-      diff = `git diff --name-status`.chomp!
-      @local_diffs_info = classify(diff)
+    # git diff {--cached} --name-only {--diff-filter=}
+    def diff model: nil, filter: nil
+      cmd = 'git diff '
+      if !model.nil? && model.downcase == 'cached'
+        cmd = cmd + '--cached '
+      end
+      cmd = cmd + '--name-only '
+      if !filter.nil?
+        cmd = cmd + '--diff-filter=' + filter
+      end
+      `#{cmd}`.chomp.split
     end
 
-
     # git confs
     def conf_of conf_name
-      return `git config #{conf_name}`.chomp!
+      `git config #{conf_name}`.chomp
     end
 
     def white_spaces
       against = get_against
 
-      return `git diff-index --check --cached #{against} --`.chomp!
+      `git diff-index --check --cached #{against} --`.chomp
     end
 
     def exec cmd
-      return `#{cmd}`.chomp!
+      `#{cmd}`.chomp
     end
 
     private
 
-    def classify diffs
-      classified = {}
-      diffs.each_line(separator = $/) do |line|
-        Hash[*line.split].each_pair do |key, value|
-          if classified[key.to_sym].nil?
-            classified[key.to_sym] = [value]
-          else
-            classified[key.to_sym] << value
-          end
-        end
-      end
-      return classified
-    end
-
     def get_against
       if `git rev-parse --verify HEAD >/dev/null 2>&1`
-        return 'HEAD'
+        'HEAD'
       else
-        return AGAINST
+        AGAINST
       end
     end
   end

data/lib/hookspec/version.rb

@@ -1,3 +1,3 @@
 module HookSpec
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hookspec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - wills