express_validations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82cad3c08526d5d9a3a983988c6c92c4212e3e10
+  data.tar.gz: 7fd2414f2d33ece0b128d5b17b5a02bcad4ab0ac
+SHA512:
+  metadata.gz: cb303806f09bc997662a084f9ab9e74b07b2c991cadbe9c2dd6938282d66b808c05f2d8cd150bfbe02b87c5f5d25523bdabc0e6840e2e490fe5ecc9b03700247
+  data.tar.gz: eb663b7865ea67f6c19ef6bedd1c58ce750257617b78cc564302fdf0ad34038ec82540a7db3fbcdd6694305cc1699cbd5cb68724648e83d939ecdacdcd82956f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/support/secrets.yml
+/express_validations-0.1.0.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+* first release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in express_validations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 ToDo
+
+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.

data/README.md

@@ -0,0 +1,86 @@
+# ExpressValidations
+
+This gem allows you to express the validations in your Rails models as JSON objects, so that you can implement them as client side validations with JQuery --- the way you want to.
+
+This gem helps to maintain consistency between validation rules on server-side and implementations on client-side.
+
+It can be very handy if you want to display validations in a more user-friendly manner or when you are creating a wizard and want to implement model validations on each step.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'express_validations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install express_validations
+
+## Usage
+
+For model classes where you require the validations on client-side, add the following line to it:
+
+```include ExpressValidations```
+
+Then in the views for this model do:
+
+```
+<%= javascript_tag do %>
+	window.validationRules = <%= #{Your Model}.validations_as_json.html_safe %>;
+<% end %>
+```
+
+This will give access of the model's validation definitions to your application's client-side.
+
+But that is not it. You can use the JQuery functions provided with this gem to check if validation passes on a particular field or form, as well as get validation details for a field or a set of fields.
+
+Include the following line in your ```application.js``` file:
+
+```//= require express.validations```
+
+Then you can use the included functions, for examples, as:
+
+```
+// returns true or false
+var fieldValidation = expressValidations.checkFieldValidation($('input#user_first_name'), window.validationRules);
+
+// returns true or false
+var formValidation = expressValidations.checkFieldValidation($('form#new_user'), window.validationRules);
+
+// returns an object
+var fieldValidationRules = expressValidations.getValidationsFor($('input#user_first_name'), window.validationRules);
+
+// returns an array of objects
+var multipleFieldsValidationRules = expressValidations.getValidationsForMultiple([$('input#username'), $('input#password')], window.validationRules);
+
+```
+
+## Notes
+
+- It requires ```Ruby >= 1.9.3```
+- It requires ```activesupport >= 3.2.22```
+- It requires that you declare validations with the form ```validates_#{validation_name}_of``` such as ```validates_presence_of```, with specified options and messages
+- It skips on ```numericality``` validator
+- It cannot take custom validations into account
+
+
+## ToDo
+
+- Add more JS examples
+- Add the ```numericality``` validator
+- Add tests for Javascript functions
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vikramanity/express_validations.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "express_validations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/express_validations.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'express_validations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "express_validations"
+  spec.version       = ExpressValidations::VERSION
+  spec.authors       = ["Vikram Anand"]
+  spec.email         = ["vikram983@outlook.com"]
+
+  spec.summary       = %q{Express the validations in your models as JSON objects.}
+  spec.description   = %q{This gem allows you to express the validations in your models as JSON objects, so that you can implement them as client side validations.}
+  spec.homepage      = "https://github.com/vikramanity/express_validations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pg', '0.17.1'
+  spec.add_development_dependency 'with_model', '~> 1.2'
+  spec.add_dependency 'activesupport', '>= 3.2.22', '<= 5.0.0.1'
+  spec.add_dependency 'railties', '>= 3.2.22', '<= 5.0.0.1'
+end

data/lib/express_validations.rb

@@ -0,0 +1,35 @@
+require "active_support/concern"
+
+require "express_validations/version"
+
+module ExpressValidations
+  require "express_validations/engine" if defined? Rails
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def validations_as_json(attributes = [])
+      raise ArgumentError, "Argument must be an array!" unless attributes.is_a?(Array)
+
+      validatons = []
+      attrs_with_validations = attributes
+
+      attribute_names.map{ |attr|
+        attrs_with_validations << attr.to_sym unless validators_on(attr).blank?
+      }
+
+      attrs_with_validations.each do |attr|
+        validators = []
+        attr_validators = validators_on(attr)
+
+        attr_validators.each do |attr_validator|
+          validators << { attr_validator.class.name.demodulize.to_sym => attr_validator.options }
+        end
+
+        validatons << { attr => { :validators => validators } }
+      end
+
+      validatons.to_json
+    end
+  end
+end

data/lib/express_validations/engine.rb

@@ -0,0 +1,3 @@
+class Engine < ::Rails::Engine
+  isolate_namespace ExpressValidations
+end

data/lib/express_validations/version.rb

@@ -0,0 +1,3 @@
+module ExpressValidations
+  VERSION = "0.1.0"
+end

data/vendor/assets/javascripts/express.validations.js

@@ -0,0 +1,246 @@
+// ---------------------------------------------------------------------------
+// Express Validations - (https://github.com/vikramanity/express_validations)
+// Copyright (c) 2016 Vikram Anand
+// Licensed under MIT (https://opensource.org/licenses/MIT)
+// ---------------------------------------------------------------------------
+
+
+(function() {
+  var displayValidation, getValidationsFor, railsValidations, validateField;
+
+  // A list of all (most) Rails validations
+  // railsValidations = [
+  //   "absence",
+  //   "acceptance",
+  //   "confirmation",
+  //   "exclusion",
+  //   "format",
+  //   "inclusion",
+  //   "length",
+  //   "numericality",
+  //   "presence",
+  //   "uniqueness"
+  // ];
+
+  getValidationsFor = function($element, validationRules) {
+    var elName, fieldName, validationObjects;
+    elName = $element.attr('name');
+    fieldName = elName.substring(elName.indexOf("[") + 1, elName.indexOf("]"));
+    validationObjects = [];
+    $.each(validationRules, function(i1, validationRule) {
+      var validators;
+      if (fieldName === Object.keys(validationRule)[0]) {
+        validators = validationRule[fieldName].validators;
+        return $.each(validators, function(i2, validator) {
+          var opts, valdor;
+          valdor = Object.keys(validator)[0];
+          opts = validator[Object.keys(validator)[0]];
+          return validationObjects.push({
+            validator: valdor,
+            options: opts
+          });
+        });
+      }
+    });
+    return validationObjects;
+  };
+
+  displayValidation = function($element, message) {
+    // code to display validation error message
+  };
+
+  validateField = function($element, fieldValidation, exceptions) {
+    var $el, flag, labelText, options, regex, regexString, tMsg, validationPassed, validator;
+    if (exceptions == null) {
+      exceptions = [];
+    }
+    validationPassed = true;
+    validator = fieldValidation.validator;
+    options = fieldValidation.options;
+    if ((validator === "AbsenceValidator") && ($.inArray(validator, exceptions) === -1)) {
+      if (($element.val() != null) && ($element.val() != "")) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + options.message;
+        displayValidation($element, tMsg);
+      }
+    } else if ((validator === "AcceptanceValidator") && ($.inArray(validator, exceptions) === -1)) {
+      if ($element.val().not(':checked')) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + options.message;
+        displayValidation($element, tMsg);
+      }
+    } else if ((validator === "ConfirmationValidator") && ($.inArray(validator, exceptions) === -1)) {
+      $el = $('input#' + $element.attr('id') + '_confirmation').first();
+      if ($element.val() !== $el.val()) {
+        validationPassed = false;
+        displayValidation($el, options.message);
+      }
+    } else if ((validator === "ExclusionValidator") && ($.inArray(validator, exceptions) === -1)) {
+      if ($.inArray($element.val(), options["in"]) > -1) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + options.message;
+        displayValidation($element, tMsg);
+      }
+    } else if ((validator === "FormatValidator") && ($.inArray(validator, exceptions) === -1)) {
+      regexString = options["with"].source;
+      flag = options["with"].options;
+      regex = new RegExp(regexString, flag);
+      if (!regex.test($element.val())) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + options.message;
+        displayValidation($element, tMsg);
+      }
+    } else if ((validator === "InclusionValidator") && ($.inArray(validator, exceptions) === -1)) {
+      if ($.inArray($element.val(), options["in"]) < 0) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + options.message;
+        displayValidation($element, tMsg);
+      }
+    } else if ((validator === "LengthValidator") && ($.inArray(validator, exceptions) === -1)) {
+      if ($element.val().length < options.minimum) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + (options.too_short || options.message);
+        displayValidation($element, tMsg);
+      }
+      if ($element.val().length > options.maximum) {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + (options.too_long || options.message);
+        displayValidation($element, tMsg);
+      }
+    } else if ((validator === "PresenceValidator") && ($.inArray(validator, exceptions) === -1)) {
+      if ($element.val() === "") {
+        validationPassed = false;
+        labelText = $("label[for='" + $element.attr('id') + "']").first().text();
+        tMsg = labelText + ' ' + options.message;
+        displayValidation($element, tMsg);
+      }
+    }
+    return validationPassed;
+  };
+
+
+  this.expressValidations = {
+    checkFieldValidation: function($validationField, validationRules, exceptions) {
+      var validationPassed, validationResult, fieldValidations;
+      if (exceptions == null) {
+        exceptions = [];
+      }
+      validationPassed = true;
+      validationResult = [];
+      fieldValidations = getValidationsFor($validationField, validationRules);
+      $.each(fieldValidations, function(i1, fieldValidation) {
+        var result;
+        result = validateField($validationField, fieldValidation, exceptions);
+        validationResult.push(result);
+        if (!result) {
+          return false;
+        }
+      });
+      if ($.inArray(false, validationResult) > -1) {
+        validationPassed = false;
+      }
+      return validationPassed;
+    },
+    checkFormValidation: function($form, validationRules, exceptions) {
+      var validationFields = $form.find(':input:not(:hidden):not(:button):not(:submit)');
+      var validationPassed, validationResult;
+      if (exceptions == null) {
+        exceptions = [];
+      }
+      validationPassed = true;
+      validationResult = [];
+      $.each(validationFields, function(i1, $validationField) {
+        var fieldValidations;
+        fieldValidations = getValidationsFor($validationField, validationRules);
+        return $.each(fieldValidations, function(i2, fieldValidation) {
+          var result;
+          result = validateField($validationField, fieldValidation, exceptions);
+          validationResult.push(result);
+          if (!result) {
+            return false;
+          }
+        });
+      });
+      if ($.inArray(false, validationResult) > -1) {
+        validationPassed = false;
+      }
+      return validationPassed;
+    },
+    getValidationsFor: function($element, validationRules) {
+      var elName, fieldName, validationObjects;
+      elName = $element.attr('name');
+      fieldName = elName.substring(elName.indexOf("[") + 1, elName.indexOf("]"));
+      validationObjects = [];
+      $.each(validationRules, function(i1, validationRule) {
+        var validators;
+        if (fieldName === Object.keys(validationRule)[0]) {
+          validators = validationRule[fieldName].validators;
+          return $.each(validators, function(i2, validator) {
+            var opts, valdor;
+            valdor = Object.keys(validator)[0];
+            opts = validator[Object.keys(validator)[0]];
+            return validationObjects.push({
+              validator: valdor,
+              options: opts
+            });
+          });
+        }
+      });
+      return validationObjects;
+    },
+    getValidationsForMultiple: function(validationFields, validationRules) {
+      var fieldValidations = [];
+      $.each(validationFields, function(i1, $validationField) {
+        var key = $validationField;
+        var val = getValidationsFor($validationField, validationRules);
+        fieldValidations.push({
+          field: key,
+          validations: val
+        });
+      });
+      return fieldValidations;
+    },
+    checkUniqueness: function($element, uniquenessResults) {
+      $.ajax({
+        url: "determine_uniqueness",
+        type: "get",
+        data: {
+          field: $element.attr('name'),
+          value: $element.val()
+        },
+        dataType: "json",
+        success: function(data) {
+          return uniquenessResults.push([$element, data.uniqueness]);
+        },
+        error: function(j, s, e) {
+          return window.networkError = true;
+        }
+      });
+      return uniquenessResults;
+    },
+    checkAge: function(age, validationFields, msg) {
+      var $element1, $element2, $element3, ageDate, givenDate, validationPassed;
+      validationPassed = true;
+      ageDate = new Date();
+      ageDate.setFullYear(ageDate.getUTCFullYear() - age);
+      ageDate.setMonth(ageDate.getUTCMonth());
+      ageDate.setDate(ageDate.getUTCDate());
+      $element1 = validationFields[0];
+      $element2 = validationFields[1];
+      $element3 = validationFields[2];
+      givenDate = new Date($element1.val(), $element2.val(), $element3.val());
+      if (ageDate.getTime() <= givenDate.getTime()) {
+        validationPassed = false;
+        displayValidation($element3, msg);
+      }
+      return validationPassed;
+    }
+  };
+}).call(this);

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: express_validations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vikram Anand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+description: This gem allows you to express the validations in your models as JSON
+  objects, so that you can implement them as client side validations.
+email:
+- vikram983@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- express_validations.gemspec
+- lib/express_validations.rb
+- lib/express_validations/engine.rb
+- lib/express_validations/version.rb
+- vendor/assets/javascripts/express.validations.js
+homepage: https://github.com/vikramanity/express_validations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Express the validations in your models as JSON objects.
+test_files: []