rubocop-rspec 0.17.0

data/lib/rubocop-rspec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'rubocop'
+
+require 'rubocop/rspec/version'
+require 'rubocop/rspec/inject'
+
+Rubocop::RSpec::Inject.defaults!
+
+# We are housing ourselves directly into RuboCop's module structure. This is
+# less than ideal, but until RuboCop directly supports plugins, we can avoid
+# breaking too many assumptions.
+require 'rubocop/cop/rspec/unit_spec_naming'

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

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module RSpec
+      # This cop checks that RSpec unit tests conform to a consistent naming
+      # scheme - both for the describe call, and the file path.
+      #
+      # Disabled by default. Generally, you want to scope it to your project's
+      # unit spec paths:
+      #
+      #   UnitSpecNaming:
+      #     Enabled: true
+      #     Include:
+      #       - 'spec/rubocop/*'
+      #
+      class UnitSpecNaming < Cop
+        DESCRIBE_CLASS_MSG = 'The first argument to describe should be the ' \
+                             'class or module being tested.'
+
+        METHOD_STRING_MSG = 'The second argument to describe should be the ' \
+                            "method being tested. '#instance' or '.class'"
+
+        CLASS_SPEC_MSG = 'Class unit spec should have a path ending with %s'
+
+        METHOD_SPEC_MSG = 'Unit spec should have a path matching %s'
+
+        METHOD_STRING_MATCHER = /^[\#\.].+/
+
+        def on_send(node)
+          return unless top_level_describe? node
+          _receiver, _method_name, *args = *node
+          # Ignore non-string args (RSpec metadata)
+          args = [args.first] + args[1..-1].select { |a| a.type == :str }
+
+          if cop_config['EnforceDescribeStatement']
+            enforce_describe_statement(node, args)
+          end
+
+          if offences.size == 0 && cop_config['EnforceFilenames']
+            enforce_filename(node, args)
+          end
+        end
+
+        private
+
+        def enforce_describe_statement(node, args)
+          check_described_class(node, args.first)
+          check_described_method(node, args[1])
+        end
+
+        def enforce_filename(node, args)
+          path_parts = const_name(args.first).split('::').map do |part|
+            camel_to_underscore(part)
+          end
+
+          if !args[1]
+            check_class_spec(node, path_parts)
+          else
+            method_str = args[1].children.first if args[1]
+            path_parts << 'class_methods' if method_str.start_with? '.'
+            check_method_spec(node, path_parts, method_str)
+          end
+        end
+
+        def check_described_class(node, first_arg)
+          if !first_arg || first_arg.type != :const
+            add_offence(first_arg || node, :expression, DESCRIBE_CLASS_MSG)
+          end
+        end
+
+        def check_described_method(node, second_arg)
+          return unless second_arg
+
+          unless METHOD_STRING_MATCHER =~ second_arg.children.first
+            add_offence(second_arg, :expression, METHOD_STRING_MSG)
+          end
+        end
+
+        def check_class_spec(node, path_parts)
+          spec_path = File.join(path_parts) + '_spec.rb'
+          unless source_filename.end_with? spec_path
+            add_offence(node, :expression, format(CLASS_SPEC_MSG, spec_path))
+          end
+        end
+
+        def check_method_spec(node, path_parts, method_str)
+          matcher_parts = path_parts.dup
+          # Strip out symbols; it's not worth enforcing a vocabulary for them.
+          matcher_parts << method_str[1..-1].gsub(/\W+/, '*') + '_spec.rb'
+
+          glob_matcher = File.join(matcher_parts)
+          unless source_filename =~ regexp_from_glob(glob_matcher)
+            message = format(METHOD_SPEC_MSG, glob_matcher)
+            add_offence(node, :expression, message)
+          end
+        end
+
+        def top_level_describe?(node)
+          _receiver, method_name, *_args = *node
+          return false unless method_name == :describe
+
+          root_node = processed_source.ast
+          top_level_nodes = describe_statement_children(root_node)
+          # If we have no top level describe statements, we need to check any
+          # blocks on the top level (e.g. after a require).
+          if top_level_nodes.size == 0
+            top_level_nodes = node_children(root_node).map do |child|
+              describe_statement_children(child) if child.type == :block
+            end.flatten.compact
+          end
+
+          top_level_nodes.include? node
+        end
+
+        def describe_statement_children(node)
+          node_children(node).select do |element|
+            element.type == :send && element.children[1] == :describe
+          end
+        end
+
+        def source_filename
+          processed_source.buffer.name
+        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][^A-Z]+)/, '\\1_\\2')
+            result.downcase!
+          end
+        end
+
+        def regexp_from_glob(glob)
+          Regexp.new(glob.gsub('.', '\\.').gsub('*', '.*') + '$')
+        end
+
+        def node_children(node)
+          node.children.select { |e| e.is_a? Parser::AST::Node }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/inject.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'yaml'
+
+module Rubocop
+  module RSpec
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      DEFAULT_FILE = File.expand_path(
+        '../../../../config/default.yml', __FILE__
+      )
+
+      def self.defaults!
+        hash = YAML.load_file(DEFAULT_FILE)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(hash, DEFAULT_FILE)
+
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/version.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Rubocop
+  module RSpec
+    # Version information for the RSpec RuboCop plugin.
+    module Version
+      STRING = '0.17.0'
+    end
+  end
+end

data/rubocop-rspec.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rubocop/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rubocop-rspec'
+  spec.summary = 'Code style checking for RSpec files'
+  spec.description = <<-end_description
+    Code style checking for RSpec files.
+    A plugin for the RuboCop code style enforcing & linting tool.
+  end_description
+  spec.homepage = 'http://github.com/nevir/rubocop-rspec'
+  spec.authors = ['Ian MacLeod']
+  spec.email = ['ian@nevir.net']
+  spec.licenses = ['MIT']
+
+  spec.version = Rubocop::RSpec::Version::STRING
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.require_paths = ['lib']
+  spec.files = Dir['**/*']
+  spec.test_files = spec.files.grep(/^spec\//)
+  spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
+
+  spec.add_runtime_dependency('rubocop', '~> 0.17')
+end

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

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::RSpec::UnitSpecNaming, :config do
+  subject(:cop) { described_class.new(config) }
+
+  context 'describe statement enforcement' do
+    let(:cop_config) { { 'EnforceFilenames' => false } }
+
+    it 'checks first-line describe statements' do
+      inspect_source(cop,
+                     ['describe "bad describe" do; end'])
+      expect(cop.offences.size).to eq(1)
+    end
+
+    it 'checks describe statements after a require' do
+      inspect_source(cop,
+                     ["require 'spec_helper'",
+                      'describe "bad describe" do; end'])
+      expect(cop.offences.size).to eq(1)
+    end
+
+    it 'ignores nested describe statements' do
+      inspect_source(cop,
+                     ['describe Some::Class do',
+                      '  describe "bad describe" do; end',
+                      'end'])
+      expect(cop.offences).to eq([])
+    end
+
+    it "doesn't blow up on single-line describes" do
+      inspect_source(cop,
+                     ['describe Some::Class'])
+      expect(cop.offences).to eq([])
+    end
+
+    it 'checks class method naming' do
+      inspect_source(cop,
+                     ["describe Some::Class, '.asdf' do; end"])
+      expect(cop.offences).to eq([])
+    end
+
+    it 'checks instance method naming' do
+      inspect_source(cop,
+                     ["describe Some::Class, '#fdsa' do; end"])
+      expect(cop.offences).to eq([])
+    end
+
+    it 'enforces non-method names' do
+      inspect_source(cop,
+                     ["describe Some::Class, 'nope' do; end"])
+      expect(cop.offences.size).to eq(1)
+    end
+  end
+
+  context 'filename enforcement' do
+    let(:cop_config) { { 'EnforceDescribeStatement' => false } }
+
+    it 'checks class specs' do
+      inspect_source(cop,
+                     ['describe Some::Class do; end'],
+                     'some/class_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'handles CamelCaps class names' do
+      inspect_source(cop,
+                     ['describe MyClass do; end'],
+                     'my_class_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'handles ACRONYMClassNames' do
+      inspect_source(cop,
+                     ['describe ABCOne::Two do; end'],
+                     'abc_one/two_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'handles ALLCAPS class names' do
+      inspect_source(cop,
+                     ['describe ALLCAPS do; end'],
+                     'allcaps_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'checks instance methods' do
+      inspect_source(cop,
+                     ["describe Some::Class, '#inst' do; end"],
+                     'some/class/inst_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'checks class methods' do
+      inspect_source(cop,
+                     ["describe Some::Class, '.inst' do; end"],
+                     'some/class/class_methods/inst_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'ignores non-alphanumeric characters' do
+      inspect_source(cop,
+                     ["describe Some::Class, '#pred?' do; end"],
+                     'some/class/pred_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'allows flexibility with predicates' do
+      inspect_source(cop,
+                     ["describe Some::Class, '#thing?' do; end"],
+                     'some/class/thing_predicate_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'allows flexibility with operators' do
+      inspect_source(cop,
+                     ["describe MyClass, '#<=>' do; end"],
+                     'my_class/spaceship_operator_spec.rb')
+      expect(cop.offences).to eq([])
+    end
+
+    it 'checks the path' do
+      inspect_source(cop,
+                     ["describe MyClass, '#foo' do; end"],
+                     'my_clas/foo_spec.rb')
+      expect(cop.offences.size).to eq(1)
+    end
+
+    it 'checks class spec paths' do
+      inspect_source(cop,
+                     ['describe MyClass do; end'],
+                     'my_clas_spec.rb')
+      expect(cop.offences.size).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+# As much as possible, we try to reuse RuboCop's spec environment.
+require File.join(
+  Gem::Specification.find_by_name('rubocop').gem_dir, 'spec', 'spec_helper.rb'
+)
+
+$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

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rspec
+version: !ruby/object:Gem::Version
+  version: 0.17.0
+platform: ruby
+authors:
+- Ian MacLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: |2
+      Code style checking for RSpec files.
+      A plugin for the RuboCop code style enforcing & linting tool.
+email:
+- ian@nevir.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE.md
+- README.md
+files:
+- config/default.yml
+- coverage/assets/0.8.0/application.css
+- coverage/assets/0.8.0/application.js
+- coverage/assets/0.8.0/colorbox/border.png
+- coverage/assets/0.8.0/colorbox/controls.png
+- coverage/assets/0.8.0/colorbox/loading.gif
+- coverage/assets/0.8.0/colorbox/loading_background.png
+- coverage/assets/0.8.0/favicon_green.png
+- coverage/assets/0.8.0/favicon_red.png
+- coverage/assets/0.8.0/favicon_yellow.png
+- coverage/assets/0.8.0/loading.gif
+- coverage/assets/0.8.0/magnify.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png
+- coverage/index.html
+- Gemfile
+- Gemfile.lock
+- lib/rubocop/cop/rspec/unit_spec_naming.rb
+- lib/rubocop/rspec/inject.rb
+- lib/rubocop/rspec/version.rb
+- lib/rubocop-rspec.rb
+- MIT-LICENSE.md
+- pkg/rubocop-rspec-0.1.0.gem
+- pkg/rubocop-rspec-0.17.0.gem
+- Rakefile
+- README.md
+- rubocop-rspec.gemspec
+- spec/rubocop/cop/rspec/unit_spec_naming_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nevir/rubocop-rspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Code style checking for RSpec files
+test_files:
+- spec/rubocop/cop/rspec/unit_spec_naming_spec.rb
+- spec/spec_helper.rb