simple_form_extension 1.2.21 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e370539cbb41a3fadee1616fab1de6f18e4e72c1
-  data.tar.gz: a3e2e7f10511fd4bd99779e256f4f281365be79d
+  metadata.gz: 88f0bf75c6d43b626fe22ec5fdb9771157da4eb2
+  data.tar.gz: 380443d6c110fcbc8949bf3900a90ae5cd92a006
 SHA512:
-  metadata.gz: 35be6562973b9c43412da2b3459b8b7e286f75919a313d55f5500ff56c4e241cd153197463e85510cd5daaa5435f3c2c9a107554a0b32993e9bbd3b894b4ab5a
-  data.tar.gz: 0669e178bcd964fbfeee69bec192eddc1b2a35e0e5f9717e01477ab0fbc1ad60160ecc6a4569c77a165da747a435d038d17411f7de01ee5b3681e6820f677d47
+  metadata.gz: 90f046a027bae80df700bdbbc4bcb50cb8b9f1b115e15dbed2ce43c305e9b61fb31343f2f240033c81362a2db600ff387c5fbec141654ea4148b13e0574329e7
+  data.tar.gz: 3dc2a04b168821621c36bfaf1e5190fd180b36e4d07e1c049cafd72479d5ee44e16686b46baa69ed1503d6567242059852e8209bdff23cd9f930ea017de55412

data/README.md

@@ -16,6 +16,18 @@ Or install it yourself as:
 
     $ gem install simple_form_extension
 
+Add to your `application.css` :
+
+```css
+ *= require simple_form_extension
+```
+
+Add to your `application.js` :
+
+```javascript
+//= require simple_form_extension
+```
+
 ## Usage
 
 To use the popover component, please include in a javascript file :
@@ -24,18 +36,65 @@ To use the popover component, please include in a javascript file :
 $('body').popover(selector: '[rel="popover"]')
 ```
 
-For the [Redactor](https://github.com/SammyLin/redactor-rails) component to
-work, require the javascript files :
+### Available inputs
+
+The following custom Simple Form inputs are available :
+
+* boolean
+* collection_check_boxes
+* collection_radio_buttons
+* color
+* date_time
+* file
+* image
+* numeric
+* redactor
+* selectize
+* slider
+
+### Javascript Plugins
+
+Simple Form Extension comes with several javascript plugins built-in for the
+inputs to work properly.
+
+Plugins are automatically initialized on page load, with or without Turbolinks.
+
+This means that for a classic page you don't need to initialize anything yourself.
+
+#### Manual javascript plugins initialization
+
+If you append some HTML, after the page is loaded, containing inputs that you
+need to initialize, you'll need to manually call the Simple Form Extension
+plugins initialization method.
+
+> Note : Most of the javascript-bound inputs need their associated plugin to be
+run to build their final appearance. So their initialization can't be deferred,
+and you need to initialize them manually when appending HTML to the page after
+the page is loaded
+
+All you need to do is calling the following `simpleForm` jQuery plugin :
 
 ```javascript
-//= require simple_form_extension
+$fragment.simpleForm()`
 ```
 
-TODO: Write usage instructions here
+As an example, if you're loading a form from the server, you can do the
+following :
+
+```javascript
+$.get('/form/url', function(response) {
+  // Store the fragment loaded from the server in a variable
+  $fragment = $(response)
+  // Append it to the DOM
+  $fragment.appendTo('body')
+  // Initialize Simple Form Extension plugins
+  $fragment.simpleForm()
+})
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/simple_form_extension/fork )
+1. Fork it ( http://github.com/xana68/simple_form_extension/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/simple_form_extension/version.rb

@@ -1,3 +1,3 @@
 module SimpleFormExtension
-  VERSION = "1.2.21"
+  VERSION = "1.3.0"
 end

data/vendor/assets/javascripts/simple_form_extension.coffee

@@ -10,10 +10,30 @@
 #= require_self
 #= require_tree ./simple_form_extension
 
-$.fn.simpleForm = {}
+$.simpleForm =
+  # Bind a callback to run when a DOM or sub-DOM is ready to be initialized
+  # Allows abstracting the following cases :
+  #   - Document is ready with $(document).ready()
+  #   - Document is ready with Turbolinks $(document).on('page:change')
+  #   - A sub-DOM is dynamically added and needs all the plugins to be
+  #     initialized, ex: for nested forms
+  #
+  onDomReady: (callback) ->
+    $(document).on 'initialize.simpleform', (e, $fragment) ->
+      callback($fragment)
 
-window.onPageReady = (callback) ->
-  $(document).ready ->
-    callback() if window.Turbolinks is undefined
+# Trigger all the registered callbacks and run them on the target element
+$.fn.simpleForm = ->
+  @each (i, fragment) ->
+    $(document).trigger('initialize.simpleform', [$(fragment)])
 
-  $(document).on('page:change', callback);
+# Classic document ready binding
+# Does not run when Turbolinks is present and supported by the browser
+#
+$(document).ready ->
+  $('body').simpleForm() unless window.Turbolinks && window.Turbolinks.supported
+
+# Turbolinks document ready binding
+#
+$(document).on 'page:change', ->
+  $('body').simpleForm()

data/vendor/assets/javascripts/simple_form_extension/colorpicker.coffee

@@ -9,5 +9,5 @@ $.fn.simpleFormColorpicker = ->
     instance = new ColorPicker($input)
     $input.data('simple-form:colorpicker', instance)
 
-onPageReady ->
-  $('[data-colorpicker]').simpleFormColorpicker()
+$.simpleForm.onDomReady ($document) ->
+  $document.find('[data-colorpicker]').simpleFormColorpicker()

data/vendor/assets/javascripts/simple_form_extension/datetimepicker.coffee

@@ -40,8 +40,12 @@ class TimePicker extends DateTimePicker
       format: @$input.data('format')
     )
 
-# Lazy initialization of date and datetime pickers
-onPageReady ->
+
+$.simpleForm.onDomReady ($document) ->
+  # Plugin initialization delegated to body, so we do not need to run the
+  # initialization process when the body has not changed
+  return unless $document.is('body')
+
   $('body').on 'click', 'input.datetime', (e) ->
     DateTimePicker.forInput($(e.currentTarget), DateTimePicker).show()
 
@@ -55,11 +59,11 @@ onPageReady ->
   $('body').on 'click', '.date .datetimepicker-trigger', (e) ->
     $input = $(e.currentTarget).closest('.date').find('input.date')
     DatePicker.forInput($input, DatePicker).show()
-    
+
   $('body').on 'click', 'input.time', (e) ->
     TimePicker.forInput($(e.currentTarget), TimePicker).show()
 
   $('body').on 'click', '.time .datetimepicker-trigger', (e) ->
     $input = $(e.currentTarget).closest('.time').find('input.time')
     TimePicker.forInput($input, TimePicker).show()
-      
+

data/vendor/assets/javascripts/simple_form_extension/fileinput.coffee

@@ -26,7 +26,11 @@ class ExistingFileField
     @$existingFile.show(0)
     @$removeButtonIcon.attr(class: @originalClass)
 
-onPageReady ->
+$.simpleForm.onDomReady ($document) ->
+  # Plugin initialization delegated to body, so we do not need to run the
+  # initialization process when the body has not changed
+  return unless $document.is('body')
+
   $('body').on 'click', '[data-dismiss="existing-file"]', (e) ->
     $button = $(e.currentTarget)
     $field = $button.closest('[data-provides="existing-file"]')

data/vendor/assets/javascripts/simple_form_extension/redactor.coffee

@@ -52,5 +52,5 @@ $.fn.simpleFormRedactor = ->
     instance = new Redactor($textarea)
     $textarea.data('simple-form:redactor', instance)
 
-onPageReady ->
-  $('[data-redactor]').simpleFormRedactor()
+$.simpleForm.onDomReady ($document) ->
+  $document.find('[data-redactor]').simpleFormRedactor()

data/vendor/assets/javascripts/simple_form_extension/selectize.coffee

@@ -50,5 +50,5 @@ $.fn.simpleFormSelectize = (options = {}) ->
     instance = new Selectize($select, options)
     $select.data('simple-form:selectize', instance)
 
-onPageReady ->
-  $('[data-selectize]').simpleFormSelectize()
+$.simpleForm.onDomReady ($document) ->
+  $document.find('[data-selectize]').simpleFormSelectize()

data/vendor/assets/javascripts/simple_form_extension/slider.coffee

@@ -12,5 +12,5 @@ $.fn.simpleFormSlider = ->
     instance = new Slider($select)
     $select.data('simple-form:slider', instance)
 
-onPageReady ->
-  $('[data-slider]').simpleFormSlider()
+$.simpleForm.onDomReady ($document) ->
+  $document.find('[data-slider]').simpleFormSlider()

data/vendor/assets/javascripts/simple_form_extension/spinbox.coffee

@@ -1,7 +1,7 @@
 class Spinbox
   constructor: (@$el) ->
     @$el.spinbox(max: Number.POSITIVE_INFINITY)
-      
+
 
 $.fn.simpleFormSpinbox = ->
   @each (i, el) ->
@@ -9,9 +9,9 @@ $.fn.simpleFormSpinbox = ->
     return if $input.data('simple-form:spinbox')
     instance = new Spinbox($input)
     $input.data('simple-form:spinbox', instance)
-         
-onPageReady ->
-  $spinbox = $('.spinbox')
+
+$.simpleForm.onDomReady ($document) ->
+  $spinbox = $document.find('.spinbox')
   return unless $spinbox.length
   $spinbox.simpleFormSpinbox()
-  
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_form_extension
 version: !ruby/object:Gem::Version
-  version: 1.2.21
+  version: 1.3.0
 platform: ruby
 authors:
 - Alexandre Vasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails