factory_bot_rails 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b742728304ad03cf96bd0894d77fc2e692bedd7577dab1c7758a0e7cc49fc6e
-  data.tar.gz: fa05b3990a3a3d0a819e3afc79bcc7eb218a3b54a4aa071f9e23b3018b349ffd
+  metadata.gz: 5742c3086e009bf4ba09d13c5f912e547b06b71552747f9c2a8c8da26680025c
+  data.tar.gz: d789dd365195a302bd7888d2d927b34b797280f06614fa0e73d22b7d3f446755
 SHA512:
-  metadata.gz: b99d122d606f1ff76388d3d617d600f78870c4cace484b26ddf69782ee4db752c75b168e2920d00d9b077123fbdabeb82984dbf241aa2fc18555d32f313d9e85
-  data.tar.gz: afb2e89740609a4f49765a937f54b8c47f4d569ce8d89f9c6ee2490d76ded24b69b07de95a5924c6afe41a9890d2905d1bc0ce96bd79d1a5a20bb17cd7243adf
+  metadata.gz: '09f24e068c621baa9d6e2721abdaa54df0f4eeb88b3b258f394cdd7a6f1366bb66e8d0d7cf3ab000f86c7e1d93e0e3f333f1ac16158f9f789a5b80e7893549b9'
+  data.tar.gz: 6d5c4d46d035618cfb995db650b27cabc9f67439a0eabaf974e805dd9a989eb80d04082eebad64bf1a7575151a8062f91bea0f5d0b30123771da035198745177

data/CONTRIBUTING.md

@@ -35,5 +35,5 @@ Some things that will increase the chance that your pull request is accepted:
 * Follow our [style guide][style].
 * Write a [good commit message][commit].
 
-[style]: https://github.com/thoughtbot/guides/tree/master/style
+[style]: https://github.com/thoughtbot/guides/tree/main/general
 [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/NEWS.md

@@ -3,6 +3,25 @@ there might not be any notable changes in new versions of this project.
 
 # NEWS
 
+## 6.3.0 (November 17, 2023)
+
+* Changed: reject sequence definitions for ActiveRecord primary keys (Sean
+  Doyle).
+* Changed: factory\_bot dependency to ~> 6.4 (Mike Burns).
+* Changed: upgrade dependencies (Daniel Colson).
+* Add: `projections.json` for Rails.vim (Caleb Hearth).
+* Docs: fix broken link (Edu Depetris).
+* Docs: mention Rails generator in docs (Edu Depetris).
+* Docs: fix typo (Yudai Takada).
+* Internal: skip Spring version 2.1.1 due to a bug in that release (Christina
+  Entcheva, Daniel Colson).
+* Internal: test against Rails 6.1 (Antonis Berkakis).
+* Internal: test against Ruby 3 (Daniel Colson).
+* Internal: fewer warnings in Cucumber tests (Daniel Colson).
+* Internal: use GitHub Actions for CI (Mathieu Jobin).
+* Internal: a whole bunch of cleanup (Daniel Colson).
+* Internal: fix CI due to a Bundler output change (Mike Burns).
+
 ## 6.2.0 (May 7, 2021)
 
 * Changed: factory\_bot dependency to ~> 6.2.0

data/README.md

@@ -1,4 +1,4 @@
-# factory_bot_rails [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
+# factory_bot_rails [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version]
 
 [factory_bot][fb] is a fixtures replacement with a straightforward definition
 syntax, support for multiple build strategies (saved instances, unsaved
@@ -15,7 +15,7 @@ Check out the [guide](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stabl
 factory\_bot\_rails provides Rails integration for [factory_bot][fb].
 
 Supported Rails versions are listed in [`Appraisals`](Appraisals). Supported
-Ruby versions are listed in [`.travis.yml`](.travis.yml).
+Ruby versions are listed in [`.github/workflows/build.yml`](.github/workflows/build.yml).
 
 ## Download
 
@@ -144,8 +144,30 @@ Note that factory\_bot\_rails will only use this custom template if you are
 generating each factory in a separate file; it will have no effect if you are
 generating all of your factories in `test/factories.rb` or `spec/factories.rb`.
 
+Factory\_bot\_rails will add a custom generator:
+
+```shell
+rails generate factory_bot:model NAME [field:type field:type] [options]
+```
+
 [default factory template]: https://github.com/thoughtbot/factory_bot_rails/tree/master/lib/generators/factory_bot/model/templates/factories.erb
 
+### Active Record Configuration
+
+By default, FactoryBot will refuse to generate Active Record primary key
+columns. Without additional configuration, an Active Record model treats a
+column named `id` as its primary key.
+
+For example, defining an `id` attribute with `add_attribute(:id)`, `id { ... }`,
+or `sequence(:id)` will raise a `FactoryBot::AttributeDefinitionError`.
+
+You can disable this behavior by adding the following to `config/application.rb`
+or the appropriate environment configuration in `config/environments`:
+
+```ruby
+config.factory_bot.reject_primary_key_attributes = false
+```
+
 ## Contributing
 
 Please see [CONTRIBUTING.md](CONTRIBUTING.md).
@@ -171,8 +193,6 @@ See [our other projects][community].
 We are [available for hire][hire].
 
 [fb]: https://github.com/thoughtbot/factory_bot
-[ci]: http://travis-ci.org/thoughtbot/factory_bot_rails?branch=master
-[ci-image]: https://secure.travis-ci.org/thoughtbot/factory_bot_rails.svg
 [grade]: https://codeclimate.com/github/thoughtbot/factory_bot_rails
 [grade-image]: https://codeclimate.com/github/thoughtbot/factory_bot_rails.svg
 [community]: https://thoughtbot.com/community?utm_source=github

data/lib/factory_bot_rails/factory_validator/active_record_validator.rb

@@ -0,0 +1,18 @@
+module FactoryBotRails
+  class FactoryValidator
+    class ActiveRecordValidator
+      def validate!(payload)
+        attributes, for_class = payload.values_at(:attributes, :class)
+        attributes.each do |attribute|
+          if for_class < ActiveRecord::Base && for_class.primary_key == attribute.name.to_s
+            raise FactoryBot::AttributeDefinitionError, <<~ERROR
+              Attribute generates #{for_class.primary_key.inspect} primary key for #{for_class.name}"
+
+              Do not define #{for_class.primary_key.inspect}. Instead, rely on the database to generate it.
+            ERROR
+          end
+        end
+      end
+    end
+  end
+end

data/lib/factory_bot_rails/factory_validator.rb

@@ -0,0 +1,39 @@
+module FactoryBotRails
+  class FactoryValidator
+    def initialize(validators = [])
+      @validators = Array(validators)
+    end
+
+    def add_validator(validator)
+      @validators << validator
+    end
+
+    def run
+      ActiveSupport::Notifications.subscribe("factory_bot.compile_factory", &validate_compiled_factory)
+    end
+
+    private
+
+    def validate_compiled_factory
+      if Rails.version >= "6.0"
+        rails_6_0_support
+      else
+        rails_5_2_support
+      end
+    end
+
+    def rails_6_0_support
+      proc do |event|
+        @validators.each { |validator| validator.validate!(event.payload) }
+      end
+    end
+
+    def rails_5_2_support
+      proc do |*notification_event_arguments|
+        event = ActiveSupport::Notifications::Event.new(*notification_event_arguments)
+
+        rails_6_0_support.call(event)
+      end
+    end
+  end
+end

data/lib/factory_bot_rails/generators/null_generator.rb

@@ -1,7 +1,7 @@
 module FactoryBotRails
   module Generators
     class NullGenerator
-      def initialize(generators)
+      def initialize(*)
       end
 
       def run

data/lib/factory_bot_rails/railtie.rb

@@ -3,12 +3,15 @@
 require "factory_bot"
 require "factory_bot_rails/generator"
 require "factory_bot_rails/reloader"
+require "factory_bot_rails/factory_validator"
 require "rails"
 
 module FactoryBotRails
   class Railtie < Rails::Railtie
     config.factory_bot = ActiveSupport::OrderedOptions.new
     config.factory_bot.definition_file_paths = FactoryBot.definition_file_paths
+    config.factory_bot.reject_primary_key_attributes = true
+    config.factory_bot.validator = FactoryBotRails::FactoryValidator.new
 
     initializer "factory_bot.set_fixture_replacement" do
       Generator.new(config).run
@@ -18,9 +21,20 @@ module FactoryBotRails
       FactoryBot.definition_file_paths = definition_file_paths
     end
 
+    ActiveSupport.on_load :active_record do
+      config = Rails.configuration.factory_bot
+
+      if config.reject_primary_key_attributes
+        require "factory_bot_rails/factory_validator/active_record_validator"
+
+        config.validator.add_validator FactoryValidator::ActiveRecordValidator.new
+      end
+    end
+
     config.after_initialize do |app|
       FactoryBot.find_definitions
       Reloader.new(app).run
+      app.config.factory_bot.validator.run
     end
 
     private

data/lib/generators/factory_bot.rb

@@ -2,7 +2,7 @@ require "rails/generators/named_base"
 
 module FactoryBot
   module Generators
-    class Base < Rails::Generators::NamedBase #:nodoc:
+    class Base < Rails::Generators::NamedBase # :nodoc:
       def self.source_root
         path = File.join(
           File.dirname(__FILE__),

data/lib/rails/projections.json

@@ -0,0 +1,26 @@
+{
+  "spec/factories/*.rb": {
+    "alternate": "app/models/{singular}.rb",
+    "collection": "model",
+    "command": "factory",
+    "template": [
+      "FactoryBot.define do",
+      "  factory :{singular} do",
+      "  end",
+      "end"
+    ],
+    "test": "spec/models/{singular}_spec.rb"
+  },
+  "test/factories/*.rb": {
+    "alternate": "app/models/{singular}.rb",
+    "collection": "model",
+    "command": "factory",
+    "template": [
+      "FactoryBot.define do",
+      "  factory :{singular} do",
+      "  end",
+      "end"
+    ],
+    "test": "test/models/{singular}_test.rb"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_rails
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Joe Ferris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.2.0
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.2.0
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 description: factory_bot_rails provides integration between factory_bot and rails
   5.0 or newer
 email: jferris@thoughtbot.com
@@ -51,6 +79,8 @@ files:
 - README.md
 - lib/factory_bot_rails.rb
 - lib/factory_bot_rails/definition_file_paths.rb
+- lib/factory_bot_rails/factory_validator.rb
+- lib/factory_bot_rails/factory_validator/active_record_validator.rb
 - lib/factory_bot_rails/generator.rb
 - lib/factory_bot_rails/generators/non_rspec_generator.rb
 - lib/factory_bot_rails/generators/null_generator.rb
@@ -60,6 +90,7 @@ files:
 - lib/generators/factory_bot.rb
 - lib/generators/factory_bot/model/model_generator.rb
 - lib/generators/factory_bot/model/templates/factories.erb
+- lib/rails/projections.json
 homepage: https://github.com/thoughtbot/factory_bot_rails
 licenses:
 - MIT
@@ -79,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: factory_bot_rails provides integration between factory_bot and rails 5.0