activeadmin_dynamic_fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ee6e7b7330564161d89fc27dca1c94c33c17e24
+  data.tar.gz: 95dd1da212342bd8531f270426e5666403f691de
+SHA512:
+  metadata.gz: b3c5c278abee8e3ce1befd06ddf91236a02467ee3a80e905942718ddd0f58896ad592ba098cf876def36b2f12b529e38fab13ea4e3ccb8b69a3e63644ebf1af3
+  data.tar.gz: 6c929053ca401f09a8901f97f81f23b0cfbfe93a8fe74933b5270054de7081e4757fd2d67f63d185de534996018a6cddce3cdad7a4e216bcbc4df8f038ae5be0

data/.gitignore

@@ -0,0 +1,3 @@
+_misc/
+
+*.orig

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2017 Mattia Roccoberton
+
+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,149 @@
+# ActiveAdmin Dynamic Fields [![Gem Version](https://badge.fury.io/rb/activeadmin_dynamic_fields.svg)](https://badge.fury.io/rb/activeadmin_dynamic_fields)
+
+An Active Admin plugin to add dynamic behaviors to fields.
+
+Features:
+
+- set conditional checks on fields
+- trigger some actions on other fields
+- create links to load some content in a dialog
+
+The easiest way to show how this plugin works is looking the examples (below).
+
+## Install
+
+- Add to your Gemfile: `gem 'activeadmin_dynamic_fields'`
+- Execute bundle
+- Add at the end of your ActiveAdmin styles (_app/assets/stylesheets/active_admin.scss_):
+`@import 'activeadmin/dynamic_fields';`
+- Add at the end of your ActiveAdmin javascripts (_app/assets/javascripts/active_admin.js_):
+`//= require activeadmin/dynamic_fields`
+
+## Options
+
+Options are passed to fields using *input_html* parameter:
+
+- **data-if**: check a condition, values:
+  + **checked**: check if a checkbox is checked
+  + **not_checked**: check if a checkbox is not checked
+  + **blank**: check if a field is blank
+  + **not_blank**: check if a field is not blank
+- **data-eq**: check if a field has a specific value
+- **data-not**: check if a field hasn't a specific value
+- **data-function**: check the return value of a custom function
+- **data-target**: target css selector
+- **data-action**: the action to trigger, values:
+  + **hide**: hides elements
+  + **slide**: hides elements (using sliding)
+  + **fade**: hides elements (using fading)
+  + **setValue**: set a value
+  + **callback**: call a function
+- **data-value**: value to set
+- **data-callback**: custom function for setting a value
+- **data-arg**: argument passed to the custom set function
+
+## Examples of dynamic fields
+
+- A checkbox that hides other fields if false (ex. model *Article*):
+
+```rb
+form do |f|
+  f.inputs 'Article' do
+    f.input :published, input_html: { 'data-if': 'not_checked', 'data-action': 'hide', 'data-target': '.grp1' }
+    f.input :online_date, wrapper_html: { class: 'grp1' }
+    f.input :position, wrapper_html: { class: 'grp1' }
+  end
+  f.actions
+end
+```
+
+- Set another field value if a string field is blank:
+
+`f.input :title, input_html: { 'data-if': 'blank', 'data-action': 'setValue', 'data-target': '#article_position', 'data-value': '10' }`
+
+- Use a custom function for conditional check (*title_not_empty()* must be available on global scope):
+
+`f.input :title, input_html: { 'data-function': 'title_empty', 'data-action': 'slide', 'data-target': '#article_description_input' }`
+
+```js
+function title_empty( el ) {
+  return ( $('#article_title').val().trim() === '' );
+}
+```
+
+- Call a callback function as action:
+
+`f.input :published, input_html: { 'data-if': 'checked', 'data-action': 'callback', 'data-callback': 'set_title', 'data-args': '["[unpublished]"]' }`
+
+```js
+function set_title( args ) {
+  if( $('#article_title').val().trim() === '' ) {
+    $('#article_title').val( args[0] );
+    $('#article_title').trigger( 'change' );
+  }
+}
+```
+
+- Custom function without action:
+
+`f2.input :category, as: :select, collection: [ [ 'Cat 1', 'cat1' ], [ 'Cat 2', 'cat2' ], [ 'Cat 3', 'cat3' ] ], input_html: { 'data-function': 'on_change_category' }`
+
+```js
+function on_change_category( el ) {
+  var target = el.closest( 'fieldset' ).find( '.pub' );
+  target.prop( 'checked', ( el.val() == 'cat2' ) );
+  target.trigger( 'change' );
+}
+```
+
+## Example to open a dialog
+
+Example with 2 models: *Author* and *Article*
+
+Prepare the content dialog - in Active Admin Author config:
+
+```rb
+ActiveAdmin.register Author do
+  # ...
+  member_action :dialog do
+    content  = '<dl>'
+    [:name, :age, :created_at].each do |field|
+      content += "<dt>#{Author.human_attribute_name(field)}:</dt><dd>#{resource[field]}</dd>"
+    end
+    content += '</dl>'
+    render plain: content
+  end
+  # ...
+end
+```
+
+Add a link to show the dialog - in Active Admin Article config:
+
+```rb
+ActiveAdmin.register Article do
+  # ...
+  show do |object|
+    attributes_table do
+      # ...
+      row :author do
+        link_to object.author.name, dialog_admin_author_path( object.author ), title: object.author.name, 'data-df-dialog': true, 'data-df-icon': true
+      end
+    end
+  end
+  # ...
+end
+```
+
+The link url is loaded via AJAX before opening the dialog.
+
+## Do you like it? Star it!
+
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+## Contributors
+
+- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer
+
+## License
+
+[MIT](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"

data/activeadmin_dynamic_fields.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activeadmin/dynamic_fields/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activeadmin_dynamic_fields'
+  spec.version       = ActiveAdmin::DynamicFields::VERSION
+  spec.summary       = 'Dynamic fields for ActiveAdmin'
+  spec.description   = 'An Active Admin plugin to add dynamic behaviors to fields'
+  spec.license       = 'MIT'
+  spec.authors       = ['Mattia Roccoberton']
+  spec.email         = 'mat@blocknot.es'
+  spec.homepage      = 'https://github.com/blocknotes/activeadmin_dynamic_fields'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activeadmin', '~> 1.0'
+end

data/app/assets/javascripts/activeadmin/dynamic_fields.js

@@ -0,0 +1,114 @@
+
+function dfEvalCondition( el, args ) {
+  if( args.fn ) {
+    if( args.fn && window[args.fn] ) return !window[args.fn]( el );
+    else console.log( 'Warning - activeadmin_dynamic_fields: ' + args.fn + '() not available [1]' );
+  }
+  else if( args.if == 'checked' ) {
+    return !el.is(':checked');
+  }
+  else if( args.if == 'not_checked' ) {
+    return el.is(':checked');
+  }
+  else if( args.if == 'blank' ) {
+    return el.val().length === 0 || !el.val().trim();
+  }
+  else if( args.if == 'not_blank' ) {
+    return el.val().length !== 0 && el.val().trim();
+  }
+  else if( args.eq ) {
+    return el.val() == args.eq;
+  }
+  else if( args.not ) {
+    return el.val() != args.not;
+  }
+  return undefined;
+}
+
+function dfSetupField( el ) {
+  var action = el.data( 'action' );
+  var target, args = {};
+  args.if = el.data( 'if' );
+  args.eq = el.data( 'eq' );
+  args.not = el.data( 'not' );
+  args.fn = el.data( 'function' );
+  if( el.data( 'target' ) ) target = el.closest( 'fieldset' ).find( el.data( 'target' ) )
+  if( action == 'hide' ) {
+    if( dfEvalCondition( el, args ) ) target.show();
+    else target.hide();
+    el.on( 'change', function( event ) {
+      if( dfEvalCondition( $(this), args ) ) target.show();
+      else target.hide();
+    });
+  }
+  else if( action == 'slide' ) {
+    if( dfEvalCondition( el, args ) ) target.slideDown();
+    else target.slideUp();
+    el.on( 'change', function( event ) {
+      if( dfEvalCondition( $(this), args ) ) target.slideDown();
+      else target.slideUp();
+    });
+  }
+  else if( action == 'fade' ) {
+    if( dfEvalCondition( el, args ) ) target.fadeIn();
+    else target.fadeOut();
+    el.on( 'change', function( event ) {
+      if( dfEvalCondition( $(this), args ) ) target.fadeIn();
+      else target.fadeOut();
+    });
+  }
+  else if( action == 'setValue' ) {
+    var val = el.data( 'value' ) ? el.data( 'value' ) : '';
+    if( dfEvalCondition( el, args ) ) dfSetValue( target, val );
+    el.on( 'change', function( event ) {
+      if( dfEvalCondition( $(this), args ) ) dfSetValue( target, val );
+    });
+  }
+  else if( action == 'callback' ) {
+    var cb = el.data( 'callback' );
+    if( cb && window[cb] ) {
+      if( dfEvalCondition( el, args ) ) window[cb]( el.data( 'args' ) );
+      el.on( 'change', function( event ) {
+        if( dfEvalCondition( $(this), args ) ) window[cb]( el.data( 'args' ) );
+      });
+    }
+    else console.log( 'Warning - activeadmin_dynamic_fields: ' + cb + '() not available [2]' );
+  }
+  else if( args.fn ) {  // function without action
+    dfEvalCondition( el, args );
+    el.on( 'change', function( event ) {
+      dfEvalCondition( el, args );
+    });
+  }
+}
+
+function dfSetValue( el, val ) {
+  if( el.attr('type') != 'checkbox' ) el.val( val );
+  else el.prop('checked', val == '1');
+  el.trigger( 'change' );
+}
+
+$(document).ready( function() {
+  $('[data-df-dialog]').on( 'click', function( event ) {
+    event.preventDefault();
+    if( $('#df-dialog').length == 0 ) $('body').append( '<div id="df-dialog"></div>' );
+    var title = $(this).attr( 'title' );
+    $.ajax({
+      url: $(this).attr( 'href' )
+    }).done( function( result ) {
+      if( title ) $('#df-dialog').attr( 'title', title );
+      $('#df-dialog').html( result );
+      $('#df-dialog').dialog({ modal: true });
+    });
+  });
+
+  $('[data-if], [data-function], [data-eq], [data-not]').each( function() {
+    dfSetupField( $(this) );
+  });
+
+  $('.has_many_container').on( 'has_many_add:after', function( e, fieldset, container ) {
+    $('[data-if], [data-function], [data-eq], [data-not]').each( function() {
+      dfSetupField( $(this) );
+    });
+  });
+});

data/app/assets/stylesheets/activeadmin/_dynamic_fields.sass

@@ -0,0 +1,13 @@
+body.active_admin
+  a[data-df-icon]::after
+    content: ' •'
+  // .ui-dialog
+  //   .ui-dialog-titlebar
+  //     display: flex
+  //     justify-content: space-between
+  //     > *
+  //       align-self: center
+  //   // .ui-dialog-buttonset
+  //   //   text-align: right
+  #df-dialog
+    padding: 10px 15px 5px 15px

data/lib/activeadmin/dynamic_fields/engine.rb

@@ -0,0 +1,9 @@
+require 'active_admin'
+
+module ActiveAdmin
+  module DynamicFields
+    class Engine < ::Rails::Engine
+      engine_name 'activeadmin_dynamic_fields'
+    end
+  end
+end

data/lib/activeadmin/dynamic_fields/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module DynamicFields
+    VERSION = '0.1.0'
+  end
+end

data/lib/activeadmin/dynamic_fields.rb

@@ -0,0 +1 @@
+require 'activeadmin/dynamic_fields/engine'

data/lib/activeadmin_dynamic_fields.rb

@@ -0,0 +1 @@
+require 'activeadmin/dynamic_fields'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin_dynamic_fields
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: An Active Admin plugin to add dynamic behaviors to fields
+email: mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeadmin_dynamic_fields.gemspec
+- app/assets/javascripts/activeadmin/dynamic_fields.js
+- app/assets/stylesheets/activeadmin/_dynamic_fields.sass
+- lib/activeadmin/dynamic_fields.rb
+- lib/activeadmin/dynamic_fields/engine.rb
+- lib/activeadmin/dynamic_fields/version.rb
+- lib/activeadmin_dynamic_fields.rb
+homepage: https://github.com/blocknotes/activeadmin_dynamic_fields
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Dynamic fields for ActiveAdmin
+test_files: []