activeadmin-magicfields 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2fa74a59fbf379bacb891c95d2fe0ef60b6ba14
+  data.tar.gz: e4fed1594cfac9aecf652c9514542dabdaf20470
+SHA512:
+  metadata.gz: d6d6f9f3836941469d5863eddba3f55460e8ac5415383e24592a906d912cb540115f2b8fa313b1ae2489fac41868941c14fcb7fdc704adb18b3e3403f414b129
+  data.tar.gz: 5ba2fdf9cdd43681fd5796c0284017a7a906519c784c0c74506f706554099c89a993cdf50a27877c0b7adc8b99ef56851667844b429385df30cf3c5f98d49cea

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,42 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activeadmin', github: 'activeadmin'
+gem 'inherited_resources'
+gem 'paperclip'
+# gem 'activeadmin-wysihtml5', github: 'silvaire/activeadmin-wysihtml5'
+
+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-magicfields/(.+)\.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,160 @@
+# 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](http://www.advancedcustomfields.com/) plugin features to Active Admin. Its development was greatly inspired by Petr Sergeev's and Sindre Moen's `activeadmin_polymorphic` [gem](https://github.com/hyperoslo/activeadmin_polymorphic).
+
+This gem includes a lot of hacks and tricks, and has been developed mainly as an experiment. Use carefully and at your own risk.
+
+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](http://i.imgur.com/XJbuHXx.png)
+
+Then, users can add parts to Active Admin models with the click of a button, and simply fill in their content.
+
+![fill the content](http://i.imgur.com/mQ0vSGb.png)
+
+# 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:
+
+``` ruby
+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
+
+```
+# db/migrate
+class CreateYourModelsParts < ActiveRecord::Migration
+  def change
+    create_table :your_models_parts do |t|
+      t.integer :your_model_id
+      t.integer :part_id
+    end
+  end
+end
+```
+
+```
+# models/your_model.rb
+class YourModel < 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/your_model.rb
+ActiveAdmin.register YourModel 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.
+
+```
+# db/migrate
+class CreateFieldYourFieldType < ActiveRecord::Migration
+  def change
+    create_table :field_your_field_types do |t|
+      t.string :title #required for all field types
+      t.integer :field_template_id #required for all field types
+
+      t.[some_database_type] :your_field_type
+
+      t.timestamps
+    end
+  end
+end
+```
+
+```
+# models/field/your_field_type.rb
+module Field
+  class YourFieldType < ActiveRecord::Base
+    self.table_name = "field_your_field_types"
+
+    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 :your_field_type, presence: { if: :is_required }
+
+  end
+end
+```
+
+```
+<%# views/admin/field_inputs/_your_field_type.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](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-magicfields.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "activeadmin-magicfields/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.license     = "MIT"
+  s.name        = "activeadmin-magicfields"
+  s.version     = ActiveadminMagicfields::VERSION
+  s.authors     = ["Silvain Toromanoff"]
+  s.email       = ["silvain@agencyleroy.com"]
+  s.description = 'This gem extends formtastic\'s form builder to support custom sections and fields in your forms'
+  s.summary     = 'Custom fields and sections for active admin.'
+  s.homepage    = ""
+
+  s.files         = `git ls-files`.split("\n").sort
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+
+  s.add_dependency "activeadmin"
+  s.add_dependency "inherited_resources"
+  s.add_dependency "paperclip"
+end

data/app/assets/javascripts/activeadmin-magicfields.js.coffee

@@ -0,0 +1,101 @@
+$ ->
+  init_sections_sortable()
+  activateAJAXwysiwyg()
+  activateAJAXsortable()
+
+  $(document).on 'click', 'a.button.section_has_many_remove', (e)->
+    e.preventDefault()
+    parent    = $(@).closest '.section_has_many_container'
+    to_remove = $(@).closest 'fieldset'
+    recompute_positions parent
+
+    parent.trigger 'section_has_many_remove:before', [to_remove, parent]
+    to_remove.remove()
+    parent.trigger 'section_has_many_remove:after', [to_remove, parent]
+
+  $(document).on 'click', 'a.button.section_has_many_add', (e)->
+    e.preventDefault()
+    parent = $(@).closest '.section_has_many_container'
+    parent.trigger before_add = $.Event('section_has_many_add:before'), [parent]
+
+    unless before_add.isDefaultPrevented()
+      index = parent.data('section_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 'section_has_many_add:after', [fieldset, parent]
+
+  $('.json_container').on 'change', '.section_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).parents('ol').first().remove()#replaceWith hiddenField
+
+    newListItem = $ '<li>'
+
+    formName = $(this).attr('name').split("[parts]")[0]
+
+    extractAndInsertSectionForm formPath, fieldset, formName
+
+activateAJAXwysiwyg = ->
+  $(document).ajaxSuccess( ->
+    $('.wysihtml5:not(.initialized)').each( ->
+      editor = new wysihtml5.Editor($(this).find('textarea').attr('id'), # id of textarea element
+      { 
+        toolbar: $(this).find('.toolbar').attr('id'),                    # id of toolbar element
+        parserRules:  wysihtml5ParserRules                               # defined in parser rules set 
+      })
+      $(@).addClass('initialized')
+    )
+  )
+
+activateAJAXsortable = ->
+  $(document).ajaxSuccess( ->
+    init_sections_sortable()
+  )
+
+
+window.extractAndInsertSectionForm= (url, target, formName)->
+  target = $ target
+
+  $.get url + "?form_name=#{formName}", (data) ->
+    target.prepend data
+    return false
+
+
+init_sections_sortable = ->
+  elems = $('.json_container[data-sortable]:not(.ui-sortable)')
+  if elems.length
+    elems.sortable
+      axis: 'y'
+      items: '> fieldset',
+      handle: '> ol > .handle',
+      stop: recompute_positions
+    elems.each recompute_positions
+
+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 "> .input > :input[name$='[_destroy]']"
+    sortable_input = $(@).find "> .input > :input[name$='[#{input_name}]']"
+
+    if sortable_input.length
+      sortable_input.val if destroy_input.is ':checked' then '' else position++