factory_bot_instrumentation 1.2.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdf74679c8560415d27425a05ee0b58d44b39c17fb355bd0477c9e170625802b
-  data.tar.gz: 2e50ab307e1b9294f72b4d954650e52594e81e538d251a365bd0beb6592c6c72
+  metadata.gz: 37442055c37286bda9ecc80137609a66e4170181350f1fe494e0140cf888a33c
+  data.tar.gz: eb684ed40aad5659818346b43b22510c981fac3283ce81239ff943b3148aa72b
 SHA512:
-  metadata.gz: 0334b6fffbdc4280e5edab1754ab0523fbdfc8cb9d436891e33a0f7b62a03420686d268b23841835f76cba5e63a618a85b70945ae3091c5c73eeb2623e157c68
-  data.tar.gz: fec368b1ab9d87b531d4316b8154b101595d5c6b40673753eec3228f3f91f49a0a42d9f77b0e28621bd028a428ddc3a61262ac528f090f4fc1aba89ac0258cde
+  metadata.gz: c24c700505db37bd0960ccf4d4f941c9117c2b0885b15fbabe871ee7b63bd5d87b259e77a94e751784f9c51edb4d08c04f22ea6338ca4d0cf913475245d6f165
+  data.tar.gz: 20461fb181cd6e48fd3c7a32d5cfbc1f0647fb5a85095564c4cdeff3951a23b8a6047d6b60a532588f763222bb8475bac5ee8f0e27dd06d9fa6a20e40f3a07d4

data/.github/workflows/test.yml

@@ -18,8 +18,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7']
-        rails: ['5.2', '6.1', '7.1']
+        ruby: ['2.7', '3.0']
+        rails: ['6.1', '7.1']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:

data/.rubocop.yml

@@ -13,7 +13,7 @@ AllCops:
   SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 2.7
-  TargetRailsVersion: 5.2
+  TargetRailsVersion: 6.1
   Exclude:
     - bin/**/*
     - vendor/**/*

data/.yardopts

@@ -4,3 +4,4 @@
 -
 README.md
 doc/examples/**/*.rb
+doc/*.md

data/Appraisals

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'rails-5.2' do
-  gem 'rails', '~> 5.2.0'
-end
-
 appraise 'rails-6.1' do
   gem 'rails', '~> 6.1.0'
 end

data/CHANGELOG.md

@@ -2,65 +2,75 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
-### 1.2.4
+### 1.4.0 (6 January 2025)
+
+* Moved the instrumentation methods (`#instrumentation`, `#scenarios`,
+  `#groups`, `#scenario_group`) from the `RootController` to the
+  `ApplicationController` (#23)
+
+### 1.3.0 (3 January 2025)
+
+* Raised minimum supported Ruby/Rails version to 2.7/6.1 (#22)
+
+### 1.2.4 (15 August 2024)
 
 * Just a retag of 1.2.1
 
-### 1.2.3
+### 1.2.3 (15 August 2024)
 
 * Just a retag of 1.2.1
 
-### 1.2.2
+### 1.2.2 (9 August 2024)
 
 * Just a retag of 1.2.1
 
-### 1.2.1
+### 1.2.1 (9 August 2024)
 
 * Added API docs building to continuous integration (#21)
 
-### 1.2.0
+### 1.2.0 (8 July 2024)
 
 * Dropped support for Ruby <2.7 (#20)
 
-### 1.1.5
+### 1.1.5 (18 February 2024)
 
 * Added fallbacks for configuration processing (#19)
 
-### 1.1.4
+### 1.1.4 (5 January 2024)
 
 * Pinned factory_bot down to < 6.4.5 in order to support Ruby 2.5 (#18)
 * Added handling to support Psych 4 and 5 (#18)
 
-### 1.1.3
+### 1.1.3 (18 December 2023)
 
 * Corrected the fallback view path configuration (#17)
 
-### 1.1.2
+### 1.1.2 (18 December 2023)
 
 * Moved the development dependencies from the gemspec to the Gemfile (#15)
 * Added a fallback view path handling in case an Rails application cannot
   find our engine templates correctly (#16)
 
-### 1.1.1
+### 1.1.1 (24 February 2023)
 
 * Removed double bundler/gem_tasks handling
 
-### 1.1.0
+### 1.1.0 (24 February 2023)
 
 * Added support for Gem release automation
 
-### 1.0.2
+### 1.0.2 (15 February 2023)
 
 * When used in combination with the `factory_bot_rails` gem (>= 6.0) we do not
   force a `FactoryBot.reload` at Rails engine initialization as it breaks with
   an `FactoryBot::DuplicateDefinitionError` (#14)
 
-### 1.0.1
+### 1.0.1 (15 February 2023)
 
 * Added a retry logic to the FactoryBot reloading on the POST/create endpoint
   in order to handle parallel requests properly (#13)
 
-### 1.0.0
+### 1.0.0 (18 January 2023)
 
 * Bundler >= 2.3 is from now on required as minimal version (#12)
 * Dropped support for Ruby < 2.5 (#12)
@@ -68,49 +78,49 @@
 * Updated all development/runtime gems to their latest
   Ruby 2.5 compatible version (#12)
 
-### 0.8.0
+### 0.8.0 (10 December 2021)
 
 * Added `FactoryBot.reload` to the initializer code to ensure the factories
   are in place.
 
-### 0.7.1
+### 0.7.1 (15 October 2021)
 
 * Migrated to Github Actions
 * Migrated to our own coverage reporting
 
-### 0.7.0
+### 0.7.0 (15 October 2021)
 
 * Dropped Rails 4 support
 
-### 0.6.0
+### 0.6.0 (21 September 2020)
 
 * Added support for custom error handling and improved the default error
   handling on FactoryBot usage (#9)
 
-### 0.5.1
+### 0.5.1 (12 May 2020)
 
 * Corrected a bug on the scenario description update (#8)
 
-### 0.5.0
+### 0.5.0 (20 January 2020)
 
 * Added support for custom before action logics (#7)
 
-### 0.4.0
+### 0.4.0 (9 December 2019)
 
 * Added support for configurable rendering (#6)
 
-### 0.3.0
+### 0.3.0 (15 July 2019)
 
 * Removed CI support for Ruby 2.3 (it never worked before)
 * Fixed the overwrite params bug on Rails 4.2
 * Added a test suite for the engine
 
-### 0.2.0
+### 0.2.0 (22 March 2019)
 
 * Removed the Gemfile locks and added the to the ignore list
 * Dropped Rails 3 support
 * Added support for Bundler 1 and 2
 
-### 0.1.0
+### 0.1.0 (9 January 2019)
 
 * Added the initial code base

data/Gemfile

@@ -13,7 +13,7 @@ gem 'bundler', '~> 2.3'
 gem 'countless', '~> 1.1'
 gem 'factory_bot_rails', '~> 6.2'
 gem 'guard-rspec', '~> 4.7'
-gem 'railties', '>= 5.2'
+gem 'railties', '>= 6.1'
 gem 'rspec-rails', '~> 5.1'
 gem 'rubocop', '~> 1.28'
 gem 'rubocop-rails', '~> 2.14'

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

@@ -36,6 +36,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

@@ -79,53 +79,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/factory_bot_instrumentation.gemspec

@@ -33,9 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
 
-  # TODO: Remove the upper lock when
-  #       https://github.com/thoughtbot/factory_bot/issues/1614 is solved.
-  spec.add_runtime_dependency 'factory_bot', '~> 6.2', '< 6.4.5'
-  spec.add_runtime_dependency 'rails', '>= 5.2'
-  spec.add_runtime_dependency 'retries', '>= 0.0.5'
+  spec.add_dependency 'factory_bot', '~> 6.2'
+  spec.add_dependency 'rails', '>= 6.1'
+  spec.add_dependency 'retries', '>= 0.0.5'
 end

data/gemfiles/rails_6.1.gemfile

@@ -7,7 +7,7 @@ gem "bundler", "~> 2.3"
 gem "countless", "~> 1.1"
 gem "factory_bot_rails", "~> 6.2"
 gem "guard-rspec", "~> 4.7"
-gem "railties", ">= 5.2"
+gem "railties", ">= 6.1"
 gem "rspec-rails", "~> 5.1"
 gem "rubocop", "~> 1.28"
 gem "rubocop-rails", "~> 2.14"

data/gemfiles/rails_7.1.gemfile

@@ -7,7 +7,7 @@ gem "bundler", "~> 2.3"
 gem "countless", "~> 1.1"
 gem "factory_bot_rails", "~> 6.2"
 gem "guard-rspec", "~> 4.7"
-gem "railties", ">= 5.2"
+gem "railties", ">= 6.1"
 gem "rspec-rails", "~> 5.1"
 gem "rubocop", "~> 1.28"
 gem "rubocop-rails", "~> 2.14"

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.2.4'
+    VERSION = '1.4.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.2.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,23 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.4.5
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: retries
   requirement: !ruby/object:Gem::Requirement
@@ -116,7 +110,6 @@ files:
 - doc/assets/regular.png
 - docker-compose.yml
 - factory_bot_instrumentation.gemspec
-- gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.1.gemfile
 - lib/factory_bot/instrumentation/configuration.rb

data/gemfiles/rails_5.2.gemfile

@@ -1,22 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal", "~> 2.4"
-gem "bundler", "~> 2.3"
-gem "countless", "~> 1.1"
-gem "factory_bot_rails", "~> 6.2"
-gem "guard-rspec", "~> 4.7"
-gem "railties", ">= 5.2"
-gem "rspec-rails", "~> 5.1"
-gem "rubocop", "~> 1.28"
-gem "rubocop-rails", "~> 2.14"
-gem "rubocop-rspec", "~> 2.10"
-gem "simplecov", ">= 0.22"
-gem "sqlite3", "~> 1.5"
-gem "timecop", ">= 0.9.6"
-gem "yard", ">= 0.9.28"
-gem "yard-activesupport-concern", ">= 0.0.1"
-gem "rails", "~> 5.2.0"
-
-gemspec path: "../"