sparqcode_cane 1.3.0.1

data/lib/cane/version.rb

@@ -0,0 +1,3 @@
+module Cane
+  VERSION = '1.3.0.1'
+end

data/lib/cane/violation_formatter.rb

@@ -0,0 +1,49 @@
+require 'stringio'
+
+module Cane
+
+  # Computes a string to be displayed as output from an array of violations
+  # computed by the checks.
+  class ViolationFormatter < Struct.new(:violations)
+    def to_s
+      return '' if violations.empty?
+
+      grouped_violations.map do |description, violations|
+        format_group_header(description, violations) +
+          format_violations(violations)
+      end.flatten.join("\n") + "\n\n"
+    end
+
+    protected
+
+    def format_group_header(description, violations)
+      ["", "%s (%i):" % [description, violations.length], ""]
+    end
+
+    def format_violations(violations)
+      column_widths = calculate_columm_widths(violations)
+
+      violations.map do |violation|
+        format_violation(violation, column_widths)
+      end
+    end
+
+    def format_violation(violation, column_widths)
+      [
+        '  ' + violation.columns.map.with_index { |column, index|
+          "%-#{column_widths[index]}s" % column
+        }.join('  ')
+      ]
+    end
+
+    def calculate_columm_widths(violations)
+      violations.map { |violation|
+        violation.columns.map { |x| x.to_s.length }
+      }.transpose.map(&:max)
+    end
+
+    def grouped_violations
+      violations.group_by(&:description)
+    end
+  end
+end

data/spec/abc_check_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+require 'cane/abc_check'
+
+describe Cane::AbcCheck do
+  it 'creates an AbcMaxViolation for each method above the threshold' do
+    file_name = make_file(<<-RUBY)
+      class Harness
+        def not_complex
+          true
+        end
+
+        def complex_method(a)
+          b = a
+          return b if b > 3
+        end
+      end
+    RUBY
+
+    violations = described_class.new(files: file_name, max: 1).violations
+    violations.length.should == 1
+    violations[0].should be_instance_of(Cane::AbcMaxViolation)
+    violations[0].columns.should == [file_name, "Harness > complex_method", 2]
+  end
+
+  it 'sorts violations by complexity' do
+    file_name = make_file(<<-RUBY)
+      class Harness
+        def not_complex
+          true
+        end
+
+        def complex_method(a)
+          b = a
+          return b if b > 3
+        end
+      end
+    RUBY
+
+    violations = described_class.new(files: file_name, max: 0).violations
+    violations.length.should == 2
+    complexities = violations.map(&:complexity)
+    complexities.should == complexities.sort.reverse
+  end
+
+  it 'creates a SyntaxViolation when code cannot be parsed' do
+    file_name = make_file(<<-RUBY)
+      class Harness
+    RUBY
+
+    violations = described_class.new(files: file_name).violations
+    violations.length.should == 1
+    violations[0].should be_instance_of(Cane::SyntaxViolation)
+    violations[0].columns.should == [file_name]
+    violations[0].description.should be_instance_of(String)
+  end
+
+  def self.it_should_extract_method_name(method_name, label=method_name)
+    it "creates an AbcMaxViolation for #{method_name}" do
+      file_name = make_file(<<-RUBY)
+        class Harness
+          def #{method_name}(a)
+            b = a
+            return b if b > 3
+          end
+        end
+      RUBY
+
+      violations = described_class.new(files: file_name, max: 1).violations
+      violations[0].detail.should == "Harness > #{label}"
+    end
+  end
+
+  # These method names all create different ASTs. Which is weird.
+  it_should_extract_method_name 'a'
+  it_should_extract_method_name 'self.a', 'a'
+  it_should_extract_method_name 'next'
+  it_should_extract_method_name 'GET'
+  it_should_extract_method_name '`'
+  it_should_extract_method_name '>='
+end

data/spec/cane_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require "stringio"
+require 'cane/cli'
+
+describe 'Cane' do
+  def capture_stdout &block
+    real_stdout, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = real_stdout
+  end
+
+  def run(cli_args)
+    result = nil
+    output = capture_stdout do
+      result = Cane::CLI.run(cli_args.split(' '))
+    end
+
+    [output, result ? 0 : 1]
+  end
+
+  it 'fails if ABC metric does not meet requirements' do
+    file_name = make_file(<<-RUBY)
+      class Harness
+        def complex_method(a)
+          if a < 2
+            return "low"
+          else
+            return "high"
+          end
+        end
+      end
+    RUBY
+
+    _, exitstatus = run("--abc-glob #{file_name} --abc-max 1")
+
+    exitstatus.should == 1
+  end
+
+  it 'fails if style metrics do not meet requirements' do
+    file_name = make_file("whitespace ")
+
+    output, exitstatus = run("--style-glob #{file_name}")
+    exitstatus.should == 1
+    output.should include("Lines violated style requirements")
+  end
+
+  it 'allows measure to be configured' do
+    file_name = make_file("toolong")
+
+    output, exitstatus = run("--style-glob #{file_name} --style-measure 3")
+    exitstatus.should == 1
+    output.should include("Lines violated style requirements")
+  end
+
+  it 'does not include trailing new lines in the character count' do
+    file_name = make_file('#' * 80 + "\n" + '#' * 80)
+
+    output, exitstatus = run("--style-glob #{file_name} --style-measure 80")
+    exitstatus.should == 0
+    output.should be_empty
+  end
+
+  it 'allows upper bound of failed checks' do
+    file_name = make_file("whitespace ")
+
+    output, exitstatus = run("--style-glob #{file_name} --max-violations 1")
+    exitstatus.should == 0
+    output.should include("Lines violated style requirements")
+  end
+
+  it 'allows checking of a value in a file' do
+    file_name = make_file("89")
+
+    output, exitstatus = run("--gte #{file_name},90")
+    exitstatus.should == 1
+    output.should include("Quality threshold crossed")
+  end
+
+  it 'allows checking of class documentation' do
+    file_name = make_file("class NoDoc")
+
+    output, exitstatus = run("--doc-glob #{file_name}")
+    exitstatus.should == 1
+    output.should include("Classes are not documented")
+  end
+
+  context 'with a .cane file' do
+    before(:each) do
+      file_name = make_file("class NoDoc")
+      make_dot_cane("--doc-glob #{file_name}")
+    end
+
+    after(:each) do
+      unmake_dot_cane
+    end
+
+    it 'loads options from a .cane file' do
+      output, exitstatus = run('')
+
+      exitstatus.should == 1
+      output.should include("Classes are not documented")
+    end
+  end
+
+  it 'displays a help message' do
+    output, exitstatus = run("--help")
+
+    exitstatus.should == 0
+    output.should include("Usage:")
+  end
+
+  it 'displays version' do
+    output, exitstatus = run("--version")
+
+    exitstatus.should == 0
+    output.should include(Cane::VERSION)
+  end
+
+  it 'uses the last of conflicting arguments' do
+    file_name = make_file("class NoDoc")
+
+    run("--doc-glob #{file_name} --no-doc").should ==
+      run("--no-doc")
+
+    run("--no-doc --doc-glob #{file_name}").should ==
+      run("--doc-glob #{file_name}")
+  end
+end

data/spec/doc_check_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'cane/doc_check'
+
+describe Cane::DocCheck do
+  it 'creates a DocViolation for each undocumented class' do
+    file_name = make_file <<-RUBY
+# This class is documented
+class Doc; end
+class NoDoc; end # No doc
+  class AlsoNoDoc; end
+[:class]
+# class Ignore
+class Meta
+  class << self; end
+end
+    RUBY
+
+    violations = described_class.new(files: file_name).violations
+    violations.length.should == 2
+
+    violations[0].should be_instance_of(Cane::UndocumentedClassViolation)
+    violations[0].file_name.should == file_name
+    violations[0].number.should == 3
+
+    violations[1].should be_instance_of(Cane::UndocumentedClassViolation)
+    violations[1].file_name.should == file_name
+    violations[1].number.should == 4
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'tempfile'
+
+# 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 make_dot_cane(content)
+  File.open('./.cane', 'w') do |f|
+    f.puts content
+  end
+end
+
+def unmake_dot_cane
+  FileUtils.rm('./.cane')
+end
+
+require 'simplecov'
+
+class SimpleCov::Formatter::QualityFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    File.open("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

data/spec/style_check_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+require 'cane/style_check'
+
+describe Cane::StyleCheck do
+  it 'creates a StyleViolation for each method above the threshold' do
+    ruby = [
+      "def test  ",
+      "\t1",
+      "end"
+    ].join("\n")
+    file_name = make_file(ruby)
+
+    violations = Cane::StyleCheck.new(files: file_name, measure: 80).violations
+    violations.length.should == 2
+    violations[0].should be_instance_of(StyleViolation)
+  end
+end

data/spec/threshold_check_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+require 'cane/threshold_check'
+
+describe ThresholdCheck do
+  it 'returns a value of unavailable when file cannot be read' do
+    check = ThresholdCheck.new([[:>=, 'bogus_file', 20]])
+    violations = check.violations
+    violations.length.should == 1
+    violations[0].to_s.should include("unavailable")
+  end
+end

data/spec/violation_formatter_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+require 'cane/violation_formatter'
+
+describe Cane::ViolationFormatter do
+  def violation(description)
+    stub("violation",
+      description: description,
+      columns:     []
+    )
+  end
+
+  it 'includes number of violations in the group header' do
+    described_class.new([violation("FAIL")]).to_s.should include("(1)")
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sparqcode_cane
+version: !ruby/object:Gem::Version
+  version: 1.3.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Shay, Mike Emery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fails your build if code quality thresholds are not met
+email:
+- xavier@squareup.com, mike@sparqcode.com
+executables:
+- cane
+extensions: []
+extra_rdoc_files: []
+files:
+- spec/abc_check_spec.rb
+- spec/cane_spec.rb
+- spec/doc_check_spec.rb
+- spec/spec_helper.rb
+- spec/style_check_spec.rb
+- spec/threshold_check_spec.rb
+- spec/violation_formatter_spec.rb
+- lib/cane/abc_check.rb
+- lib/cane/abc_max_violation.rb
+- lib/cane/cli/spec.rb
+- lib/cane/cli/translator.rb
+- lib/cane/cli.rb
+- lib/cane/doc_check.rb
+- lib/cane/rake_task.rb
+- lib/cane/style_check.rb
+- lib/cane/style_violation.rb
+- lib/cane/syntax_violation.rb
+- lib/cane/threshold_check.rb
+- lib/cane/threshold_violation.rb
+- lib/cane/version.rb
+- lib/cane/violation_formatter.rb
+- lib/cane.rb
+- README.md
+- HISTORY.md
+- LICENSE
+- cane.gemspec
+- bin/cane
+homepage: http://github.com/square/cane
+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.24
+signing_key: 
+specification_version: 3
+summary: 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.  SPARQCode
+  changed it so that instead of ABC checks it does cyclomatic complexity.
+test_files:
+- spec/abc_check_spec.rb
+- spec/cane_spec.rb
+- spec/doc_check_spec.rb
+- spec/spec_helper.rb
+- spec/style_check_spec.rb
+- spec/threshold_check_spec.rb
+- spec/violation_formatter_spec.rb