aa_associations 0.1.0

data/app/views/admin/shared/_add_to_association.html.erb

@@ -0,0 +1,21 @@
+<%- if resource_administrated?(relationship_class) && relationship_class.respond_to?(:autocomplete_attribute) && relationship_class.autocomplete_attribute.present? -%>
+  <%= form_tag relate_to_url(object), :class => 'relate-to-form', :method => :put do %>
+    <fieldset class="inputs">
+      <h4>Add a <%= relationship_class.model_name.human %></h4>
+      <%= hidden_field_tag 'relationship_name', relationship %>
+      <ol>
+        <li class="label">
+          <label for="related_id">
+            <%= relationship_class.model_name.human %>
+            <%= relationship_class.human_attribute_name(relationship_class.autocomplete_attribute) %>
+          </label>
+        </li>
+        <li class="input">
+          <%= hidden_field_tag 'related_id', nil, :class => 'token-input',
+            'data-model-name' => relationship_class.model_name.singular %>
+        </li>
+        <li class="button"><%= submit_tag "Add #{relationship_class.model_name.human}" %></li>
+      </ol>
+    </fieldset>
+  <% end %>
+<%- end -%>

data/app/views/admin/shared/_association_collection_table_actions.html.erb

@@ -0,0 +1,4 @@
+<%= link_to "Edit", edit_url_for(record) %>
+<%= button_to "Unrelate", {:action => :unrelate, :id => object.to_param,
+  :relationship_name => relationship,
+  :related_id => record.id}, :method => :put %>

data/app/views/admin/shared/_blank_slate.html.erb

@@ -0,0 +1,3 @@
+<div class="blank_slate_container">
+  <span class="blank_slate flash"><%= blank_text %></span>
+</div>

data/app/views/admin/shared/_collection_table.html.erb

@@ -0,0 +1,58 @@
+<div class="relationship-table" id="relationship-table-<%= relationship %>">
+  <h3><%= object.class.human_attribute_name(relationship) %></h3>
+  <%= render :partial => 'admin/shared/add_to_association', :locals => {
+    :relationship_class => relationship_class,
+    :object => object,
+    :relationship => relationship
+  } %>
+  <%- if collection.present? -%>
+    <table class="index_table">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <% columns.each do |column| %>
+            <th><%= relationship_class.human_attribute_name(column) %></th>
+          <%- end -%>
+          <th>&nbsp;</th>
+        </tr>
+      </thead>
+      <tbody>
+        <%- collection.each do |record| -%>
+          <tr class="<%= cycle("odd", "even") -%>">
+            <td><%= record.id %></td>
+            <%- columns.each do |column| -%>
+              <%- if record.send(column).is_a?(ActiveRecord::Base) -%>
+                <td><%= display_name_for(record.send(column)) %></td>
+              <%- else -%>
+                <td><%= record.send(column) %></td>
+              <%- end -%>
+            <%- end -%>
+            <td class="actions">
+              <%- if resource_administrated?(record.class) -%>
+                <%= render :partial => 'admin/shared/association_collection_table_actions', :locals => {
+                  :record => record,
+                  :object => object,
+                  :relationship => relationship
+                } %>
+              <%- else -%>
+                &nbsp;
+              <%- end -%>
+            </td>
+          </tr>
+        <%- end -%>
+      </tbody>
+    </table>
+    <div class="resource-table-footer">
+      <%= paginate collection, :remote => true, :params => {
+        :action => 'page_related', :relationship_name => relationship
+      } %>
+      <div class="pagination_information">
+        <%= raw page_entries_info(collection) %>
+      </div>
+    </div>
+  <%- else -%>
+    <%= render :partial => 'admin/shared/blank_slate', :locals => {
+      :blank_text => "There are no #{object.class.human_attribute_name(relationship)}"
+    } %>
+  <%- end -%>
+</div>

data/app/views/admin/shared/_form.html.erb

@@ -0,0 +1,7 @@
+<%= admin_form_for resource %>
+
+<%- if resource.persisted? && active_admin_config.form_associations.present? -%>
+  <%- active_admin_config.form_associations.each do |association| -%>
+    <%= collection_relationship_manager(resource, association) %>
+  <%- end -%>
+<%- end -%>

data/config/routes.rb

@@ -0,0 +1,7 @@
+if Rails.application.config.aa_associations.autocomplete_models
+  models = Rails.application.config.aa_associations.autocomplete_models.join('|')
+  Rails.application.routes.draw do
+    match '/autocomplete/:model' => 'autocomplete#index', :model => /(#{models})/,
+      :defaults => { :format => 'json' }
+  end
+end

data/lib/aa_associations.rb

@@ -0,0 +1,20 @@
+require 'active_support'
+require 'activeadmin'
+require 'active_admin_associations/version'
+require 'active_admin_associations/active_admin_extensions'
+require 'formtastic/token_input_default_for_association'
+require 'formtastic/inputs/token_input'
+
+module ActiveAdminAssociations
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :AssociationActions
+    autoload :FormConfigDSL
+    autoload :RedirectDestroyActions
+    autoload :Autocompleter
+    autoload :AssociationConfig
+  end
+end
+
+require 'active_admin_associations/engine'

data/lib/active_admin_associations/active_admin_extensions.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  class Resource
+    attr_accessor :form_columns
+    attr_accessor :form_associations
+    attr_accessor :active_association_form
+  end
+  
+  class << self
+    def resources
+      application.namespaces.values.map{|n| n.resources.resources }.flatten.compact.map(&:resource_class)
+    end
+  end
+end

data/lib/active_admin_associations/association_actions.rb

@@ -0,0 +1,43 @@
+module ActiveAdminAssociations
+  module AssociationActions
+    def association_actions
+      member_action :unrelate, :method => :put do
+        reflection = resource_class.reflect_on_association(params[:relationship_name].to_sym)
+        if reflection.collection?
+          related_record = reflection.klass.find(params[:related_id])
+          resource.send(params[:relationship_name]).delete(related_record)
+        else
+          resource.update_attribute("#{params[:relationship_name]}_id", nil)
+        end
+        flash[:notice] = "The recored has been unrelated."
+        redirect_to request.headers["Referer"].presence || admin_dashboard_url
+      end
+
+      member_action :relate, :method => :put do
+        reflection = resource_class.reflect_on_association(params[:relationship_name].to_sym)
+        if reflection.collection?
+          record_to_relate = reflection.klass.find(params[:related_id])
+          resource.send(params[:relationship_name]) << record_to_relate
+        else
+          resource.update_attribute("#{params[:relationship_name]}_id", record_to_relate)
+        end
+        flash[:notice] = "The recored has been related."
+        redirect_to request.headers["Referer"].presence || admin_dashboard_url
+      end
+
+      member_action :page_related, :method => :get do
+        relationship_name = params[:relationship_name].to_sym
+        association_config = active_admin_config.form_associations[relationship_name]
+        relationship_class = resource_class.reflect_on_association(relationship_name).klass
+        association_columns = association_config.fields.presence || relationship_class.content_columns
+        render :partial => 'admin/shared/collection_table', :locals => {
+          :object             => resource,
+          :collection         => resource.send(relationship_name).page(params[:page]),
+          :relationship       => relationship_name,
+          :columns            => association_columns,
+          :relationship_class => relationship_class
+        }
+      end
+    end
+  end
+end

data/lib/active_admin_associations/association_config.rb

@@ -0,0 +1,50 @@
+module ActiveAdminAssociations
+  class AssociationConfig
+    include Enumerable
+    
+    class Association
+      attr_reader :name
+      attr_reader :fields
+
+      def initialize(name, fields = [], &block)
+        @name = name.to_sym
+        @fields = fields
+        instance_exec(&block) if block_given?
+      end
+      
+      def field(name)
+        @fields << name
+      end
+      
+      def fields(*names)
+        @fields += names
+      end
+    end
+    
+    attr_reader :association_configs
+    delegate :each, :to => :association_configs
+
+    def initialize(&block)
+      @association_configs = []
+      instance_exec(&block)
+    end
+    
+    def blank?
+      @association_configs.blank?
+    end
+    
+    def [](association_name)
+      @association_configs.detect {|a| a.name == association_name.to_sym }
+    end
+    
+    def association(name, fields = [], &block)
+      @association_configs << Association.new(name, fields, &block)
+    end
+    
+    def associations(*names)
+      names.each do |name|
+        @association_configs << Association.new(name)
+      end
+    end
+  end
+end

data/lib/active_admin_associations/autocompleter.rb

@@ -0,0 +1,64 @@
+module ActiveAdminAssociations
+  module Autocompleter
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def autocomplete(attribute, options = {})
+        class_attribute :autocomplete_attribute
+        class_attribute :autocomplete_options
+
+        self.autocomplete_attribute = attribute
+        self.autocomplete_options = options
+
+        extend AutocompleteMethods
+      end
+    end
+
+    module AutocompleteMethods
+      def autocomplete_results(query)
+        results = where("LOWER(#{table_name}.#{autocomplete_attribute}) LIKE ?", "#{query.downcase}%").
+          order("#{table_name}.#{autocomplete_attribute} ASC")
+        results.map do |record|
+          _autocomplete_format_result(record)
+        end
+      end
+      
+      private
+      
+      def _autocomplete_format_result(record)
+        if configured_autocomplete_result_formatter?
+          aa_associations_config.autocomplete_result_formatter.call(record,
+            autocomplete_attribute, autocomplete_options)
+        else
+          label = _format_autocomplete_label(record)
+          {"label"  => label, # This plays nice with both jQuery UI autocomplete and jquery.tokeninput
+            "value" => record.send(autocomplete_attribute), 
+            "id"    => record.id}
+        end
+      end
+      
+      def _format_autocomplete_label(record)
+        if autocomplete_options[:format_label].present?
+          if autocomplete_options[:format_label].is_a?(Symbol)
+            record.send(autocomplete_options[:format_label])
+          elsif autocomplete_options[:format_label].respond_to?(:call)
+            autocomplete_options[:format_label].call(record)
+          else
+            record.send(autocomplete_attribute)
+          end
+        else
+          record.send(autocomplete_attribute)
+        end
+      end
+      
+      def configured_autocomplete_result_formatter?
+        aa_associations_config.autocomplete_result_formatter.present? &&
+          aa_associations_config.autocomplete_result_formatter.respond_to?(:call)
+      end
+      
+      def aa_associations_config
+        Rails.application.config.aa_associations
+      end
+    end
+  end
+end

data/lib/active_admin_associations/engine.rb

@@ -0,0 +1,25 @@
+module ActiveAdminAssociations
+  class Engine < Rails::Engine
+    config.aa_associations = ActiveSupport::OrderedOptions.new
+    
+    initializer "active_admin_associations.load_extensions" do |app|
+      ActiveAdmin::BaseController.helper ActiveAdminAssociationsHelper
+      ActiveAdmin::ResourceDSL.send(:include, ActiveAdminAssociations::AssociationActions)
+      ActiveAdmin::ResourceDSL.send(:include, ActiveAdminAssociations::FormConfigDSL)
+      
+      unless app.config.aa_associations.destroy_redirect == false
+        ActiveAdmin::BaseController.send(:include, ActiveAdminAssociations::RedirectDestroyActions)
+      end
+      
+      unless app.config.aa_associations.autocomplete == false
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::Base.send(:include, ActiveAdminAssociations::Autocompleter)
+        end
+      
+        Formtastic::Helpers::InputHelper.send(:include, Formtastic::TokenInputDefaultForAssociation)
+      end
+      
+      ActiveAdmin.application.register_stylesheet 'active_admin_associations'
+    end
+  end
+end

data/lib/active_admin_associations/form_config_dsl.rb

@@ -0,0 +1,15 @@
+module ActiveAdminAssociations
+  module FormConfigDSL
+    def active_association_form(&block)
+      config.active_association_form = block
+    end
+
+    def form_columns(*column_names)
+      config.form_columns = column_names.flatten
+    end
+
+    def form_associations(&block)
+      config.form_associations = AssociationConfig.new(&block)
+    end
+  end
+end

data/lib/active_admin_associations/redirect_destroy_actions.rb

@@ -0,0 +1,7 @@
+module ActiveAdminAssociations
+  module RedirectDestroyActions
+    def destroy
+      destroy!{ request.headers["Referer"].presence || admin_dashboard_url }
+    end
+  end
+end

data/lib/active_admin_associations/version.rb

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

data/lib/formtastic/inputs/token_input.rb

@@ -0,0 +1,43 @@
+module Formtastic
+  module Inputs
+    class TokenInput
+      include Base
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+            builder.hidden_field(input_name, input_html_options)
+        end
+      end
+      
+      def input_html_options
+        super.merge({
+         :required          => nil,
+         :autofocus         => nil,
+         :class             => 'token-input',
+         'data-model-name' => reflection.klass.model_name.singular
+        }).tap do |html_options|
+          if record.present?
+            html_options["data-pre"] = prepopulated_value.to_json
+          end
+        end
+      end
+      
+      def prepopulated_value
+        [{"value" => name_value, "id" => record.id}]
+      end
+      
+      def name_method
+        builder.collection_label_methods.find { |m| record.respond_to?(m) }
+      end
+      
+      def name_value
+        record.send(name_method)
+      end
+      
+      def record
+        @object.send(method)
+      end
+    end
+  end
+end

data/lib/formtastic/token_input_default_for_association.rb

@@ -0,0 +1,19 @@
+module Formtastic
+  module TokenInputDefaultForAssociation
+    extend ActiveSupport::Concern
+    
+    included do
+      alias_method_chain :default_input_type, :token_default_for_association
+    end
+    
+    def default_input_type_with_token_default_for_association(method, options = {})
+      if @object
+        reflection = reflection_for(method)
+        if reflection && reflection.klass.respond_to?(:autocomplete_attribute) && reflection.macro == :belongs_to
+          return :token
+        end
+      end
+      default_input_type_without_token_default_for_association(method, options)
+    end
+  end
+end

data/test/active_admin_associations_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class ActiveAdminAssociationsTest < ActionDispatch::IntegrationTest
+  setup do
+    admin_login_as
+    @post = Factory(:post)
+    @tag = Factory(:tag)
+    @post.tags = [@tag]
+  end
+  
+  context 'editing a post' do
+    setup do
+      visit "/admin/posts/#{@post.id}/edit"
+    end
+    
+    should 'have correct inputs from form_columns config' do
+      assert page.has_selector?('form.post fieldset.inputs input#post_title'), 'no input for Post title'
+      assert page.has_selector?('form.post fieldset.inputs textarea#post_body'), 'no input for Post body'
+      assert page.has_selector?('form.post fieldset.inputs input#post_creator_id'), 'no input for Post creator'
+    end
+    
+    should 'have correct inputs from active_association_form config' do
+      assert page.has_selector?('form.post fieldset#more-inputs input.my-date-picker#post_published_at'), 'no input for Post published_at'
+      assert page.has_selector?('form.post fieldset#more-inputs input#post_featured'), 'no input for Post featured'
+    end
+    
+    should 'have correct token input for post creator' do
+      token_input = page.find('form.post fieldset.inputs input.token-input#post_creator_id')
+      assert_equal 'hidden', token_input["type"]
+      assert_equal 'user', token_input['data-model-name']
+      assert_equal '1', token_input['value']
+      assert_equal [{"value" => "Bill Tester", "id" => @post.creator_id}], MultiJson.decode(token_input['data-pre'])
+    end
+    
+    should 'have a form to relate new tags' do
+      assert page.has_selector?('.relationship-table#relationship-table-tags form.relate-to-form')
+      assert page.has_selector?('#relationship-table-tags form.relate-to-form input[type="hidden"]#relationship_name')
+      assert_equal 'tags', page.find('#relationship-table-tags form.relate-to-form input#relationship_name')['value']
+      token_input = page.find('#relationship-table-tags form.relate-to-form input.token-input#related_id')
+      assert_equal 'tag', token_input['data-model-name']
+    end
+    
+    should 'have a table of the related tags' do
+      assert page.has_xpath?('//div[@id="relationship-table-tags"]//table[@class="index_table"]/thead//th[text()="Name"]')
+      assert_equal @tag.name, page.find(:xpath, "//div[@id='relationship-table-tags']//table[@class='index_table']/tbody//tr[td[1][text()=#{@tag.id}]]//td[2]").text
+      edit_link = page.find(:xpath, "//div[@id='relationship-table-tags']//table[@class='index_table']/tbody//tr/td[3]/a[text()='Edit']")
+      assert_match %r{\A/admin/tags/\d+/edit}, edit_link['href']
+      
+      assert page.has_xpath?("//div[@id='relationship-table-tags']//table[@class='index_table']/tbody//tr/td[3]/form//input[@type='submit'][@value='Unrelate']")
+      unrelate_form = page.find(:xpath, "//div[@id='relationship-table-tags']//table[@class='index_table']/tbody//tr/td[3]/form[@class='button_to']")
+      unrelate_url = unrelate_form['action']
+      assert_match %r{\A/admin/posts/#{@post.id}/unrelate}, unrelate_url
+      query_params = unrelate_url.split('?')[1].split('&')
+      assert_same_elements ["related_id=#{@tag.id}", 'relationship_name=tags'], query_params
+    end
+  end
+
+  context 'editing a tag' do
+    setup do
+      visit "/admin/tags/#{@tag.id}/edit"
+    end
+    
+    should 'have a table of the related posts' do
+      assert page.has_xpath?('//div[@id="relationship-table-posts"]//table[@class="index_table"]/thead//th[text()="Title"]')
+      assert_equal @post.title, page.find(:xpath, "//div[@id='relationship-table-posts']//table[@class='index_table']/tbody//tr[td[1][text()=#{@post.id}]]//td[2]").text
+      assert_equal @post.creator.name, page.find(:xpath, "//div[@id='relationship-table-posts']//table[@class='index_table']/tbody//tr[td[1][text()=#{@post.id}]]//td[3]").text
+    end
+  end
+end