codeqa 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76abd3e514881ba020ce7be60294367f7a449a6e
+  data.tar.gz: 22c52858996a5ff6f762fb286998d4f87b56d3d7
+SHA512:
+  metadata.gz: 7c6f4a03915e49f2075e9b7491baec61b64a7396860491bc04abf813b93428794820e0ed26b399017c9055fff48a823d7c0d9a983b9ea3ad6ead5f32ac2ca449
+  data.tar.gz: 1febdf733bdf6f47cfd95c77a39172c64c0ce60495e1273e04d06181ff2345654ee4a9195fe8811c6425fae2d3e59d4527d275ddd0aa8d5fd1c6e98ae20b511a

data/.codeqa.rb

@@ -0,0 +1,22 @@
+Codeqa.configure do |config|
+  config.excludes = ['spec/fixtures/html_error.html.erb',
+                     'spec/fixtures/html_error.text.html',
+                     'spec/fixtures/ruby_error.rb',
+                     'lib/codeqa/checkers/check_pry.rb',
+                     'spec/lib/codeqa/checkers/check_pry_spec.rb',
+                     'spec/lib/codeqa/checkers/check_rspec_focus_spec.rb',
+                     'coverage/*',
+                     'pkg/*']
+
+  config.enabled_checker.delete 'CheckRubySyntax'
+  config.enabled_checker << 'RubocopLint'
+  config.enabled_checker << 'RubocopFormatter'
+
+  config.rubocop_formatter_cops << 'AlignHash'
+  config.rubocop_formatter_cops << 'SignalException'
+  config.rubocop_formatter_cops << 'DeprecatedClassMethods'
+  config.rubocop_formatter_cops << 'RedundantBegin'
+  config.rubocop_formatter_cops << 'RedundantSelf'
+  config.rubocop_formatter_cops << 'RedundantReturn'
+  config.rubocop_formatter_cops << 'CollectionMethods'
+end

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.rvmrc
+!.keep

data/.rspec

@@ -0,0 +1,3 @@
+--tty
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,93 @@
+
+AllCops:
+  Exclude:
+    - spec/fixtures/ruby_error.rb
+
+# changed config ---------------------------
+
+AlignHash:
+  EnforcedHashRocketStyle: table
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+LineLength:
+  Max: 119
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+DotPosition:
+  EnforcedStyle: trailing
+
+#SpaceInsideBlockBraces:
+#  EnforcedStyle: no_space
+#  SupportedStyles:
+#    - space
+#    - no_space
+#  # Valid values are: space, no_space
+#  EnforcedStyleForEmptyBraces: no_space
+#  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+#  SpaceBeforeBlockParameters: false
+
+# http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-fail
+SignalException:
+    EnforcedStyle: only_raise
+
+
+CollectionMethods:
+  Enabled: true
+
+MethodLength:
+  Enabled: true
+  CountComments: false # count full line comments?
+  Max: 10
+  Severity: refactor
+
+FileName:
+  Exclude:
+    - 'lib/templates/pre-commit'
+    - '.codeqa.rb'
+
+# Disabled cops ------------------------------
+
+DoubleNegation:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+  CountComments: false # count full line comments?
+  Max: 100
+
+# complains about use of class vars
+ClassVars:
+  Enabled: false
+
+# checks for top-level docu of classes and modules
+Documentation:
+  Enabled: false
+
+# checks to avoid \1 in regex
+PerlBackrefs:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+SignalException:
+ EnforcedStyle: only_raise
+
+MethodLength:
+ Enabled: false
+
+RegexpLiteral:
+ Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - rbx
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx
+    - rvm: ruby-head

data/.vimrc

@@ -0,0 +1 @@
+noremap <buffer> <leader>t :!bundle exec rspec --no-color --fail-fast %:p:h<cr>

data/CHANGELOG

@@ -0,0 +1,8 @@
+0.2.1
+  * fixing missing ERB error
+0.2.0
+  * .codeqa config file
+  * lots of refactorings
+  * ruby 2.0.0 compliant
+0.1.0 
+  * checking for old style link_to blocks (without equal signs)

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codeqa.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rb-inotify', :require => false
+  # gem 'rb-fsevent', :require => false #mac only
+  # gem 'rb-fchange', :require => false #windows only
+end
+
+group :test do
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+end

data/Guardfile

@@ -0,0 +1,21 @@
+notification :tmux,
+  :display_message => true,
+  :timeout => 3 # in seconds
+
+# ignore /doc/
+
+group :red_green_refactor, halt_on_fail: true do
+  guard 'rspec', cmd: "bundle exec rspec --color --format p", all_after_pass: true do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})               { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')            { 'spec' }
+    watch('spec/factories.rb')              { 'spec' }
+    watch('spec/support/jobs.json')         { 'spec' }
+    watch(%r{^spec/factories/(.+)\.rb})     { 'spec' }
+  end
+
+  guard :rubocop, cli: %w(--display-cop-names --auto-correct) do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Schrammel
+
+MIT License
+
+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,97 @@
+# Codeqa
+
+[![Build Status](https://travis-ci.org/experteer/codeqa.svg?branch=master)](https://travis-ci.org/experteer/codeqa)
+[![Coverage Status](https://img.shields.io/coveralls/experteer/codeqa.svg)](https://coveralls.io/r/experteer/codeqa)
+[![Code Climate](https://codeclimate.com/github/experteer/codeqa/badges/gpa.svg)](https://codeclimate.com/github/experteer/codeqa)
+
+With codeqa you can check your code to comply to certain coding rules (utf8 only chars, indenting) or to avoid typical errors or
+enforce deprecations. You might even put it into a pre commit hook.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'codeqa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codeqa
+
+## Usage
+
+    codeqa filename
+
+
+## Config
+
+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
+  the closest `.git` folder.
+
+Both the config in your home directory and the project config file are optional
+and will be automatically skiped if they do not exist.
+
+Because codeqa now uses ruby for configuration we can more easily change settings
+without replacing it completely.
+
+### Example Config
+
+```ruby
+Codeqa.configure do |config|
+  # override the list of excludes
+  config.excludes = ['coverage/*',
+                     'pkg/*',
+                     'tmp/*',
+                     /\.log/]
+
+  # remove the default ruby lint in favor of rubocop
+  config.enabled_checker.delete 'CheckRubySyntax'
+  config.enabled_checker << 'RubocopLint'
+  # also enable the rubocop autoformatter
+  config.enabled_checker << 'RubocopFormatter'
+
+  # add some more active formatters/cops to rubocop
+  config.rubocop_formatter_cops << 'AlignHash'
+  config.rubocop_formatter_cops << 'SignalException'
+  config.rubocop_formatter_cops << 'DeprecatedClassMethods'
+  config.rubocop_formatter_cops << 'RedundantBegin'
+  config.rubocop_formatter_cops << 'RedundantSelf'
+  config.rubocop_formatter_cops << 'RedundantReturn'
+  config.rubocop_formatter_cops << 'CollectionMethods'
+end
+```
+
+## Checkers
+
+- pattern
+  - CheckPry
+  - CheckRspecFocus
+  - CheckConflict
+  - CheckStrangeChars
+  - CheckLinkTo
+- rubocop
+  - RubocopLint (replacement for CheckRubySyntax)
+  - RubocopFormatter
+- erb
+  - CheckErb (tests erb template for syntax errors using either `erb` or `action_view`
+  - CheckErbHtml (removes all erb tags and tests with `tidy` if the template is valid XML)
+- yard
+  - CheckYard (checks YARD for warnings)
+- CheckRubySyntax (runs file though `ruby -c`, use RubocopLint if possible)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+desc 'Run all specs'
+task :specs do
+  opts = %w(rspec -c)
+  opts += ['--require', File.join(File.dirname(__FILE__), 'spec', 'spec_helper')]
+  # opts += ['-I', YARD::ROOT]
+  if ENV['DEBUG']
+    $DEBUG = true
+    opts += ['-d']
+  end
+  opts += FileList['spec/**/*_spec.rb'].sort
+  cmd = opts.join(' ')
+  puts cmd if Rake.application.options.trace
+  system(cmd)
+  raise "Command failed with status (#{$?.to_i}): #{cmd}" if $?.to_i != 0
+end
+task :spec => :specs
+task :default => :specs

data/bin/codeqa

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+$: << File.join(File.dirname(__FILE__), '../lib') if ENV['CODEQA_DEV']
+require 'rubygems'
+require 'codeqa'
+
+require 'pathname'
+require 'optparse'
+
+options = { :silent => false, :failfast => false }
+
+ARGV.options do |opts|
+  opts.banner = "Usage:  #{File.basename($PROGRAM_NAME)} [OPTIONS] FILES"
+
+  opts.separator ''
+  opts.separator 'Specific Options:'
+
+  opts.on('-s', '--silent', 'No output if no error') do
+    options[:silent] = true
+  end
+  opts.on('-f', '--fail-fast', 'Fail right after the first error.') do
+    options[:failfast] = true
+  end
+
+  opts.on('-i', '--install', 'Install a basic pre-commit hook.') do
+    options[:install] = true
+  end
+
+  opts.separator 'Common Options:'
+
+  opts.on('-h', '--help',
+          'Show this message.') do
+    puts opts
+    exit
+  end
+  opts.on('-v', '--version',
+          "Show version (it's #{Codeqa::VERSION})") do
+    puts Codeqa::VERSION
+    exit
+  end
+
+  begin
+    opts.parse!
+  rescue
+    puts opts
+    exit
+  end
+end
+
+if options[:install]
+  Codeqa.install(ARGV.first || '.')
+  exit
+end
+
+exploded_args = ARGV.map do |e|
+  if File.directory?(e)
+    Dir["#{e}/**/*"]
+  else
+    e
+  end
+end
+
+files_to_check = exploded_args.
+  flatten.
+  map{ |e| Pathname.new(e).realpath.to_s }.
+  reject{ |e| File.directory?(e) || Codeqa.configuration.excluded?(e) }.
+  uniq
+
+puts "#{files_to_check.count} files to check" unless options[:silent]
+if options[:failfast]
+  # all? is already lazy/fail-fast so it will stop after the first false
+  exit 1 unless files_to_check.all?{ |e| Codeqa.check(e, options) }
+else
+  exit 1 unless files_to_check.map{ |e| Codeqa.check(e, options) }.all?
+end

data/codeqa.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/codeqa/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Peter Schrammel', 'Andreas Eger']
+  gem.email         = ['peter.schrammel@experteer.com', 'andreas.eger@experteer.com']
+  gem.description   = 'Checks your code (esp Rails) for common errors'
+  gem.summary       = 'Code checker'
+  gem.homepage      = ''
+
+  gem.files         = `git ls-files`.split($\)
+  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'
+  gem.require_paths = ['lib']
+  gem.version       = Codeqa::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '>=3.0'
+  gem.add_development_dependency 'yard'
+end

data/config/default.rb

@@ -0,0 +1,42 @@
+Codeqa.configure do |config|
+  config.excludes = ['vendor/**/*']
+  config.enabled_checker = %w(CheckErb
+                              CheckErbHtml
+                              CheckRubySyntax
+                              CheckStrangeChars
+                              CheckUtf8Encoding
+                              CheckConflict
+                              CheckPry
+                              CheckLinkto
+                              CheckRspecFocus)
+  config.erb_engine = 'erb'
+  config.rubocop_formatter_cops = %w( EmptyLinesAroundBody
+                                      EmptyLines
+                                      TrailingWhitespace
+                                      SpaceBeforeBlockBraces
+                                      SpaceInsideBlockBraces
+                                      SpaceAroundEqualsInParameterDefault
+                                      SpaceAfterComma
+                                      SingleSpaceBeforeFirstArg
+                                      SpaceInsideHashLiteralBraces
+                                      SpaceAroundOperators
+                                      SpaceInsideParens
+                                      LeadingCommentSpace
+                                      EmptyLineBetweenDefs
+                                      IndentationConsistency
+                                      IndentationWidth
+                                      MethodDefParentheses
+                                      DefWithParentheses
+                                      HashSyntax
+                                      AlignArray
+                                      AlignParameters
+                                      BracesAroundHashParameters )
+  # other interessting but currently not enabled default cops
+  # AlignHash
+  # SignalException
+  # DeprecatedClassMethods
+  # RedundantBegin
+  # RedundantSelf
+  # RedundantReturn
+  # CollectionMethods
+end

data/lib/codeqa/check_errors.rb

@@ -0,0 +1,21 @@
+module Codeqa
+  class CheckErrors
+    def initialize
+      @details = []
+    end
+
+    attr_reader :details
+
+    def add(place, message)
+      @details << [place, message]
+    end
+
+    def success?
+      @details.empty?
+    end
+
+    def errors?
+      !success?
+    end
+  end
+end

data/lib/codeqa/checker.rb

@@ -0,0 +1,47 @@
+require 'stringio'
+require 'tempfile'
+require 'forwardable'
+
+module Codeqa
+  class Checker
+    extend ::Forwardable
+
+    def initialize(sourcefile)
+      @errors = CheckErrors.new
+      @sourcefile = sourcefile
+    end
+
+    attr_reader :sourcefile
+    attr_reader :errors
+    def_delegators :@errors, :success?, :errors?
+
+    def self.available?
+      true
+    end
+
+  private
+
+    def with_existing_file(content=sourcefile.content)
+      if sourcefile.exist? && sourcefile.content == content
+        yield sourcefile.filename
+      else
+        Tempfile.open('codeqa') do |tmpfile|
+          tmpfile.write(content)
+          tmpfile.flush
+          tmpfile.rewind
+          yield tmpfile.path
+        end
+      end
+    end
+
+    def capture
+      $stdout, stdout = StringIO.new, $stdout
+      $stderr, stderr = StringIO.new, $stderr
+      result = yield
+      [result, $stdout.string + $stderr.string]
+    ensure
+      $stdout = stdout
+      $stderr = stderr
+    end
+  end
+end

data/lib/codeqa/checkers/check_conflict.rb

@@ -0,0 +1,28 @@
+require 'codeqa/checkers/pattern_checker'
+
+module Codeqa
+  module Checkers
+    class CheckConflict < PatternChecker
+      def name
+        'conflict'
+      end
+
+      def hint
+        'Remove the lines which are beginning with <<<<<<< or >>>>>>> or =======.'
+      end
+
+      def self.check?(sourcefile)
+        sourcefile.text?
+      end
+
+    private
+
+      def self.pattern
+        @pattern ||= /^<<<<<<<|^>>>>>>>|^=======$/m
+      end
+      def error_msg(_line, line_number, _pos)
+        "conflict leftovers in line #{line_number}, please merge properly"
+      end
+    end
+  end
+end

data/lib/codeqa/checkers/check_erb.rb

@@ -0,0 +1,48 @@
+module Codeqa
+  module Checkers
+    class CheckErb < Checker
+      def self.check?(sourcefile)
+        sourcefile.erb?
+      end
+
+      def self.available?
+        engine?
+      end
+
+      def name
+        'erb syntax'
+      end
+
+      def hint
+        'There is a syntax error in the ruby code of the erb parsed file.'
+      end
+
+      # rubocop:disable RescueException,HandleExceptions
+      def check
+        if defined?(ActionView)
+          ActionView::Template::Handlers::Erubis.new(erb).result
+        else
+          ERB.new(sourcefile.content.gsub('<%=', '<%'), nil, '-').result
+        end
+      rescue SyntaxError
+        errors.add(nil, <<-EOF)
+        #{$!.message}
+        #{$!.backtrace.join("\n")}
+        EOF
+      rescue Exception
+        true # valid syntax - just the proper setup for the template/rendering is missing
+      end
+      # rubocop:enable RescueException,HandleExceptions
+
+      def self.engine?
+        @@engine ||= if %w(actionview action_view).include? Codeqa.configuration.erb_engine.downcase
+                       require 'action_view'
+                       true
+                     else
+                       require 'erb'
+                       true
+                     end
+      end
+    end
+  end
+end