codeqa 0.3.0

data/lib/codeqa/checkers/check_erb_html.rb

@@ -0,0 +1,42 @@
+require 'codeqa/fake_erb'
+require 'open3'
+module Codeqa
+  module Checkers
+    class CheckErbHtml < Checker
+      def self.check?(sourcefile)
+        sourcefile.html?
+      end
+
+      def name
+        'erb html'
+      end
+
+      def hint
+        'The html I see after removing the erb stuff is not valid (find the unclosed tags and attributes).'
+      end
+
+      def check
+        result = nil
+        with_existing_file(html) do |filename|
+          Open3.popen3("tidy -q -e -xml '#{filename}'") do |_in_stream, _out_stream, err_stream|
+            message = err_stream.read
+            result = message if message =~ /(Error:|missing trailing quote|end of file while parsing attributes)/m
+          end # IO.popen
+        end # Tempfile
+
+        return unless result
+        errors.add(nil, html)
+        errors.add(nil, result)
+      end
+
+      def html
+        @html ||= begin
+                    html = FakeERB.new(sourcefile.content.gsub('<%=', '<%')).result
+                    html = html.force_encoding('UTF-8') if html.respond_to?(:force_encoding)
+                    html.gsub(%r{<script[ >].*?</script>|<style[ >].*?</style>}m,
+                              '<!--removed script/style tag-->')
+                  end
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_linkto.rb

@@ -0,0 +1,28 @@
+require 'codeqa/checkers/pattern_checker'
+
+module Codeqa
+  module Checkers
+    class CheckLinkto < PatternChecker
+      def name
+        'link_to'
+      end
+
+      def hint
+        "<% link_to ... do ... %> detected add an '=' after the <%"
+      end
+
+      def self.check?(sourcefile)
+        sourcefile.erb?
+      end
+
+    private
+
+      def self.pattern
+        @pattern ||= /<% link_to.* do.*%>/
+      end
+      def error_msg(_line, line_number, _pos)
+        "old style block link_to in line #{line_number}"
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_pry.rb

@@ -0,0 +1,28 @@
+require 'codeqa/checkers/pattern_checker'
+
+module Codeqa
+  module Checkers
+    class CheckPry < PatternChecker
+      def name
+        'pry'
+      end
+
+      def hint
+        'Leftover binding.pry found, please remove it.'
+      end
+
+      def self.check?(sourcefile)
+        sourcefile.ruby?
+      end
+
+    private
+
+      def self.pattern
+        @pattern ||= /binding\.pry/
+      end
+      def error_msg(_line, line_number, _pos)
+        "binding.pry in line #{line_number}"
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_rspec_focus.rb

@@ -0,0 +1,28 @@
+require 'codeqa/checkers/pattern_checker'
+
+module Codeqa
+  module Checkers
+    class CheckRspecFocus < PatternChecker
+      def name
+        'rspec-focus'
+      end
+
+      def hint
+        'Leftover :focus in spec found, please remove it.'
+      end
+
+      def self.check?(sourcefile)
+        sourcefile.spec?
+      end
+
+    private
+
+      def self.pattern
+        @pattern ||= /:focus/
+      end
+      def error_msg(_line, line_number, _pos)
+        ":focus in line #{line_number}"
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_ruby_syntax.rb

@@ -0,0 +1,25 @@
+require 'erb'
+module Codeqa
+  module Checkers
+    class CheckRubySyntax < Checker
+      def self.check?(sourcefile)
+        sourcefile.ruby?
+      end
+
+      def name
+        'ruby syntax'
+      end
+
+      def hint
+        'Ruby can not parse the file, please check it for syntax errors.'
+      end
+
+      def check
+        with_existing_file do |filename|
+          command = "/usr/bin/env ruby -c '#{filename}' 1>/dev/null 2>/dev/null"
+          errors.add(nil, 'Ruby syntax error') unless system(command)
+        end
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_strange_chars.rb

@@ -0,0 +1,29 @@
+require 'codeqa/checkers/pattern_checker'
+
+module Codeqa
+  module Checkers
+    class CheckStrangeChars < PatternChecker
+      def name
+        'strange chars'
+      end
+
+      def hint
+        'The file contains a tab or form feed. Remove them.'
+      end
+
+      def self.check?(sourcefile)
+        sourcefile.text?
+      end
+
+    private
+
+      def self.pattern
+        @pattern ||= /(\x09|\x0c)/
+      end
+      def error_msg(line, line_number, pos)
+        strangeness = (line.include?("\x09") ? 'TAB x09' : 'FORM FEED x0C')
+        "#{strangeness} at line #{line_number} column #{pos + 1}"
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_utf8_encoding.rb

@@ -0,0 +1,22 @@
+module Codeqa
+  module Checkers
+    class CheckUtf8Encoding < Checker
+      def self.check?(sourcefile)
+        sourcefile.text?
+      end
+
+      def name
+        'utf8 encoding'
+      end
+
+      def hint
+        'The file contains non utf8 characters. Find and remove them.'
+      end
+
+      def check
+        return if sourcefile.content.force_encoding('UTF-8').valid_encoding?
+        errors.add(nil, 'encoding error, not utf8')
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_yard.rb

@@ -0,0 +1,55 @@
+require 'stringio'
+
+module Codeqa
+  module Checkers
+    class CheckYard < Checker
+      def self.check?(sourcefile)
+        sourcefile.ruby? && !(sourcefile.filename =~ /^(test|spec)/)
+      end
+      def self.available?
+        yard?
+      end
+
+      def self.io
+        @@io ||= StringIO.new
+      end
+
+      def name
+        'yard'
+      end
+
+      def hint
+        'Yard gives us some warnings on the file you can run <yardoc filename> to check yourself.'
+      end
+
+      def check
+        if self.class.yard?
+          ::YARD.parse_string(sourcefile.content) # let yard parse the file content
+          io.rewind # rewind the io
+          message = io.read
+          warnings = message.match(/\A\[warn\]: /)
+          errors.add(nil, message.gsub(/\(stdin\)/, sourcefile.filename)) if warnings
+        end
+      ensure
+        io.reopen # clear the message for the next file
+      end
+
+    private
+
+      def io
+        self.class.io
+      end
+
+      def self.yard?
+        @loaded ||= begin
+                      require 'yard'
+                      ::YARD::Logger.instance(io) # replace YARD logger with io
+                      true
+                    rescue LoadError
+                      puts 'yard not installed'
+                      false
+                    end
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/pattern_checker.rb

@@ -0,0 +1,26 @@
+module Codeqa
+  module Checkers
+    class PatternChecker < Checker
+      def check
+        sourcefile.content.lines.each.with_index do |line, line_number|
+          pos = (line =~ pattern)
+          errors.add("#{line_number + 1},#{pos + 1}", error_msg(line, line_number + 1, pos)) if pos
+        end
+      end
+
+      def self.available?
+        respond_to?(:pattern)
+      end
+
+    private
+
+      def pattern
+        self.class.pattern
+      end
+
+      def error_msg(*_args)
+        raise 'not implemented'
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/rubocop_formatter.rb

@@ -0,0 +1,29 @@
+require 'codeqa/checkers/rubocop_full'
+
+module Codeqa
+  module Checkers
+    class RubocopFormatter < Rubocop
+      def name
+        'rubocop formatter'
+      end
+
+      def hint
+        <<-EOF
+Rubocop reformatted your code.
+Check what it has done and add the changes to git's index
+EOF
+      end
+
+      def after_check
+        # add changes to the git index
+        # `git add #{sourcefile.filename}`
+      end
+
+    private
+
+      def config_args
+        %w(--auto-correct --only ) << Codeqa.configuration.rubocop_formatter_cops.to_a.join(',')
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/rubocop_full.rb

@@ -0,0 +1,53 @@
+module Codeqa
+  module Checkers
+    class Rubocop < Checker
+      def self.check?(sourcefile)
+        sourcefile.ruby?
+      end
+
+      def self.available?
+        rubocop?
+      end
+
+      def name
+        'rubocop'
+      end
+
+      def hint
+        'Rubocop does not like your syntax, please fix your code.'
+      end
+
+      def check
+        return unless self.class.rubocop?
+        with_existing_file do |filename|
+          args = config_args << filename
+          success, captured = capture do
+            if defined?(RuboCop) # its RuboCop since 0.24
+              ::RuboCop::CLI.new.run(default_args + args) == 0
+            else
+              ::Rubocop::CLI.new.run(default_args + args) == 0
+            end
+          end
+          errors.add(nil, captured) unless success
+        end
+      end
+
+    private
+
+      def config_args
+        %w(--auto-correct --fail-level warning)
+      end
+
+      def default_args
+        %w(--display-cop-names --format emacs)
+      end
+
+      def self.rubocop?
+        @loaded ||= begin
+                      require 'rubocop'
+                      true
+                    end
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/rubocop_lint.rb

@@ -0,0 +1,21 @@
+require 'codeqa/checkers/rubocop_full'
+
+module Codeqa
+  module Checkers
+    class RubocopLint < Rubocop
+      def name
+        'rubocop lint'
+      end
+
+      def hint
+        'Rubocop found syntax errors, please fix your code.'
+      end
+
+    private
+
+      def config_args
+        %w(--lint --fail-level error)
+      end
+    end
+  end
+end

data/lib/codeqa/configuration.rb

@@ -0,0 +1,94 @@
+require 'set'
+module Codeqa
+  class Configuration
+    # the default config file will setup all variables to some sane defaults
+    attr_accessor :erb_engine
+    attr_reader :excludes,
+                :enabled_checker,
+                :rubocop_formatter_cops
+
+    def excludes=(val)
+      @excludes = Set[*val]
+    end
+
+    def enabled_checker=(val)
+      @enabled_checker = Set[*val]
+    end
+
+    def rubocop_formatter_cops=(val)
+      @rubocop_formatter_cops = Set[*val]
+    end
+
+    def default_config_path
+      Codeqa.root.join('config', 'default')
+    end
+
+    def home_config_path
+      home_dir_config = File.join(home_dir, DOTFILE)
+      return home_dir_config if File.exist? home_dir_config
+      false
+    end
+
+    def project_config_path
+      project_root_config = File.join(project_root, DOTFILE)
+      return project_root_config if File.exist? project_root_config
+      false
+    end
+
+    #
+    # tests a given filepath if it should be excluded
+    # @param file File.join compatable filepath
+    #
+    # @return [Boolean]
+    def excluded?(file)
+      file = File.join(Dir.pwd, file) unless file.start_with?('/')
+      Codeqa.configuration.excludes.any?{ |pattern| match_path?(pattern, file) }
+    end
+
+  private
+
+    DOTFILE = '.codeqa.rb'
+
+    def home_dir
+      @home_dir ||= Dir.home
+    end
+
+    def project_root
+      @project_root ||= git_root_till_home
+    end
+
+    # ascend from the current dir till I find a .git folder or reach home_dir
+    def git_root_till_home
+      Pathname.new(Dir.pwd).ascend do |dir_pathname|
+        return dir_pathname if File.directory?("#{dir_pathname}/.git")
+        return nil if dir_pathname.to_s == home_dir
+      end
+    end
+
+    def match_path?(pattern, path)
+      case pattern
+      when String
+        basename = File.basename(path)
+        pattern = File.join(project_root, pattern) unless pattern.start_with?('/')
+        path == pattern || basename == pattern || File.fnmatch(pattern, path)
+      when Regexp
+        path =~ pattern
+      end
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||=  Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      Codeqa.register_checkers
+    end
+  end
+end
+
+require Codeqa.configuration.default_config_path
+require Codeqa.configuration.home_config_path if Codeqa.configuration.home_config_path
+require Codeqa.configuration.project_config_path if Codeqa.configuration.project_config_path

data/lib/codeqa/fake_erb.rb

@@ -0,0 +1,80 @@
+require 'erb'
+module Codeqa
+  # copied from ERB
+  # throws away all the erb stuff so only html remains
+  # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, BlockNesting
+  class FakeERB < ERB
+    def initialize(str, safe_level=nil, trim_mode=nil, eoutvar='_erbout', compiler_class=FakeERB::Compiler)
+      @safe_level = safe_level
+      compiler = compiler_class.new(trim_mode)
+      set_eoutvar(compiler, eoutvar)
+      @src = compiler.compile(str)
+      @filename = nil
+    end
+
+    class Compiler < ERB::Compiler # :nodoc:
+      def compile(s)
+        out = Buffer.new(self)
+
+        content = ''
+        scanner = make_scanner(s)
+        scanner.scan do |token|
+          next if token.nil?
+          next if token == ''
+          if scanner.stag.nil?
+            case token
+            when PercentLine
+              out.push("#{@put_cmd} #{content_dump(content)}") if content.size > 0
+              content = ''
+              out.push(token.to_s)
+              out.cr
+            when :cr
+              out.cr
+            when '<%', '<%=', '<%#'
+              scanner.stag = token
+              out.push("#{@put_cmd} #{content_dump(content)}") if content.size > 0
+              content = ''
+            when "\n"
+              content << "\n"
+              out.push("#{@put_cmd} #{content_dump(content)}")
+              content = ''
+            when '<%%'
+              content << '<%'
+            else
+              content << token
+            end
+          else
+            case token
+            when '%>'
+              case scanner.stag
+              when '<%'
+                if content[-1] == "\n"
+                  content.chop!
+                  # out.push(content)
+                  out.cr
+                else
+                  # out.push(content)
+                end
+              when '<%='
+                # out.push("#{@insert_cmd}((#{content}).to_s)")
+              when '<%#'
+                # out.push("# #{content_dump(content)}")
+              end
+              scanner.stag = nil
+              content = ''
+            when '%%>'
+              content << '%>'
+            else
+              content << token
+            end
+          end
+        end
+        # puts "pushed2 #{content}"
+        out.push("#{@put_cmd} #{content_dump(content)}") if content.size > 0
+        out.close
+        out.script
+      end
+    end
+  end
+  # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, BlockNesting
+end

data/lib/codeqa/runner.rb

@@ -0,0 +1,61 @@
+require 'set'
+
+module Codeqa
+  class Runner
+    class << self
+      def registered_checkers
+        @@registered_checkers
+      end
+
+      def reset_checkers
+        @@registered_checkers = Set.new
+      end
+
+      def register_checker(checker_class)
+        @@registered_checkers << checker_class
+      end
+    end
+    @@registered_checkers = reset_checkers
+
+    # run the checks on source
+    def self.run(sourcefile)
+      runner = new(sourcefile)
+      runner.run
+      runner
+    end
+
+    def initialize(sourcefile)
+      @sourcefile = sourcefile
+      @results = []
+    end
+    attr_reader :sourcefile
+
+    def run
+      return @results unless @results.empty?
+      @results = @@registered_checkers.map do |checker_klass|
+        next unless checker_klass.check?(sourcefile)
+        checker = checker_klass.new(sourcefile)
+
+        checker.before_check if checker.respond_to?(:before_check)
+        checker.check
+        checker.after_check if checker.respond_to?(:after_check)
+        checker
+      end.compact
+    end
+
+    # the results (checker instances of the run)
+    attr_reader :results
+
+    def failures
+      @failures ||= @results.reject{ |checker| checker.success? }
+    end
+
+    def success?
+      failures.empty?
+    end
+
+    def display_result(options={})
+      RunnerDecorator.new(self, options)
+    end
+  end
+end