cocoon/History.md

# Change History / Release Notes


## Version 1.1.0

* BREAKING: the triggered javascript events `removal-callback`, `after-removal-callback`, and `insertion-callback` are renamed to the more correct and symmetric
  `cocoon:after-insert, cocoon:before-insert, cocoon:after-remove, cocoon:before-remove`. Also the events are namespaced to prevent collisions with other libraries.
* allow created objects to be decorated with a callable. This is especially useful if you are using Draper or some decorator instead of the plain model in your views.
* it is now possible to specify a relative node, and use standard jquery traversal methods on insertion
* trigger insertion event on correct `insertionNode`
* thanks to #90 cocoon now supports non-AR associations and array-fields, you just have to supply your own `build_<association>` methods

I would really really like to thank all contributors, check them out https://github.com/nathanvda/cocoon/graphs/contributors
They made cocoon way more awesome than I could have done in my lonesome.

## Version 1.0.22

* Fix that it still works for mongoid

## Version 1.0.21

* Use association build methods instead of assoc.klass.new. This avoids mass-assignment errors and other misbehaviors around attribute accessibility.


## Version 1.0.20

* improved handing of the `:partial`: remove the extra options-hash, and just make it use the single hash, so now we can just write

     = link_to_add_association 'add something', f, :tasks, :partial => 'shared/task_fields'
     = link_to_add_association 'add something', f, :tasks, :class => 'your-special-class', :partial => 'shared/task_fields'


## Version 1.0.19

* pull #53 (@CuriousCurmudgeon): fixed some bugs introduced in previous version (ooooops! Thanks!!!)

## Version 1.0.18

* pull in #51 (@erwin): adding an `after-removal-callback` in javascript, very useful if you want to recalculate e.g. total-items or indexes
* pull in #42 (@zacstewart): allow to hand extra `:locals` to the partial
* updated documentation

## Version 1.0.17

* fix: make sure that cocoon still works for rails 3.0, where the `conditions` is not available yet

## Version 1.0.16

* merged pull request #33 (@fl00r): added the a custom partial option! genius :)
  Also the creation of the nested objects takes any available conditions into account.
  Now you can write

     = link_to_add_association 'add something', f, :tasks, {}, :partial => 'shared/task_fields'

## Version 1.0.15

* added `data-association-insertion-method` that gives more control over where to insert the new nested fields.
  It takes a jquery method as parameter that inserts the new data. `before`, `after`, `append`, `prepend`, etc. Default: `before`.
* `data-association-insertion-position` is still available and acts as an alias. Probably this will be deprecated in the future.


## Version 1.0.14

* When playing with `simple_form` and `twitter-bootstrap`, I noticed it is crucial that I call the correct nested-fields function.
  That is: `fields_for` for standard forms, `semantic_fields_for` in formtastic and `simple_fields_for` for simple_form.
  Secondly, this was not enough, I needed to be able to hand down options to that method. So in the `link_to_add_association` method you
  can now an extra option `:render_options` and that hash will be handed to the association-builder.

  This allows the nested fields to be built correctly with `simple_form` for `twitter-bootstrap`.

## Version 1.0.13

* A while ago we added the option to add a javascript callback on inserting a new associated object, I now made sure we can add a callback on insertion
  and on removal of a new item. One example where this was useful for me is visible in the demo project `cocoon_simple_form_demo` where I implemented a
  `belongs_to` relation, and either select from a list, or add a new element.
  So: the callback-mechanism has changed, and now the callback is bound to the parent container, instead of the link itself. This is because we can also
  bind the removal callback there (as the removal link is inserted in the html dynamically).

  For more info, see the `README`.

## Version 1.0.12

* using "this" in `association-insertion-node` is now possible

If you are using rails < 3.1, you should run

    rails g cocoon:install

to install the new `cocoon.js` to your `public/javascripts` folder.


## Version 1.0.11


## Version 1.0.10

* Fuck! Built the gem with 1.9.2 again. Built the gem again with 1.8.7.

## Version 1.0.9

* is now rails 3.1 compatible. If you are not using Rails 3.1 yet, this should have no effect.
  For rails 3.1 the cocoon.js no longer needs to be installed using the `rails g cocoon:install`. It is
  automatically used from the gem.

## Version 1.0.8

* Loosened the gem dependencies.

## Version 1.0.7 (20/06/2011)

Apparently, the gem 1.0.6 which was generated with ruby 1.9.2 gave the following error upon install:

      uninitialized constant Psych::Syck (NameError)

This is related to this bug: http://rubyforge.org/tracker/?group_id=126&atid=575&func=detail&aid=29163

This should be fixed in the next release of rubygems, the fix should be to build the gem with ruby 1.8.7.
Let's hope this works.

## Version 1.0.6 (19/06/2011)

* The javascript has been improved to consistently use `e.preventDefault` instead of returning false.

Run

    rails g cocoon:install

to copy the new `cocoon.js` to your `public/javascripts` folder.


## Version 1.0.5 (17/06/2011)

* This release make sure that the `link_to_add_association` generates a correctly clickable
  link in the newer rails 3 versions as well. In rails 3.0.8. the html was double escaped.

If you are upgrading from 1.0.4, you just have to update the gem. No other actions needed. If you are updating
from earlier versions, it is safer to do

    rails g cocoon:install

This will copy the new `cocoon.js` files to your `public/javascripts` folder.