simple_bootstrap_form 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53a5640dfe3f3bae268c55e04da08106872c1da5
+  data.tar.gz: 72d50603af3495d61d91e4a99b847bac467ba40b
+SHA512:
+  metadata.gz: 69c87d1324efb67a722367f817286d7db770b7f07e331528d6c9fe5a761447137371396a3850dc906f956795d4064db3f8bddda458f896ecd669ae0949ca751f
+  data.tar.gz: 8f02a703c4977a78061a14c66e9668ce17fc403f2b4d95535a2f344fd6a4c567a099967ce10a1afc1df45c9441dd1d0b66c7b14ee3712133bc68302ead1f0641

data/.gitignore

@@ -0,0 +1,19 @@
+/.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/log/*

data/.ruby-gemset

@@ -0,0 +1 @@
+simple_bootstrap_form

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in my_gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sam Pierson
+
+MIT License
+
+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,74 @@
+# Bootstrap 3 Form Builder
+
+* I'm a fan of [Boootstrap](http://getbootstrap.com/)
+* I'm a fan of [Simple Form](https://github.com/plataformatec/simple_form)
+* Bootstrap 3 was released in August 2013, but as of February 2014 Simple Form
+  has yet to support it.
+* If your forms are relatively simple, this gem can be used as a stop-gap
+  measure until Simple Form supports Bootstrap 3.
+
+People [have been working on Bootstrap 3 support for Simple
+Form](https://github.com/plataformatec/simple_form/issues/857), for 7 months now
+but as yet it has failed to see the light of day.
+
+I think the reason for this may be that while Simple Form is configurable using
+an initializer, Bootstrap 3 requires wrapping something in a new way, which
+is going to require a new feature in the base Simple Form framework.
+
+SimpleForm is a featurefull generic framework that will layout forms for
+multiple different CSS frameworks (right now Bootstrap 2.3 and Zurb Foundation).
+The challenge with this is that greater flexibility incurs greater complexity in
+imlementation.  I believe the continued non-appearance of Simple Form Bootstrap
+3 support reflects the difficulty people have in working in this more complex
+framework, and getting the results integrated and released.
+
+This goal of this gem is to:
+
+* Implement a subset of the Simple Form API
+* Layout forms for Bootstrap 3 only
+* Be easier to maintain
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_bootstrap_form'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_bootstrap_form
+
+## Usage
+
+Replace calls to:
+
+    simple_form_for ...
+
+with
+
+    bootstrap_form_for ...
+
+## Support
+
+#### Bootstrap Support
+
+* Horizontal Form
+
+#### Simple Form API Support
+
+* Input types: boolean, datetime, email, password, text, textarea.  These are
+  trivial to add.  Just take a look in fields/.
+* Required fields.
+* Placeholders, automatic and custom.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/my_gem/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_bootstrap_form/action_view_extensions.rb

@@ -0,0 +1,31 @@
+module SimpleBootstrapForm
+  module ActionViewExtensions
+
+    def bootstrap_form_for(record, options={}, &block)
+      options[:builder] ||= SimpleBootstrapForm::FormBuilder
+      options[:html] ||= {}
+      options[:html][:class] = CssClassList.new options[:html][:class]
+      options[:html][:class] << 'form-horizontal'
+      options[:html][:role] ||= 'form'
+      prevent_action_view_putting_a_div_around_all_fields_with_errors do
+        form_for record, options, &block
+      end
+    end
+
+    private
+
+    def prevent_action_view_putting_a_div_around_all_fields_with_errors(&block)
+      orig_field_error_proc = ::ActionView::Base.field_error_proc
+      begin
+        ::ActionView::Base.field_error_proc = SimpleBootstrapForm.method :noop_field_error_proc
+        yield
+      ensure
+        ::ActionView::Base.field_error_proc = orig_field_error_proc
+      end
+    end
+  end
+
+  def self.noop_field_error_proc(html_tag, instance)
+    html_tag
+  end
+end

data/lib/simple_bootstrap_form/css_class_list.rb

@@ -0,0 +1,32 @@
+module SimpleBootstrapForm
+
+  class CssClassList < Array
+
+    def initialize(*classes)
+      replace normalize_array_or_string(classes)
+    end
+
+    def <<(classes)
+      replace self + normalize_array_or_string(classes)
+      uniq!
+    end
+
+    def to_s
+      join ' '
+    end
+
+    private
+
+    def normalize_array_or_string(classes)
+      if classes.is_a?(String)
+        classes.split ' '
+      elsif classes.is_a?(Array)
+        classes.flatten.join(' ').split(' ')
+      elsif classes.nil?
+        []
+      else
+        raise 'CssClassList takes an Array or String'
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/base_field.rb

@@ -0,0 +1,103 @@
+module SimpleBootstrapForm
+  module Fields
+    class BaseField
+
+      class << self
+        attr_accessor :type
+      end
+
+      def initialize(form_builder, template, name, options)
+        @form_builder = form_builder
+        @template = template
+        @name = name
+        @options = options.dup
+      end
+
+      def to_s
+        @template.content_tag :div, group_options do
+          field_label +
+          input_tag +
+          errors_block
+        end
+      end
+
+      private
+
+      def group_options
+        css_classes = CssClassList.new 'form-group', group_name
+        css_classes << 'has-error' if has_error?
+        { class: css_classes }
+      end
+
+      def group_name # added as a class on form group to make it more testable
+        "#{@form_builder.object_name.to_s.underscore}_#{@name}_group"
+      end
+
+      def field_label
+        @form_builder.label @name, label_text, label_options
+      end
+
+      def label_text
+        text = @options[:label] || @name.to_s.humanize.capitalize
+        required_asterisk + text
+      end
+
+      def required_asterisk
+        if required?
+          @template.content_tag(:abbr, '*', title: 'required') + ' '
+        else
+          ''
+        end.html_safe
+      end
+
+      def label_options
+        css_classes = CssClassList.new 'control-label col-sm-3'
+        { class: css_classes }
+      end
+
+      def input_tag
+        @template.content_tag(:div, class: 'col-sm-6') do
+          @form_builder.text_field @name, input_options
+        end
+      end
+
+      def input_options
+        @options.merge! class: 'form-control',
+                        placeholder: placeholder,
+                        type: self.class.type
+        @options.merge! required: 'required' if required?
+        @options
+      end
+
+      def placeholder
+        @options[:placeholder] || @name.to_s.humanize
+      end
+
+      def errors_block
+        return '' unless errors.any?
+        @template.content_tag :span, errors.join(', '),
+                                     class: 'help-block col-sm-3'
+      end
+
+      def model
+        @form_builder.object
+      end
+
+      def errors
+        return [] unless model
+        @cached_errors ||= model.errors[@name.to_sym]
+      end
+
+      def required?
+        return false unless model
+        model.class.validators_on(@name).any? do |validator|
+          validator.kind_of? ActiveModel::Validations::PresenceValidator
+        end
+      end
+
+      def has_error?
+        errors.any?
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/boolean_field.rb

@@ -0,0 +1,14 @@
+module SimpleBootstrapForm
+  module Fields
+    class BooleanField < BaseField
+
+      self.type = 'checkbox'
+
+      def input_tag
+        @template.content_tag(:div, class: 'col-sm-6') do
+          @form_builder.check_box @name
+        end
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/datetime_field.rb

@@ -0,0 +1,53 @@
+module SimpleBootstrapForm
+  module Fields
+    class DatetimeField < BaseField
+
+      self.type = 'datetime'
+
+      def input_tag
+        @template.content_tag(:div, class: 'col-sm-6') do
+          @template.content_tag :div, class: 'input-group' do
+            @form_builder.text_field(@name, input_options) +
+            calendar_icon
+          end
+        end
+      end
+
+      private
+
+      def calendar_icon
+        @template.content_tag(:div, class: 'input-group-addon') do
+          @template.content_tag(:span, '',
+            class: 'glyphicon glyphicon-calendar',
+            data: { 'activate-datepicker' => "##{tag_id}" }
+          )
+        end
+      end
+
+      def input_options
+        super
+        @options.merge! value: value_suitable_for_use_by_jquery_datetimepicker
+        @options
+      end
+
+      def value_suitable_for_use_by_jquery_datetimepicker
+        @form_builder.object.send(@name).try(:strftime, '%Y/%m/%d %H:%M')
+      end
+
+      # Adapted from module ActionView::Helpers::Tags::Base
+      def tag_id
+        "#{sanitized_object_name}_#{sanitized_method_name}"
+      end
+
+      # Adapted from module ActionView::Helpers::Tags::Base
+      def sanitized_object_name
+        @form_builder.object_name.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").sub(/_$/, "")
+      end
+
+      # Adapted from module ActionView::Helpers::Tags::Base
+      def sanitized_method_name
+        @name.to_s.sub(/\?$/,"")
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/email_field.rb

@@ -0,0 +1,8 @@
+module SimpleBootstrapForm
+  module Fields
+    class EmailField < BaseField
+
+      self.type = 'email'
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/password_field.rb

@@ -0,0 +1,8 @@
+module SimpleBootstrapForm
+  module Fields
+    class PasswordField < BaseField
+
+      self.type = 'password'
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/text_field.rb

@@ -0,0 +1,8 @@
+module SimpleBootstrapForm
+  module Fields
+    class TextField < BaseField
+
+      self.type = 'text'
+    end
+  end
+end

data/lib/simple_bootstrap_form/fields/textarea_field.rb

@@ -0,0 +1,12 @@
+module SimpleBootstrapForm
+  module Fields
+    class TextareaField < BaseField
+
+      def input_tag
+        @template.content_tag(:div, class: 'col-sm-6') do
+          @form_builder.text_area @name, input_options
+        end
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/form_builder.rb

@@ -0,0 +1,51 @@
+module SimpleBootstrapForm
+  class FormBuilder < ActionView::Helpers::FormBuilder
+
+    # Context inherited from ActionView::Helpers::FormBuilder:
+    #
+    #   @template
+    #   object
+
+    def input(name, options = {})
+      klass = map_object_attribute_to_field_class name, options
+      klass.new(self, @template, name, options).to_s
+    end
+
+    private
+
+    def map_object_attribute_to_field_class(attr, options)
+      prefix = field_class_prefix attr, options
+      "SimpleBootstrapForm::Fields::#{prefix}Field".constantize
+    end
+
+    def field_class_prefix(attr, options)
+      if options[:as]
+        options[:as].to_s.capitalize
+      else
+        derive_field_class_prefix attr
+      end
+    end
+
+    def derive_field_class_prefix(attr)
+      case attr_column_type(attr)
+      when :boolean; 'Boolean'
+      when :datetime; 'Datetime'
+      when :string; string_field_class_prefix_based_on_column_name(attr)
+      when :text  ; 'Textarea'
+      else 'Text'
+      end
+    end
+
+    def attr_column_type(attr)
+      object.try(:column_for_attribute, attr).try(:type) || :string
+    end
+
+    def string_field_class_prefix_based_on_column_name(attr)
+      x = case
+      when attr.to_s =~ /email/i    ; 'Email'
+      when attr.to_s =~ /password/i ; 'Password'
+      else 'Text'
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/version.rb

@@ -0,0 +1,3 @@
+module SimpleBootstrapForm
+  VERSION = "0.0.1"
+end

data/lib/simple_bootstrap_form.rb

@@ -0,0 +1,13 @@
+require 'simple_bootstrap_form'
+require 'simple_bootstrap_form/css_class_list'
+require 'simple_bootstrap_form/action_view_extensions'
+require 'simple_bootstrap_form/form_builder'
+require 'simple_bootstrap_form/fields/base_field'
+require 'simple_bootstrap_form/fields/boolean_field'
+require 'simple_bootstrap_form/fields/datetime_field'
+require 'simple_bootstrap_form/fields/email_field'
+require 'simple_bootstrap_form/fields/password_field'
+require 'simple_bootstrap_form/fields/text_field'
+require 'simple_bootstrap_form/fields/textarea_field'
+
+ActionView::Base.send :include, SimpleBootstrapForm::ActionViewExtensions

data/simple_bootstrap_form.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_bootstrap_form/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_bootstrap_form"
+  spec.version       = SimpleBootstrapForm::VERSION
+  spec.authors       = ["Sam Pierson"]
+  spec.email         = ["gems@sampierson.com"]
+  spec.summary       = %q{Bootstrap 3 Form Helper}
+  spec.description   = %q{A form helper with a 'Simple Form'-like interface, that supports Bootstrap 3}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails", ">= 3.0.0.beta1"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "capybara" # for has_selector? method
+  spec.add_runtime_dependency "rails", ">= 4"
+end

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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 File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/account.rb

@@ -0,0 +1,6 @@
+class Account < ActiveRecord::Base
+  #has_secure_password
+
+  validates :email, :first_name, :last_name, presence: true
+  validates :email, uniqueness: true
+end

data/spec/dummy/app/models/article.rb

@@ -0,0 +1,2 @@
+class Article < ActiveRecord::Base
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run