hookspec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6249c3de2e45bc9b03ac662f1927cf10cec74af8
+  data.tar.gz: 36aae9238098865dd1ef77a8d89d6e6ab5fef90e
+SHA512:
+  metadata.gz: 7918e9880cae12db1e6f2228404359558721e78f928878685b36086f622d499b883bae47926179b7c232dbde3487bec3d3d2ab35b25f807468cc5721f461f74a
+  data.tar.gz: 9b9fcbf6ec39c7bc73b51e2015e5977a9e4461b3828509ac2aaad3b18de7156b72141c64d45e58273fdbbc39050db4b2c940d6ae898b6efa1954d89cf1c88695

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hookspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    hookspec (0.0.2)
+      rspec (>= 2.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  hookspec!
+  rake

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 fdwills
+
+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,91 @@
+hookspec
+====================
+
+## Lastest version
+
+v1.0.0(beta)
+
+## About
+
+As the name, hookspec is an git hook test tool. Write hooks like test!
+
+## Install
+
+    gem install hookspec
+
+or include in Gemfile
+
+    gem 'hookspec'
+
+After hookspec gem is installed, you can use 'hookspec' command. Execute the command to initialize hookspec:
+
+    bundle exec hookspec install
+
+## Usage
+
+New a spec file under git\_hooks/[hook\_type]/ named like _FILENAME_\_spec.rb
+
+    # 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
+
+## Supported hook\_type
+
+* applypatch-msg
+* pre-commit
+* post-update
+* prepare-commit-msg
+* commit-msg
+* pre-push
+* pre-applypatch
+* update
+* post-push
+* pre-rebase
+
+## Samples
+
+#### how to new get a git envirnment install
+
+    git_env = HookSpec::GitEnv.new
+
+#### how to validate branch name
+
+    it 'master branch can not be pushed' do
+      expect(git_env).not_to be_branch('master')
+    end
+
+#### 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')
+    end
+
+Provide three diff type of diffs:
+
+* 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)
+
+#### how to get git configure
+
+    it 'pull rebase must be setted' do
+      expect(git_env.conf_of("pull.rebase")).to eql 'true'
+    end
+
+#### how to execute git commands
+
+    git_env.exec("git status")
+
+#### More...
+
+_More features_ are to be continued...
+
+## commit
+
+fork and send pull-request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/bin/hookspec

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'hookspec/all'
+HookSpec::Application.new.run

data/hookspec.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path(File.join(File.dirname(__FILE__),'lib/'))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'hookspec/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'hookspec'
+  s.version     = HookSpec::VERSION
+  s.date        = '2014-03-06'
+  s.summary     = "git hooks by spec"
+  s.description = "write git hooks like spec"
+  s.authors     = ["wills"]
+  s.email       = 'weirenzhong@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/fdwills/hookspec'
+  s.license     = 'MIT'
+  s.executables << 'hookspec'
+
+  s.add_runtime_dependency "rspec", ">= 2.13.0"
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+end

data/lib/hookspec.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rspec'
+require 'hookspec/all'
+

data/lib/hookspec/all.rb

@@ -0,0 +1,11 @@
+require 'rake'
+
+Rake.application.options.trace = true
+
+require 'hookspec/version'
+require 'hookspec/application'
+require 'hookspec/matchers'
+require 'hookspec/git_env'
+
+module HookSpec
+end

data/lib/hookspec/application.rb

@@ -0,0 +1,21 @@
+module HookSpec
+  class Application < Rake::Application
+
+    def initialize
+      super
+      @branch = `git rev-parse --abbrev-ref HEAD`.chomp!
+      @diffs_info = {}
+      @all_files = []
+    end
+
+    def run
+      Rake.application = self
+      super
+    end
+
+    def load_rakefile
+      load File.expand_path(File.join(File.dirname(__FILE__),'tasks/install.rake'))
+    end
+
+  end
+end

data/lib/hookspec/git_env.rb

@@ -0,0 +1,88 @@
+module HookSpec
+  class GitEnv
+    #an empty tree object hash
+    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!
+    end
+
+    def files
+      return @all_files unless @all_files.nil?
+      @all_files = `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)
+    end
+
+
+    # git confs
+    def conf_of conf_name
+      return `git config #{conf_name}`.chomp!
+    end
+
+    def white_spaces
+      against = get_against
+
+      return `git diff-index --check --cached #{against} --`.chomp!
+    end
+
+    def exec cmd
+      return `#{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'
+      else
+        return AGAINST
+      end
+    end
+  end
+end

data/lib/hookspec/install.rb

@@ -0,0 +1 @@
+load File.expand_path(File.join(File.dirname(__FILE__),'tasks/install.rake'))

data/lib/hookspec/matchers.rb

@@ -0,0 +1,2 @@
+require 'hookspec/matchers/be_branch'
+require 'hookspec/matchers/include_file'

data/lib/hookspec/matchers/be_branch.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+RSpec::Matchers.define :be_branch do |branch|
+  match do |git_env|
+    git_env.current_branch.eql?(branch)
+  end
+end

data/lib/hookspec/matchers/include_file.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+RSpec::Matchers.define :include_file do |file_name|
+  match do |files|
+    files.empty? || files.any?{ |f| f.eql? file_name }
+  end
+end

data/lib/hookspec/tasks/install.rake

@@ -0,0 +1,61 @@
+require 'erb'
+require 'pathname'
+
+desc 'Install hookspec...'
+task :install do
+
+  unless File.exist?('.git') && File.directory?('.git')
+    puts '''
+Current dirctory is not in a git repo Or
+Current dirctory is not git repo root dirctory!
+'''
+    exit 1
+  end
+
+  hooks = %w{
+    applypatch-msg
+    pre-applypatch
+    prepare-commit-msg
+    commit-msg
+    pre-commit
+    update
+    post-update
+    pre-rebase
+    pre-push
+    post-push
+  }
+
+  hook_dir = Pathname.new('git_hooks')
+  hook_bk_dir = Pathname.new('.git/hooks/bak')
+
+  mkdir_p hook_dir
+  mkdir_p hook_bk_dir
+
+  hooks.each do |hook|
+    # copy hook.sh
+    mv(".git/hooks/#{hook}", ".git/hooks/#{hook}.bk")
+    sh_template = File.read (File.expand_path("../../templates/" + hook + ".sh", __FILE__) )
+    File.open(".git/hooks/#{hook}", 'w+') do |f|
+      f.write(ERB.new(sh_template).result(binding))
+      f.close
+    end
+    chmod(0755, ".git/hooks/#{hook}")
+
+    # mkdir hook/
+    sub_dir = Pathname.new("git_hooks/" + hook + "/")
+    mkdir_p sub_dir
+
+    # copy hook/sample.rb.erb
+    template = File.read( File.expand_path("../../templates/" + hook + "/sample.rb", __FILE__) )
+    file = sub_dir.join('sample.rb.erb')
+    File.open(file, 'w+') do |f|
+      f.write(ERB.new(template).result(binding))
+      f.close
+    end
+  end
+  puts '''
+=================
+install done !
+installed to git_hooks/ !
+'''
+end

data/lib/hookspec/templates/applypatch-msg.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/applypatch-msg/

data/lib/hookspec/templates/applypatch-msg/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/commit-msg.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/commit-msg/

data/lib/hookspec/templates/commit-msg/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/post-push.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/post-push/

data/lib/hookspec/templates/post-push/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/post-update.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/post-update/

data/lib/hookspec/templates/post-update/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/pre-applypatch.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/pre-applypatch/

data/lib/hookspec/templates/pre-applypatch/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/pre-commit.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/pre-commit/

data/lib/hookspec/templates/pre-commit/sample.rb

@@ -0,0 +1,12 @@
+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
+
+  it 'show white spaces errors' do
+    puts git_env.white_spaces
+  end
+end

data/lib/hookspec/templates/pre-push.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/pre-push/

data/lib/hookspec/templates/pre-push/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/pre-rebase.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/pre-rebase/

data/lib/hookspec/templates/pre-rebase/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/templates/prepare-commit-msg.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/prepare-commit-msg/

data/lib/hookspec/templates/prepare-commit-msg/sample.rb

@@ -0,0 +1,17 @@
+require 'hookspec'
+describe "push messages" do
+  let (:git_env) {HookSpec::GitEnv.new}
+  it 'out put all diffs' do
+    git_env.diffs_of_commit.each do |key, value|
+      case key
+      when :A, :a
+        puts "add file"
+      when :M, :m
+        puts "modify file"
+      when :D, :d
+        puts "delete file"
+      end
+      values.each { |file_name| puts file_name }
+    end
+  end
+end

data/lib/hookspec/templates/update.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle exec rspec git_hooks/update/

data/lib/hookspec/templates/update/sample.rb

@@ -0,0 +1,7 @@
+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

data/lib/hookspec/version.rb

@@ -0,0 +1,3 @@
+module HookSpec
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: hookspec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- wills
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: write git hooks like spec
+email: weirenzhong@gmail.com
+executables:
+- hookspec
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/hookspec
+- hookspec.gemspec
+- lib/hookspec.rb
+- lib/hookspec/.git_env.rb.swp
+- lib/hookspec/all.rb
+- lib/hookspec/application.rb
+- lib/hookspec/git_env.rb
+- lib/hookspec/install.rb
+- lib/hookspec/matchers.rb
+- lib/hookspec/matchers/be_branch.rb
+- lib/hookspec/matchers/include_file.rb
+- lib/hookspec/tasks/install.rake
+- lib/hookspec/templates/applypatch-msg.sh
+- lib/hookspec/templates/applypatch-msg/sample.rb
+- lib/hookspec/templates/commit-msg.sh
+- lib/hookspec/templates/commit-msg/sample.rb
+- lib/hookspec/templates/post-push.sh
+- lib/hookspec/templates/post-push/sample.rb
+- lib/hookspec/templates/post-update.sh
+- lib/hookspec/templates/post-update/sample.rb
+- lib/hookspec/templates/pre-applypatch.sh
+- lib/hookspec/templates/pre-applypatch/sample.rb
+- lib/hookspec/templates/pre-commit.sh
+- lib/hookspec/templates/pre-commit/sample.rb
+- lib/hookspec/templates/pre-push.sh
+- lib/hookspec/templates/pre-push/sample.rb
+- lib/hookspec/templates/pre-rebase.sh
+- lib/hookspec/templates/pre-rebase/sample.rb
+- lib/hookspec/templates/prepare-commit-msg.sh
+- lib/hookspec/templates/prepare-commit-msg/sample.rb
+- lib/hookspec/templates/update.sh
+- lib/hookspec/templates/update/sample.rb
+- lib/hookspec/version.rb
+homepage: https://github.com/fdwills/hookspec
+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.0.3
+signing_key: 
+specification_version: 4
+summary: git hooks by spec
+test_files: []