link_to_add_fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8033fcfe31d3cfb7852d44afde60305123cc120
+  data.tar.gz: b42164453f26a98699a5641b67dbc1cc64f768b3
+SHA512:
+  metadata.gz: bdd1136c834105f39400c2c2d77e225b455ff7b2aa11be17968f5b5e7caaa7e5099623de7f48468a0d43856dfdaf4eccd536462146db214307a173e4ab56ba81
+  data.tar.gz: 5ddec37e0ae37edc25f5d5c26839da19b081015b6e95d38bcda0eaea0359951de376960b13070912a9d6ad9212ae5887d07b43b9e026c951981ae4ba44930215

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 richard lynch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# LinkToAddFields
+![](https://i.imgur.com/OGnj3Af.gif) 
+ 
+Dynamically add nested fields to your Rails forms.  
+When clicked, `link_to_add_fields` will render the association's fields partial 
+above it.  
+`link_to_remove_fields` will hide the HTML element matching it's 
+target css selector. It also sets a truthy value in the hidden input field 
+closest to it, name this field `_destroy` to remove models.  
+
+After seeing this idea in a Rails casts episode I ended up using it so often I 
+thought it worth making a gem.
+
+## Installation
+Make sure you have jQuery installed.  
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'link_to_add_fields'
+```
+
+Then execute:
+```bash
+$ bundle
+```
+
+And require `link_to_add_fields` in application.js, after jQuery.
+```javascript
+//
+//= require jquery
+//= require link_to_add_fields
+//= require_tree .
+
+```
+
+## Usage
+### `link_to_add_fields(name, builder, association, options = {}) => String`
+#### Parameters:
+ - name (String) -- Name of the link, passed to `link_to`.
+ - builder (ActionView::Helpers::FormBuilder) -- Parent form builder object.
+ - association (Symbol) -- Child association name (pluralised).
+ - options (Hash) (defaults to: {}) -- a customizable set of options.
+#### Options Hash (options):
+ - :partial (String) -- Path to partial, override the inferred partial. If left 
+blank will be inferred form the form's model's name and the association 
+(signularised), eg `posts/comment_fields`
+ - other options are passed through to `link_to`.
+
+### `link_to_remove_fields(name, target, options = {}) => String`
+#### Parameters:
+  - name (String) -- Name of the link, passed to `link_to`.
+  - target (String) -- Css selector to hide.
+  - options (Hash) (defaults to: {}) -- a customizable set of options.
+#### Options Hash (options):
+ - other options are passed through to `link_to`.
+
+## Example
+`post_form.html.erb`
+```erb
+  <%= form_for @post do |f| %>
+    <%= f.label :name %>
+    <%= f.text_field :name %><br>
+
+    <%= f.label :body %>
+    <%= f.text_area :body %><br>
+
+    <%= f.fields_for :comments do |ff| %>
+      <%= render partial: "comment_fields", locals: { f: ff } %>
+      <br>
+    <% end %>
+
+    <%= link_to_add_fields 'Add comment', f, :comments %><br>
+
+    <%= f.submit %>
+  <% end %>
+```
+`comment_fields.html.erb`
+```erb
+  <div class="comment_fields">
+    <%= f.label :body, 'Comment' %>
+    <%= f.text_area :body %><br>
+
+    <%= f.hidden_field :_destroy %>
+    <%= link_to_remove_fields 'Remove comment', '.comment_fields' %>
+  </div>
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/helpers/link_to_add_fields_helper.rb

@@ -0,0 +1,26 @@
+module LinkToAddFieldsHelper
+  def link_to_add_fields(name, f, association, options = {})
+    new_object = f.object.send(association).klass.new
+    id = new_object.object_id
+    objects_name = f.object.class.name.underscore.pluralize
+    options_partial = options.delete(:partial)
+    infered_partial = association.to_s.singularize + "_fields"
+    partial_name = options_partial || infered_partial
+    template_name = "#{objects_name}/#{partial_name}"
+    fields = f.fields_for(association, new_object, child_index: id) do |builder|
+      render(template_name, f: builder)
+    end
+    data = options[:data] || {}
+    options[:data] = data.merge(
+      link_to_add_field_id: id,
+      link_to_add_field: fields.gsub("\n", "")
+    )
+    link_to name, '#', options
+  end
+
+  def link_to_remove_fields(name, target, options = {})
+    data = options[:data] || {}
+    options[:data] = data.merge(link_to_remove_field: target)
+    link_to name, '#', options
+  end
+end

data/lib/link_to_add_fields.rb

@@ -0,0 +1,5 @@
+require "link_to_add_fields/version"
+
+module LinkToAddFields
+  class Engine < ::Rails::Engine; end
+end

data/lib/link_to_add_fields/version.rb

@@ -0,0 +1,3 @@
+module LinkToAddFields
+  VERSION = '0.1.0'
+end

data/lib/tasks/link_to_add_fields_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :link_to_add_fields do
+#   # Task goes here
+# end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require link_to_add_fields
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,5 @@
+class PostsController < ApplicationController
+  def new
+    @post = Post.new
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ApplicationRecord
+  belongs_to :post
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,4 @@
+class Post < ApplicationRecord
+  has_many :comments
+  accepts_nested_attributes_for :comments, allow_destroy: true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/app/views/posts/_comment_fields.html.erb

@@ -0,0 +1,8 @@
+<div class="comment_fields">
+  <%= f.label :body, 'Comment' %>
+  <br>
+  <%= f.text_area :body %>
+  <br>
+  <%= f.hidden_field :_destroy %>
+  <%= link_to_remove_fields 'Remove comment', '.comment_fields', class: 'btn', data: { test: true } %>
+</div>

data/spec/dummy/app/views/posts/new.html.erb

@@ -0,0 +1,16 @@
+<%= form_for @post do |f| %>
+  <%= f.label :name %>
+  <br>
+  <%= f.text_field :name %>
+  <br>
+  <%= f.label :body %>
+  <br>
+  <%= f.text_area :body %>
+  <%= f.fields_for :comments do |ff| %>
+    <%= render partial: "comment_fields", locals: { f: ff } %>
+  <% end %>
+  <br>
+  <%= link_to_add_fields 'Add comment', f, :comments, class: 'btn', data: { test: true } %>
+  <br>
+  <%= f.submit %>
+<% end %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end