koality 1.0.0

data/spec/koality/runner/cane_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe Koality::Runner::Cane do
+
+  let(:options) do
+    Koality::Options.new({
+      :abc_file_pattern => '{app,lib}/**/.rb',
+      :abc_threshold => 15,
+      :abc_enabled => true,
+
+      :style_file_pattern => '{app,lib}/**/.rb',
+      :style_line_length_threshold => 80,
+      :style_enabled => true,
+
+      :code_coverage_enabled => false,
+
+      :doc_file_pattern => '{app,lib}/**/.rb',
+      :doc_enabled => false,
+
+      :custom_thresholds => [[:>=, 'quality/foo', 42]],
+      :total_violations_threshold => 5
+    })
+  end
+  let(:runner) { runner = Koality::Runner::Cane.new options }
+
+  describe '.new' do
+    it 'translates Koality options into the format Cane expects' do
+      copts = runner.cane_options
+
+      copts[:threshold].should == [[:>=, 'quality/foo', 42]]
+
+      copts[:abc].should == {
+        :files => '{app,lib}/**/.rb',
+        :max => 15
+      }
+
+      copts[:style].should == {
+        :files => '{app,lib}/**/.rb',
+        :measure => 80,
+      }
+
+      copts[:doc].should be_nil
+    end
+  end
+
+  describe '#checkers' do
+    it 'returns all checkers which have configured options' do
+      runner.checkers.values.should include(
+        Cane::Runner::CHECKERS[:abc],
+        Cane::Runner::CHECKERS[:style],
+        Cane::Runner::CHECKERS[:threshold]
+      )
+      runner.checkers.values.should_not include(Cane::Runner::CHECKERS[:doc])
+    end
+  end
+
+  describe '#run_checker' do
+    let(:checker) { stub('checker', :violations => [:violation_1, :violation_2]) }
+    let(:reporter) { stub('reporter', :report => true) }
+
+    before do
+      Koality::Reporter::Cane.stubs(:start).yields(reporter)
+      runner.checkers[:abc].stubs(:new).returns(checker)
+    end
+
+    it 'builds and runs the specified checker' do
+      runner.checkers[:abc].expects(:new).with(runner.cane_options[:abc]).returns(checker)
+      checker.expects(:violations)
+
+      runner.run_checker(:abc)
+    end
+
+    it 'saves the violations' do
+      runner.run_checker(:abc)
+      runner.violations[:abc].should == [:violation_1, :violation_2]
+    end
+
+    it 'reports the violations' do
+      reporter.expects(:report).with(:abc, [:violation_1, :violation_2])
+      runner.run_checker(:abc)
+    end
+  end
+
+  describe '#run' do
+    before do
+      runner.stubs(:run_checker)
+    end
+
+    it 'clears the violations' do
+      runner.violations.expects(:clear)
+      runner.run
+    end
+
+    it 'runs each checker' do
+      runner.stubs(:checkers).returns({
+        :abc => (abc = stub('abc_checker')),
+        :style => (style = stub('style_checker'))
+      })
+
+      runner.expects(:run_checker).with(:abc)
+      runner.expects(:run_checker).with(:style)
+      runner.run
+    end
+
+    it 'returns whether or not the run was successful' do
+      runner.expects(:success?).returns(true)
+      runner.run.should eql(true)
+
+      runner.expects(:success?).returns(false)
+      runner.run.should eql(false)
+    end
+  end
+
+  describe '#success?' do
+    before do
+      runner.stubs(:violations).returns({:abc => [], :style => []})
+    end
+
+    it 'returns true if the total is not exceeded and each type is not exceeded' do
+      runner.expects(:exceeds_total_violations_threshold? => false)
+      runner.expects(:exceeds_violations_threshold? => false).twice
+
+      runner.success?.should be_true
+    end
+
+    it 'returns false if the total violations are exceeded' do
+      runner.expects(:exceeds_total_violations_threshold? => true)
+      runner.success?.should be_false
+    end
+
+    it 'returns false if the total is not exceeded but a single type does' do
+      runner.stubs(:exceeds_total_violations_threshold? => false)
+      runner.expects(:exceeds_violations_threshold?).with(:abc).returns(false)
+      runner.expects(:exceeds_violations_threshold?).with(:style).returns(true)
+      runner.success?.should be_false
+    end
+  end
+
+end

data/spec/koality/runner/rails_best_practices_spec.rb

@@ -0,0 +1,64 @@
+require 'pathname'
+require 'spec_helper'
+
+describe Koality::Runner::RailsBestPractices do
+
+  let(:options) do
+    Koality::Options.new({
+      :rails_bp_accept_patterns => %w(app/controllers/.+\\.rb),
+      :rails_bp_ignore_patterns => [/app\/helpers\/foo_helper\.rb/],
+      :rails_bp_error_file => 'rails_bp_errors',
+      :output_directory => 'quality'
+    })
+  end
+  let(:runner) { runner = Koality::Runner::RailsBestPractices.new options }
+
+  describe '.new' do
+    it 'figures out the output file path' do
+      runner.output_file.should == options.output_file(:rails_bp_error_file)
+    end
+
+    it 'translates the options into what RBP expects' do
+      rbp_opts = runner.rbp_options
+
+      rbp_opts['only'].should == [Regexp.new("app/controllers/.+\\.rb")]
+      rbp_opts['except'].should == [/app\/helpers\/foo_helper\.rb/]
+    end
+  end
+
+  describe '#run' do
+    let(:reporter) { stub('reporter', :report => true) }
+    let(:rbp) { rbp = stub('RailsBestPractices', :analyze => true, :errors => []) }
+
+    before do
+      FileUtils.mkdir_p options.output_directory
+      Koality::Reporter::RailsBestPractices.stubs(:start).yields(reporter)
+      RailsBestPractices::Analyzer.stubs(:new).returns(rbp)
+    end
+
+    it 'runs a RBP analyzer with the translated options' do
+      RailsBestPractices::Analyzer.expects(:new).with('.', runner.rbp_options).returns(rbp)
+      rbp.expects(:analyze)
+
+      runner.run
+    end
+
+    it 'creates a file with the number of failures from the run' do
+      errors = [stub('error')] * rand(5)
+      rbp.stubs(:errors).returns(errors)
+
+      runner.run
+
+      Pathname.new(runner.output_file).read.should == errors.count.to_s
+    end
+
+    it 'reports the errors' do
+      errors = [stub('error')] * rand(5)
+      rbp.stubs(:errors).returns(errors)
+
+      reporter.expects(:report).with(errors)
+      runner.run
+    end
+  end
+
+end

data/spec/koality/simplecov/formatter_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'koality/simplecov/formatter'
+
+describe Koality::SimpleCov::Formatter do
+
+  let(:formatter) { Koality::SimpleCov::Formatter.new }
+  let(:result) do
+    stub('result', :source_files => stub('source', :covered_percent => 99.999))
+  end
+
+  describe '#format' do
+    before do
+      SimpleCov::Formatter::HTMLFormatter.any_instance.stubs(:format)
+    end
+
+    it 'runs the HTML formatter' do
+      html_formatter = stub('html')
+      html_formatter.expects(:format).with(result)
+      SimpleCov::Formatter::HTMLFormatter.stubs(:new => html_formatter)
+
+      formatter.format(result)
+    end
+
+    it 'ensures that the output directory exists' do
+      Koality.options.expects(:ensure_output_directory_exists)
+      formatter.format(result)
+    end
+
+    it 'outputs the covered percent to the correct file' do
+      formatter.format(result)
+      output_file = Pathname.new(Koality.options.output_file(:code_coverage_file))
+      output_file.read.should == '99.999'
+    end
+  end
+
+end

data/spec/koality_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Koality do
+
+  let(:options) do
+    Koality::Options.new({
+      :output_directory => 'quality'
+    })
+  end
+
+  before do
+    Koality.stubs(:options).returns(options)
+  end
+
+  describe '.run' do
+    before do
+      Koality.stubs(:run_rails_bp => true, :run_cane => true)
+    end
+
+    it 'makes sure the output_directory exists' do
+      FileUtils.expects(:mkdir_p).with('quality')
+      Koality.run
+    end
+
+    it 'runs RailsBestPractices with the passed options if enabled' do
+      options.stubs(:rails_bp_enabled?).returns(true)
+      Koality.expects(:run_rails_bp)
+      Koality.run
+    end
+
+    it 'does not run RailsBestPractices if disabled' do
+      options.stubs(:rails_bp_enabled?).returns(false)
+      Koality.expects(:run_rails_bp).never
+      Koality.run
+    end
+
+    it 'runs Cane with the passed options' do
+      Koality.expects(:run_cane).returns(true)
+      Koality.run
+    end
+
+    it 'aborts if the abort_on_failure flag is set and the run was not successful' do
+      options[:abort_on_failure] = true
+      Koality.stubs(:run_cane).returns(false)
+      Koality.expects(:abort)
+
+      Koality.run
+    end
+
+    it 'does not abort if the abort_on_failure flag is set and the run was successful' do
+      options[:abort_on_failure] = true
+      Koality.stubs(:run_cane).returns(true)
+      Koality.expects(:abort).never
+
+      Koality.run
+    end
+
+    it 'does not abort if the abort_on_failure flag is set to false' do
+      options[:abort_on_failure] = false
+      Koality.stubs(:run_cane).returns(false)
+      Koality.expects(:abort).never
+
+      Koality.run
+    end
+  end
+
+  describe '.run_rails_bp' do
+    it 'runs the runner with the passed in options' do
+      rbp = mock('RBP', :run => true)
+      Koality::Runner::RailsBestPractices.expects(:new).with(options).returns(rbp)
+
+      Koality.run_rails_bp
+    end
+  end
+
+  describe '.run_cane' do
+    it 'runs the runner with the passed in options' do
+      cane = mock('cane', :run => true)
+      Koality::Runner::Cane.expects(:new).with(options).returns(cane)
+
+      Koality.run_cane
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift "../lib"
+
+require 'rspec'
+require 'koality'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.mock_with :mocha
+
+  config.formatter = :progress
+  config.color_enabled = true
+  config.filter_run :focused => true
+  config.run_all_when_everything_filtered = true
+  config.alias_example_to :fit, :focused => true
+  config.alias_example_to :they
+end

data/spec/support/with_constants.rb

@@ -0,0 +1,43 @@
+module Kernel
+  class << self
+
+    def with_warnings(flag, &block)
+      old_verbose, $VERBOSE = $VERBOSE, flag
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+
+    def silence_warnings(&block)
+      with_warnings(nil, &block)
+    end
+
+  end
+end
+
+class Object
+  def self.with_constants(constants, &block)
+    old_constants = Hash.new
+    missing_constants = []
+
+    constants.each do |constant, val|
+      if const_defined?(constant)
+        old_constants[constant] = const_get(constant)
+      else
+        missing_constants << constant
+      end
+
+      Kernel::silence_warnings{ const_set(constant, val) }
+    end
+
+    yield
+
+    old_constants.each do |constant, val|
+      Kernel::silence_warnings{ const_set(constant, val) }
+    end
+
+    missing_constants.each do |constant|
+      Kernel::silence_warnings{ remove_const(constant) }
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: koality
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jared Pace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Runs opinionated code quality tools as part of you test stuite
+email:
+- jared@thinkrelevance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- koality.gemspec
+- lib/koality.rb
+- lib/koality/options.rb
+- lib/koality/rake_task.rb
+- lib/koality/reporter/base.rb
+- lib/koality/reporter/cane.rb
+- lib/koality/reporter/rails_best_practices.rb
+- lib/koality/runner/cane.rb
+- lib/koality/runner/rails_best_practices.rb
+- lib/koality/simplecov.rb
+- lib/koality/simplecov/formatter.rb
+- lib/koality/version.rb
+- spec/koality/options_spec.rb
+- spec/koality/rake_task_spec.rb
+- spec/koality/runner/cane_spec.rb
+- spec/koality/runner/rails_best_practices_spec.rb
+- spec/koality/simplecov/formatter_spec.rb
+- spec/koality_spec.rb
+- spec/spec_helper.rb
+- spec/support/with_constants.rb
+homepage: https://github.com/relevance/koality
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Runs opinionated code quality tools as part of you test stuite
+test_files:
+- spec/koality/options_spec.rb
+- spec/koality/rake_task_spec.rb
+- spec/koality/runner/cane_spec.rb
+- spec/koality/runner/rails_best_practices_spec.rb
+- spec/koality/simplecov/formatter_spec.rb
+- spec/koality_spec.rb
+- spec/spec_helper.rb
+- spec/support/with_constants.rb