rubocop-rspec 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d78e6378d0979625180390c70a6e37d889a67652
-  data.tar.gz: 95a96f1a4def09e03681c8f76600a066556186a4
+  metadata.gz: 5e1993245da215069d2de0ca4a565ccd0ac9aaa6
+  data.tar.gz: ab550daf4e1f7ea5121d19fbea73e6626b6ae3a2
 SHA512:
-  metadata.gz: 24074653cb0280bbafea8676c58f3fddca8dea629d79c72ce26655fb8fb7a3440e9665ce6d231701d22f7a8375c36681dd8522ce8f49def8d8d5cbe2ad914b47
-  data.tar.gz: ae19016c5b9ae6385ecc7f56dbc9f5e97daba9c93eff6d0d3f061a35d5407f0c36b713f1adb81bba5db7b65b9bb5a7c3566614a20070fd9cae9c802005456479
+  metadata.gz: 01f3a531a9acaef8fd91e3f2af343eaecf80d7e74e224e386d2470911189c24a90e27a9e2b717e01250c2f76fc60269ea3bef26c413adac9eb4e71d4c44d4180
+  data.tar.gz: 34ec3b6aeaa188e97066a479ec6c33fbbdc714609afbaccf82dc4aa0e64f8277ab6c376c35be726f52794d3e84c367e7d3222a8afd8a586061e51a1cd968c606

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## 1.2.0
+
+* Drop support of ruby `1.9.2`. ([@geniou][])
+* Update to RuboCop `~> 0.24`. ([@geniou][])
+* Add `autocorrect` to `RSpec::ExampleWording`. This experimental - use with care and check the changes. ([@geniou][])
+* Fix config loader debug output. ([@geniou][])
+* Rename `FileName` cop to `FilePath` as a workaround - see [#19](https://github.com/nevir/rubocop-rspec/issues/19). ([@geniou][])
+
 ## 1.1.0
 
 * Add `autocorrect` to `RSpec::DescribedClass` cop. ([@geniou][])

data/Gemfile

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -66,7 +66,7 @@ In your `.rubocop.yml`, you may treat the RSpec cops just like any other
 cop. For example:
 
 ```yaml
-RSpec/FileName:
+RSpec/FilePath:
   Exclude:
     - spec/my_poorly_named_spec_file.rb
 ```

data/config/default.yml

@@ -13,6 +13,12 @@ RSpec/DescribeMethod:
 RSpec/ExampleWording:
   Description: 'Do not use should when describing your tests.'
   Enabled: true
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+  IgnoredWords: []
+
 
 RSpec/MultipleDescribes:
   Description: 'Checks for multiple top level describes.'
@@ -22,7 +28,7 @@ RSpec/InstanceVariable:
   Description: 'Checks for the usage of instance variables.'
   Enabled: true
 
-RSpec/FileName:
+RSpec/FilePath:
   Description: 'Checks the file and folder naming of the spec file.'
   Enabled: true
   CustomTransform:

data/lib/rubocop-rspec.rb

@@ -13,6 +13,6 @@ require 'rubocop/cop/rspec/describe_class'
 require 'rubocop/cop/rspec/describe_method'
 require 'rubocop/cop/rspec/described_class'
 require 'rubocop/cop/rspec/example_wording'
-require 'rubocop/cop/rspec/file_name'
+require 'rubocop/cop/rspec/file_path'
 require 'rubocop/cop/rspec/instance_variable'
 require 'rubocop/cop/rspec/multiple_describes'

data/lib/rubocop/cop/rspec/example_wording.rb

@@ -6,6 +6,9 @@ module RuboCop
       # Do not use should when describing your tests.
       # see: http://betterspecs.org/#should
       #
+      # The autocorrect is experimental - use with care! It can be configured
+      # with CustomTransform (e.g. have => has) and IgnoredWords (e.g. only).
+      #
       # @example
       #   # bad
       #   it 'should find nothing' do
@@ -27,7 +30,57 @@ module RuboCop
           message = arguments.first.to_s
           return unless message.start_with?('should')
 
-          add_offense(method, :selector, MSG)
+          arg1 = args.first.loc.expression
+          message = Parser::Source::Range
+            .new(arg1.source_buffer, arg1.begin_pos + 1, arg1.end_pos - 1)
+
+          add_offense(message, message, MSG)
+        end
+
+        def autocorrect(range)
+          @corrections << lambda do |corrector|
+            corrector.replace(range, corrected_message(range))
+          end
+        end
+
+        private
+
+        def corrected_message(range)
+          range.source.split(' ').tap do |words|
+            first_word = words.shift
+            words.unshift('not') if first_word == "shouldn't"
+
+            words.each_with_index do |value, key|
+              next if ignored_words.include?(value)
+              words[key] = simple_present(words[key])
+              break
+            end
+          end.join(' ')
+        end
+
+        def simple_present(word)
+          return custom_transform[word] if custom_transform[word]
+
+          # ends with o s x ch sh or ss
+          if %w(o s x]).include?(word[-1]) ||
+            %w(ch sh ss]).include?(word[-2..-1])
+            return "#{word}es"
+          end
+
+          # ends with y
+          if word[-1] == 'y' && !%w(a u i o e).include?(word[-2])
+            return "#{word[0..-2]}ies"
+          end
+
+          "#{word}s"
+        end
+
+        def custom_transform
+          cop_config['CustomTransform'] || []
+        end
+
+        def ignored_words
+          cop_config['IgnoredWords'] || []
         end
       end
     end

data/lib/rubocop/cop/rspec/{file_name.rb → file_path.rb}

@@ -14,7 +14,7 @@ module RuboCop
       #   my_class/method_spec.rb  # describe MyClass, '#method'
       #   my_class_method_spec.rb  # describe MyClass, '#method'
       #   my_class_spec.rb         # describe MyClass
-      class FileName < Cop
+      class FilePath < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
         MESSAGE = 'Spec path should end with `%s`'

data/lib/rubocop/rspec/inject.rb

@@ -13,7 +13,7 @@ module RuboCop
 
       def self.defaults!
         hash = YAML.load_file(DEFAULT_FILE)
-        puts "configuration from #{path}" if ConfigLoader.debug?
+        puts "configuration from #{DEFAULT_FILE}" if ConfigLoader.debug?
         config = ConfigLoader.merge_with_default(hash, DEFAULT_FILE)
 
         ConfigLoader.instance_variable_set(:@default_configuration, config)

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.1.0'
+      STRING = '1.2.0'
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.version = RuboCop::RSpec::Version::STRING
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.require_paths = ['lib']
   spec.files = Dir[
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(/^spec\//)
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
-  spec.add_runtime_dependency('rubocop', '~> 0.23')
+  spec.add_development_dependency('rubocop', '~> 0.24')
   spec.add_development_dependency('rake', '~> 10.1')
   spec.add_development_dependency('rspec', '~> 3.0')
   spec.add_development_dependency('simplecov', '~> 0.8')

data/spec/project_spec.rb

@@ -77,7 +77,7 @@ describe 'RuboCop Project' do # rubocop:disable RSpec/DescribeClass
         it 'has a valid URL' do
           issues.each do |issue|
             number = issue[:number].gsub(/\D/, '')
-            pattern = %r{^https://github\.com/[/]+/[/]+/(?:issues|pull)/#{number}$} # rubocop:disable LineLength
+            pattern = %r{^https://github\.com/.+/.+/(?:issues|pull)/#{number}$} # rubocop:disable LineLength
             expect(issue[:url]).to match(pattern)
           end
         end

data/spec/rubocop/cop/rspec/example_wording_spec.rb

@@ -2,8 +2,14 @@
 
 require 'spec_helper'
 
-describe RuboCop::Cop::RSpec::ExampleWording do
-  subject(:cop) { described_class.new }
+describe RuboCop::Cop::RSpec::ExampleWording, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) do
+    {
+      'CustomTransform' => { 'have' => 'has', 'not' => 'does not' },
+      'IgnoredWords' => %w(only realy)
+    }
+  end
 
   it 'finds description with `should` at the beginning' do
     inspect_source(cop, ["it 'should do something' do", 'end'])
@@ -11,7 +17,16 @@ describe RuboCop::Cop::RSpec::ExampleWording do
     expect(cop.offenses.map(&:line).sort).to eq([1])
     expect(cop.messages)
       .to eq(['Do not use should when describing your tests.'])
-    expect(cop.highlights).to eq(['it'])
+    expect(cop.highlights).to eq(['should do something'])
+  end
+
+  it 'finds description with `shouldn\'t` at the beginning' do
+    inspect_source(cop, ['it "shouldn\'t do something" do', 'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages)
+      .to eq(['Do not use should when describing your tests.'])
+    expect(cop.highlights).to eq(['shouldn\'t do something'])
   end
 
   it 'skips descriptions without `should` at the beginning' do
@@ -20,4 +35,26 @@ describe RuboCop::Cop::RSpec::ExampleWording do
                          'end'])
     expect(cop.offenses).to be_empty
   end
+
+  {
+    'should return something' => 'returns something',
+    'should not return something' => 'does not return something',
+    'should do nothing' => 'does nothing',
+    'should have sweets' => 'has sweets',
+    'should worry about the future' => 'worries about the future',
+    'should pay for pizza' => 'pays for pizza',
+    'should miss me' => 'misses me',
+    'should realy only return one item' => 'realy only returns one item'
+  }.each do |old, new|
+    it 'autocorrects an offenses' do
+      new_source = autocorrect_source(cop, ["it '#{old}' do", 'end'])
+      expect(new_source).to eq("it '#{new}' do\nend")
+    end
+  end
+
+  it "autocorrects shouldn't" do
+    new_source =
+      autocorrect_source(cop, 'it "shouldn\'t return something" do; end')
+    expect(new_source).to eq('it "does not return something" do; end')
+  end
 end

data/spec/rubocop/cop/rspec/{file_name_spec.rb → file_path_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe RuboCop::Cop::RSpec::FileName, :config do
+describe RuboCop::Cop::RSpec::FilePath, :config do
   subject(:cop) { described_class.new(config) }
   let(:cop_config) { { 'CustomTransform' => { 'FooFoo' => 'foofoo' } } }
 

data/spec/spec_helper.rb

@@ -8,19 +8,3 @@ require File.join(
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rubocop-rspec'
-
-# Overwriting RuboCop's parse_source to add support for mocked file paths.
-#
-# Remove once rubocop > 0.17.0 releases.
-def parse_source(source, file = nil)
-  source = source.join($RS) if source.is_a?(Array)
-  if file.is_a? String
-    RuboCop::SourceParser.parse(source, file)
-  elsif file
-    file.write(source)
-    file.rewind
-    RuboCop::SourceParser.parse(source, file.path)
-  else
-    RuboCop::SourceParser.parse(source)
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ian MacLeod
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
-  type: :runtime
+        version: '0.24'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ files:
 - lib/rubocop/cop/rspec/describe_method.rb
 - lib/rubocop/cop/rspec/described_class.rb
 - lib/rubocop/cop/rspec/example_wording.rb
-- lib/rubocop/cop/rspec/file_name.rb
+- lib/rubocop/cop/rspec/file_path.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
 - lib/rubocop/cop/rspec/multiple_describes.rb
 - lib/rubocop/rspec/inject.rb
@@ -102,7 +102,7 @@ files:
 - spec/rubocop/cop/rspec/describe_method_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
 - spec/rubocop/cop/rspec/example_wording_spec.rb
-- spec/rubocop/cop/rspec/file_name_spec.rb
+- spec/rubocop/cop/rspec/file_path_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
 - spec/rubocop/cop/rspec/multiple_describes_spec.rb
 - spec/spec_helper.rb
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -136,7 +136,7 @@ test_files:
 - spec/rubocop/cop/rspec/describe_method_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
 - spec/rubocop/cop/rspec/example_wording_spec.rb
-- spec/rubocop/cop/rspec/file_name_spec.rb
+- spec/rubocop/cop/rspec/file_path_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
 - spec/rubocop/cop/rspec/multiple_describes_spec.rb
 - spec/spec_helper.rb