rubocop 0.0.0 → 0.1.0

data/lib/rubocop/cop/space_after_comma_etc.rb

@@ -0,0 +1,24 @@
+module Rubocop
+  module Cop
+    class SpaceAfterCommaEtc < Cop
+      ERROR_MESSAGE = 'Space missing after %s.'
+
+      def inspect(file, source, tokens, sexp)
+        tokens.each_index { |ix|
+          pos, name, text = tokens[ix]
+          kind = case name
+                 when :on_comma     then 'comma'
+                 when :on_label     then 'colon'
+                 when :on_op        then 'colon' if text == ':'
+                 when :on_semicolon then 'semicolon'
+                 end
+          if kind and not [:on_sp, :on_ignored_nl].include?(tokens[ix + 1][1])
+            index = pos[0] - 1
+            add_offence(:convention, index, source[index],
+                        ERROR_MESSAGE % kind)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/rubocop/cop/surrounding_space.rb

@@ -0,0 +1,44 @@
+require_relative 'grammar'
+
+module Rubocop
+  module Cop
+    class SurroundingSpace < Cop
+      ERROR_MESSAGE = 'Surrounding space missing for operator'
+
+      def inspect(file, source, tokens, sexp)
+        Grammar.new(tokens).correlate(sexp).sort.each { |ix, grammar_path|
+          pos, name, text = tokens[ix]
+          if name == :on_op
+            unless surrounded_by_whitespace?(tokens[ix - 1, 3])
+              unless ok_without_spaces?(grammar_path)
+                index = pos[0] - 1
+                add_offence(:convention, index, source[index],
+                            ERROR_MESSAGE + " '#{text}'.")
+              end
+            end
+          end
+        }
+      end
+
+      def ok_without_spaces?(grammar_path)
+        grandparent, parent, child = grammar_path.values_at(-3, -2, -1)
+        return true if [:unary, :symbol, :defs, :def, :call].include?(parent)
+        return true if [:rest_param, :blockarg, :block_var, :args_add_star,
+                        :args_add_block, :const_path_ref, :dot2,
+                        :dot3].include?(child)
+        return true if grandparent == :unary && parent == :vcall
+        return true if parent == :command_call && child == :'::'
+        false
+      end
+
+      def surrounded_by_whitespace?(nearby_tokens)
+        left, _, right = nearby_tokens
+        whitespace?(left) && whitespace?(right)
+      end
+
+      def whitespace?(token)
+        [:on_sp, :on_ignored_nl, :on_nl].include?(token[1])
+      end
+    end
+  end
+end

data/lib/rubocop/cop/tab.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class Tab < Cop
+      ERROR_MESSAGE = 'Tab detected.'
+
+      def inspect(file, source)
+        source.each_with_index do |line, index|
+          if line =~ /^ *\t/
+            add_offence(:convention, index, line, ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/trailing_whitespace.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class TrailingWhitespace < Cop
+      ERROR_MESSAGE = 'Trailing whitespace detected.'
+
+      def inspect(file, source)
+        source.each_with_index do |line, index|
+          if line =~ /.*[ \t]+$/
+            add_offence(:convention, index, line, ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/report/emacs_style.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Rubocop
+  module Report
+    # Plain text report, suitable for display in Emacs *compilation* buffers.
+    class EmacsStyle < PlainText
+      # Generates a string representation of the report
+      def generate
+        entries.map { |e|
+          "#@filename:#{e.line_number + 1}: #{e.encode_severity}: #{e.message}"
+        }.join("\n")
+      end
+    end
+  end
+end

data/lib/rubocop/report/plain_text.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Rubocop
+  module Report
+    # Plain text report, suitable for display in terminals.
+    class PlainText < Report
+      # Generates a string representation of the report
+      def generate
+        report = "== #{filename} ==\n"
+        report << entries.join("\n")
+      end
+
+      def display(stream = $stdout)
+        stream.puts generate
+      end
+    end
+  end
+end

data/lib/rubocop/report/report.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Rubocop
+  module Report
+    # Creates a Report object, based on the current settings
+    #
+    # @param [String] the filename for the report
+    # @return [Report] a report object
+    def create(file, output_mode = :default)
+      case output_mode
+      when :default     then PlainText.new(file)
+      when :emacs_style then EmacsStyle.new(file)
+      end
+    end
+
+    module_function :create
+
+    class Report
+      attr_accessor :entries
+      attr_accessor :filename
+
+      # @param [String] the filename for this report
+      def initialize(filename)
+        @filename = filename
+        @entries = []
+      end
+
+      # Appends offences registered by cops to the report.
+      # @param [Cop] a cop with something to report
+      def <<(cop)
+        cop.offences.each do |entry|
+          @entries << entry
+        end
+      end
+
+      def empty?
+        entries.empty?
+      end
+    end
+  end
+end

data/lib/rubocop/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Rubocop
   VERSION = "0.0.1"
 end

data/rubocop.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rubocop"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bozhidar Batsov"]
+  s.date = "2012-12-20"
+  s.description = "Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide."
+  s.email = "bozhidar@batsov.com"
+  s.executables = ["rubocop"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/rubocop",
+    "features/rubocop.feature",
+    "features/step_definitions/rubocop_steps.rb",
+    "features/support/env.rb",
+    "lib/rubocop.rb",
+    "lib/rubocop/cli.rb",
+    "lib/rubocop/cop/cop.rb",
+    "lib/rubocop/cop/empty_lines.rb",
+    "lib/rubocop/cop/encoding.rb",
+    "lib/rubocop/cop/grammar.rb",
+    "lib/rubocop/cop/indentation.rb",
+    "lib/rubocop/cop/line_length.rb",
+    "lib/rubocop/cop/offence.rb",
+    "lib/rubocop/cop/space_after_comma_etc.rb",
+    "lib/rubocop/cop/surrounding_space.rb",
+    "lib/rubocop/cop/tab.rb",
+    "lib/rubocop/cop/trailing_whitespace.rb",
+    "lib/rubocop/report/emacs_style.rb",
+    "lib/rubocop/report/plain_text.rb",
+    "lib/rubocop/report/report.rb",
+    "lib/rubocop/version.rb",
+    "rubocop.gemspec",
+    "spec/rubocop/cli_spec.rb",
+    "spec/rubocop/cops/cop_spec.rb",
+    "spec/rubocop/cops/empty_lines_spec.rb",
+    "spec/rubocop/cops/grammar_spec.rb",
+    "spec/rubocop/cops/indentation_spec.rb",
+    "spec/rubocop/cops/line_length_spec.rb",
+    "spec/rubocop/cops/offence_spec.rb",
+    "spec/rubocop/cops/space_after_comma_etc_spec.rb",
+    "spec/rubocop/cops/surrounding_space_spec.rb",
+    "spec/rubocop/cops/tab_spec.rb",
+    "spec/rubocop/cops/trailing_whitespace_spec.rb",
+    "spec/rubocop/reports/emacs_style_spec.rb",
+    "spec/rubocop/reports/report_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/bbatsov/rubocop"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Automatic Ruby code style checking tool."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/rubocop/cli_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+module Rubocop
+  module Report
+    describe CLI do
+      let(:cli) { CLI.new }
+      before(:each) { $stdout = StringIO.new }
+      after(:each) { $stdout = STDOUT }
+
+      it 'exits cleanly when -h is used' do
+        lambda { cli.run ['-h'] }.should exit_with_code(0)
+        lambda { cli.run ['--help'] }.should exit_with_code(0)
+        message = ['Usage: rubocop [options] [file1, file2, ...]',
+                   '    -v, --[no-]verbose               Run verbosely',
+                   '    -e, --emacs                      Emacs style output']
+        $stdout.string.should == (message * 2).join("\n") + "\n"
+      end
+
+      it 'checks a given correct file and returns 0' do
+        File.open('example.rb', 'w') { |f| f.puts 'x = 0' }
+        begin
+          cli.run(['example.rb']).should == 0
+          $stdout.string.should == "\n1 files inspected, 0 offences detected\n"
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
+      it 'checks a given file with faults and returns 1' do
+        File.open('example.rb', 'w') { |f| f.puts 'x = 0 ' }
+        begin
+          cli.run(['example.rb']).should == 1
+          $stdout.string.should == ['== example.rb ==',
+                                    'C:  0: Trailing whitespace detected.',
+                                    '',
+                                    '1 files inspected, 1 offences detected',
+                                    ''].join("\n")
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
+      it 'can report in emacs style' do
+        File.open('example1.rb', 'w') { |f| f.puts 'x = 0 ' }
+        File.open('example2.rb', 'w') { |f| f.puts "\tx = 0" }
+        begin
+          cli.run(['--emacs', 'example1.rb', 'example2.rb']).should == 1
+          $stdout.string.should ==
+            ['example1.rb:1: C: Trailing whitespace detected.',
+             'example2.rb:1: C: Tab detected.',
+             '',
+             '2 files inspected, 2 offences detected',
+             ''].join("\n")
+        ensure
+          File.delete 'example1.rb'
+          File.delete 'example2.rb'
+        end
+      end
+    end
+  end
+end

data/spec/rubocop/cops/cop_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe Cop do
+      let (:cop) { Cop.new }
+
+      it 'initially has 0 offences' do
+        cop.offences.size.should == 0
+      end
+
+      it 'initially has nothing to report' do
+        cop.has_report?.should be_false
+      end
+
+      it 'keeps track of offences' do
+        cop.add_offence('file', 0, 'line', 'message')
+
+        cop.offences.size.should == 1
+      end
+
+      it 'will report registered offences' do
+        cop.add_offence('file', 0, 'line', 'message')
+
+        cop.has_report?.should be_true
+      end
+    end
+  end
+end

data/spec/rubocop/cops/empty_lines_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe EmptyLines do
+      let (:empty_lines) { EmptyLines.new }
+
+      it 'finds offences in inner classes' do
+        empty_lines.inspect_source('', ['class K',
+                                        '  def m',
+                                        '  end',
+                                        '  class J',
+                                        '    def n',
+                                        '    end',
+                                        '    def o',
+                                        '    end',
+                                        '  end',
+                                        '  # checks something',
+                                        '  def p',
+                                        '  end',
+                                        'end'])
+        empty_lines.offences.size.should == 2
+        empty_lines.offences.map(&:line).sort.should == ['    def o',
+                                                         '  def p']
+      end
+
+      # Only one def, so rule about empty line *between* defs does not
+      # apply.
+      it 'accepts a def that follows a line with code' do
+        empty_lines.inspect_source('', ['x = 0',
+                                        'def m',
+                                        'end'])
+        empty_lines.offences.size.should == 0
+      end
+
+      # Only one def, so rule about empty line *between* defs does not
+      # apply.
+      it 'accepts a def that follows code and a comment' do
+        empty_lines.inspect_source('', ['  x = 0',
+                                        '  # 123',
+                                        '  def m',
+                                        '  end'])
+        empty_lines.offences.size.should == 0
+      end
+
+      it 'accepts the first def without leading empty line in a class' do
+        empty_lines.inspect_source('', ['class K',
+                                        '  def m',
+                                        '  end',
+                                        'end'])
+        empty_lines.offences.size.should == 0
+      end
+
+      it 'accepts a def that follows an empty line and then a comment' do
+        empty_lines.inspect_source('', ['class A',
+                                        '  # calculates value',
+                                        '  def m',
+                                        '  end',
+                                        '',
+                                        '  private',
+                                        '  # calculates size',
+                                        '  def n',
+                                        '  end',
+                                        'end',
+                                       ])
+        empty_lines.offences.size.should == 0
+      end
+
+      it 'accepts a def that is the first of a module' do
+        source = ['module Util',
+                  '  public',
+                  '  #',
+                  '  def html_escape(s)',
+                  '  end',
+                  'end',
+                 ]
+        empty_lines.inspect_source('', source)
+        empty_lines.offences.map(&:message).should == []
+      end
+    end
+  end
+end