comfy_bootstrap_form 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e259644ff4ca92f7c1ad851f4b49405baf41f12db6f2352d2bc86742d102e678
-  data.tar.gz: 5ff70b67fc490005cb33e0c0d0c0211a3181e67470c8aa22266af299a27c0f0c
+  metadata.gz: e1131134a470480c0db98c57088a09d3dc5875cdde69e2886c4ad58e56f85982
+  data.tar.gz: eb630d1a2474b38262f778ec6a77dcb6adcfb359f15ac11064e32aa164efbd26
 SHA512:
-  metadata.gz: 214fbf0f8c2003616dd75707c156a4da91bb4d740a186fd7436a980eddc26fde7f0067c7c5e8fe2890451ee5f8005079c89d5ed22ea805b6e4e55a8fbbbf2c64
-  data.tar.gz: d00c03f8af63d13203335322dbe2143100e5bdf0188069d517a8acf30be5861f69fbdefbd6367a52c31e6af8b808454a5dcdcdecfc0535c1b260512e32d759c5
+  metadata.gz: 3159663372d2ce7266d3145ade1a927c7195e99df1954c4a535bfd402ffeaf2155df31277887d09dff6b561b3167226f7baab64605661e7d8a09950f12c65647
+  data.tar.gz: de46cca64ea6c26c322336d544a6d4ac0c719067ae64d0b5d3dcbd77acff0570a1aa2440d343b0f87ba38abf611e7ea98c7d14cc3aa442a09b2444e880ef9cdc

data/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   TargetRubyVersion: 2.2
   Exclude:

data/.travis.yml

@@ -5,6 +5,8 @@ rvm:
   - 2.4.3
   - 2.5.0
 gemfile:
+  - test/gemfiles/5.0.gemfile
+  - test/gemfiles/5.1.gemfile
   - test/gemfiles/5.2.gemfile
 branches:
   only:

data/Gemfile

@@ -3,16 +3,17 @@ source "http://rubygems.org"
 gemspec
 
 # Uncomment and change rails version for testing purposes
-# gem "rails", "~> 5.2.0.beta2"
+# gem "rails", "~> 5.1.0"
 
 group :development do
-  gem "rubocop", "~> 0.51.0", require: false
+  gem "rubocop", require: false
 end
 
 group :test do
   gem "coveralls", require: false
   gem "diffy"
   gem "equivalent-xml"
+  # gem "minitest", "~> 5.10.3"
   gem "minitest"
   gem "sqlite3"
 end

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2012-2018 Oleg Khabarov, Stephen Potenza <potenza@gmail.com>
+Copyright 2018 Oleg Khabarov, Stephen Potenza
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -13,7 +13,7 @@
 
 ## Requirements
 
-- Rails 5.2+
+- Rails 5.0+
 - Bootstrap 4.0.0+
 
 ## Installation
@@ -68,6 +68,32 @@ Feel free to take a look at the [Demo App](/demo) to see how everything renders.
 Specifically see [form.html.erb](/demo/app/views/bootstrap/form.html.erb) template
 for all kinds of different form configurations you can have.
 
+## Form helpers
+
+#### boostrap_form_with
+
+Wrapper around `form_with` helper that's available in Rails 5.1 and above.
+Here's an example:
+
+```erb
+<%= bootstrap_form_with model: @person, scope: :user do |form| %>
+  <%= form.email_field :email %>
+  <%= form.submit %>
+<% end %>
+```
+
+#### bootstrap_form_for
+
+Wrapper around `form_for` helper that's available in all Rails 5 versions.
+Here's an example:
+
+```erb
+<%= bootstrap_form_with @person, as: :user do |form| %>
+  <%= form.email_field :email %>
+  <%= form.submit %>
+<% end %>
+```
+
 ## Supported form field helpers
 
 This gem wraps most of the default form field helpers. Here's the current list:
@@ -262,14 +288,11 @@ If you want to use something like a button, or other html content do this:
 
 ### Gotchas
 
-For inline radio buttons and check boxes you need to add custom css for error
-messages show up (see: https://github.com/twbs/bootstrap/issues/25540):
-
-```css
-.invalid-feeback {
-  display: block
-}
-```
+- In Rails 5.1 `form_with` does not generate ids for inputs. If you want them
+  you'll need to override this method: [actionview/lib/action_view/helpers/form_helper.rb#L745](https://github.com/rails/rails/blob/bdc581616b760d1e2be3795c6f0f3ab4b1e125a5/actionview/lib/action_view/helpers/form_helper.rb#L745)
+- For inline radio buttons and check boxes you need to add custom css for error
+  messages show up. See: [twbs/bootstrap/issues/25540](https://github.com/twbs/bootstrap/issues/25540)
+  For now adding `.invalid-feeback { display: block }` will work.
 
 ## Screenshots
 

data/bootstrap_form.gemspec

@@ -6,7 +6,7 @@ require "bootstrap_form/version"
 Gem::Specification.new do |s|
   s.name        = "comfy_bootstrap_form"
   s.version     = BootstrapForm::VERSION
-  s.authors     = ["Oleg Khabarov", "Stephen Potenza"]
+  s.authors     = ["Oleg Khabarov"]
   s.email       = ["oleg@khabarov.ca"]
   s.homepage    = "https://github.com/comfy/comfy-bootstrap-form"
   s.summary     = "Rails form builder that makes it easy to style forms using "\
@@ -15,11 +15,14 @@ Gem::Specification.new do |s|
                   "easy to create beautiful-looking forms using Bootstrap 4"
   s.license     = "MIT"
 
-  s.files         = `git ls-files`.split("\n")
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|demo)/})
+  end
+
   s.bindir        = "exe"
   s.require_paths = ["lib"]
 
   s.required_ruby_version = ">= 2.2.2"
 
-  s.add_dependency "rails", ">= 5.2.rc1"
+  s.add_dependency "rails", ">= 5.0.0"
 end

data/lib/bootstrap_form/version.rb

@@ -1,5 +1,5 @@
 module BootstrapForm
 
-  VERSION = "4.0.0".freeze
+  VERSION = "4.0.1".freeze
 
 end

data/lib/bootstrap_form/view_helper.rb

@@ -3,26 +3,47 @@ module BootstrapForm
 
     # Wrapper for `form_with`. Passing in Bootstrap form builder.
     def bootstrap_form_with(**options, &block)
-      supress_field_errors do
-        css_classes       = options.delete(:class) || ""
-        bootstrap_options = options[:bootstrap] || {}
+      bootstrap_options = options[:bootstrap] || {}
 
-        if bootstrap_options[:layout].to_s == "inline"
-          css_classes << " form-inline"
-        end
+      css_classes = options.delete(:class)
 
-        form_options = options.reverse_merge(builder: BootstrapForm::FormBuilder)
-        form_options.merge!(class: css_classes) unless css_classes.blank?
+      if bootstrap_options[:layout].to_s == "inline"
+        css_classes = [css_classes, "form-inline"].compact.join(" ")
+      end
+
+      form_options = options.reverse_merge(builder: BootstrapForm::FormBuilder)
+      form_options.merge!(class: css_classes) unless css_classes.blank?
+
+      supress_form_field_errors do
         form_with(**form_options, &block)
       end
     end
 
+    def bootstrap_form_for(record, options = {}, &block)
+      options[:html] ||= {}
+
+      bootstrap_options = options[:bootstrap] || {}
+
+      css_classes = options[:html].delete(:class)
+
+      if bootstrap_options[:layout].to_s == "inline"
+        css_classes = [css_classes, "form-inline"].compact.join(" ")
+      end
+
+      options.reverse_merge!(builder: BootstrapForm::FormBuilder)
+      options[:html].merge!(class: css_classes) unless css_classes.blank?
+
+      supress_form_field_errors do
+        form_for(record, options, &block)
+      end
+    end
+
   private
 
     # By default, Rails will wrap form fields with extra html to indicate
     # inputs with errors. We need to handle this in the builder to render
     # Bootstrap specific markup. So we need to bypass this.
-    def supress_field_errors
+    def supress_form_field_errors
       original_proc = ActionView::Base.field_error_proc
       ActionView::Base.field_error_proc = proc { |input, _instance| input }
       yield

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comfy_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Oleg Khabarov
-- Stephen Potenza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.rc1
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.rc1
+        version: 5.0.0
 description: bootstrap_form is a rails form builder that makes it super easy to create
   beautiful-looking forms using Bootstrap 4
 email:
@@ -42,66 +41,12 @@ files:
 - README.md
 - Rakefile
 - bootstrap_form.gemspec
-- demo/README.md
-- demo/Rakefile
-- demo/app/controllers/application_controller.rb
-- demo/app/controllers/bootstrap_controller.rb
-- demo/app/models/application_record.rb
-- demo/app/models/user.rb
-- demo/app/views/bootstrap/form.html.erb
-- demo/app/views/layouts/application.html.erb
-- demo/bin/bundle
-- demo/bin/rails
-- demo/bin/rake
-- demo/bin/setup
-- demo/bin/update
-- demo/bin/yarn
-- demo/config.ru
-- demo/config/application.rb
-- demo/config/boot.rb
-- demo/config/database.yml
-- demo/config/environment.rb
-- demo/config/environments/development.rb
-- demo/config/environments/test.rb
-- demo/config/initializers/application_controller_renderer.rb
-- demo/config/initializers/assets.rb
-- demo/config/initializers/backtrace_silencers.rb
-- demo/config/initializers/cookies_serializer.rb
-- demo/config/initializers/filter_parameter_logging.rb
-- demo/config/initializers/inflections.rb
-- demo/config/initializers/mime_types.rb
-- demo/config/initializers/wrap_parameters.rb
-- demo/config/locales/en.yml
-- demo/config/puma.rb
-- demo/config/routes.rb
-- demo/config/spring.rb
-- demo/config/storage.yml
-- demo/db/schema.rb
-- demo/form_preview_horizontal.png
-- demo/form_preview_horizontal_with_errors.png
-- demo/form_preview_inline.png
-- demo/form_preview_vertical.png
-- demo/log/.keep
-- demo/package.json
-- demo/public/favicon.ico
 - lib/bootstrap_form.rb
 - lib/bootstrap_form/bootstrap_options.rb
 - lib/bootstrap_form/form_builder.rb
 - lib/bootstrap_form/version.rb
 - lib/bootstrap_form/view_helper.rb
 - lib/comfy_bootstrap_form.rb
-- test/bootstrap_form/bootstrap_options_test.rb
-- test/bootstrap_form/fields_test.rb
-- test/bootstrap_form/fields_with_errors_test.rb
-- test/bootstrap_form/form_builder_test.rb
-- test/bootstrap_form/horizontal_form_test.rb
-- test/bootstrap_form/inline_form_test.rb
-- test/bootstrap_form/input_group_test.rb
-- test/bootstrap_form/radios_and_checkboxes_test.rb
-- test/bootstrap_form/submit_test.rb
-- test/bootstrap_form/view_helpers_test.rb
-- test/gemfiles/5.2.gemfile
-- test/test_helper.rb
 homepage: https://github.com/comfy/comfy-bootstrap-form
 licenses:
 - MIT
@@ -122,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Rails form builder that makes it easy to style forms using Bootstrap 4

data/demo/README.md

@@ -1,18 +0,0 @@
-# DEMO APP (Rails 5.2)
-
-### Usage
-
-- `rake db:schema:load`
-- `rails s`
-- Navigate to http://localhost:3000
-- Start changing stuff in [/demo/app/views/bootstrap/form.html.erb](/demo/app/views/bootstrap/form.html.erb)
-
-### Following files were added or changed:
-
-- db/schema.rb
-- config/{application, routes, boot}.rb
-- config/environments/{development, test}.rb
-- app/models/user.rb
-- app/controllers/bootstrap_controller.rb
-- app/views/layouts/application.html.erb
-- app/views/bootstrap/form.html.erb

data/demo/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative 'config/application'
-
-Rails.application.load_tasks

data/demo/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::Base
-end

data/demo/app/controllers/bootstrap_controller.rb

@@ -1,18 +0,0 @@
-class BootstrapController < ApplicationController
-
-  def form
-    @user = User.new(test: "Lorem ipsum")
-
-    @user_with_error = User.new
-    @user_with_error.errors.add(:username, "Username already taken")
-    @user_with_error.errors.add(:email, "Invalid email address")
-    @user_with_error.errors.add(:password, "Another user already uses this password")
-    @user_with_error.errors.add(:color, "Red is the worst color. Choose another.")
-    @user_with_error.errors.add(:bio, "Too much information")
-    @user_with_error.errors.add(:locale, "It's fine, but here's another error")
-    @user_with_error.errors.add(:terms, "You never agreed to Terms and Conditions")
-    @user_with_error.errors.add(:test, "Generic error message")
-
-  end
-
-end

data/demo/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end

data/demo/app/models/user.rb

@@ -1,3 +0,0 @@
-class User < ActiveRecord::Base
-
-end

data/demo/app/views/bootstrap/form.html.erb

@@ -1,127 +0,0 @@
-<h3>Horizontal Form</h3>
-
-<%= bootstrap_form_with model: @user, scope: "user_a", url: "/", bootstrap: {layout: :horizontal} do |form| %>
-  <%= form.email_field :username, placeholder: "AzureDiamond", bootstrap: {prepend: "@"} %>
-  <%= form.email_field :email, placeholder: "you@example.com" %>
-  <%= form.password_field :password, placeholder: "hunter2", bootstrap: {help: "Password should be at least 12 characters long"}  %>
-  <%= form.collection_radio_buttons :color, ["red", "green", "blue"], :to_s, :titleize, bootstrap: {check_inline: true, help: "Choose your favorite color"} %>
-  <%= form.text_area :bio, placeholder: "Tell us your life story" %>
-  <%= form.select :locale, [["English", "en"], ["French", "fr"]], {}, bootstrap: {label: {text: "Language"}} %>
-  <%= form.check_box :terms, bootstrap: {label: {text: "I agree to Terms and Conditions"}, help: "By clicking Agree you're also acknowledging that Apple may sew your mouth to a ... "} %>
-  <%= form.primary "Press to Register" do %>
-    <a href="/" class="btn btn-link">Maybe Later</a>
-  <% end %>
-<% end %>
-
-<h3>Horizontal Form With Errors</h3>
-
-<%= bootstrap_form_with model: @user_with_error, scope: "user_b", url: "/", bootstrap: {layout: :horizontal} do |form| %>
-  <%= form.email_field :username, placeholder: "AzureDiamond", bootstrap: {prepend: "@"} %>
-  <%= form.email_field :email, placeholder: "you@example.com" %>
-  <%= form.password_field :password, placeholder: "hunter2", bootstrap: {help: "Password should be at least 12 characters long"}  %>
-  <%= form.collection_radio_buttons :color, ["red", "green", "blue"], :to_s, :titleize, bootstrap: {check_inline: true, help: "Choose your favorite color"} %>
-  <%= form.text_area :bio, placeholder: "Tell us your life story" %>
-  <%= form.select :locale, [["English", "en"], ["French", "fr"]], {}, bootstrap: {label: {text: "Language"}} %>
-  <%= form.check_box :terms, bootstrap: {label: {text: "I agree to Terms and Conditions"}, help: "By clicking Agree you're also acknowledging that Apple may sew your mouth to a ... "} %>
-  <%= form.primary "Press to Register" do %>
-    <a href="/" class="btn btn-link">Maybe Later</a>
-  <% end %>
-<% end %>
-
-<h3>Inline Form</h3>
-
-<%= bootstrap_form_with scope: :login, url: "/", bootstrap: {layout: :inline, label: {hide: true}} do |form| %>
-  <%= form.email_field :username, placeholder: "Username", bootstrap: {prepend: "@"} %>
-  <%= form.password_field :password, placeholder: "Password" %>
-  <%= form.check_box :remember_me %>
-  <%= form.primary "Sign in", class: "ml-3" %>
-<% end %>
-
-<div class="row">
-  <div class="col-6">
-    <h3>Vertical Form</h3>
-
-    <%= bootstrap_form_with model: @user, scope: "user_c", url: "/" do |form| %>
-      <%= form.email_field :username, placeholder: "AzureDiamond", bootstrap: {prepend: "@"} %>
-      <%= form.email_field :email, placeholder: "you@example.com" %>
-      <%= form.password_field :password, placeholder: "hunter2", bootstrap: {help: "Password should be at least 12 characters long"}  %>
-      <%= form.collection_radio_buttons :color, ["red", "green", "blue"], :to_s, :titleize, bootstrap: {check_inline: true, help: "Choose your favorite color"} %>
-      <%= form.text_area :bio, placeholder: "Tell us your life story" %>
-      <%= form.select :locale, [["English", "en"], ["French", "fr"]], {}, bootstrap: {label: {text: "Language"}} %>
-      <%= form.check_box :terms, bootstrap: {label: {text: "I agree to Terms and Conditions"}, help: "By clicking Agree you're also acknowledging that Apple may sew your mouth to a ... "} %>
-      <%= form.primary "Press to Register" do %>
-        <a href="/" class="btn btn-link">Maybe Later</a>
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-6">
-    <h3>With Errors</h3>
-
-    <%= bootstrap_form_with model: @user_with_error, scope: "user_c", url: "/" do |form| %>
-      <%= form.email_field :username, placeholder: "AzureDiamond", bootstrap: {prepend: "@"} %>
-      <%= form.email_field :email, placeholder: "you@example.com" %>
-      <%= form.password_field :password, placeholder: "hunter2", bootstrap: {help: "Password should be at least 12 characters long"}  %>
-      <%= form.collection_radio_buttons :color, ["red", "green", "blue"], :to_s, :titleize, bootstrap: {check_inline: true, help: "Choose your favorite color"} %>
-      <%= form.text_area :bio, placeholder: "Tell us your life story" %>
-      <%= form.select :locale, [["English", "en"], ["French", "fr"]], {}, bootstrap: {label: {text: "Language"}} %>
-      <%= form.check_box :terms, bootstrap: {label: {text: "I agree to Terms and Conditions"}, help: "By clicking Agree you're also acknowledging that Apple may sew your mouth to a ... "} %>
-      <%= form.primary "Press to Register" do %>
-        <a href="/" class="btn btn-link">Maybe Later</a>
-      <% end %>
-    <% end %>
-  </div>
-</div>
-
-<div class="row">
-  <div class="col-6">
-    <h3>Checkboxes and Radio buttons</h3>
-    <% @user.test = "b" %>
-    <%= bootstrap_form_with model: @user, scope: "user_d", url: "/" do |form| %>
-      <%= form.collection_radio_buttons :test, [["a", "Label A"], ["b", "Label B"]], :first, :second %>
-      <%= form.collection_check_boxes :test, [["e", "Label E"], ["f", "Label F"]], :first, :second, bootstrap: {help: "help text"} %>
-      <%= form.collection_radio_buttons :test, ["u", "v", "w"], :to_s, :to_s, bootstrap: {inline: true, label: {text: "Custom Label"}} %>
-      <%= form.collection_check_boxes :test, ["x", "y", "z"], :to_s, :to_s, bootstrap: {inline: true, help: "help text", label: {hide: true}} %>
-    <% end %>
-  </div>
-  <div class="col-6">
-    <h3>With Errors</h3>
-    <% @user_with_error.test = "b" %>
-    <%= bootstrap_form_with model: @user_with_error, scope: "user_e", url: "/" do |form| %>
-      <%= form.collection_radio_buttons :test, [["a", "Label A"], ["b", "Label B"]], :first, :second %>
-      <%= form.collection_check_boxes :test, [["e", "Label E"], ["f", "Label F"]], :first, :second, bootstrap: {help: "help text"} %>
-      <%= form.collection_radio_buttons :test, ["u", "v", "w"], :to_s, :to_s, bootstrap: {inline: true, label: {text: "Custom Label"}} %>
-      <%= form.collection_check_boxes :test, ["x", "y", "z"], :to_s, :to_s, bootstrap: {inline: true, help: "help text", label: {hide: true}} %>
-    <% end %>
-  </div>
-</div>
-
-<div class="row">
-  <div class="col-6">
-    <h3>Input Group</h3>
-
-    <%= bootstrap_form_with model: @user, scope: "user_f", url: "/" do |form| %>
-      <%= form.email_field :email, placeholder: "Enter Email", bootstrap: {prepend: "Prepend", append: "Append", help: "help text"} %>
-      <% prepend_button = capture do %>
-        <button class="btn btn-success">Go</button>
-      <% end %>
-      <% append_button = capture do %>
-        <button class="btn btn-danger">Stop</button>
-      <% end %>
-      <%= form.email_field :email, placeholder: "Enter Email", bootstrap: {label: {hide: true}, prepend: {html: prepend_button}, append: {html: append_button}} %>
-    <% end %>
-  </div>
-  <div class="col-6">
-    <h3>With Errors</h3>
-
-    <%= bootstrap_form_with model: @user_with_error, scope: "user_g", url: "/" do |form| %>
-      <%= form.email_field :email, placeholder: "Enter Email", bootstrap: {prepend: "Prepend", append: "Append", help: "help text"} %>
-      <% prepend_button = capture do %>
-        <button class="btn btn-success">Go</button>
-      <% end %>
-      <% append_button = capture do %>
-        <button class="btn btn-danger">Stop</button>
-      <% end %>
-      <%= form.email_field :email, placeholder: "Enter Email", bootstrap: {label: {hide: true}, prepend: {html: prepend_button}, append: {html: append_button}} %>
-    <% end %>
-  <div>
-</div>