rails_ajax_formhandler 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a299fae46deed71657ddd8d96ab542fa7eedb2ca
-  data.tar.gz: 401ac99e6507a57a31100255f2c66da3d05f900c
+  metadata.gz: 4980edcc055fa4f4483d16075696fdf4b67ada19
+  data.tar.gz: d11f00cf24ad09b51206f430b381d5d4cee5983f
 SHA512:
-  metadata.gz: 1711b334fe66fc58bb3ca7d3200a671742b3578ffb44d3647ec50692c3ccf93933effdd9284aa22cea3338a31e11a5c766d67480cf193eda65047e28c060aee6
-  data.tar.gz: ed4f4479dfd08e6ed65487e987a8533df4a5a53d447ebe4da37ce912c18897356b60269b0557b0b49a98dc370ef1c020d284516d82f4e006abb167abcdf1d79c
+  metadata.gz: 0b65a51e35d16001838f5f6d241126a96f93e66f1a04a6a1f379d0ee2641e125b82835aba892da354cc3647d01a7362ad0c83c3e27a2693add6da928a9f75739
+  data.tar.gz: 7648402f5e8429e1834da25ac3c39e31f56de7fcb3ddce6cd2600f908afba1ff40eca87574555007176aa2c3eacc0390865c8b100b8f4422bc6be8d92331ff86

data/README.md

@@ -52,6 +52,9 @@ $(document).ready(function{
 });
 
 ```
+I'll automatically detects your form and set an event-listener, so the form will be submitted with ajax.
+
+__Please note that in order to work, use the "form_for"-helper in your view as usual!__
 
 ## Global Options
 
@@ -60,8 +63,8 @@ $(document).ready(function{
 
 ## HTML
 
-html
-an object
+### html
+ accepts an object with the keys shown below
 
 ```javascript
 {
@@ -83,23 +86,27 @@ or, if you're using Bootstrap Version 3
 }
 ```
 
+
 ## Callbacks
 
-success 	 
-a function with the with jqXHR as first, the form-object as second and the event as third argument
+all callbacks accepting only a function	
+
+### success 	 
+
+jqXHR as first, the form-object as second and the event as third argument
 
 
 ```javascript
 { ...
 	success:	function(xhr, form, event) {
-	// what happens after successfull submit
+	// what happens after success
 	}
 }
 ```
 
 
-error  
-function with jqXHR as first, the errorThrown(string) as second, the form-object as third and the event as forth argument
+### error  
+jqXHR as first, the errorThrown(string) as second, the form-object as third and the event as forth argument
 
 
 ```javascript
@@ -110,8 +117,8 @@ function with jqXHR as first, the errorThrown(string) as second, the form-object
 }
 ```
 
-send  
-function with the event only argument, will be called on submit
+### send  
+event as only argument, will be called on submit
 
 
 ```javascript
@@ -122,7 +129,7 @@ function with the event only argument, will be called on submit
 }
 ```
 
-Example:
+### *Example:*
 
 
 ```javascript
@@ -132,7 +139,8 @@ Example:
 	helpBlockClass: "my-help-block"
 	},
 	success:	function(xhr, form, event) {
-		$("#succes-message").html("Form successfully submitted")
+		$("#success-message").html("Form successfully submitted");
+		form[0].reset();
 	}
 }
 ```
@@ -147,7 +155,7 @@ def create
  if @client.save
   f.json { render :show, status: :created}
  else
- 	f.json { render json: @client.errors, status: :unprocessable_entity }
+  f.json { render json: @client.errors, status: :unprocessable_entity }
  end  
 end
 
@@ -156,13 +164,26 @@ def update
  if @client.update(client_params)
   f.json { render :show, status: :ok}
  else
- 	f.json { render json: @client.errors, status: :unprocessable_entity }
- end
-  
+  f.json { render json: @client.errors, status: :unprocessable_entity }
+ end  
 end
 
 ```
 
+_Note_ that the json response in case of error works only if the json-string contains only the errors-object, or, if namespacing is required, the object name as key and the errors as values.
+
+```ruby 
+	f.json { render _json: @client.errors_, status: :unprocessable_entity }
+
+```
+or
+
+```ruby 
+	f.json { render _json: { client: @client.errors, data: "some other stuff"}_, status: :unprocessable_entity }
+
+```
+That gives you the possibility, passing some other informations alongside the errors-object, if required.
+
 ## Model
 
 Insert your validations in the model and pass your error-messages like:
@@ -173,17 +194,13 @@ validates :firstname, presence: { message: "We need your firstname!"}
 
 ```
 
-If you're not familiar with, please refer to [guides.rubyonrails](http://guides.rubyonrails.org/active_record_validations.html).
+If you're not familiar with, please refer to [http://guides.rubyonrails.org](http://guides.rubyonrails.org/active_record_validations.html).
 
 
 ## Multiple Forms
 
-<<<<<<< HEAD
 If you have two or more forms on one page, FormHandler detects them all and sets them up. The passed arguments will be applied to each form. For specific configuration, call the ".config_form()"
-=======
-If you have two or more forms on one page, FormHandler detects them all and sets them up. The passed arguments will be applied to each for. For specific configuration, call the ".config_form()"
->>>>>>> 9d6f3ee23dfee4cef6f8454363e58dd9d7624de3
- method:
+method:
 
  ```javascript
  
@@ -198,8 +215,33 @@ If you have two or more forms on one page, FormHandler detects them all and sets
  })
 
  form_handler.init();
-
  ```
+## Hidden fields
+
+In some cases the input-field shown in the form doesn't store the actual value, but updates a hidden_field, which will be submitted.For example, a datepicker:
+
+![datepicker](https://raw.githubusercontent.com/brancadavide/rails_ajax_formhandler/master/input_datepicker.png)
+
+would look like
+
+
+```ruby
+...
+<div class="field">
+<input type="text" class="datepicker" id="datepicker-input">
+
+<%= f.hidden_field :date_of_birth %>
+</div>
+```
+
+In this case please make sure that the hidden-input appears _after_ the 'dummy-field', like in the example above in order to render validation errors properly!
+
+
+## Support
+
+I hope this usefull for you as it is for me. If there are any issues, pleas contact me [info@yield-in.de](info@yield-in.de)
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rails_ajax_formhandler/version.rb

@@ -1,3 +1,3 @@
 module RailsAjaxFormhandler
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/vendor/assets/javascripts/ajax_formhandler.js

@@ -3,6 +3,7 @@
 /*
 Form-Handler by Davide Brancaccio
 
+
 FormHandler submits your form automatically via ajax and handles validation-rendering also by adding error-styles and messages.
 This works without any additional setup with standard-rails scaffold forms and controllers, just by adding validations to the model.
 
@@ -28,6 +29,18 @@ Example scaffold 'Client':
 
 				...
 
+	show.json.jbuilder
+
+					...
+					json.extract! @client, :id,:firstname,:lastname,...
+
+				<or if namespacing is required>
+
+					json.set! :client do |client|
+							client.extract! @client, :id,:firstname,:lastname,...
+					end
+					....
+
 	_form.html.erb
 
 				...
@@ -86,7 +99,97 @@ Example scaffold 'Client':
 	
 					}
 
+	as example:
+	----------
+							var form_handler = new FormHandler({
+										html: {
+												errorClass: "my-error-class",
+												helpBlockClass: "error-feedback"
+										},
+										success: function(xhr, form, event) {
+											var response = xhr.responseJSON;
+											$(form)....
+										}
+							})
+
+							form_handler.init();
+	
+	--------------------------------------------------------------------------------------------------------------
+
+	Multiple Form Support
+	----------------------
+
+	If you use more than one form on one page, FormHandler detects it automatically and applies given options to all forms.
+	So your settings become global. To specify the options for every single form just use the 'config_form()' method and provide
+	the form-name, for eexample "client" and the specified options like
+
+			form_handler.config_form('client', {
+					success: function(xhr, form, event) {
+							...do anything else
+					}
+			})
+	
+	if, for some reasons, you don't want to FormHandler to take care of one or some forms, just pass ' ignore: true':
+
+			form_handler.config_form('client', {
+					ignore: true
+					}
+			});
+
+
+	Redirections
+	-------------
+
+	In some cases, the shown input field is not actually the field meant to be submitted, instead the value is stored in an hidden input.
+	For example when you use datepicker or typeahead.
+
+	Because FormHandler takes advantage of rails-naming-convention, it is looking for the hidden input-field. 
+	To work properly, the hidden-input musst be of course inside a wrapper and must appear after the 'dummy-input'.
+
+	But if you try to edit the record, the existing value doesn't show up either, if you haven't done any workarounds.
+
+
+	To make sure that the validation-rendering works reliable and the value is shown also on your edit-form, use the 
+	'apply_validation_to()' method. 
+
+	Example
+	-------
+
+	_form.html.erb
+					....
+					<input type="text" id="date_show" class="any-datepicker">
+					<%= f.hidden_field :date_of_birth %>
+					....
+
+	client.js 
+						var form_handler = new FormHandler({
+										html: {
+												errorClass: "my-error-class",
+												helpBlockClass: "error-feedback"
+										},
+										success: function(xhr, form, event) {
+											var response = xhr.responseJSON;
+											$(form)....
+										}
+							});
+
+							form_handler.apply_validation_to("client",{
+								"client_date_of_birth": "date_show"
+							})
+
+							form_handler.init();
+
+or even easier with data-attribute:
+		
+
+		_form.html.erb
+					....
+					<input type="text" id="date_show" class="any-datepicker">
+					<%= f.hidden_field :date_of_birth, data: {validation: "date_show"} %>
+					....
+
 
+PLEASE NOTE THAT VALIDATION-RENDERING NOT WORKING WITH NESTED ATTRIBUTES, AT LEAST NOT WITHOUT ANY WORKAROUNDS!
 
 */
 
@@ -373,7 +476,6 @@ FormObject.prototype.get_ajax_settings = function(event,values) {
 			var field = $("#" + value); 
 			form_object.validation_renderer.remove_error(field);
 		})
-		this.form[0].reset();
 	};
 
 	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_ajax_formhandler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Davide Brancaccio
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- input_datepicker.png
 - input_validation_example1.png
 - input_validation_example2.png
 - lib/.DS_Store