factory_bot_instrumentation 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22779b2ddcf2a843745a37630a9c9195cdee2ec476aba7ff9f384ba3479d8bc7
-  data.tar.gz: 0c8aafc7fe54a6bd757c2d35193fbe45ec184d7c3714048a800c54225cfbacf2
+  metadata.gz: 166d24c0a99e8dd9dca1a06a195cdc9c9a89d2ec4aca5eeb1978e8bc9168bbcb
+  data.tar.gz: 8dbd9b962528fdb0f033a508dee1c63dbe4cd0eed0f564384bd74aad44e7a1c9
 SHA512:
-  metadata.gz: 8c9b1fcbb5f85e3deb47cbbe308841e29ce06dd300ae0085e3728e6a68a3341d70aad86f7ca9efd563f5fa82469ed1ba422c6b3f5cbc86af238c66800d6602a0
-  data.tar.gz: fd1a95d7b69759f6e4f8b491948c2d688f45294909decde13b95b4625341445868cb40c6150b1e091dde8ed13ebabebf1557002eabd14752b3f5338ed59466a3
+  metadata.gz: ba0e5b5ca4302c6025ca5b0247aac5bdca259999e58954f6f8e3fcf32e0ed998848138a75c2ec665f6398b1e57f0e0355d51d030ee591321077457c55873ff60
+  data.tar.gz: 63f212c7d2ef904b0bd82cac15a374a3c1f3f478c93dbf4ca6f157c0e2ad242da029011a353dba103788b826a29b1185938e3559fc441b37f1b71b8932e86659

data/.rubocop.yml

@@ -1,3 +1,7 @@
+inherit_from:
+  - https://potpourri.hausgold.de/config/rubocop.yml
+  - https://potpourri.hausgold.de/config/rubocop-gem.yml
+
 plugins:
   - rubocop-rspec
   - rubocop-rails
@@ -5,9 +9,6 @@ plugins:
 Rails:
   Enabled: true
 
-Style/Documentation:
-  Enabled: true
-
 AllCops:
   NewCops: enable
   SuggestExtensions: false
@@ -21,43 +22,12 @@ AllCops:
     - gemfiles/**/*
     - spec/dummy/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - Rakefile
-    - '*.gemspec'
-    - spec/**/*.rb
-    - '**/*.rake'
-    - doc/**/*.rb
-
-# MFA is not yet enabled for our gems yet.
-Gemspec/RequireMFA:
-  Enabled: false
-
-# We stay with the original Ruby Style Guide recommendation.
-Layout/LineLength:
-  Max: 80
-
-# Document all the things.
-Style/DocumentationMethod:
-  Enabled: true
-  RequireForNonPublicMethods: true
-
 # It's a deliberate idiom in RSpec.
 # See: https://github.com/bbatsov/rubocop/issues/4222
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*"
 
-# Because +expect_any_instance_of().to have_received()+ is not
-# supported with the +with(hash_including)+ matchers
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Because nesting makes sense here to group the feature tests
-# more effective. This increases maintainability.
-RSpec/NestedGroups:
-  Max: 4
-
 # Disable regular Rails spec paths.
 Rails/FilePath:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 2.2.0 (19 December 2025)
+
+* Migrated to a shared Rubocop configuration for HAUSGOLD gems ([#37](https://github.com/hausgold/factory_bot_instrumentation/pull/37))
+
 ### 2.1.0 (23 October 2025)
 
 * Added support for Rails 8.1 ([#35](https://github.com/hausgold/factory_bot_instrumentation/pull/35))

data/Envfile

@@ -1,3 +1,4 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
+RUBOCOP_CACHE_ROOT=/app/tmp

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 HAUSGOLD | talocasa GmbH
+Copyright (c) 2025 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -73,8 +73,8 @@ application is working as expected. Whoop. A failure happens on the frontend
 and a lot of tests fail due to the root cause that an entity was not
 deleted/recreated.
 
-A better solution whould be a dynamic seed generation per test case. So an
-entity may be deleted in an isolated manner, due to a random seed. Thats even
+A better solution would be a dynamic seed generation per test case. So an
+entity may be deleted in an isolated manner, due to a random seed. That's even
 better than looking for a statically seeded entity on a list for example,
 because you can now just focus on the single entry which was dynamically
 generated for your insolated test case.
@@ -82,7 +82,7 @@ generated for your insolated test case.
 Another use case for dynamic seeds are explorative testers. They could benefit
 from the entities your factories are already generating. But on canary, or
 production like environments they are not able to access an Rails console to
-trigger the factory_bot factories. Thats where `factory_bot_instrumentation`
+trigger the factory_bot factories. That's where `factory_bot_instrumentation`
 comes in.
 
 ## Usage
@@ -144,7 +144,7 @@ let(:user_with_many_friends) { create :user, :with_friends, friends_amount: 5 }
 
 With the Instrumentation engine you allow external users to trigger your
 factories the same way via an API (HTTP request) or with preconfigured
-scenarios via an easy to use frontend. Thats it.
+scenarios via an easy to use frontend. That's it.
 
 ### Configuration
 
@@ -186,7 +186,7 @@ default: &default
       overwrite: {}
 
     - name: User with a single friend named Bob
-      desc: Create a new user with a single friend whoes name is Bob.
+      desc: Create a new user with a single friend whose name is Bob.
       factory: :user
       traits:
         - :confirmed
@@ -346,7 +346,7 @@ end
 ### API
 
 The Instrumentation engine comes with a single API endpoint which allows you to
-trigger your factory_bot factories with traits and overwrites. Thats just as
+trigger your factory_bot factories with traits and overwrites. That's just as
 simple as it sounds.
 
 The endpoint is at the same path as you mounted the engine. Say you mounted the
@@ -580,7 +580,7 @@ here:
 
 ##### postCreateError
 
-In case you want to perform some magic after an error occured, you can use
+In case you want to perform some magic after an error occurred, you can use
 the `postCreateError` hook. You can access the output options and the
 runtime payload with all its data, but changes to them won't take effect
 because this hook is triggered after the error is rendered. The `payload`
@@ -673,7 +673,7 @@ An example block could look like this:
     {
       cb(null, `
         <div class="alert alert-danger" role="alert">
-          An unexpected error occured.
+          An unexpected error occurred.
         </div>
         <pre id="data">${output}</pre>
         ${window.utils.clipboardButton('data')}
@@ -725,7 +725,7 @@ custom functionality like blocks or complete custom Instrumentation pages. Just
 create `app/views/factory_bot_instrumentation/_styles.html.erb` inside your
 application. The file could look like this:
 
-```hmtl
+```html
 <link rel="stylesheet"
       href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/dark.min.css"
       integrity="sha256-GVo4WKmO61/tVmRyEKLvRm2Nnq7mdFCaOim/9HbNpaM="

data/app/assets/javascripts/factory_bot_instrumentation/create.js

@@ -12,8 +12,8 @@ window.CreateForm = CreateForm = function()
   {
     window.utils.waterfallWithHooks({
       data: {
-        alert: `An unexpected error occured. Looks like something went wrong
-                while generating your new entity. This migth be a bug, or an
+        alert: `An unexpected error occurred. Looks like something went wrong
+                while generating your new entity. This might be a bug, or an
                 unexpected feature. It could be a temporary issue. When this
                 is persistent contact your friendly API Instrumentation
                 administrator.`,

data/app/assets/javascripts/factory_bot_instrumentation/hooks.js

@@ -106,7 +106,7 @@ window.hooks = {
   //   }
   preCreateError: [],
 
-  // In case you want to perform some magic after an error occured, you can use
+  // In case you want to perform some magic after an error occurred, you can use
   // the +postCreateError+ hook. You can access the output options and the
   // runtime payload with all its data, but changes to them won't take effect
   // because this hook is triggered after the error is rendered. The +payload+

data/app/controllers/factory_bot/instrumentation/application_controller.rb

@@ -42,7 +42,7 @@ module FactoryBot
       end
 
       # Unfortunately +Rails.configuration.instrumentation+ is only read once
-      # and do not hot-reload on changes. Thats why we read this file manually
+      # and do not hot-reload on changes. That's why we read this file manually
       # to get always a fresh state.
       #
       # @return [Hash{String => Mixed}] the instrumentation scenarios
@@ -66,7 +66,7 @@ module FactoryBot
         end
       end
 
-      # Map all the configured scenario groups to a useable hash.
+      # Map all the configured scenario groups to a usable hash.
       #
       # @return [Hash{Regexp => String}] the group mapping
       def groups

data/app/controllers/factory_bot/instrumentation/root_controller.rb

@@ -51,9 +51,6 @@ module FactoryBot
       # a valid FactoryBot options set.
       #
       # @return [Array<Mixed>] the FactoryBot options
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the Rails version
-      #   handling
       def factory_params
         data = params.permit(:factory, traits: [])
 
@@ -70,7 +67,6 @@ module FactoryBot
           { **overwrite }
         ]
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/config/instrumentation.yml

@@ -27,7 +27,7 @@ default: &default
       overwrite: {}
 
     - name: User with a single friend named Bob
-      desc: Create a new user with a single friend whoes name is Bob.
+      desc: Create a new user with a single friend whose name is Bob.
       factory: :user
       traits:
         - :confirmed

data/lib/factory_bot/instrumentation/version.rb

@@ -4,7 +4,7 @@ module FactoryBot
   # The gem version details.
   module Instrumentation
     # The version of the +factory_bot_instrumentation+ gem
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
 
     class << self
       # Returns the version of gem as a string.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_instrumentation
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Hermann Mayer