rom-factory 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 946c06da46cc1d12ac8e90fc8b79661ce43e9ed2ab2ba0e3ffd93f5c1ac7e419
-  data.tar.gz: fa2c475a578ba75f7574ed5d883a4432fc4f2328849fc4be74813b854a0c6dba
+  metadata.gz: 76c2c2d443aae25366e10dc9cfb41bc23a9e69abd38597b144214a9b4f861b51
+  data.tar.gz: 3aea3e8cf8568962e72c0d8ebda1da5b9ca38b6bcbf6469a9c2ea3f67377a314
 SHA512:
-  metadata.gz: b1dea330b287e3b56c2acaea898c9139317b0de709098c0c7525d05215db34571dfa41447337ca39b39f7d1d5ace98fde9f442854a725870fa6496c24d00eee3
-  data.tar.gz: 6279eb190440aeb10dc03c26fe18cfcc67f846e8d0981b7822746172f564936f5d2fd7cbf41a68336be1865516afda03947302804db8d6a1e05040198137beb9
+  metadata.gz: 1a463af2b73eca8c24d2a276c678a72e7d7883ed030b241bdc71c58998ce2ce0742f039e30744a0baa12d81cfcab111602f2b960e0db5abf786b3c0f9afe3c03
+  data.tar.gz: b60e2dfd2d87136bd3f10a84df790fa2f664babdd9d972682986545ceefabf7353f7811ef6f2f51028f611012e3b9f632cf485fcdf63c0d490ef543b9b59cf8d

data/CHANGELOG.md

@@ -1,7 +1,53 @@
-<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+# Changelog
 
-## 0.13.0 2025-01-21
+All notable changes to this project will be documented in this file.
 
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Break Versioning](https://www.taoensso.com/break-versioning).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+[Unreleased]: https://github.com/rom-rb/rom-factory/compare/v0.14.0...main
+
+## [0.14.0] - 2026-10-03
+
+### Added
+
+- Support transient attributes. (@rickenharp in #97)
+
+  Define transient attributes inside a `transient` block. Other attributes can depend on them, but they are not part of the resulting tuple or struct. You can override them when building, like any other attribute.
+
+  ```ruby
+  Factory.define(:user) do |f|
+    f.transient do |t|
+      t.password "secret"
+    end
+    f.password_hash { |password| BCrypt::Password.create(password) }
+  end
+
+  Factory[:user, password: "something else"]
+  ```
+
+### Changed
+
+- Minimum Ruby version is now 3.3. (@alassek)
+- Add `tsort` as an explicit runtime dependency. (@flash-gordon)
+
+[0.13.0]: https://github.com/rom-rb/rom-factory/compare/v0.13.0...v0.14.0
+
+## [0.13.0] - 2025-01-21
 
 ### Added
 
@@ -23,15 +69,18 @@ Factory.define :category do |f|
 end
 ```
 
+- Aliases for factory methods (via #92) (@cflipse)
+
+`Factory.create` is aliased to `Factory.[]`
+`Factory.build` is aliased to `Factory.structs[]`
 
 ### Changed
 
 - Minimum Ruby version is now 3.1 (@flash-gordon)
 
-[Compare v0.12.0...v0.13.0](https://github.com/rom-rb/rom-factory/compare/v0.12.0...v0.13.0)
-
-## 0.12.0 2024-01-19
+[0.13.0]: https://github.com/rom-rb/rom-factory/compare/v0.12.0...v0.13.0
 
+## [0.12.0] - 2024-01-19
 
 ### Added
 
@@ -43,11 +92,9 @@ end
 - Relations without PKs should work too (via #87) (@solnic)
 - Relations with PK values generated on the Ruby side should work in SQlite too (via #87) (@solnic)
 
+[0.12.0]: https://github.com/rom-rb/rom-factory/compare/v0.11.0...v0.12.0
 
-[Compare v0.11.0...v0.12.0](https://github.com/rom-rb/rom-factory/compare/v0.11.0...v0.12.0)
-
-## 0.11.0 2022-11-11
-
+## [0.11.0] - 2022-11-11
 
 ### Added
 
@@ -80,20 +127,17 @@ Factory[:user, **user_attributes]
 - Upgraded to the latest versions of dry-rb dependencies, compatible with rom 5.3 (@flash-gordon)
 - Support for Faker 1.x was dropped (@alassek)
 
-[Compare v0.10.2...v0.11.0](https://github.com/rom-rb/rom-factory/compare/v0.10.2...v0.11.0)
-
-## 0.10.2 2020-04-05
+[0.11.0]: https://github.com/rom-rb/rom-factory/compare/v0.10.2...v0.11.0
 
+## [0.10.2] - 2020-04-05
 
 ### Fixed
 
 - Fix more keyword warnings (@flash-gordon)
 
+[0.10.2]: https://github.com/rom-rb/rom-factory/compare/v0.10.1...v0.10.2
 
-[Compare v0.10.1...v0.10.2](https://github.com/rom-rb/rom-factory/compare/v0.10.1...v0.10.2)
-
-## 0.10.1 2019-12-28
-
+## [0.10.1] - 2019-12-28
 
 ### Added
 
@@ -103,11 +147,9 @@ Factory[:user, **user_attributes]
 
 - Keyword warnings reported by Ruby 2.7 (@flash-gordon)
 
+[0.10.1]: https://github.com/rom-rb/rom-factory/compare/v0.10.0...v0.10.1
 
-[Compare v0.10.0...v0.10.1](https://github.com/rom-rb/rom-factory/compare/v0.10.0...v0.10.1)
-
-## 0.10.0 2019-12-11
-
+## [0.10.0] - 2019-12-11
 
 ### Added
 
@@ -124,41 +166,33 @@ Factory[:user, **user_attributes]
 - Support building structs when child assoc does not define parent (@psparrow)
 - Fixed `TupleEvaluator#struct_attrs` for non-standard output schema (@AMHOL)
 
+[0.10.0]: https://github.com/rom-rb/rom-factory/compare/v0.9.1...v0.10.0
 
-[Compare v0.9.1...v0.10.0](https://github.com/rom-rb/rom-factory/compare/v0.9.1...v0.10.0)
-
-## 0.9.1 2019-10-23
-
+## [0.9.1] - 2019-10-23
 
 ### Fixed
 
 - Attributes of a struct are no longer accidentally passed to their associations (@psparrow)
 
+[0.9.1]: https://github.com/rom-rb/rom-factory/compare/v0.9.0...v0.9.1
 
-[Compare v0.9.0...v0.9.1](https://github.com/rom-rb/rom-factory/compare/v0.9.0...v0.9.1)
-
-## 0.9.0 2019-08-12
-
+## [0.9.0] - 2019-08-12
 
 ### Added
 
 - When attributes hash includes unknown attributes, a `ROM::Factory::UnknownAttributeError` will be raised (@rawburt)
 
+[0.9.0]: https://github.com/rom-rb/rom-factory/compare/v0.8.0...v0.9.0
 
-[Compare v0.8.0...v0.9.0](https://github.com/rom-rb/rom-factory/compare/v0.8.0...v0.9.0)
-
-## 0.8.0 2019-04-24
-
+## [0.8.0] - 2019-04-24
 
 ### Fixed
 
 - Loaded association structs are no longer rejected by output schemas (issue #34) (flash-gordon + solnic)
 
+[0.8.0]: https://github.com/rom-rb/rom-factory/compare/v0.7.0...v0.8.0
 
-[Compare v0.7.0...v0.8.0](https://github.com/rom-rb/rom-factory/compare/v0.7.0...v0.8.0)
-
-## 0.7.0 2018-11-17
-
+## [0.7.0] - 2018-11-17
 
 ### Added
 
@@ -169,11 +203,9 @@ Factory[:user, **user_attributes]
 
 - Overwritten attributes with dependencies (JanaVPetrova)
 
+[0.7.0]: https://github.com/rom-rb/rom-factory/compare/v0.6.0...v0.7.0
 
-[Compare v0.6.0...v0.7.0](https://github.com/rom-rb/rom-factory/compare/v0.6.0...v0.7.0)
-
-## 0.6.0 2018-01-31
-
+## [0.6.0] - 2018-01-31
 
 ### Added
 
@@ -187,10 +219,9 @@ Factory[:user, **user_attributes]
 
 - Accessing a factory which is not defined will result in `FactoryNotDefinedError` exception (GustavoCaso + solnic)
 
-[Compare v0.5.0...v0.6.0](https://github.com/rom-rb/rom-factory/compare/v0.5.0...v0.6.0)
-
-## 0.5.0 2017-10-24
+[0.6.0]: https://github.com/rom-rb/rom-factory/compare/v0.5.0...v0.6.0
 
+## [0.5.0] - 2017-10-24
 
 ### Added
 
@@ -203,9 +234,9 @@ Factory[:user, **user_attributes]
 
 - Depends on `rom-core` now (solnic)
 
-[Compare v0.4.0...v0.5.0](https://github.com/rom-rb/rom-factory/compare/v0.4.0...v0.5.0)
+[0.5.0]: https://github.com/rom-rb/rom-factory/compare/v0.4.0...v0.5.0
 
-## 0.4.0 2017-03-03
+## [0.4.0] - 2017-03-03
 
 improves internals.
 
@@ -224,3 +255,5 @@ improves internals.
 - `Rom::Factory::Config.configure` was replaced with `ROM::Factory.configure` (solnic)
 - Global factory config and builders are gone (solnic)
 - Structs are now based on dry-struct (solnic)
+
+[0.4.0]: https://github.com/rom-rb/rom-factory/tree/v0.4.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 rom-rb team
+Copyright (c) 2015-2026 Hanakai team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,29 +1,22 @@
-[gem]: https://rubygems.org/gems/rom-factory
-[actions]: https://github.com/rom-rb/rom-factory/actions
-[codacy]: https://www.codacy.com/gh/rom-rb/rom-factory
-[chat]: https://rom-rb.zulipchat.com
-[inchpages]: http://inch-ci.org/github/rom-rb/rom-factory
+<!--- This file is synced from hanakai-rb/repo-sync -->
 
-# rom-factory [![Join the chat at https://rom-rb.zulipchat.com](https://img.shields.io/badge/rom--rb-join%20chat-%23346b7a.svg)][chat]
+[actions]: https://github.com/hanakai-rb/rom-factory/actions
+[chat]: https://discord.gg/naQApPAsZB
+[forum]: https://discourse.hanakai.org
+[rubygem]: https://rubygems.org/gems/rom-factory
 
-[![Gem Version](https://badge.fury.io/rb/rom-factory.svg)][gem]
-[![CI Status](https://github.com/rom-rb/rom-factory/workflows/ci/badge.svg)][actions]
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5fd26fae687549218458879b1a607e18)][codacy]
-[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/5fd26fae687549218458879b1a607e18)][codacy]
-[![Inline docs](http://inch-ci.org/github/rom-rb/rom-factory.svg?branch=master)][inchpages]
+# ROM Factory [![Gem Version](https://badge.fury.io/rb/rom-factory.svg)][rubygem] [![CI Status](https://github.com/hanakai-rb/rom-factory/workflows/CI/badge.svg)][actions]
 
-## Links
-
-* [User documentation](https://rom-rb.org/learn/factory)
-* [API documentation](https://rubydoc.info/gems/rom-factory)
+[![Forum](https://img.shields.io/badge/Forum-dc360f?logo=discourse&logoColor=white)][forum]
+[![Chat](https://img.shields.io/badge/Chat-717cf8?logo=discord&logoColor=white)][chat]
 
-## Supported Ruby versions
+## Links
 
-This library officially supports the following Ruby versions:
+- [User documentation](https://hanakai.org/learn/rom/factories)
+- [API documentation](http://rubydoc.info/gems/rom-factory)
 
-* MRI >= `3.1`
-* jruby >= `9.4` (not tested in CI)
 
 ## License
 
 See `LICENSE` file.
+

data/lib/rom/factory/attributes/association.rb

@@ -1,205 +1,213 @@
 # frozen_string_literal: true
 
-module ROM::Factory
-  module Attributes
-    # @api private
-    # rubocop:disable Style/OptionalArguments
-    module Association
-      class << self
-        def new(assoc, ...)
-          const_get(assoc.definition.type).new(assoc, ...)
-        end
-      end
-
+module ROM
+  module Factory
+    module Attributes
       # @api private
-      class Core
-        attr_reader :assoc, :options, :traits
-
-        # @api private
-        def initialize(assoc, builder, *traits, **options)
-          @assoc = assoc
-          @builder_proc = builder
-          @traits = traits
-          @options = options
+      # rubocop:disable Style/OptionalArguments
+      module Association
+        class << self
+          def new(assoc, ...)
+            const_get(assoc.definition.type).new(assoc, ...)
+          end
         end
 
         # @api private
-        def through? = false
+        class Core
+          attr_reader :assoc, :options, :traits
 
-        # @api private
-        def builder
-          @__builder__ ||= @builder_proc.call
-        end
+          def transient
+            false
+          end
 
-        # @api private
-        def name = assoc.key
+          # @api private
+          def initialize(assoc, builder, *traits, **options)
+            @assoc = assoc
+            @builder_proc = builder
+            @traits = traits
+            @options = options
+          end
 
-        # @api private
-        def dependency?(*) = false
+          # @api private
+          def through? = false
 
-        # @api private
-        def value? = false
+          # @api private
+          def builder
+            @__builder__ ||= @builder_proc.call
+          end
 
-        # @api private
-        def factories = builder.factories
+          # @api private
+          def name = assoc.key
 
-        # @api private
-        def foreign_key = assoc.foreign_key
+          # @api private
+          def dependency?(*) = false
 
-        # @api private
-        def count = options.fetch(:count, 1)
-      end
+          # @api private
+          def value? = false
 
-      # @api private
-      class ManyToOne < Core
-        # @api private
-        # rubocop:disable Metrics/AbcSize
-        def call(attrs, persist: true)
-          return if attrs.key?(name) && attrs[name].nil?
-
-          assoc_data = attrs.fetch(name, EMPTY_HASH)
-
-          if assoc_data.is_a?(::Hash) && assoc_data[assoc.target.primary_key] && !attrs[foreign_key]
-            assoc.associate(attrs, attrs[name])
-          elsif assoc_data.is_a?(::ROM::Struct)
-            assoc.associate(attrs, assoc_data)
-          else
-            parent =
-              if persist && !attrs[foreign_key]
-                builder.persistable.create(*parent_traits, **assoc_data)
-              else
-                builder.struct(
-                  *parent_traits,
-                  **assoc_data, assoc.target.primary_key => attrs[foreign_key]
-                )
-              end
+          # @api private
+          def factories = builder.factories
 
-            tuple = {name => parent}
+          # @api private
+          def foreign_key = assoc.foreign_key
 
-            assoc.associate(tuple, parent)
-          end
+          # @api private
+          def count = options.fetch(:count, 1)
         end
-        # rubocop:enable Metrics/AbcSize
-
-        private
 
-        def parent_traits
-          @parent_traits ||=
-            if assoc.target.associations.key?(assoc.source.name)
-              traits + [assoc.target.associations[assoc.source.name].key => false]
+        # @api private
+        class ManyToOne < Core
+          # @api private
+          # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+          def call(attrs, persist: true)
+            return if attrs.key?(name) && attrs[name].nil?
+
+            assoc_data = attrs.fetch(name, EMPTY_HASH)
+
+            if assoc_data.is_a?(::Hash) && assoc_data[assoc.target.primary_key] && !attrs[foreign_key]
+              assoc.associate(attrs, attrs[name])
+            elsif assoc_data.is_a?(::ROM::Struct)
+              assoc.associate(attrs, assoc_data)
             else
-              traits
+              parent =
+                if persist && !attrs[foreign_key]
+                  builder.persistable.create(*parent_traits, **assoc_data)
+                else
+                  builder.struct(
+                    *parent_traits,
+                    **assoc_data, assoc.target.primary_key => attrs[foreign_key]
+                  )
+                end
+
+              tuple = {name => parent}
+
+              assoc.associate(tuple, parent)
             end
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
+
+          private
+
+          def parent_traits
+            @parent_traits ||=
+              if assoc.target.associations.key?(assoc.source.name)
+                traits + [{assoc.target.associations[assoc.source.name].key => false}]
+              else
+                traits
+              end
+          end
         end
-      end
 
-      # @api private
-      class OneToMany < Core
         # @api private
-        def call(attrs = EMPTY_HASH, parent, persist: true)
-          return if attrs.key?(name)
+        class OneToMany < Core
+          # @api private
+          def call(attrs = EMPTY_HASH, parent, persist: true)
+            return if attrs.key?(name)
 
-          structs = ::Array.new(count).map do
-            # hash which contains the foreign key info, i.e: { user_id: 1 }
-            association_hash = assoc.associate(attrs, parent)
+            structs = ::Array.new(count).map do
+              # hash which contains the foreign key info, i.e: { user_id: 1 }
+              association_hash = assoc.associate(attrs, parent)
 
-            if persist
-              builder.persistable.create(*traits, **association_hash)
-            else
-              builder.struct(*traits, **attrs, **association_hash)
+              if persist
+                builder.persistable.create(*traits, **association_hash)
+              else
+                builder.struct(*traits, **attrs, **association_hash)
+              end
             end
+
+            {name => structs}
           end
 
-          {name => structs}
+          # @api private
+          def dependency?(rel) = assoc.source == rel
         end
 
         # @api private
-        def dependency?(rel) = assoc.source == rel
-      end
-
-      # @api private
-      class OneToOne < OneToMany
-        # @api private
-        def call(attrs = EMPTY_HASH, parent, persist: true)
-          # do not associate if count is 0
-          return {name => nil} if count.zero?
+        class OneToOne < OneToMany
+          # @api private
+          def call(attrs = EMPTY_HASH, parent, persist: true)
+            # do not associate if count is 0
+            return {name => nil} if count.zero?
 
-          return if attrs.key?(name)
+            return if attrs.key?(name)
 
-          association_hash = assoc.associate(attrs, parent)
+            association_hash = assoc.associate(attrs, parent)
 
-          struct =
-            if persist
-              builder.persistable.create(*traits, **association_hash)
-            else
-              belongs_to_name = ::ROM::Inflector.singularize(assoc.source_alias)
-              belongs_to_associations = {belongs_to_name.to_sym => parent}
-              final_attrs = attrs.merge(association_hash).merge(belongs_to_associations)
-              builder.struct(*traits, **final_attrs)
-            end
+            struct =
+              if persist
+                builder.persistable.create(*traits, **association_hash)
+              else
+                belongs_to_name = ::ROM::Inflector.singularize(assoc.source_alias)
+                belongs_to_associations = {belongs_to_name.to_sym => parent}
+                final_attrs = attrs.merge(association_hash).merge(belongs_to_associations)
+                builder.struct(*traits, **final_attrs)
+              end
 
-          {name => struct}
+            {name => struct}
+          end
         end
-      end
 
-      class ManyToMany < Core
-        def call(attrs = EMPTY_HASH, parent, persist: true)
-          return if attrs.key?(name)
+        class ManyToMany < Core
+          # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+          def call(attrs = EMPTY_HASH, parent, persist: true)
+            return if attrs.key?(name)
 
-          structs = count.times.map do
-            if persist && attrs[tpk]
-              attrs
-            elsif persist
-              builder.persistable.create(*traits, **attrs)
-            else
-              builder.struct(*traits, **attrs)
+            structs = count.times.map do
+              if persist && attrs[tpk]
+                attrs
+              elsif persist
+                builder.persistable.create(*traits, **attrs)
+              else
+                builder.struct(*traits, **attrs)
+              end
             end
-          end
-
-          # Delegate to through factory if it exists
-          if persist
-            if through_factory?
-              structs.each do |child|
-                through_attrs = {
-                  ::ROM::Inflector.singularize(assoc.source.name.key).to_sym => parent,
-                  assoc.through.assoc_name => child
-                }
 
-                factories[through_factory_name, **through_attrs]
+            # Delegate to through factory if it exists
+            if persist
+              if through_factory?
+                structs.each do |child|
+                  through_attrs = {
+                    ::ROM::Inflector.singularize(assoc.source.name.key).to_sym => parent,
+                    assoc.through.assoc_name => child
+                  }
+
+                  factories[through_factory_name, **through_attrs]
+                end
+              else
+                assoc.persist([parent], structs)
               end
+
+              {name => result(structs)}
             else
-              assoc.persist([parent], structs)
+              result(structs)
             end
-
-            {name => result(structs)}
-          else
-            result(structs)
           end
-        end
+          # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
 
-        def result(structs) = {name => structs}
+          def result(structs) = {name => structs}
 
-        def dependency?(rel) = assoc.source == rel
+          def dependency?(rel) = assoc.source == rel
 
-        def through? = true
+          def through? = true
 
-        def through_factory?
-          factories.registry.key?(through_factory_name)
-        end
+          def through_factory?
+            factories.registry.key?(through_factory_name)
+          end
 
-        def through_factory_name
-          ::ROM::Inflector.singularize(assoc.definition.through.source).to_sym
-        end
+          def through_factory_name
+            ::ROM::Inflector.singularize(assoc.definition.through.source).to_sym
+          end
 
-        private
+          private
 
-        def tpk = assoc.target.primary_key
-      end
+          def tpk = assoc.target.primary_key
+        end
 
-      class OneToOneThrough < ManyToMany
-        def result(structs) = {name => structs[0]}
+        class OneToOneThrough < ManyToMany
+          def result(structs) = {name => structs[0]}
+        end
       end
     end
+    # rubocop:enable Style/OptionalArguments
   end
-  # rubocop:enable Style/OptionalArguments
 end