git-hooks-helper 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+gitt-hooks-helper-*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+gemspec
+gem 'rspec'
+gem 'pry'
+gem 'rails_best_practices'

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    git-hooks-helper (0.0.1)
+      rails-erb-check
+      rails_best_practices
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.11)
+    builder (2.1.2)
+    coderay (0.9.8)
+    colored (1.2)
+    diff-lcs (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    method_source (0.6.7)
+      ruby_parser (>= 2.3.1)
+    progressbar (0.9.1)
+    pry (0.9.7.4)
+      coderay (~> 0.9.8)
+      method_source (~> 0.6.7)
+      ruby_parser (>= 2.3.1)
+      slop (~> 2.1.0)
+    rack (1.2.4)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails-erb-check (0.1.0)
+      actionpack (~> 3.0)
+    rails_best_practices (1.3.0)
+      activesupport
+      colored
+      erubis
+      i18n
+      progressbar
+      sexp_processor
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.10)
+    slop (2.1.0)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git-hooks-helper!
+  pry
+  rails_best_practices
+  rspec

data/HISTORY

@@ -0,0 +1 @@
+2012-01-20 Initial release 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Martynas Margis
+
+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

@@ -0,0 +1,50 @@
+Instalation
+-----------
+  gem install git-hooks-helper
+
+File clasification
+------------------
+
+Most commands use file classes internally or accept type class as a param.
+File type classes and associated file extensions:
+1. :rb  - .rb .rake .task .prawn
+2. :js  - .js
+3. :erb - .erb
+
+Usage
+-----
+Create your hit hook in .git/hooks directory and make it executable.
+
+My example pre-commit hook that i use myself.
+To create such a hook type in console:
+
+  cd your/project/
+  touch .git/hooks/pre-commit
+  chmod +x .git/hooks/pre-commit
+  vim .git/hooks/pre-commit
+
+and paste following code:
+
+
+```ruby
+  #!/usr/bin/env ruby
+
+  require "git-hooks-helper"
+
+  GitHooksHelper.results do
+    # fail/pass options
+    # stop_on_warnings                                   # makes git commit fail if any warnings are found
+    # never_stop                                         # hooks never fails commits
+    # list_files                                         # shows list of all changed files
+
+    # schecks
+    check_ruby_syntax                                    # errors when ruby syntax has errors
+    check_erb                                            # errors when ERB syntax has errors
+    check_best_practices                                 # warnings when ruby best practices are violated
+    warning_on "WTF?", "binding.pry", "<<<<<<<"          # warnings when any of these texts are present in any commited files
+    warning_on "console.log", "debugger", {:in => [:js]} # warning when any of these texts are present in JS files
+
+    # messages
+    info "Run rspec tests and have a nice day."
+  end
+```

data/README.md

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "git-hooks-helper"
+
+GitHooksHelper.results do
+  do_not_stop_on_warnings
+
+  check_ruby_syntax
+  check_erb
+  check_best_practices
+  warning_on "WTF?", "binding.pry", "<<<<<<<"
+  warning_on "console.log", "debugger", {:in => [:js]}
+
+  info "Run rspec tests and have a nice day."
+end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/git-hooks-helper.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "git-hooks-helper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "git-hooks-helper"
+  s.version     = GitHooksHelper::VERSION
+  s.authors     = ["Martynas Margis"]
+  s.email       = []
+  s.homepage    = ""
+  s.summary     = %q{Small gem to help write simple git hooks}
+  s.description = %q{Gem for creating simple git hooks in ruby.}
+
+  s.rubyforge_project = "git-hooks-helper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+#  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "rails-erb-check"
+  s.add_runtime_dependency "rails_best_practices"
+end

data/lib/git-hooks-helper.rb

@@ -0,0 +1,7 @@
+require "git-hooks-helper/hook"
+
+module GitHooksHelper
+  def self.results(&block)
+    GitHooksHelper::Hook.new(&block)
+  end
+end

data/lib/git-hooks-helper/extensions/string.rb

@@ -0,0 +1,5 @@
+class String
+  def red;    "\e[1m\e[31m#{self}\e[0m"; end
+  def green;  "\e[1m\e[32m#{self}\e[0m"; end
+  def yellow; "\e[1m\e[33m#{self}\e[0m"; end
+end

data/lib/git-hooks-helper/git.rb

@@ -0,0 +1,11 @@
+module GitHooksHelper
+  class Git
+    class << self
+      FILES_TO_WATCH = /(.+\.(e?rb|task|rake|thor|prawn)|[Rr]akefile|[Tt]horfile)/
+
+      def in_index
+        `git diff-index --name-only --cached HEAD`.split("\n").select{ |file| file =~ FILES_TO_WATCH }.map(&:chomp)
+      end
+    end
+  end
+end

data/lib/git-hooks-helper/hook.rb

@@ -0,0 +1,145 @@
+require "git-hooks-helper/result"
+require "git-hooks-helper/git"
+require "git-hooks-helper/extensions/string"
+require "open3"
+
+module GitHooksHelper
+  class Hook
+
+    RB_REGEXP     = /\.(rb|rake|task|prawn)\z/
+    ERB_REGEXP   = /\.erb\z/
+    JS_REGEXP   = /\.js\z/
+
+    RB_WARNING_REGEXP  = /[0-9]+:\s+warning:/
+    ERB_INVALID_REGEXP = /invalid\z/
+    COLOR_REGEXP = /\e\[(\d+)m/
+
+    # Set this to true if you want warnings to stop your commit
+    def initialize(&block)
+      @compiler_ruby = `which ruby`.strip
+
+      @result = GitHooksHelper::Result.new(false)
+      @changed_ruby_files = GitHooksHelper::Git.in_index
+
+      instance_eval(&block) if block
+
+      if @result.errors?
+        status = 1
+        puts "ERRORS:".red
+        puts @result.errors.join("\n")
+        puts "--------\n".red
+      end
+
+      if @result.warnings?
+        if @result.stop_on_warnings
+          puts "WARNINGS:".yellow
+        else
+          puts "Warnings:".yellow
+        end
+        puts @result.warnings.join("\n")
+        puts "--------\n".yellow
+      end
+
+      if @result.perfect_commit?
+        puts "Perfect commit!".green
+      end
+
+      if @result.continue?
+        # all good
+        puts("COMMIT OK:".green)
+        exit 0
+      else
+        puts("COMMIT FAILED".red)
+        exit 1
+      end
+    end
+
+    def stop_on_warnings
+      @result.stop_on_warnings = true
+    end
+
+    def do_not_stop_on_warnings
+      @result.stop_on_warnings = false
+    end
+
+    def never_stop
+      @result.never_stop = true
+    end
+
+    def list_files(filetypes = [:all])
+      each_changed_file(filetypes) do |file|
+        puts file
+      end
+    end
+
+    def each_changed_file(filetypes = [:all])
+      if @result.continue?
+        @changed_ruby_files.each do |file|
+          unless filetypes.include?(:all)
+            next unless (filetypes.include?(:rb) and file =~ RB_REGEXP) or (filetypes.include?(:erb) and file =~ ERB_REGEXP) or (filetypes.include?(:js) and file =~ JS_REGEXP)
+          end
+          yield file if File.readable?(file)
+        end
+      end
+    end
+
+    def check_ruby_syntax
+      each_changed_file([:rb]) do |file|
+        Open3.popen3("#{@compiler_ruby} -wc #{file}") do |stdin, stdout, stderr|
+          stderr.read.split("\n").each do |line|
+            line =~ RB_WARNING_REGEXP ? @result.warnings << line : @result.errors << line
+          end
+        end
+      end
+    end
+
+    def check_erb
+      each_changed_file([:erb]) do |file|
+        Open3.popen3("rails-erb-check #{file}") do |stdin, stdout, stderr|
+          @result.errors.concat stdout.read.split("\n").map{|line| "#{file} => invalid ERB syntax" if line.gsub(COLOR_REGEXP, '') =~ ERB_INVALID_REGEXP}.compact
+        end
+      end
+    end
+
+    def check_best_practices
+      each_changed_file([:rb, :erb]) do |file|
+        puts "bundle exec rails_best_practices --spec --test #{file}"
+        Open3.popen3("bundle exec rails_best_practices --spec --test #{file}") do |stdin, stdout, stderr|
+          @result.warn(stdout.read.split("\n").map do |line|
+            if line =~ /#{file}/
+              line.gsub(COLOR_REGEXP, '').strip
+            end
+          end.compact)
+        end
+      end
+    end
+
+    # Maybe need options for different file types :rb :erb :js
+    def warning_on(*args)
+      options = (args[-1].kind_of?(Hash) ? args.pop : {})
+      each_changed_file(options[:in] || [:all]) do |file|
+        Open3.popen3("fgrep -nH \"#{args.join("\n")}\" #{file}") do |stdin, stdout, stderr|
+          err = stdout.read
+          err.split("\n").each do |msg|
+            args.each do |string|
+              @result.warn("#{msg.split(" ").first} contains #{string}") if msg =~ /#{string}/
+            end
+          end
+        end
+      end
+    end
+
+    def info(text)
+      puts(text.green)
+    end
+
+    def notice(text)
+      puts(text.yellow)
+    end
+
+    def warn(text)
+      puts(text.red)
+    end
+
+  end
+end

data/lib/git-hooks-helper/result.rb

@@ -0,0 +1,42 @@
+module GitHooksHelper
+  class Result
+
+    attr_accessor :errors, :warnings, :stop_on_warnings, :never_stop
+
+    def initialize(stop_on_warnings)
+      @errors = []
+      @warnings = []
+      @stop_on_warnings = stop_on_warnings
+      @never_stop = false
+    end
+
+    def warn(msg)
+      if msg.class == Array
+        @warnings.concat msg
+      else
+        @warnings << msg
+      end
+    end
+
+    def continue?
+      @never_stop || (!(errors? || (warnings? && @stop_on_warnings)))
+    end
+
+    def warnings?
+      @warnings.size > 0
+    end
+
+    def errors?
+      @errors.size > 0
+    end
+
+    def pass?
+      @never_stop || errors?
+    end
+
+    def perfect_commit?
+      !(errors? || warnings?)
+    end
+
+  end
+end

data/lib/git-hooks-helper/version.rb

@@ -0,0 +1,3 @@
+module GitHooksHelper
+  VERSION = "0.0.1"
+end

data/spec/git_files/bad_syntax.rb

@@ -0,0 +1,4 @@
+class Test
+  def
+  end
+end

data/spec/git_files/good_syntax.rb

@@ -0,0 +1,4 @@
+class Test
+  def test
+  end
+end

data/spec/git_files/no_best_practices.rb

@@ -0,0 +1,5 @@
+class Test
+  # extra tab and whitespace in the end 
+	def test 
+  end
+end

data/spec/git_files/ok.html.erb

@@ -0,0 +1,4 @@
+<html>
+  <% form do |f| %>
+  <% end %>
+</html>

data/spec/git_files/ok_best_practices.rb

@@ -0,0 +1,5 @@
+class Test
+  # extra tab and whitespace in the end
+  def test
+  end
+end

data/spec/git_files/syntax_error.html.erb

@@ -0,0 +1,4 @@
+<html>
+  <% form do |f| %>
+  <% end >
+</html>

data/spec/git_hooks_helper_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe GitHooksHelper do
+
+  it "should run empty hook" do
+    GitHooksHelper::Git.should_receive(:in_index).and_return([])
+
+    begin
+      GitHooksHelper.results do
+      end
+    rescue SystemExit
+      $!.status.should eql 0
+    end
+  end
+
+  describe "check_ruby_syntax" do
+    before(:each) do
+      @files = [
+        "spec/git_files/bad_syntax.rb",
+        "spec/git_files/good_syntax.rb"
+      ]
+    end
+
+    it "should fail on bad rb syntax" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(@files)
+      begin
+        GitHooksHelper.results do
+          check_ruby_syntax
+        end
+      rescue SystemExit => e
+        $!.status.should eql 1
+      end
+    end
+
+    it "should pass good rb syntax" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/good_syntax.rb"])
+      begin
+        GitHooksHelper.results do
+          check_ruby_syntax
+        end
+      rescue SystemExit => e
+        $!.status.should eql 0
+      end
+    end
+  end
+
+  describe "never_stop" do
+    it "should pass even on errors and warnings" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/bad_syntax.rb"])
+      begin
+        GitHooksHelper.results do
+          never_stop
+          check_ruby_syntax
+        end
+      rescue SystemExit => e
+        $!.status.should eql 0
+      end
+    end
+  end
+
+  describe "stop_on_warnings" do # also sort of checks best practices
+    it "should stop even on warnings" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/no_best_practices.rb"])
+      begin
+        GitHooksHelper.results do
+          stop_on_warnings
+          check_best_practices
+        end
+      rescue SystemExit => e
+        $!.status.should eql 1
+      end
+    end
+
+    it "should run OK when no errors" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/ok_best_practices.rb"])
+      begin
+        GitHooksHelper.results do
+          stop_on_warnings
+          check_best_practices
+        end
+      rescue SystemExit => e
+        $!.status.should eql 0
+      end
+    end
+  end
+
+  describe "check_erb" do
+    it "should stop even on warnings on syntax error in ERB" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/syntax_error.html.erb"])
+      begin
+        GitHooksHelper.results do
+          stop_on_warnings
+          check_erb
+        end
+      rescue SystemExit => e
+        $!.status.should eql 1
+      end
+    end
+
+    it "should show no error on correct ERB" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/ok.html.erb"])
+      begin
+        GitHooksHelper.results do
+          stop_on_warnings
+          check_erb
+        end
+      rescue SystemExit => e
+        $!.status.should eql 0
+      end
+    end
+  end
+
+  describe "warning_on" do
+    it "should show error when file contains specific text" do
+      GitHooksHelper::Git.should_receive(:in_index).and_return(["spec/git_files/ok.html.erb"])
+      begin
+        GitHooksHelper.results do
+          stop_on_warnings
+          check_erb 
+        end
+      rescue SystemExit => e
+        $!.status.should eql 0
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'git-hooks-helper'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: git-hooks-helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martynas Margis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails-erb-check
+  requirement: &19072720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19072720
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: &19071260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19071260
+description: Gem for creating simple git hooks in ruby.
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- HISTORY
+- LICENSE
+- README
+- README.md
+- Rakefile
+- git-hooks-helper.gemspec
+- lib/git-hooks-helper.rb
+- lib/git-hooks-helper/extensions/string.rb
+- lib/git-hooks-helper/git.rb
+- lib/git-hooks-helper/hook.rb
+- lib/git-hooks-helper/result.rb
+- lib/git-hooks-helper/version.rb
+- spec/git_files/bad_syntax.rb
+- spec/git_files/good_syntax.rb
+- spec/git_files/no_best_practices.rb
+- spec/git_files/ok.html.erb
+- spec/git_files/ok_best_practices.rb
+- spec/git_files/syntax_error.html.erb
+- spec/git_hooks_helper_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: git-hooks-helper
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Small gem to help write simple git hooks
+test_files: []