codeqa 0.3.0

data/lib/codeqa/runner_decorator.rb

@@ -0,0 +1,84 @@
+module Codeqa
+  class RunnerDecorator
+    def initialize(runner, options={})
+      @options = { :colors => true }.merge(options)
+      @runner = runner
+      @msg = ''
+    end
+
+    def sourcefile_to_s
+      info("Codeqa on :'#{@runner.sourcefile.filename}'\n")
+    end
+
+    def success_to_s
+      if @runner.success?
+        success("Passed tests: #{@runner.results.map(&:name).join(', ')}\n")
+      else
+        error("Failed tests: #{@runner.failures.map(&:name).join(', ')}\n")
+      end
+    end
+
+    def details_to_s
+      error_details
+    end
+
+    def to_s
+      @msg << sourcefile_to_s
+      @msg << success_to_s
+      @msg << details_to_s unless @runner.success?
+
+      @msg
+    end
+
+  private
+
+    def error_details
+      msg = ''
+      @runner.failures.each do |checker|
+        msg << error("------- #{checker.name} -------\n")
+        msg << error("#{checker.hint}\n")
+        checker.errors.details.each do |detail|
+          msg << info("#{detail[1]}\n")
+        end
+      end
+      msg
+    end
+
+    # http://stackoverflow.com/questions/1489183/colorized-ruby-output
+    def info(txt)
+      txt
+    end
+
+    def error(txt)
+      red(txt)
+    end
+
+    def success(txt)
+      green(txt)
+    end
+
+    def colorize(color_code, txt)
+      if @options[:colors]
+        "\e[#{color_code}m#{txt}\e[0m"
+      else
+        txt
+      end
+    end
+
+    def red(txt)
+      colorize(31, txt)
+    end
+
+    def green(txt)
+      colorize(32, txt)
+    end
+
+    # def yellow(txt)
+    #   colorize(33, txt)
+    # end
+
+    # def pink(txt)
+    #   colorize(35, txt)
+    # end
+  end
+end

data/lib/codeqa/sourcefile.rb

@@ -0,0 +1,50 @@
+module Codeqa
+  class Sourcefile
+    BINARY_PATTERN = /\.(swf|jpg|png|gif|pdf|xls|zip|eot|woff|ttf|mo|so|gem)$/
+    ERB_PATTERN = /\.(erb|rhtml|text\.html|text\.plain)$/
+    HTML_PATTERN = /\.(rhtml|html|text\.html)/
+    RUBY_PATTERN = /\.(rb|gemspec)$/
+    RUBY_NAMES = %w(Guardfile Gemfile Rakefile config.ru)
+    SPEC_PATTERN = /_spec\.rb$/
+
+    def initialize(filename, content=nil)
+      @filename = filename
+      @content = content
+      # ensure_file
+    end
+
+    attr_reader :filename
+
+    def content
+      @content ||= File.read(filename)
+    end
+
+    def exist?
+      File.exist?(filename)
+    end
+
+    def text?
+      !binary?
+    end
+
+    def binary?
+      @binary ||= !!(filename =~ BINARY_PATTERN)
+    end
+
+    def ruby?
+      @ruby ||= (RUBY_NAMES.include?(filename) || !!(filename =~ RUBY_PATTERN))
+    end
+
+    def erb?
+      @erb ||= !!(filename =~ ERB_PATTERN)
+    end
+
+    def html?
+      @html ||= !!(filename =~ HTML_PATTERN) && !ruby?
+    end
+
+    def spec?
+      @spec ||= !!(filename =~ SPEC_PATTERN)
+    end
+  end
+end

data/lib/codeqa/version.rb

@@ -0,0 +1,3 @@
+module Codeqa
+  VERSION = '0.3.0'
+end

data/lib/codeqa.rb

@@ -0,0 +1,78 @@
+require 'pathname'
+module Codeqa
+  CODEQA_HOME = Pathname.new(File.join(File.dirname(__FILE__), '..')).realpath
+
+  class << self
+    def root
+      CODEQA_HOME
+    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
+    end
+
+    def check(filename, options={})
+      options = { :silent_success => false, :silent => false }.merge(options)
+      runner = runner(filename)
+      if runner.success?
+        $stdout.puts(runner.display_result) unless options[:silent_success] || options[:silent]
+        true
+      else
+        $stderr.puts runner.display_result unless options[:silent]
+        false
+      end
+    end
+
+    def runner(filename)
+      sourcefile = Codeqa::Sourcefile.new(filename)
+      Codeqa::Runner.run(sourcefile)
+    end
+
+    def register_checkers
+      Codeqa::Runner.reset_checkers
+      configuration.enabled_checker.each do |checker|
+        begin
+          checker_klass = Codeqa::Checkers.const_get(checker)
+          next unless checker_klass.available?
+          Codeqa::Runner.register_checker checker_klass
+        rescue
+          "checker <#{checker}> not known"
+        end
+      end
+    end
+  end
+end
+
+require 'codeqa/version'
+require 'codeqa/sourcefile'
+require 'codeqa/checker'
+require 'codeqa/check_errors'
+require 'codeqa/runner'
+require 'codeqa/runner_decorator'
+
+require 'codeqa/configuration'
+
+# load all files in checkers subfolder
+Dir.glob(Codeqa.root.join('lib/codeqa/checkers/*.rb')) do |file|
+  require "codeqa/checkers/#{file[%r{/([^/]+)\.rb}, 1]}"
+end
+
+Codeqa.register_checkers

data/lib/templates/pre-commit

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+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 => true)
+end
+
+if success
+  puts 'success'
+  exit 0
+else
+  puts 'error'
+  exit 1
+end

data/spec/fixtures/html_error.html.erb

@@ -0,0 +1,10 @@
+<div>
+ some close tag error </li>
+</div>
+
+<div open_attribute="error another="ok">
+</div>
+
+<div open_till_end="error>
+</div>
+

data/spec/fixtures/html_error.text.html

@@ -0,0 +1,3 @@
+<div>
+<% def erb_error %>
+</div>

data/spec/fixtures/isolation/home/project/file.rb

@@ -0,0 +1 @@
+p 'this is a ruby file'

data/spec/fixtures/isolation/home/project/ignored/some_file.txt

@@ -0,0 +1 @@
+some file

data/spec/fixtures/ruby.rb

@@ -0,0 +1,3 @@
+class Foo
+  attr_reader :bar
+end

data/spec/fixtures/ruby_error.rb

@@ -0,0 +1,3 @@
+class Ok Ok
+  def foo
+end

data/spec/lib/codeqa/checkers/check_conflict_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckConflict do
+  it_behaves_like 'a checker'
+
+  it 'should check text files' do
+    source = source_with
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect ======== and <<<<<<< and >>>>>>>' do
+    source = source_with("first line\n<<<<<<<\n=======\nthirdline\n>>>>>>>")
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details).to eq([
+      ['2,1', 'conflict leftovers in line 2, please merge properly'],
+      ['3,1', 'conflict leftovers in line 3, please merge properly'],
+      ['5,1', 'conflict leftovers in line 5, please merge properly']
+    ])
+  end
+
+  it 'should find not find if not there ' do
+    source = source_with("first line\n<<<<<<\n======\nthirdline\n>>>>>>")
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end

data/spec/lib/codeqa/checkers/check_erb_html_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+# there is no tidy on travis-ci so we can't test this checker there
+unless ENV['TRAVIS']
+  describe Codeqa::Checkers::CheckErbHtml do
+    it_behaves_like 'a checker'
+
+    it 'should check erb files' do
+      source = source_with('', 'file.html.erb')
+      expect(described_class.check?(source)).to be_truthy
+      source = source_with('', 'test.rhtml')
+      expect(described_class.check?(source)).to be_truthy
+      source = source_with('', 'test.text.html')
+      expect(described_class.check?(source)).to be_truthy
+
+      source = source_with('', 'zipped.zip')
+      expect(described_class.check?(source)).to be_falsey
+    end
+
+    it 'should detect html tag errors' do
+      source = source_with('<div><ul></div>')
+      checker = check_with(described_class, source)
+      expect(checker).to be_error
+      expect(checker.errors.details).to eq([
+        [nil, '<div><ul></div>'],
+        [nil, "line 1 column 10 - Error: unexpected </div> in <ul>\n"]])
+    end
+
+    it 'should detect attribute till end of file errors' do
+      source = source_with("<div class='halfopen></div>")
+      checker = check_with(described_class, source)
+      expect(checker).to be_error
+      expect(checker.errors.details).to eq([
+        [nil, "<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>')
+      checker = check_with(described_class, source)
+      expect(checker).to be_error
+      expect(checker.errors.details).to eq([
+        [nil, "<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
+      source = source_with('<div><ul></ul></div>')
+      checker = check_with(described_class, source)
+      expect(checker).to be_success
+    end
+
+    it 'should ignore javascript' do
+      source = source_with('<div><script></ul></script></div>')
+      checker = check_with(described_class, source)
+      expect(checker).to be_success
+    end
+    it 'should ignore javascript' do
+      source = source_with('<div><script type="text/javascript" charset="utf-8"></ul></script></div>')
+      checker = check_with(described_class, source)
+      expect(checker).to be_success
+      source = source_with("<div><script>multiline\n</ul></script></div>")
+      checker = check_with(described_class, source)
+      expect(checker).to be_success
+    end
+    it 'should ignore javascript' do
+      source = source_with('<div><style></ul></style></div>')
+      checker = check_with(described_class, source)
+      expect(checker).to be_success
+    end
+  end
+end

data/spec/lib/codeqa/checkers/check_erb_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckErb do
+  it_behaves_like 'a checker'
+
+  it 'should check erb files' do
+    source = source_with('', 'file.html.erb')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'test.rhtml')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'test.text.html')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect syntax errors in the erb' do
+    source = source_with('blub<%= def syntax %> ok')
+    checker = check_with(described_class, source)
+    expect(checker.errors?).to be true
+    str = checker.errors.details[0][1]
+
+    expect(str).to match(Regexp.new(Regexp.escape('(erb):1: syntax error, unexpected end-of-input, expect')))
+  end
+  it 'should be successfull for valid erb' do
+    source = source_with('blub<%= var %> ok')
+    checker = check_with(described_class, source)
+    expect(checker.success?).to be true
+  end
+
+end

data/spec/lib/codeqa/checkers/check_linkto_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckLinkto do
+  it_behaves_like 'a checker'
+
+  it 'should check erb files' do
+    source = source_with('', 'file.html.erb')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect <% link_to ... do ... %>' do
+    source = source_with("<% link_to '/page',do_some_paths do%>", 'file.html.erb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details).to eq([['1,1', 'old style block link_to in line 1']])
+  end
+
+  it 'should find not find if not there ' do
+    source = source_with("<%= link_to '/page',do_some_paths do%>", 'file.html.erb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end

data/spec/lib/codeqa/checkers/check_pry_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckPry do
+  it_behaves_like 'a checker'
+
+  it 'should check ruby files' do
+    source = source_with('', 'file.rb')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect binding pry' do
+    source = source_with("first line\nbinding.pry\nthirdline", 'file.rb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+  end
+
+  it 'should be success is all is finde ' do
+    source = source_with("first line\nthirdline\n", 'file.rb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end

data/spec/lib/codeqa/checkers/check_rspec_focus_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckRspecFocus do
+  it_behaves_like 'a checker'
+
+  it 'should check spec files' do
+    source = source_with('', 'file_spec.rb')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'file.rb')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect :focus' do
+    source = source_with("first line\:focus\nthirdline", 'file_spec.rb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+  end
+
+  it 'should be success is all is finde ' do
+    source = source_with("first line\nthirdline\n", 'file_spec.rb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end

data/spec/lib/codeqa/checkers/check_ruby_syntax_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckRubySyntax do
+  it_behaves_like 'a checker'
+
+  it 'should check text files' do
+    source = source_with
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect syntax errors' do
+    source = source_with('class MyClass')
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details).to eq([[nil, 'Ruby syntax error']])
+  end
+
+  it 'should find not find if not there ' do
+    source = source_with('class MyClass; end')
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end

data/spec/lib/codeqa/checkers/check_strange_chars_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckStrangeChars do
+  it_behaves_like 'a checker'
+
+  it 'should check text files' do
+    source = source_with('', 'file.html.erb')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect tabs' do
+    source = source_with("one\x09two")
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details).to eq([['1,4', 'TAB x09 at line 1 column 4']])
+  end
+
+  it 'should detect form feeds' do
+    source = source_with("one\n\x0ctwo")
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details).to eq([['2,1', 'FORM FEED x0C at line 2 column 1']])
+  end
+
+end

data/spec/lib/codeqa/checkers/check_utf8_encoding_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckUtf8Encoding do
+  it_behaves_like 'a checker'
+
+  it 'should check text files' do
+    source = source_with
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect non utf8 chars ' do
+    source = source_with("\xE4\xF6\xFC")
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details).to eq([[nil, 'encoding error, not utf8']])
+  end
+
+  it 'should find not find if not there ' do
+    source = source_with('first line')
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end

data/spec/lib/codeqa/checkers/check_yard_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::CheckYard do
+  it_behaves_like 'a checker'
+
+  it 'should check rb files' do
+    source = source_with('', 'file.rb')
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'test.rhtml')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect yard errors' do
+    source = source_with("# @paramsssss\nclass MyClass\nend", 'file.rb')
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    detail = checker.errors.details[0][1]
+    expect(detail).to match(/Unknown tag @paramsssss in file/)
+  end
+
+end

data/spec/lib/codeqa/checkers/rubocop_formatter_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::RubocopFormatter do
+  it_behaves_like 'a checker'
+end

data/spec/lib/codeqa/checkers/rubocop_full_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::Rubocop do
+  it_behaves_like 'a checker'
+end

data/spec/lib/codeqa/checkers/rubocop_lint_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Codeqa::Checkers::RubocopLint do
+  it_behaves_like 'a checker'
+
+  it 'should check text files' do
+    source = source_with
+    expect(described_class.check?(source)).to be_truthy
+    source = source_with('', 'zipped.zip')
+    expect(described_class.check?(source)).to be_falsey
+  end
+
+  it 'should detect syntax errors' do
+    source = source_with('class MyClass')
+    checker = check_with(described_class, source)
+    expect(checker).to be_error
+    expect(checker.errors.details.first[1]).to match(/unexpected token/)
+  end
+
+  it 'should find not find if not there ' do
+    source = source_with('class MyClass; end')
+    checker = check_with(described_class, source)
+    expect(checker).to be_success
+  end
+
+end