Add factory.Faker()

This relies on the ``fake-factory`` library, and provides realistic
random values for most field types.

10 files changed, 293 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index 991180f..9b82406 100644
--- a/README.rst
+++ b/README.rst
@@ -177,6 +177,28 @@ It is also possible to create a bunch of objects in a single call:
     >>> [user.first_name for user in users]
     ["Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe", "Joe"]
 
+
+Realistic, random values
+""""""""""""""""""""""""
+
+Tests look better with random yet realistic values.
+For this, factory_boy relies on the excellent `fake-factory <https://pypi.python.org/pypi/fake-factory>`_ library:
+
+.. code-block:: python
+
+    class RandomUserFactory(factory.Factory):
+        class Meta:
+            model = models.User
+
+        first_name = factory.Faker('first_name')
+        last_name = factory.Faker('last_name')
+
+.. code-block:: pycon
+
+    >>> UserFactory()
+    <User: Lucy Murray>
+
+
 Lazy Attributes
 """""""""""""""
 
diff --git a/dev_requirements.txt b/dev_requirements.txt
index 7c29185..d55129a 100644
--- a/dev_requirements.txt
+++ b/dev_requirements.txt
@@ -1,3 +1,5 @@
+-r requirements.txt
+
 coverage
 Django
 Pillow
diff --git a/docs/changelog.rst b/docs/changelog.rst
index cd5d281..886db0b 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -9,6 +9,8 @@ ChangeLog
 *New:*
 
     - Add :attr:`factory.FactoryOptions.rename` to help handle conflicting names (:issue:`206`)
+    - Add support for random-yet-realistic values through `fake-factory <https://pypi.python.org/pypi/fake-factory>`_,
+      through the :class:`factory.Faker` class.
 
 .. _v2.5.2:
 
diff --git a/docs/reference.rst b/docs/reference.rst
index 0705ca2..a168de5 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -474,6 +474,66 @@ factory_boy supports two main strategies for generating instances, plus stubs.
 Declarations
 ------------
 
+
+Faker
+"""""
+
+.. class:: Faker(provider, locale=None, **kwargs)
+
+    .. OHAIVIM**
+
+    In order to easily define realistic-looking factories,
+    use the :class:`Faker` attribute declaration.
+
+    This is a wrapper around `fake-factory <https://pypi.python.org/pypi/fake-factory>`_;
+    its argument is the name of a ``fake-factory`` provider:
+
+    .. code-block:: python
+
+        class UserFactory(factory.Factory):
+            class Meta:
+                model = User
+
+            first_name = factory.Faker('name')
+
+    .. code-block:: pycon
+
+        >>> user = UserFactory()
+        >>> user.name
+        'Lucy Cechtelar'
+
+
+    .. attribute:: locale
+
+        If a custom locale is required for one specific field,
+        use the ``locale`` parameter:
+
+        .. code-block:: python
+
+            class UserFactory(factory.Factory):
+                class Meta:
+                    model = User
+
+                first_name = factory.Faker('name', locale='fr_FR')
+
+        .. code-block:: pycon
+
+            >>> user = UserFactory()
+            >>> user.name
+            'Jean Valjean'
+
+
+    .. classmethod:: override_default_locale(cls, locale)
+
+        If the locale needs to be overridden for a whole test,
+        use :meth:`~factory.Faker.override_default_locale`:
+
+        .. code-block:: pycon
+
+            >>> with factory.Faker.override_default_locale('de_DE'):
+            ...     UserFactory()
+            <User: Johannes Brahms>
+
 LazyAttribute
 """""""""""""
 
diff --git a/factory/__init__.py b/factory/__init__.py
index ea8c459..80eb6a8 100644
--- a/factory/__init__.py
+++ b/factory/__init__.py
@@ -43,6 +43,7 @@ from .base import (
 # Backward compatibility; this should be removed soon.
 from .mogo import MogoFactory
 from .django import DjangoModelFactory
+from .faker import Faker
 
 from .declarations import (
     LazyAttribute,
diff --git a/factory/faker.py b/factory/faker.py
new file mode 100644
index 0000000..10a0cba
--- /dev/null
+++ b/factory/faker.py
@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2010 Mark Sandstrom
+# Copyright (c) 2011-2015 Raphaël Barrois
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+"""Additional declarations for "faker" attributes.
+
+Usage:
+
+    class MyFactory(factory.Factory):
+        class Meta:
+            model = MyProfile
+
+        first_name = factory.Faker('name')
+"""
+
+
+from __future__ import absolute_import
+from __future__ import unicode_literals
+
+import contextlib
+
+import faker
+import faker.config
+
+from . import declarations
+
+class Faker(declarations.OrderedDeclaration):
+    """Wrapper for 'faker' values.
+
+    Args:
+        provider (str): the name of the Faker field
+        locale (str): the locale to use for the faker
+
+        All other kwargs will be passed to the underlying provider
+        (e.g ``factory.Faker('ean', length=10)``
+        calls ``faker.Faker.ean(length=10)``)
+
+    Usage:
+        >>> foo = factory.Faker('name')
+    """
+    def __init__(self, provider, locale=None, **kwargs):
+        self.provider = provider
+        self.provider_kwargs = kwargs
+        self.locale = locale
+
+    def generate(self, extra_kwargs):
+        kwargs = {}
+        kwargs.update(self.provider_kwargs)
+        kwargs.update(extra_kwargs)
+        faker = self._get_faker(self.locale)
+        return faker.format(self.provider, **kwargs)
+
+    def evaluate(self, sequence, obj, create, extra=None, containers=()):
+        return self.generate(extra or {})
+
+    _FAKER_REGISTRY = {}
+    _DEFAULT_LOCALE = faker.config.DEFAULT_LOCALE
+
+    @classmethod
+    @contextlib.contextmanager
+    def override_default_locale(cls, locale):
+        old_locale = cls._DEFAULT_LOCALE
+        cls._DEFAULT_LOCALE = locale
+        try:
+            yield
+        finally:
+            cls._DEFAULT_LOCALE = old_locale
+
+    @classmethod
+    def _get_faker(cls, locale=None):
+        if locale is None:
+            locale = cls._DEFAULT_LOCALE
+
+        if locale not in cls._FAKER_REGISTRY:
+            cls._FAKER_REGISTRY[locale] = faker.Faker(locale=locale)
+
+        return cls._FAKER_REGISTRY[locale]
diff --git a/requirement.txt b/requirement.txt
new file mode 100644
index 0000000..bd2a4a6
--- /dev/null
+++ b/requirement.txt
@@ -0,0 +1 @@
+fake-factory>=0.5.0
diff --git a/setup.py b/setup.py
index daee69b..942fa2c 100755
--- a/setup.py
+++ b/setup.py
@@ -47,6 +47,9 @@ setup(
     setup_requires=[
         'setuptools>=0.8',
     ],
+    install_requires=[
+        'fake-factory>=0.5.0',
+    ],
     tests_require=[
         #'mock',
     ],
diff --git a/tests/__init__.py b/tests/__init__.py
index dc1a119..b2c772d 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -7,6 +7,7 @@ from .test_django import *
 from .test_base import *
 from .test_containers import *
 from .test_declarations import *
+from .test_faker import *
 from .test_fuzzy import *
 from .test_helpers import *
 from .test_using import *
diff --git a/tests/test_faker.py b/tests/test_faker.py
new file mode 100644
index 0000000..41f8e19
--- /dev/null
+++ b/tests/test_faker.py
@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2010 Mark Sandstrom
+# Copyright (c) 2011-2015 Raphaël Barrois
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+import factory
+import unittest
+
+
+class MockFaker(object):
+    def __init__(self, expected):
+        self.expected = expected
+
+    def format(self, provider, **kwargs):
+        return self.expected[provider]
+
+
+class FakerTests(unittest.TestCase):
+    def setUp(self):
+        self._real_fakers = factory.Faker._FAKER_REGISTRY
+        factory.Faker._FAKER_REGISTRY = {}
+
+    def tearDown(self):
+        factory.Faker._FAKER_REGISTRY = self._real_fakers
+
+    def _setup_mock_faker(self, locale=None, **definitions):
+        if locale is None:
+            locale = factory.Faker._DEFAULT_LOCALE
+        factory.Faker._FAKER_REGISTRY[locale] = MockFaker(definitions)
+
+    def test_simple_biased(self):
+        self._setup_mock_faker(name="John Doe")
+        faker_field = factory.Faker('name')
+        self.assertEqual("John Doe", faker_field.generate({}))
+
+    def test_full_factory(self):
+        class Profile(object):
+            def __init__(self, first_name, last_name, email):
+                self.first_name = first_name
+                self.last_name = last_name
+                self.email = email
+
+        class ProfileFactory(factory.Factory):
+            class Meta:
+                model = Profile
+            first_name = factory.Faker('first_name')
+            last_name = factory.Faker('last_name', locale='fr_FR')
+            email = factory.Faker('email')
+
+        self._setup_mock_faker(first_name="John", last_name="Doe", email="john.doe@example.org")
+        self._setup_mock_faker(first_name="Jean", last_name="Valjean", email="jvaljean@exemple.fr", locale='fr_FR')
+
+        profile = ProfileFactory()
+        self.assertEqual("John", profile.first_name)
+        self.assertEqual("Valjean", profile.last_name)
+        self.assertEqual('john.doe@example.org', profile.email)
+
+    def test_override_locale(self):
+        class Profile(object):
+            def __init__(self, first_name, last_name):
+                self.first_name = first_name
+                self.last_name = last_name
+
+        class ProfileFactory(factory.Factory):
+            class Meta:
+                model = Profile
+
+            first_name = factory.Faker('first_name')
+            last_name = factory.Faker('last_name', locale='fr_FR')
+
+        self._setup_mock_faker(first_name="John", last_name="Doe")
+        self._setup_mock_faker(first_name="Jean", last_name="Valjean", locale='fr_FR')
+        self._setup_mock_faker(first_name="Johannes", last_name="Brahms", locale='de_DE')
+
+        profile = ProfileFactory()
+        self.assertEqual("John", profile.first_name)
+        self.assertEqual("Valjean", profile.last_name)
+
+        with factory.Faker.override_default_locale('de_DE'):
+            profile = ProfileFactory()
+            self.assertEqual("Johannes", profile.first_name)
+            self.assertEqual("Valjean", profile.last_name)
+
+        profile = ProfileFactory()
+        self.assertEqual("John", profile.first_name)
+        self.assertEqual("Valjean", profile.last_name)
+