rspec_power 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15e38ae448c0c4dfeb0251c6186f5fff49aeb9fc36b68ee2c307e5bb9956a0e3
-  data.tar.gz: 29e94be5c241dcf1f839e5494c41d1327b289c8a6763a1cab3cda2ef4d601e81
+  metadata.gz: a77f18032d0c06a36ad09d86f39dfcc0361009599b465ba6c53be1c9b4b2028f
+  data.tar.gz: e629475ed4f514239754b305a74e86ff36127de526b7e7d9fa6a6383bb645f93
 SHA512:
-  metadata.gz: 5966690eb7da430b3e2ddd99acee303efb0c46909b6dca64d4d116fe12264d4e6fb40b215128850e4392f74fb152515e2dc2c667de2c8be52695467eaafe697f
-  data.tar.gz: 2b1c5ce8f74d29bbb54715aa8d4f9255a685f4e624073508e2fc2209d99a65bfcae6339d306a6bcc482641dc1325507781838a5c1dce7ed3b7d37b61128e8dac
+  metadata.gz: ac21e5391546fbf07d05d54a19dd1b01bb718a8318c78a62559aa1e47cf8f4ea2e3b4c937bca6a64da638d896de881350b863ea82400d879e7f476cdd205f385
+  data.tar.gz: 67fa15caba966ae8afa38ca9643a8c74af05f903ff1a9d17a324657e3a8733d85ed692b28f853f1fdf476f694729a9c582267172f33457b845c7891b453db5f6

data/README.md

@@ -28,7 +28,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 group :test do
-  gem "rspec_power", require: false
+  gem "rspec_power"
 end
 ```
 
@@ -38,6 +38,11 @@ And then execute:
 bundle install
 ```
 
+If you are using the "timecop" gem, you need to
+
+- add to Gemfile as `gem "rspec_power", require: false`
+- add `require "rspec_power"` before `require "timecop"` in `rails_helper.rb`.
+
 ## 🚀 Quick Start
 
 The gem automatically configures itself when required. Just add it to your Gemfile.
@@ -46,7 +51,7 @@ The gem automatically configures itself when required. Just add it to your Gemfi
 
 ### 🔍 Enhanced Logging
 
-Capture all Rails logs during specific tests:
+Capture all Rails logs during specific tests, copied from [test-prof](https://github.com/test-prof/test-prof) gem with a small enhancement:
 
 ```ruby
 RSpec.describe User, :with_log do

data/lib/rspec_power/env.rb

@@ -25,6 +25,10 @@ end
 RSpec.shared_context "rspec_power::env:override" do
   around(:each) do |example|
     overrides = example.metadata[:with_env] || {}
-    with_test_env(overrides) { example.run }
+    if overrides.any?
+      with_test_env(overrides) { example.run }
+    else
+      example.run
+    end
   end
 end

data/lib/rspec_power/logging.rb

@@ -75,17 +75,19 @@ module RSpecPower
       end
 
       def with_logging
-        old = LoggingHelpers.swap_logger(LoggingHelpers.all_loggables)
+        targets = LoggingHelpers.all_loggables
+        old_loggers = LoggingHelpers.swap_logger(targets)
         yield
       ensure
-        LoggingHelpers.restore_logger(old, LoggingHelpers.all_loggables)
+        LoggingHelpers.restore_logger(old_loggers, targets)
       end
 
       def with_ar_logging
-        old = LoggingHelpers.swap_logger(LoggingHelpers.ar_loggables)
+        targets = LoggingHelpers.ar_loggables
+        old_loggers = LoggingHelpers.swap_logger(targets)
         yield
       ensure
-        LoggingHelpers.restore_logger(old, LoggingHelpers.ar_loggables)
+        LoggingHelpers.restore_logger(old_loggers, targets)
       end
   end
 end

data/lib/rspec_power/performance.rb

@@ -10,7 +10,8 @@ module RSpecPower
         yield
       ensure
         elapsed_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000.0
-        if elapsed_ms > max_ms
+        # Do not override an existing exception
+        if $!.nil? && elapsed_ms > max_ms
           formatted_elapsed = format("%.3f", elapsed_ms)
           formatted_limit = format("%.3f", max_ms)
           raise RSpec::Expectations::ExpectationNotMetError,

data/lib/rspec_power/sql.rb

@@ -58,48 +58,56 @@ end
 
 RSpec.shared_context "rspec_power::sql:none" do
   around(:each) do |example|
-    executed_sql = []
+    if example.metadata[:with_no_sql_queries] || example.metadata[:with_no_sql]
+      executed_sql = []
 
-    callback = lambda do |_name, _started, _finished, _unique_id, payload|
-      event_name = payload[:name].to_s
-      cached = payload[:cached]
-      next if cached
-      next if event_name == "SCHEMA" || event_name == "TRANSACTION"
+      callback = lambda do |_name, _started, _finished, _unique_id, payload|
+        event_name = payload[:name].to_s
+        cached = payload[:cached]
+        next if cached
+        next if event_name == "SCHEMA" || event_name == "TRANSACTION"
 
-      executed_sql << payload[:sql]
-    end
+        executed_sql << payload[:sql]
+      end
 
-    ActiveSupport::Notifications.subscribed(callback, "sql.active_record") do
-      example.run
-    end
+      ActiveSupport::Notifications.subscribed(callback, "sql.active_record") do
+        example.run
+      end
 
-    if executed_sql.any?
-      message = "Expected no SQL to be executed, but #{executed_sql.length} statement(s) were run.\n" \
-                + executed_sql.map { |sql| "  - #{sql}" }.join("\n")
-      raise RSpec::Expectations::ExpectationNotMetError, message
+      if executed_sql.any?
+        message = "Expected no SQL to be executed, but #{executed_sql.length} statement(s) were run.\n" \
+                  + executed_sql.map { |sql| "  - #{sql}" }.join("\n")
+        raise RSpec::Expectations::ExpectationNotMetError, message
+      end
+    else
+      example.run
     end
   end
 end
 
 RSpec.shared_context "rspec_power::sql:must" do
   around(:each) do |example|
-    executed_sql = []
+    if example.metadata[:with_sql_queries] || example.metadata[:with_sql]
+      executed_sql = []
 
-    callback = lambda do |_name, _started, _finished, _unique_id, payload|
-      event_name = payload[:name].to_s
-      cached = payload[:cached]
-      next if cached
-      next if event_name == "SCHEMA" || event_name == "TRANSACTION"
+      callback = lambda do |_name, _started, _finished, _unique_id, payload|
+        event_name = payload[:name].to_s
+        cached = payload[:cached]
+        next if cached
+        next if event_name == "SCHEMA" || event_name == "TRANSACTION"
 
-      executed_sql << payload[:sql]
-    end
+        executed_sql << payload[:sql]
+      end
 
-    ActiveSupport::Notifications.subscribed(callback, "sql.active_record") do
-      example.run
-    end
+      ActiveSupport::Notifications.subscribed(callback, "sql.active_record") do
+        example.run
+      end
 
-    if executed_sql.empty?
-      raise RSpec::Expectations::ExpectationNotMetError, "Expected some SQL to be executed, but none was run"
+      if executed_sql.empty?
+        raise RSpec::Expectations::ExpectationNotMetError, "Expected some SQL to be executed, but none was run"
+      end
+    else
+      example.run
     end
   end
 end

data/lib/rspec_power/time.rb

@@ -1,10 +1,7 @@
-require "active_support/testing/time_helpers"
 require "time"
 
 module RSpecPower
   module TimeHelpers
-    include ActiveSupport::Testing::TimeHelpers
-
     def with_time_zone(zone)
       if defined?(ActiveSupport::TimeZone)
         ::Time.use_zone(zone) { yield }
@@ -18,6 +15,13 @@ end
 RSpec.shared_context "rspec_power::time:freeze" do
   around(:each) do |example|
     if ts = example.metadata[:with_time_freeze]
+      # include ActiveSupport::Testing::TimeHelpers if not already included
+      if !@_rspec_power_time_helpers_included && !respond_to?(:travel_to)
+        RSpec.configure do |config|
+          config.include ActiveSupport::Testing::TimeHelpers
+        end
+        @_rspec_power_time_helpers_included = true
+      end
       ts = Time.parse(ts) if ts.is_a?(String)
       travel_to(ts) { example.run }
     else

data/lib/rspec_power/version.rb

@@ -1,3 +1,3 @@
 module RSpecPower
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rspec_power.rb

@@ -11,7 +11,8 @@ require "rspec_power/sql"
 require "rspec_power/performance"
 require "rspec_power/benchmark"
 
-RSpec.configure do |config|
+if defined?(RSpec)
+  RSpec.configure do |config|
   # Logging
   config.include RSpecPower::LoggingHelpers
   config.include_context "rspec_power::logging:verbose", with_log: true
@@ -58,4 +59,5 @@ RSpec.configure do |config|
   # Prefer :with_dump_db_on_fail; keep :dump_db_on_fail for backward compatibility
   config.include_context "rspec_power::db_dump:on_fail", :with_dump_db_on_fail
   config.include_context "rspec_power::db_dump:on_fail", :dump_db_on_fail
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_power
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -79,7 +79,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: RSpec power tools
+description: 'A collection of helpers and contexts to enhance Rails specs: logging,
+  env/I18n/time helpers, SQL guards, request/DB dumps, benchmarking, CI guards, and
+  performance limits.'
 email:
 - igorkasyanchuk@gmail.com
 executables: []
@@ -107,6 +109,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/igorkasyanchuk/rspec_power
+  source_code_uri: https://github.com/igorkasyanchuk/rspec_power
+  bug_tracker_uri: https://github.com/igorkasyanchuk/rspec_power/issues
+  documentation_uri: https://github.com/igorkasyanchuk/rspec_power#readme
 rdoc_options: []
 require_paths:
 - lib
@@ -123,5 +128,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: RSpec power tools
+summary: Powerful RSpec helpers for Rails testing
 test_files: []