comply 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 722d89b836f206876be44dad520abe01f66f83d7
+  data.tar.gz: 1d4f4a587d745cf3defa6c0c28404dc894d92a00
+SHA512:
+  metadata.gz: 242e7876ee58be0be396eba9a9c7f10f8e1a9083dfcefa0e4c309a659cf4441418b00a04de08f4bc9e19ab74568f38a9b6e059b421e84100cce216d81ea1706a
+  data.tar.gz: e22103b29fd7020d029cae89c4dcac823b3052ff2229c1308499286f172adf69fa492f0cc397c3ec083e189321c7cb64b84fe10576c1c6d7d744566f8de13cb7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,162 @@
+# Comply
+Server-side ActiveRecord validations, all up in your client-side HTML.
+
+## Intention and Purpose
+Rendering the same page over and over due to validations is a slow and unpleasant user experience. The logical alternative is, of course, validating the form on the page, before it is submitted.
+
+Though it's better, doing that still requires duplicating your validations on the client and server. Any time you change a validation in one place, it must be changed in the other as well. In addition, some validations require hitting the server and database, for example validating the uniqueness of an email address.
+
+The solution offered here is combine the server-side validations with inline error messages on the form. This is done by creating an API for validating your objects. When triggered, the form is serialized and sent to the API endpoint, where it is instantiated as your ActiveRecord model, and validations are run. The API returns the instance's error messages, which the form uses to determine if the described object is valid.
+
+## Basic Usage
+Include Comply in your gemfile:
+```ruby
+gem 'comply'
+```
+If you are using Rails 3, you need to include `strong_parameters`
+```ruby
+gem 'comply'
+gem 'strong_parameters'
+```
+Mount the engine in your `routes.rb`:
+```ruby
+mount Comply::Engine => '/comply'
+```
+Require the javascript files & dependencies in the form's corresponding javascript file (requires Asset Pipeline):
+```js
+//= require jquery
+//= require comply
+```
+
+In your form:
+Add the `data-validate-model` tag to your form tag with the name of the model you intend to validate:
+```erb
+<%= form_for @movie, html: { data: { validate_model: 'movie' } } do |f| %>
+```
+On the input tags you want validated, add the `data-validate` tag:
+```erb
+<div class="field">
+  <%= f.label :title %><br>
+  <%= f.text_field :title, data: { validate: true } %>
+</div>
+<div class="field">
+  <%= f.label :description %><br>
+  <%= f.text_area :description, data: { validate: true } %>
+</div>
+```
+
+Of course, this all assumes you have ActiveRecord validations set up in your model:
+```ruby
+class Movie < ActiveRecord::Base
+  validates :title, presence: true, uniqueness: true
+  validates :desciption, presence: true
+end
+```
+
+## Customizations
+You can control the behavior of your validatable forms and inputs in a variety of ways.
+
+### Validation route
+You can specify the route to be used for validation on the form by setting the `data-validate-route` attribute.
+```erb
+<%= form_for @movie, html: { data: { validate_model: 'movie', validate_route: custom_validation_path } } do |f| %>
+```
+
+### Success messages
+Want success messages to add some personality to your forms? Add the message as the `data-validate-success` attribute.
+```erb
+<%= f.text_field :title, data: { validate: true, validate_success: "Sweet title yo!" } %>
+```
+
+### Event triggers
+You can change the jQuery event which triggers the input validation with the `data-validate-event` attribute.
+```erb
+<%= f.text_field :description, data: { validate: true, validate_event: 'click' } %>
+```
+Note: the default event is `input keyup`.
+
+### Timeouts
+You can delay validation by setting the `data-validate-timeout` attribute. This is great for things like checking a string's format so that it won't validate until the user has had a chance to finish typing.
+```erb
+<%= f.text_field :description, data: { validate: true, validate_timeout: 1000 } %>
+```
+Note: the amount is in milliseconds, and the default amount is 500 milliseconds.
+
+### Validation dependencies
+Sometimes you have two fields that you want to validate at the same time. You can ensure they will be serialized and validated together using the `data-validate-with` attribute, which takes the jQuery selector of the dependent object. This can be useful for things like confirmation fields.
+```erb
+<%= f.label :password %>
+<%= f.password_field :password, class: "span6" %>
+
+<%= f.label :password_confirmation %>
+<%= f.password_field :password_confirmation, data: { validate: true, validate_with: '#user_password' } %>
+```
+
+### Multiparameter attributes
+Want to validate multiple fields as one like a multiparameter attribute? Add the `data-multiparam` attribute to your inputs. This is great for multivalue fields like dates.
+```erb
+<%= f.date_select :release_date, {}, data: { validate: true, multiparam: 'release_date' } %>
+```
+
+#### Forcing validations on multiparameters
+Normally, a multiparameter input won't validate until all of its fields have been completed. If you want to override that, you can set the `data-validate-force` attribute. This is good if you don't want to represent your multiparameter fields as one unit.
+```erb
+<%= f.date_select :release_date, { order: [:month, :day] }, data: { validate: true, multiparam: 'release_date' } %>
+<%= f.text_field :'release_date(1i)', id: 'release_date_1i', data: { validate: true, multiparam: 'release_date', validate_force: true } %>
+```
+
+## Customizing the ValidationMessage class
+If you don't want to use the default `Comply.ValidationMessage`, which is responsible for putting the validation message tag on the page and handling the display of messages, great news: you can overwrite it!
+
+After you've included Comply in the Asset Pipeline, feel free to extend it! For example (in `foo.js.coffee`):
+```coffeescript
+class Comply.ValidationMessage extends Comply.BaseValidationMessage
+  constructor: (@$el) ->
+    super
+    console.log 'We can build him. We have the technology.'
+
+  successMessage: (message = '') ->
+    super
+    console.log 'All systems go.'
+
+  errorMessage: (message = '') ->
+    super
+    console.log 'Houston, we have a problem.'
+
+  resetMessage: (message) ->
+    super
+    console.log 'Mulligan!'
+```
+
+## Mounting the engine elsewhere
+If you would like to mount the engine under a different namespace, all you need to do is add the engine path to the javascript object:
+
+```ruby
+# routes.rb
+mount Comply::Engine => '/joanie_loves_chachi'
+```
+```javascript
+//= require comply
+
+Comply.enginePath = 'joanie_loves_chachi';
+```
+
+## Customizing Validation Behavior
+You can override the validation behavior by inheriting from `Comply::ValidationsController`. This can be useful for cases like forms which update specific attributes of an instance.
+
+For example, if you have a "change email" form, and you want to validate the email's uniqueness against the current user, you can override the `validation_instance` method on `Comply::ValidationsController`, set corresponding routes, and add the `data-validate-route` attribute to your form.
+```ruby
+# my_validations_controller.rb
+class MyValidationsController < Comply::ValidationsController
+  def validation_instance
+    current_user.attributes = @fields
+    current_user
+  end
+end
+
+# routes.rb
+match 'validations' => 'my_validations#show', only: :show, as: :my_validation
+```
+```erb
+<%= form_for @movie, html: { data: { validate_model: 'movie', validate_route: my_validation_path } } do |f| %>
+```

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Comply'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/comply/base_validation_message.js.coffee

@@ -0,0 +1,21 @@
+class Comply.BaseValidationMessage
+  constructor: (@$el) ->
+    if multiparam = @$el.data('multiparam')
+      selector = "[data-multiparam=#{multiparam}].validation-msg"
+      @$el.parent().append("<div data-multiparam='#{multiparam}' class='validation-msg'></div>") unless $(selector).length
+      @$messageField = $(selector)
+    else
+      @$el.after("<div class='validation-msg'></div>")
+      @$messageField = @$el.siblings('.validation-msg')
+
+  successMessage: (message = '') ->
+    @resetMessage message
+    @$messageField.addClass 'success'
+
+  errorMessage: (message = '') ->
+    @resetMessage message
+    @$messageField.addClass 'error'
+
+  resetMessage: (message) ->
+    @$messageField.html message
+    @$messageField.removeClass 'error success'

data/app/assets/javascripts/comply/config.js.coffee

@@ -0,0 +1,3 @@
+window.Comply = {
+  enginePath: 'comply',
+}

data/app/assets/javascripts/comply/index.js.coffee

@@ -0,0 +1,4 @@
+#= require comply/config
+#= require_tree .
+
+$ -> $('[data-validate-model]').each -> new Comply.ValidatableForm $(this)

data/app/assets/javascripts/comply/validatable_form.js.coffee

@@ -0,0 +1,38 @@
+class Comply.ValidatableForm
+  constructor: (@$form) ->
+    @inputs          = @_inputs()
+    @model           = @$form.data('validate-model')
+    @$button         = @$form.find('[type=submit]')
+    @validationRoute = @$form.data('validate-route') or "/#{Comply.enginePath}/validations"
+    @$button.click @validateInputs
+    @$button.attr('disabled', false).removeClass('disabled')
+
+  validateInputs: (event) =>
+    event.preventDefault()
+    @validate inputs: @inputs, submit: true
+
+  validate: (options) ->
+    $.get @validationRoute, @_params(), (response) =>
+      return @$form.submit() if options.submit and @_allSuccess(response)
+      @_setMessages(options.inputs, response)
+
+  # private
+
+  _setMessages: (inputs, response) =>
+    for input in inputs
+      status = @_isSuccess(input, response)
+      input.setMessage status, @_responseValue(input, response, status)
+
+  _allSuccess: (response) -> not (err for field, err of response.error when err.length).length
+
+  _inputs: ->
+    for input in @$form.find('[data-validate][name]')
+      new Comply.ValidatableInput $(input), this
+
+  _isSuccess: (input, response) ->
+    if !!@_responseValue(input, response) then 'error' else 'success'
+
+  _params: -> "#{$.param(model: @model)}&#{@$form.serialize()}"
+
+  _responseValue: (input, response, status = 'error') ->
+    if response[status]? then response[status][input.attrName]

data/app/assets/javascripts/comply/validatable_input.js.coffee

@@ -0,0 +1,41 @@
+class Comply.ValidatableInput
+  constructor: (@$el, @form) ->
+    parts          = @$el.attr('name').replace(/\]/g, '').split('[')
+    @model         = parts[0]
+    @attrName      = parts[parts.length - 1].split('(')[0]
+    @event         = @$el.data('validate-event') or 'input keyup'
+    @timeoutLength = @$el.data('validate-timeout') or 500
+    @successMessage = @$el.data('validate-success')
+    @dependency    = @_dependency()
+    @message       = new Comply.ValidationMessage @$el
+    @$el.bind @event, @validate
+
+  validate: =>
+    if @_validatable()
+      clearTimeout @timeout
+      @timeout = setTimeout @_submitValidations, @timeoutLength
+
+  setMessage: (status, message) ->
+    message = @successMessage if status is 'success'
+    @message["#{status}Message"] message
+
+  #private
+
+  _dependency: ->
+    new Comply.ValidatableInput($("#{@$el.data('validate-with')}[name]"), @form) if @$el.data('validate-with')?
+
+  _forceValidate: -> @forceValidate or= @$el.data('validate-force')
+
+  _multiparam: -> @multiparam or= @$el.data('multiparam')
+
+  _multiparamFields: ->
+    field for field in $("[data-multiparam=#{@_multiparam()}]") when field isnt @$el[0]
+
+  _$multiparamFields: ->
+    @$multiparamFields or= $(field) for field in @_multiparamFields()
+
+  _submitValidations: => @form.validate inputs: (el for el in [this, @dependency] when el)
+
+  _validatable: ->
+    return true if @_forceValidate() or not @_multiparam()
+    !($el for $el in @_$multiparamFields() when !$el.val().length).length

data/app/assets/javascripts/comply/validation_message.js.coffee

@@ -0,0 +1 @@
+class Comply.ValidationMessage extends Comply.BaseValidationMessage

data/app/controllers/comply/application_controller.rb

@@ -0,0 +1,5 @@
+module Comply
+  class ApplicationController < ActionController::Base
+    include ::SslRequirement
+  end
+end

data/app/controllers/comply/validations_controller.rb

@@ -0,0 +1,33 @@
+module Comply
+  class ValidationsController < Comply::ApplicationController
+    ssl_allowed :show
+
+    before_filter :require_model, :require_fields
+
+    def show
+      @instance = validation_instance
+      @instance.valid?
+      render json: { error: @instance.errors }
+    end
+
+    private
+
+    def validation_instance
+      @model.new(post_params)
+    end
+
+    def post_params
+      params.require(params[:model].to_sym).permit!
+    end
+
+    def require_fields
+      @fields = params[params[:model].downcase]  if params[params[:model].downcase].present?
+      render json: { error: 'Form fields not found' }, status: 500 unless @fields
+    end
+
+    def require_model
+      @model = params[:model].classify.constantize if params[:model].present?
+      render json: { error: 'Model not found' }, status: 500 unless @model
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Comply::Engine.routes.draw do
+  match '/validations' => 'validations#show', via: :get
+end

data/lib/comply/engine.rb

@@ -0,0 +1,5 @@
+module Comply
+  class Engine < ::Rails::Engine
+    isolate_namespace Comply
+  end
+end

data/lib/comply/version.rb

@@ -0,0 +1,3 @@
+module Comply
+  VERSION = '1.0.0'
+end

data/lib/comply.rb

@@ -0,0 +1,5 @@
+require 'comply/engine'
+require 'ssl_requirement'
+
+module Comply
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: comply
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- '@jacobaweiss'
+- '@andyjbas'
+- '@azach'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bartt-ssl_requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jasmine-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validate your ActiveRecord models on the client, showing their error
+  and success messages by providing a validation controller.
+email:
+- jack@lumoslabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/comply/base_validation_message.js.coffee
+- app/assets/javascripts/comply/config.js.coffee
+- app/assets/javascripts/comply/index.js.coffee
+- app/assets/javascripts/comply/validatable_form.js.coffee
+- app/assets/javascripts/comply/validatable_input.js.coffee
+- app/assets/javascripts/comply/validation_message.js.coffee
+- app/controllers/comply/application_controller.rb
+- app/controllers/comply/validations_controller.rb
+- config/routes.rb
+- lib/comply/engine.rb
+- lib/comply/version.rb
+- lib/comply.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://www.github.com/lumoslabs/comply
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Inline validation of your ActiveRecord models via the AJAX internets
+test_files: []