bootstrap4_form_builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 974db139d9433498cc39cea61e94e6826ee75115
+  data.tar.gz: 1a2e42618302f022c07014728766d947fef4c923
+SHA512:
+  metadata.gz: c5ccd4d4992daa7ba8ee9269b9106927fe7d3d83850600f5b785a14bfba0e09856e6d6e3be963ed352cd510b9047e9637c4fa7fa5ca02095a2c10ad94fcf9711
+  data.tar.gz: 079aca0f9a5fb7a914722bda45e63cc4295ba35e299a4759a334e8e78290e4e1086ba866bb815001441d3284fad0cdcb443731a2236dd2c85c9c4b3d0e93cfa1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Christopher Slade
+
+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/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bootstrap4FormBuilder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/bootstrap4_form_builder.rb

@@ -0,0 +1,13 @@
+require 'bootstrap4_form_builder/form_builder'
+require 'bootstrap4_form_builder/helper'
+
+module Bootstrap4FormBuilder
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+
+ActionView::Base.send :include, Bootstrap4FormBuilder::Helper
+ActionView::Base.send :include, Bootstrap4FormBuilder::FormBuilder
+

data/lib/bootstrap4_form_builder/form_builder.rb

@@ -0,0 +1,254 @@
+module Bootstrap4FormBuilder
+  module FormBuilder
+    class BootstrapBuilder < ActionView::Helpers::FormBuilder
+    
+      delegate :content_tag, :concat, :capture, to: :@template
+    
+      attr_reader :layout, :label_col, :control_col
+    
+      FIELD_HELPERS = %w{color_field date_field datetime_field datetime_local_field
+          email_field month_field number_field password_field phone_field
+          range_field search_field telephone_field text_area text_field time_field
+          url_field week_field}
+    
+      def initialize(object_name, object, template, options)
+        @layout = options[:layout]
+        @label_col = options[:label_col]
+        @control_col = options[:control_col]
+        @inline_errors = options[:inline_errors].nil? ? true : options[:inline_errors]
+        @inline_error_class = options[:inline_error_class]
+        #puts "Inline Errors: #{@inline_errors}"
+        #Could be done in helper.
+        if inline_layout?
+          options.reverse_merge! html: {}
+          options[:html][:class] = [options[:html][:class], inline_class].compact.join(" ")
+        end
+    
+        super
+      end
+    
+      FIELD_HELPERS.each do |method_name|
+        define_method(method_name) do |method, *args|
+          options = args.extract_options!.symbolize_keys!
+          standard_html("#{__method__.to_s}", method, options)
+        end
+      end
+    
+      def standard_html(type, method, options = {})
+        form_group_builder(method, options) do
+          content = []
+          options[:class] = [control_class, options[:class]].compact.join(" ")
+          
+          
+          temporarily_disable_field_error_proc do
+            content << generate_label(method, options)
+            if gridded_form?
+              content << content_tag(:div, class: @control_col) do
+                @template.send(type, object_name, method, options)
+              end
+            else
+              content << @template.send(type, object_name, method, options)
+            end
+          end
+          content << generate_error_help(method, options)
+          content.compact.join.html_safe
+        end
+      end
+  
+      def check_box(name, options = {}, checked_value = "1", unchecked_value = "0", &block)
+        options = options.symbolize_keys!
+        check_box_options = options.except(:label, :label_class, :inline)
+        label_class = [options[:label_class]]
+        
+        temporarily_disable_field_error_proc do
+          html = super(name, check_box_options, checked_value, unchecked_value)
+          label_content = block_given? ? capture(&block) : options[:label]
+          html.concat(" ").concat(label_content || (object && object.class.human_attribute_name(name)) || name.to_s.humanize)
+
+          label_name = name
+  
+          label_class = options[:label_class] 
+  
+          if options[:inline]
+            label_class = ["checkbox-inline", label_class].compact.join(' ')
+            label(label_name, html, class: label_class)
+          else
+            content_tag(:div, class: "checkbox") do
+              label(label_name, html, class: label_class)
+            end
+          end
+        end
+      end
+  
+      def radio_button(name, value, *args)
+        options = args.extract_options!.symbolize_keys!
+        args << options.except(:label, :label_class, :inline)
+        label_class = [options[:label_class]]
+        
+        temporarily_disable_field_error_proc do
+          html = super(name, value, *args) + " " + value.humanize
+
+          if options[:inline]
+            label_class = ["radio-inline", label_class].compact.join(" ")
+            label(value, html, value: value, class: label_class)
+          else
+            content_tag(:div, class: "radio") do
+              label(value, html, value: value, class: label_class)
+            end
+          end
+        end
+      end
+    
+      def form_group(*args, &block)
+        options = args.extract_options!
+        name = args.first
+    
+        options[:class] = ["form-group", options[:class]]
+        options[:class] << label_error_class if has_errors?(name)
+        options[:class] = options[:class].compact.join(" ")
+    
+        content_tag(:div, options.except(:label, :label_class)) do
+          label_class = [@label_col, options[:label_class]].compact.join(' ')
+          
+          label = @template.label_tag(nil, options[:label], class: label_class) if options[:label]
+          controls = capture(&block).to_s
+      
+          error_help = generate_error_help(name)
+          controls = content_tag(:div, class: @control_col) { concat(controls) } if gridded_form?
+      
+
+          concat(label).concat(controls).concat(error_help)
+        end
+      end
+    
+      def submit(name = nil, options = {})
+        options[:class] = ["btn btn-default", options[:class]].compact.join(" ")
+        super(name, options)
+      end
+  
+      def primary(name = nil, options = {})
+        options[:class] = ["btn btn-primary", options[:class]].compact.join(" ")
+        method(:submit).super_method.call(name, options)
+      end
+  
+      def alert_message(title, options = {})
+        alert_class = options[:class] || 'alert alert-danger'
+        display_errors = options.delete(:error_summary)
+    
+        if object.respond_to?(:errors) && object.errors.full_messages.any?
+          content_tag :div, class: alert_class do
+            content = [content_tag(:p, title)]
+            content << error_summary if display_errors
+            content.join.html_safe
+          end
+        end
+      end
+  
+      def error_summary
+        content_tag :ul, class: 'bootstrap-form-error-summary' do
+          object.errors.full_messages.each do |error|
+            concat content_tag(:li, error)
+          end
+        end
+      end
+    
+      private
+  
+      def objectify_options(options)
+        super.except(:layout, :inline_errors, :inline_error_class)
+      end
+  
+      def temporarily_disable_field_error_proc
+        original_proc = ActionView::Base.field_error_proc
+        ActionView::Base.field_error_proc = proc { |input, instance| input }
+        yield
+      ensure
+        ActionView::Base.field_error_proc = original_proc
+      end
+  
+      def form_group_builder(method, options)
+        container_class = [fieldset_class]
+        container_class << "row" if gridded_form?
+        container_class << fieldset_errors_class if has_errors?(method)
+        container_class << options.delete(:container_class)
+        container_class = container_class.compact.join(" ")
+    
+        content_tag :div, class: container_class do
+          yield
+        end
+      end
+  
+      def generate_label(name, *args)
+        options = args.extract_options!
+        label_class = options.delete(:label_class)
+        label_class = ["form-control-label", @label_col, label_class]
+        label_class << hide_label_class if hide_label?(options)
+        label_class << label_error_class if has_errors?(name)
+        label_class = label_class.compact.join(" ")
+    
+        label_name  = options.delete(:label)
+        label_name ||= name.to_s.humanize
+    
+        label(name, label_name, class: label_class)    
+      end
+  
+      def generate_error_help(name, *args)
+        if has_errors?(name) && @inline_errors
+          error_class = ["text-muted", "error-text", @inline_error_class].compact.join(" ")
+          content_tag(:small, class: error_class) do
+            get_error_messages(name)
+          end
+        end
+      end
+  
+      def gridded_form?
+        @label_col && @control_col
+      end
+  
+      def inline_layout?
+        @layout == :inline
+      end
+  
+      def hide_label?(options)
+        options.delete(:hide_label)
+      end
+  
+      #Errors
+  
+      def has_errors?(name)
+        object.respond_to?(:errors) && !(name.nil? || object.errors[name].empty?)
+      end
+  
+      def get_error_messages(name)
+        object.errors[name].join(", ")
+      end
+  
+      #Default classes
+  
+      def hide_label_class
+        "sr-only"
+      end
+  
+      def inline_class
+        "form-inline"
+      end
+  
+      def control_class
+        "form-control"
+      end
+  
+      def fieldset_class
+        "form-group"
+      end
+  
+      def label_error_class
+        "label-error"
+      end
+  
+      def fieldset_errors_class
+        "field-with-errors"
+      end
+    
+    end
+  end
+end

data/lib/bootstrap4_form_builder/helper.rb

@@ -0,0 +1,31 @@
+module Bootstrap4FormBuilder
+  module Helper
+    
+    def bootstrap_form_for(object, options= {}, &block)
+      options.reverse_merge!({builder: Bootstrap4FormBuilder::FormBuilder::BootstrapBuilder})
+      
+      options[:html] ||= {}
+      options[:html][:role] ||= "form"
+      
+      #Done in Builder
+      # if options[:layout] == :inline
+      #   options[:html][:class] = [options[:html][:class], "form-inline"].compact.join(" ")
+      # end
+      
+      #Done in Builder
+      #temporarily_disable_field_error_proc do
+        form_for(object, options, &block)
+      #end
+    end
+    
+    
+    def temporarily_disable_field_error_proc
+      original_proc = ActionView::Base.field_error_proc
+      ActionView::Base.field_error_proc = proc { |input, instance| input }
+      yield
+    ensure
+      ActionView::Base.field_error_proc = original_proc
+    end
+    
+  end
+end

data/lib/bootstrap4_form_builder/version.rb

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

data/lib/tasks/bootstrap4_form_builder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bootstrap4_form_builder do
+#   # Task goes here
+# end

data/test/bootstrap4_form_builder_helper_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class Bootstap4FormBuilderHelperTest < ActionView::TestCase
+  include Bootstrap4FormBuilder::Helper
+    
+  test "default forms" do
+    expected = %{<form role="form" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post"><input name="utf8" type="hidden" value="&#x2713;" /><div class="form-group"><label class="form-control-label" for="user_name">Name</label><input class="form-control" type="text" name="user[name]" id="user_name" /></div></form>}
+    assert_equal expected, bootstrap_form_for(User.new) { |f| f.text_field(:name)}
+  end
+  
+  test "inline forms" do
+    expected = %{<form role="form" class="new_user form-inline" id="new_user" action="/users" accept-charset="UTF-8" method="post"><input name="utf8" type="hidden" value="&#x2713;" /><div class="form-group"><label class="form-control-label" for="user_name">Name</label><input class="form-control" type="text" name="user[name]" id="user_name" /></div></form>}
+    assert_equal expected, bootstrap_form_for(User.new, layout: :inline) { |f| f.text_field(:name)}
+  end
+  
+  test "gridded forms" do
+    expected = %{<form role="form" class="new_user" id="new_user" action="/users" accept-charset="UTF-8" method="post"><input name="utf8" type="hidden" value="&#x2713;" /><div class="form-group row"><label class="form-control-label col-sm-2" for="user_name">Name</label><div class="col-sm-10"><input class="form-control" type="text" name="user[name]" id="user_name" /></div></div></form>}
+    assert_equal expected, bootstrap_form_for(User.new, label_col: 'col-sm-2', control_col: 'col-sm-10') { |f| f.text_field(:name)}
+  end
+end

data/test/bootstrap4_form_builder_radio_check_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class Bootstrap4FormBuilderRadioCheckTest < ActionView::TestCase
+  
+  def setup
+    @builder = Bootstrap4FormBuilder::FormBuilder::BootstrapBuilder.new(:user, nil, self, {})
+  end
+  
+  test "radio_button is wrapped correctly" do
+    expected = %{<div class="form-group"><div class="radio"><label class="" for="user_male_male"><input type="radio" value="male" name="user[gender]" id="user_gender_male" /> Male</label></div><div class="radio"><label class="" for="user_female_female"><input type="radio" value="female" name="user[gender]" id="user_gender_female" /> Female</label></div></div>}
+    output = @builder.form_group(:gender) do
+      @builder.radio_button(:gender, "male") + @builder.radio_button(:gender, "female")
+    end 
+    
+    assert_equal expected, output
+  end
+  
+  test "check_box is wrapped correctly" do
+    expected = %{<div class="form-group"><div class="checkbox"><label for="user_agree"><input name="user[agree]" type="hidden" value="0" /><input type="checkbox" value="1" name="user[agree]" id="user_agree" /> Agree to Terms</label></div></div>}
+    output = @builder.form_group(:agree) do
+      @builder.check_box :agree, label: "Agree to Terms"
+    end 
+    
+    assert_equal expected, output
+  end
+  
+  test "radio_button inline is wrapped correctly" do
+    expected = %{<div class="form-group"><label class="radio-inline " for="user_male_male"><input type="radio" value="male" name="user[gender]" id="user_gender_male" /> Male</label><label class="radio-inline " for="user_female_female"><input type="radio" value="female" name="user[gender]" id="user_gender_female" /> Female</label></div>}
+    output = @builder.form_group(:gender) do
+      @builder.radio_button(:gender, "male", inline: true)+@builder.radio_button(:gender, "female", inline: true)
+    end 
+    
+    assert_equal expected, output
+  end
+  
+  test "check_box inline is wrapped correctly" do
+    expected = %{<div class="form-group"><label class="checkbox-inline" for="user_agree"><input name="user[agree]" type="hidden" value="0" /><input type="checkbox" value="1" name="user[agree]" id="user_agree" /> Agree to Terms</label></div>}
+    output = @builder.form_group(:agree) do
+      @builder.check_box :agree, label: "Agree to Terms", inline: true
+    end 
+    
+    assert_equal expected, output
+  end
+  
+  test "form_group label and label_class are included" do
+    expected = %{<div class="form-group"><label class="terms-label">Terms</label><div class="checkbox"><label for="user_agree"><input name="user[agree]" type="hidden" value="0" /><input type="checkbox" value="1" name="user[agree]" id="user_agree" /> Agree to Terms</label></div></div>}
+    output = @builder.form_group(:agree, label: "Terms", label_class: "terms-label") do
+      @builder.check_box :agree, label: "Agree to Terms"
+    end 
+    
+    assert_equal expected, output
+  end
+end