abyme 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 627dd83f44a40bcdf8ebd3355761ff9e1201c9d9c11e526e00acee11c685e479
-  data.tar.gz: 476215a4ae3e062e79104f0351da75a090c74c25cbde16cdd26016e17cea08cb
+  metadata.gz: fb0f45e02d147c46725a521f0e789998a6c99172333daa039eb5cd0544805c52
+  data.tar.gz: f849cda4209753325ecbb737683b510c19f52fb22ac2aa72e095e67c56d5b24f
 SHA512:
-  metadata.gz: bd5fa9ecb5bae8fdab1272017769649c4ca5945789f47a5c792c6240a2aa45366a335c231128e04feb57448e9275433a303df023ced40c5f26eaafefd03baf78
-  data.tar.gz: 8d5728bd54f6e9292f36f9336e7b8157b1354e17e6348ce1fa07ad611c31c8d5f4d2550f494e4e4d00dfd136c5daf621a1cf6d1ba999c5f2625fc8e1110841b2
+  metadata.gz: a091fd6a3a798accdcc60a119e7b435d72ce553aea6896e041583d6df65d64157e1511031bad28a8d5b9042c2df3c3501400819cf3791eda7c2ae53618f776e5
+  data.tar.gz: f92d9395baad0cfa1a561a9c7936c9856b4b5049c5821040fbdb73aa55c9d444c9de2d5b7bdd59d70ce90e665967782311c9ba85250204f41d78bed644a24753

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abyme (0.4.0)
+    abyme (0.5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -63,6 +63,7 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    bindex (0.8.1)
     builder (3.2.4)
     capybara (3.33.0)
       addressable
@@ -73,6 +74,7 @@ GEM
       regexp_parser (~> 1.5)
       xpath (~> 3.2)
     childprocess (3.0.0)
+    coderay (1.1.3)
     concurrent-ruby (1.1.8)
     crass (1.0.6)
     database_cleaner (1.8.5)
@@ -82,6 +84,9 @@ GEM
     diff-lcs (1.4.4)
     docile (1.3.2)
     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)
@@ -102,6 +107,11 @@ GEM
     nokogiri (1.11.1)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
     public_suffix (4.0.6)
     puma (5.0.4)
       nio4r (~> 2.0)
@@ -179,6 +189,11 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
+    web-console (4.1.0)
+      actionview (>= 6.0.0)
+      activemodel (>= 6.0.0)
+      bindex (>= 0.4.0)
+      railties (>= 6.0.0)
     webdrivers (4.4.1)
       nokogiri (~> 1.6)
       rubyzip (>= 1.3.0)
@@ -198,6 +213,8 @@ DEPENDENCIES
   bundler (~> 2.0)
   capybara
   database_cleaner-active_record
+  generator_spec
+  pry-rails
   puma
   rails
   rails-controller-testing
@@ -206,6 +223,7 @@ DEPENDENCIES
   simplecov
   simplecov-lcov
   sqlite3
+  web-console
   webdrivers
 
 BUNDLED WITH

data/README.md

@@ -1,33 +1,27 @@
-# Abyme 🕳
+# abyme 🕳
 
 [![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)
 
-abyme makes it easy to handle nested attributes in Rails, using [stimulus](https://stimulusjs.org/handbook/introduction) under the hood. Here's an example :
+abyme is an easy and framework-agnostic way to handle nested attributes in Rails, using [stimulus](https://stimulusjs.org/handbook/introduction) under the hood. Here's an example :
 ```ruby
 # views/projects/_form.html.erb
-<%= simple_form_for @project do |f| %>
-  <%= f.input :title %>
-  <%= f.input :description %>
+<%= form_for @project do |f| %>
+  <%= f.text_field :title %>
+  <%= f.text_area :description %>
   <%= f.submit 'Save' %>
 
   <%= f.abyme_for(:tasks) %>
 <% end %>
 ```
-Supposing you have a partial located in `views/abyme/_task_fields` containing your fields for `tasks`, the `abyme_for` command will generate and display 3 elements in this order :
-- A div containing all task fields for `@project.tasks` (either persisted or already built instances of `tasks`)
-- A div which will contain all additional tasks about to be created (added through the `Add task` button below)
-- A button to generate fields for new instances of tasks
+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 :
+- A `div` containing all task fields for `@project.tasks` (either persisted or already built instances of `tasks`)
+- A `div` which will contain all additional tasks about to be created (added through the `Add task` button below)
+- A `button` to generate fields for new instances of tasks
 
-Have a look below to learn more about the different options and needed configuration.
-
-
-## Disclaimer
-This project is still a work in progress and subject to change. We would advise not to use it in production code just yet.
-
-Any enhancement proposition or bug report welcome !
+Have a look below to learn more about configuration and all its different options.
 
 ## Demo app
 
@@ -37,6 +31,17 @@ 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`
+
+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:
@@ -66,154 +71,96 @@ application.load(definitionsFromContext(context))
 application.register('abyme', AbymeController)
 ```
 
-## What are nested forms and why a new gem ?
+## Get 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)
 
-Nested forms (or more accurately *nested fields* or *nested attributes*) are forms that deal with associated models. Let's picture a `Project` model that `has_many :tasks`. A nested form will allow you to create a project along with one or several tasks **within a single form**. If `Tasks` were to have associations on their own, like `:comments`, you could also, still in the same form, instantiate comments along with their parent models.
+You may also check out our [step by step tutorial](https://github.com/bear-in-mind/abyme/wiki/Step-by-step-Tutorial)
 
-Rails provides [its own helper](https://api.rubyonrails.org/v6.0.1/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for) to handle nested attributes. **abyme** is basically a smart wrapper around it, offering easier syntax along with some fancy additions. To work properly, some configuration will be required in both models and controllers (see below).
 
-What Rails doesn't provide natively is the possibility to **dynamically add new associations on the fly**, which requires Javascript implementation. What this means it that you would normally have to know in advance how many fields you'd like to display (1, 2 or any number of `:tasks`), which isn't very usable in this day and age. This is what the [cocoon gem](https://github.com/nathanvda/cocoon) has been helping with for the past 7 years. This gem still being implemented in JQuery (which [Rails dropped as a dependency](https://github.com/rails/rails/issues/25208)), we wanted to propose a more plug'n'play approach, using Basecamp's [Stimulus](https://stimulusjs.org/) instead.
+### Model
 
-## Basic Configuration
+💡 Don't forget to `include Abyme::Model` in your parent model
 
-### Models
-Let's consider a to-do application with Projects having many Taks, themselves having many Comments.
+#### #abymize(:association, permit: nil, reject: nil, options = {})
+In models, the `abyme_for :association` acts as an alias for this command :
 ```ruby
-# models/project.rb
-class Project < ApplicationRecord
-  has_many :tasks
-  validates :title, :description, presence: true
-end
-
-# models/task.rb
-class Task < ApplicationRecord
-  belongs_to :project
-  has_many :comments
-  validates :title, :description, presence: true
-end
-
-# models/comment.rb
-class Comment < ApplicationRecord
-  belongs_to :task
-  validates :content, presence: true
-end
+  accepts_nested_attributes_for :association, reject_if: :all_blank, :allow_destroy: true
 ```
-The end-goal here is to be able to create a project along with different tasks, and immediately add comments to some of these tasks ; all within a single form.
-What we'll have is a 2-level nested form. Thus, we'll need to configure our `Project` and `Task` models like so :
+
+* `permit: []` : allows you to generate a hash of attributes that can be easily called on the controller side through the `::abyme_attributes` class method (see details below).
 ```ruby
-# models/project.rb
-class Project < ApplicationRecord
-  include Abyme::Model
-  has_many :tasks, inverse_of: :project
-  # ...
-  abymize :tasks
-end
-
-# models/task.rb
-class Task < ApplicationRecord
-  include Abyme::Model
-  has_many :comments, inverse_of: :task
-  # ...
-  abymize :comments
-end
+  abymize :association, permit: [:name, :description]
+  
+  # You may also permit all attributes like so :
+  abymize :association, permit: :all_attributes 
 ```
-Note the use of the `inverse_of` option. It is needed for Rails to effectively associate children to their yet unsaved parent. Have a peek to the bottom of [this page](https://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html#method-i-accepts_nested_attributes_for) for more info.
-
-### Controller
-Since we're dealing with one form, we're only concerned with one controller : the one the form routes to. In our example, this would be the `ProjectsController`.
-The only configuration needed here will concern our strong params. Nested attributes require a very specific syntax to white-list the permitted attributes. It looks like this :
 
+* `reject: []` : allows you to add all attributes to `::abyme_attributes`, excepted the ones specified.
 ```ruby
-def project_params
-  params.require(:project).permit(
-    :title, :description, tasks_attributes: [
-      :id, :title, :description, :_destroy, comments_attributes: [
-        :id, :content, :_destroy
-      ]
-    ]
-  )
-end
+  abymize :association, reject: [:password]
 ```
-A few explanations here. 
-
-* To permit a nested model attributes in your params, you'll need to pass the `association_attributes: [...]` hash at the end of your resource attributes. Key will always be `association_name` followed by `_attributes`, while the value will be an array of symbolized attributes, just like usual.
-
-> **Note**: if your association is a singular one (`has_one` or `belongs_to`) the association will be singular ; if a Project `has_one :owner`, you would then need to pass `owner_attributes: [...]`)
-
-* You may have remarked the presence of `id` and `_destroy` among those params. These are necessary for edit actions : if you want to allow your users to destroy or update existing records, these are **mandatory**.  Otherwise, Rails won't be able to recognize these records as existing ones, and will just create new ones. More info [here](https://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html).
-
-## Basic Usage
-
-Dealing with nested attributes means you'll generally have to handle a few things inside your form:
-* Display fields for the **persisted records** (here, already existing `:tasks`)
-* Display fields for the **new records** (future `:tasks` not yet persisted)
-* A button to **trigger the addition** of fields for a new resource (an `Add a new task` button)
-* A button to **remove fields** for a given resource (`Remove task`)
-
-abyme provides helper methods for all these. Here's how our form for `Project` looks like when using default values:
 
+* `options: {}` : [the same options] you may pass to the `accepts_nested_attributes` method (see [this link](https://api.rubyonrails.org/v6.1.0/classes/ActiveRecord/NestedAttributes/ClassMethods.html) for details)
 ```ruby
-# views/projects/_form.html.erb
-<%= simple_form_for @project do |f| %>
-  <%= f.input :title %>
-  <%= f.input :description %>
-  <%= f.submit 'Save' %>
-
-  <%= f.abyme_for(:tasks) do |abyme| %>
-    <%= abyme.records %>
-    <%= abyme.new_records %>
-    <%= add_associated_record %>
-  <% end %>
-<% end %>
+  abyme_for :association, limit: 3, allow_destroy: false
 ```
 
-`abyme.records` will contain the persisted associations fields, while `abyme.new_records` will contain fields for the new associations. `add_associated_record` will by default generate a button with a text of type "Add `resource_name`". To work properly, this method **has** to be called **inside the block** passed to the `abyme_for` method.
-
-Now where's the code for these fields ? abyme will assume a **partial** to be present in the directory `/views/abyme` with a *name respecting this naming convention* (just like with [cocoon](https://github.com/nathanvda/cocoon#basic-usage)): `_singular_association_name_fields.html.erb`. 
-
-This partial might look like this:
+#### ::abyme_attributes
+Returns a hash to the right format to be included in the `strong params` on the controller side. For a `Project` model with nested `:tasks` :
 ```ruby
-# views/abyme/_task_fields.html.erb
-<%= f.input :title %>
-<%= f.input :description %>
-<%= f.hidden_field :_destroy %>
-
-<%= remove_associated_record(tag: :div) do %>
-  <i class="fas fa-trash"></i>
-<% end %>
+  Project.abyme_attributes
+  # => {tasks_attributes: [:title, :description, :id, :_destroy]}
 ```
 
-Note the presence of the `remove_associated_record` button. Here, we pass it an option to make it a `<div>`, as well as a block to customize its content. Don't forget the `_destroy` attribute, needed to mark items for destruction.
+### Controller
+#### #abyme_attributes
+Infers the name of the resource from the controller name, and calls the `::abyme_attributes` method on it. Hence, in your `ProjectsController` :
+```ruby
+  def project_params
+    params.require(:project).permit(:title, :description, abyme_attributes)
+  end
+```
 
-### What about the controller ?
+### Views
 
-What about it ? Well, not much. That's the actual magical thing about `nested_attributes`: once your model is aware of its acceptance of those for a given association, and your strong params are correctly configured, there's nothing else to do.
-`@project.create(project_params)` is all you'll need to save a project along with its descendants 👨‍👧‍👧
+#### #abyme_for(:association, options = {}, &block)
+This is the container for all your nested fields. It takes the symbolized association as a parameter, along with options, and an optional block to specify any layout you may wish for the different parts of the `abyme` builder. 
 
-### Auto mode
+💡 Please note an id is automatically added to this element, which value is : `abyme--association_name`.
 
-Let's now take care of our comments fields. We'll add these using our neat *automatic mode*: just stick this line at the end of the partial :
+💡  If you don't pass a block, `records`, `new_records` and `add_association` will be called and will appear in this order in your layout.
+* `partial: ` : allows you to indicate a custom partial path for both `records` and `new_records`
 ```ruby
-# views/abyme/_task_fields.html.erb
-# ... rest of the partial above
-<%= f.abyme_for(:comments) %>
+  <%= f.abyme_for(:tasks, partial: 'projects/task_fields') do |abyme| %>
+    <%= abyme.records %>
+    <%= abyme.new_records %>
+    <%= add_association %>
+  <% end %>
 ```
-Where's the rest of the code ? Well, if the default configuration you saw above in the `_form.html.erb` suits you, and the order in which the different resources appear feels right (persisted first, new fields second, and the 'Add' button last), then you can just spare the block, and it will be taken care of for you. We'll just write our `_comment_fields.html.erb` partial in the `views/abyme` directory and we'll be all set.
-
-## Advanced usage
-### Models
-In models, the `abyme_for :association` acts as an alias for this command :
-
+* `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).
 ```ruby
-  accepts_nested_attributes_for :association, reject_if: :all_blank, :allow_destroy: true
+  <%= f.abyme_for(:tasks, limit: 5) do |abyme| %>
+    # 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 %>
+  <% end %>
 ```
-
-Which is the way you would configure `nested_attributes` 90% of the time. Should you want to pass [any available options](https://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html#method-i-accepts_nested_attributes_for) to this method or change those, you may just pass them as with the original method :
+* `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.
 ```ruby
-  abyme_for :association, limit: 3, allow_destroy: false
+  <%= f.abyme_for(:tasks, min_count: 1) do |abyme| %>
+    # 1 blank task will automatically be added to the form.
+    <%= abyme.records %>
+    <%= abyme.new_records %>
+    <%= add_association %>
+  <% end %>
 ```
 
-### Views
+*If you're not passing a block*, the `abyme_for` method can take a few additional options:
+* `button_text: ` this will set the `add_association` button text to the string of your choice.
+
+💡 All options that should be passed to either `records` or `new_records` below can be passed here and will be passed down.
 
 #### #records
 A few options can be passed to `abyme.records`:
@@ -250,7 +197,7 @@ A few options can be passed to `abyme.records`:
     <%= add_associated_record %>
   <% end %>
 ```
-* `wrapper_html:` : gives you the possibility to add any HTML attribute you may want to the wrapper containing all fields.
+* `wrapper_html:` : gives you the possibility to add any HTML attribute you may want to the wrapper containing all persisted fields.
 ```ruby
   <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records(wrapper_html: { class: "persisted-records" }) %>
@@ -296,39 +243,6 @@ As you may have seen above, you can also pass a block to the method to give it w
   <% end %>
 ```
 
-#### #abyme_for(:association, form_object)
-This is the container for all your nested fields. It takes two parameters (the symbolized association and the `form_builder`), and some optional ones. Please note an id is automatically added to this element, which value is : `abyme--association`. 
-* `partial:` : allows you to indicate a custom partial path for both `records` and `new_records`
-```ruby
-  <%= f.abyme_for(:tasks, partial: 'projects/task_fields') do |abyme| %>
-    <%= abyme.records %>
-    <%= abyme.new_records %>
-    <%= 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).
-```ruby
-  <%= f.abyme_for(:tasks, limit: 5) do |abyme| %>
-    # 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_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.
-```ruby
-  <%= f.abyme_for(:tasks, min_count: 1) do |abyme| %>
-    # 1 blank task will automatically be added to the form.
-    <%= abyme.records %>
-    <%= abyme.new_records %>
-    <%= add_associated_record %>
-  <% end %>
-```
-
-*When in auto mode*, the abyme_for method can take a few options:
-* `button_text:` : this will set the `add_associated_record` button text to the string of your choice.
-* All options that should be passed to either `records` or `new_records` can be passed here and will be passed down.
-
 ## Events
 This part is still a work in progress and subject to change. We're providing some basic self-explanatory events to attach to. These are emitted by the main container (created by the `abyme_for` method).
 

data/abyme.gemspec

@@ -34,10 +34,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner-active_record'
   spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'webdrivers'
+  spec.add_development_dependency "generator_spec"
   
   # Dummy app
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'pry-rails'
+  spec.add_development_dependency 'web-console'
+
   spec.add_development_dependency 'puma'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-lcov'

data/lib/abyme.rb

@@ -1,6 +1,7 @@
 require "abyme/version"
 require 'abyme/view_helpers'
 require 'abyme/engine'
+require 'abyme/controller'
 require 'abyme/action_view_extensions/builder'
 
 module Abyme

data/lib/abyme/abyme_builder.rb

@@ -8,10 +8,11 @@ module Abyme
     # the form object, lookup_context optionaly a partial path
     # then yield itself to the block 
 
-    def initialize(association:, form:, lookup_context:, partial:, &block)
+    def initialize(association:, form:, context:, partial:, &block)
       @association = association
       @form = form
-      @lookup_context = lookup_context
+      @context = context
+      @lookup_context = context.lookup_context
       @partial = partial
       yield(self) if block_given?
     end
@@ -23,7 +24,7 @@ module Abyme
   
     def records(options = {})
       persisted_records_for(@association, @form, options) do |fields_for_association|
-        render_association_partial(fields_for_association, options)
+        render_association_partial(@association, fields_for_association, @partial, @context)
       end
     end
 
@@ -34,15 +35,9 @@ module Abyme
     
     def new_records(options = {}, &block)
       new_records_for(@association, @form, options) do |fields_for_association|
-        render_association_partial(fields_for_association, options)
+        render_association_partial(@association, fields_for_association, @partial, @context)
       end
     end
   
-    private
-
-    def render_association_partial(fields, options)
-      partial = @partial || options[:partial] || "abyme/#{@association.to_s.singularize}_fields"
-      ActionController::Base.render(partial: partial, locals: { f: fields })
-    end
   end
 end

data/lib/abyme/controller.rb

@@ -0,0 +1,15 @@
+module Abyme
+  module Controller
+    def abyme_attributes
+      return [] if resource_class.nil?
+      
+      resource_class.abyme_attributes
+    end
+
+    private
+
+    def resource_class
+      self.class.name.match(/(.*)(Controller)/)[1].singularize.safe_constantize
+    end
+  end
+end

data/lib/abyme/engine.rb

@@ -6,6 +6,9 @@ module Abyme
       ActiveSupport.on_load :action_view do
         include Abyme::ViewHelpers
       end
+      ActiveSupport.on_load :action_controller do
+        include Abyme::Controller
+      end
     end
   end
 end

data/lib/abyme/model.rb

@@ -1,11 +1,85 @@
 module Abyme
   module Model
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def abymize(association, options = {})
+    module ClassMethods
+      def abymize(association, permit: nil, reject: nil, **options)
         default_options = {reject_if: :all_blank, allow_destroy: true}
-        accepts_nested_attributes_for association, default_options.merge(options)
+        nested_attributes_options = default_options.merge(options)
+        accepts_nested_attributes_for association, nested_attributes_options
+        # Save allow_destroy value for this model/association for later
+        save_destroy_option(association, nested_attributes_options[:allow_destroy])
+        Abyme::Model.permit_attributes(self.name, association, permit || reject, permit.present?) if permit.present? || reject.present?
+      end
+
+      def abyme_attributes
+        Abyme::Model.instance_variable_get(:@permitted_attributes)[self.name]
+      end
+
+      private
+
+      def save_destroy_option(association, value)
+        Abyme::Model.instance_variable_get(:@allow_destroy)[self.name][association] = value
+      end
+    end
+
+    @permitted_attributes ||= {}
+    @allow_destroy        ||= {}
+
+    attr_accessor :allow_destroy
+    attr_reader   :permitted_attributes
+
+    def self.permit_attributes(class_name, association, attributes, permit)
+      @permitted_attributes[class_name]["#{association}_attributes".to_sym] = AttributesBuilder.new(class_name, association, attributes, permit)
+                                                                                               .build_attributes
+    end
+
+    def self.included(klass)
+      @permitted_attributes[klass.name] ||= {}
+      @allow_destroy[klass.name]        ||= {}
+      klass.extend ClassMethods
+    end
+
+    class AttributesBuilder
+      def initialize(model, association, attributes, permit = true)
+        @model = model
+        @association = association
+        @attributes_list = attributes
+        @permit = permit
+        @association_class = @association.to_s.classify.constantize
+      end
+
+      def build_attributes
+        nested_attributes = @association_class.abyme_attributes if @association_class.respond_to? :abyme_attributes
+        authorized_attributes = build_default_attributes
+        if @permit && @attributes_list == :all_attributes
+          authorized_attributes = build_all_attributes(authorized_attributes, nested_attributes)
+        elsif @permit
+          @attributes_list << nested_attributes unless (nested_attributes.blank? || @attributes_list.include?(nested_attributes))
+          authorized_attributes += @attributes_list
+        else
+          authorized_attributes = build_all_attributes(authorized_attributes, nested_attributes)
+          authorized_attributes -= @attributes_list
+        end
+        authorized_attributes
+      end
+
+      def destroy_allowed?
+        Abyme::Model.instance_variable_get(:@allow_destroy).dig(@model, @association)
+      end
+
+      def add_all_attributes
+        @association_class.column_names.map(&:to_sym).reject { |attr| [:id, :created_at, :updated_at].include?(attr) }
+      end
+
+      def build_all_attributes(authorized_attributes, nested_attributes)
+        authorized_attributes += add_all_attributes
+        authorized_attributes << nested_attributes unless (nested_attributes.blank? || authorized_attributes.include?(nested_attributes))
+        authorized_attributes
+      end
+
+      def build_default_attributes
+        attributes = [:id]
+        attributes << :_destroy if destroy_allowed?
+        attributes
       end
     end
   end

data/lib/abyme/version.rb

@@ -2,7 +2,7 @@
 module Abyme
   module VERSION
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

data/lib/abyme/view_helpers.rb

@@ -3,7 +3,7 @@ require_relative "abyme_builder"
 module Abyme
   module ViewHelpers
 
-    # ABYMIZE
+    # ABYME_FOR
 
     # this helper will generate the top level wrapper markup
     # with the bare minimum html attributes (data-controller="abyme")
@@ -23,12 +23,12 @@ module Abyme
     # set the default number of blank fields to display
 
     # - partial (String)
-    # to customize the partial path by default #abymize will expect 
+    # to customize the partial path by default #abyme_for will expect 
     # a partial to bbe present in views/abyme
 
     # - Exemple
 
-    # <%= abymize(:tasks, f, limit: 3) do |abyme| %>
+    # <%= abyme_for(:tasks, f, limit: 3) do |abyme| %>
     #   ...
     # <% end %>
 
@@ -42,7 +42,7 @@ module Abyme
       content_tag(:div, data: { controller: 'abyme', limit: options[:limit], min_count: options[:min_count] }, id: "abyme--#{association}") do
         if block_given?
           yield(Abyme::AbymeBuilder.new(
-            association: association, form: form, lookup_context: self.lookup_context, partial: options[:partial]
+            association: association, form: form, context: self, partial: options[:partial]
             )
           )
         else
@@ -62,7 +62,7 @@ module Abyme
     # then a hash of options.
 
     # - Exemple
-    # <%= abymize(:tasks, f) do |abyme| %>
+    # <%= abyme_for(:tasks, f) do |abyme| %>
     #   <%= abyme.new_records %>
     #   ...
     # <% end %>
@@ -85,7 +85,7 @@ module Abyme
     # :end is the default value
 
     # - partial (String)
-    # to customize the partial path by default #abymize will expect 
+    # to customize the partial path by default #abyme_for will expect 
     # a partial to bbe present in views/abyme
 
     # - fields_html (Hash)
@@ -113,7 +113,8 @@ module Abyme
           form.fields_for association, association.to_s.classify.constantize.new, child_index: 'NEW_RECORD' do |f|
             content_tag(:div, build_attributes(fields_default, basic_fields_markup(options[:fields_html], association))) do
               # Here, if a block is passed, we're passing the association fields to it, rather than the form itself
-              block_given? ? yield(f) : render(options[:partial] || "abyme/#{association.to_s.singularize}_fields", f: f)
+              # block_given? ? yield(f) : render(options[:partial] || "abyme/#{association.to_s.singularize}_fields", f: f)
+              block_given? ? yield(f) : render_association_partial(association, f, options[:partial])
             end
           end
         end
@@ -128,7 +129,7 @@ module Abyme
     # then a hash of options.
 
     # - Exemple
-    # <%= abymize(:tasks, f) do |abyme| %>
+    # <%= abyme_for(:tasks, f) do |abyme| %>
     #   <%= abyme.records %>
     #   ...
     # <% end %>
@@ -151,7 +152,7 @@ module Abyme
     # ex: order: { created_at: :desc }
 
     # - partial (String)
-    # to customize the partial path by default #abymize will expect 
+    # to customize the partial path by default #abyme_for will expect 
     # a partial to bbe present in views/abyme
 
     # - fields_html (Hash)
@@ -178,7 +179,7 @@ module Abyme
       content_tag(:div, options[:wrapper_html]) do
         form.fields_for(association, records) do |f|
           content_tag(:div, build_attributes(fields_default, basic_fields_markup(options[:fields_html], association))) do
-            block_given? ? yield(f) : render(options[:partial] || "abyme/#{association.to_s.singularize}_fields", f: f)
+            block_given? ? yield(f) : render_association_partial(association, f, options[:partial])
           end
         end
       end
@@ -262,9 +263,19 @@ module Abyme
         # Add new data attributes (keys & values)
         default[:data] = default[:data].merge(attr[:data].reject { |key, _| default[:data][key] })
       end
-      # Merge data attributes to the hash ok html attributes
+      # Merge data attributes to the hash of html attributes
       default.merge(attr.reject { |key, _| key == :data })
     end
 
+    # RENDER PARTIAL
+
+    # renders a partial based on the passed path, or will expect a partial to be found in the views/abyme directory. 
+
+    def render_association_partial(association, form, partial = nil, context = nil)
+      partial_path = partial ||"abyme/#{association.to_s.singularize}_fields"
+      context ||= self
+      context.render(partial: partial_path, locals: {f: form})
+    end
+
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abyme",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "JS companion to abyme gem",
   "main": "javascript/index.js",
   "files": [
@@ -20,6 +20,6 @@
   "homepage": "https://github.com/bear-in-mind/abyme",
   "bugs": "https://github.com/bear-in-mind/abyme/issues",
   "dependencies": {
-    "stimulus": "^1.1.1"
+    "stimulus": "^2.0.0"
   }
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abyme
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Romain Sanson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: web-console
+  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'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +249,7 @@ files:
 - lib/abyme.rb
 - lib/abyme/abyme_builder.rb
 - lib/abyme/action_view_extensions/builder.rb
+- lib/abyme/controller.rb
 - lib/abyme/engine.rb
 - lib/abyme/model.rb
 - lib/abyme/version.rb