realtime-validations 0.0.3 → 0.0.4

data/README.rdoc

@@ -1,3 +1,67 @@
-= RealtimeValidations
+= Realtime Validations for Rails
 
-This project rocks and uses MIT-LICENSE.
+Gem that is able to run validations on models while the form is being filled by the user.
+
+== Why
+
+It is smart in the sense that is able to fulfill almost 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
+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'
+
+=== Running generators
+
+  rails g realtime_validations realtime_validations
+
+Read more about what the generators do on the Wiki pages.
+
+=== Putting everything together
+
+=== Application Layout
+
+Include javascripts and stylesheets (optionally) from the engine in your layout file:
+
+  <%= stylesheet_link_tag    'application', 'realtime_validations/core' %>
+  <%= javascript_include_tag 'application', 'realtime_validations/core' %>
+
+==== Views
+
+You should use:
+
+  form_validated_for
+
+=== Check if the engine is correctly imported
+
+Run:
+
+  rake routes
+
+and check if it contains a route for:
+
+  POST   /validations/*args(.:format) realtime_validations/validations#validate
+
+=== 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/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module RealtimeValidations
+
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def copy_initializer_file
+        copy_file 'initializer.rb', 'config/initializers/realtime_validations_initializer.rb'
+        copy_file 'realtime_validations.js', 'app/assets/javascripts/realtime_validations.js'
+      end
+
+    end
+
+  end
+
+end

data/lib/realtime-validations/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: realtime-validations
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16323340 !ruby/object:Gem::Requirement
+  requirement: &8517220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *16323340
+  version_requirements: *8517220
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &16322860 !ruby/object:Gem::Requirement
+  requirement: &8516800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16322860
+  version_requirements: *8516800
 description: Form real time validations for free on Rails applications
 email:
 - ereslibre@gmail.com
@@ -47,9 +47,9 @@ files:
 - config/initializers/form_validated_for.rb
 - lib/realtime-validations.rb
 - lib/realtime-validations/version.rb
+- lib/generators/realtime_validations/install_generator.rb
 - lib/generators/realtime_validations/templates/initializer.rb
 - lib/generators/realtime_validations/templates/realtime_validations.js
-- lib/generators/realtime_validations/realtime_validations_generator.rb
 - lib/tasks/realtime-validations_tasks.rake
 - MIT-LICENSE
 - Rakefile

data/lib/generators/realtime_validations/realtime_validations_generator.rb

@@ -1,12 +0,0 @@
-require 'rails/generators'
-
-class RealtimeValidationsGenerator < Rails::Generators::NamedBase
-
-  source_root File.join(File.dirname(__FILE__), 'templates')
-
-  def copy_initializer_file
-    copy_file 'initializer.rb', 'config/initializers/realtime_validations_initializer.rb'
-    copy_file 'realtime_validations.js', 'app/assets/javascripts/realtime_validations.js'
-  end
-
-end