rubocop 0.4.3 → 0.4.4

data/.rubocop.yml

@@ -184,4 +184,8 @@ AvoidPerlBackrefs:
 
 # Avoid the use of class variables.
 AvoidClassVars:
+  Enabled: true
+
+# Symbol literals should use snake_case.
+SymbolSnakeCase:
   Enabled: true

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/lib/rubocop.rb

@@ -42,6 +42,7 @@ require 'rubocop/cop/avoid_for'
 require 'rubocop/cop/avoid_perlisms'
 require 'rubocop/cop/avoid_perl_backrefs'
 require 'rubocop/cop/avoid_class_vars'
+require 'rubocop/cop/symbol_snake_case'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -52,16 +52,26 @@ module Rubocop
           line.chomp
         end
 
-        tokens, sexp, correlations = CLI.rip_source(source)
-
-        cops.each do |cop_klass|
-          cop_config = config[cop_klass.name.split('::').last] if config
-          cop_klass.config = cop_config
-          cop = cop_klass.new
-          cop.correlations = correlations
-          cop.inspect(file, source, tokens, sexp)
-          total_offences += cop.offences.count
-          report << cop if cop.has_report?
+        syntax_cop = Rubocop::Cop::Syntax.new
+        syntax_cop.inspect(file, source, nil, nil)
+
+        if syntax_cop.offences.map(&:severity).include?(:error)
+          # In case of a syntax error we just report that error and do
+          # no more checking in the file.
+          report << syntax_cop
+          total_offences += syntax_cop.offences.count
+        else
+          tokens, sexp, correlations = CLI.rip_source(source)
+
+          cops.each do |cop_klass|
+            cop_config = config[cop_klass.name.split('::').last] if config
+            cop_klass.config = cop_config
+            cop = cop_klass.new
+            cop.correlations = correlations
+            cop.inspect(file, source, tokens, sexp)
+            total_offences += cop.offences.count
+            report << cop if cop.has_report?
+          end
         end
 
         report.display unless report.empty?

data/lib/rubocop/cop/symbol_snake_case.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class SymbolSnakeCase < Cop
+      ERROR_MESSAGE = 'Use snake_case for symbols.'
+      SNAKE_CASE = /^@?[\da-z_]+[!?=]?$/
+      OPERATORS = %w(! + - % * ** [])
+
+      def inspect(file, source, tokens, sexp)
+        each(:symbol_literal, sexp) do |s|
+          symbol_ident = s[1][1][1]
+
+          # handle a couple of special cases
+          next if OPERATORS.include?(symbol_ident)
+
+          unless symbol_ident =~ SNAKE_CASE
+            line_no = s[1][1][2].lineno
+            add_offence(:convention,
+                        line_no,
+                        ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/rubocop.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rubocop"
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bozhidar Batsov"]
@@ -62,6 +62,7 @@ Gem::Specification.new do |s|
     "lib/rubocop/cop/space_after_comma_etc.rb",
     "lib/rubocop/cop/string_literals.rb",
     "lib/rubocop/cop/surrounding_space.rb",
+    "lib/rubocop/cop/symbol_snake_case.rb",
     "lib/rubocop/cop/syntax.rb",
     "lib/rubocop/cop/tab.rb",
     "lib/rubocop/cop/ternary_operator.rb",
@@ -115,6 +116,7 @@ Gem::Specification.new do |s|
     "spec/rubocop/cops/space_inside_brackets_spec.rb",
     "spec/rubocop/cops/space_inside_parens_spec.rb",
     "spec/rubocop/cops/string_literals_spec.rb",
+    "spec/rubocop/cops/symbol_snake_case_spec.rb",
     "spec/rubocop/cops/syntax_spec.rb",
     "spec/rubocop/cops/tab_spec.rb",
     "spec/rubocop/cops/ternary_operator_spec.rb",

data/spec/rubocop/cli_spec.rb

@@ -215,6 +215,26 @@ module Rubocop
         )
       end
 
+      it 'registers an offence for a syntax error' do
+        File.open('example.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts 'class Test'
+          f.puts 'en'
+        end
+        begin
+          expect(cli.run(['--emacs', 'example.rb'])).to eq(1)
+          unexpected_part = RUBY_VERSION >= '2.0' ? 'end-of-input' : '$end'
+          expect($stdout.string.uncolored).to eq(
+            ["example.rb:3: E: Syntax error, unexpected #{unexpected_part}, " +
+             'expecting keyword_end',
+             '',
+             '1 files inspected, 1 offences detected',
+             ''].join("\n"))
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
       it 'can process a file with an invalid UTF-8 byte sequence' do
         File.open('example.rb', 'w') do |f|
           f.puts '# encoding: utf-8'

data/spec/rubocop/cops/symbol_snake_case_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe SymbolSnakeCase do
+      let(:snake_case) { SymbolSnakeCase.new }
+
+      it 'registers an offence for camel case in names' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :BadIdea'])
+        expect(snake_case.offences.map(&:message)).to eq(
+          ['Use snake_case for symbols.'])
+      end
+
+      it 'accepts snake case in names' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :good_idea'])
+        expect(snake_case.offences.map(&:message)).to be_empty
+      end
+
+      it 'accepts snake case with a prefix @ in names' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :@good_idea'])
+        expect(snake_case.offences.map(&:message)).to be_empty
+      end
+
+      it 'accepts snake case with ? suffix' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :good_idea?'])
+        expect(snake_case.offences.map(&:message)).to be_empty
+      end
+
+      it 'accepts snake case with ! suffix' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :good_idea!'])
+        expect(snake_case.offences.map(&:message)).to be_empty
+      end
+
+      it 'accepts snake case with = suffix' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :good_idea='])
+        expect(snake_case.offences.map(&:message)).to be_empty
+      end
+
+      it 'accepts special cases - !, [] and **' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :**',
+                        'test = :!',
+                        'test = :[]'])
+        expect(snake_case.offences.map(&:message)).to be_empty
+      end
+
+      it 'registers an offence for SCREAMING_SNAKE_CASE' do
+        inspect_source(snake_case, 'file.rb',
+                       ['test = :BAD_IDEA'])
+        expect(snake_case.offences.size).to eq(1)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -177,6 +177,7 @@ files:
 - lib/rubocop/cop/space_after_comma_etc.rb
 - lib/rubocop/cop/string_literals.rb
 - lib/rubocop/cop/surrounding_space.rb
+- lib/rubocop/cop/symbol_snake_case.rb
 - lib/rubocop/cop/syntax.rb
 - lib/rubocop/cop/tab.rb
 - lib/rubocop/cop/ternary_operator.rb
@@ -230,6 +231,7 @@ files:
 - spec/rubocop/cops/space_inside_brackets_spec.rb
 - spec/rubocop/cops/space_inside_parens_spec.rb
 - spec/rubocop/cops/string_literals_spec.rb
+- spec/rubocop/cops/symbol_snake_case_spec.rb
 - spec/rubocop/cops/syntax_spec.rb
 - spec/rubocop/cops/tab_spec.rb
 - spec/rubocop/cops/ternary_operator_spec.rb
@@ -254,7 +256,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2923028741214038028
+      hash: 2433240001762549702
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: