test-prof 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3470510e87a497a0296d3a88f6bb5dc2666f00ad
-  data.tar.gz: 4e9ee789a2f74f17498437150401beab2876a635
+  metadata.gz: 24cff6c482c079404a3305f62252be2030f673fc
+  data.tar.gz: ed0f1cb0674d57d171cb7214ecb0c890750e3841
 SHA512:
-  metadata.gz: 5d4436007d14d00b8c2607cb197fdb8f8046192a25f633573c4a42af207ae7516a63bde479536d19dcbab0e7b2e3ce9a3ebd9f097c81d60cea37c79157763799
-  data.tar.gz: eeaccf2924f2913fee7b14d20be66c9a2badfae2eeb1abe68af978852e9168c9098a8ab1d0b67f3dad43b1368a818246cd7552fa48d573ddcc7f2ea8b07e7566
+  metadata.gz: 812bd0c997bac0956f02f63056100bddce61ba1ec4b0bcbce6d279b36f28f6d963ed83ce976664b1181840a7a4daf24af5dbdc2646401db212e4ae377fb091a6
+  data.tar.gz: 45bdcee69c2ff43ec1c4117b5e2d1df21046708956df1818cc900c056f914a500df28397487a4989a5695c0f46f1ebb7db66bc3a24690812e7e7cdd67a71be56

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## master
+
+- Upgrade RSpec/AggregateFailures to RuboCop 0.52.0. ([@palkan][])
+
+  RuboCop < 0.51.0 is not supported anymore.
+
+- [Fixes [#49](https://github.com/palkan/test-prof/issues/49)] Correcly detect RSpec version in `let_it_be`. ([@desoleary][])
+
 ## 0.4.5
 
 - Fix circular require in `lib/factory_doctor/minitest`. ([@palkan][])
@@ -10,7 +18,7 @@
 
 ## 0.4.3
 
-- [#46](https://github.com/palkan/test-prof/pull/46) Support FactoryBot, which is [former FactoryGirl](https://github.com/thoughtbot/factory_bot/pull/1051), 
+- [#46](https://github.com/palkan/test-prof/pull/46) Support FactoryBot, which is [former FactoryGirl](https://github.com/thoughtbot/factory_bot/pull/1051),
   while maintaining compatibility with latter. ([@Shkrt][])
 
 ## 0.4.2
@@ -134,4 +142,4 @@ Ensure output dir exists in `#artifact_path` method.
 [@danielwestendorf]: https://github.com/danielwestendorf
 [@Shkrt]: https://github.com/Shkrt
 [@IDolgirev]: https://github.com/IDolgirev
-
+[@desoleary]: https://github.com/desoleary

data/guides/.rubocop.yml

@@ -0,0 +1 @@
+# Leave it blank to use default Rubocop config in guides

data/guides/any_fixture.md

@@ -10,7 +10,7 @@ Consider an example:
 
 ```ruby
 # The best way to use AnyFixture is through RSpec shared contexts
-RSpec.shared_context "account", account: true do
+RSpec.shared_context 'account', account: true do
   # You should call AnyFixture outside of transaction to re-use the same
   # data between examples
   before(:all) do
@@ -30,22 +30,21 @@ RSpec.shared_context "account", account: true do
 
   let(:account) { @account }
 
-  # Or hard-reload object if there is chance of in-place modification within tests
+  # Or hard-reload object if there is chance of in-place modification
   let(:account) { Account.find(@account.id) }
 end
 
-
 # Then in your tests
 
 # Active this fixture using a tag
 describe UsersController, :account do
-  ...
+  # ...
 end
 
 # This test also uses the same account record,
 # no double-creation
 describe PostsController, :account do
-  ...
+  # ...
 end
 ```
 
@@ -54,7 +53,7 @@ end
 In your `spec_helper.rb`:
 
 ```ruby
-require "test_prof/recipes/rspec/any_fixture"
+require 'test_prof/recipes/rspec/any_fixture'
 ```
 
 Now you can use `TestProf::AnyFixture` in your tests.
@@ -79,7 +78,7 @@ end
 And the shared contexts:
 
 ```ruby
-RSpec.shared_context "author" do
+RSpec.shared_context 'author' do
   before(:all) do
     @author = TestProf::AnyFixture.register(:author) do
       FactoryGirl.create(:account)
@@ -89,7 +88,7 @@ RSpec.shared_context "author" do
   let(:author) { @author }
 end
 
-RSpec.shared_context "article" do
+RSpec.shared_context 'article' do
   before(:all) do
     # outside of AnyFixture, we don't know about its dependent tables
     author = FactoryGirl.create(:author)
@@ -107,9 +106,9 @@ Then in some example:
 
 ```ruby
 # This one adds only the 'articles' table to the list of affected tables
-include_context "article"
+include_context 'article'
 # And this one adds the 'authors' table
-include_context "author"
+include_context 'author'
 ```
 
 Now we have the following affected tables list: `['articles', 'authors']`. At the end of the suite, the 'authors' table is cleaned first which leads to a foreign-key violation error.

data/guides/before_all.md

@@ -27,10 +27,10 @@ Or you can try `before(:all)`:
 describe BeatleWeightedSearchQuery do
   before(:all) do
     @paul = create(:beatle, name: 'Paul')
-    ...
+    # ...
   end
 
-  ...
+  # ...
 end
 ```
 
@@ -43,10 +43,10 @@ And that's how `before_all` works:
 describe BeatleWeightedSearchQuery do
   before_all do
     @paul = create(:beatle, name: 'Paul')
-    ...
+    # ...
   end
 
-  ...
+  # ...
 end
 ```
 
@@ -57,7 +57,7 @@ That's all!
 In your `spec_helper.rb`:
 
 ```ruby
-require "test_prof/recipes/rspec/before_all"
+require 'test_prof/recipes/rspec/before_all'
 ```
 
 ## Caveats
@@ -72,13 +72,13 @@ end
 
 let(:user) { @user }
 
-it "when user is admin" do
+it 'when user is admin' do
   # we modified our object in-place!
   user.update!(role: 1)
   expect(user).to be_admin
 end
 
-it "when user is regular" do
+it 'when user is regular' do
   # now @user's state depends on the order of specs!
   expect(user).not_to be_admin
 end

data/guides/factory_default.md

@@ -31,15 +31,15 @@ end
 And we want to test the `Task` model:
 
 ```ruby
-describe "PATCH #update" do
+describe 'PATCH #update' do
   let(:task) { create(:task) }
 
-  it "works" do
+  it 'works' do
     patch :update, id: task.id, task: { completed: 't' }
     expect(response).to be_success
   end
 
-  ...
+  # ...
 end
 ```
 
@@ -50,12 +50,12 @@ And it breaks our logic (every object should belong to the same account).
 Typical workaround:
 
 ```ruby
-describe "PATCH #update" do
+describe 'PATCH #update' do
   let(:account) { create(:account) }
   let(:project) { create(:project, account: account) }
   let(:task) { create(:task, project: project, account: account) }
 
-  it "works" do
+  it 'works' do
     patch :update, id: task.id, task: { completed: 't' }
     expect(response).to be_success
   end
@@ -67,7 +67,7 @@ That works. And there are some cons: it's a little bit verbose and error-prone (
 Here is how we can deal with it using FactoryDefault:
 
 ```ruby
-describe "PATCH #update" do
+describe 'PATCH #update' do
   let(:account) { create_default(:account) }
   let(:project) { create_default(:project) }
   let(:task) { create(:task) }
@@ -75,9 +75,9 @@ describe "PATCH #update" do
   # and if we need more projects, users, tasks with the same parent record,
   # we just write
   let(:another_project) { create(:project) } # uses the same account
-  let(:another_task) { create(:task) } # uses the same account and the first project
+  let(:another_task) { create(:task) } # uses the same account
 
-  it "works" do
+  it 'works' do
     patch :update, id: task.id, task: { completed: 't' }
     expect(response).to be_success
   end
@@ -91,7 +91,7 @@ end
 In your `spec_helper.rb`:
 
 ```ruby
-require "test_prof/recipes/rspec/factory_default"
+require 'test_prof/recipes/rspec/factory_default'
 ```
 
 This adds two new methods to FactoryBot:

data/guides/factory_doctor.md

@@ -3,7 +3,7 @@
 One common bad pattern that slows our tests down is unnecessary database manipulation. Consider a _bad_ example:
 
 ```ruby
-it "validates name presence" do
+it 'validates name presence' do
   user = create(:user)
   user.name = ''
   expect(user).not_to be_valid
@@ -13,7 +13,7 @@ end
 Here we create a new user record, run all callbacks and validations and save it to the database. We don't need all these! Here is a _good_ example:
 
 ```ruby
-it "validates name presence" do
+it 'validates name presence' do
   user = build_stubbed(:user)
   user.name = ''
   expect(user).not_to be_valid
@@ -46,7 +46,7 @@ You can also tell FactoryDoctor to ignore specific examples/groups. Just add the
 
 ```ruby
 # won't be reported as offense
-it "is ignored", :fd_ignore do
+it 'is ignored', :fd_ignore do
   user = create(:user)
   user.name = ''
   expect(user).not_to be_valid
@@ -94,7 +94,7 @@ Just use `fd_ignore` inside your example:
 
 ```ruby
 # won't be reported as offense
-it "is ignored" do
+it 'is ignored' do
   fd_ignore
 
   @user.name = ''

data/guides/factory_prof.md

@@ -72,7 +72,7 @@ end
 create(:comment) #=> creates 5 records
 
 # And the corresponding stack is:
-[:comment, :answer, :question, :author, :author, :author]
+# [:comment, :answer, :question, :author, :author, :author]
 ```
 
 The wider column the more often this stack appears.

data/guides/let_it_be.md

@@ -25,12 +25,12 @@ We already have [`before_all`](https://github.com/palkan/test-prof/tree/master/g
 describe BeatleWeightedSearchQuery do
   before_all do
     @paul = create(:beatle, name: 'Paul')
-    ...
+    # ...
   end
 
   specify { expect(subject.call('joh')).to contain_exactly(@john) }
 
-  ...
+  # ...
 end
 ```
 
@@ -60,7 +60,7 @@ That's it! Just replace `let!` with `let_it_be`. That's equal to the `before_all
 In your `spec_helper.rb`:
 
 ```ruby
-require "test_prof/recipes/rspec/let_it_be"
+require 'test_prof/recipes/rspec/let_it_be'
 ```
 
 In your tests:
@@ -69,7 +69,7 @@ In your tests:
 describe MySuperDryService do
   let_it_be(:user) { create(:user) }
 
-  ...
+  # ...
 end
 ```
 

data/guides/rspec_stamp.md

@@ -17,7 +17,7 @@ Step 0. Make sure that all your tests pass.
 Step 1. Create a shared context to conditionally turn on `inline!` mode:
 
 ```ruby
-shared_context "sidekiq:inline", sidekiq: :inline do
+shared_context 'sidekiq:inline', sidekiq: :inline do
   around(:each) { |ex| Sidekiq::Testing.inline!(&ex) }
 end
 ```

data/guides/rubocop.md

@@ -36,7 +36,7 @@ it { is_expected.to have_header('X-TOTAL-PAGES', 10) }
 it { is_expected.to have_header('X-NEXT-PAGE', 2) }
 
 # good
-it "returns the second page", :aggregate_failures do
+it 'returns the second page', :aggregate_failures do
   is_expected.to be_success
   is_expected.to have_header('X-TOTAL-PAGES', 10)
   is_expected.to have_header('X-NEXT-PAGE', 2)

data/guides/ruby_prof.md

@@ -33,8 +33,8 @@ TestProf::RubyProf.run
 TestProf provides a built-in shared context for RSpec to profile examples individually:
 
 ```ruby
-it "is doing heavy stuff", :rprof do
-  ...
+it 'is doing heavy stuff', :rprof do
+  # ...
 end
 ```
 

data/guides/stack_prof.md

@@ -33,8 +33,8 @@ TestProf::StackProf.run
 TestProf provides a built-in shared context for RSpec to profile examples individually:
 
 ```ruby
-it "is doing heavy stuff", :sprof do
-  ...
+it 'is doing heavy stuff', :sprof do
+  # ...
 end
 ```
 

data/guides/tag_prof.md

@@ -40,8 +40,7 @@ That's the quick workaround:
 
 ```ruby
 RSpec.configure do |config|
-
-  ...
+  # ...
   config.define_derived_metadata(file_path: %r{/spec/}) do |metadata|
     # do not overwrite type if it's already set
     next if metadata.key?(:type)

data/guides/tests_sampling.md

@@ -9,10 +9,10 @@ Require the corresponding patch:
 
 ```ruby
 # For RSpec in your spec_helper.rb
-require "test_prof/recipes/rspec/sample"
+require 'test_prof/recipes/rspec/sample'
 
 # For Minitest in your test_helper.rb
-require "test_prof/recipes/minitest/sample"
+require 'test_prof/recipes/minitest/sample'
 ```
 
 And then just add `SAMPLE` env variable with the number of example groups (or suites) you want to run:

data/lib/test_prof/cops/rspec/aggregate_failures.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop'
+require 'test_prof/utils'
 
 module RuboCop
   module Cop
@@ -37,7 +38,22 @@ module RuboCop
           pending
         ].freeze
 
+        class << self
+          def supported?
+            return @supported if instance_variable_defined?(:@supported)
+            @supported = TestProf::Utils.verify_gem_version('rubocop', at_least: '0.51.0')
+
+            unless @supported
+              warn "RSpec/AggregateFailures cop requires RuboCop >= 0.51.0. Skipping"
+            end
+
+            @supported
+          end
+        end
+
         def on_block(node)
+          return unless self.class.supported?
+
           method, _args, body = *node
           return unless body && body.begin_type?
 
@@ -48,8 +64,8 @@ module RuboCop
 
           add_offense(
             node,
-            :expression,
-            'Use :aggregate_failures instead of several one-liners.'
+            location: :expression,
+            message: 'Use :aggregate_failures instead of several one-liners.'
           )
         end
 

data/lib/test_prof/recipes/rspec/let_it_be.rb

@@ -16,7 +16,7 @@ module TestProf
 
       # Only works with RSpec 3.2.0
       def supported?
-        TestProf::Utils.verify_gem_version('rspec', at_least: '3.2.0')
+        TestProf::Utils.verify_gem_version('rspec-core', at_least: '3.2.0')
       end
 
       private

data/lib/test_prof/rspec_dissect/rspec.rb

@@ -154,6 +154,7 @@ module TestProf
         RSpecDissect.config.top_count
       end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end
 

data/lib/test_prof/ruby_prof.rb

@@ -103,9 +103,8 @@ module TestProf
       def dump(name)
         result = @profiler.stop
 
-        if config.eliminate_methods?
-          result.eliminate_methods!(config.eliminate_methods)
-        end
+        result.eliminate_methods!(config.eliminate_methods) if
+          config.eliminate_methods?
 
         printer_type, printer_class = config.resolve_printer
         path = build_path name, printer_type

data/lib/test_prof/utils.rb

@@ -8,10 +8,16 @@ module TestProf
         raise ArgumentError, "Please, provide `at_least` or `at_most` argument" if
           at_least.nil? && at_most.nil?
 
-        version = Gem.loaded_specs[gem_name].version
+        spec = Gem.loaded_specs[gem_name]
+        version = spec.version if spec
+        return false if version.nil?
 
-        (at_least.nil? || Gem::Version.new(at_least) <= version) &&
-          (at_most.nil? || Gem::Version.new(at_most) >= version)
+        supported_version?(version, at_least, at_most)
+      end
+
+      def supported_version?(gem_version, at_least, at_most)
+        (at_least.nil? || Gem::Version.new(at_least) <= gem_version) &&
+          (at_most.nil? || Gem::Version.new(at_most) >= gem_version)
       end
     end
   end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.4.5".freeze
+  VERSION = "0.4.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2017-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
   to analyze factories usage, integrate with Ruby profilers,\n    profile your examples
   using ActiveSupport notifications (if any) and\n    statically analyze your code
@@ -104,6 +118,7 @@ files:
 - assets/src/d3.flameGraph.min.js
 - assets/src/d3.v4.min.js
 - assets/testprof.png
+- guides/.rubocop.yml
 - guides/any_fixture.md
 - guides/before_all.md
 - guides/event_prof.md