Merge pull request #1 from preisanalytics/master

michaelsauter · michaelsauter · commit 199fa9b68673 · 2015-07-10T09:15:06.000+02:00
refactoring installation. hook is now just a link into commitable code
diff --git a/.codeqa/config.rb b/.codeqa/config.rb
diff --git a/.codeqa/git_hook.rb b/.codeqa/git_hook.rb
@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+APP_ROOT = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', '..')))
+HOOKS_PATH = APP_ROOT.join('.codeqa', 'hooks')
+
+# run each hook if one gives an error then commit will fail
+
+HOOKS_PATH.children(false).sort.each do |filename|
+  exe = HOOKS_PATH.join(filename)
+  ok = system(%(#{exe} APP_ROOT="#{APP_ROOT}"))
+  exit 1 unless ok
+end
+
+exit 0
diff --git a/.codeqa/hooks/base.rb b/.codeqa/hooks/base.rb
@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# running codeqa checks on changes files
+
 def staged_files
   @staged_files ||= begin
     files = `git diff --cached --name-only --diff-filter=ACM`.split
@@ -30,9 +32,9 @@ def binary?(file)
 end
 
 files_to_check = staged_files.
-                  map{ |e| Pathname.new(e).realpath.to_s }.
-                  reject{ |e| File.directory?(e) || Codeqa.configuration.excluded?(e) }.
-                  uniq
+                 map{ |e| Pathname.new(e).realpath.to_s }.
+                 reject{ |e| File.directory?(e) || Codeqa.configuration.excluded?(e) }.
+                 uniq
 
 print "Codeqa checking #{files_to_check.count} files"
 # fail fast
diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,6 @@ test/version_tmp
 tmp
 .idea
 .rvmrc
+/spec/fixtures/.codeqa
+/spec/fixtures/isolation/home/project/.codeqa/
 !.keep
diff --git a/.ruby-version b/.ruby-version
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 2.1.2
+  - 2.2.2
+  - 2.1.5
   - 2.0.0
   - rbx
   - ruby-head
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+0.5.0
+  * INCOMPATIBLE CHANGE: new config layout (now config has to be in .codeqa/config.rb)
+  * multiple hooks in any language is allowed (create scripts in .codeqa/hooks)
 0.2.1
   * fixing missing ERB error
 0.2.0
diff --git a/README.md b/README.md
@@ -33,9 +33,9 @@ Since Version 0.3 codeqa uses ruby for configuration, therefore the config file
 is now named `.codeqa.rb`. The loading of configuration files is still the same,
 meaning we have to following load order:
 
-1. Initialize with default settings (see `config/default..rb`)
-2. load `.codeqa.rb` from your home directory and merge it with the defaults.
-3. load `.codeqa.rb` placed in the project root, which is determined by finding
+1. Initialize with default settings (see `config/default.rb`)
+2. load `.codeqa/config.rb` from your home directory and merge it with the defaults.
+3. load `.codeqa/config.rb` placed in the project root, which is determined by finding
   the closest `.git` folder.
 
 Both the config in your home directory and the project config file are optional
@@ -90,6 +90,10 @@ end
   - CheckYard (checks YARD for warnings)
 - CheckRubySyntax (runs file though `ruby -c`, use RubocopLint if possible)
 
+## Hooks
+Since version 0.5 it's possible to run any scripts which are placed at .codeqa/hooks . If they exit with code <> 0
+the commit is not allowed. The scripts have to be executable.
+
 ## Contributing
 
 1. Fork it
diff --git a/bin/codeqa b/bin/codeqa
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << File.join(File.dirname(__FILE__), '../lib') if ENV['CODEQA_DEV']
+$: << File.join(File.dirname(__FILE__), '../lib') unless $PROGRAM_NAME == 'codeqa'
 require 'rubygems'
 require 'codeqa'
 
diff --git a/codeqa.gemspec b/codeqa.gemspec
@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/experteer/codeqa'
   gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($\)
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'codeqa'
diff --git a/lib/codeqa.rb b/lib/codeqa.rb
@@ -8,25 +8,8 @@ def root
     end
 
     def install(root='.')
-      require 'fileutils'
-      git_root = Pathname.new "#{root}/.git"
-      if File.exist?(git_root)
-        pre_commit_path = git_root.join 'hooks', 'pre-commit'
-        if File.exist?(pre_commit_path)
-          # $stdout.puts 'moving away the old pre-commit hook -> pre-commit.bkp'
-          FileUtils.mv(pre_commit_path,
-                       git_root.join('hooks', 'pre-commit.bkp'),
-                       :force => true)
-        end
-        pre_commit_template_path = Codeqa.root.join('lib', 'templates', 'pre-commit')
-        # $stdout.puts 'placing new pre-commit hook'
-        FileUtils.cp(pre_commit_template_path, pre_commit_path)
-        FileUtils.chmod('+x', pre_commit_path)
-        true
-      else
-        # $stderr.puts "#{root} is not in a git root"
-        false
-      end
+      require 'codeqa/installer'
+      Codeqa::Installer.call(root)
     end
 
     def check(filename, options={})
diff --git a/lib/codeqa/checkers/html_validator.rb b/lib/codeqa/checkers/html_validator.rb
@@ -39,11 +39,11 @@ def check
 
       def stripped_html
         @stripped_html ||= ErbSanitizer.
-                            new(sourcefile.content).
-                            result.
-                            gsub(%r{<script[ >](.*?)</script>}m) do
-                              "<!-- script#{"\n" * $1.scan("\n").count} /script -->"
-                            end
+                           new(sourcefile.content).
+                           result.
+                           gsub(%r{<script[ >](.*?)</script>}m) do
+          "<!-- script#{"\n" * Regexp.last_match(1).scan("\n").count} /script -->"
+        end
       end
 
       def self.nokogiri?
diff --git a/lib/codeqa/checkers/rubocop_full.rb b/lib/codeqa/checkers/rubocop_full.rb
@@ -46,13 +46,13 @@ def default_args
 
       def handle_rubocop_results(raw)
         MultiJson.load(raw)['files'].
-                 reject{ |f| f['offenses'].empty? }.
-                 each do |file|
-                   file['offenses'].each do |offense|
-                     position = [offense['location']['line'], offense['location']['column']]
-                     errors.add(position, "#{offense['cop_name']}: #{offense['message']}")
-                   end
-                 end
+          reject{ |f| f['offenses'].empty? }.
+          each do |file|
+          file['offenses'].each do |offense|
+            position = [offense['location']['line'], offense['location']['column']]
+            errors.add(position, "#{offense['cop_name']}: #{offense['message']}")
+          end
+        end
       end
       def self.rubocop?
         @loaded ||= begin
diff --git a/lib/codeqa/configuration.rb b/lib/codeqa/configuration.rb
@@ -47,7 +47,7 @@ def excluded?(file)
 
   private
 
-    DOTFILE = '.codeqa.rb'
+    DOTFILE = '.codeqa/config.rb'
 
     def home_dir
       @home_dir ||= Dir.home
@@ -79,7 +79,7 @@ def match_path?(pattern, path)
 
   class << self
     def configuration
-      @configuration ||=  Configuration.new
+      @configuration ||= Configuration.new
     end
 
     def configure
diff --git a/lib/codeqa/installer.rb b/lib/codeqa/installer.rb
@@ -0,0 +1,56 @@
+require 'fileutils'
+
+module Codeqa
+  class Installer
+    def self.call(app_root)
+      new(app_root).call
+    end
+
+    def initialize(app_root)
+      @app_root = Pathname.new(File.expand_path(app_root))
+    end
+
+    def call
+      generate_dot_codeqa
+      install_codeqa_git_hook
+    end
+
+  private
+
+    def dot_path(*args)
+      app_path('.codeqa').join(*args)
+    end
+
+    def app_path(*args)
+      @app_root.join(*args)
+    end
+
+    def template_path(*args)
+      Codeqa.root.join('lib', 'templates').join(*args)
+    end
+
+    # return true if installation succeeded
+    # return false if either no git repo or hook already present
+    def install_codeqa_git_hook
+      git_root = app_path.join('.git')
+      pre_commit_path = git_root.join 'hooks', 'pre-commit'
+
+      return false unless File.exist?(git_root)
+      return false if File.exist?(pre_commit_path)
+      # an alternative would be to backup the old hook
+      # FileUtils.mv(pre_commit_path,
+      #             git_root.join('hooks', 'pre-commit.bkp'),
+      #             :force => true)
+      pre_commit_path.make_symlink('../../.codeqa/git_hook.rb') # relative path!
+      true
+    end
+
+    def generate_dot_codeqa
+      dot_path.mkdir unless dot_path.exist?
+      dot_path('hooks').mkdir unless dot_path('hooks').exist?
+      FileUtils.cp(template_path('base_hook.rb'), dot_path('hooks', 'base.rb')) unless dot_path('hooks', 'base.rb').exist?
+      FileUtils.cp(template_path('git_hook.rb'), dot_path('git_hook.rb')) unless  dot_path('git_hook.rb').exist?
+      dot_path('git_hook.rb').chmod(0775)
+    end
+  end
+end
diff --git a/lib/codeqa/version.rb b/lib/codeqa/version.rb
@@ -1,3 +1,3 @@
 module Codeqa
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end
diff --git a/lib/templates/base_hook.rb b/lib/templates/base_hook.rb
@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+# running codeqa checks on changes files
+
+def staged_files
+  @staged_files ||= begin
+    files = `git diff --cached --name-only --diff-filter=ACM`.split
+    files.reject do |f|
+      if File.ftype(f) != 'file'
+        true
+      else
+        size = File.size(f)
+        size > 1_000_000 || (size > 20 && binary?(f))
+      end
+    end
+  end
+end
+
+# from https://github.com/djberg96/ptools/blob/master/lib/ptools.rb#L90
+def binary?(file)
+  return true if File.ftype(file) != 'file'
+  s = (File.read(file, File.stat(file).blksize) || '').split(//)
+  ((s.size - s.grep(' '..'~').size) / s.size.to_f) > 0.30
+end
+
+begin
+  require 'bundler/setup'
+  require 'codeqa'
+rescue LoadError
+  puts "can't find codeqa in current bundle"
+  exit 1
+end
+
+files_to_check = staged_files.
+                 map{ |e| Pathname.new(e).realpath.to_s }.
+                 reject{ |e| File.directory?(e) || Codeqa.configuration.excluded?(e) }.
+                 uniq
+
+print "Codeqa checking #{files_to_check.count} files"
+# fail fast
+success = files_to_check.all? do |file|
+  print '.'
+  Codeqa.check(file, :silent_success => true)
+end
+
+if success
+  exit 0
+else
+  exit 1
+end
diff --git a/lib/templates/git_hook.rb b/lib/templates/git_hook.rb
@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+APP_ROOT = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', '..')))
+HOOKS_PATH = APP_ROOT.join('.codeqa', 'hooks')
+
+# run each hook if one gives an error then commit will fail
+
+HOOKS_PATH.children(false).sort.each do |filename|
+  exe = HOOKS_PATH.join(filename)
+  ok = system(%(#{exe} APP_ROOT="#{APP_ROOT}"))
+  exit 1 unless ok
+end
+
+exit 0
diff --git a/spec/lib/codeqa/checkers/check_conflict_spec.rb b/spec/lib/codeqa/checkers/check_conflict_spec.rb
@@ -26,5 +26,4 @@
     checker = check_with(described_class, source)
     expect(checker).to be_success
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/check_erb_html_spec.rb b/spec/lib/codeqa/checkers/check_erb_html_spec.rb
@@ -32,7 +32,6 @@
       expect(checker.errors.details).to eq([
         [:source, "<div class='halfopen></div>"],
         [nil, "line 1 column 28 - Warning: <div> end of file while parsing attributes\n"]])
-
     end
     it 'should detect attribute with missing trailing qute mark' do
       source = source_with('<div class="halfopen next="ok"></div>')
@@ -41,7 +40,6 @@
       expect(checker.errors.details).to eq([
         [:source, "<div class=\"halfopen next=\"ok\"></div>"],
         [nil, "line 1 column 1 - Warning: <div> attribute with missing trailing quote mark\n"]])
-
     end
 
     it 'should find not find errors if html is ok ' do
diff --git a/spec/lib/codeqa/checkers/check_erb_spec.rb b/spec/lib/codeqa/checkers/check_erb_spec.rb
@@ -27,5 +27,4 @@
     checker = check_with(described_class, source)
     expect(checker.success?).to be true
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/check_linkto_spec.rb b/spec/lib/codeqa/checkers/check_linkto_spec.rb
@@ -24,5 +24,4 @@
     checker = check_with(described_class, source)
     expect(checker).to be_success
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/check_ruby_syntax_spec.rb b/spec/lib/codeqa/checkers/check_ruby_syntax_spec.rb
@@ -22,5 +22,4 @@
     checker = check_with(described_class, source)
     expect(checker).to be_success
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/check_strange_chars_spec.rb b/spec/lib/codeqa/checkers/check_strange_chars_spec.rb
@@ -27,5 +27,4 @@
       [[2, 1], 'FORM FEED x0C at line 2 column 1']
     ])
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/check_utf8_encoding_spec.rb b/spec/lib/codeqa/checkers/check_utf8_encoding_spec.rb
@@ -22,5 +22,4 @@
     checker = check_with(described_class, source)
     expect(checker).to be_success
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/check_yard_spec.rb b/spec/lib/codeqa/checkers/check_yard_spec.rb
@@ -17,5 +17,4 @@
     detail = checker.errors.details[0][1]
     expect(detail).to match(/Unknown tag @paramsssss in file/)
   end
-
 end
diff --git a/spec/lib/codeqa/checkers/rubocop_lint_spec.rb b/spec/lib/codeqa/checkers/rubocop_lint_spec.rb
@@ -22,5 +22,4 @@
     checker = check_with(described_class, source)
     expect(checker).to be_success
   end
-
 end
diff --git a/spec/lib/codeqa/runner_decorator_spec.rb b/spec/lib/codeqa/runner_decorator_spec.rb
@@ -64,5 +64,4 @@
   #   decorator = Codeqa::RunnerDecorator.new(runner)
   #   expect(decorator.to_s).to match(/Passed tests.+strange chars/)
   # end
-
 end
diff --git a/spec/lib/codeqa/runner_spec.rb b/spec/lib/codeqa/runner_spec.rb
@@ -1,5 +1,4 @@
 require 'spec_helper'
 
 describe Codeqa::Runner do
-
 end
diff --git a/spec/lib/codeqa/sourcefile_spec.rb b/spec/lib/codeqa/sourcefile_spec.rb
@@ -29,5 +29,4 @@
     expect(source).to be_erb
     expect(source).to be_html
   end
-
 end
diff --git a/spec/lib/codeqa/utils/erb_sanitizer_spec.rb b/spec/lib/codeqa/utils/erb_sanitizer_spec.rb
diff --git a/spec/lib/codeqa_spec.rb b/spec/lib/codeqa_spec.rb

-Original file line number
+Diff line change
@@ @@ -1,6 +1,7 @@ @@
 language: ruby
 rvm:
 -  - 2.1.2
 +  - 2.2.2
 +  - 2.1.5
   - 2.0.0
   - rbx
   - ruby-head