simple_bootstrap_form 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27c4585ebe1f844686694e3d88cd045fe7b4c007
-  data.tar.gz: a3f97b39f979917a0d140ab729bd6a5b036ebac8
+  metadata.gz: 49612ff415db9c67ef7d7fddec5ce1628a89bd56
+  data.tar.gz: f44b2d057f9fb6c315271314a119245dab29f9d1
 SHA512:
-  metadata.gz: f02db029971faa1f602dfe08e2fd827c13da0beea257df0ff7824087454835513facd78b393d246f53e65d475e2ffef7759f877992f24bd40b7537e6ce8d4c45
-  data.tar.gz: 1846b4a9972a30d0223e32ee685683ae56deb285e74eab3bfe0107f9a772efdd2f5eb6d87515f2bf43e2739fe1b3c97dd0fdd680b0c07e805fbcc2acd56e08c1
+  metadata.gz: 5d98ef3d428ad7ced926485824bc37ba490d531d2d7adbae27ea7b3b7a065566155fa1aff84a68dc366e0129e8f203a13541f97c8a74030ad26ae9f4d47bf402
+  data.tar.gz: 70730348cf4eb5997e8de562623fc2cb76e44d48de10d412cbac84e77ec06ca38e7cc86be8785fa6dfffddbee28b8cdcb477e149d486f79a86951036c2469e42

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in my_gem.gemspec
 gemspec
+
+group :development, :test do
+  # Gems required to run guard-rspec and send notifications to OS Notification
+  # System
+  gem 'guard-rspec', require: false
+  gem 'terminal-notifier-guard'
+
+  gem 'byebug'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', all_on_start: false, all_after_pass: false , failed_mode: :keep do
+  watch(%r{^spec/.+_spec\.rb$})
+  #watch(%r{^lib/(.+)\.rb$})     { |m| "spec#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/simple_bootstrap_form_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,5 +1,7 @@
 # Bootstrap 3 Form Builder
 
+![CiecleCI Build Status](https://circleci.com/gh/Piersonally/simple_bootstrap_form.png?circle-token=1adabd4d96f92f6566f705581fb108ed59b31150)
+
 * 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
@@ -18,7 +20,7 @@ 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
+implementation.  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.
 
@@ -52,6 +54,87 @@ with
 
     bootstrap_form_for ...
 
+For example:
+
+```haml
+= bootstrap_form_for @article_form do |f|
+  = f.input :title
+  = f.input :published_at
+  = f.input :visible
+  = f.input :body, rows: 20
+  = f.input :topic_names, label: 'Tags'
+```
+
+Generates (spaces added for clarity):
+
+```html
+<form accept-charset="UTF-8" action="/articles" class="form-horizontal"
+      id="new_article" method="post" role="form">
+  <div style="display:none"><input name="utf8" type="hidden" value="✓"><input
+    name="authenticity_token" type="hidden"
+    value="NYiknMBfTGqphSHozhG8NMCGQeWbRY6hzs2a0+gaxJw="></div>
+
+  <div class="form-group article_title_group"><label
+    class="control-label col-sm-3" for="article_title"><abbr
+    title="required">*</abbr> Title</label>
+
+    <div class="col-sm-6"><input class="form-control" id="article_title"
+                                 name="article[title]" placeholder="Title"
+                                 required="required" type="text"></div>
+  </div>
+
+  <div class="form-group article_published_at_group"><label
+    class="control-label col-sm-3" for="article_published_at">Published
+    at</label>
+    <div class="col-sm-6">
+      <div class="input-group"><input class="form-control"
+                                      id="article_published_at"
+                                      name="article[published_at]"
+                                      placeholder="Published at"
+                                      type="datetime">
+
+        <div class="input-group-addon"><span
+          class="glyphicon glyphicon-calendar"
+          data-activate-datepicker="#article_published_at"></span></div>
+      </div>
+    </div>
+  </div>
+
+  <div class="form-group article_visible_group"><label
+    class="control-label col-sm-3" for="article_visible">Visible</label>
+
+    <div class="col-sm-6"><input name="article[visible]" type="hidden"
+                                 value="0"><input id="article_visible"
+                                                  name="article[visible]"
+                                                  type="checkbox" value="1">
+    </div>
+  </div>
+
+  <div class="form-group article_body_group"><label
+    class="control-label col-sm-3" for="article_body">Body</label>
+
+    <div class="col-sm-6"><textarea class="form-control" id="article_body"
+                                    name="article[body]" placeholder="Body"
+                                    rows="20"></textarea></div>
+  </div>
+
+  <div class="form-group article_topic_names_group"><label
+    class="control-label col-sm-3" for="article_topic_names">Tags</label>
+
+    <div class="col-sm-6"><input class="form-control" id="article_topic_names"
+                                 label="Tags" name="article[topic_names]"
+                                 placeholder="Topic names" type="text" value="">
+    </div>
+  </div>
+
+  <div class="form-group">
+    <div class="col-sm-offset-3 col-sm-2">
+      <input class="btn btn-primary" name="commit" type="submit" value="Save">
+    </div>
+  </div>
+</form>
+```
+
 ## Support
 
 #### Bootstrap Support

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.expand_path("spec/dummy/config/environment")
+  require 'simple_bootstrap_form'
+  ARGV.clear
+  IRB.start
+end

data/circle.yml

@@ -0,0 +1,5 @@
+database:
+  override:
+    - cd spec/dummy ; bundle exec rake db:create --trace
+    - cd spec/dummy ; bundle exec rake db:migrate --trace
+    - cd spec/dummy ; bundle exec rake db:test:prepare --trace

data/lib/simple_bootstrap_form/action_view_extensions.rb

@@ -2,11 +2,7 @@ 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'
+      options[:builder] ||= form_builder_class options
       prevent_action_view_putting_a_div_around_all_fields_with_errors do
         form_for record, options, &block
       end
@@ -14,6 +10,10 @@ module SimpleBootstrapForm
 
     private
 
+    def form_builder_class(options)
+      SimpleBootstrapForm::HorizontalForm::FormBuilder
+    end
+
     def prevent_action_view_putting_a_div_around_all_fields_with_errors(&block)
       orig_field_error_proc = ::ActionView::Base.field_error_proc
       begin

data/lib/simple_bootstrap_form/css_class_list.rb

@@ -12,7 +12,7 @@ module SimpleBootstrapForm
     end
 
     def to_s
-      join ' '
+      sort.join ' '
     end
 
     private

data/lib/simple_bootstrap_form/field_factory.rb

@@ -0,0 +1,58 @@
+module SimpleBootstrapForm
+  class FieldFactory
+
+    def initialize(builder, template)
+      @builder  = builder
+      @template = template
+    end
+
+    def for_attribute(attr, options)
+      field_class(attr, options).new(@builder, @template, attr, options)
+    end
+
+    private
+
+    def field_class(attr, options)
+      field_class_name(attr, options).constantize
+    end
+
+    def field_class_name(attr, options)
+      type_prefix = field_class_type_prefix attr, options
+      class_name = "#{type_prefix}Field"
+      @builder.class.fully_qualified_class_name_for_field class_name
+    end
+
+    # Return first half of a field class name, based on the type of the
+    # field: 'Text', 'Email', 'Password', 'Textarea', 'Boolean', etc.
+    # Appending 'Field' to this gets you a real class, e.g. TextField
+    def field_class_type_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)
+      @builder.object.try(:column_for_attribute, attr).try(:type) || :string
+    end
+
+    def string_field_class_prefix_based_on_column_name(attr)
+      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/horizontal_form/fields/base_field.rb

@@ -0,0 +1,118 @@
+module SimpleBootstrapForm
+  module HorizontalForm
+    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
+          process_options(options)
+        end
+
+        def to_s
+        @template.content_tag :div, group_options do
+            field_label +
+            input_tag +
+            errors_block
+          end
+        end
+
+        private
+
+        def process_options(options)
+          @options = options.dup
+          @label_size  = @options.delete :label_size
+          @input_size  = @options.delete :input_size
+          @label_text  = @options.delete :label
+          @group_class = @options.delete :group_class
+        end
+
+        def group_options
+          css_classes = CssClassList.new 'form-group', group_class
+          css_classes << 'has-error' if has_error?
+          { class: css_classes }
+        end
+
+        def group_class # a class for the form group to make it more testable
+          case @group_class
+          when false; nil
+          when nil; "#{@form_builder.object_name.to_s.underscore}_#{@name}_group"
+          else @group_class
+          end
+        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'
+          css_classes << @label_size
+          { class: css_classes.to_s }
+        end
+
+        def input_tag
+          @template.content_tag(:div, class: @input_size) 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
+end

data/lib/simple_bootstrap_form/horizontal_form/fields/boolean_field.rb

@@ -0,0 +1,16 @@
+module SimpleBootstrapForm
+  module HorizontalForm
+    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
+end

data/lib/simple_bootstrap_form/horizontal_form/fields/datetime_field.rb

@@ -0,0 +1,55 @@
+module SimpleBootstrapForm
+  module HorizontalForm
+    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
+end

data/lib/simple_bootstrap_form/horizontal_form/fields/email_field.rb

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

data/lib/simple_bootstrap_form/horizontal_form/fields/password_field.rb

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

data/lib/simple_bootstrap_form/horizontal_form/fields/text_field.rb

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

data/lib/simple_bootstrap_form/horizontal_form/fields/textarea_field.rb

@@ -0,0 +1,14 @@
+module SimpleBootstrapForm
+  module HorizontalForm
+    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
+end

data/lib/simple_bootstrap_form/horizontal_form/form_builder.rb

@@ -0,0 +1,59 @@
+module SimpleBootstrapForm
+  module HorizontalForm
+    class FormBuilder < ActionView::Helpers::FormBuilder
+
+      def initialize(object_name, object, template, options={}, block=nil)
+        @field_factory = FieldFactory.new self, template
+        process_options options
+        super object_name, object, template, options_for_rails_form_builder, block
+      end
+
+      def input(name, supplied_options = {})
+        options = field_options(supplied_options)
+        @field_factory.for_attribute(name, options).to_s
+      end
+
+      def self.fully_qualified_class_name_for_field(field_class_name)
+        # Better to do this manually than using introspection
+        "SimpleBootstrapForm::HorizontalForm::Fields::#{field_class_name}"
+      end
+
+      private
+
+      def process_options(options)
+        @options = options.dup
+        @options.delete :layout
+        @group_class = @options.delete :group_class
+      end
+
+      def options_for_rails_form_builder
+        @options[:html] ||= {}
+        @options[:html][:role] ||= 'form'
+        @options[:html][:class] = form_css_classes
+        @options
+      end
+
+      def form_css_classes
+        css_classes = CssClassList.new options[:html][:class]
+        css_classes << 'form-horizontal'
+        css_classes
+      end
+
+      def field_options(supplied_options)
+        options = supplied_options.dup
+        options[:label_size] ||= field_label_size
+        options[:input_size] ||= field_input_size
+        options[:group_class] = @group_class if @group_class == false
+        options
+      end
+
+      def field_label_size
+        @options[:label_size] || 'col-sm-3'
+      end
+
+      def field_input_size
+        @options[:input_size] || 'col-sm-6'
+      end
+    end
+  end
+end

data/lib/simple_bootstrap_form/version.rb

@@ -1,3 +1,3 @@
 module SimpleBootstrapForm
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/simple_bootstrap_form.rb

@@ -1,13 +1,14 @@
 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'
+require 'simple_bootstrap_form/field_factory'
+require 'simple_bootstrap_form/horizontal_form/form_builder'
+require 'simple_bootstrap_form/horizontal_form/fields/base_field'
+require 'simple_bootstrap_form/horizontal_form/fields/boolean_field'
+require 'simple_bootstrap_form/horizontal_form/fields/datetime_field'
+require 'simple_bootstrap_form/horizontal_form/fields/email_field'
+require 'simple_bootstrap_form/horizontal_form/fields/password_field'
+require 'simple_bootstrap_form/horizontal_form/fields/text_field'
+require 'simple_bootstrap_form/horizontal_form/fields/textarea_field'
 
 ActionView::Base.send :include, SimpleBootstrapForm::ActionViewExtensions

data/simple_bootstrap_form.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   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_development_dependency "nokogiri" # used by has_element matcher
   spec.add_runtime_dependency "rails", ">= 4"
 end

data/spec/field_factory_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe SimpleBootstrapForm::FieldFactory do
+  let(:model) { double 'model' }
+  let(:field_factory) { SimpleBootstrapForm::FieldFactory.new builder, nil }
+
+  describe "#for_attribute" do
+    let(:column) { double 'column' }
+    let(:attr_name) { 'foo' }
+    let(:options) { {} }
+
+    def setup_stubs
+      allow(builder).to receive(:object).and_return(model)
+      allow(model).to receive(:column_for_attribute).with(attr_name).and_return(column)
+      allow(column).to receive(:type).and_return(column_type)
+    end
+
+    subject { field_factory.for_attribute attr_name, options }
+
+    context "when given a horizontal form builder" do
+      let(:builder) { SimpleBootstrapForm::HorizontalForm::FormBuilder.new 'bogomodel', model, nil, {} }
+
+      context "for a text field" do
+        let(:column_type) { :string }
+        before { setup_stubs }
+
+        it { expect(subject).to be_a SimpleBootstrapForm::HorizontalForm::Fields::TextField }
+
+        context "when given an :as option" do
+          let(:options) { { as: :password } }
+
+          it "should override the default field type with the supplied one" do
+            expect(subject).to be_a SimpleBootstrapForm::HorizontalForm::Fields::PasswordField
+          end
+        end
+
+        context "whose name includes 'email'" do
+          let(:attr_name) { 'email' }
+
+          it { expect(subject).to be_a SimpleBootstrapForm::HorizontalForm::Fields::EmailField }
+        end
+
+        context "whose name includes 'password'" do
+          let(:attr_name) { 'password' }
+
+          it { should be_a SimpleBootstrapForm::HorizontalForm::Fields::PasswordField }
+        end
+      end
+
+      context "for a boolean field" do
+        let(:column_type) { :boolean }
+        before  { setup_stubs }
+
+        it { expect(subject).to be_a SimpleBootstrapForm::HorizontalForm::Fields::BooleanField }
+      end
+
+      context "for a datetime field" do
+        let(:column_type) { :datetime }
+        before  { setup_stubs }
+
+        it { expect(subject).to be_a SimpleBootstrapForm::HorizontalForm::Fields::DatetimeField }
+      end
+    end
+  end
+end