simple_form-bootstrap 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01f4677d60eb55516edfce94662be7be2694a9b0
+  data.tar.gz: 5c486b494860f4460812723074f387019713ab2a
+SHA512:
+  metadata.gz: eac1e6ee3e50a2b2f8d580c1f915f3b3b92d8da2ba09f92122f314c374562c30d7e00297e7ab01671bad49cd9ef15c22207dd8b7858473c2dd91f4d06950ca89
+  data.tar.gz: 468837005159acccbe5e73ce8bac474432e3511cf7dddf3af9fcb8f53d03a14d66c86dd561e9a291fc3a17d4b8008fb3346a6e126c7d5040cafaf39d05bc6e9e

data/Rakefile

@@ -0,0 +1,5 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end

data/app/assets/javascripts/simple_form-bootstrap.js

@@ -0,0 +1,20 @@
+//= require simple_form-bootstrap/date_time_input
+
+(function($) {
+  'use strict';
+  function initializeComponents(node) {
+    // Enable our date/time pickers
+    var datePickers = $('input.bootstrap-datepicker', node);
+    datePickers.datetimepicker();
+  }
+
+  $(document).on('ready', function(e) {
+    initializeComponents(document);
+  })
+  $(document).on('DOMNodeInserted', function(e) {
+    initializeComponents(e.target);
+  });
+  $(document).on('nested:fieldAdded', function(e) {
+    initializeComponents(e.field);
+  });
+})(jQuery);

data/app/assets/javascripts/simple_form-bootstrap/date_time_input.js

@@ -0,0 +1,76 @@
+// Hijacks the default Bootstrap date-time picker to always format dates in the specified format
+// through the use of a hidden field.
+(function($) {
+  'use strict';
+  /* global moment */
+
+  // Machine-readable formats used to store dates in hidden fields
+  var DATE_FORMAT = 'YYYY-MM-DD';
+  var DATETIME_FORMAT = 'YYYY-MM-DDTHH:mm:ssZZ';
+  var DATETIME_FORMAT_RAILS = 'YYYY-MM-DD HH:mm:ss ZZ';
+
+  var oldDateTimePicker = $.fn.datetimepicker;
+  if (!oldDateTimePicker) {
+    return;
+  }
+
+  var methods = {
+    initialise: function(arg) {
+      // Synchronise the proper display format
+      this.each(methods.initialiseFormat);
+
+      // Create the controls
+      arg = arg || {};
+      oldDateTimePicker.call(
+        this.filter(':not(input.bootstrap-timepicker)').parent(),
+        $.extend({}, arg, { pickTime: false }));
+      oldDateTimePicker.call(
+        this.filter('input.bootstrap-timepicker').parent(),
+        arg);
+
+      // Hide the backing date picker and show the actual date picker.
+      this.attr('type', 'text');
+      this.parent().css('display', '');
+      this.parent().next('input[type=text]').attr('type', 'hidden');
+
+      return this;
+    },
+
+    initialiseFormat: function() {
+      var $textField = $(this);
+      var displayFormat = $textField.data('dateFormat');
+
+      // Parse date in field (if provided)
+      var thisDate = moment($textField.val(), [DATETIME_FORMAT_RAILS, displayFormat]);
+      if (thisDate.isValid()) {
+        // Set displayed text field
+        $textField.val(thisDate.format(displayFormat));
+
+        // Set hidden field
+        var hiddenFormat = $textField.hasClass('bootstrap-timepicker') ? DATETIME_FORMAT :
+          DATE_FORMAT;
+        $textField.parent().next('input').val(thisDate.format(hiddenFormat));
+      }
+    }
+  };
+
+  // Replace the datetimepicker prototypes
+  $.fn.datetimepicker = function(arg) {
+    return methods.initialise.call(this, arg);
+  };
+  $.fn.datetimepicker.defaults = oldDateTimePicker.defaults;
+
+  // Ensure that the dates are properly formatted in the text field.
+  $(document).on('dp.change dp.show', '.bootstrap-datepicker:' +
+  'not(.bootstrap-timepicker)', function (e) {
+    var date = e.date;
+    var rails_date_format = date.format(DATE_FORMAT);
+    $(this).next('input[type=hidden]').val(rails_date_format);
+  });
+
+  $(document).on('dp.change dp.show', '.bootstrap-timepicker', function (e) {
+    var date = e.date;
+    var rails_date_format = date.format(DATETIME_FORMAT);
+    $(this).next('input[type=hidden]').val(rails_date_format);
+  });
+}(jQuery));

data/lib/simple_form/bootstrap.rb

@@ -0,0 +1,26 @@
+module SimpleForm::Bootstrap
+  extend ActiveSupport::Autoload
+
+  autoload :Setup
+  autoload :FormBuilders
+
+  eager_autoload do
+    autoload :Inputs
+  end
+
+  # Because we are augmenting Simple Form with our input fields, we need to load even when eager
+  # loading is not enabled
+  SimpleForm::Bootstrap::FormBuilders.load!
+
+  # Configuration options
+  extend SimpleForm::Bootstrap::Setup
+
+  # Method used to tidy up errors.
+  mattr_accessor :error_method
+  @@error_method = :first
+end
+
+if defined?(Rails)
+  require 'simple_form/bootstrap/railtie'
+  require 'simple_form/bootstrap/engine'
+end

data/lib/simple_form/bootstrap/engine.rb

@@ -0,0 +1,2 @@
+class SimpleForm::Bootstrap::Engine < Rails::Engine
+end

data/lib/simple_form/bootstrap/form_builders.rb

@@ -0,0 +1,9 @@
+module SimpleForm::Bootstrap::FormBuilders
+  extend ActiveSupport::Autoload
+
+  def self.load!
+    Dir.glob("#{__dir__}/form_builders/*") do |path|
+      require path
+    end
+  end
+end

data/lib/simple_form/bootstrap/form_builders/date_time.rb

@@ -0,0 +1,27 @@
+module SimpleForm::Bootstrap::FormBuilders::DateTime
+  DATE_TIME_COLUMN_TYPES = [
+    'datetime',
+    'timestamp',
+    'timestamp without time zone'
+  ].freeze
+
+  DATE_COLUMN_TYPES = [
+    'date'
+  ].freeze
+
+  def default_input_type_with_bootstrap_date_time(attribute_name, column, options, *args, &block)
+    if (options.is_a?(Hash) ? options[:as] : @options[:as]).nil? && !column.nil?
+      return :bootstrap_date_time if DATE_TIME_COLUMN_TYPES.include?(column.sql_type)
+      return :bootstrap_date if DATE_COLUMN_TYPES.include?(column.sql_type)
+    end
+
+    default_input_type_without_bootstrap_date_time(attribute_name, column, options, *args, &block)
+  end
+end
+
+SimpleForm::FormBuilder.class_eval do
+  include SimpleForm::Bootstrap::FormBuilders::DateTime
+
+  map_type :bootstrap_date_time, :bootstrap_date, to: SimpleForm::Bootstrap::Inputs::DateTimeInput
+  alias_method_chain :default_input_type, :bootstrap_date_time
+end

data/lib/simple_form/bootstrap/inputs.rb

@@ -0,0 +1,7 @@
+module SimpleForm::Bootstrap::Inputs
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :DateTimeInput
+  end
+end

data/lib/simple_form/bootstrap/inputs/date_time_input.rb

@@ -0,0 +1,134 @@
+# Inspired by this StackOverflow answer: http://stackoverflow.com/a/19018501
+# I have modified this to work with dates AND times, and also to work better
+# with browsers with JavaScript disabled.
+class SimpleForm::Bootstrap::Inputs::DateTimeInput < SimpleForm::Inputs::Base
+  def input(_ = nil)
+    text_field_options             = input_html_options.with_indifferent_access
+    format                         = text_field_options.delete(:format) || default_format
+
+    # Integrate with Bootstrap's styling
+    text_field_options[:class]    << 'form-control'
+
+    hidden_field_options           = text_field_options.dup
+    hidden_field_options[:class]   = text_field_options[:class].dup # so they won't work with same array object
+    hidden_field_options[:id]      = "#{attribute_name}_hidden"
+    hidden_field_options[:value] ||= value(object).try(:to_s)
+    text_field_options[:class]    << 'bootstrap-datepicker'
+    text_field_options[:class]    << 'bootstrap-timepicker' if input_type == :bootstrap_date_time
+    text_field_options[:value]   ||= format_date(value(object), format)
+    text_field_options[:data]      = { 'date-format' => strftime_to_momentjs_format(format) }
+
+    text_field_group_classes       = text_field_options[:class].dup
+    text_field_group_classes.delete('form-control')
+
+    return_string = <<-END_INPUT
+      <div class="input-group #{text_field_group_classes.join(' ')}" style="display: none">
+        #{@builder.hidden_field(attribute_name, text_field_options.to_hash)}
+        <span class="input-group-addon"><span class="glyphicon glyphicon-calendar"></span></span>
+      </div>
+      #{@builder.text_field(attribute_name, hidden_field_options.to_hash)}
+    END_INPUT
+    return_string.html_safe
+  end
+
+  protected
+
+  # Gets the format suitable for this field.
+  def default_format
+    case input_type
+      when :bootstrap_date
+        I18n.t('date.formats.default')
+      when :bootstrap_date_time
+        I18n.t('time.formats.default')
+    end
+  end
+
+  def value(object)
+    object.send @attribute_name if object
+  end
+
+  def format_date(value, format)
+    value.try(:strftime, format)
+  end
+
+  private
+
+  # rubocop:disable Style/CyclomaticComplexity, Style/MethodLength
+  def strftime_to_momentjs_format(format)
+    format.gsub(/([^%]%|^%)([_\-\^][a-zA-Z]|[a-zA-Z])/i) do |match|
+      last_match = Regexp.last_match(2)
+
+      # Preprocess the last match:
+      # - %_m is blank-padding
+      # - %-m is no padding
+      # - %^B is uppercase
+      padding = 0 # zero padding; 1 = blank, 2 = none
+      case last_match[0]
+        when '_'
+          padding = 1
+          last_match = last_match[1]
+        when '-'
+          padding = 2
+          last_match = last_match[1]
+        when '^'
+          last_match = last_match[1]
+      end
+
+      specifier =
+        case last_match
+          when 'a' # Abbreviated day
+            'ddd'
+          when 'A' # Full day
+            'dddd'
+          when 'd' # Day of month, with leading 0
+            padding == 2 ? 'D' : 'DD'
+          when 'u' # Day of year, with leading 0's (3 digits)
+            'DDDD'
+          when 'w' # Day of week, Sunday = 0
+            'd'
+
+          when 'b', 'h' # Abbreviated month
+            'MMM'
+          when 'B' # Full month
+            'MMMM'
+          when 'm' # Two digit representation of month (01 = Jan)
+            padding == 2 ? 'M' : 'MM'
+
+          when 'y' # Two digit representation of the year
+            'YY'
+          when 'Y' # Four digit representation of the year
+            'YYYY'
+
+          when 'H' # Two digit representation of the hour in 24-hour format
+            'HH'
+          when 'k' # Two digit representation of the hour in 24-hour format, padded with space
+            'H'
+          when 'I' # Two digit representation of the hour in 12-hour format
+            'hh'
+          when 'l' # Two digit representation of the hour in 12-hour format, padded with space
+            'h'
+
+          when 'M' # Two digit representation of minute
+            'mm'
+          when 'p' # Uppercase AM or PM
+            'A'
+          when 'P' # Lowercase AM or PM
+            'a'
+          when 'S' # Two digit representation of seconds
+            'ss'
+
+          when 'z' # The time zone offset. e.g. -0500
+            'ZZ'
+          when 'Z' # The time zone offset. e.g. EST
+            'z'
+          else
+            match
+        end
+
+      # Strip the % and return the new specifier
+      match = Regexp.last_match(1)
+      (match.slice(0, match.length - 1) || '') + specifier
+    end
+  end
+  # rubocop:enable Style/CyclomaticComplexity, Style/MethodLength
+end

data/lib/simple_form/bootstrap/railtie.rb

@@ -0,0 +1,5 @@
+require 'rails/railtie'
+
+class SimpleForm::Bootstrap::Railtie < Rails::Railtie
+  config.eager_load_namespaces << SimpleForm::Bootstrap
+end

data/lib/simple_form/bootstrap/setup.rb

@@ -0,0 +1,155 @@
+# Handles configuration Simple Form with Bootstrap defaults.
+module SimpleForm::Bootstrap::Setup
+  def setup
+    yield self
+    configure_simple_form
+  end
+
+  private
+
+  def configure_simple_form
+    SimpleForm.setup do |config|
+      config.error_notification_class = 'alert alert-danger'
+      config.button_class = 'btn btn-default'
+      config.boolean_label_class = nil
+
+      config.wrappers :vertical_form, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.use :placeholder
+        b.optional :maxlength
+        b.optional :pattern
+        b.optional :min_max
+        b.optional :readonly
+        b.use :label, class: 'control-label'
+
+        b.use :input, class: 'form-control'
+        b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+        b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+      end
+
+      config.wrappers :vertical_file_input, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.use :placeholder
+        b.optional :maxlength
+        b.optional :readonly
+        b.use :label, class: 'control-label'
+
+        b.use :input
+        b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+        b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+      end
+
+      config.wrappers :vertical_boolean, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.optional :readonly
+
+        b.wrapper tag: 'div', class: 'checkbox' do |ba|
+          ba.use :label_input
+        end
+
+        b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+        b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+      end
+
+      config.wrappers :vertical_radio_and_checkboxes, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.optional :readonly
+        b.use :label, class: 'control-label'
+        b.use :input
+        b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+        b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+      end
+
+      config.wrappers :horizontal_form, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.use :placeholder
+        b.optional :maxlength
+        b.optional :pattern
+        b.optional :min_max
+        b.optional :readonly
+        b.use :label, class: 'col-sm-3 control-label'
+
+        b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
+          ba.use :input, class: 'form-control'
+          ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+          ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+        end
+      end
+
+      config.wrappers :horizontal_file_input, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.use :placeholder
+        b.optional :maxlength
+        b.optional :readonly
+        b.use :label, class: 'col-sm-3 control-label'
+
+        b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
+          ba.use :input
+          ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+          ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+        end
+      end
+
+      config.wrappers :horizontal_boolean, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.optional :readonly
+
+        b.wrapper tag: 'div', class: 'col-sm-offset-3 col-sm-9' do |wr|
+          wr.wrapper tag: 'div', class: 'checkbox' do |ba|
+            ba.use :label_input, class: 'col-sm-9'
+          end
+
+          wr.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+          wr.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+        end
+      end
+
+      config.wrappers :horizontal_radio_and_checkboxes, tag: 'div', class: 'form-group',
+                      error_class: 'has-error' do |b|
+        b.use :html5
+        b.optional :readonly
+
+        b.use :label, class: 'col-sm-3 control-label'
+
+        b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
+          ba.use :input
+          ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+          ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+        end
+      end
+
+      config.wrappers :inline_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+        b.use :html5
+        b.use :placeholder
+        b.optional :maxlength
+        b.optional :pattern
+        b.optional :min_max
+        b.optional :readonly
+        b.use :label, class: 'sr-only'
+
+        b.use :input, class: 'form-control'
+        b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+        b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+      end
+
+      # Wrappers for forms and inputs using the Bootstrap toolkit.
+      # Check the Bootstrap docs (http://getbootstrap.com)
+      # to learn about the different styles for forms and inputs,
+      # buttons and other elements.
+      config.default_wrapper = :vertical_form
+      config.wrapper_mappings = {
+        check_boxes: :vertical_radio_and_checkboxes,
+        radio_buttons: :vertical_radio_and_checkboxes,
+        file: :vertical_file_input,
+        boolean: :vertical_boolean,
+      }
+    end
+  end
+end

data/lib/simple_form/bootstrap/version.rb

@@ -0,0 +1,4 @@
+module SimpleForm; end
+module SimpleForm::Bootstrap
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: simple_form-bootstrap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joel Low
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Initialises Simple Form to automatically produce Bootstrap 3-friendly
+  markup
+email: joel@joelsplace.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/assets/javascripts/simple_form-bootstrap.js
+- app/assets/javascripts/simple_form-bootstrap/date_time_input.js
+- lib/simple_form/bootstrap.rb
+- lib/simple_form/bootstrap/engine.rb
+- lib/simple_form/bootstrap/form_builders.rb
+- lib/simple_form/bootstrap/form_builders/date_time.rb
+- lib/simple_form/bootstrap/inputs.rb
+- lib/simple_form/bootstrap/inputs/date_time_input.rb
+- lib/simple_form/bootstrap/railtie.rb
+- lib/simple_form/bootstrap/setup.rb
+- lib/simple_form/bootstrap/version.rb
+homepage: https://github.com/lowjoel/simple_form-bootstrap
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Initialises Simple Form to automatically produce Bootstrap 3-friendly markup.
+  Also adds date and time pickers.
+test_files: []