abyme 0.2.4 → 0.6.1

data/README.md

@@ -1,16 +1,28 @@
-# Abyme 🕳
-
-abyme is a modern take on handling dynamic nested forms in Rails 6+ using StimulusJS.
+# 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)
+[![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)
 
-## 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.
+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
+# views/projects/_form.html.erb
+<%= form_for @project do |f| %>
+  <%= f.text_field :title %>
+  <%= f.text_area :description %>
+  
+  <%= 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 :
+- 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
 
-Any enhancement proposition or bug report welcome !
+Have a look below to learn more about configuration and all its different options.
 
 ## Demo app
 
@@ -34,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"
@@ -49,271 +66,221 @@ application.load(definitionsFromContext(context))
 application.register('abyme', AbymeController)
 ```
 
-## What are nested forms and why a new gem ?
-
-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.
+## 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) 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
+```
 
-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).
+#### 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
+```
 
-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
-  # ...
-  abyme_for :tasks
-end
-
-# models/task.rb
-class Task < ApplicationRecord
-  include Abyme::Model
-  has_many :comments, inverse_of: :task
-  # ...
-  abyme_for :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' %>
-
-  <%= abymize(:tasks, f) do |abyme| %>
-    <%= abyme.records %>
-    <%= abyme.new_records %>
-    <%= add_association %>
-  <% 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_association` 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 `abymize` 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_association(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_association` 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
-<%= abymize(:comments, f) %>
+  <%= f.abyme_for(:tasks, partial: 'projects/task_fields') do |abyme| %>
+    <%= abyme.records %>
+    <%= abyme.new_records %>
+    <%= add_associated_record %>
+  <% 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_associated_record %>
+  <% 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_associated_record %>
+  <% 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`:
 * `collection:` : allows you to pass a collection of your choice to only display specific objects.
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records(collection: @project.tasks.where(done: false)) %>
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 * `order:` : allows you to pass an ActiveRecord `order` method to sort your instances the way you want.
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records(order: { created_at: :asc }) %>
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
-* `partial:` : allows you to indicate a custom partial, if one has not already been passed to `abymize`.
+* `partial:` : allows you to indicate a custom partial, if one has not already been passed to `abyme_for`.
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records %>
     <%= abyme.new_records(partial: 'projects/task_fields') %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 * `fields_html:` : gives you the possibility to add any HTML attribute you may want to each set of fields. By default, an `abyme--fields` and an `singular_association-fields` class are already present.
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records(fields_html: { class: "some-class" }) %>
     # Every set of persisted fields will have these 3 classes : 'abyme--fields', 'task-fields', and 'some-class'
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= 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
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records(wrapper_html: { class: "persisted-records" }) %>
     # The wrapper containing all persisted task fields will have an id "abyme-tasks-wrapper" and a class "persisted-records"
     <%= abyme.new_records %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 #### #new_records
 Here are the options that can be passed to `abyme.new_records`:
 * `position:` : allows you to specify whether new fields added dynamically should go at the top or at the bottom. `:end` is the default value.
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     <%= abyme.records %>
     <%= abyme.new_records(position: :start) %>
-    <%= add_association %>
+    <%= add_associated_record %>
   <% end %>
 ```
 * `partial:` : same as `#records`
 * `fields_html:` : same as `#records`
 * `wrapper_html:` : same as `#records`
 
-#### #add_association, #remove_association
+#### #add_associated_record, #remove_associated_record
 These 2 methods behave the same. Here are their options :
 * `tag:` : allows you to specify a tag of your choosing, like `:a`, or `:div`. Default is `:button`.
 * `content:` : the text to display inside the element. Default is `Add association_name`
 * `html:` : gives you the possibility to add any HTML attribute you may want to the element.
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     # ...
-    <%= add_association(tag: :a, content: "Add a super task", html: {id: "add-super-task"}) %>
+    <%= add_associated_record(tag: :a, content: "Add a super task", html: {id: "add-super-task"}) %>
   <% end %>
 ```
 
 As you may have seen above, you can also pass a block to the method to give it whatever HTML content you want :
 ```ruby
-  <%= abymize(:tasks, f) do |abyme| %>
+  <%= f.abyme_for(:tasks) do |abyme| %>
     # ...
-    <%= add_association(tag: :div, html: {id: "add-super-task", class: "flex"}) do %>
+    <%= add_associated_record(tag: :div, html: {id: "add-super-task", class: "flex"}) do %>
       <i class="fas fa-plus"></i>
       <h2>Add a super task</h2>
     <% end %>
   <% end %>
 ```
 
-#### #abymize(: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
-  <%= abymize(:tasks, f, partial: 'projects/task_fields') do |abyme| %>
-    <%= abyme.records %>
-    <%= abyme.new_records %>
-    <%= add_association %>
-  <% 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
-  <%= abymize(:tasks, f, 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 %>
-```
-* `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
-  <%= abymize(:tasks, f, min_count: 1) do |abyme| %>
-    # 1 blank task will automatically be added to the form.
-    <%= abyme.records %>
-    <%= abyme.new_records %>
-    <%= add_association %>
-  <% end %>
-```
-
-*When in auto mode*, the abymize method can take a few 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` 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 `abymize` method).
+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).
 
 We're currently thinking about a way to attach to these via Stimulus. Coming soon !
 
@@ -341,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
 

data/abyme.gemspec

@@ -34,10 +34,16 @@ 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 'rails', "~> 6.0.3.6"
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'web-console'
+  spec.add_development_dependency 'simple_form'
+
   spec.add_development_dependency 'puma'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-lcov'