rubocop 0.13.1 → 0.14.0

data/spec/rubocop/cop/style/string_literals_spec.rb

@@ -2,76 +2,154 @@
 
 require 'spec_helper'
 
-module Rubocop
-  module Cop
-    module Style
-      describe StringLiterals do
-        subject(:cop) { StringLiterals.new }
-
-        it 'registers offence for double quotes when single quotes suffice' do
-          inspect_source(cop, ['s = "abc"',
-                               'x = "a\\\\b"',
-                               'y ="\\\\b"',
-                               'z = "a\\\\"'])
-          expect(cop.offences.size).to eq(4)
-        end
-
-        it 'accepts double quotes when they are needed' do
-          src = ['a = "\n"',
-                 'b = "#{encode_severity}:' +
-                 '#{sprintf("%3d", line_number)}: #{m}"',
-                 'c = "\'"',
-                 'd = "#@test"',
-                 'e = "#$test"',
-                 'f = "\e"',
-                 'g = "#@@test"']
-          inspect_source(cop, src)
-          expect(cop.offences).to be_empty
-        end
-
-        it 'accepts double quotes at the start of regexp literals' do
-          inspect_source(cop, ['s = /"((?:[^\\"]|\\.)*)"/'])
-          expect(cop.offences).to be_empty
-        end
-
-        it 'accepts double quotes with some other special symbols' do
-          # "Substitutions in double-quoted strings"
-          # http://www.ruby-doc.org/docs/ProgrammingRuby/html/language.html
-          src = ['g = "\xf9"',
-                 'copyright = "\u00A9"']
-          inspect_source(cop, src)
-          expect(cop.offences).to be_empty
-        end
-
-        it 'accepts " in a %w' do
-          inspect_source(cop, ['%w(")'])
-          expect(cop.offences).to be_empty
-        end
-
-        it 'accepts \\\\\n in a string' do # this would be: "\\\n"
-          inspect_source(cop, ['"foo \\\\\n bar"'])
-          expect(cop.offences).to be_empty
-        end
-
-        it 'can handle double quotes within embedded expression' do
-          src = ['"#{"A"}"']
-          inspect_source(cop, src)
-          expect(cop.offences).to be_empty
-        end
-
-        it 'can handle a built-in constant parsed as string' do
-          # Parser will produce str nodes for constants such as __FILE__.
-          src = ['if __FILE__ == $PROGRAM_NAME',
-                 'end']
-          inspect_source(cop, src)
-          expect(cop.offences).to be_empty
-        end
-
-        it 'auto-corrects " with \'' do
-          new_source = autocorrect_source(cop, 's = "abc"')
-          expect(new_source).to eq("s = 'abc'")
-        end
-      end
+describe Rubocop::Cop::Style::StringLiterals, :config do
+  subject(:cop) { described_class.new(config) }
+
+  context 'configured with single quotes preferred' do
+    let(:cop_config) { { 'EnforcedStyle' => 'single_quotes' } }
+
+    it 'registers offence for double quotes when single quotes ' +
+      'suffice' do
+      inspect_source(cop, ['s = "abc"',
+                           'x = "a\\\\b"',
+                           'y ="\\\\b"',
+                           'z = "a\\\\"'])
+      expect(cop.highlights).to eq(['"abc"',
+                                    '"a\\\\b"',
+                                    '"\\\\b"',
+                                    '"a\\\\"'])
+      expect(cop.messages)
+        .to eq(["Prefer single-quoted strings when you don't need " +
+                'string interpolation or special symbols.'] * 4)
+    end
+
+    it 'accepts single quotes' do
+      inspect_source(cop, ["a = 'x'"])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts %q and %Q quotes' do
+      inspect_source(cop, ['a = %q(x) + %Q[x]'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts double quotes when they are needed' do
+      src = ['a = "\n"',
+             'b = "#{encode_severity}:' +
+             '#{sprintf("%3d", line_number)}: #{m}"',
+             'c = "\'"',
+             'd = "#@test"',
+             'e = "#$test"',
+             'f = "\e"',
+             'g = "#@@test"']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts double quotes at the start of regexp literals' do
+      inspect_source(cop, ['s = /"((?:[^\\"]|\\.)*)"/'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts double quotes with some other special symbols' do
+      # "Substitutions in double-quoted strings"
+      # http://www.ruby-doc.org/docs/ProgrammingRuby/html/language.html
+      src = ['g = "\xf9"',
+             'copyright = "\u00A9"']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts " in a %w' do
+      inspect_source(cop, ['%w(")'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts \\\\\n in a string' do # this would be: "\\\n"
+      inspect_source(cop, ['"foo \\\\\n bar"'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'can handle double quotes within embedded expression' do
+      src = ['"#{"A"}"']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'can handle a built-in constant parsed as string' do
+      # Parser will produce str nodes for constants such as __FILE__.
+      src = ['if __FILE__ == $PROGRAM_NAME',
+             'end']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'auto-corrects " with \'' do
+      new_source = autocorrect_source(cop, 's = "abc"')
+      expect(new_source).to eq("s = 'abc'")
+    end
+  end
+
+  context 'configured with double quotes preferred' do
+    let(:cop_config) { { 'EnforcedStyle' => 'double_quotes' } }
+
+    it 'registers offence for single quotes when double quotes would ' +
+      'be equivalent' do
+      inspect_source(cop, ["s = 'abc'"])
+      expect(cop.highlights).to eq(["'abc'"])
+      expect(cop.messages)
+        .to eq(['Prefer double-quoted strings unless you need ' +
+                'single quotes to avoid extra backslashes for ' +
+                'escaping.'])
+    end
+
+    it 'accepts double quotes' do
+      inspect_source(cop, ['a = "x"'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts %q and %Q quotes' do
+      inspect_source(cop, ['a = %q(x) + %Q[x]'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts single quotes when they are needed' do
+      src = ["a = '\\n'",
+             "b = '\"'"]
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts single quotes at the start of regexp literals' do
+      inspect_source(cop, ["s = /'((?:[^\\']|\\.)*)'/"])
+      expect(cop.offences).to be_empty
+    end
+
+    it "accepts ' in a %w" do
+      inspect_source(cop, ["%w(')"])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'can handle a built-in constant parsed as string' do
+      # Parser will produce str nodes for constants such as __FILE__.
+      src = ['if __FILE__ == $PROGRAM_NAME',
+             'end']
+      inspect_source(cop, src)
+      expect(cop.offences).to be_empty
+    end
+
+    it "auto-corrects ' with \"" do
+      new_source = autocorrect_source(cop, "s = 'abc'")
+      expect(new_source).to eq('s = "abc"')
+    end
+  end
+
+  context 'when configured with a bad value' do
+    let(:cop_config) { { 'EnforcedStyle' => 'other' } }
+
+    it 'fails' do
+      expect { inspect_source(cop, ['a = "b"']) }
+        .to raise_error(RuntimeError)
     end
   end
 end

data/spec/rubocop/cop/style/symbol_array_spec.rb

@@ -2,44 +2,38 @@
 
 require 'spec_helper'
 
-module Rubocop
-  module Cop
-    module Style
-      describe SymbolArray do
-        subject(:sa) { SymbolArray.new }
+describe Rubocop::Cop::Style::SymbolArray do
+  subject(:cop) { described_class.new }
 
-        it 'registers an offence for arrays of symbols', { ruby: 2.0 } do
-          inspect_source(sa,
-                         ['[:one, :two, :three]'])
-          expect(sa.offences.size).to eq(1)
-        end
+  it 'registers an offence for arrays of symbols', { ruby: 2.0 } do
+    inspect_source(cop,
+                   ['[:one, :two, :three]'])
+    expect(cop.offences.size).to eq(1)
+  end
 
-        it 'does not reg an offence for array with non-syms', { ruby: 2.0 } do
-          inspect_source(sa,
-                         ['[:one, :two, "three"]'])
-          expect(sa.offences).to be_empty
-        end
+  it 'does not reg an offence for array with non-syms', { ruby: 2.0 } do
+    inspect_source(cop,
+                   ['[:one, :two, "three"]'])
+    expect(cop.offences).to be_empty
+  end
 
-        it 'does not reg an offence for array starting with %i',
-           { ruby: 2.0 } do
-          inspect_source(sa,
-                         ['%i(one two three)'])
-          expect(sa.offences).to be_empty
-        end
+  it 'does not reg an offence for array starting with %i',
+     { ruby: 2.0 } do
+    inspect_source(cop,
+                   ['%i(one two three)'])
+    expect(cop.offences).to be_empty
+  end
 
-        it 'does not reg an offence for array with one element',
-           { ruby: 2.0 } do
-          inspect_source(sa,
-                         ['[:three]'])
-          expect(sa.offences).to be_empty
-        end
+  it 'does not reg an offence for array with one element',
+     { ruby: 2.0 } do
+    inspect_source(cop,
+                   ['[:three]'])
+    expect(cop.offences).to be_empty
+  end
 
-        it 'does nothing on Ruby 1.9', { ruby: 1.9 } do
-          inspect_source(sa,
-                         ['[:one, :two, :three]'])
-          expect(sa.offences).to be_empty
-        end
-      end
-    end
+  it 'does nothing on Ruby 1.9', { ruby: 1.9 } do
+    inspect_source(cop,
+                   ['[:one, :two, :three]'])
+    expect(cop.offences).to be_empty
   end
 end

data/spec/rubocop/cop/style/symbol_name_spec.rb

@@ -1,144 +1,138 @@
-  # encoding: utf-8
+# encoding: utf-8
 
 require 'spec_helper'
 
-module Rubocop
-  module Cop
-    module Style
-      describe SymbolName, :config do
-        subject(:symbol_name) { SymbolName.new(config) }
-        let(:cop_config) { { 'AllowCamelCase' => true } }
-
-        context 'when AllowCamelCase is true' do
-          let(:cop_config) { { 'AllowCamelCase' => true } }
-
-          it 'does not register an offence for camel case in names' do
-            inspect_source(symbol_name,
-                           ['test = :BadIdea'])
-            expect(symbol_name.offences).to be_empty
-          end
-        end
-
-        context 'when AllowCamelCase is false' do
-          let(:cop_config) { { 'AllowCamelCase' => false } }
-
-          it 'registers an offence for camel case in names' do
-            inspect_source(symbol_name,
-                           ['test = :BadIdea'])
-            expect(symbol_name.messages).to eq(
-              ['Use snake_case for symbols.'])
-          end
-        end
-
-        context 'when AllowDots is true' do
-          let(:cop_config) { { 'AllowDots' => true } }
-
-          it 'does not register an offence for dots in names' do
-            inspect_source(symbol_name,
-                           ['test = :"bad.idea"'])
-            expect(symbol_name.offences).to be_empty
-          end
-        end
-
-        context 'when AllowDots is false' do
-          let(:cop_config) { { 'AllowDots' => false } }
-
-          it 'registers an offence for dots in names' do
-            inspect_source(symbol_name,
-                           ['test = :"bad.idea"'])
-            expect(symbol_name.offences.map(&:message)).to eq(
-              ['Use snake_case for symbols.'])
-          end
-        end
-
-        it 'registers an offence for symbol used as hash label' do
-          inspect_source(symbol_name,
-                         ['{ KEY_ONE: 1, KEY_TWO: 2 }'])
-          expect(symbol_name.messages).to eq(
-            ['Use snake_case for symbols.'] * 2)
-        end
-
-        it 'accepts snake case in names' do
-          inspect_source(symbol_name,
-                         ['test = :good_idea'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts snake case in hash label names' do
-          inspect_source(symbol_name,
-                         ['{ one: 1, one_more_3: 2 }'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts snake case with a prefix @ in names' do
-          inspect_source(symbol_name,
-                         ['test = :@good_idea'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts snake case with ? suffix' do
-          inspect_source(symbol_name,
-                         ['test = :good_idea?'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts snake case with ! suffix' do
-          inspect_source(symbol_name,
-                         ['test = :good_idea!'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts snake case with = suffix' do
-          inspect_source(symbol_name,
-                         ['test = :good_idea='])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts special cases - !, [] and **' do
-          inspect_source(symbol_name,
-                         ['test = :**',
-                          'test = :!',
-                          'test = :[]',
-                          'test = :[]='])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts special cases - ==, <=>, >, <, >=, <=' do
-          inspect_source(symbol_name,
-                         ['test = :==',
-                          'test = :<=>',
-                          'test = :>',
-                          'test = :<',
-                          'test = :>=',
-                          'test = :<='])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'accepts non snake case arguments to private_constant' do
-          inspect_source(symbol_name,
-                         ['private_constant :NORMAL_MODE, :ADMIN_MODE'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'registers an offence for non snake case symbol near ' +
-            'private_constant' do
-          inspect_source(symbol_name,
-                         ['private_constant f(:ADMIN_MODE)'])
-          expect(symbol_name.offences.size).to eq(1)
-        end
-
-        it 'can handle an alias of and operator without crashing' do
-          inspect_source(symbol_name,
-                         ['alias + add'])
-          expect(symbol_name.offences).to be_empty
-        end
-
-        it 'registers an offence for SCREAMING_symbol_name' do
-          inspect_source(symbol_name,
-                         ['test = :BAD_IDEA'])
-          expect(symbol_name.offences.size).to eq(1)
-        end
-      end
+describe Rubocop::Cop::Style::SymbolName, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'AllowCamelCase' => true } }
+
+  context 'when AllowCamelCase is true' do
+    let(:cop_config) { { 'AllowCamelCase' => true } }
+
+    it 'does not register an offence for camel case in names' do
+      inspect_source(cop,
+                     ['test = :BadIdea'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'when AllowCamelCase is false' do
+    let(:cop_config) { { 'AllowCamelCase' => false } }
+
+    it 'registers an offence for camel case in names' do
+      inspect_source(cop,
+                     ['test = :BadIdea'])
+      expect(cop.messages).to eq(
+        ['Use snake_case for symbols.'])
+    end
+  end
+
+  context 'when AllowDots is true' do
+    let(:cop_config) { { 'AllowDots' => true } }
+
+    it 'does not register an offence for dots in names' do
+      inspect_source(cop,
+                     ['test = :"bad.idea"'])
+      expect(cop.offences).to be_empty
     end
   end
+
+  context 'when AllowDots is false' do
+    let(:cop_config) { { 'AllowDots' => false } }
+
+    it 'registers an offence for dots in names' do
+      inspect_source(cop,
+                     ['test = :"bad.idea"'])
+      expect(cop.offences.map(&:message)).to eq(
+        ['Use snake_case for symbols.'])
+    end
+  end
+
+  it 'registers an offence for symbol used as hash label' do
+    inspect_source(cop,
+                   ['{ KEY_ONE: 1, KEY_TWO: 2 }'])
+    expect(cop.messages).to eq(
+      ['Use snake_case for symbols.'] * 2)
+  end
+
+  it 'accepts snake case in names' do
+    inspect_source(cop,
+                   ['test = :good_idea'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts snake case in hash label names' do
+    inspect_source(cop,
+                   ['{ one: 1, one_more_3: 2 }'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts snake case with a prefix @ in names' do
+    inspect_source(cop,
+                   ['test = :@good_idea'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts snake case with ? suffix' do
+    inspect_source(cop,
+                   ['test = :good_idea?'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts snake case with ! suffix' do
+    inspect_source(cop,
+                   ['test = :good_idea!'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts snake case with = suffix' do
+    inspect_source(cop,
+                   ['test = :good_idea='])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts special cases - !, [] and **' do
+    inspect_source(cop,
+                   ['test = :**',
+                    'test = :!',
+                    'test = :[]',
+                    'test = :[]='])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts special cases - ==, <=>, >, <, >=, <=' do
+    inspect_source(cop,
+                   ['test = :==',
+                    'test = :<=>',
+                    'test = :>',
+                    'test = :<',
+                    'test = :>=',
+                    'test = :<='])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts non snake case arguments to private_constant' do
+    inspect_source(cop,
+                   ['private_constant :NORMAL_MODE, :ADMIN_MODE'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for non snake case symbol near ' +
+      'private_constant' do
+    inspect_source(cop,
+                   ['private_constant f(:ADMIN_MODE)'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'can handle an alias of and operator without crashing' do
+    inspect_source(cop,
+                   ['alias + add'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for SCREAMING_symbol_name' do
+    inspect_source(cop,
+                   ['test = :BAD_IDEA'])
+    expect(cop.offences.size).to eq(1)
+  end
 end