factory_bot_instrumentation 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37442055c37286bda9ecc80137609a66e4170181350f1fe494e0140cf888a33c
-  data.tar.gz: eb684ed40aad5659818346b43b22510c981fac3283ce81239ff943b3148aa72b
+  metadata.gz: 83e360c563829d80a36e5bc4210a6a3da30233958a03d6c121a0158b445cb502
+  data.tar.gz: ee121882322897358b90092c0c88e8d0d70e416bc5a44188c78e34386aaa07ea
 SHA512:
-  metadata.gz: c24c700505db37bd0960ccf4d4f941c9117c2b0885b15fbabe871ee7b63bd5d87b259e77a94e751784f9c51edb4d08c04f22ea6338ca4d0cf913475245d6f165
-  data.tar.gz: 20461fb181cd6e48fd3c7a32d5cfbc1f0647fb5a85095564c4cdeff3951a23b8a6047d6b60a532588f763222bb8475bac5ee8f0e27dd06d9fa6a20e40f3a07d4
+  metadata.gz: 4a6f7e41ffe69853ef92f6708f8540b571917b78086084f52d0c8790e3aa1222661c3bbd0dc8b70867a506a8e3d412610ebb8b364130bcfc82022052b8304cc7
+  data.tar.gz: 01d84146f7db621d49a04ea6542e4a6bf570676a4c5405560a4aeb56b0b92f457d72163a480b0b2c583f756adfe36ce739bb3de35875b6ed9de7229693411a5e

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 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 (#24)
+
 ### 1.4.0 (6 January 2025)
 
 * Moved the instrumentation methods (`#instrumentation`, `#scenarios`,

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.
       #

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

@@ -4,12 +4,6 @@ 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'
-
       # 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.
       #

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.0'
+    VERSION = '1.5.0'
 
     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.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot