rubocop-rspec 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e7b5f7025e117a87e31f15d9e2a8f052e590270
-  data.tar.gz: 89bfe35b6ba5d2af8eb751403e87d765a73931ce
+  metadata.gz: 41d29a68e96541d0d09976b9cdc582f4c468a447
+  data.tar.gz: d38ae28874032c3035a8fd78e6865dfece308fe6
 SHA512:
-  metadata.gz: 83f01b1e8b7a94599499b286ba65034c791b5939bfbfb84400db6950ed6c4092c27e0b1ac4544c6d21bcf068724495ea73408812cdf7216ef6199cf510c51cac
-  data.tar.gz: da36f3a208108b5342d3718fc64a6a35dfcaf2fd9a0b18039f244f6a0ea1ad97e0b2a39ce4d78f8cff69fb2d189fbd5dce8403559c92157d4d8d10e6e436e488
+  metadata.gz: 109b7e39672639b8aeb325439b0501dcec5d9e96eecde7b014cbe5647403bc5d8715a6499bfe9a5ea86bd8ec05f94f17cd75a0c59d9f1882031b3463961fe92b
+  data.tar.gz: 3bb0205007875394a79cc08782dd82ce7186238e155ec18b7078a59aef9572ff8804cc252027f6c2977415fe200605f0741688011a6845ec0eb276e163a3e37d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change log
 
+## Master (unreleased)
+
+## 1.5.2 (2016-08-01)
+
+* Drop support for ruby `2.0.0` and `2.1.0`. ([@backus][])
+* Internal refactorings and improved test coverage. ([@backus][])
+
 ## 1.5.1 (2016-07-20)
 
 * Fix `unrecognized parameter RSpec/VerifiedDoubles:IgnoreSymbolicNames` warning. ([@jeffreyc][])

data/Gemfile

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

data/README.md

@@ -80,14 +80,6 @@ RSpec/FilePath:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-For running the spec files, this project depends on RuboCop's spec helpers.
-This means that in order to run the specs locally, you need a (shallow) clone
-of the RuboCop repository:
-
-```bash
-git submodule update --init vendor/rubocop
-```
-
 ## License
 
 `rubocop-rspec` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bundler'
 require 'bundler/gem_tasks'
 begin
@@ -26,7 +24,7 @@ task :internal_investigation do
   require 'rubocop-rspec'
 
   result = RuboCop::CLI.new.run
-  abort('RuboCop failed!') unless result == 0
+  abort('RuboCop failed!') unless result.zero?
 end
 
 task default: [:spec, :internal_investigation]

data/lib/rubocop-rspec.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
-
 require 'rubocop'
 
 require 'rubocop/rspec/version'
 require 'rubocop/rspec/inject'
 require 'rubocop/rspec/top_level_describe'
+require 'rubocop/rspec/wording'
+require 'rubocop/rspec/util'
 
 RuboCop::RSpec::Inject.defaults!
 

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module RuboCop
   module Cop
     module RSpec
@@ -33,14 +31,7 @@ module RuboCop
           _receiver, method_name, *_args = *node
           return unless ANY_INSTANCE_METHODS.include?(method_name)
 
-          add_offense(
-            node,
-            :expression,
-            format(
-              MESSAGE % { method: method_name },
-              node.loc.expression.source
-            )
-          )
+          add_offense(node, :expression, MESSAGE % { method: method_name })
         end
       end
     end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -21,25 +20,34 @@ module RuboCop
       class DescribeClass < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
-        REQUEST_PAIR = s(:pair, s(:sym, :type), s(:sym, :request))
-        FEATURE_PAIR = s(:pair, s(:sym, :type), s(:sym, :feature))
-        ROUTING_PAIR = s(:pair, s(:sym, :type), s(:sym, :routing))
-        VIEW_PAIR = s(:pair, s(:sym, :type), s(:sym, :view))
+        MSG = 'The first argument to describe should be '\
+              'the class or module being tested.'.freeze
 
-        MESSAGE = 'The first argument to describe should be the class or ' \
-                  'module being tested.'.freeze
+        def_node_matcher :valid_describe?, <<-PATTERN
+        {(send {(const nil :RSpec) nil} :describe const ...) (send nil :describe)}
+        PATTERN
 
-        def on_top_level_describe(_node, args)
-          return if args[0] && args[0].type == :const
+        def_node_matcher :describe_with_metadata, <<-PATTERN
+        (send {(const nil :RSpec) nil} :describe
+          !const
+          ...
+          (hash $...))
+        PATTERN
 
-          return if args[1..-1].any? do |arg|
-            next unless arg.hash_type?
-            arg.children.any? do |n|
-              [REQUEST_PAIR, FEATURE_PAIR, ROUTING_PAIR, VIEW_PAIR].include?(n)
-            end
+        def_node_matcher :rails_metadata?, <<-PATTERN
+        (pair
+          (sym :type)
+          (sym {:request :feature :routing :view}))
+        PATTERN
+
+        def on_top_level_describe(node, args)
+          return if valid_describe?(node)
+
+          describe_with_metadata(node) do |pairs|
+            return if pairs.any?(&method(:rails_metadata?))
           end
 
-          add_offense(args[0], :expression, MESSAGE)
+          add_offense(args.first, :expression)
         end
       end
     end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -19,16 +18,15 @@ module RuboCop
       #   describe MyClass, '.my_class_method' do
       #   end
       class DescribeMethod < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+        include RuboCop::RSpec::TopLevelDescribe, RuboCop::RSpec::Util
 
         MESSAGE = 'The second argument to describe should be the method ' \
                   "being tested. '#instance' or '.class'".freeze
         METHOD_STRING_MATCHER = /^[\#\.].+/
 
-        def on_top_level_describe(_node, args)
-          second_arg = args[1]
-          return unless second_arg && second_arg.type == :str
-          return if METHOD_STRING_MATCHER =~ second_arg.children.first
+        def on_top_level_describe(_node, (_, second_arg))
+          return unless second_arg && second_arg.type.equal?(:str)
+          return if METHOD_STRING_MATCHER =~ one(second_arg.children)
 
           add_offense(second_arg, :expression, MESSAGE)
         end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -27,9 +26,8 @@ module RuboCop
           method, _args, body = *node
           return unless top_level_describe?(method)
 
-          _receiver, method_name, object = *method
-          return unless method_name == :describe
-          return unless object && object.type == :const
+          _receiver, _method_name, object = *method
+          return unless object && object.type.equal?(:const)
 
           inspect_children(body, object)
         end
@@ -43,14 +41,13 @@ module RuboCop
         private
 
         def inspect_children(node, object)
-          return unless node.is_a? Parser::AST::Node
-          return if scope_change?(node) || node.type == :const
+          return unless node.instance_of?(Node)
+          return if scope_change?(node) || node.type.equal?(:const)
 
           node.children.each do |child|
-            if child == object
+            if child.eql?(object)
               name = object.loc.expression.source
               add_offense(child, :expression, format(MESSAGE, name))
-              break
             end
             inspect_children(child, object)
           end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -35,23 +34,19 @@ module RuboCop
 
           length = code_length(node)
 
-          return unless length > max
-          add_offense(node, :expression, message(length, max))
+          return unless length > max_length
+          add_offense(node, :expression, message(length))
         end
 
         private
 
-        def max
-          cop_config['Max']
-        end
-
         def code_length(node)
-          lines = node.source.lines.to_a[1..-2] || []
+          lines = node.source.lines[1..-2]
 
           lines.count { |line| !irrelevant_line(line) }
         end
 
-        def message(length, max_length)
+        def message(length)
           format('Example has too many lines. [%d/%d]', length, max_length)
         end
       end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -25,9 +24,9 @@ module RuboCop
           method, = *node
           _, method_name, *args = *method
 
-          return unless method_name == :it
+          return unless method_name.equal?(:it)
 
-          arguments = *args.first
+          arguments = args.first.to_a
           message = arguments.first.to_s
           return unless message.downcase.start_with?('should')
 
@@ -36,53 +35,30 @@ module RuboCop
                                               arg1.begin_pos + 1,
                                               arg1.end_pos - 1)
 
-          add_offense(message, message, MSG)
+          add_offense(message, message)
         end
 
         def autocorrect(range)
           lambda do |corrector|
-            corrector.replace(range, corrected_message(range))
+            corrector.replace(
+              range,
+              RuboCop::RSpec::Wording.new(
+                range.source,
+                ignore: ignored_words,
+                replace: custom_transform
+              ).rewrite
+            )
           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'] || []
+          cop_config.fetch('CustomTransform', {})
         end
 
         def ignored_words
-          cop_config['IgnoredWords'] || []
+          cop_config.fetch('IgnoredWords', [])
         end
       end
     end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -29,7 +28,7 @@ module RuboCop
           object = args.first.const_name
           return unless object
 
-          path_matcher = matcher(object, args[1])
+          path_matcher = matcher(object, args.at(1))
           return if source_filename =~ regexp_from_glob(path_matcher)
 
           add_offense(node, :expression, format(MESSAGE, path_matcher))
@@ -38,16 +37,15 @@ module RuboCop
         private
 
         def routing_spec?(args)
-          args[1..-1].any? do |arg|
-            next unless arg.hash_type?
+          args.any? do |arg|
             arg.children.include?(ROUTING_PAIR)
           end
         end
 
         def matcher(object, method)
           path = File.join(parts(object))
-          if method && method.type == :str
-            path += '*' + method.children.first.gsub(/\W+/, '')
+          if method && method.type.equal?(:str)
+            path += '*' + method.str_content.gsub(/\W+/, '')
           end
 
           "#{path}*_spec.rb"
@@ -64,19 +62,18 @@ module RuboCop
         end
 
         def camel_to_underscore(string)
-          string.dup.tap do |result|
-            result.gsub!(/([^A-Z])([A-Z]+)/, '\\1_\\2')
-            result.gsub!(/([A-Z])([A-Z\d][^A-Z\d]+)/, '\\1_\\2')
-            result.downcase!
-          end
+          string
+            .gsub(/([^A-Z])([A-Z]+)/, '\\1_\\2')
+            .gsub(/([A-Z])([A-Z\d][^A-Z\d]+)/, '\\1_\\2')
+            .downcase
         end
 
         def regexp_from_glob(glob)
-          Regexp.new(glob.gsub('.', '\\.').gsub('*', '.*') + '$')
+          Regexp.new(glob.sub('.', '\\.').gsub('*', '.*') + '$')
         end
 
         def custom_transform
-          cop_config['CustomTransform'] || []
+          cop_config['CustomTransform'] || {}
         end
       end
     end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -21,44 +20,63 @@ module RuboCop
       #   describe MyClass do
       #   end
       class Focus < Cop
-        MESSAGE = 'Focused spec found.'.freeze
+        MSG = 'Focused spec found.'.freeze
 
-        FOCUSABLE_BLOCKS = [
-          :example_group, :describe, :context, :xdescribe, :xcontext,
-          :it, :example, :specify, :xit, :xexample, :xspecify,
-          :feature, :scenario, :xfeature, :xscenario
-        ].freeze
+        FOCUSABLE_SELECTORS = '
+          :context
+          :describe
+          :example
+          :example_group
+          :feature
+          :it
+          :scenario
+          :specify
+          :xcontext
+          :xdescribe
+          :xexample
+          :xfeature
+          :xit
+          :xscenario
+          :xspecify
+        '.freeze
 
-        FOCUSED_BLOCKS = [
-          :fdescribe, :fcontext,
-          :focus, :fexample, :fit, :fspecify,
-          :ffeature, :fscenario
-        ].freeze
+        FOCUSING_SELECTORS = '
+          :fcontext
+          :fdescribe
+          :fexample
+          :ffeature
+          :fit
+          :focus
+          :fscenario
+          :fspecify
+        '.freeze
 
-        FOCUS_KEY = s(:sym, :focus)
+        FOCUS_SYMBOL = s(:sym, :focus)
+        FOCUS_TRUE   = s(:pair, FOCUS_SYMBOL, s(:true))
 
-        FOCUS_TRUE_PAIR = s(:pair, FOCUS_KEY, s(:true))
+        def_node_matcher :metadata, <<-PATTERN
+          {(send nil {#{FOCUSABLE_SELECTORS}} ... (hash $...))
+           (send nil {#{FOCUSABLE_SELECTORS}} $...)}
+        PATTERN
 
-        def on_send(node)
-          _receiver, method_name, *_args = *node
-          @focusable_block = FOCUSABLE_BLOCKS.include?(method_name)
-          if FOCUSED_BLOCKS.include?(method_name)
-            add_offense(node, :expression, MESSAGE)
-          end
+        def_node_matcher :focused_block?, <<-PATTERN
+          (send nil {#{FOCUSING_SELECTORS}} ...)
+        PATTERN
 
-          # check for :focus
-          return unless @focusable_block
-          node.children.any? do |n|
-            add_offense(n, :expression, MESSAGE) if n == FOCUS_KEY
+        def on_send(node)
+          focus_metadata(node) do |focus|
+            add_offense(focus, :expression)
           end
         end
 
-        def on_hash(node)
-          return unless @focusable_block
-          return if node.children.any? do |n|
-            if [FOCUS_TRUE_PAIR].include?(n)
-              add_offense(n, :expression, MESSAGE)
-            end
+        private
+
+        def focus_metadata(node, &block)
+          yield(node) if focused_block?(node)
+
+          metadata(node) do |matches|
+            matches.grep(FOCUS_SYMBOL, &block)
+            matches.grep(FOCUS_TRUE, &block)
           end
         end
       end