activeadmin_polymorphic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 806875f4dc043b24f94549838a81c5ad6d180e4b
+  data.tar.gz: 786835f0298f3ce1e08870a9bede6f9ab036d9e6
+SHA512:
+  metadata.gz: 8a5da9426cf627abefc48134e70fc9bea72ebd90de1f8c1e28094e6dc693037609120a1ed514a26a1d5b417ed64a6d558623f8a47ffcab26b0585eee6b60b2e5
+  data.tar.gz: d8f296a37a267d68ccccf8d9cfea1b8449f7ebe66b3a889e1791ad29126093191a68bde27f27c8834cb093d4aa64a03bd8eff151f36b3c0e2a65bede0e26e666

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+## Mac
+.DS_Store
+
+## Windows
+.Thumbs.db
+
+## TextMate
+*.tm_project
+*.tmproj
+tmtags
+
+## Emacs
+*~
+\#*
+.\#*
+
+## Vim
+*.swp
+# IDEA / RUBYMINE
+.idea
+
+## RVM
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+## Project (general)
+tags
+coverage
+rdoc
+doc
+.yardoc
+pkg
+
+## Project (specific)
+bin/
+.bundle
+spec/rails
+*.sqlite3-journal
+Gemfile.lock
+Gemfile-*.lock
+capybara*
+viewcumber
+test-rails*
+public
+.rspec
+.rails-version
+.rbenv-version
+.localeapp/*

data/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activeadmin', github: 'activeadmin'
+gem 'inherited_resources'
+
+group :development do
+  # Debugging
+  gem 'better_errors'      # Web UI to debug exceptions. Go to /__better_errors to access the latest one
+  gem 'binding_of_caller'  # Retrieve the binding of a method's caller in MRI Ruby >= 1.9.2
+
+  # Performance
+  gem 'rack-mini-profiler' # Inline app profiler. See ?pp=help for options.
+  gem 'flamegraph'         # Flamegraph visualiztion: ?pp=flamegraph
+
+  # Documentation
+  gem 'yard'               # Documentation generator
+  gem 'redcarpet'          # Markdown implementation (for yard)
+end
+
+group :test do
+  gem 'capybara'
+  gem 'simplecov', require: false # Test coverage generator. Go to /coverage/ after running tests
+  gem 'coveralls', require: false # Test coverage website. Go to https://coveralls.io
+  gem 'cucumber-rails', require: false
+  gem 'database_cleaner'
+  gem 'guard-rspec'
+  gem 'jasmine'
+  gem 'jslint_on_rails'
+  gem 'launchy'
+  gem 'rails-i18n' # Provides default i18n for many languages
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'rspec-rails'
+  gem 'i18n-spec'
+  gem 'shoulda-matchers'
+  gem 'sqlite3'
+  gem 'poltergeist'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', all_on_start: false, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/active_admin_polymorphic/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+  watch('spec/rails_helper.rb')  { "spec/" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2015 Sergeev Peter
+
+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,86 @@
+# ActiveadminPolymorphic
+
+Activeadmin Polymorphic gem is made to bring has_many polymorphic nested forms into your ActiveAdmin. ActiveAdmin users formtastic to build awesome forms, but formatstic itself doesn't support polymorphic relations. `activeadmin_polymorphic` gem is trying to solve that problem.
+
+![](https://s3.amazonaws.com/f.cl.ly/items/0b2F2t2R3D0o1O3F1R3e/Screen%20Shot%202015-02-05%20at%2012.57.04.png)
+
+# Features
+
+* polymorphic forms
+* validation
+* sortable behaviour
+* file uploads
+
+# Installation
+
+Add this to your Gemfile:
+
+``` ruby
+gem "activeadmin_polymorphic"
+```
+
+and run `bundle install`.
+
+Include assets in js and css manifests
+
+```
+#= require activeadmin_polymorphic
+@import "activeadmin_polymorphic";
+```
+
+# Usage
+
+To use gem, your model should have related model, which works as a proxy to polymorphic relations.
+
+![](https://s3.amazonaws.com/f.cl.ly/items/2Z3M2V0b3Z342L2Z2R0N/Screen%20Shot%202015-02-05%20at%2013.37.36.png)
+
+Gem extrands activeadmin's form builder, so to enable `has_many_polymorphic` method you need to override form builder using `builder` option:
+
+```
+...
+SECTIONABLES = [Image, Text]
+
+form builder: ActiveadminPolymorphic::FormBuilder do |f|
+  f.polymorphic_has_many :sections, :sectionable, types: SECTIONABLES
+end
+...
+```
+
+There are few options available:
+* first option is a name of polymorphic has_many association
+* second option referes to polymorphied version of association name (sectionable_id and sectaionable_type for example)
+* `types` - list of related models you want to use
+* `allow_destroy` - weather or not to allow to destroy related objects
+* `sortable` - enables drag'n'drop for nested forms, accepts sortable column name, for example `sortable: :priority`
+
+Subforms for polymorphic relations are forms which you define in your ActiveAdmin. Gem fetches and submits them using some ajax magic.
+
+# Under the hood
+
+This gem is a set of dirty hacks and tricks. Calling `polymorphic_has_many` makes it to do the following things:
+
+* for new records it generates dropdown with polymorphic types
+* for exising records it generates two hidden fields with id and type
+* then the real javascript starts, it extracts whole forms from polymorphic models new or edit pages, strips form actions, and inserts that forms right into parent form
+* when you try to submit forms, javascripts submit subforms first; if subforms are invalid, it reloads them with erros and interupts  main form submission process
+* after all sub forms successfully saved, it strips them (because forms nested into other forms are simantically invalid, right?) and submits parent form
+
+# File uploads in subforms
+
+Gem relies on [rails ajax](https://github.com/rails/jquery-rails) form submissions, which doesn't allow to submit files directly. Workaround for it is asynchronous file submission using for example [remotipart](https://github.com/JangoSteve/remotipart) for CarrierWave or [refile](https://github.com/elabs/refile) with [refile-input](https://github.com/hyperoslo/refile-input). Note: before subforms submissions javascript strips all file inputs from forms.
+
+# Testing
+
+Tests stucture is mostly copied from original ActiveAdmin.
+
+Install development dependencies with `bundle install`. To setup test suit run `rake test`. Run tests with `bundle exec guard`. There aren't many of them, let's say there are quite a few.
+
+# In plan
+
+* allow to reuse existing polymorphic objects
+* check who it works with  models under sertain namespace
+* improve tests
+
+# License
+
+[MIT](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler'
+require 'rake'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+def cmd(command)
+  puts command
+  fail unless system command
+end
+
+require File.expand_path('../spec/support/detect_rails_version', __FILE__)
+
+# Import all our rake tasks
+FileList['tasks/**/*.rake'].each { |task| import task }
+
+task default: :test
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort 'Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine'
+  end
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+
+  ARGV.clear
+  IRB.start
+end

data/activeadmin_polymorphic.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "activeadmin_polymorphic/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.license     = "MIT"
+  s.name        = "activeadmin_polymorphic"
+  s.version     = ActiveadminPolymorphic::VERSION
+  s.authors     = ["Petr Sergeev", "Sindre Moen"]
+  s.email       = ["peter@hyper.no", "sindre@hyper.no"]
+  s.description = 'This gem extends formtastic\'s form builder to support polymoprhic has many relations in your forms'
+  s.summary     = 'HasMany polymoprhic support for active admin.'
+  s.homepage    = "https://github.com/hyperoslo/activeadmin-polymorphic"
+
+  s.files         = `git ls-files`.split("\n").sort
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+end

data/app/assets/javascripts/activeadmin_polymorphic.js.coffee

@@ -0,0 +1,172 @@
+$ ->
+  if $('.polymorphic_has_many_container').length
+    form = $('#main_content').find('form:first')
+    $(form).on 'submit', (e) ->
+      submissions_counter = 0
+      parentForm = @
+      expect = $(@).find('form').length
+      if submissions_counter < expect
+        e.preventDefault()
+
+      $(@).find('form').each ->
+        remoteSubmit @, ->
+          submissions_counter++
+          if submissions_counter == expect
+            $(form).find('form').remove()
+            stripEmptyRelations()
+            $(parentForm).submit()
+
+  $(document).on "upload:start", "form", (event) ->
+    form = $('#main_content').find('form:first')
+    form.find("input[type=submit]").attr "disabled", true
+
+  $(document).on "upload:complete", "form", (event) ->
+    form = $('#main_content').find('form:first')
+
+    unless form.find("input.uploading").length
+      form.find("input[type=submit]").removeAttr "disabled"
+
+  $('.polymorphic_has_many_fields').each (index, rapper) ->
+    rapper = $ rapper
+
+    hiddenField = rapper.find 'input[type=hidden][data-path]'
+    formPath = hiddenField.data 'path'
+
+    extractAndInsertForm formPath, rapper
+
+
+  $(document).on 'click', 'a.button.polymorphic_has_many_remove', (e)->
+    e.preventDefault()
+    parent    = $(@).closest '.polymorphic_has_many_container'
+    to_remove = $(@).closest 'fieldset'
+    recompute_positions parent
+
+    parent.trigger 'polymorphic_has_many_remove:before', [to_remove, parent]
+    to_remove.remove()
+    parent.trigger 'polymorphic_has_many_remove:after', [to_remove, parent]
+
+  $(document).on 'click', 'a.button.polymorphic_has_many_add', (e)->
+    e.preventDefault()
+    parent = $(@).closest '.polymorphic_has_many_container'
+    parent.trigger before_add = $.Event('polymorphic_has_many_add:before'), [parent]
+
+    unless before_add.isDefaultPrevented()
+      index = parent.data('polymorphic_has_many_index') || parent.children('fieldset').length - 1
+      parent.data has_many_index: ++index
+
+      regex = new RegExp $(@).data('placeholder'), 'g'
+      html  = $(@).data('html').replace regex, index
+
+      fieldset = $(html).insertBefore(@)
+      recompute_positions parent
+      parent.trigger 'polymorphic_has_many_add:after', [fieldset, parent]
+
+  init_polymorphic_sortable()
+
+
+  $('.polymorphic_has_many_container').on 'change', '.polymorphic_type_select', (event) ->
+    fieldset = $(this).closest 'fieldset'
+
+    selectedOption = $(this).find 'option:selected'
+    formPath = selectedOption.data 'path'
+
+    label = $(this).prev 'label'
+    label.remove()
+
+    hiddenField = $('<input type="hidden" />')
+    hiddenField.attr 'name', $(this).attr('name')
+    hiddenField.val $(this).val()
+
+    $(this).replaceWith hiddenField
+
+    newListItem = $ '<li>'
+
+    extractAndInsertForm formPath, fieldset
+
+init_polymorphic_sortable = ->
+  elems = $('.polymorphic_has_many_container[data-sortable]:not(.ui-sortable)')
+
+  elems.sortable
+    axis: 'y'
+    items: '> fieldset',
+    handle: '> ol > .handle',
+    stop:    recompute_positions
+  elems.each recompute_positions
+
+# Removes relations if id or type is not specified
+# For example when user clicked add relation button, but didn't selected type
+stripEmptyRelations = ->
+  $('.polymorphic_has_many_fields input:hidden').each ->
+    if $(@).val() == ""
+      $(@).parents('.polymorphic_has_many_fields').remove()
+
+recompute_positions = (parent)->
+  parent     = if parent instanceof jQuery then parent else $(@)
+  input_name = parent.data 'sortable'
+  position   = parseInt(parent.data('sortable-start') || 0, 10)
+
+  parent.children('fieldset').each ->
+    # We ignore nested inputs, so when defining your has_many, be sure to keep
+    # your sortable input at the root of the has_many block.
+    destroy_input  = $(@).find "> ol > .input > :input[name$='[_destroy]']"
+    sortable_input = $(@).find "> ol > .input > :input[name$='[#{input_name}]']"
+
+    if sortable_input.length
+      sortable_input.val if destroy_input.is ':checked' then '' else position++
+
+window.extractAndInsertForm= (url, target)->
+  target = $ target
+
+  $.get url, (data)->
+    elements = $(data)
+    form = $('#main_content form', elements).first()
+    $(form).find('.actions').remove()
+    $(form).on 'submit', -> return false
+
+    target.prepend form
+
+window.loadErrors = (target) ->
+  $(target).off('ajax:success') # unbind successfull action for json form
+  $(target).trigger('submit.rails').on 'ajax:success', (event, data, result) ->
+    # duplicates method above. refactor using callbacks
+    elements = $(data)
+    form = $('#main_content form', elements).first()
+    $(form).find('.actions').remove()
+    $(form).on 'submit', -> return false
+
+    $(target).replaceWith(form)
+
+
+window.remoteSubmit = (target, callback)->
+  $(target).data('remote', true)
+  $(target).removeAttr('novalidate')
+  action = $(target).attr('action')
+  $(target).find("input[type=file]").remove()
+  # we gonna burn in hell for that
+  # perhaps we can use ajax:before callback
+  # to set type json
+  action_with_json = action + '.json'
+  $(target).attr('action', action_with_json)
+
+  # unbind callbacks action for form if it was submitted before
+  $(target).off('ajax:success').off('ajax:aborted:file').off('ajax:error')
+
+  $(target).trigger('submit.rails')
+    .on 'ajax:aborted:file', (inputs) ->
+      false
+    .on 'ajax:error', (event, response, status)->
+      $(target).attr('action', action)
+      if response.status == 422
+        loadErrors(target)
+    .on 'ajax:success', (event, object, status, response) ->
+      $(target).attr('action', action)
+      if response.status == 201 # created
+        $(target).next().find('input:first').val(object.id)
+        # replace new form with edit form
+        # to update form method to PATCH and form action
+        url = "#{action}/#{object.id}/edit"
+        extractAndInsertForm(url, $(target).parent('fieldset'))
+        $(target).remove()
+
+      callback()
+

data/app/assets/stylesheets/activeadmin_polymorphic.css.sass

@@ -0,0 +1,25 @@
+form .polymorphic_has_many_container fieldset
+  position: relative
+
+form .polymorphic_has_many_container fieldset:not(:last-of-type)
+  border-bottom: 1px solid lightgray
+  margin-bottom: 20px
+
+.input.refile img.image-preview
+  margin: 0.5em 0 0 20%
+  display: block
+
+form .polymorphic_has_many_container .handle
+  position: absolute
+  top: calc(50% - 60px)
+  right: 2px
+  padding: 0
+  cursor: move
+
+  &.ui-sortable-handle
+    top: calc(50% - 42px)
+
+  span.icon
+    width: 3em
+    height: 3em
+  

data/lib/activeadmin_polymorphic/engine.rb

@@ -0,0 +1,5 @@
+module ActiveadminPolymorphic
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveadminPolymorphic
+  end
+end

data/lib/activeadmin_polymorphic/form_builder.rb

@@ -0,0 +1,124 @@
+module ActiveadminPolymorphic
+  class FormBuilder < ::ActiveAdmin::FormBuilder
+    def polymorphic_has_many(assoc, poly_name, options = {}, &block)
+      custom_settings = :new_record, :allow_destroy, :heading, :sortable, :sortable_start, :types, :path_prefix
+      builder_options = {new_record: true, path_prefix: :admin}.merge! options.slice  *custom_settings
+
+      options         = {for: assoc      }.merge! options.except *custom_settings
+      options[:class] = [options[:class], "polymorphic_has_many_fields"].compact.join(' ')
+      sortable_column = builder_options[:sortable]
+      sortable_start  = builder_options.fetch(:sortable_start, 0)
+
+      html = "".html_safe
+      html << template.capture do
+        contents = "".html_safe
+
+        block = polymorphic_form(poly_name, builder_options)
+
+        template.assign('polymorphic_has_many_block' => true)
+        contents = without_wrapper { inputs(options, &block) }
+
+        if builder_options[:new_record]
+          contents << js_for_polymorphic_has_many(
+            assoc, poly_name, template, builder_options, options[:class]
+          )
+        else
+          contents
+        end
+      end
+
+      tag = @already_in_an_inputs_block ? :li : :div
+      html = template.content_tag(tag, html, class: "polymorphic_has_many_container #{assoc}", 'data-sortable' => sortable_column, 'data-sortable-start' => sortable_start)
+      template.concat(html) if template.output_buffer
+      html
+    end
+
+    protected
+
+    def polymorphic_has_many_actions(has_many_form, builder_options, contents)
+      if has_many_form.object.new_record?
+        contents << template.content_tag(:li) do
+          template.link_to I18n.t('active_admin.has_many_remove'),
+            "#", class: 'button polymorphic_has_many_remove'
+        end
+      elsif builder_options[:allow_destroy]
+        contents << has_many_form.input(:_destroy, as: :boolean,
+                            wrapper_html: {class: 'polymorphic_has_many_delete'},
+                            label: I18n.t('active_admin.has_many_delete'))
+      end
+
+      if builder_options[:sortable]
+        contents << has_many_form.input(builder_options[:sortable], as: :hidden)
+
+        contents << template.content_tag(:li, class: 'handle') do
+          ::ActiveAdmin::Iconic.icon :move_vertical
+        end
+      end
+
+      contents
+    end
+
+    def js_for_polymorphic_has_many(assoc, poly_name, template, builder_options, class_string)
+      new_record = builder_options[:new_record]
+      assoc_reflection = object.class.reflect_on_association assoc
+      assoc_name       = assoc_reflection.klass.model_name
+      placeholder      = "NEW_#{assoc_name.to_s.underscore.upcase.gsub(/\//, '_')}_RECORD"
+
+      text = new_record.is_a?(String) ? new_record : I18n.t('active_admin.has_many_new', model: assoc_name.human)
+      form_block = polymorphic_form(poly_name, builder_options, true)
+
+      opts = {
+        for: [assoc, assoc_reflection.klass.new],
+        class: class_string,
+        for_options: { child_index: placeholder }
+      }
+
+      html = "".html_safe
+      html << template.capture do
+        inputs_for_nested_attributes opts, &form_block
+      end
+
+      template.link_to text, '#', class: "button polymorphic_has_many_add", data: {
+        html: CGI.escapeHTML(html).html_safe, placeholder: placeholder
+      }
+    end
+
+    def polymorphic_options(builder_options)
+      # add internationalization
+      builder_options[:types].each_with_object([]) do |model, options|
+        options << [
+          model.model_name.human, model,
+          {"data-path" => form_new_path(model, builder_options) }
+        ]
+      end
+    end
+
+    def polymorphic_form(poly_name, builder_options, for_js = false)
+      proc do |f|
+        html = "".html_safe
+        html << f.input("#{poly_name}_id", as: :hidden)
+
+        if f.object.send(poly_name).nil?
+          html << f.input("#{poly_name}_type", input_html: { class: 'polymorphic_type_select' }, as: :select, collection: polymorphic_options(builder_options))
+        else
+          html << f.input(
+            "#{poly_name}_type", as: :hidden,
+            input_html: {"data-path" =>  form_edit_path(f.object.send(poly_name), builder_options) }
+          )
+        end
+
+        html << polymorphic_has_many_actions(f, builder_options, "".html_safe)
+
+        html
+      end
+    end
+
+    def form_new_path(object, builder_options)
+      "/#{builder_options[:path_prefix]}/#{ActiveModel::Naming.plural(object)}/new"
+    end
+
+    def form_edit_path(object, builder_options)
+      "/#{builder_options[:path_prefix]}/#{ActiveModel::Naming.plural(object)}/#{object.id}/edit"
+    end
+  end
+end

data/lib/activeadmin_polymorphic/version.rb

@@ -0,0 +1,3 @@
+module ActiveadminPolymorphic
+  VERSION = "0.1.0"
+end

data/lib/activeadmin_polymorphic.rb

@@ -0,0 +1,5 @@
+require "activeadmin_polymorphic/engine"
+require "activeadmin_polymorphic/form_builder"
+
+module ActiveadminPolymorphic
+end