factory_bot_instrumentation 2.9.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 816705309be49f08f806e7c42795df561d37e3a4923d87456425f7c1d92984b4
-  data.tar.gz: f78e531c94adfeeda2e97f6aeb7f47e22930cf9b38c12fc71052c2680f24aee1
+  metadata.gz: 3a38fbf7fbe98fed861a4fc524a10e5798e8e1abc918c742272365b11c476e81
+  data.tar.gz: a9b886fd2f52d856c264b34d8b2d4297df8ea12d1bb6bf1f84b1bbb6480b54ce
 SHA512:
-  metadata.gz: 8ffec26066e0396cf9d61936e324c7103dd1353e684eb0ef073f9f3178e22f94ba9c6077f298b47140c007e9e8992e79550cc89903a7bc4c73ff6275e9bf19da
-  data.tar.gz: ffbb12feb2054cd33e2ff0fe48e2a4bbb58abc3d8ef4ba66f5c3568897977fec578efc5e5ba484300d8d27ce812f5c20c3b2a2fa4fa959fdec4cba5e8670f884
+  metadata.gz: 0bbbb1aaad25753d40cd97dfdd968c9935cfc9d6aded00ceb39aded62067707ebde83364a6b688700bf2cef4c3b43778a3c67c6f54940224a2d6be237aec48bb
+  data.tar.gz: 412673861a682f7506c9b56e2be255f56ac66eb604596348de122e29e6aacd6cc54dcbbc6f51ec3eee1dd4c35b30dc2494f96e6b995678245c0d8ac54b275ec1

data/.gitignore

@@ -11,6 +11,7 @@
 /gemfiles/vendor/
 /Gemfile.lock
 *.gemfile.lock
+/.claude
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -39,3 +39,7 @@ Rails/FilePath:
 # Because we just implemented the ActiveRecord API.
 Rails/SkipsModelValidations:
   Enabled: false
+
+# Because we don't have a Rails environment here.
+Rails/RakeEnvironment:
+  Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 3.0.0 (13 May 2026)
+
+* Added automatic asset registering with Sprockets ([#46](https://github.com/hausgold/factory_bot_instrumentation/pull/46))
+
+So you can remove the following lines from your `app/assets/config/manifest.js`:
+
+```js
+//= link factory_bot_instrumentation/application.css
+//= link factory_bot_instrumentation/application.js
+```
+
+* Added automatic asset bundling to support Propshaft ([#46](https://github.com/hausgold/factory_bot_instrumentation/pull/46))
+
 ### 2.9.0 (4 May 2026)
 
 * Dropped Ruby 3.x and Rails <8.1 support ([#45](https://github.com/hausgold/factory_bot_instrumentation/pull/45))

data/Makefile

@@ -28,6 +28,7 @@ HEAD ?= head
 ID ?= id
 MKDIR ?= mkdir
 RM ?= rm
+SED ?= sed
 SORT ?= sort
 TEST ?= test
 XARGS ?= xargs
@@ -174,6 +175,11 @@ stats:
 	# Print all the notes from the code
 	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
 
-release:
+build:
+	# Build and prepare the gem for releasing
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) bundle_assets)
+	@$(SED) -i '/spec.extensions/d' factory_bot_instrumentation.gemspec
+
+release: build
 	# Release a new gem version
 	@$(BUNDLE) exec $(RAKE) release

data/Rakefile

@@ -11,6 +11,17 @@ require 'countless/rake_tasks'
 APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
+desc 'Bundle the engine JavaScript and CSS sources into application.{js,css}'
+task :bundle_assets do
+  require 'factory_bot/instrumentation/asset_bundler'
+  FactoryBot::Instrumentation::AssetBundler.bundle_all!.each do |kind, files|
+    conf = FactoryBot::Instrumentation::AssetBundler.config(kind)
+    rel = files.map { |f| f.sub("#{conf[:source_dir]}/", '') }
+    puts "Bundled #{files.size} #{kind.upcase} source(s) into " \
+         "#{conf[:output_name]}: #{rel.join(', ')}"
+  end
+end
+
 desc 'Run all specs in spec directory (excluding plugin specs)'
 RSpec::Core::RakeTask.new(spec: [
                             'db:drop', 'db:create', 'db:migrate', 'db:setup'
@@ -18,6 +29,14 @@ RSpec::Core::RakeTask.new(spec: [
 
 task default: :spec
 
+# Neuter Bundler's `release:guard_clean` check. The `make build` step prunes
+# the unbundled JS/CSS sources from `app/assets/**/factory_bot_instrumentation/`
+# after bundling them into `application.{js,css}`, which leaves the working
+# tree dirty by design. The commit + tag are already in place before release,
+# so the clean-tree guard would only block pushing the artefact we just built.
+Rake::Task['release:guard_clean'].clear
+task 'release:guard_clean'
+
 # Configure all code statistics directories
 Countless.configure do |config|
   config.stats_base_directories = [

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

@@ -1,16 +1,458 @@
-// This is a manifest file that'll be compiled into application.js, which will
-// include all the files listed below.
+// !!! AUTO-GENERATED FILE - DO NOT EDIT !!!
 //
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts,
-// vendor/assets/javascripts, or any plugin's vendor/assets/javascripts
-// directory can be referenced here using a relative path.
+// This file bundles every JS source under
+// +app/assets/javascripts/factory_bot_instrumentation/+ into a single asset. It is regenerated:
+//   * on `gem install` / `bundle install` (via a RubyGems extension
+//     hook), and
+//   * during gem release (via the `bundle_assets` Rake task).
 //
-// It's not advisable to add code directly here, but if you do, it'll appear at
-// the bottom of the compiled file. JavaScript code in this file should be
-// added after the last require_* statement.
+// To rebuild it manually, run:
 //
-// Read Sprockets README
-// (https://github.com/rails/sprockets#sprockets-directives) for details about
-// supported directives.
+//   $ bundle exec rake bundle_assets
+
+// >>> create.js
+window.CreateForm = CreateForm = function()
+{
+  this.scope = '#generate';
+  this.form = new Form(this.scope);
+  this.scenarios = window.scenarios;
+  this.select = $(`${this.scope} .scenario`);
+  this.desc = $(`${this.scope} .description`);
+
+  let self = this;
+
+  this.form.errorContent = function(payload, output, cb)
+  {
+    window.utils.waterfallWithHooks({
+      data: {
+        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.`,
+        output: output,
+        payload: payload,
+        pre: '',
+        post: ''
+      },
+      pre: window.hooks.preCreateError,
+      post: window.hooks.postCreateError,
+      action: (payload, innerCb) => {
+        cb(null, `
+          ${payload.pre}
+          <div class="alert alert-danger" role="alert">${payload.alert}</div>
+          <pre id="data">${payload.output}</pre>
+          ${window.utils.clipboardButton()}
+          ${payload.post}
+        `);
+        innerCb(null, payload);
+      }
+    });
+  };
+
+  this.form.resultContent = function(payload, output, cb)
+  {
+    let card = window.utils.card({
+      body: `
+        <pre id="data">${output}</pre>
+        ${window.utils.clipboardButton()}
+      `
+    });
+
+    window.utils.waterfallWithHooks({
+      data: {
+        alert: `A new ${self.scenario().name.toLowerCase()} was created.`,
+        output: output,
+        payload: payload,
+        cards: [card],
+        pre: '',
+        post: '',
+        openCard: '#details'
+      },
+      pre: window.hooks.preCreateResult,
+      post: window.hooks.postCreateResult,
+      action: (payload, innerCb) => {
+        cb(null, `
+          ${payload.pre}
+          <div class="alert alert-success" role="alert">${payload.alert}</div>
+          <div class="accordion" id="response">
+            ${payload.cards.join(' ')}
+          </div>
+          ${payload.post}
+        `);
+        innerCb(null, payload);
+        if (payload.openCard) {
+          $(
+            `.accordion#response button[data-target="${payload.openCard}"]`
+          ).click();
+        }
+      }
+    });
+  };
+};
+
+CreateForm.prototype.updateDesc = function()
+{
+  this.desc.html(this.scenario().desc);
+};
+
+CreateForm.prototype.activeScenario = function()
+{
+  raw = this.select.find(':selected').val().split('/');
+  return { group: raw[0], index: raw[1] };
+};
+
+CreateForm.prototype.scenario = function()
+{
+  scenario = this.activeScenario();
+  return this.scenarios[scenario.group][scenario.index];
+};
+
+CreateForm.prototype.bind = function()
+{
+  this.form.bind((event) => {
+    this.submit();
+  });
+
+  this.select.on('change', this.updateDesc.bind(this));
+  this.updateDesc();
+};
+
+CreateForm.prototype.submit = function()
+{
+  let form = this.form;
+  let conf = this.scenario();
+
+  window.utils.waterfallWithHooks({
+    data: {
+      factory: conf.factory,
+      traits: conf.traits,
+      overwrite: conf.overwrite
+    },
+    pre: window.hooks.preCreate,
+    post: window.hooks.postCreate,
+    action: (payload, cb) => {
+      window.utils.request({
+        url: window.createUrl,
+        data: JSON.stringify(payload)
+      }, (err, result) => {
+        if (err) { return cb && cb(err); }
+        cb(null, { request: payload, response: result });
+      });
+    }
+  }, function(err, result) {
+    if (err) { return form.showError(err, err.responseText); }
+    form.showResult(result, result.response);
+  });
+};
+
+// >>> hooks.js
+// You can define some custom hooks to enhance the functionality. With the help
+// of the following hooks you are able to customize the outputs, perform
+// additional HTTP requests or anything you like.
 //
-//= require_tree .
+// All the hooks are designed to passthrough a payload. They receive this
+// payload as the first argument, and a callback function to signal the end of
+// the hook. You MUST pass the payload as second parameter to the callback, or
+// pass an error object as first argument. You can modify the payload as you
+// wish, eg. adding some data from subsequent requests.
+//
+// Example hooks:
+//
+//   // Error case
+//   window.hooks.postCreate.push((payload, cb) => {
+//     cb({ error: true});
+//   });
+//
+//   // Happy case
+//   window.hooks.postCreate.push((payload, cb) => {
+//     cb(null, Object.assign(payload, { additional: { data: true } }));
+//   });
+//
+// Mind the fact that you can define multiple custom functions per hook type.
+// They are executed after each other in a waterfall like flow. The order of
+// the hooks array is therefore essential.
+window.hooks = {
+  // With the help of the +perCreate+ hooks you can manipulate the create
+  // request parameters. Think of an additional handling which reads an
+  // overwrite form or a kind of trait checkboxes to customize the factory
+  // call. The +payload+ looks like this:
+  //
+  //   {
+  //     factory: 'user',
+  //     traits: ['confirmed'],
+  //     overwrite: { password: 'secret' }
+  //   }
+  preCreate: [],
+
+  // The +postCreate+ hook allows you to perform subsequent requests to fetch
+  // additional data. Think of a user instrumentation where you want to request
+  // a one time token for this user. This token can be added to the payload and
+  // can be shown with the help of the +preCreateResult+ hook. The payload
+  // contains the request parameters and the response body from the
+  // instrumentation request. Here comes an example +payload+:
+  //
+  //   {
+  //     request: { factory: 'user', /* [..] */ },
+  //     response: { /* [..] */ }
+  //   }
+  postCreate: [],
+
+  // With the help of the +preCreateResult+ hook you can customize the output
+  // of the result. You could also perform some subsequent requests or some UI
+  // preparations. You can access the output options and the runtime payload
+  // with all its data and make modifications to them. This hook is triggered
+  // before the result is rendered. A sample payload comes here:
+  //
+  //   {
+  //     alert: 'Your alert text.',
+  //     output: 'Formatted response',
+  //     payload: { request: { /* [..] */ }, response: { /* [..] */ } },
+  //     cards: [
+  //       `The details accordion card,
+  //        you can add more, remove the details card
+  //        or reorder them`
+  //     ],
+  //     openCard: '#details', // Open a custom card, or none
+  //     pre: 'Additinal HTML content before the alert.',
+  //     post: 'Additinal HTML content after the formatted response output.'
+  //   }
+  preCreateResult: [],
+
+  // In case you want to perform some logic after the result is rendered, you
+  // can use the +postCreateResult+ hook. You can access the output options and
+  // the runtime payload with all its data, but changes to them won't take
+  // effect. The +payload+ looks like this:
+  //
+  //   {
+  //     alert: 'Your alert text.',
+  //     output: 'Formatted response',
+  //     payload: { request: { /* [..] */ }, response: { /* [..] */ } },
+  //     cards: [
+  //       `The details accordion card,
+  //        you can add more, remove the details card
+  //        or reorder them`
+  //     ],
+  //     openCard: '#details', // Open a custom card, or none
+  //     pre: 'Additinal HTML content before the alert.',
+  //     post: 'Additinal HTML content after the formatted response output.'
+  //   }
+  postCreateResult: [],
+
+  // With the help of the +preCreateError+ hook you can customize the output of
+  // the error. Furthermore you can perform some subsequent requests or
+  // whatever comes to your mind. You can access the output options and the
+  // runtime payload with all its data and make modifications to them. This
+  // hook is triggered before the error is rendered. A sample payload comes
+  // here:
+  //
+  //   {
+  //     alert: 'Your alert text.',
+  //     output: 'Formatted response',
+  //     payload: { request: { /* [..] */ }, response: { /* [..] */ } },
+  //     pre: 'Additinal HTML content before the alert.',
+  //     post: 'Additinal HTML content after the formatted response output.'
+  //   }
+  preCreateError: [],
+
+  // 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+
+  // looks like this:
+  //
+  //   {
+  //     alert: 'Your alert text.',
+  //     output: 'Formatted response',
+  //     payload: { request: { /* [..] */ }, response: { /* [..] */ } },
+  //     pre: 'Additinal HTML content before the alert.',
+  //     post: 'Additinal HTML content after the formatted response output.'
+  //   }
+  postCreateError: []
+};
+
+// >>> lib/form.js
+window.Form = Form = function(scope)
+{
+  this.button = $(scope).find('button');
+  this.result = $('#result');
+  this.spinner = $('#spinner');
+};
+
+Form.prototype.bind = function(action)
+{
+  this.button.on('click', (event) => {
+    event.preventDefault();
+    this.hideResult();
+    action(event);
+    return false;
+  });
+};
+
+Form.prototype.hideResult = function()
+{
+  this.result.hide();
+  this.button.prop('disabled', true);
+  this.spinner.show();
+};
+
+Form.prototype.showResultContainer = function(html)
+{
+  this.result.html(html);
+  $('pre').each((i, block) => hljs.highlightBlock(block));
+  new ClipboardJS('.cb-copy');
+  this.result.show();
+  this.button.prop('disabled', false);
+};
+
+Form.prototype.showError = function(payload, output)
+{
+  this.spinner.hide();
+  output = window.utils.prepareOutput(output);
+  this.errorContent(payload, output, (err, html) => {
+    this.showResultContainer(html);
+  });
+};
+
+Form.prototype.errorContent = function(payload, output, cb)
+{
+  cb(null, `
+    <pre id="data">${output}</pre>
+    ${window.utils.clipboardButton()}
+  `);
+};
+
+Form.prototype.showResult = function(payload, output)
+{
+  this.spinner.hide();
+  output = window.utils.prepareOutput(output);
+  this.resultContent(payload, output, (err, html) => {
+    this.showResultContainer(html);
+  });
+};
+
+Form.prototype.resultContent = function(payload, output, cb)
+{
+  cb(null, `
+    <pre id="data">${output}</pre>
+    ${window.utils.clipboardButton()}
+  `);
+};
+
+// >>> lib/utils.js
+window.utils = Utils = {};
+
+Utils.pushWaterfallPayload = function(data)
+{
+  return (cb) => cb(null, data);
+};
+
+Utils.waterfallWithHooks = function(opts, cb)
+{
+  cb = cb || function(){};
+  opts = Object.assign({
+    pre: [],
+    post: [],
+    data: {},
+    action: (payload, cb) => cb(null, payload)
+  }, opts);
+
+  async.waterfall([
+    // Yield the data to pre hooks
+    Utils.pushWaterfallPayload(opts.data),
+    // Perform pre hooks
+    ...opts.pre,
+    // Perform the create request
+    opts.action,
+    // Perform post hooks
+    ...opts.post
+  ], cb);
+};
+
+Utils.request = function(opts, cb)
+{
+  opts = Object.assign({
+    url: '/',
+    type: 'POST',
+    data: '{}',
+    dataType: 'json',
+    contentType: 'application/json; charset=utf-8',
+    ignoreErrors: false
+  }, opts || {}, {
+    success: (result) => cb(null, result)
+  });
+
+  errCb = (err) => cb(err);
+  if (opts.ignoreErrors) {
+    errCb = (err) => cb(null, err);
+  }
+
+  $.ajax(opts).fail(errCb);
+};
+
+Utils.escape = function(str)
+{
+  return str.replace(/&/g, "&amp;")
+            .replace(/</g, "&lt;")
+            .replace(/>/g, "&gt;");
+};
+
+Utils.prepareOutput = function(output)
+{
+  try {
+    if (typeof output !== 'object') { output = JSON.parse(output); }
+    output = JSON.stringify(output, null, 2);
+  } catch { }
+
+  return window.utils.escape(output);
+};
+
+Utils.clipboardButton = function(id)
+{
+  id = id || 'data';
+  return `
+    <span class="btn btn-primary cb-copy"
+      data-clipboard-target="#${id}">
+      <i class="fas fa-paste"></i> Copy result to clipboard
+    </span>
+  `;
+};
+
+Utils.clipboardBadge = function(id)
+{
+  id = id || 'data';
+  return `
+    <span class="badge badge-dark cb-copy" title="Copy result to clipboard"
+          data-clipboard-target="#${id}"><i class="fas fa-paste"></i>
+    </span>
+  `;
+};
+
+Utils.card = function(opts)
+{
+  opts = Object.assign({
+    id: 'details',
+    icon: 'fa-asterisk',
+    title: 'Details',
+    body: ''
+  }, opts || {});
+
+  return `
+    <div class="card">
+      <div class="card-header">
+        <h5 class="mb-0">
+          <button class="btn btn-link collapsed" type="button"
+            data-toggle="collapse" data-target="#${opts.id}"
+            aria-expanded="false">
+            <i class="fas ${opts.icon}"></i> ${opts.title}</h5>
+          </button>
+        </h5>
+      </div>
+      <div id="${opts.id}" class="collapse" data-parent="#response">
+        <div class="card-body">
+          ${opts.body}
+        </div>
+      </div>
+    </div>
+  `;
+};

data/app/assets/stylesheets/factory_bot_instrumentation/application.css

@@ -1,42 +1,18 @@
 /*
- * This is a manifest file that'll be compiled into application.css, which will
- * include all the files listed below.
+ * !!! AUTO-GENERATED FILE - DO NOT EDIT !!!
  *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets,
- * vendor/assets/stylesheets, or any plugin's vendor/assets/stylesheets
- * directory can be referenced here using a relative path.
+ * This file bundles every CSS source under
+ * +app/assets/stylesheets/factory_bot_instrumentation/+ into a single asset. It is regenerated:
+ *   * on `gem install` / `bundle install` (via a RubyGems extension
+ *     hook), and
+ *   * during gem release (via the `bundle_assets` Rake task).
  *
- * You're free to add application-wide styles to this file and they'll appear
- * at the bottom of the compiled file so the styles you add here take
- * precedence over styles defined in any other CSS/SCSS files in this
- * directory. Styles in this file should be added after the last require_*
- * statement.  It is generally better to create a new file per style scope.
+ * To rebuild it manually, run:
  *
- *= require_tree .
- *= require_self
+ *   $ bundle exec rake bundle_assets
  */
 
-.row { margin-top: 5em }
-.result-container { background-color: #f8f8f8 }
-.hljs { background-color: #fff; }
-.jumbotron { padding: 1rem }
-.jumbotron .row { margin-top: 0 }
-.badge { cursor: pointer }
-.btn-link:hover, .btn-link:active, .btn-link:focus { text-decoration: none }
-
-pre {
-  margin-bottom: 0;
-  white-space: pre-wrap;
-  white-space: -moz-pre-wrap;
-  white-space: -pre-wrap;
-  white-space: -o-pre-wrap;
-  word-wrap: break-word;
-}
-
-pre + .btn {
-  margin-top: 1rem;
-}
-
+/* >>> spinner.css */
 .spinner {
   margin: 100px auto;
   width: 50px;
@@ -89,3 +65,25 @@ pre + .btn {
     -webkit-transform: scaleY(1.0);
   }
 }
+
+/* >>> utils.css */
+.row { margin-top: 5em }
+.result-container { background-color: #f8f8f8 }
+.hljs { background-color: #fff; }
+.jumbotron { padding: 1rem }
+.jumbotron .row { margin-top: 0 }
+.badge { cursor: pointer }
+.btn-link:hover, .btn-link:active, .btn-link:focus { text-decoration: none }
+
+pre {
+  margin-bottom: 0;
+  white-space: pre-wrap;
+  white-space: -moz-pre-wrap;
+  white-space: -pre-wrap;
+  white-space: -o-pre-wrap;
+  word-wrap: break-word;
+}
+
+pre + .btn {
+  margin-top: 1rem;
+}

data/factory_bot_instrumentation.gemspec

@@ -24,13 +24,20 @@ Gem::Specification.new do |spec|
   }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    next false if f.match?(/application\.(js|css)/)
+
+    f.match(%r{^(test|spec|features|ext)/}) || f.match(/\.(js|css)$/)
   end
 
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  # Regenerate the bundled JavaScript asset whenever the gem is
+  # installed. This is the standard RubyGems / Bundler hook and fires
+  # for plain +gem install+ as well as for Git-source +bundle install+
+  # in third-party applications.
+
   spec.required_ruby_version = '>= 4.0'
 
   spec.add_dependency 'factory_bot', '~> 6.2'