green_light 0.0.3 → 0.1.3

data/Gemfile

@@ -1,5 +1,18 @@
 source 'http://rubygems.org'
-gem 'rails'
-gem "activerecord", :require => "active_record"
-gem 'rspec'
-gem 'supermodel'
+gem 'rails',"3.1.0.rc5" 
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails', "~> 3.1.0.rc"
+  gem 'coffee-rails', "~> 3.1.0.rc"
+  gem 'uglifier'
+end
+
+gem 'jquery-rails'
+
+group :test do
+  gem "activerecord", :require => "active_record"
+  gem 'rspec'
+  gem 'supermodel'
+end

data/README.rdoc

@@ -1,6 +1,6 @@
 = green_light
 
-Provides client side validation (with the help of the jquery validation plugin) while keeping validation in the model, where it belongs.
+Provides client side validation, with the help of the {jquery validation plugin}[http://bassistance.de/jquery-plugins/jquery-plugin-validation/], while keeping validation in the model, where it belongs.
 
 
 == Installation
@@ -13,19 +13,18 @@ Add green_light to your Gemfile and run the bundle install command.
 
 == Usage
 
-Run this generator to copy the required assets to your public folder:-
+Generate the required green_light configuration:-
 
-  rails g green_light_assets
+  rails g green_light:install
 
-Download {jQuery}[http://jquery.com/] and the {jQuery Validation Plugin}[http://bassistance.de/jquery-plugins/jquery-plugin-validation/] and include them in your layout header.
+Include the JQuery validation plugin and green_light javascript in your application.js file:-
 
-  <%= javascript_include_tag 'jquery-1.x.x.min', 'jquery.validate.min' %>
+  //= require jquery.validate
+  //= require green_light
 
-Also, insert the following javascript include tag in your layout html header:-
-  
-  <%= javascript_include_tag 'jquery.validate_regex', 'green_light' %>
+Specify which models you want to have client-side validation in the config/green_light.yml file e.g.:-
 
-Note, the green_light file specified above is generated dynamically, so it wont appear in your public javascripts folder.
+  validate_models: ['ModelName1', 'ModelName2']
 
 Add the <tt>green_light</tt> class to the forms that you wish to have client side validation:-
 
@@ -42,10 +41,12 @@ And finally, add some validations to your models!
   validates_uniqueness_of
   validates_numericality_of
 
+For validations that are not yet supported, the gem will degrade gracefully to the standard Rails server-side validation.
+
 
-== Requirements
+== Legecy Rails 3 Support
 
-  jQuery versions 1.3.2, 1.4.2, 1.4.4, 1.5.0, 1.5.1
+For Rails 3 support use the older version (0.0.3) of green_light
 
 
 == Running the Tests

data/app/assets/javascripts/green_light.js.erb

@@ -0,0 +1,23 @@
+/**
+ * Build validation rules based on models specified in the green_light config
+ */ 
+<% unless GREEN_LIGHT[:validate_models].empty? %>
+  <% @rules = GreenLight::Rules.generate(GREEN_LIGHT[:validate_models]) %>
+  $().ready(function() {
+    $(".green_light").validate(<%= @rules.html_safe %>);
+  });
+<% end %>
+
+/**
+ * Custom code for regex validation
+ */ 
+$.validator.addMethod(
+  "regex",
+  function(value, element, regexp) {
+    var check = false;
+    var re = new RegExp(regexp);
+    return this.optional(element) || re.test(value);
+  },
+  "You have entered an invalid value for this field"
+);
+

data/app/controllers/javascripts_controller.rb

@@ -1,10 +1,5 @@
 class JavascriptsController < ApplicationController
-  respond_to :js, :text
-
-  def green_light
-    @rules = GreenLight::Rules.generate(all_models)
-    respond_with(@rules)
-  end
+  respond_to :text
 
   def check_for_uniqueness
     record = params[:model].constantize.where("#{params[:field]} = ?", params[params[:model].downcase.underscore][params[:field]])
@@ -14,11 +9,4 @@ class JavascriptsController < ApplicationController
       render :text => true
     end
   end
-
-  private
-    def all_models
-      tables = ActiveRecord::Base.connection.tables
-      tables.delete("schema_migrations")
-      tables.map { |table| table.camelize.singularize.constantize }
-    end
 end

data/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
-  match "/javascripts/green_light" => "javascripts#green_light"
+  match "/assets/green_light" => "assets#green_light"
   match "/javascripts/check_for_uniqueness" => "javascripts#check_for_uniqueness"
 end

data/lib/generators/green_light/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module GreenLight
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Generates config file for green_light'
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+    
+    def generate_config
+      copy_file "green_light.yml", "config/green_light.yml"
+    end
+    
+    def generate_initializer
+      copy_file "green_light.rb", "config/initializers/green_light.rb"
+    end
+  end
+end
+

data/lib/generators/green_light/templates/green_light.rb

@@ -0,0 +1,2 @@
+config = YAML.load_file(File.join(Rails.root, 'config', 'green_light.yml'))
+GREEN_LIGHT = HashWithIndifferentAccess.new(config)

data/lib/generators/green_light/templates/green_light.yml

@@ -0,0 +1 @@
+validate_models: []

data/lib/green_light/rules.rb

@@ -9,7 +9,7 @@ module GreenLight
     def self.generate(models)
       data, rules = {}, {}
       models.each do |model| 
-        model._validators.each do |field_name, validations| 
+        model.constantize._validators.each do |field_name, validations| 
           rules["#{model.to_s.underscore.downcase}[#{field_name}]"] = parse_each_validation(model, field_name, validations)
           data[:rules] = rules
         end

data/lib/green_light/version.rb

@@ -1,3 +1,3 @@
 module GreenLight
-  VERSION = "0.0.3"
+  VERSION = "0.1.3"
 end

data/spec/green_light_spec.rb

@@ -5,27 +5,27 @@ describe GreenLight do
   end
       
   it "should return a valid json string when validating the format of a field" do
-    rules = GreenLight::Rules.generate([FormatOfModel])
+    rules = GreenLight::Rules.generate(['FormatOfModel'])
     rules.should == "{\"errorElement\":\"span\",\"rules\":{\"format_of_model[title]\":{\"regex\":\"(^[A-Za-z]$)\"}}}"
   end
 
   it "should return a json string when validating the presence of a field" do
-    rules = GreenLight::Rules.generate([PresenceOfModel])
+    rules = GreenLight::Rules.generate(['PresenceOfModel'])
     rules.should == "{\"errorElement\":\"span\",\"rules\":{\"presence_of_model[title]\":{\"required\":true}}}"
   end
 
   it "should return a json string when validating the length of a field" do
-    rules = GreenLight::Rules.generate([LengthOfModel])
+    rules = GreenLight::Rules.generate(['LengthOfModel'])
     rules.should == "{\"errorElement\":\"span\",\"rules\":{\"length_of_model[title]\":{\"maxlength\":10,\"minlength\":5}}}"
   end
 
   it "should return a json string when validating the numericality of a field" do
-    rules = GreenLight::Rules.generate([NumericalityOfModel])
+    rules = GreenLight::Rules.generate(['NumericalityOfModel'])
     rules.should == "{\"errorElement\":\"span\",\"rules\":{\"numericality_of_model[age]\":{\"regex\":\"^[0-9]*$\"}}}"
   end
 
   it "should return a json string when validating the uniqueness of a field" do
-    rules = GreenLight::Rules.generate([UniquenessOfModel])
+    rules = GreenLight::Rules.generate(['UniquenessOfModel'])
     rules.should == "{\"errorElement\":\"span\",\"rules\":{\"uniqueness_of_model[title]\":{\"remote\":\"/javascripts/check_for_uniqueness?model=UniquenessOfModel&field=title\"}}}"
   end
 end