Merge pull request #18 from xeBuz/jesus_custom_messages

Variables on message
xeBuz · Jan 25, 2016 · 0a91d90 · 0a91d90
2 parents e4ae4ed + 438c45d
commit 0a91d90
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -71,9 +71,18 @@ Every Constraint has a parameter to throw an exception everytime the validation
 ValidateNumeric(Table.field, False, True, "Message")
 ```
 
-The last parameter enables this featur and throw a `ValidateError` exception, otherwise it will fails silently.
+The third parameter enables this feature and throw a `ValidateError` exception, otherwise it will fails silently.
 
 
+## Message Exception
+
+The fourth parameter allow a custom message exception, with a few variables available
+
+- `old_value`: value previous to the modification
+- `new_value`: value provided (with the error)
+- `key`: the column name
+- `field`: object.column
+
 
 ## Available Constraints
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -63,9 +63,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.1'
+version = '1.1.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.1'
+release = '1.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/custom.rst b/docs/custom.rst
@@ -21,5 +21,5 @@ You must define your own method ``check_value()`` and if you are receiving any a
             retunr if value in ['A', 'B']
 
 
-    validator = ValidateAorB('yadayada')
+    validator = ValidateAorB(field, True, True, 'yadayada')
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,7 @@ Contents:
    usage
    validators
    custom
+   messages
 
 
 

diff --git a/docs/messages.rst b/docs/messages.rst
@@ -0,0 +1,19 @@
+Exception Message
+=================
+
+
+You will be able to create customs exception messages, with a few variables availables:
+
+* ``field``: Object and property
+* ``key``: property
+* ``new_value``: New value changed
+* ``old_value``: Previous value
+
+
+
+.. code-block:: python
+
+    from flask_validator import ValidateEmail
+
+    validator = ValidateEmail(field, False, True, 'Message: Field {field}, Key {key}, New value {new_value}, Old value {old_value}')
+
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -1,5 +1,5 @@
 Basic Usage
-====================
+===========
 
 
 The most performant way to set up your validations is uring the SQLAlchemy special  directive_ ``__declare_last__``, it occurs after mappings are assumed to be completed and the ‘configure’ step has finished.

diff --git a/examples/example.py b/examples/example.py
@@ -20,7 +20,8 @@ def __init__(self, string, integer):
     @classmethod
     def __declare_last__(cls):
         ValidateInteger(User.integer)
-        ValidateString(User.string, False, True, "Custom Message")
+        ValidateString(User.string, False, True, "Custom Message, "
+                                                 "Field {field} - Value {value} - Oldvalue {oldvalue} - Key {key}")
 
 db.create_all()
 u = User("user", 1)

diff --git a/flask_validator/validator.py b/flask_validator/validator.py
@@ -2,7 +2,7 @@
 from sqlalchemy import event
 from .exceptions import ValidateError
 
-__version__ = '1.1'
+__version__ = '1.1.1'
 
 
 class FlaskValidator:
@@ -45,6 +45,8 @@ def __validate(self, target, value, oldvalue, initiator):
 
             if self.throw_exception:
                 if self.message:
+                    self.message = self.message.format(
+                            field=self.field, new_value=value, old_value=oldvalue, key=initiator.key)
                     raise ValidateError(self.message)
                 else:
                     raise ValidateError('Value %s from column %s is not valid' % (value, initiator.key))

diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
 
 setup(
     name='Flask-Validator',
-    version='1.1',
+    version='1.1.1',
     license='Mozilla Public License',
     author='Jesus Roldan',
     author_email='jesus.roldan@gmail.com',