rails_ember_validations 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df12d9676acf553fcac1f09b51763133eb3dae99
-  data.tar.gz: 639d9859de2d9b49191951186f5a9c7ce0a8e7bf
+  metadata.gz: 29208c4de693622df2dbae560c321d4fc3b2a4bb
+  data.tar.gz: fe3646a91ffeb0007a71482f0c3eaf81c91ef08a
 SHA512:
-  metadata.gz: b3eb4dc1d3d2c26eb69346d7b07c2b32097397513d0ca2026c7db292197802ce9793063a2dc5ea94497a8544e0f65600b89d7b1737ff12ec964fa9a1bd959078
-  data.tar.gz: d56f739e6ecbd3ff90bc6ed7cec7fba4b0df5c15ccdbf324a4d4a321f51f0f235d38408f035142f81d4c9975ed602c1263a1190b1678d84d8db612e7fb3696ff
+  metadata.gz: 637886743a63fa3984de0bd92a794bba11b3b4c63c102dc510a51948b1e22435409df2c990bd6a1183dd7b4bce3b331befe44fc7d6928ee366d48981ba076ce1
+  data.tar.gz: dc5f355f8c8a1a6c42968a3ee2d6ebcae78f5a00da650008670f68d053ac8b975b1531d4c637e827f69b8c0d44791527ee6e800d6e76a2acb1d68a5fefc134bc

data/README.md

@@ -1,6 +1,15 @@
 # RailsEmberValidations
 
-TODO: Write a gem description
+Rails_ember_validations is a gem for server-side validations in your forms.
+Its use is for validations only, it will not process any actions, its up to you to handle the responce.
+
+This gem was created for json responces  with validation and authorization errors.
+
+Although it is designed for functionality with ember.js , you can still use it with
+anything you want.
+
+
+Rails_ember_validations for ember use, works only with ember-data and it will fail if you use anything else for client persistence.
 
 ## Installation
 
@@ -16,9 +25,114 @@ Or install it yourself as:
 
     $ gem install rails_ember_validations
 
+For ember use , add 
+
+//= require validation-view
+
+in your application.js file, after the rest of ember files.
+
 ## Usage
+GENERAL
+
+
+
+Just make a post request at /validate.json , passing your params as {"object_to_validate"=>{"attr1"=>"something", "attr2"=>"something",... }}
+
+Example:
+
+{"user"=>{"role"=>"administrator", "name"=>"User1", "id"=>"1"}}
+
+If you sent an id in object's attributes ,server will validate it as new, else as update.
+
+Server will validate ANY attribute , based on validations defined in the appropriate model.
+Server will also authorize your object (using CanCan's authorize! method), if you use CanCan, else it will just proceed 
+in  validation check.
+
+Responce for validation errors will be : {"attr1"=> [array_of_errors_for_attr1], "attr2"=> [array_of_errors_for_attr2],... }}
+
+Example:
+
+{"password":["can't be blank","Weak Password"],"name":["can't be blank"]}
+
+EMBER.JS
+
+
+
+Simply include App.ValidationView at the top of your form.
+
+
+
+Include any input you may have in a div with id {attribute}Validation
+To see the error , call view.{attribute}Validation in an if view.{attribute}Validation block
+
+Authorization errors are displayed by calling view.authorizationValidation in an if view.authorizationValidation block.
+
+For example in the following form we get authorization errors at the top of our form and validation errors for name attribute spanned to our input element . 
+
+{{#view App.ValidationView }}
+	{{#if view.authorizationValidation}}
+
+	    <div class="alert alert-error">
+
+			{{view.authorizationValidation}}
+
+		</div>
+
+	{{/if}}
+
+	<div id="nameInput" class="form-group">
+
+		<span>First Name </span>
+
+		{{input value=email type="text"}}
+
+		{{#if view.nameValidation}}
+			<div class="alert alert-error">
+				{{view.nameValidation}}
+			</div>
+
+		{{/if}}		
+	</div>
+
+{{/view}}
+
+
+When server returns errors (if any) , validationView will try to find divs with id named after the error attributes.
+It will add 'has-error' class at them, so if you'd like you can overide this class' styling .
+
+If server returns no errors, view will trigger the save action of current controller, so place any logic following a valid request there.
+ValidationView also comes with a cancel action embedded that rollsback any changes to record you were editing or deletes it if it was new.
+
+
+Excluding model properties
+
+When you have extra properties in your model that you don't want to be sent for validation, you can add inside your model a property array named excludedProperties and add any property that wont be sent for validation.
+
+Example:
+
+
+
+App.User = DS.Model.extend({
+
+  email: DS.attr('string'),
+  name: DS.attr('string'),
+  surname: DS.attr('string'),
+
+  can_edit: DS.attr('boolean'),
+  can_delete: DS.attr('boolean'),
+  can_read: DS.attr('boolean'),
+  can_manage: DS.attr('boolean'),
+  can_create: DS.attr('boolean'),
+
+  excludedProperties: ['can_edit', 'can_delete', 'can_read', 'can_manage', 'can_create'],
+
+});
+
+In the above when a user record is sent for validation , only name, surname and email are sent. Everything in excludedProperties is not.
+
+
+
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/generators/rails_ember_validations/install_generator.rb

@@ -1,6 +1,6 @@
 require 'rails/generators/base'
 module RailsEmberValidations
-  class InstallGenerator < Rails::Generators::NamedBase
+  class InstallGenerator < Rails::Generators::Base
 
 
 

data/lib/rails_ember_validations/version.rb

@@ -1,3 +1,3 @@
 module RailsEmberValidations
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_ember_validations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexandros M
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,15 +50,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/rails_ember_validations.rb
-- lib/rails_ember_validations/version.rb
-- rails_ember_validations.gemspec
-- app/controllers/rails_ember_validations/validations_controller.rb
 - app/assets/javascripts/validation-view.js
+- app/controllers/rails_ember_validations/validations_controller.rb
 - config/routes.rb
-- lib/rails_ember_validations/engine.rb
 - lib/generators/rails_ember_validations/USAGE
 - lib/generators/rails_ember_validations/install_generator.rb
+- lib/rails_ember_validations.rb
+- lib/rails_ember_validations/engine.rb
+- lib/rails_ember_validations/version.rb
+- rails_ember_validations-0.0.1.gem
+- rails_ember_validations.gemspec
 homepage: ''
 licenses:
 - MIT
@@ -84,4 +85,3 @@ signing_key:
 specification_version: 4
 summary: Server side validations
 test_files: []
-has_rdoc: