cool_nested_forms 0.1.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2f7ad90816a28b45857f43b357d89e45fb89e83
-  data.tar.gz: 62245f5482d798bafb522b8f366085a598b6839e
+  metadata.gz: b48184d7b170609c8a71ea4eb082cfb6edfd795f
+  data.tar.gz: 52b40bc7014dfec757f6f34753e5b4afbdfd77e7
 SHA512:
-  metadata.gz: 50eccdcb03196c2594f2a24c1d753779eb6133ef55b4531479b8f8ff37171a537b4d8f49cd9104ad60e8163d4d425dd7f38a0af18f90ff2cd2e1d8173332be54
-  data.tar.gz: f702ec2ed7182732a972d9722ad19e4b293294fd805ae6ad654f414a9aea7e0304bb1bb9f5d00d9f2f8646fb7d902b5bc3da19cdae0e94ebf74ab57578f1b6f0
+  metadata.gz: e0527b621ff6b2ca7dc633c996ed48fbf22de4d2afe22e5d12348af1e43f32f82d2e95f69b7533e81455ee39361d1dab1df5d7d8f7bae96a68cd9892d3ad4bd7
+  data.tar.gz: 85ff8543fd00f3ac6463c5e2e3899d4570ac0152d619a519cc8c67a7eca0d87aad0872c7a22315aeae51d8b5a6f1e4ec1525ffeb3dace99759b20586dbcd3016

data/README.md

@@ -1,8 +1,12 @@
 # CoolNestedForms
+[![Gem Version](https://badge.fury.io/rb/cool_nested_forms.svg)](https://badge.fury.io/rb/cool_nested_forms)        
+
 Add Nested Forms to your Forms. Currently tested with a depth of 2.
 For example a Form can add an Item and this Item can add a sub Item.
 It can probably support longer nests but I haven't tested it yet.
 
+By the way, this is intended to simplify adding the javascript required to add form_field dynamically while following form builder conventions. What that means is that there is some work to be done in the form of configuring models and controllers and adding a couple of views.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -13,21 +17,97 @@ gem 'cool_nested_forms'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install cool_nested_forms
 
-## Usage
+Then require the javascript in your app/assets/javascripts/application.js
+```javascript
+//= require cool_nested_forms
+```
+
+## Usage Example
+For this example I will use Job and Task models
+
+### Preparing your models
+
+#### Job Model
+```ruby
+class Job < ActiveRecord::Base
+  has_many :tasks, :dependent => :destroy
+  # :name is required - User your own required field here
+  accepts_nested_attributes_for :tasks, :reject_if => lambda { |a| a[:name].blank? }, :allow_destroy => true
+end
+```
+#### Task Model
+```ruby
+class Task < ActiveRecord::Base
+  belongs_to :job
+end
+```
+### Preparing the Job Controller
+```ruby
+class JobsController < ApplicationController
+
+  # other code #
+
+  def job_params
+    # :id and :_destroy are required. Substitute name with your own fields
+    params.require(:job).permit(:name,
+      :tasks_attributes => [:id, :name, :_destroy])
+  end
+end
+```
+### The view used to generate tasks
+Due to laziness remove_child_button needs to be nested right under the containing div. this will be fixed in the next version.
+app/views/jobs/_task.html.rb
+```html
+<div>
+  <%= remove_child_button "Remove" %>
+  <%= f.hidden_field :_destroy, :class => 'removable' %>
+
+  <%= f.label :name %>
+  <%= f.text_field :name %>
+</div>
+```
+
+## Adding functionality to the Job form
+app/views/jobs/_form.html.erb
+```html
+  <%= form_for(@job) do |f| %>
+
 
-Will update with usage later
+    <!-- your other job fields go here -->
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    <!-- this generates a template for javascript -->  
+    <%= new_fields_template f, :tasks, {object: Tasks.new, :template => "tasks_#{f.object.id}_fields"} %>  
+    <!-- this generates a button that adds a task into    <div id="tasks_<%=f.object.id%>"> -->  
+    <%= add_child_button "Add Task", :tasks, "tasks_#{f.object.id}", "tasks_#{f.object.id}", "<your-css-classes>" %>  
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    <div id="tasks_<%=f.object.id%>">
+      <%= f.fields_for :tasks, @job.tasks do |builder| %>
+        <%= render "task", :f => builder %>
+      <% end %>
+    </div>
+
+  <%end%>
+```
+
+### After add/remove events
+If you need to perform any other javascript actions after a child is added or removed, you can add a listener to these events
+```javascript
+coolNestedForms.childAdded
+coolNestedForms.childRemoved
+```
+Something like this
+```javascript
+$(document).bind('coolNestedForms.childAdded', function(){
+  // do something
+});
+```
 
 ## Contributing
 

data/cool_nested_forms.gemspec

@@ -23,16 +23,16 @@ Gem::Specification.new do |spec|
       "public gem pushes."
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "app"]
 
-  spec.add_runtime_dependency 'rails', '~> 4.1'
+  spec.add_runtime_dependency 'rails', '~> 5.1'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/cool_nested_forms/version.rb

@@ -1,3 +1,3 @@
 module CoolNestedForms
-  VERSION = "0.1.2"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cool_nested_forms
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Carlos Roque
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Easily add nested forms to your forms
 email:
 - carlos_roque@hotmail.com
@@ -78,7 +78,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
@@ -87,7 +86,6 @@ files:
 - app/helpers/cool_nested_forms_helper.rb
 - bin/console
 - bin/setup
-- cool_nested_forms-0.1.1.gem
 - cool_nested_forms.gemspec
 - lib/cool_nested_forms.rb
 - lib/cool_nested_forms/engine.rb
@@ -113,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Cool Nested Forms

data/Gemfile.lock

@@ -1,130 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cool_nested_forms (0.1.0)
-      rails (~> 4.2.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (4.2.7.1)
-      actionpack (= 4.2.7.1)
-      actionview (= 4.2.7.1)
-      activejob (= 4.2.7.1)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.7.1)
-      actionview (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.7.1)
-      activesupport (= 4.2.7.1)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.7.1)
-      activesupport (= 4.2.7.1)
-      globalid (>= 0.3.0)
-    activemodel (4.2.7.1)
-      activesupport (= 4.2.7.1)
-      builder (~> 3.1)
-    activerecord (4.2.7.1)
-      activemodel (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
-      arel (~> 6.0)
-    activesupport (4.2.7.1)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    arel (6.0.3)
-    builder (3.2.2)
-    concurrent-ruby (1.0.2)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    globalid (0.3.7)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    pkg-config (1.1.7)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.7.1)
-      actionmailer (= 4.2.7.1)
-      actionpack (= 4.2.7.1)
-      actionview (= 4.2.7.1)
-      activejob (= 4.2.7.1)
-      activemodel (= 4.2.7.1)
-      activerecord (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.7.1)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (4.2.7.1)
-      actionpack (= 4.2.7.1)
-      activesupport (= 4.2.7.1)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.2)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    sprockets (3.7.0)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.1.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.13.a)
-  cool_nested_forms!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.13.0.rc.1