refactor: add a BC layer for 2.x

[nikophil]

• Doc update
• Bundle configuration
  • Remove auto_refresh_proxies refactor: deprecate config auto_refresh_proxies #524
  • Remove make_factory (I don't think we should do this)
  • without_constructor => use_constructor
  • remove database_resetter.enabled
  • move database_resetter.orm|odm to root
• Object Instantiator split into Instantiator/Hydrator (actually nothing to do here)
• Zenstruck\Foundry\Factory
  • withAttributes() -> with()
  • __construct() removed ⚠️ we must keep an empty __construct() in Factory
  • Factory::sequence() used to accept iterable|callable now it only accepts iterable
• Zenstruck\Foundry\ModelFactory -> Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory
  • protected function getDefaults(): array -> protected function defaults(): array|callable
  • protected static function getClass(): string -> public static function class(): string
  • protected function initialize() -> protected function initialize(): static
  • addState() -> with()
• Zenstruck\Foundry\Proxy -> Zenstruck\Foundry\Persistence\Proxy
  • no longer implements \Stringable
  • isPersisted() removed
  • object() -> _real()
  • save() -> _save()
  • remove() -> _delete()
  • refresh() -> _refresh()
  • forceSet() -> _set()
  • forceSetAll() removed
  • forceGet() -> _get()
  • repository() -> _repository()
  • enableAutoRefresh() -> _enableAutoRefresh()
  • disableAutoRefresh() -> _disableAutoRefresh()
  • withoutAutoRefresh() -> _withoutAutoRefresh()
  • assertPersisted() removed
  • assertNotPersisted() removed
  • introduce Proxy interface
  • final objects cannot be proxified
• Zenstruck\Foundry\anonymous() -> Zenstruck\Foundry\factory() (factory() will be re-added in 2.x)
• Zenstruck\Foundry\create() -> Zenstruck\Foundry\Persistence\persist()
• Zenstruck\Foundry\create_many() removed
• Zenstruck\Foundry\instantiate() -> Zenstruck\Foundry\object()
• Zenstruck\Foundry\instantiate_many() removed
• Zenstruck\Foundry\repository() -> Zenstruck\Foundry\Persistence\repository()
• Zenstruck\Foundry\Test\TestState -> Zenstruck\Foundry\Test\UnitTestConfig (better name?)
• Zenstruck\Foundry\Factory::delayFlush() -> Zenstruck\Foundry\Persistence\flush_after()
• Zenstruck\Foundry\Test\Factories
  • disablePersist() -> Zenstruck\Foundry\Persistence\disable_persisting()
  • enablePersist() -> Zenstruck\Foundry\Persistence\enable_persisting()
  • disable_persisting() / enable_persisting() can non more be called in a unit test
• Zenstruck\Foundry\Instantiator to Zenstruck\Foundry\Object\Instantiator
  • new Instantiator() => Instantiator::withConstructor()
  • alwaysForceProperties() => alwaysForce() + parameters are spread
  • allowExtraAttributes() => allowExtra() + parameters are spread
  • Instantiator::withConstructor() will throw an exception if class's constructor is not public
• Zenstruck\Foundry\RepositoryProxy to Zenstruck\Foundry\Persistence\RepositoryDecorator
• Zenstruck\Foundry\RepositoryAssertions to Zenstruck\Foundry\Persistence\RepositoryAssertions
• withoutPersisting() & co are only on PersistObjectFactory
• Proxy::forceGet() was mistakenly removed and rector should convert to _get()
• Factory::faker() => faker()
• FactoryCollection::set() to deprecate
• Instantiator::forceGet() to deprecate
• Instantiator::forceSet() to deprecate
• bc layer on sequences needs to be rolled-back
• randomRange() does not accept 0 anymore we'll still allow 0 in 2.x
• deprecate FactoryCollection::factory()
• RepositoryProxy::findOneBy() second argument $orderBy should be deprecated
• ModelFactory::new() used to accept string (should we deprecate this?)
• RepositoryDecorator methods now returns T and not Proxy
• Rector
  • Don't replace extended factory if extending a user-defined factory
  • Calls to parent::getDefaults() on factories that extend other user-defined factories
  • see how we can improve FQCN and FQFN which are not imported
  • functions changed to object() are not proxied
  • functions changed to persist() are not proxied

EDIT: I think the two following are ok-ish: for the first problem. Both problems are fixed byt rector rules.

• no deprecation is thrown around "old" classes like Proxy, RepositoryProxy, etc... not sure it is really a problem, but we're not covered by deprecations for this I don't think a lot of people type-hint RepositoryProxy
• deprecation was never thrown about Factory::instantiate()'s return type, althought Ive added #[ReturnTypeWillChange] For the second one: if the problem exist, tests will fail in a very explicit way

[nikophil]

Bundle config diff:

zenstruck_foundry:
-    auto_refresh_proxies: null
    instantiator:
-        without_constructor:  false
+        use_constructor:  true
        allow_extra_attributes: false
        always_force_properties: false
        service:              null
+    orm:
+        auto_persist:         true
+        reset:
+            connections: [default]
+            entity_managers: [default]
+            mode: schema
+    mongo:
+        auto_persist:         true
+        reset:
+            document_managers: [default]
-    database_resetter:
-        enabled:              true
-        orm:
-            connections:          []
-            object_managers:      []
-            reset_mode:           schema
-        odm:
-            object_managers:      []
    global_state:         []
-    make_factory:
-        default_namespace:    Factory

[kbond]

Here's some info on my upgrade to this branch and running rector:

Before:
Remaining direct deprecation notices (3342)

After (and issues below fixed):

Remaining direct deprecation notices (13) 🎉

  38x: Since zenstruck/foundry 1.37.0: Calling instance method "Zenstruck\Foundry\Object\Instantiator::withoutConstructor()" is deprecated and will be removed in 2.0. Use static call instead: "Zenstruck\Foundry\Object\Instantiator::withoutConstructor()" instead.

  12x: Since zenstruck\foundry 1.37.0: Method "Zenstruck\Foundry\Proxy::object()" is deprecated and will be removed in 2.0. Use "Zenstruck\Foundry\Proxy::_real()" instead.

  11x: Since zenstruck\foundry 1.37.0: Method "Zenstruck\Foundry\Proxy::save()" is deprecated and will be removed in 2.0. Use "Zenstruck\Foundry\Proxy::_save()" instead.

  9x: Since zenstruck\foundry 1.37.0: Method "Zenstruck\Foundry\Proxy::forceSet()" is deprecated and will be removed in 2.0. Use "Zenstruck\Foundry\Proxy::_set()" instead.

  2x: Since zenstruck\foundry 1.37.0: Method "Zenstruck\Foundry\Proxy::forceSetAll()" is deprecated and will be removed in 2.0 without replacement.

  1x: Since zenstruck\foundry 1.37.0: Passing a callable to method "Zenstruck\Foundry\Factory::sequence()" is deprecated and will be removed in 2.0.

  1x: Since zenstruck\foundry 1.37: Usage of "Zenstruck\Foundry\anonymous()" function is deprecated and will be removed in 2.0. Use the "Zenstruck\Foundry\Persistence\proxy_factory()" function instead.

Remaining indirect deprecation notices (199)

  175x: Since zenstruck\foundry 1.37.0: Method "Zenstruck\Foundry\Proxy::object()" is deprecated and will be removed in 2.0. Use "Zenstruck\Foundry\Proxy::_real()" instead.

  1x: The "Zenstruck\Foundry\Factory::create()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\ObjectFactory".

  1x: The "Zenstruck\Foundry\ObjectFactory::new()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\ObjectFactory::create()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\ObjectFactory::createOne()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\ObjectFactory::createSequence()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::findOrCreate()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::first()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::last()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::random()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::randomOrCreate()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::randomSet()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::randomRange()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::all()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::find()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

  1x: The "Zenstruck\Foundry\Persistence\PersistentObjectFactory::findBy()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory".

Issues:
Not sure if all these can/should be fixed.

• FQCN and FQFN not imported (easily fixed en mass with phpstorm)
• factories that extend other user-defined factories had their extends base class changed
• forceGet issue
• calls to parent::getDefaults() on factories that extend other user-defined factories
• functions changed to object() are not proxied
• functions changed to persist() are not proxied