cocooned 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff5fc052a1bf37f18e1f22b550f35bf876e0cc09c4c7d4ebef3667c7afde67a
-  data.tar.gz: 55202ea14bda345f2ed5f20fc95ebb0de1bfa7831e9f70ba92b2a092c7ca210b
+  metadata.gz: 4494f16e78b35fe2847ef24c3b8ec95183ce63cf05fc41a81ed9aa6b316ca1a1
+  data.tar.gz: 4f554493b8c3aa8fe6e9e89a1eb762d186336783ad24f948e31d4d97922f405b
 SHA512:
-  metadata.gz: ed672de23fce13326d63cb1e943689ea8f4df8be8873111daecb9a25df954ee06a47592a6b28399c95120e6079337c26125838b42a868395e0d5639d08461569
-  data.tar.gz: 23b8d0ab6bdfda55e974f322bec4a0a39a9fd089f9bfbfa343144ccdc76639560286a4212ac3018e0ee10a567d70b8f363be5c3c3578e5000440de41a2464e04
+  metadata.gz: 8c09909ed1c2e7b9db436be0918b19bc28815568c804aeb76e9caba91809baabea55a3a732bcfedeac5226d550820e79b85f12d69ffced86aa2844bfaca16e91
+  data.tar.gz: 0c41cef34455f05fb7bc278f563d063f40ca3e5c74f31dbc2ec642f60b694041657d9f35ca35cdf8579ba685ca0923d8a16994dacbdc34a56c65520e4d44cad3

data/History.md

@@ -1,5 +1,14 @@
 # Change History / Release Notes
 
+## Version 1.3.2
+
+* Compatibility with Mongoid 7+
+
+## Version 1.3.1
+
+* Use UMD pattern to load the Cocooned module
+* Now publish packages on both rubygems.org and npmjs.com
+
 ## Version 1.3.0
 
 ### Breaking changes

data/README.md

@@ -33,7 +33,11 @@ Inside your `Gemfile` add the following:
 gem "cocooned"
 ```
 
-You must also require `cocooned` in your `application.js` and `application.css`, so it compiles with the asset pipeline.
+### Load Cocooned styles and scripts
+
+If you use Sprockets, you have to require `cocooned` in your `application.js` and `application.css`, so it compiles with the asset pipeline.
+
+If you use Yarn to manage your non-Ruby dependencies and/or Webpack to build your assets, you can install the [`@notus.sh/cocooned` companion package](https://www.npmjs.com/package/@notus.sh/cocooned).
 
 ## Usage
 
@@ -70,23 +74,23 @@ E.g. in your `ListsController`:
 
 ### Basic form
 
-_Please note examples in this section are written with the [`haml` templating language](http://haml.info/)._
-
 [Rails natively supports nested forms](https://guides.rubyonrails.org/form_helpers.html#nested-forms) but does not support adding or removing nested items.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |f|
-  = f.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |f| %>
+  <%= f.input :name %>
   
-  %h3 Items
-  = f.fields_for :tasks do |item_form|
-    / This block is repeated for every task in @list.items
-    = item_form.label :description
-    = item_form.text_field :description
-    = item_form.check_box :done
-    
-  = f.submit "Save"
+  <h3>Items</h3>
+  <%= f.fields_for :tasks do |item_form| %>
+    <% # This block is repeated for every task in @list.items %>
+    <%= item_form.label :description %>
+    <%= item_form.text_field :description %>
+    <%= item_form.check_box :done %>
+  <% end %>
+  
+  <%= f.submit "Save" %>
+<% end %>
 ```
 
 To enable Cocooned on this first, we need to:
@@ -102,75 +106,88 @@ Let's do it.
 
 We now have two files:
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  = form.fields_for :items do |item_form|
-    = render 'item_fields', f: item_form
+  <h3>Items</h3>
+  <%= form.fields_for :items do |item_form|
+    <%= render 'item_fields', f: item_form %>
+  <% end %>
     
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
-```haml
-/ `app/views/lists/_item_fields.html.haml`
-= f.label :description
-= f.text_field :description
-= f.check_box :done
+```erb
+<% # `app/views/lists/_item_fields.html.erb` %>
+<%= f.label :description %>
+<%= f.text_field :description %>
+<%= f.check_box :done %>
 ```
 
 #### 2. Add a way to add a new item to the collection
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  #items
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+  <h3>Items</h3>
+  <div id="items">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
   
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
 By default, a new item will be inserted just before the immediate parent of the 'Add an item' link. You can have a look at the documentation of `cocooned_add_item_link` for more information about how to change that but we'll keep it simple for now.
 
 #### 3. Add a way to remove an item from the collection
 
-```haml
-/ `app/views/lists/_item_fields.html.haml`
-.cocooned-item
-  = f.label :description
-  = f.text_field :description
-  = f.check_box :done
-  = cocooned_remove_item_link 'Remove', f
+```erb
+<% # `app/views/lists/_item_fields.html.erb` %>
+<div class="cocooned-item">
+  <%= f.label :description %>
+  <%= f.text_field :description %>
+  <%= f.check_box :done %>
+  <%= cocooned_remove_item_link 'Remove', f %>
+</div>
 ```
 
-The `.cocooned-item` class is required for the `cocooned_remove_item_link` to work correctly.
+The `cocooned-item` class is required for the `cocooned_remove_item_link` to work correctly.
 
 #### 4. Initialize Cocooned to handle this form
 
 Cocooned will detect on page load forms it should handle and initialize itself.
 This detection is based on the presence of a `data-cocooned-options` attribute on the nested forms container.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  #items{ :data => { cocooned_options: {}.to_json } }
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+  <h3>Items</h3>
+  <div id="items" data-cocooned-options="<%= {}.to_json %>">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
   
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+</div>
 ``` 
 
 And we're done!
@@ -188,52 +205,63 @@ For now, Cocooned supports two plugins:
 
 The limit plugin is autoloaded when needed and does not require anything more than you specifiying the maximum number of items allowed in the association.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
+```erb
+<% # `app/views/lists/_form.html.erb` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  %h3 Items
-  #items{ :data => { cocooned_options: { limit: 12 }.to_json } }
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+  <h3>Items</h3>
+  <div id="items" data-cocooned-options="<%= { limit: 12 }.to_json %>">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
   
-  = form.submit "Save"
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
 #### The reorderable plugin
 
 The reorderable plugin is autoloaded when activated and does not support any particular options.
 
-```haml
-/ `app/views/lists/_form.html.haml`
-= form_for @list do |form|
-  = form.input :name
-  
-  %h3 Items
-  #items{ :data => { cocooned_options: { reorderable: true }.to_json } }
-    = form.fields_for :tasks do |item_form|
-      = render 'item_fields', f: item_form
-    .links
-      = cocooned_add_item_link 'Add an item', form, :items
+```erb
+<% # `app/views/lists/_form.html.haml` %>
+<%= form_for @list do |form| %>
+  <%= form.input :name %>
   
-  = form.submit "Save"
+  <h3>Items</h3>
+  <div id="items" data-cocooned-options="<%= { reorderable: true }.to_json %>">
+    <%= form.fields_for :tasks do |item_form| %>
+      <%= render 'item_fields', f: item_form %>
+    <% end %>
+    
+    <div class="links">
+      <%= cocooned_add_item_link 'Add an item', form, :items %>
+    </div>
+  </div>
+    
+  <%= form.submit "Save" %>
+<% end %>
 ```
 
 However, you need to edit your nested partial to add the links that allow your users to move an item up or down in the collection and to add a `position` field.
 
-```haml
-/ `app/views/lists/_item_fields.html.haml`
-.cocooned-item
-  = f.label :description
-  = f.text_field :description
-  = f.check_box :done
-  = f.hidden_field :position
-  = cocooned_move_item_up_link 'Up', f
-  = cocooned_move_item_down_link 'Down', f
-  = cocooned_remove_item_link 'Remove', f
+```erb
+<% # `app/views/lists/_item_fields.html.erb` %>
+<div class="cocooned-item">
+  <%= f.label :description %>
+  <%= f.text_field :description %>
+  <%= f.check_box :done %>
+  <%= f.hidden_field :position %>
+  <%= cocooned_move_item_up_link 'Up', f %>
+  <%= cocooned_move_item_down_link 'Down', f %>
+  <%= cocooned_remove_item_link 'Remove', f %>
+</div>
 ```
 
 Also, remember the strong parameters gotcha we mentioned earlier.

data/Rakefile

@@ -79,6 +79,7 @@ namespace :npm do
     contributors = []
     spec.authors.each_with_index do |name, i|
       next if spec.email[i].nil?
+
       contributors << {
         name: name.dup.force_encoding('UTF-8'),
         email: spec.email[i].dup.force_encoding('UTF-8')

data/app/assets/javascripts/cocooned.js

@@ -1,5 +1,7 @@
 /* globals define */
 
+// Use Universal Module Definition pattern to load Cocooned
+// See https://github.com/umdjs/umd/blob/master/templates/returnExportsGlobal.js
 (function (root, factory) {
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.

data/cocooned.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.8.0'
   spec.add_development_dependency 'rspec-rails', '~> 3.8.0'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
 end

data/lib/cocooned/association_builder.rb

@@ -54,11 +54,12 @@ module Cocooned
     def build_without_reflection
       methods = %W[build_#{plural_name} build_#{singular_name}].select { |m| form.object.respond_to?(m) }
       raise "Association #{association} doesn't exist on #{form.object.class}" unless methods.any?
+
       form.object.send(methods.first)
     end
 
     def should_use_conditions?
-      reflection.class.name == 'Mongoid::Relations::Metadata' || @options[:force_non_association_create]
+      reflection.class.name.starts_with?('Mongoid::') || @options[:force_non_association_create]
     end
 
     def build_with_conditions

data/lib/cocooned/helpers/deprecate.rb

@@ -14,7 +14,7 @@ module Cocooned
         [
           "NOTE: #{target_and_name} is deprecated",
           replacement == :none ? ' with no replacement' : "; use #{replacement} instead",
-          format('. It will dissapear in %s.', release),
+          format('. It will dissapear in %<release>s.', release: release),
           location.nil? ? '' : "\n#{target_and_name} called from #{location}"
         ].join.strip
       end

data/lib/cocooned/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cocooned
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocooned
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Gaël-Ian Havard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,6 +115,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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: Easier nested form. Supports standard Rails forms, Formtastic and SimpleForm.
 email:
 - gael-ian@notus.sh