github-migration/cocoon
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

add data-association-insertion-method

Browse Source 
the -position data attribute doesn't really "make sense" when adding
the "append" or "prepend" methods. those aren't "positions".  I try to
be grammatically correct. :)
This commit is contained in:
Matte Edens 2011-12-06 12:03:25 -08:00
parent 0e52731827
commit 4563b685be
2 changed files with 40 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.markdown
View File

@ -118,7 +118,7 @@ I will provide a full example (and a sample project) later.
I define two helper functions: I define two helper functions:
### link_to_add_association ### `link_to_add_association`
This function will add a link to your markup that will, when clicked, dynamically add a new partial form for the given association. This function will add a link to your markup that will, when clicked, dynamically add a new partial form for the given association.
This should be placed below the `semantic_fields_for`. This should be placed below the `semantic_fields_for`.
@ -129,14 +129,16 @@ It takes four parameters:
- f: referring to the containing form-object - f: referring to the containing form-object
- association: the name of the association (plural) of which a new instance needs to be added (symbol or string). - association: the name of the association (plural) of which a new instance needs to be added (symbol or string).
- html_options: extra html-options (see `link_to`) - html_options: extra html-options (see `link_to`)
There are two extra options that allow to conrol the placement of the new link-data: There are three extra options that allow to control the placement of the new link-data:
- `data-association-insertion-node` : the jquery selector of the node - `data-association-insertion-node` : the jquery selector of the node
- `data-association-insertion-position` : insert the new data `before` or `after` the given node. - `data-association-insertion-method` : jquery method that inserts the new data. `before`, `after`, `append`, `prepend`, etc. Default: `before`
- `data-association-insertion-position` : old method specifying where to insert new data.
- this setting still works but `data-association-insertion-method` takes precedence. may be removed in a future version.
Optionally you could also leave out the name and supply a block that is captured to give the name (if you want to do something more complicated). Optionally you could also leave out the name and supply a block that is captured to give the name (if you want to do something more complicated).
### link_to_remove_association ### `link_to_remove_association`
This function will add a link to your markup that will, when clicked, dynamically remove the surrounding partial form. This function will add a link to your markup that will, when clicked, dynamically remove the surrounding partial form.
This should be placed inside the partial `_<association-object-singular>_fields`. This should be placed inside the partial `_<association-object-singular>_fields`.
@ -158,7 +160,7 @@ be handed down as follows:
### Callbacks (upon insert and remove of items) ### Callbacks (upon insert and remove of items)
There is an option to add a callback on insertion or removal. If in your view you have the following snippet to select an `onwer` There is an option to add a callback on insertion or removal. If in your view you have the following snippet to select an `owner`
(we use slim for demonstration purposes) (we use slim for demonstration purposes)
#owner #owner
@ -188,20 +190,20 @@ Do note that for the callbacks to work there has to be a surrounding container (
### Control the Insertion behaviour ### Control the Insertion behaviour
The default insertion location is at the back of the current container. But we have added two `data`-attributes that are read to determine the insertion-node and -location. The default insertion location is at the back of the current container. But we have added two `data`-attributes that are read to determine the insertion-node and -method.
For example: For example:
$(document).ready(function() { $(document).ready(function() {
$("#owner a.add_fields"). $("#owner a.add_fields").
data("association-insertion-position", 'before'). data("association-insertion-method", 'before').
data("association-insertion-node", 'this'); data("association-insertion-node", 'this');
}); });
The `association-insertion-node` will determine where to add it. You can choose any selector here, or specify this (default it is the parent-container). The `association-insertion-node` will determine where to add it. You can choose any selector here, or specify this (default it is the parent-container).
The `association-insertion-position` will determine where to add it in relation with the node. Only two options: `before` or `after`. The `association-insertion-method` will determine where to add it in relation with the node. Any jQuery DOM Manipulation method can be set but we recommend sticking to any of the following: `before`, `after`, `append`, `prepend`. It is unknown at this time what others would do.
### Partial ### Partial
@ -224,7 +226,7 @@ There is no limit to the amount of nesting, though.
## Todo ## Todo
* add more sample relations: has_many :through, belongs_to, ... * add more sample relations: `has_many :through`, `belongs_to`, ...
* improve the tests (test the javascript too)(if anybody wants to lend a hand ...?) * improve the tests (test the javascript too)(if anybody wants to lend a hand ...?)
## Copyright ## Copyright

56
app/assets/javascripts/cocoon.js
View File

@ -11,56 +11,58 @@
$('.add_fields').live('click', function(e) { $('.add_fields').live('click', function(e) {
e.preventDefault(); e.preventDefault();
var assoc = $(this).data('association'), var $this = $(this),
assocs = $(this).data('associations'), assoc = $this.data('association'),
content = $(this).data('template'), assocs = $this.data('associations'),
insertionPosition = $(this).data('association-insertion-position'), content = $this.data('template'),
insertionNode = $(this).data('association-insertion-node'), insertionMethod = $this.data('association-insertion-method') || $this.data('association-insertion-position') || 'before';
insertionCallback = $(this).data('insertion-callback'), insertionNode = $this.data('association-insertion-node'),
removalCallback = $(this).data('removal-callback'), insertionCallback = $this.data('insertion-callback'),
regexp_braced = new RegExp('\\[new_' + assoc + '\\]', 'g'), removalCallback = $this.data('removal-callback'),
regexp_underscord = new RegExp('_new_' + assoc + '_', 'g'), regexp_braced = new RegExp('\\[new_' + assoc + '\\]', 'g'),
new_id = new Date().getTime(), regexp_underscord = new RegExp('_new_' + assoc + '_', 'g'),
newcontent_braced = '[' + new_id + ']', new_id = new Date().getTime(),
newcontent_braced = '[' + new_id + ']',
newcontent_underscord = '_' + new_id + '_', newcontent_underscord = '_' + new_id + '_',
new_content = content.replace(regexp_braced, '[' + new_id + ']'); new_content = content.replace(regexp_braced, '[' + new_id + ']');
if (new_content == content) { if (new_content == content) {
regexp_braced = new RegExp('\\[new_' + assocs + '\\]', 'g'); regexp_braced = new RegExp('\\[new_' + assocs + '\\]', 'g');
regexp_underscord = new RegExp('_new_' + assocs + '_', 'g'); regexp_underscord = new RegExp('_new_' + assocs + '_', 'g');
new_content = content.replace(regexp_braced, '[' + new_id + ']'); new_content = content.replace(regexp_braced, '[' + new_id + ']');
} }
new_content = new_content.replace(regexp_underscord, newcontent_underscord); new_content = new_content.replace(regexp_underscord, newcontent_underscord);
if (insertionNode){ if (insertionNode){
insertionNode = insertionNode == "this" ? $(this) : $(insertionNode); insertionNode = insertionNode == "this" ? $this : $(insertionNode);
} else { } else {
insertionNode = $(this).parent(); insertionNode = $this.parent();
} }
var contentNode = $(new_content); var contentNode = $(new_content);
if (insertionPosition == 'after'){ // allow any of the jquery dom manipulation methods (after, before, append, prepend, etc)
insertionNode.after(contentNode); // to be called on the node. allows the insertion node to be the parent of the inserted
} else { // code and doesn't force it to be a sibling like after/before does. default: 'before'
insertionNode.before(contentNode); insertionNode[insertionMethod](contentNode);
}
$(this).parent().trigger('insertion-callback'); $this.parent().trigger('insertion-callback');
}); });
$('.remove_fields.dynamic').live('click', function(e) { $('.remove_fields.dynamic').live('click', function(e) {
trigger_removal_callback($(this)); var $this = $(this);
trigger_removal_callback($this);
e.preventDefault(); e.preventDefault();
$(this).closest(".nested-fields").remove(); $this.closest(".nested-fields").remove();
}); });
$('.remove_fields.existing').live('click', function(e) { $('.remove_fields.existing').live('click', function(e) {
trigger_removal_callback($(this)); var $this = $(this);
trigger_removal_callback($this);
e.preventDefault(); e.preventDefault();
$(this).prev("input[type=hidden]").val("1"); $this.prev("input[type=hidden]").val("1");
$(this).closest(".nested-fields").hide(); $this.closest(".nested-fields").hide();
}); });
})(jQuery); })(jQuery);