rubocop-rspec-focused 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 18d13e56c465ff7b44a3f971d20354f8317bafbe
4
+ data.tar.gz: d59941e5b7c8e7167c42fc6cc954be23f3cb3c3e
5
+ SHA512:
6
+ metadata.gz: 8138b5bf399d3cccd1a819c0f6c88309fe4d5e56d3eb6de5b0ead1a5d7c0148070c5d888a14c677e91ab73473419484d0a2295d1313d34edc1ff52d54756170c
7
+ data.tar.gz: 6d28d20175cba0605b9a81caaad880af0dfa2f245b7e46c978edd3dae4a39061cfdb61f7317f73c77a3abf7d30445a7e769a8d60aba74ae6a7db101360360767
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --require spec_helper
data/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ ## 0.0.1
2
+
3
+ * Initial release.
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in rubocop-rspec-focused.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 Love With Food, Hendy Tanata
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,49 @@
1
+ # rubocop-rspec-focused
2
+
3
+ Cop for focused specs.
4
+
5
+ ```ruby
6
+ # bad
7
+ fit 'does something' do
8
+ expect(foo).to be_empty
9
+ end
10
+
11
+ it 'does something', focus: true do
12
+ expect(foo).to be_empty
13
+ end
14
+
15
+ # good
16
+ it 'does something' do
17
+ expect(foo).to be_empty
18
+ end
19
+ ```
20
+
21
+ ## Installation
22
+
23
+ Add this line to your application's Gemfile:
24
+
25
+ ```ruby
26
+ gem 'rubocop-rspec-focused'
27
+ ```
28
+
29
+ And then execute:
30
+
31
+ $ bundle
32
+
33
+ And add this to .rubocop.yml:
34
+
35
+ ```yml
36
+ require:
37
+ - rubocop/rspec/focused
38
+
39
+ Rspec/Focused:
40
+ Enabled: true
41
+ ```
42
+
43
+ ## Contributing
44
+
45
+ 1. Fork it ( https://github.com/lovewithfood/rubocop-rspec-focused/fork )
46
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
47
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
48
+ 4. Push to the branch (`git push origin my-new-feature`)
49
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,48 @@
1
+ require 'rubocop'
2
+
3
+ module RuboCop
4
+ module Cop
5
+ module RSpec
6
+ # Tests should not be focused.
7
+ #
8
+ # @example
9
+ # # bad
10
+ # fit 'does something' do
11
+ # expect(foo).to be_empty
12
+ # end
13
+ #
14
+ # it 'does something', focus: true do
15
+ # expect(foo).to be_empty
16
+ # end
17
+ #
18
+ # # good
19
+ # it 'does something' do
20
+ # expect(foo).to be_empty
21
+ # end
22
+ class Focused < Cop
23
+ include AST::Sexp
24
+
25
+ MESSAGE = 'Remove focused spec'
26
+ FOCUSED_METHODS =
27
+ [:focus, :fexample, :fit, :fspecify, :fcontext, :fdescribe]
28
+
29
+ def on_block(node)
30
+ method, _args, _body = *node
31
+ _receiver, method_name, _object, metadata = *method
32
+
33
+ if FOCUSED_METHODS.include?(method_name) || focus_set_to_true?(metadata)
34
+ add_offense(node, :expression, MESSAGE)
35
+ end
36
+ end
37
+
38
+ private
39
+
40
+ def focus_set_to_true?(metadata)
41
+ metadata && metadata.children.any? do |pair|
42
+ pair == s(:pair, s(:sym, :focus), s(:true))
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1 @@
1
+ require 'rubocop/cop/rspec/focused'
@@ -0,0 +1,7 @@
1
+ module RuboCop
2
+ module RSpec
3
+ module Focused
4
+ VERSION = '0.0.1'
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'rubocop/rspec/focused/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "rubocop-rspec-focused"
8
+ spec.version = RuboCop::RSpec::Focused::VERSION
9
+ spec.authors = ["Love With Food, Hendy Tanata"]
10
+ spec.email = ["hendy@lovewithfood.com"]
11
+ spec.summary = %q{RuboCop extension to find focused specs}
12
+ spec.description = %q{Find focused specs}
13
+ spec.homepage = "https://github.com/lovewithfood/rubocop-rspec-focused"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_runtime_dependency "rubocop"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.7"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.1.0"
26
+ end
@@ -0,0 +1,26 @@
1
+ require 'spec_helper'
2
+ require 'rubocop/cop/rspec/focused'
3
+
4
+ RSpec.describe RuboCop::Cop::RSpec::Focused do
5
+ subject(:cop) { described_class.new }
6
+
7
+ described_class::FOCUSED_METHODS.each do |method|
8
+ it "finds #{method}" do
9
+ inspect_source(cop, ["#{method} 'does something' do",
10
+ ' expect(foo).to be_empty',
11
+ 'end'])
12
+ expect(cop.offenses.size).to eq(1)
13
+ expect(cop.offenses.map(&:line).sort).to eq([1])
14
+ expect(cop.messages).to eq([described_class::MESSAGE])
15
+ end
16
+ end
17
+
18
+ it 'finds an example with focus: true' do
19
+ inspect_source(cop, ['it "does something", foo: bar, focus: true do',
20
+ ' expect(foo).to be_empty',
21
+ 'end'])
22
+ expect(cop.offenses.size).to eq(1)
23
+ expect(cop.offenses.map(&:line).sort).to eq([1])
24
+ expect(cop.messages).to eq([described_class::MESSAGE])
25
+ end
26
+ end
@@ -0,0 +1,92 @@
1
+ require File.join(
2
+ Gem::Specification.find_by_name('rubocop').gem_dir,
3
+ 'spec/support', 'cop_helper.rb'
4
+ )
5
+
6
+ Dir['spec/support/**/*.rb'].each { |f| require f.sub(/\Aspec\//, '') }
7
+
8
+ # This file was generated by the `rspec --init` command. Conventionally, all
9
+ # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
10
+ # The generated `.rspec` file contains `--require spec_helper` which will cause this
11
+ # file to always be loaded, without a need to explicitly require it in any files.
12
+ #
13
+ # Given that it is always loaded, you are encouraged to keep this file as
14
+ # light-weight as possible. Requiring heavyweight dependencies from this file
15
+ # will add to the boot time of your test suite on EVERY test run, even for an
16
+ # individual file that may not need all of that loaded. Instead, consider making
17
+ # a separate helper file that requires the additional dependencies and performs
18
+ # the additional setup, and require it from the spec files that actually need it.
19
+ #
20
+ # The `.rspec` file also contains a few flags that are not defaults but that
21
+ # users commonly want.
22
+ #
23
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
24
+ RSpec.configure do |config|
25
+ # rspec-expectations config goes here. You can use an alternate
26
+ # assertion/expectation library such as wrong or the stdlib/minitest
27
+ # assertions if you prefer.
28
+ config.expect_with :rspec do |expectations|
29
+ # This option will default to `true` in RSpec 4. It makes the `description`
30
+ # and `failure_message` of custom matchers include text for helper methods
31
+ # defined using `chain`, e.g.:
32
+ # be_bigger_than(2).and_smaller_than(4).description
33
+ # # => "be bigger than 2 and smaller than 4"
34
+ # ...rather than:
35
+ # # => "be bigger than 2"
36
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
37
+ end
38
+
39
+ # rspec-mocks config goes here. You can use an alternate test double
40
+ # library (such as bogus or mocha) by changing the `mock_with` option here.
41
+ config.mock_with :rspec do |mocks|
42
+ # Prevents you from mocking or stubbing a method that does not exist on
43
+ # a real object. This is generally recommended, and will default to
44
+ # `true` in RSpec 4.
45
+ mocks.verify_partial_doubles = true
46
+ end
47
+
48
+ # These two settings work together to allow you to limit a spec run
49
+ # to individual examples or groups you care about by tagging them with
50
+ # `:focus` metadata. When nothing is tagged with `:focus`, all examples
51
+ # get run.
52
+ config.filter_run :focus
53
+ config.run_all_when_everything_filtered = true
54
+
55
+ # Limits the available syntax to the non-monkey patched syntax that is recommended.
56
+ # For more details, see:
57
+ # - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
58
+ # - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
59
+ # - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
60
+ config.disable_monkey_patching!
61
+
62
+ # This setting enables warnings. It's recommended, but in some cases may
63
+ # be too noisy due to issues in dependencies.
64
+ config.warnings = true
65
+
66
+ # Many RSpec users commonly either run the entire suite or an individual
67
+ # file, and it's useful to allow more verbose output when running an
68
+ # individual spec file.
69
+ if config.files_to_run.one?
70
+ # Use the documentation formatter for detailed output,
71
+ # unless a formatter has already been configured
72
+ # (e.g. via a command-line flag).
73
+ config.default_formatter = 'doc'
74
+ end
75
+
76
+ # Print the 10 slowest examples and example groups at the
77
+ # end of the spec run, to help surface which specs are running
78
+ # particularly slow.
79
+ config.profile_examples = 10
80
+
81
+ # Run specs in random order to surface order dependencies. If you find an
82
+ # order dependency and want to debug it, you can fix the order by providing
83
+ # the seed, which is printed after each run.
84
+ # --seed 1234
85
+ config.order = :random
86
+
87
+ # Seed global randomization in this process using the `--seed` CLI option.
88
+ # Setting this allows you to use `--seed` to deterministically reproduce
89
+ # test failures related to randomization by passing the same `--seed` value
90
+ # as the one that triggered the failure.
91
+ Kernel.srand config.seed
92
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rubocop-rspec-focused
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Love With Food, Hendy Tanata
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-02-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rubocop
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.7'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.7'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 3.1.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 3.1.0
69
+ description: Find focused specs
70
+ email:
71
+ - hendy@lovewithfood.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - CHANGELOG.md
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - lib/rubocop/cop/rspec/focused.rb
84
+ - lib/rubocop/rspec/focused.rb
85
+ - lib/rubocop/rspec/focused/version.rb
86
+ - rubocop-rspec-focused.gemspec
87
+ - spec/lib/rubocop/cop/rspec/focused_spec.rb
88
+ - spec/spec_helper.rb
89
+ homepage: https://github.com/lovewithfood/rubocop-rspec-focused
90
+ licenses:
91
+ - MIT
92
+ metadata: {}
93
+ post_install_message:
94
+ rdoc_options: []
95
+ require_paths:
96
+ - lib
97
+ required_ruby_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ required_rubygems_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ requirements: []
108
+ rubyforge_project:
109
+ rubygems_version: 2.2.2
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: RuboCop extension to find focused specs
113
+ test_files:
114
+ - spec/lib/rubocop/cop/rspec/focused_spec.rb
115
+ - spec/spec_helper.rb