koality 1.0.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koality.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jared Pace
+
+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,128 @@
+# Koality
+
+Runs opinionated code metric tools against your code as part of the test
+suite. If the set level of desired quality is not met the build will
+fail.
+
+Beware of the drop bears.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'koality', :require => false
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koality
+
+## Usage
+
+Add the following to your applications Rakefile. Place it after
+`MyApp::Application.load_tasks` for Rails apps.
+
+    begin
+      require 'koality/rake_task'
+
+      Koality::RakeTask.new do |opts|
+        # configure options here
+        # See [koality_home]/lib/koality/options.rb for defaults
+
+        # opts.abc_threshold = 10
+      end
+      task :default => :koality
+    rescue LoadError
+      warn 'Could not load Koality, skipping Rake task.'
+    end
+
+Running your test suite with Koality:
+
+    rake
+
+Running koality on its own:
+
+    rake koality 
+
+
+## SimpleCov Integration (Optional)
+
+Add the following to the top of your spec/spec_helper.rb file.
+Must be before your require your application code.
+
+    require 'koality/simplecov'
+    SimpleCov.start
+
+## Available options
+
+All options are shown with their current defaults.
+
+    Koality::RakeTask.new do |opts|
+      opts.abc_file_pattern               = '{app,lib}/**/*.rb'
+      opts.abc_threshold                  = 15
+      opts.abc_violations_threshold       = 0
+      opts.abc_enabled                    = true
+
+      opts.style_file_pattern             = '{app,lib,spec}/**/*.{rb,coffee,js}'
+      opts.style_line_length_threshold    = 120
+      opts.style_violations_threshold     = 0
+      opts.style_enabled                  = true
+
+      opts.doc_file_pattern               = '{app,lib}/**/*.rb'
+      opts.doc_violations_threshold       = 0
+      opts.doc_enabled                    = false
+
+      opts.code_coverage_threshold        = 90
+      opts.code_coverage_file             = 'code_coverage'
+      opts.code_coverage_enabled          = true
+
+      opts.rails_bp_accept_patterns       = []
+      opts.rails_bp_ignore_patterns       = []
+      opts.rails_bp_errors_threshold      = 0
+      opts.rails_bp_error_file            = 'rails_best_practices_errors'
+      opts.rails_bp_enabled               = true
+
+      opts.custom_thresholds              = []
+      opts.total_violations_threshold     = 0
+      opts.abort_on_failure               = true
+      opts.output_directory               = 'quality'
+
+      opts.colorize_output                = true
+    end
+
+## Configuring Rails Best Practices
+
+Generate the config file (config/rails_best_practices.yml)
+
+    bundle exec rails_best_practices -g
+
+Edit configuration or comment out lines to skip certain checks.
+
+## Common Questions
+
+* I don't want to the build to fail if I exceed any thresholds. How do I
+  turn that off?
+
+    opts.abort_on_failure = false
+
+* I only want to fail the build if there are over 10 ABC errors. How do
+  I set that up?
+
+    opts.abc_violations_threshold = 10
+    opts.total_violations_threshold = -1
+
+* How do I keep style violations from breaking the build?
+
+    opts.style_violations_threshold = -1
+    opts.total_violations_threshold = -1
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/koality.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/koality/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jared Pace"]
+  gem.email         = ["jared@thinkrelevance.com"]
+  gem.description   = %q{Runs opinionated code quality tools as part of you test stuite}
+  gem.summary       = %q{Runs opinionated code quality tools as part of you test stuite}
+  gem.homepage      = "https://github.com/relevance/koality"
+
+  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          = "koality"
+  gem.require_paths = ["lib"]
+  gem.version       = Koality::VERSION
+
+  # Runtime Dependencies
+  gem.add_runtime_dependency 'rails_best_practices', ['~> 1.9']
+  gem.add_runtime_dependency 'simplecov', ['~> 0.6']
+  gem.add_runtime_dependency 'cane', ['~> 1.3']
+  gem.add_runtime_dependency 'terminal-table', ['~> 1.4']
+  gem.add_runtime_dependency 'term-ansicolor', ['~> 1.0']
+
+  # Developmnet Dependencies
+  gem.add_development_dependency 'rspec', ['~> 2.10']
+  gem.add_development_dependency 'mocha', ['~> 0.11']
+end

data/lib/koality.rb

@@ -0,0 +1,43 @@
+require 'koality/version'
+require 'koality/options'
+require 'koality/reporter/base'
+require 'koality/reporter/cane'
+require 'koality/reporter/rails_best_practices'
+require 'koality/runner/cane'
+require 'koality/runner/rails_best_practices'
+
+module Koality
+
+  class << self
+    def run
+      setup_environment
+
+      run_rails_bp if options.rails_bp_enabled?
+
+      success = run_cane
+      abort if options[:abort_on_failure] && !success
+    end
+
+    def run_rails_bp
+      rails_bp = Koality::Runner::RailsBestPractices.new(options)
+      rails_bp.run
+    end
+
+    def run_cane
+      cane = Koality::Runner::Cane.new(options)
+      cane.run
+    end
+
+    def options
+      @options ||= Koality::Options.new
+    end
+
+    private
+
+    def setup_environment
+      options.ensure_output_directory_exists
+    end
+  end
+
+end
+

data/lib/koality/options.rb

@@ -0,0 +1,120 @@
+require 'forwardable'
+require 'fileutils'
+
+module Koality
+  class Options
+    extend Forwardable
+
+    DEFAULTS = {
+      :abc_file_pattern               => '{app,lib}/**/*.rb',
+      :abc_threshold                  => 15,
+      :abc_violations_threshold       => 0,
+      :abc_enabled                    => true,
+
+      :style_file_pattern             => '{app,lib,spec}/**/*.{rb,coffee,js}',
+      :style_line_length_threshold    => 120,
+      :style_violations_threshold     => 0,
+      :style_enabled                  => true,
+
+      :doc_file_pattern               => '{app,lib}/**/*.rb',
+      :doc_violations_threshold       => 0,
+      :doc_enabled                    => false,
+
+      :code_coverage_threshold        => 90,
+      :code_coverage_file             => 'code_coverage',
+      :code_coverage_enabled          => true,
+
+      :rails_bp_accept_patterns       => [],
+      :rails_bp_ignore_patterns       => [],
+      :rails_bp_errors_threshold      => 0,
+      :rails_bp_error_file            => 'rails_best_practices_errors',
+      :rails_bp_enabled               => true,
+
+      :custom_thresholds              => [],
+      :total_violations_threshold     => 0,
+      :abort_on_failure               => true,
+      :output_directory               => 'quality',
+
+      :colorize_output                => true
+    }
+
+    attr_accessor :opts
+
+    def_delegators :@opts, :[], :[]=
+
+    def initialize(overrides = {})
+      self.opts = DEFAULTS.merge(overrides)
+    end
+
+    # Add a threshold check. If the file exists and it contains a number,
+    # compare that number with the given value using the operator.
+    def add_threshold(file, operator, value)
+      custom_thresholds << [operator, file, value]
+    end
+
+    def thresholds
+      custom_thresholds + runner_thresholds
+    end
+
+    def runner_thresholds
+      runners = []
+      runners << rails_bp_custom_threshold if rails_bp_enabled?
+      runners << code_coverage_custom_threshold if code_coverage_enabled?
+      runners
+    end
+
+    def ensure_output_directory_exists
+      FileUtils.mkdir_p output_directory
+    end
+
+    def output_file(name)
+      File.join(output_directory, opts[name])
+    end
+
+    def rails_bp_enabled?
+      defined?(Rails) && rails_bp_enabled
+    end
+
+    def code_coverage_enabled?
+      code_coverage_enabled
+    end
+
+    def colorize_output?
+      colorize_output
+    end
+
+    def respond_to_missing?(method)
+      writer?(method) || reader?(method)
+    end
+
+    private
+
+    def method_missing(method, *args)
+      if opt = writer?(method)
+        opts[opt] = args.first
+      elsif opt = reader?(method)
+        opts[opt]
+      else
+        super
+      end
+    end
+
+    def writer?(method)
+      /^(?<option>.+)=$/ =~ method.to_s
+      option && opts.key?(option.to_sym) && option.to_sym
+    end
+
+    def reader?(method)
+      opts.key?(method.to_sym) && method.to_sym
+    end
+
+    def rails_bp_custom_threshold
+      [:<=, output_file(:rails_bp_error_file), rails_bp_errors_threshold]
+    end
+
+    def code_coverage_custom_threshold
+      [:>=, output_file(:code_coverage_file), code_coverage_threshold]
+    end
+
+  end
+end

data/lib/koality/rake_task.rb

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/tasklib'
+require 'koality'
+
+module Koality
+  class RakeTask < ::Rake::TaskLib
+
+    def initialize(task_name = :koality)
+      yield Koality.options if block_given?
+
+      define_task task_name
+    end
+
+    def define_task(task_name)
+      unless ::Rake.application.last_comment
+        desc %(Ensures various code metrics are met)
+      end
+
+      task task_name do
+        Koality.run
+      end
+    end
+
+  end
+end

data/lib/koality/reporter/base.rb

@@ -0,0 +1,39 @@
+require 'terminal-table'
+require 'term/ansicolor'
+require 'benchmark'
+
+class String
+  include Term::ANSIColor
+end
+
+module Koality
+  module Reporter
+    class Base
+
+      def self.start(&block)
+        reporter = new
+
+        time = Benchmark.measure do
+          yield reporter
+        end
+
+        puts "-- #{'%0.3f' % time.real}s\n\n"
+      end
+
+      private
+
+      def color(message, color_name)
+        if Koality.options.colorize_output?
+          message.to_s.send(color_name)
+        else
+          message
+        end
+      end
+
+      def build_table
+        Terminal::Table.new :style => {:width => 140, :padding_left => 2, :padding_right => 2}
+      end
+
+    end
+  end
+end