cane 2.6.0 → 2.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1eef945328c09e0abccd91652842a632f639eac0
+  data.tar.gz: 5c154f5d285bea2fd7d5d0549436a16ace066ca8
+SHA512:
+  metadata.gz: a4d12974def26b1bfb704167090c2c56a50d5fb134b598821a532fadfb4f75cbce155d017734a2720d06ce851be65bf4a413886ca403a5dde3a2365b3f1fe5bc
+  data.tar.gz: e5a7b0b163105d6eab4e2e92522693552d034503f12e10de7e45268ae80a330ba203e8c77bdb305bfc8fc519a4f29ef71f9f5ee870e974f8c08dc3c7559883a9

data/HISTORY.md

@@ -1,5 +1,11 @@
 # Cane History
 
+## 2.6.1 - 30 October 2013 (2ea008)
+
+* Feature: Don't require doc for one-line class w/out method.
+* Bugfix: JsonFormatter initializer needs to take an options hash.
+* Doc: Add license definition to gemspec.
+
 ## 2.6.0 - 7 June 2013 (616bb8a5)
 
 * Feature: classes with no methods do not require documentation.

data/README.md

@@ -79,21 +79,23 @@ Command-line arguments will override arguments specified in the `.cane` file.
 
 ## 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
-        cane.no_style = true
-        cane.abc_exclude = %w(Foo::Bar#some_method)
-      end
-
-      task :default => :quality
-    rescue LoadError
-      warn "cane not available, quality task not provided."
-    end
+```ruby
+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
+    cane.no_style = true
+    cane.abc_exclude = %w(Foo::Bar#some_method)
+  end
+
+  task :default => :quality
+rescue LoadError
+  warn "cane not available, quality task not provided."
+end
+```
 
 Loading options from a `.cane` file is supported by setting `canefile=` to the
 file name.
@@ -137,22 +139,24 @@ Checks must implement:
 
 See existing checks for guidance. Create your check in a new file:
 
-    # unhappy.rb
-    class UnhappyCheck < Struct.new(:opts)
-      def self.options
-        {
-          unhappy_file: ["File to check", default: [nil]]
-        }
-      end
-
-      def violations
-        [
-          description: "Files are unhappy",
-          file:        opts.fetch(:unhappy_file),
-          label:       ":("
-        ]
-      end
-    end
+```ruby
+# unhappy.rb
+class UnhappyCheck < Struct.new(:opts)
+  def self.options
+    {
+      unhappy_file: ["File to check", default: [nil]]
+    }
+  end
+
+  def violations
+    [
+      description: "Files are unhappy",
+      file:        opts.fetch(:unhappy_file),
+      label:       ":("
+    ]
+  end
+end
+```
 
 Include your check either using command-line options:
 
@@ -160,11 +164,13 @@ Include your check either using command-line options:
 
 Or in your rake task:
 
-    require 'unhappy'
+```ruby
+require 'unhappy'
 
-    Cane::RakeTask.new(:quality) do |c|
-      c.use UnhappyCheck, unhappy_file: 'myfile'
-    end
+Cane::RakeTask.new(:quality) do |c|
+  c.use UnhappyCheck, unhappy_file: 'myfile'
+end
+```
 
 ## Protips
 

data/cane.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.bindir        = "bin"
   gem.executables  << "cane"
+  gem.license       = "Apache 2.0"
   gem.version       = Cane::VERSION
   gem.has_rdoc      = false
   gem.add_dependency 'parallel'

data/lib/cane/doc_check.rb

@@ -43,6 +43,10 @@ module Cane
 
     CLASS_REGEX = /^\s*(?:class|module)\s+([^\s;]+)/
 
+    # http://rubular.com/r/53BapkefdD
+    SINGLE_LINE_CLASS_REGEX =
+      /^\s*(?:class|module).*;\s*end\s*(#.*)?\s*$/
+
     METHOD_REGEX = /(?:^|\s)def\s+/
 
     def violations
@@ -67,26 +71,35 @@ module Cane
     end
 
     def class_definitions_in(file_name)
-      class_definitions = []
+      closed_classes = []
+      open_classes = []
       last_line = ""
 
       Cane::File.iterator(file_name).each_with_index do |line, number|
         if class_definition? line
-          class_definitions << ClassDefinition.new({
-            line: (number + 1),
-            label: extract_class_name(line),
-            has_doc: comment?(last_line)
-          })
-        end
-
-        if method_definition?(line) && !class_definitions.empty?
-          class_definitions.last.requires_doc = true
+          if single_line_class_definition? line
+            closed_classes
+          else
+            open_classes
+          end.push class_definition(number, line, last_line)
+
+        elsif method_definition?(line) && !open_classes.empty?
+          open_classes.last.requires_doc = true
         end
 
         last_line = line
       end
 
-      class_definitions
+      (closed_classes + open_classes).sort_by(&:line)
+    end
+
+    def class_definition(number, line, last_line)
+      ClassDefinition.new({
+        line: (number + 1),
+        label: extract_class_name(line),
+        has_doc: comment?(last_line),
+        requires_doc: method_definition?(line)
+      })
     end
 
     def missing_file_violations
@@ -112,6 +125,10 @@ module Cane
       line =~ CLASS_REGEX && $1.index('<<') != 0
     end
 
+    def single_line_class_definition?(line)
+      line =~ SINGLE_LINE_CLASS_REGEX
+    end
+
     def comment?(line)
       line =~ /^\s*#/ && !(MAGIC_COMMENT_REGEX =~ line)
     end

data/lib/cane/json_formatter.rb

@@ -5,7 +5,7 @@ module Cane
   # Computes a machine-readable JSON representation from an array of violations
   # computed by the checks.
   class JsonFormatter
-    def initialize(violations)
+    def initialize(violations, options = {})
       @violations = violations
     end
 

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '2.6.0'
+  VERSION = '2.6.1'
 end

data/spec/doc_check_spec.rb

@@ -9,7 +9,6 @@ describe Cane::DocCheck do
 
   it 'creates a DocViolation for each undocumented class with a method' do
     file_name = make_file <<-RUBY
-# This class is documented
 class Doc; end
 class  Empty; end # No doc is fine
   class NoDoc; def with_method; end; end
@@ -43,15 +42,39 @@ end
     violations.length.should == 3
 
     violations[0].values_at(:file, :line, :label).should == [
-      file_name, 4, "NoDoc"
+      file_name, 3, "NoDoc"
     ]
 
     violations[1].values_at(:file, :line, :label).should == [
-      file_name, 16, "AlsoNeedsDoc"
+      file_name, 15, "AlsoNeedsDoc"
     ]
 
     violations[2].values_at(:file, :line, :label).should == [
-      file_name, 18, "ButThisNeedsDoc"
+      file_name, 17, "ButThisNeedsDoc"
+    ]
+  end
+
+  it 'does not create violations for single line classes without methods' do
+    file_name = make_file <<-RUBY
+class NeedsDoc
+  class AlsoNeedsDoc < StandardError; def foo; end; end
+  class NoDocIsOk < StandardError; end
+  class NoDocIsAlsoOk < StandardError; end # No doc is fine on this too
+
+  def my_method
+  end
+end
+RUBY
+
+    violations = check(file_name).violations
+    violations.length.should == 2
+
+    violations[0].values_at(:file, :line, :label).should == [
+      file_name, 1, "NeedsDoc"
+    ]
+
+    violations[1].values_at(:file, :line, :label).should == [
+      file_name, 2, "AlsoNeedsDoc"
     ]
   end
 

data/spec/spec_helper.rb

@@ -61,4 +61,6 @@ class SimpleCov::Formatter::QualityFormatter
 end
 
 SimpleCov.formatter = SimpleCov::Formatter::QualityFormatter
-SimpleCov.start
+SimpleCov.start do
+  add_filter "vendor/bundle/"
+end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 2.6.0
-  prerelease: 
+  version: 2.6.1
 platform: ruby
 authors:
 - Xavier Shay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,49 +41,43 @@ dependencies:
 - !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'
 - !ruby/object:Gem::Dependency
   name: rspec-fire
   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
@@ -136,28 +125,28 @@ files:
 - cane.gemspec
 - bin/cane
 homepage: http://github.com/square/cane
-licenses: []
+licenses:
+- Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 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.
 test_files:
@@ -175,3 +164,4 @@ test_files:
 - spec/style_check_spec.rb
 - spec/threshold_check_spec.rb
 - spec/violation_formatter_spec.rb
+has_rdoc: false