Skip to content
This gem extends formtastic's form builder to support custom fields and sections for your Active Admin models
Ruby HTML CoffeeScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app/assets
lib
spec
tasks
.gitignore
Gemfile
Guardfile
LICENSE.txt
README.md
Rakefile
activeadmin-magicfields.gemspec

README.md

Activeadmin Magicfields

Activeadmin Magicfields gem is made to bring simple sections and custom field support into your ActiveAdmin. It aims to bring some of Wordpress' Advanced Custom Fields plugin features to Active Admin. Its development was greatly inspired by Petr Sergeev's and Sindre Moen's activeadmin_polymorphic gem.

This gem includes a lot of hacks and tricks, and has been developed mainly as an experiment. Use carefully and at your own risk. Please feel free to create pull requests for improvements or bug fixes.

Installing the gem enables the user to create section templates (called parts) straight from the admin panel, defining which field types should be included in a part.

create a part

Then, users can add parts to Active Admin models with the click of a button, and simply fill in their content.

fill the content

Features

  • Part creation from custom fields (default field types are: text, textarea, image, checkbox and repeater. See down to add your own field types)
  • Add parts and content to Active Admin model
  • Form Validation
  • Sortable behaviour
  • File uploads

Installation

Add this to your Gemfile:

gem "activeadmin-magicfields"

and run bundle install, then rails g activeadmin-magicfields:install, and finally rake db:migrate.

Include assets in js and css manifests

# assets/javascripts/active_admin.js.coffee
# ...
#= require activeadmin-magicfields
# ...

// assets/stylesheets/active_admin.scss
// ...
@import "activeadmin-magicfields";
// ...

Usage

To use the gem, you need to enable parts on one of your models (in the following example, we add parts to the Page model)

# db/migrate
class CreatePagesParts < ActiveRecord::Migration
  def change
    create_table :pages_parts do |t|
      t.integer :page_id
      t.integer :part_id
    end
  end
end
# models/page.rb
class Page < ActiveRecord::Base
  # ...

  has_many :part_objects, dependent: :destroy, inverse_of: :base_model, foreign_key: "base_model_id"
  has_and_belongs_to_many :parts
  accepts_nested_attributes_for :part_objects, allow_destroy: true

  # ...
end

The gem extends activeadmin's form builder, so to enable it you need to override the form builder using builder option:

#admin/page.rb
ActiveAdmin.register Page do
  # ...

  form builder: ActiveadminMagicfields::FormBuilder, html: { :enctype => "multipart/form-data" } do |f|
    f.inputs do
      # ...
      f.sections_has_many :parts, collection: Part.includes(:field_templates).all, part_objects: resource.part_objects, sortable: :position
    end
    f.actions
  end

  # ...
end

There are few parameters available, currently none of which can be changed:

  • the first is the name of the parts association
  • the second parameter refers to the available parts (previously created in the admin panel)
  • part_objects loads the pre-existing parts associated with the edited object
  • sortable - enables drag'n'drop for parts

Adding a custom field type

To add a custom field type, just create a table called 'field_[your_field_type]s', a model in models/field/your_field_type.rb, and a form partial. This will enable you to use your_field_type as a part's custom field. In the following example, we create the textarea field type. (In views/admin/field_inputs/_textarea.html.erb, you can also find an example of how to make this field a WYSIWYG field)

# db/migrate
class CreateFieldTextarea < ActiveRecord::Migration
  def change
    create_table :field_textareas do |t|
      t.string :title #required for all field types
      t.integer :field_template_id #required for all field types

      t.text :textarea

      t.timestamps
    end
  end
end

# models/field/textarea.rb
module Field
  class Textarea < ActiveRecord::Base
    self.table_name = "field_textareas"

    has_one :part_object_field, as: :fieldable
    belongs_to :field_template

    delegate :title, to: :field_template, allow_nil: true
    delegate :is_required, to: :field_template, allow_nil: true

    validates :textarea, presence: { if: :is_required }

  end
end
<%# views/admin/field_inputs/_textarea.html.erb %>
<%= builder.input field_template.field_type, label: field_template.title, required: field_template.is_required, input_html: {name: form_prefix + builder.object_name.sub('part[', '[') + "[#{field_template.field_type}]" } %>

Testing

As this gem was created the quick'n'dirty way as a fast experiment, tests are not up-to-date at all.

In plan

  • Fix strong parameters (currently, the gem accepts any parameters submission)
  • Namespace everything to avoid conflicts
  • Make proper tests
  • Make more thing customizable (eg. the names 'parts' and 'part_objects' could be defined by user)
  • Improve the form UI, currently pretty raw.
  • Repeater fields could allow a selection of parts (or define their own).

License

MIT

You can’t perform that action at this time.