cane 1.2.0 → 1.3.0

data/HISTORY.md

@@ -1,5 +1,10 @@
 # Cane History
 
+## 1.3.0 - 20 April 2012 (c166dfa0)
+
+* Remove dependency on tailor. Fewer styles checks are performed, but the three
+  remaining are the only ones I've found useful.
+
 ## 1.2.0 - 31 March 2012 (adce51b9)
 
 * Gracefully handle files with invalid syntax (#1)

data/cane.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |gem|
   gem.executables  << "cane"
   gem.version       = Cane::VERSION
   gem.has_rdoc      = false
-  gem.add_dependency 'tailor'
   gem.add_development_dependency 'rspec', '~> 2.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov'

data/lib/cane/style_check.rb

@@ -1,97 +1,44 @@
-require 'tailor'
-
 require 'cane/style_violation'
 
 module Cane
 
-  # Creates violations for files that do not meet style conventions. This uses
-  # the `tailor` gem, configured to exclude some of its less reliable checks
-  # (mostly spacing around punctuation).
+  # Creates violations for files that do not meet style conventions. Only
+  # highly obvious, probable, and non-controversial checks are performed here.
+  # It is not the goal of the tool to provide an extensive style report, but
+  # only to prevent studid mistakes.
   class StyleCheck < Struct.new(:opts)
     def violations
-      Dir[opts.fetch(:files)].map do |file_name|
-        find_violations_in_file(file_name)
+      file_list.map do |file_path|
+        map_lines(file_path) do |line, line_number|
+          violations_for_line(line.chomp).map do |message|
+            StyleViolation.new(file_path, line_number + 1, message)
+          end
+        end
       end.flatten
     end
 
     protected
 
-    def find_violations_in_file(file_name)
-      source    = File.open(file_name, 'r:utf-8')
-      file_path = Pathname.new(file_name)
-
-      source.each_line.map.with_index do |source_line, line_number|
-        violations_for_line(file_path, source_line, line_number)
+    def violations_for_line(line)
+      result = []
+      if line.length > measure
+        result << "Line is >%i characters (%i)" % [measure, line.length]
       end
+      result << "Line contains trailing whitespace" if line =~ /\s$/
+      result << "Line contains hard tabs"           if line =~ /\t/
+      result
     end
 
-    def violations_for_line(file_path, source_line, line_number)
-      FileLine.new(source_line, opts).problems.map do |message|
-        StyleViolation.new(file_path, line_number + 1, message)
-      end
-    end
-  end
-
-  # The `tailor` gem was not designed to be used as a library, so interfacing
-  # with it is a bit of a mess. This wrapper is attempt to confine that mess to
-  # a single point in the code.
-  class FileLine < Tailor::FileLine
-    attr_accessor :opts
-
-    def initialize(source_line, opts)
-      self.opts = opts
-
-      super(source_line, nil, nil)
-    end
-
-    def find_problems
-      # This is weird. These methods actually have side-effects! We capture
-      # the effects my monkey-patching #print_problem below.
-      spacing_problems
-      method_line? && camel_case_method?
-      class_line?  && snake_case_class?
-      too_long?
-    end
-
-    def print_problem(message)
-      @problems << message.gsub(/\[.+\]\s+/, '')
+    def file_list
+      Dir[opts.fetch(:files)]
     end
 
-    def problems
-      @problems = []
-      find_problems
-      @problems
-    end
-
-    # A copy of the parent method that only uses a small subset of the spacing
-    # checks we actually want (the others are too buggy or controversial).
-    def spacing_problems
-      spacing_conditions.each_pair do |condition, values|
-        unless self.scan(values.first).empty?
-          print_problem values[1]
-        end
-      end
-    end
-
-    def spacing_conditions
-      SPACING_CONDITIONS.select {|k, _|
-        [:hard_tabbed, :trailing_whitespace].include?(k)
-      }
-    end
-
-    # Copy of parent method using a configurable line length.
-    def too_long?
-      length = self.chomp.length
-      if length > line_length_max
-        print_problem "Line is >#{line_length_max} characters (#{length})"
-        return true
-      end
-
-      false
+    def measure
+      opts.fetch(:measure)
     end
 
-    def line_length_max
-      opts.fetch(:measure)
+    def map_lines(file_path, &block)
+      File.open(file_path).each_line.map.with_index(&block)
     end
   end
 

data/lib/cane/version.rb

@@ -1,3 +1,3 @@
 module Cane
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cane
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-31 00:00:00.000000000 Z
+date: 2012-04-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: tailor
-  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
@@ -130,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.18
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Fails your build if code quality thresholds are not met. Provides complexity