cane 1.0.0 → 1.1.0

data/HISTORY.md

@@ -1,5 +1,13 @@
 # Cane History
 
+## 1.1.0 - 24 March 2012 (ba8a74fc)
+
+* `app` added to default globs
+* Added `cane/rake_task`
+* `class << obj` syntax ignore by documentation check
+* Line length checks no longer include trailing new lines
+* Add support for a `.cane` file for setting per-project default options.
+
 ## 1.0.0 - 14 January 2012 (4e400534)
 
-Initial release.
+* Initial release.

data/LICENSE

@@ -0,0 +1,14 @@
+
+   Copyright 2012 Square Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -31,24 +31,57 @@ Customize behaviour with a wealth of options:
 
     > cane --help
     Usage: cane [options]
-            --abc-glob GLOB              Glob to run ABC metrics over (default: lib/**/*.rb)
-            --abc-max VALUE              Report any methods with complexity greater than VALUE (default: 15)
+
+    You can also put these options in a .cane file.
+
+            --abc-glob GLOB              Glob to run ABC metrics over (default: {app,lib}/**/*.rb)
+            --abc-max VALUE              Ignore methods under this complexity (default: 15)
             --no-abc                     Disable ABC checking
 
-            --style-glob GLOB            Glob to run style metrics over (default: {lib,spec}/**/*.rb)
+            --style-glob GLOB            Glob to run style metrics over (default: {app,lib,spec}/**/*.rb)
             --style-measure VALUE        Max line length (default: 80)
             --no-style                   Disable style checking
 
-            --doc-glob GLOB              Glob to run documentation metrics over (default: lib/**/*.rb)
+            --doc-glob GLOB              Glob to run documentation checks over (default: {app,lib}/**/*.rb)
             --no-doc                     Disable documentation checking
 
-            --gte FILE,THRESHOLD         If FILE contains a single number, verify it is >= to THRESHOLD.
+            --gte FILE,THRESHOLD         If FILE contains a number, verify it is >= to THRESHOLD.
 
             --max-violations VALUE       Max allowed violations (default: 0)
 
             --version                    Show version
         -h, --help                       Show this message
 
+Set default options into a `.cane` file:
+
+    > cat .cane
+    --no-doc
+    --abc-glob **/*.rb
+    > cane
+
+It works just like this:
+
+    > cane --no-doc --abc-glob '**/*.rb'
+
+## Integrating with Rake
+
+    begin
+      require 'cane/rake_task'
+
+      desc "Run cane to check quality metrics"
+      Cane::RakeTask.new(:quality) do |cane|
+        cane.abc_max = 10
+        cane.add_threshold 'coverage/covered_percent', :>=, 99
+      end
+
+      task :default => :quality
+    rescue LoadError
+      warn "cane not available, quality task not provided."
+    end
+
+Rescuing `LoadError` is a good idea, since `rake -T` failing is totally
+frustrating.
+
 ## Adding to a legacy project
 
 Cane can be configured to still pass in the presence of a set number of
@@ -87,3 +120,16 @@ Requires MRI 1.9, since it depends on the `ripper` library to calculate
 complexity metrics. This only applies to the Ruby used to run Cane, not the
 project it is being run against. In other words, you can run Cane against your
 1.8 project.
+
+## Support
+
+[Ask questions on Stack
+Overflow](http://stackoverflow.com/questions/ask?tags=ruby+cane). We keep an
+eye on new cane questions.
+
+## Contributing
+
+Fork and patch! Before any changes are merged to master, we need you to sign an
+[Individual Contributor
+Agreement](https://spreadsheets.google.com/a/squareup.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1)
+(Google Form).

data/bin/cane

@@ -1,9 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
-
-$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
-
 require 'cane/cli'
 
 result = Cane::CLI.run(ARGV)

data/cane.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.files         = Dir.glob("{spec,lib}/**/*.rb") + %w(
                         README.md
                         HISTORY.md
+                        LICENSE
                         cane.gemspec
                       )
   gem.test_files    = Dir.glob("spec/**/*.rb")

data/lib/cane/cli/spec.rb

@@ -1,3 +1,4 @@
+require 'optparse'
 require 'cane/cli/translator'
 
 module Cane
@@ -7,11 +8,11 @@ module Cane
     # documentation, parsing, and default values.
     class Spec
       DEFAULTS = {
-        abc_glob:       'lib/**/*.rb',
+        abc_glob:       '{app,lib}/**/*.rb',
         abc_max:        '15',
-        style_glob:     '{lib,spec}/**/*.rb',
+        style_glob:     '{app,lib,spec}/**/*.rb',
         style_measure:  '80',
-        doc_glob:       'lib/**/*.rb',
+        doc_glob:       '{app,lib}/**/*.rb',
         max_violations: '0',
       }
 
@@ -20,6 +21,8 @@ module Cane
       class OptionsHandled < RuntimeError; end
 
       def initialize
+        add_banner
+
         add_abc_options
         add_style_options
         add_doc_options
@@ -31,12 +34,30 @@ module Cane
       end
 
       def parse(args)
-        parser.parse!(args)
+        parser.parse!(get_default_options + args)
+
         Translator.new(options, DEFAULTS).to_hash
       rescue OptionsHandled
         nil
       end
 
+      def get_default_options
+        if File.exists?('./.cane')
+          File.read('./.cane').gsub("\n", ' ').split(' ')
+        else
+          []
+        end
+      end
+
+      def add_banner
+        parser.banner = <<-BANNER
+Usage: cane [options]
+
+You can also put these options in a .cane file.
+
+BANNER
+      end
+
       def add_abc_options
         add_option %w(--abc-glob GLOB), "Glob to run ABC metrics over"
         add_option %w(--abc-max VALUE), "Ignore methods under this complexity"

data/lib/cane/cli/translator.rb

@@ -37,7 +37,9 @@ module Cane
       end
 
       def check_disabled(check, params)
-        ((params + [check]) & options.keys) == [check]
+        relevant_options = options.keys & params + [check]
+
+        check == relevant_options[-1]
       end
 
       def option_with_default(key)

data/lib/cane/doc_check.rb

@@ -25,7 +25,7 @@ module Cane
     end
 
     def class_definition?(line)
-      line =~ /^\s*class\s/
+      line =~ /^\s*class\s+/ and $'.index('<<') != 0
     end
 
     def comment?(line)

data/lib/cane/rake_task.rb

@@ -0,0 +1,75 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Cane
+  # Creates a rake task to run cane with given configuration.
+  #
+  # Examples
+  #
+  #   desc "Run code quality checks"
+  #   Cane::RakeTask.new(:quality) do |cane|
+  #     cane.abc_max = 10
+  #     cane.doc_glob = 'lib/**/*.rb'
+  #     cane.add_threshold 'coverage/covered_percent', :>=, 99
+  #   end
+  class RakeTask < ::Rake::TaskLib
+    attr_accessor :name
+
+    # Glob to run ABC metrics over (default: "lib/**/*.rb")
+    attr_accessor :abc_glob
+    # Max complexity of methods to allow (default: 15)
+    attr_accessor :abc_max
+    # Glob to run style checks over (default: "{lib,spec}/**/*.rb")
+    attr_accessor :style_glob
+    # Max line length (default: 80)
+    attr_accessor :style_measure
+    # Glob to run doc checks over (default: "lib/**/*.rb")
+    attr_accessor :doc_glob
+    # Max violations to tolerate (default: 0)
+    attr_accessor :max_violations
+
+    # 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)
+      @threshold << [operator, file, value]
+    end
+
+    def initialize(task_name = nil)
+      self.name = task_name || :cane
+      @threshold = []
+      yield self if block_given?
+
+      unless ::Rake.application.last_comment
+        desc %(Check code quality metrics with cane)
+      end
+
+      task name do
+        require 'cane/cli'
+        abort unless Cane.run(translated_options)
+      end
+    end
+
+    def options
+      [
+        :abc_glob,
+        :abc_max,
+        :doc_glob,
+        :max_violations,
+        :style_glob,
+        :style_measure
+      ].inject(threshold: @threshold) do |opts, setting|
+        value = self.send(setting)
+        opts[setting] = value unless value.nil?
+        opts
+      end
+    end
+
+    def default_options
+      Cane::CLI::Spec::DEFAULTS
+    end
+
+    def translated_options
+      Cane::CLI::Translator.new(options, default_options).to_hash
+    end
+  end
+end

data/lib/cane/style_check.rb

@@ -81,7 +81,7 @@ module Cane
 
     # Copy of parent method using a configurable line length.
     def too_long?
-      length = self.length
+      length = self.chomp.length
       if length > line_length_max
         print_problem "Line is >#{line_length_max} characters (#{length})"
         return true

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/cane_spec.rb

@@ -14,8 +14,7 @@ describe 'Cane' do
   def run(cli_args)
     result = nil
     output = capture_stdout do
-      default_cli_opts = %w(--no-style --no-abc --no-doc)
-      result = Cane::CLI.run(default_cli_opts + cli_args.split(' '))
+      result = Cane::CLI.run(cli_args.split(' '))
     end
 
     [output, result ? 0 : 1]
@@ -55,6 +54,14 @@ describe 'Cane' do
     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 ")
 
@@ -79,6 +86,24 @@ describe 'Cane' do
     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")
 
@@ -92,4 +117,14 @@ describe 'Cane' do
     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

@@ -11,6 +11,9 @@ 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

data/spec/spec_helper.rb

@@ -12,6 +12,16 @@ def make_file(content)
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-14 00:00:00.000000000 Z
+date: 2012-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tailor
-  requirement: &2156048880 !ruby/object:Gem::Requirement
+  requirement: &2160572120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156048880
+  version_requirements: *2160572120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156048380 !ruby/object:Gem::Requirement
+  requirement: &2160571620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2156048380
+  version_requirements: *2160571620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156047960 !ruby/object:Gem::Requirement
+  requirement: &2160571200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156047960
+  version_requirements: *2160571200
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2156047500 !ruby/object:Gem::Requirement
+  requirement: &2160570720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156047500
+  version_requirements: *2160570720
 description: Fails your build if code quality thresholds are not met
 email:
 - xavier@squareup.com
@@ -76,6 +76,7 @@ files:
 - 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/threshold_check.rb
@@ -85,6 +86,7 @@ files:
 - lib/cane.rb
 - README.md
 - HISTORY.md
+- LICENSE
 - cane.gemspec
 - bin/cane
 homepage: http://github.com/square/cane
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Fails your build if code quality thresholds are not met. Provides complexity