abyme 0.5.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29bd9abd9bf5c46d2c23b9c53cbe38990d03078c87fd6face66bb865493aa5a5
-  data.tar.gz: d118f6af056ca064e405c4c8a4c6df2c4fbe52864387cd45bee8f558f1990018
+  metadata.gz: aa7e981607f8bab371a8cef7529510076e0095db0b3c1908ba045e21df10a476
+  data.tar.gz: f25822329ba46b8418e4d0507291b590a3ce3e9b1f2ff2a7b25ff78821fbb0dd
 SHA512:
-  metadata.gz: 43692f0d91e0afe0f20ad57b6e89d914eb359efe175c1ff2649f362d8b6e275084067d1ed219152fead5f6782374498644c372a74c2d4f163b60696c495c8995
-  data.tar.gz: 007b9b1df96b8de5690c54c4b4083176641af8980e464b35d83b2bfcc4e84a9f53ecc9d5d41540c8131cfd134f2931bebc9f08f7cce83b94d0fee4f766dca7d8
+  metadata.gz: 77ea88778c1373472d1c8af396e235e6d51331ffabab8b613763a0fabb89ced08d76d0741af52254774d80011a2a77786520fd52f4385de8e212b5f3858884f4
+  data.tar.gz: 999cadbcf32145e4f1968815779d1828f04a272c1923135a5a049b40e676889755349c19b377f1b97913301b15ffce2650e9f4641442b4037d4851a1ba73b353

data/.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": ["@babel/env"],
+  "plugins": [
+    "@babel/plugin-proposal-class-properties"
+  ]
+}

data/Gemfile.lock

@@ -1,61 +1,61 @@
 PATH
   remote: .
   specs:
-    abyme (0.5.1)
+    abyme (0.6.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.4)
-      actionpack (= 6.0.3.4)
+    actioncable (6.0.3.7)
+      actionpack (= 6.0.3.7)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionmailbox (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activejob (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      activestorage (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      actionview (= 6.0.3.7)
+      activejob (= 6.0.3.7)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionpack (6.0.3.7)
+      actionview (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actiontext (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      activestorage (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.0.3.7)
+      activesupport (= 6.0.3.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.0.3.7)
+      activesupport (= 6.0.3.7)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activestorage (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.4)
+    activemodel (6.0.3.7)
+      activesupport (= 6.0.3.7)
+    activerecord (6.0.3.7)
+      activemodel (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
+    activestorage (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activejob (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      marcel (~> 1.0.0)
+    activesupport (6.0.3.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -65,74 +65,72 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     bindex (0.8.1)
     builder (3.2.4)
-    capybara (3.33.0)
+    byebug (11.1.3)
+    capybara (3.35.3)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
     childprocess (3.0.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    database_cleaner (1.8.5)
-    database_cleaner-active_record (1.8.0)
-      activerecord
-      database_cleaner (~> 1.8.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
     diff-lcs (1.4.4)
-    docile (1.3.2)
+    docile (1.4.0)
     erubi (1.10.0)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.8)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
-    minitest (5.14.3)
-    nio4r (2.5.4)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.7-x86_64-darwin)
       racc (~> 1.4)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-rails (0.3.9)
-      pry (>= 0.10.4)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     public_suffix (4.0.6)
-    puma (5.0.4)
+    puma (5.3.2)
       nio4r (~> 2.0)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.4)
-      actioncable (= 6.0.3.4)
-      actionmailbox (= 6.0.3.4)
-      actionmailer (= 6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actiontext (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    rails (6.0.3.7)
+      actioncable (= 6.0.3.7)
+      actionmailbox (= 6.0.3.7)
+      actionmailer (= 6.0.3.7)
+      actionpack (= 6.0.3.7)
+      actiontext (= 6.0.3.7)
+      actionview (= 6.0.3.7)
+      activejob (= 6.0.3.7)
+      activemodel (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      activestorage (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.4)
+      railties (= 6.0.3.7)
       sprockets-rails (>= 2.0.0)
     rails-controller-testing (1.0.5)
       actionpack (>= 5.0.1.rc1)
@@ -143,14 +141,14 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    railties (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (13.0.3)
-    regexp_parser (1.8.2)
+    regexp_parser (2.1.1)
     rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
     rspec-expectations (3.10.1)
@@ -159,10 +157,10 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (4.0.2)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
       rspec-core (~> 3.10)
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
@@ -172,11 +170,16 @@ GEM
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
-    simplecov (0.19.1)
+    simple_form (5.1.0)
+      actionpack (>= 5.2)
+      activemodel (>= 5.2)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.3)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -194,11 +197,11 @@ GEM
       activemodel (>= 6.0.0)
       bindex (>= 0.4.0)
       railties (>= 6.0.0)
-    webdrivers (4.4.1)
+    webdrivers (4.6.0)
       nokogiri (~> 1.6)
       rubyzip (>= 1.3.0)
       selenium-webdriver (>= 3.0, < 4.0)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
@@ -206,20 +209,22 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   abyme!
   bundler (~> 2.0)
+  byebug
   capybara
   database_cleaner-active_record
   generator_spec
-  pry-rails
+  pry-byebug
   puma
-  rails
+  rails (~> 6.0.3.6)
   rails-controller-testing
   rake (~> 13.0)
   rspec-rails
+  simple_form
   simplecov
   simplecov-lcov
   sqlite3
@@ -227,4 +232,4 @@ DEPENDENCIES
   webdrivers
 
 BUNDLED WITH
-   2.1.4
+   2.2.13

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/abyme.svg)](https://badge.fury.io/rb/abyme)
 ![build](https://github.com/bear-in-mind/abyme/workflows/build/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f591a9e00f7cf5188ad5/maintainability)](https://codeclimate.com/github/bear-in-mind/abyme/maintainability)
-[![Coverage Status](https://coveralls.io/repos/github/bear-in-mind/abyme/badge.svg)](https://coveralls.io/github/bear-in-mind/abyme?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/bear-in-mind/abyme/badge.svg?branch=master)](https://coveralls.io/github/bear-in-mind/abyme?branch=master)
 
 abyme is an easy and form-agnostic way to handle nested attributes in Rails, using [stimulus](https://stimulusjs.org/handbook/introduction) under the hood. Here's an example :
 ```ruby
@@ -11,9 +11,10 @@ abyme is an easy and form-agnostic way to handle nested attributes in Rails, usi
 <%= form_for @project do |f| %>
   <%= f.text_field :title %>
   <%= f.text_area :description %>
-  <%= f.submit 'Save' %>
-
+  
   <%= f.abyme_for(:tasks) %>
+  
+  <%= f.submit 'Save' %>
 <% end %>
 ```
 Supposing you have a `Project` that `has_many :tasks` and a partial located in `views/abyme/_task_fields` containing your form fields for `tasks`, the `abyme_for` command will generate and display 3 elements in this order :
@@ -31,18 +32,6 @@ Check out our demo app here : https://abyme-demo.herokuapp.com/
 
 Source code is right here : https://github.com/bear-in-mind/abyme_demo
 
-## Breaking changes
-Careful ! As of February 12th, we changed quite a few methods name :
-In model:
-- `abyme_for` became `abymize`
-In views:
-- `abymize(:association, f)` became `f.abyme_for(:association)`
-- `add_association` became `add_associated_record`
-- `remove_association` became `remove_associated_record`
-
-The former method names will be deprecated soon.
-If you update, don't forget to change those ! All changes are reflected in the README below.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -57,7 +46,12 @@ And then execute:
     $ yarn add abyme
 
 
-Assuming you [already installed Stimulus](https://stimulusjs.org/handbook/introduction), add this in `app/javascript/controllers/index.js` :
+Assuming you [already installed Stimulus](https://stimulusjs.org/handbook/introduction), you need to register the `stimulus` controller that takes care of the JavaScript behaviour. You can launch this generator :
+```bash
+rails generate abyme:stimulus
+```
+Or you can register it yourself :
+
 ```javascript
 // app/javascript/controllers/index.js
 import { Application } from "stimulus"
@@ -72,12 +66,53 @@ application.load(definitionsFromContext(context))
 application.register('abyme', AbymeController)
 ```
 
-## Get started
+## Getting started
 
 To learn more about the *why* of this gem, check out our [wiki](https://github.com/bear-in-mind/abyme/wiki/What-are-nested-forms-and-why-a-new-gem-%3F)
 
-You may also check out our [step by step tutorial](https://github.com/bear-in-mind/abyme/wiki/Step-by-step-Tutorial)
+You may also check out our [step by step tutorial](https://github.com/bear-in-mind/abyme/wiki/Step-by-step-Tutorial) and our [advanced configuration guide](https://github.com/bear-in-mind/abyme/wiki/Step-by-step-:-Advanced-configuration) (currently in construction).
+## Documentation
+As in our [our tutorial](https://github.com/bear-in-mind/abyme/wiki/Step-by-step-Tutorial), we'll assume we have a `Project` model, that `has_many :tasks` for the rest of the documentation.
+### Generators
+To be up and running in no time, we built a few generators. Feel free to skip these if you prefer a manual implementation.
+#### Resource
+To generate everything you need with one command, use this generator :
+```bash
+rails generate abyme:resource project tasks
+# Includes configuration in Project model
+# Adds abyme_attributes in ProjectsController permitted params
+# Creates a partial and minimum boilerplate in app/views/abyme/_task_fields.html.erb
+```
+Now, head to your parent form and [keep reading](https://github.com/eki-177/abyme#abyme_forassociation-options---block) !
+
+You can also specify [attributes to be permitted](https://github.com/eki-177/abyme#model), or permit all of them (see below). This will populate the partial with input fields for the specified attributes
+```bash
+rails generate abyme:resource project tasks description title
+# Includes configuration in Project model, including permitted attributes
+# Adds abyme_attributes in ProjectsController permitted params
+# Creates a partial with input fields for the specified attributes in app/views/abyme/_task_fields.html.erb
+```
 
+#### Individual generators
+All the generators launched by the main `resource` generator are available individually :
+```bash
+# Controller
+rails generate abyme:controller Projects
+
+# Model
+# Permit only a few attributes
+rails generate abyme:model project tasks description title
+# Permit all attributes
+rails generate abyme:model project participants all_attributes
+
+# Views
+# Without attributes (use this if you're not using SimpleForm or don't care about generating input fields)
+rails generate abyme:view tasks
+# With a few attributes
+rails generate abyme:view tasks name description
+# With all attributes
+rails generate abyme:view tasks all_attributes
+```
 
 ### Model
 
@@ -136,7 +171,7 @@ This is the container for all your nested fields. It takes the symbolized associ
   <%= f.abyme_for(:tasks, partial: 'projects/task_fields') do |abyme| %>
     <%= abyme.records %>
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 * `limit: ` : allows you to limit the number of new fields that can be created through JS. If you need to limit the number of associations in database, you will need to add validations. You can also pass an option [in your model as well](https://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html#method-i-accepts_nested_attributes_for).
@@ -145,7 +180,7 @@ This is the container for all your nested fields. It takes the symbolized associ
     # Beyond 5 tasks, the add button won't add any more fields. See events section below to see how to handle the 'abyme:limit-reached' event
     <%= abyme.records %>
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 * `min_count: ` by default, there won't be any blank fields added on page load. By passing a `min_count` option, you can set how many empty fields should appear in the form.
@@ -154,7 +189,7 @@ This is the container for all your nested fields. It takes the symbolized associ
     # 1 blank task will automatically be added to the form.
     <%= abyme.records %>
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 
@@ -273,7 +308,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/bear-in-mind/abyme.
+Bug reports and pull requests are welcome on GitHub at https://github.com/eki-177/abyme.
 
 ## License