factory_bot_instrumentation 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d643a4b86dc1bca8a7df314258f1fee44afa9caa0f20efd84dc5694e549249da
-  data.tar.gz: 12ad4d38793d3ecc33b5588070940a852ddd22ed1ae1a51a67773141f24fb14d
+  metadata.gz: 64c8bfd7239e2b0011f69809680abfd6066fa6f41fc274527fa552555f20608a
+  data.tar.gz: a833f35d400e028b82623f72e4248101f977afb811c4a8f0ec0224f5a916f38b
 SHA512:
-  metadata.gz: ea18bccad8065d7b71dc50058e7ba73d970e935d8fc14bb30f2b4126e31685b64938e023d75cbab28a809414dc7d1628a1b6e0396490584c7d9f5c344b582723
-  data.tar.gz: 26df3f123614f34d35197c305ddcda4f83a8cfb9855ced96b2917ae3a95b8f724e8fee041f48b1c57ad5082158fba05e2160edbb34f82237f8846c7e6c5b37b7
+  metadata.gz: 65a6f1c073c7c81e573584fade3c389a9195e5c0e8a74439d958859596cbb7d3d89754061f5ea6b9d3fc9d3857ca89d867b45fb94db90415804a7a69cb1d2aaf
+  data.tar.gz: 9b14f2f5d3a05f9a9523cae760e88338c3ec2823b5090b462705c86b3a0cbef71fe00ed14f9cf8a086477d392e6a27259309dd1b1813c9517deed8f11d8912d7

data/CHANGELOG.md

@@ -2,9 +2,20 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.5.1 (9 January 2025)
+
+* Sometimes the classic Rails autoloader is confused our engines
+  `RootController` does not inherit our engines `ApplicationController`, but
+  the one from host application, so we specify our dependency explicitly (#26)
+
+### 1.5.0 (7 January 2025)
+
+* Switched from `ActionController::API` to `ActionController::Base` for the
+  engine's `ApplicationController` (#25)
+
 ### 1.4.1 (6 January 2025)
 
-* Reverted (#23) as it causes errors for unknown reasons
+* Reverted (#23) as it causes errors for unknown reasons (#24)
 
 ### 1.4.0 (6 January 2025)
 

data/README.md

@@ -243,7 +243,8 @@ application. The file
 this:
 
 ```ruby
-class Instrumentation::AuthenticationsController < ActionController::API
+class Instrumentation::AuthenticationsController \
+      < FactoryBot::Instrumentation::ApplicationController
   # Generate a new web app authentication URL for the given email address.
   # This endpoint creates new login URLs which are valid for 30 minutes.
   def create
@@ -271,9 +272,20 @@ routes like this:
 
 ```ruby
 Rails.application.routes.draw do
-  unless Rails.env.production?
+  if ActiveModel::Type::Boolean.new.cast(ENV.fetch('INSTRUMENTATION_API',
+                                                   false))
     mount FactoryBot::Instrumentation::Engine => '/instrumentation'
   end
+
+  # or with custom controllers in an namespace
+
+  if ActiveModel::Type::Boolean.new.cast(ENV.fetch('INSTRUMENTATION_API',
+                                                   false))
+    namespace :instrumentation do
+      mount FactoryBot::Instrumentation::Engine => '/'
+      resource :authentication, only: :create
+    end
+  end
 end
 ```
 

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

@@ -3,12 +3,18 @@
 module FactoryBot
   module Instrumentation
     # A base engine application controller.
-    class ApplicationController < ActionController::API
+    class ApplicationController < ActionController::Base
       # Extend our core functionality to support easy authentication logics
       include ActionController::HttpAuthentication::Basic::ControllerMethods
       include ActionController::HttpAuthentication::Digest::ControllerMethods
       include ActionController::HttpAuthentication::Token::ControllerMethods
 
+      # Rails 5.2 enabled CSRF protection by default, but this may be different
+      # on the host application. Therefore we cannot blindly disable it via
+      # +skip_forgery_protection+. We have to "enable" it for no routes, which
+      # eventually disables it entirely for this engine.
+      protect_from_forgery only: []
+
       # Allow the users to implement additional instrumentation-wide before
       # action logic, like authentication
       before_action do |_controller|
@@ -19,8 +25,6 @@ module FactoryBot
         end
       end
 
-      protected
-
       # A simple shortcut for Basic Auth on Rails 4.2+. Just configure the
       # username and password and you're ready to check the current request.
       #
@@ -36,6 +40,53 @@ module FactoryBot
             )
         end
       end
+
+      # Unfortunately +Rails.configuration.instrumentation+ is only read once
+      # and do not hot-reload on changes. Thats why we read this file manually
+      # to get always a fresh state.
+      #
+      # @return [Hash{String => Mixed}] the instrumentation scenarios
+      def instrumentation
+        config_file = FactoryBot::Instrumentation.configuration.config_file.to_s
+        template = ERB.new(Pathname.new(config_file).read)
+        load_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
+        YAML.send(load_method, template.result(binding))[Rails.env] || {}
+      end
+
+      # Map all the instrumentation scenarios into groups and pass them back.
+      #
+      # @return [Hash{String => Array}] the grouped scenarios
+      def scenarios
+        res = instrumentation['scenarios'] || []
+        res.each_with_object({}) do |scenario, memo|
+          group = scenario_group(scenario['name'])
+          scenario['group'] = group
+          memo[group] = [] unless memo.key? group
+          memo[group] << scenario
+        end
+      end
+
+      # Map all the configured scenario groups to a useable hash.
+      #
+      # @return [Hash{Regexp => String}] the group mapping
+      def groups
+        (instrumentation['groups'] || {}).transform_keys do |key|
+          Regexp.new(Regexp.quote(key))
+        end
+      end
+
+      # Fetch the group name for a given scenario name. This will utilize the
+      # +SCENARIO_GROUPS+ map.
+      #
+      # @param name [String] the scenario name
+      # @return [String] the group name
+      def scenario_group(name)
+        groups.map do |pattern, group_name|
+          next unless pattern.match? name
+
+          group_name
+        end.compact.first || 'Various'
+      end
     end
   end
 end

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

@@ -3,13 +3,7 @@
 module FactoryBot
   module Instrumentation
     # The Instrumentation engine controller with frontend and API actions.
-    class RootController < ApplicationController
-      # This is required to make API controllers template renderable
-      include ActionView::Layouts
-
-      # Configure the default application layout
-      layout 'factory_bot/instrumentation/application'
-
+    class RootController < FactoryBot::Instrumentation::ApplicationController
       # Show the instrumentation frontend which features the output of
       # configured dynamic seeds scenarios. The frontend allows humans to
       # generate new seed data on the fly.
@@ -53,8 +47,6 @@ module FactoryBot
         FactoryBot::Instrumentation.configuration.render_error.call(self, e)
       end
 
-      protected
-
       # Parse the given parameters from the request and build
       # a valid FactoryBot options set.
       #
@@ -79,53 +71,6 @@ module FactoryBot
         ]
       end
       # rubocop:enable Metrics/MethodLength
-
-      # Unfortunately +Rails.configuration.instrumentation+ is only read once
-      # and do not hot-reload on changes. Thats why we read this file manually
-      # to get always a fresh state.
-      #
-      # @return [Hash{String => Mixed}] the instrumentation scenarios
-      def instrumentation
-        config_file = FactoryBot::Instrumentation.configuration.config_file.to_s
-        template = ERB.new(Pathname.new(config_file).read)
-        load_method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
-        YAML.send(load_method, template.result(binding))[Rails.env] || {}
-      end
-
-      # Map all the instrumentation scenarios into groups and pass them back.
-      #
-      # @return [Hash{String => Array}] the grouped scenarios
-      def scenarios
-        res = instrumentation['scenarios'] || []
-        res.each_with_object({}) do |scenario, memo|
-          group = scenario_group(scenario['name'])
-          scenario['group'] = group
-          memo[group] = [] unless memo.key? group
-          memo[group] << scenario
-        end
-      end
-
-      # Map all the configured scenario groups to a useable hash.
-      #
-      # @return [Hash{Regexp => String}] the group mapping
-      def groups
-        (instrumentation['groups'] || {}).transform_keys do |key|
-          Regexp.new(Regexp.quote(key))
-        end
-      end
-
-      # Fetch the group name for a given scenario name. This will utilize the
-      # +SCENARIO_GROUPS+ map.
-      #
-      # @param name [String] the scenario name
-      # @return [String] the group name
-      def scenario_group(name)
-        groups.map do |pattern, group_name|
-          next unless pattern.match? name
-
-          group_name
-        end.compact.first || 'Various'
-      end
     end
   end
 end

data/lib/factory_bot/instrumentation/engine.rb

@@ -5,6 +5,7 @@ module FactoryBot
     # The Instrumentation engine which can be mounted.
     class Engine < ::Rails::Engine
       isolate_namespace FactoryBot::Instrumentation
+      engine_name 'factory_bot_instrumentation'
 
       # Fill in some dynamic settings (application related)
       initializer 'factory_bot_instrumentation.config' do |app|

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 = '1.4.1'
+    VERSION = '1.5.1'
 
     class << self
       # Returns the version of gem as a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_instrumentation
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot