sugarcane 0.0.1

data/spec/parser_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+require "stringio"
+require 'sugarcane/cli/parser'
+
+describe SugarCane::CLI::Parser do
+  def run(cli_args)
+    result = nil
+    output = StringIO.new("")
+    result = SugarCane::CLI::Parser.new(output).parse(cli_args.split(/\s+/m))
+
+    [output.string, result]
+  end
+
+  it 'allows style options to be configured' do
+    output, result = run("--style-glob myfile --style-measure 3")
+    result[:style_glob].should == 'myfile'
+    result[:style_measure].should == 3
+  end
+
+  it 'allows checking gte of a value in a file' do
+    output, result = run("--gte myfile,90")
+    result[:gte].should == [['myfile', '90']]
+  end
+
+  it 'allows checking eq of a value in a file' do
+    output, result = run("--eq myfile,90")
+    result[:eq].should == [['myfile', '90']]
+  end
+
+  it 'allows checking lte of a value in a file' do
+    output, result = run("--lte myfile,90")
+    result[:lte].should == [['myfile', '90']]
+  end
+
+  it 'allows checking lt of a value in a file' do
+    output, result = run("--lt myfile,90")
+    result[:lt].should == [['myfile', '90']]
+  end
+
+  it 'allows checking gt of a value in a file' do
+    output, resugt = run("--gt myfile,90")
+    resugt[:gt].should == [['myfile', '90']]
+  end
+
+  it 'allows upper bound of failed checks' do
+    output, result = run("--max-violations 1")
+    result[:max_violations].should == 1
+  end
+
+  it 'uses positional arguments as shortcut for individual files' do
+    output, result = run("--all mysinglefile")
+    result[:abc_glob].should == 'mysinglefile'
+    result[:style_glob].should == 'mysinglefile'
+    result[:doc_glob].should == 'mysinglefile'
+
+    output, result = run("--all mysinglefile --abc-glob myotherfile")
+    result[:abc_glob].should == 'myotherfile'
+    result[:style_glob].should == 'mysinglefile'
+    result[:doc_glob].should == 'mysinglefile'
+  end
+
+  it 'displays a help message' do
+    output, result = run("--help")
+
+    result.should be
+    output.should include("Usage:")
+  end
+
+  it 'handles invalid options by showing help' do
+    output, result = run("--bogus")
+
+    output.should include("Usage:")
+    result.should_not be
+  end
+
+  it 'displays version' do
+    output, result = run("--version")
+
+    result.should be
+    output.should include(SugarCane::VERSION)
+  end
+
+  it 'supports exclusions' do
+    options = [
+      "--abc-exclude", "Harness#complex_method",
+      "--doc-exclude", 'myfile',
+      "--style-exclude", 'myfile'
+    ].join(' ')
+
+    _, result = run(options)
+    result[:abc_exclude].should == [['Harness#complex_method']]
+    result[:doc_exclude].should == [['myfile']]
+    result[:style_exclude].should == [['myfile']]
+  end
+
+  describe 'argument ordering' do
+    it 'gives precedence to the last argument #1' do
+      _, result = run("--doc-glob myfile --no-doc")
+      result[:no_doc].should be
+
+      _, result = run("--no-doc --doc-glob myfile")
+      result[:no_doc].should_not be
+    end
+  end
+
+  it 'loads default options from .sugarcane' do
+    defaults = <<-EOS
+      --no-doc
+      --abc-glob myfile
+      --style-glob myfile
+    EOS
+
+    SugarCane::File.stub(:exists?).with("./.sugarcane").and_return(true)
+    SugarCane::File.stub(:contents).with("./.sugarcane").and_return(defaults)
+
+    _, result = run("--style-glob myotherfile")
+
+    result[:no_doc].should be
+    result[:abc_glob].should == 'myfile'
+    result[:style_glob].should == 'myotherfile'
+  end
+
+  it 'loads default options from .cane if .sugarcane is not present' do
+    defaults = <<-EOS
+      --no-doc
+      --abc-glob myfile
+      --style-glob myfile
+    EOS
+
+    SugarCane::File.stub(:exists?).with("./.sugarcane").and_return(false)
+    SugarCane::File.stub(:exists?).with("./.cane").and_return(true)
+    SugarCane::File.stub(:contents).with("./.cane").and_return(defaults)
+
+    _, result = run("--style-glob myotherfile")
+
+    result[:no_doc].should be
+    result[:abc_glob].should == 'myfile'
+    result[:style_glob].should == 'myotherfile'
+  end
+
+  it 'allows parallel option' do
+    _, result = run("--parallel")
+    result[:parallel].should be
+  end
+
+  it 'handles ambiguous options' do
+    output, result = run("-abc-max")
+    output.should include("Usage:")
+    result.should_not be
+  end
+
+  it 'handles no_readme option' do
+    _, result = run("--no-readme")
+    result[:no_readme].should be
+  end
+
+  it 'handles json option' do
+    _, result = run("--json")
+    result[:json].should be
+  end
+end

data/spec/rake_task_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'sugarcane/rake_task'
+
+describe SugarCane::RakeTask do
+  it 'enables cane to be configured an run via rake' do
+    fn = make_file("90")
+    my_check = Class.new(Struct.new(:opts)) do
+      def violations
+        [description: 'test', label: opts.fetch(:some_opt)]
+      end
+    end
+
+    task = SugarCane::RakeTask.new(:quality) do |cane|
+      cane.no_abc = true
+      cane.no_doc = true
+      cane.no_style = true
+      cane.add_threshold fn, :>=, 99
+      cane.use my_check, some_opt: "theopt"
+      cane.max_violations = 0
+      cane.parallel = false
+    end
+
+    task.no_abc.should == true
+
+    task.should_receive(:abort)
+    out = capture_stdout do
+      Rake::Task['quality'].invoke
+    end
+
+    out.should include("Quality threshold crossed")
+    out.should include("theopt")
+  end
+
+  it 'can be configured using a .cane file' do
+    conf = "--gte 90,99"
+
+    task = SugarCane::RakeTask.new(:canefile_quality) do |cane|
+      cane.canefile = make_file(conf)
+    end
+
+    task.should_receive(:abort)
+    out = capture_stdout do
+      Rake::Task['canefile_quality'].invoke
+    end
+
+    out.should include("Quality threshold crossed")
+  end
+
+  it 'defaults to using a canefile without a block' do
+    in_tmp_dir do
+      conf = "--gte 90,99"
+      File.open('.cane', 'w') {|f| f.write conf }
+
+      task = SugarCane::RakeTask.new(:canefile_quality)
+
+      task.should_receive(:abort)
+      out = capture_stdout do
+        Rake::Task['canefile_quality'].invoke
+      end
+
+      out.should include("Quality threshold crossed")
+    end
+  end
+
+  after do
+    Rake::Task.clear
+  end
+end

data/spec/runner_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'sugarcane/runner'
+
+describe SugarCane::Runner do
+  describe '#run' do
+    it 'returns true iff fewer violations than max allowed' do
+      described_class.new(checks: [], max_violations: 0).run.should be
+      described_class.new(checks: [], max_violations: -1).run.should_not be
+    end
+
+    it 'returns JSON output' do
+      formatter = class_double("SugarCane::JsonFormatter").as_stubbed_const
+      formatter.should_receive(:new).and_return("JSON")
+      buffer = StringIO.new("")
+
+      described_class.new(
+        out: buffer, checks: [], max_violations: 0, json: true
+      ).run
+
+      buffer.string.should == "JSON"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+
+class SimpleCov::Formatter::QualityFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    File.open("tmp/coverage/covered_percent", "w") do |f|
+      f.puts result.source_files.covered_percent.to_i
+    end
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::QualityFormatter
+SimpleCov.start do
+  coverage_dir('tmp/coverage')
+  add_filter "vendor/bundle/"
+  add_filter "spec/"
+end
+
+require 'rspec/fire'
+require 'tempfile'
+require 'stringio'
+require 'rake'
+require 'rake/tasklib'
+
+RSpec.configure do |config|
+  config.include(RSpec::Fire)
+
+  def capture_stdout &block
+    real_stdout, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = real_stdout
+  end
+end
+
+# Keep a reference to all tempfiles so they are not garbage collected until the
+# process exits.
+$tempfiles = []
+
+def make_file(content)
+  tempfile = Tempfile.new('cane')
+  $tempfiles << tempfile
+  tempfile.print(content)
+  tempfile.flush
+  tempfile.path
+end
+
+def in_tmp_dir(&block)
+  Dir.mktmpdir do |dir|
+    Dir.chdir(dir, &block)
+  end
+end
+
+RSpec::Matchers.define :have_violation do |label|
+  match do |check|
+    violations = check.violations
+    violations.length.should == 1
+    violations[0][:label].should == label
+  end
+end
+
+RSpec::Matchers.define :have_no_violations do |label|
+  match do |check|
+    violations = check.violations
+    violations.length.should == 0
+  end
+end
+

data/spec/style_check_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'sugarcane/style_check'
+
+describe SugarCane::StyleCheck do
+  def check(file_name, opts = {})
+    described_class.new(opts.merge(style_glob: file_name))
+  end
+
+  let(:ruby_with_style_issue) do
+    [
+      "def test  ",
+      "\t1",
+      "end"
+    ].join("\n")
+  end
+
+  it 'creates a StyleViolation for each method above the threshold' do
+    file_name = make_file(ruby_with_style_issue)
+
+    violations = check(file_name, style_measure: 8).violations
+    violations.length.should == 3
+  end
+
+  it 'skips declared exclusions' do
+    file_name = make_file(ruby_with_style_issue)
+
+    violations = check(file_name,
+      style_measure: 80,
+      style_exclude: [file_name]
+    ).violations
+
+    violations.length.should == 0
+  end
+
+  it 'skips declared glob-based exclusions' do
+    file_name = make_file(ruby_with_style_issue)
+
+    violations = check(file_name,
+      style_measure: 80,
+      style_exclude: ["#{File.dirname(file_name)}/*"]
+    ).violations
+
+    violations.length.should == 0
+  end
+
+  it 'does not include trailing new lines in the character count' do
+    file_name = make_file('#' * 80 + "\n" + '#' * 80)
+
+    violations = check(file_name,
+      style_measure: 80,
+      style_exclude: [file_name]
+    ).violations
+
+    violations.length.should == 0
+  end
+
+end

data/spec/threshold_check_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'sugarcane/threshold_check'
+
+describe SugarCane::ThresholdCheck do
+
+  let(:simplecov_last_run) do
+    <<-ENDL
+    {
+      "result": {
+        "covered_percent": 93.88
+      }
+    }
+    ENDL
+  end
+
+  context "checking violations" do
+
+    def run(threshold, value)
+      described_class.new(threshold => [['x', value]])
+    end
+
+    context "when the current coverage cannot be read" do
+      it do
+        run(:gte, 20).should \
+          have_violation('x is unavailable, should be >= 20.0')
+      end
+    end
+
+    context "when the coverage threshold is incorrectly specified" do
+      it do
+        described_class.new(gte: [['20', 'bogus_file']]).should \
+          have_violation('bogus_file is not a number or a file')
+      end
+    end
+
+    context 'when coverage threshold is valid' do
+      before do
+        file = class_double("SugarCane::File").as_stubbed_const
+        stub_const("SugarCane::File", file)
+        file.should_receive(:contents).with('x').and_return("8\n")
+      end
+
+      context '>' do
+        it { run(:gt, 7).should have_no_violations }
+        it { run(:gt, 8).should have_violation('x is 8.0, should be > 8.0') }
+        it { run(:gt, 9).should have_violation('x is 8.0, should be > 9.0') }
+      end
+
+      context '>=' do
+        it { run(:gte, 7).should have_no_violations }
+        it { run(:gte, 8).should have_no_violations }
+        it { run(:gte, 9).should have_violation('x is 8.0, should be >= 9.0') }
+      end
+
+      context '==' do
+        it { run(:eq, 7).should have_violation('x is 8.0, should be == 7.0') }
+        it { run(:eq, 8).should have_no_violations }
+        it { run(:eq, 9).should have_violation('x is 8.0, should be == 9.0') }
+      end
+
+      context '<=' do
+        it { run(:lte, 7).should have_violation('x is 8.0, should be <= 7.0') }
+        it { run(:lte, 8).should have_no_violations }
+        it { run(:lte, 9).should have_no_violations }
+      end
+
+      context '<' do
+        it { run(:lt, 7).should have_violation('x is 8.0, should be < 7.0') }
+        it { run(:lt, 8).should have_violation('x is 8.0, should be < 8.0') }
+        it { run(:lt, 9).should have_no_violations }
+      end
+    end
+
+  end
+
+  context "normalizing a user supplied value to a threshold" do
+    it "normalizes an integer to itself" do
+      subject.normalized_limit(99).should == 99
+    end
+
+    it "normalizes a float to itself" do
+      subject.normalized_limit(99.6).should == 99.6
+    end
+
+    it "normalizes a valid file to its contents" do
+      subject.normalized_limit(make_file('99.5')).should == 99.5
+    end
+
+    it "normalizes an invalid file to an unavailable value" do
+      limit = subject.normalized_limit("/File.does.not.exist")
+      limit.should be_a SugarCane::ThresholdCheck::UnavailableValue
+    end
+
+
+    it 'normalizes a json file to a float' do
+      subject.normalized_limit(make_file(simplecov_last_run)).should == 93.88
+    end
+
+  end
+
+end

data/spec/violation_formatter_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'sugarcane/violation_formatter'
+
+describe SugarCane::ViolationFormatter do
+  def violation(description)
+    {
+      description: description
+    }
+  end
+
+  it 'includes number of violations in the group header' do
+    described_class.new([violation("FAIL")]).to_s.should include("(1)")
+  end
+
+  it 'includes total number of violations' do
+    violations = [violation("FAIL1"), violation("FAIL2")]
+    result = described_class.new(violations).to_s
+    result.should include("Total Violations: 2")
+  end
+
+  it 'does not colorize output by default' do
+    result = described_class.new([violation("FAIL")]).to_s
+    result.should_not include("\e[31m")
+  end
+
+  it 'colorizes output when passed color: true' do
+    result = described_class.new([violation("FAIL")], color: true).to_s
+    result.should include("\e[31m")
+    result.should include("\e[0m")
+  end
+
+  it 'does not colorize output if max_violations is not crossed' do
+    options = { color: true, max_violations: 1 }
+    result = described_class.new([violation("FAIL")], options).to_s
+
+    result.should_not include("\e[31m")
+  end
+end

data/sugarcane.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'sugarcane/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Robert Qualls"]
+  gem.email         = ["robert@robertqualls.com"]
+  gem.description   = "Cane with a menu that opens a text editor for each issue"
+  gem.summary       = %q{
+    Fails your build if code quality thresholds are not met. Provides
+    complexity and style checkers built-in, and allows integration with with
+    custom quality metrics.
+  }
+  gem.homepage      = "http://github.com/rlqualls/sugarcane"
+
+  gem.executables   = []
+  gem.required_ruby_version = '>= 1.9.0'
+  gem.files         = Dir.glob("{spec,lib}/**/*.rb") + %w(
+                        README.md
+                        HISTORY.md
+                        LICENSE
+                        sugarcane.gemspec
+                      )
+  gem.test_files    = Dir.glob("spec/**/*.rb")
+  gem.name          = "sugarcane"
+  gem.require_paths = ["lib"]
+  gem.bindir        = "bin"
+  gem.executables  << "sugarcane"
+  gem.license       = "Apache 2.0"
+  gem.version       = SugarCane::VERSION
+  gem.has_rdoc      = false
+
+  gem.add_dependency 'parallel'
+  gem.add_dependency 'ncursesw'
+
+  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rspec-fire', '~> 1.2.0'
+end