realtime-validations 0.0.4 → 0.0.6

data/README.rdoc

@@ -4,7 +4,7 @@ Gem that is able to run validations on models while the form is being filled by
 
 == Why
 
-It is smart in the sense that is able to fulfill almost any kind of validation. For instance, if
+It is smart in the sense that is able to fulfill any kind of validation. For instance, if
 configured properly, it can run even validations that are :scoped by some other model.
 
 Also, it allows to add some information based on the current session, user, client... so the model
@@ -12,27 +12,15 @@ to be created or edited can be linked to that session, user or client.
 
 It is very generic and is not tied to any specific case of use.
 
-== How it works
-
-It is installed a listener on every field of the form to be validated, so when the user leaves the
-field, a petition is made to the server. The server (the ValidationsController class) will then create
-a new model of that type, or will find the current one (if it is an edit/update operation). Then,
-the property that was edited by the user is set to this recently created model instance. Right
-afterwards, it is called a helper that will allow you (the developer) to set some special fields
-that have importance to you, as the session, current client or current user, in order to be able to
-correctly process all validations, even those that are scoped on the current user, for example. After
-calling your helper, the valid? method is called on the model; the errors[:field_name] is retrieved
-and returned to the client, for the JQuery code to process and modify the DOM.
-
 == Setup
 
 === Gemfile
 
-  require 'realtime-validations'
+  gem 'realtime-validations'
 
 === Running generators
 
-  rails g realtime_validations realtime_validations
+  rails g realtime_validations:install
 
 Read more about what the generators do on the Wiki pages.
 
@@ -40,7 +28,7 @@ Read more about what the generators do on the Wiki pages.
 
 === Application Layout
 
-Include javascripts and stylesheets (optionally) from the engine in your layout file:
+Include javascripts and stylesheets (optionally) from the engine in your application layout file:
 
   <%= stylesheet_link_tag    'application', 'realtime_validations/core' %>
   <%= javascript_include_tag 'application', 'realtime_validations/core' %>
@@ -51,6 +39,12 @@ You should use:
 
   form_validated_for
 
+instead of:
+
+  form_for
+
+where you want the engine to validate your fields automatically.
+
 === Check if the engine is correctly imported
 
 Run:
@@ -63,5 +57,4 @@ and check if it contains a route for:
 
 === Examples
 
-https://github.com/ereslibre/realtime-validations-examples contains some examples that can
-be of use if you are starting to use this gem.
+realtime-validations-examples[https://github.com/ereslibre/realtime-validations-examples] contains some examples that can be of use if you are starting to use this gem.

data/lib/generators/realtime_validations/templates/initializer.rb

@@ -2,9 +2,34 @@ module RealtimeValidations
 
   module Controller
 
+    #
+    # Called when this module is included in the ValidationsController.
+    #
+    # Here, you could add or remove new before and after filters, for instance.
+    #
+    # Example:
+    #
+    #   base.skip_before_filter :some_applicationcontroller_filter
+    #   base.before_filter :some_helper_method
+    #
     def self.included(base)
     end
 
+    #
+    # Called before model is validated. The model has already been filled with all the needed
+    # information in order to check whether is valid or not. Here, you could also add some
+    # extra information that has meaning for your system, as a client_id, a session_id, a
+    # user_id or something similar.
+    #
+    # Example:
+    #
+    #   model.client_id = @client.id if @client and model.respond_to? :client_id=
+    #   model.user_id = @user.id if @user and model.respond_to? :user_id=
+    #
+    # This is very important for validations on your model of the type:
+    #
+    #   validates :name, :presence => true, :uniqueness => { :scope => :client_id }
+    #
     def before_model_validation(model)
     end
 

data/lib/realtime-validations/version.rb

@@ -1,3 +1,3 @@
 module RealtimeValidations
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: realtime-validations
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-30 00:00:00.000000000 Z
+date: 2011-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &8517220 !ruby/object:Gem::Requirement
+  requirement: &19648320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *8517220
+  version_requirements: *19648320
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &8516800 !ruby/object:Gem::Requirement
+  requirement: &19647640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8516800
+  version_requirements: *19647640
 description: Form real time validations for free on Rails applications
 email:
 - ereslibre@gmail.com