rubocop-rspec-focused 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18d13e56c465ff7b44a3f971d20354f8317bafbe
+  data.tar.gz: d59941e5b7c8e7167c42fc6cc954be23f3cb3c3e
+SHA512:
+  metadata.gz: 8138b5bf399d3cccd1a819c0f6c88309fe4d5e56d3eb6de5b0ead1a5d7c0148070c5d888a14c677e91ab73473419484d0a2295d1313d34edc1ff52d54756170c
+  data.tar.gz: 6d28d20175cba0605b9a81caaad880af0dfa2f245b7e46c978edd3dae4a39061cfdb61f7317f73c77a3abf7d30445a7e769a8d60aba74ae6a7db101360360767

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-rspec-focused.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Love With Food, Hendy Tanata
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# rubocop-rspec-focused
+
+Cop for focused specs.
+
+```ruby
+# bad
+fit 'does something' do
+  expect(foo).to be_empty
+end
+
+it 'does something', focus: true do
+  expect(foo).to be_empty
+end
+
+# good
+it 'does something' do
+  expect(foo).to be_empty
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-rspec-focused'
+```
+
+And then execute:
+
+    $ bundle
+
+And add this to .rubocop.yml:
+
+```yml
+require:
+  - rubocop/rspec/focused
+
+Rspec/Focused:
+  Enabled: true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/lovewithfood/rubocop-rspec-focused/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

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

@@ -0,0 +1,48 @@
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Tests should not be focused.
+      #
+      # @example
+      #   # bad
+      #   fit 'does something' do
+      #     expect(foo).to be_empty
+      #   end
+      #
+      #   it 'does something', focus: true do
+      #     expect(foo).to be_empty
+      #   end
+      #
+      #   # good
+      #   it 'does something' do
+      #     expect(foo).to be_empty
+      #   end
+      class Focused < Cop
+        include AST::Sexp
+
+        MESSAGE = 'Remove focused spec'
+        FOCUSED_METHODS =
+          [:focus, :fexample, :fit, :fspecify, :fcontext, :fdescribe]
+
+        def on_block(node)
+          method, _args, _body = *node
+          _receiver, method_name, _object, metadata = *method
+
+          if FOCUSED_METHODS.include?(method_name) || focus_set_to_true?(metadata)
+            add_offense(node, :expression, MESSAGE)
+          end
+        end
+
+        private
+
+        def focus_set_to_true?(metadata)
+          metadata && metadata.children.any? do |pair|
+            pair == s(:pair, s(:sym, :focus), s(:true))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/focused.rb

@@ -0,0 +1 @@
+require 'rubocop/cop/rspec/focused'

data/lib/rubocop/rspec/focused/version.rb

@@ -0,0 +1,7 @@
+module RuboCop
+  module RSpec
+    module Focused
+      VERSION = '0.0.1'
+    end
+  end
+end

data/rubocop-rspec-focused.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/rspec/focused/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-rspec-focused"
+  spec.version       = RuboCop::RSpec::Focused::VERSION
+  spec.authors       = ["Love With Food, Hendy Tanata"]
+  spec.email         = ["hendy@lovewithfood.com"]
+  spec.summary       = %q{RuboCop extension to find focused specs}
+  spec.description   = %q{Find focused specs}
+  spec.homepage      = "https://github.com/lovewithfood/rubocop-rspec-focused"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+end

data/spec/lib/rubocop/cop/rspec/focused_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'rubocop/cop/rspec/focused'
+
+RSpec.describe RuboCop::Cop::RSpec::Focused do
+  subject(:cop) { described_class.new }
+
+  described_class::FOCUSED_METHODS.each do |method|
+    it "finds #{method}" do
+      inspect_source(cop, ["#{method} 'does something' do",
+                           '  expect(foo).to be_empty',
+                           'end'])
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.offenses.map(&:line).sort).to eq([1])
+      expect(cop.messages).to eq([described_class::MESSAGE])
+    end
+  end
+
+  it 'finds an example with focus: true' do
+    inspect_source(cop, ['it "does something", foo: bar, focus: true do',
+                         '  expect(foo).to be_empty',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+    expect(cop.offenses.map(&:line).sort).to eq([1])
+    expect(cop.messages).to eq([described_class::MESSAGE])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require File.join(
+  Gem::Specification.find_by_name('rubocop').gem_dir,
+  'spec/support', 'cop_helper.rb'
+)
+
+Dir['spec/support/**/*.rb'].each { |f| require f.sub(/\Aspec\//, '') }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rspec-focused
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Love With Food, Hendy Tanata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Find focused specs
+email:
+- hendy@lovewithfood.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubocop/cop/rspec/focused.rb
+- lib/rubocop/rspec/focused.rb
+- lib/rubocop/rspec/focused/version.rb
+- rubocop-rspec-focused.gemspec
+- spec/lib/rubocop/cop/rspec/focused_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lovewithfood/rubocop-rspec-focused
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RuboCop extension to find focused specs
+test_files:
+- spec/lib/rubocop/cop/rspec/focused_spec.rb
+- spec/spec_helper.rb