simple_form_extension 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd0d4d65350359f148434359f72d6814ef77a806
-  data.tar.gz: c7ae53787ed0e0b4764f16454dfc0f4eb7f6f102
+  metadata.gz: 267e21b5772a50e5445218c3e206b3196b4f643a
+  data.tar.gz: a1f3ade223f2551b5331f5079f721301ec9873d0
 SHA512:
-  metadata.gz: a4f4f7b41ed0af1856d5d6cc237926c507db3c94586d4f945f469a29a4f8a5a84771a9c3da858ab5ccad9dc9aa2d35a4de848bace1059d3cb4eb171bff17b86d
-  data.tar.gz: 351a83908b3cb0a7bcf972993d8349d000dd1a25bc6467d68bbcf6c2396e86c922454b62773967781c02740cd270e0787d363f01386b9a5f915376755e2af38b
+  metadata.gz: d173d07499d9a566018acb65fe5f5347571771c28f1753cb9195c2bb10838398732a4dcf50a846c62cea3625c8a65b8022c2d4eef0e9b2a90645942a4d157375
+  data.tar.gz: 9b14322c08e8a6e9f974de832d57cf288a8aa9826df8a924e64baad1cc6cf8f16e8dfd9823b9d2705aef5efded8c3f079de2bf003b8d731ee8dc0dee8d00f283

data/README.md

@@ -9,7 +9,6 @@ The following custom Simple Form inputs are available :
 * boolean
 * collection_check_boxes
 * collection_radio_buttons
-* color
 * date_time
 * file
 * image
@@ -17,6 +16,7 @@ The following custom Simple Form inputs are available :
 * redactor
 * selectize
 * slider
+* color
 
 Most of those inputs come with built-in javascript plugins, sometimes depending
 on external gems, others with the javascript plugin bundled in the gem's vendor
@@ -65,13 +65,168 @@ Add to your `application.js` :
 
 ## Usage
 
-To use the popover component, please include in a javascript file :
+There are two types of inputs provided by Simple Form Extension.
+
+### Input overrides
+
+The first are overrides of default Simple Form inputs, which allows for cleaner
+defaults. **You have nothing to do to use them**, since they'll be used
+automatically when calling `form.input`.
+
+Those inputs are the following :
+
+* boolean
+* collection_check_boxes
+* collection_radio_buttons
+* date_time
+* file
+* numeric
+
+### New inputs
+
+The other inputs are new ones, that extend the possibilities of your forms.
+You need to explicitly call them in your forms with the `:as` parameter.
+
+This inputs are the following :
+
+* [image](#image)
+* [selectize](#selectize)
+* [slider](#slider)
+* [redactor](#redactor)
+* [color](#color)
+
+### New Inputs usage
+
+#### :image
+
+The image is built to work with [Paperclip](https://github.com/thoughtbot/paperclip)
+attachments.
+
+It allows you to show a preview of the image before uploading it
+and a thumbnail of that image when displaying the form after the image
+has been uploaded.
+
+```ruby
+= form.input :picture, as: :image
+```
+
+Optionnaly, the input can add a Remove button to the image.
+For this feature to work you have to define a setter on your model that'll
+remove the image when given '1' as a value.
+
+As a default, the input will look for a `remove_<attachment_name>` method, and
+if it finds it, a Remove button will be added.
+
+```ruby
+# app/models/photo.rb
+class Photo < ActiveRecord::Base
+  has_attached_file :picture
+
+  def remove_picture=(value)
+    # Remove your attachment here
+  end
+end
+
+# app/views/photos/_form.html.haml
+= simple_form_for @photo do |form|
+  = form.input :picture, as: :image
+```
+
+You can customize the name of the setter that will be called with the
+`:remove_method` option :
+
+```ruby
+= form.input :picture, as: :image, remove_method: :destroy_picture
+```
+
+#### :selectize
+
+The selectize field allows you to create a powerful select field using the
+[Selectize](https://brianreavis.github.io/selectize.js/) javascript plugin.
+
+```ruby
+= form.input :items, as: :selectize, collection: Item.all
+```
+
+The following options are available :
+
+* `:creatable` : allow you to add options that are not initally present in the list
+* `:multi` : sets the field to multi mode, allowing users to select multiple items
+* `:collection` : sets the collection. Can be any ActiveRecord::Relation
+(`#name` and `#title` will be called to define label) or a Hash with { :text, :value }
+keys at least
+* `:max-items` : When in multi mode, maximum items that can be selected
+* `:sort-field` : The name of the collection item's field that will be used for sorting.
+You can add a field to the collection and it'll be serialized to JSON and used from
+selectize to sort your collection.
+
+```ruby
+= form.input :items, as: :selectize, collection: Item.all.map { |item| { text: item.name, value: item.id, position: item.position } }, :'sort-field' => :position, multi: false, creatable: true
+```
+
+Used javascript plugin : [Selectize](https://brianreavis.github.io/selectize.js/)
+
+#### :slider
+
+To use the slide component, you'll always want to set the `:min` and `:max`
+options.
+
+Use it with :
+
+```ruby
+= form.input :field, as: :slider, min: 0, max: 10
+```
+
+Options are the following :
+
+* `:step` : Which size the steps should be between :min and :max
+* `:orientation` : 'horizontal' or 'vertical', defaults to hotirzontal
+* `:range` : set to true for the slider to be a range slider
+* `:disabled` : set to true to disable interaction
+* `:ticks` : pass an array of ticks to display on the slider, ex: [0, 2, 4, 6, 8, 10]
+
+```ruby
+= form.input :field, as: :slider, min: 0, max: 10, step: 2, orientation: 'vertical',
+                     range: true, ticks: [0, 5, 10]
+```
+
+Used javascript plugin : [Bootstrap Slider](https://github.com/seiyria/bootstrap-slider)
+
+#### :redactor
+
+There are not options for now on this redactor input.
+
+To use it, just call it as usual :
+
+```ruby
+= form.input :content, as: :redactor
+```
+
+Used javascript plugin : [Redactor](https://github.com/glyph-fr/redactor-rails)
+
+#### :color
+
+The color input allows to add a colorpicker to a string field.
+
+```ruby
+= form.input :background_color, as: :color
+```
+
+Options :
+
+* format
+* align
+
+
+Used javascript plugin : [Bootstrap Color Picker](http://mjolnic.com/bootstrap-colorpicker/)
+
+<!-- To use the popover component, please include in a javascript file :
 
 ```javascript
 $('body').popover(selector: '[rel="popover"]')
-```
+``` -->
 
-### Javascript Plugins
+## Javascript Plugins
 
 Simple Form Extension comes with several javascript plugins built-in for the
 inputs to work properly.
@@ -80,7 +235,7 @@ 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
+### 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

data/lib/generators/simple_form_extension/install_generator.rb

@@ -12,6 +12,16 @@ module SimpleFormExtension
         template "config/locales/simple_form_extension.en.yml"
         template "config/locales/simple_form_extension.fr.yml"
       end
+
+      def add_custom_redactor_gem
+        gem 'redactor-rails', github: 'glyph-fr/redactor-rails'
+      end
+
+      def bundle
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+      end
     end
   end
 end

data/lib/simple_form_extension/inputs/color_input.rb

@@ -1,16 +1,22 @@
 module SimpleFormExtension
   module Inputs
     class ColorInput < SimpleForm::Inputs::Base
-
       delegate :content_tag, to: :template
 
       def input(wrapper_options = nil)
         input_html_options[:class] << "colorpicker form-control"
 
+        input_html_options[:data] ||= {}
+        input_html_options[:data].merge!(
+          colorpicker: true,
+          format: format,
+          align: align
+        )
+
         # Fetch value
         color = object.send(attribute_name)
 
-        content_tag(:div, class: 'input-group color', data: { colorpicker: true }) do
+        content_tag(:div, class: 'input-group color', data: { :'colorpicker-wrapper' => true }) do
           @builder.text_field(attribute_name, input_html_options) +
 
           content_tag(:span, class: 'input-group-addon') do
@@ -18,6 +24,14 @@ module SimpleFormExtension
           end
         end
       end
+
+      def format
+        options[:format].presence || :hex
+      end
+
+      def align
+        options[:align].presence || :right
+      end
     end
   end
 end

data/lib/simple_form_extension/version.rb

@@ -1,3 +1,3 @@
 module SimpleFormExtension
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

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

@@ -1,6 +1,9 @@
 class ColorPicker
   constructor: (@$el) ->
-    @$el.colorpicker()
+    if ($parent = @$el.closest('[data-colorpicker-wrapper]')).length
+      $parent.colorpicker()
+    else
+      @$el.colorpicker()
 
 $.fn.simpleFormColorpicker = ->
   @each (i, el) ->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_form_extension
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Glyph-fr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: This gems adds custom common input types to simple form.