pludoni_rspec 0.11 → 0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c466a7c113bf41e61ead34a21d8666c036d09546b047796c8c36cbf86eb95a30
-  data.tar.gz: f83e2c29694819e70f5e1764ac92149c54029ef05eab94d0d8d5c5d21c36f937
+  metadata.gz: 897a5ac1427f82428f620f7d860ae26c1f2d17ba654f656baa646f26d42876fc
+  data.tar.gz: 6e3bd7d8bdf3292ea15c071115d09c5b1caa2f96d9a505088d649f7efcf2b7f0
 SHA512:
-  metadata.gz: 810faf546e1d8b267fb03ed3034fce9985d37484482befb490a0bf33206870d35c673fed0f4be6277a46315c63aa991e81d5637e3f78482df8fa0b1e4b974b32
-  data.tar.gz: f5e335409f4ecb041ffbbabe2de88cf81b3c63f080eed031d74bf55fd315da8b1466bd10257e4e8855115e3bef47e0eabe4ab7ff8c47d48669158e6e7bf169d7
+  metadata.gz: 06ffcb0a2cd67c7cc7af74cf96c10eb18a575c59e23b22300fb3031426179cc2e866d6afb9cc943badb5ce46f3b7297de902b09afaa3160982bf0f44cee9d783
+  data.tar.gz: f72de2ea77aaf4f182a376f6ab35a9bcec5f16128c9ddd1778f79a0511945b7cb3bf06545b69e053858fc60b24fad8812a04f42379a92dfadaad0874213ee0d6

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 0.20
+
+- Added new default custom formatter instead of fuubar - Documentation based,
+  but prints out duration and file paths of the group
+- Disable Smooth Scrolling for Cuprite
+- Fix: Rails 7.1 `fixture_path` or `fixture_paths`
+- Add: 3 new global helpers: 
+    - ``only_run_when_single_spec_and_local!``
+      skip this example, only run if you are working on it and skip it later like special customers bugs etc., 
+      long running crawler etc. that you want to run occasionally
+    - ``local!``
+      For System specs:
+      prints the instructions to open the current page in your local browser if
+      you run the specs remotely, create a SSH tunnel to the server during
+      system specs and open the brOwser on your local machine
+
 ### 0.11
 
 - Rails 7.1 fixture_paths deprecation

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    pludoni_rspec (0.11)
+    pludoni_rspec (0.20)
       capybara (>= 3.13.2)
       cuprite
-      fuubar (>= 2.3.1)
       headless (>= 2.3.1)
       pry-rails
       puma
@@ -37,9 +36,6 @@ GEM
       concurrent-ruby (~> 1.1)
       webrick (~> 1.7)
       websocket-driver (>= 0.6, < 0.8)
-    fuubar (2.5.1)
-      rspec-core (~> 3.0)
-      ruby-progressbar (~> 1.4)
     headless (2.3.1)
     matrix (0.4.2)
     method_source (1.0.0)
@@ -69,7 +65,6 @@ GEM
     rspec-support (3.12.0)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)

data/lib/pludoni_rspec/cuprite.rb

@@ -9,6 +9,7 @@ Capybara.register_driver(:cuprite_pl) do |app|
   if ENV['CI']
     options['no-sandbox'] = nil
   end
+  options['disable-smooth-scrolling'] = true
   Capybara::Cuprite::Driver.new(app,
     window_size: [1200, 800],
     browser_options: options,

data/lib/pludoni_rspec/formatter.rb

@@ -0,0 +1,48 @@
+require 'rspec/core'
+require 'rspec/core/formatters/documentation_formatter'
+
+class EnhancedDocumentationFormatter < RSpec::Core::Formatters::DocumentationFormatter
+  RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished,
+    :example_passed, :example_pending, :example_failed
+
+  class << self
+    attr_accessor :threshold_for_good, :threshold_for_bad
+  end
+  self.threshold_for_good = 0.2
+  self.threshold_for_bad = 2
+
+  def example_group_started(notification)
+    output.puts if @group_level == 0
+    filename = if @group_level == 0
+                 RSpec::Core::Formatters::ConsoleCodes.wrap(notification.group.file_path, :gray)
+               end
+    output.puts "#{current_indentation}#{notification.group.description.strip} #{filename}"
+
+    @group_level += 1
+  end
+
+  private
+
+  def passed_output(example)
+    super + "  " + duration(example)
+  end
+
+  def failure_output(example)
+    super + "  " + duration(example)
+  end
+
+  def pending_output(example, message)
+    super + "  " + duration(example)
+  end
+
+  def duration(example)
+    time = example.metadata[:execution_result][:run_time]
+    if time < self.class.threshold_for_good
+      RSpec::Core::Formatters::ConsoleCodes.wrap("#{(time * 1000).round}ms", :black)
+    elsif time > self.class.threshold_for_bad
+      RSpec::Core::Formatters::ConsoleCodes.wrap("#{time.round(2)}s", :red)
+    else
+      RSpec::Core::Formatters::ConsoleCodes.wrap("#{time.round(2)}s", :yellow)
+    end
+  end
+end

data/lib/pludoni_rspec/spec_helper.rb

@@ -1,9 +1,12 @@
 RSpec.configure do |config|
+  config.before(:each) do
+    ActiveSupport::CurrentAttributes.reset_all if defined?(ActiveSupport::CurrentAttributes)
+  end
   config.example_status_persistence_file_path = 'tmp/rspec.failed.txt'
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
-  config.include RSpec::Rails::RequestExampleGroup, type: :request, file_path: /spec\/api/
+  config.include RSpec::Rails::RequestExampleGroup, type: :request, file_path: %r{spec/api}
   config.before do
     I18n.locale = I18n.default_locale
     if defined?(Fabrication)
@@ -21,7 +24,7 @@ RSpec.configure do |config|
 
   config.bisect_runner = :shell
   config.order = :defined
-  if Rails.version.to_f >= 7.1
+  if config.respond_to?(:fixture_paths)
     config.fixture_paths ||= []
     config.fixture_paths << "#{::Rails.root}/spec/fixtures"
   else
@@ -57,9 +60,42 @@ RSpec.configure do |config|
   end
 
   config.around(:each, :timeout) do |example|
-    time = 10 unless time.kind_of?(Numeric)
+    time = 10 unless time.is_a?(Numeric)
     Timeout.timeout(time) do
       example.run
     end
   end
+
+  # helper method for below
+  def current_file_is_the_only_spec?
+    file = caller.find { |c| c =~ /_spec\.rb/ }.split(':').first
+    file = Pathname.new(file).relative_path_from(Rails.root).to_s
+    ARGV.any? { |arg| arg.include?(file) }
+  end
+
+  # skip this example, only run if you are working on it and skip it later
+  #   like special customers bugs etc.
+  def only_run_when_single_spec_and_local!
+    if ENV['CI'] || !current_file_is_the_only_spec?
+      skip "Only run when run as a single spec and not CI set"
+    end
+  end
+
+  # For System specs:
+  # prints the instructions to open the current page in your local browser
+  # if you run the specs remotely, create a SSH tunnel to the server during system specs
+  # and open the brOwser on your local machine
+  def local!
+    uri = URI.parse(page.current_url)
+    puts "--- Connect with local browser:"
+    puts "  1. Open a SSH tunnel with port forwarding to the test server:"
+    puts "\nssh #{ENV['LOGNAME']}@pludoni.com -L 8080:localhost:#{uri.port}\n"
+      puts "  2. Open in Browser: "
+    uri.port = nil
+    uri.scheme = nil
+    uri.host = nil
+    puts "\nhttp://localhost:8080#{uri}\n"
+    puts "  Afterwards, you can close the SSH session"
+  end
+
 end

data/lib/pludoni_rspec/version.rb

@@ -1,3 +1,3 @@
 module PludoniRspec
-  VERSION = "0.11".freeze
+  VERSION = "0.20".freeze
 end

data/lib/pludoni_rspec.rb

@@ -1,15 +1,10 @@
 require "pludoni_rspec/version"
 require 'json'
 
-# rubocop:disable Rails/FilePath
 module PludoniRspec
   class Config
     class << self
-      attr_accessor :destroy_headless
-      attr_accessor :wrap_js_spec_in_headless
-      attr_accessor :chrome_arguments
-      attr_accessor :capybara_timeout
-      attr_accessor :coverage_enabled
+      attr_accessor :destroy_headless, :wrap_js_spec_in_headless, :chrome_arguments, :capybara_timeout, :coverage_enabled
     end
     # self.chrome_driver_version = "2.36"
     self.destroy_headless = false
@@ -18,6 +13,7 @@ module PludoniRspec
     self.capybara_timeout = ENV['CI'] == '1' ? 30 : 5
     self.coverage_enabled = true
   end
+
   def self.run
     ENV["RAILS_ENV"] ||= 'test'
     coverage! if Config.coverage_enabled
@@ -29,6 +25,8 @@ module PludoniRspec
     require 'pludoni_rspec/cuprite'
     require 'pludoni_rspec/freeze_time'
     require 'pludoni_rspec/shared_context'
+    require 'pludoni_rspec/formatter'
+    RSpec.configuration.default_formatter = 'EnhancedDocumentationFormatter'
     if defined?(VCR)
       require 'pludoni_rspec/vcr'
     end
@@ -43,7 +41,7 @@ module PludoniRspec
     if File.exist?('coverage/.resultset.json') && (
         File.ctime('coverage/.resultset.json') < (Time.now - 900) ||
         (JSON.parse(File.read('coverage/.resultset.json')).keys.length > 4)
-    )
+      )
       File.unlink('coverage/.resultset.json')
       if File.exist?('coverage/.resultset.json.lock')
         File.unlink('coverage/.resultset.json.lock')

data/pludoni_rspec.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "vcr", ">= 3.0.0"
   # spec.add_dependency "geckodriver-helper", ">= 0.23.0"
   spec.add_dependency 'capybara', ">= 3.13.2"
-  spec.add_dependency 'fuubar', '>= 2.3.1'
+  # spec.add_dependency 'fuubar', '>= 2.3.1'
   spec.add_dependency 'headless', ">= 2.3.1"
   spec.add_dependency 'pry-rails'
   spec.add_dependency 'puma'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pludoni_rspec
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.20'
 platform: ruby
 authors:
 - Stefan Wienert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.13.2
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: headless
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +173,7 @@ files:
 - lib/pludoni_rspec.rb
 - lib/pludoni_rspec/cuprite.rb
 - lib/pludoni_rspec/devise.rb
+- lib/pludoni_rspec/formatter.rb
 - lib/pludoni_rspec/freeze_time.rb
 - lib/pludoni_rspec/shared_context.rb
 - lib/pludoni_rspec/spec_helper.rb