codeqa 0.3.0

data/spec/lib/codeqa/configuration_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Codeqa::Configuration do
+  let(:subject){ Codeqa.configuration }
+
+  it 'should be exposed in the Codeqa module' do
+    expect(Codeqa).to respond_to(:configuration)
+  end
+
+  %w(excludes enabled_checker erb_engine rubocop_formatter_cops).each do |c|
+    it "should provide :#{c}" do
+      expect(Codeqa.configuration).to respond_to(c.to_sym)
+    end
+  end
+
+  it 'should have the excludes set' do
+    expect(Codeqa.configuration.excludes).to be_a(Set)
+    expect(Codeqa.configuration.excludes).to eq(Set.new(['vendor/**/*']))
+  end
+  it 'should have the enabled checkers set' do
+    expect(Codeqa.configuration.enabled_checker).to be_a(Set)
+    exp_set = Set.new(%w(CheckStrangeChars
+                         CheckUtf8Encoding
+                         CheckConflict
+                         CheckPry
+                         RubocopLint))
+    expect(Codeqa.configuration.enabled_checker).to eq(exp_set)
+  end
+
+  context 'exclude' do
+    before(:each) do
+      @org_dir = Dir.pwd
+      project_root = Codeqa.root.join 'spec/fixtures/isolation/home/project'
+      allow(Codeqa.configuration).to receive(:project_root).and_return(Pathname.new(project_root))
+      Dir.chdir(project_root)
+      Codeqa.configure{ |c| c.excludes = ['ignored/*', /tmp/] }
+    end
+    after(:each) do
+      Dir.chdir(@org_dir)
+      load_test_config
+    end
+    it 'should be true for filenames within a foo folder' do
+      expect(Codeqa.configuration.excluded?('ignored/some_file.txt')).to be true
+    end
+    it 'should be false for files unrelated to the excludes' do
+      expect(Codeqa.configuration.excluded?('file.rb')).to be false
+    end
+    it 'should work with regex matches' do
+      expect(Codeqa.configuration.excluded?('some/tmp/path')).to be true
+    end
+  end
+end

data/spec/lib/codeqa/runner_decorator_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Codeqa::RunnerDecorator do
+  it 'should run provide the errors if the checker failed' do
+    source = source_with('def syntax_error', 'ruby.rb')
+    runner = Codeqa::Runner.run(source)
+    expect(runner.success?).to be false
+    decorator = Codeqa::RunnerDecorator.new(runner)
+    expect(decorator.to_s).to match(/syntax/)
+  end
+  it 'should run list the ran checkers' do
+    source = source_with('def foo; end', 'ruby.rb')
+    runner = Codeqa::Runner.run(source)
+    expect(runner.success?).to be true
+    decorator = Codeqa::RunnerDecorator.new(runner)
+    expect(decorator.to_s).to match(/Passed tests.+strange chars/)
+  end
+
+end

data/spec/lib/codeqa/runner_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Codeqa::Runner do
+
+end

data/spec/lib/codeqa/sourcefile_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Codeqa::Sourcefile do
+  it 'should detect binary' do
+    source = Codeqa::Sourcefile.new('zipped.zip')
+    expect(source).to be_binary
+    expect(source).not_to be_text
+  end
+
+  it 'should detect ruby' do
+    source = Codeqa::Sourcefile.new('ruby.rb')
+    expect(source).to be_text
+    expect(source).to be_ruby
+  end
+
+  it 'should detect erb' do
+    source = Codeqa::Sourcefile.new('erb.erb')
+    expect(source).to be_text
+    expect(source).to be_erb
+  end
+
+  it 'should detect html' do
+    source = Codeqa::Sourcefile.new('erb.html.erb')
+    expect(source).to be_text
+    expect(source).to be_erb
+    expect(source).to be_html
+    source = Codeqa::Sourcefile.new('erb.rhtml')
+    expect(source).to be_text
+    expect(source).to be_erb
+    expect(source).to be_html
+  end
+
+end

data/spec/lib/codeqa_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Codeqa do
+  context 'register_checkers' do
+    it 'should first reset the checkers' do
+      expect(Codeqa::Runner).to receive(:reset_checkers)
+      Codeqa.register_checkers
+    end
+    it 'should constantize the checkers in config and add them to the registered_checkers' do
+      Codeqa.configuration.enabled_checker = ['CheckErb']
+      Codeqa.register_checkers
+      expect(Codeqa::Runner.registered_checkers).to include(Codeqa::Checkers::CheckErb)
+      load_test_config
+    end
+  end
+  context 'check' do
+    it 'should be true if the file is OK' do
+      file = './spec/fixtures/ruby.rb'
+      expect(Codeqa.check(file, :silent => true)).to be true
+    end
+    it 'should be false if the file is broken' do
+      file = './spec/fixtures/ruby_error.rb'
+      expect(Codeqa.check(file, :silent => true)).to be false
+    end
+  end
+
+  context 'install' do
+    let(:project_dir){ Codeqa.root.join('spec/fixtures/isolation/home/project') }
+    before(:each) do
+      FileUtils.mkdir_p(project_dir.join('.git', 'hooks'))
+    end
+    after(:each) do
+      FileUtils.rm_rf(project_dir.join('.git'))
+    end
+
+    it 'should be true if folder looks like a git root' do
+      expect(Codeqa.install(project_dir.to_s)).to be true
+    end
+
+    it 'should be false if folder does not look like a git root' do
+      expect(Codeqa.install(Codeqa.root.join('spec', 'fixtures'))).to be false
+    end
+
+    it 'should copy pre-commit hook into project git folder' do
+      template_location = Codeqa.root.join('lib', 'templates', 'pre-commit')
+      hook_location = project_dir.join('.git', 'hooks', 'pre-commit')
+      expect(FileUtils).to receive(:cp).with(template_location, hook_location)
+      allow(FileUtils).to receive(:chmod)
+      Codeqa.install project_dir.to_s
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'bundler'
+Bundler.setup
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+Bundler.require(:default, :test)
+
+require 'codeqa'
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # override some config settings
+  config.before(:all) do
+    load_test_config
+  end
+end
+
+Dir['./spec/support/**/*.rb'].sort.each{ |f| require f }
+
+def load_test_config
+  Codeqa.configure do |c|
+    c.excludes = ['vendor/**/*']
+    c.enabled_checker = %w(CheckStrangeChars
+                           CheckUtf8Encoding
+                           CheckConflict
+                           CheckPry
+                           RubocopLint)
+    c.rubocop_formatter_cops = %w(EmptyLinesAroundBody
+                                  EmptyLines
+                                  TrailingWhitespace)
+    c.erb_engine = 'erb'
+  end
+end
+
+def check_with(klass, source)
+  checker = klass.new(source)
+  checker.check
+  checker
+end
+
+def source_with(content='#ruby file', filename='prog.rb')
+  Codeqa::Sourcefile.new(filename, content)
+end

data/spec/support/checker.rb

@@ -0,0 +1,20 @@
+RSpec.shared_examples 'a checker' do
+  let(:checker){ described_class.new(double('SourceFile', :null_object => true)) }
+  %w(name hint check).each do |method|
+    it "should respond to :#{method}" do
+      expect(checker).to respond_to(method.to_sym)
+    end
+  end
+  %w(name hint).each do |method|
+    it "should return a non empty string from :#{method}" do
+      expect(checker.send(method.to_sym)).not_to be_empty
+    end
+  end
+  context 'ClassMethods' do
+    %w(check? available?).each do |method|
+      it "should respond to :#{method}" do
+        expect(described_class).to respond_to(method.to_sym)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: codeqa
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Peter Schrammel
+- Andreas Eger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Checks your code (esp Rails) for common errors
+email:
+- peter.schrammel@experteer.com
+- andreas.eger@experteer.com
+executables:
+- codeqa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeqa.rb"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".vimrc"
+- CHANGELOG
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/codeqa
+- codeqa.gemspec
+- config/default.rb
+- lib/codeqa.rb
+- lib/codeqa/check_errors.rb
+- lib/codeqa/checker.rb
+- lib/codeqa/checkers/check_conflict.rb
+- lib/codeqa/checkers/check_erb.rb
+- lib/codeqa/checkers/check_erb_html.rb
+- lib/codeqa/checkers/check_linkto.rb
+- lib/codeqa/checkers/check_pry.rb
+- lib/codeqa/checkers/check_rspec_focus.rb
+- lib/codeqa/checkers/check_ruby_syntax.rb
+- lib/codeqa/checkers/check_strange_chars.rb
+- lib/codeqa/checkers/check_utf8_encoding.rb
+- lib/codeqa/checkers/check_yard.rb
+- lib/codeqa/checkers/pattern_checker.rb
+- lib/codeqa/checkers/rubocop_formatter.rb
+- lib/codeqa/checkers/rubocop_full.rb
+- lib/codeqa/checkers/rubocop_lint.rb
+- lib/codeqa/configuration.rb
+- lib/codeqa/fake_erb.rb
+- lib/codeqa/runner.rb
+- lib/codeqa/runner_decorator.rb
+- lib/codeqa/sourcefile.rb
+- lib/codeqa/version.rb
+- lib/templates/pre-commit
+- spec/fixtures/html_error.html.erb
+- spec/fixtures/html_error.text.html
+- spec/fixtures/isolation/home/project/dir/.gitkeep
+- spec/fixtures/isolation/home/project/file.rb
+- spec/fixtures/isolation/home/project/ignored/some_file.txt
+- spec/fixtures/ruby.rb
+- spec/fixtures/ruby_error.rb
+- spec/lib/codeqa/checkers/check_conflict_spec.rb
+- spec/lib/codeqa/checkers/check_erb_html_spec.rb
+- spec/lib/codeqa/checkers/check_erb_spec.rb
+- spec/lib/codeqa/checkers/check_linkto_spec.rb
+- spec/lib/codeqa/checkers/check_pry_spec.rb
+- spec/lib/codeqa/checkers/check_rspec_focus_spec.rb
+- spec/lib/codeqa/checkers/check_ruby_syntax_spec.rb
+- spec/lib/codeqa/checkers/check_strange_chars_spec.rb
+- spec/lib/codeqa/checkers/check_utf8_encoding_spec.rb
+- spec/lib/codeqa/checkers/check_yard_spec.rb
+- spec/lib/codeqa/checkers/rubocop_formatter_spec.rb
+- spec/lib/codeqa/checkers/rubocop_full_spec.rb
+- spec/lib/codeqa/checkers/rubocop_lint_spec.rb
+- spec/lib/codeqa/configuration_spec.rb
+- spec/lib/codeqa/runner_decorator_spec.rb
+- spec/lib/codeqa/runner_spec.rb
+- spec/lib/codeqa/sourcefile_spec.rb
+- spec/lib/codeqa_spec.rb
+- spec/spec_helper.rb
+- spec/support/checker.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Code checker
+test_files:
+- spec/fixtures/html_error.html.erb
+- spec/fixtures/html_error.text.html
+- spec/fixtures/isolation/home/project/dir/.gitkeep
+- spec/fixtures/isolation/home/project/file.rb
+- spec/fixtures/isolation/home/project/ignored/some_file.txt
+- spec/fixtures/ruby.rb
+- spec/fixtures/ruby_error.rb
+- spec/lib/codeqa/checkers/check_conflict_spec.rb
+- spec/lib/codeqa/checkers/check_erb_html_spec.rb
+- spec/lib/codeqa/checkers/check_erb_spec.rb
+- spec/lib/codeqa/checkers/check_linkto_spec.rb
+- spec/lib/codeqa/checkers/check_pry_spec.rb
+- spec/lib/codeqa/checkers/check_rspec_focus_spec.rb
+- spec/lib/codeqa/checkers/check_ruby_syntax_spec.rb
+- spec/lib/codeqa/checkers/check_strange_chars_spec.rb
+- spec/lib/codeqa/checkers/check_utf8_encoding_spec.rb
+- spec/lib/codeqa/checkers/check_yard_spec.rb
+- spec/lib/codeqa/checkers/rubocop_formatter_spec.rb
+- spec/lib/codeqa/checkers/rubocop_full_spec.rb
+- spec/lib/codeqa/checkers/rubocop_lint_spec.rb
+- spec/lib/codeqa/configuration_spec.rb
+- spec/lib/codeqa/runner_decorator_spec.rb
+- spec/lib/codeqa/runner_spec.rb
+- spec/lib/codeqa/sourcefile_spec.rb
+- spec/lib/codeqa_spec.rb
+- spec/spec_helper.rb
+- spec/support/checker.rb
+has_rdoc: