formtastic_rebootstrap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4257feb469a591ff347eb41048290169545d08cc
+  data.tar.gz: ce32a54cad31512eac1f11291a4b0f378b8660c4
+SHA512:
+  metadata.gz: 48bed131e59562159107d4bd5710db9d07c24dff4c4b22cdc831d8063d41f51f602f88aae15e9c9f736fc97348120b5b5265358c804bfe88209b0e811ea12086
+  data.tar.gz: cc00dd0baa5cf519ca45d1b13f97fe0f517777b7e96261d712914f63ea2c375fa44d9f30defe6d5decaaa80a86162519d007781bb727e65b3430d8fecd99f037

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Matthew Bellantoni
+
+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,200 @@
+# Formtastic Bootstrap
+
+A [Formtastic](https://github.com/justinfrench/formtastic) form builder that creates markup suitable for the [Twitter Bootstrap](http://twitter.github.com/bootstrap/) framework.  In theory, it should just work.  Two great tastes in one!
+
+You can follow [FormBoot on twitter](http://twitter.com/FormBoot) for update announcements and other relevant info.
+
+## Getting Started
+
+### Dependencies
+
+This version of Formtastic Bootstrap should support the following:
+
+*Bootstrap*
+
+* Bootstrap 3.x
+
+*Rails*
+
+* Rails 3.2.x
+* Rails 4.x.x
+
+*Formtastic*
+
+* Formtastic 2.2.x
+* Formtastic 2.3.x
+
+*Ruby*
+
+* 1.9.2
+* 1.9.3
+* 2.x.x
+
+#### Installation
+
+Install the gem with
+
+    gem install formtastic_rebootstrap
+
+Or add it to your Gemfile:
+
+    gem 'formtastic_rebootstrap'
+
+And install it with <tt>bundle install</tt>.
+
+#### Configuration
+
+Add the following line to your Formtastic initialization file:
+
+    # config/initializers/formtastic.rb
+    Formtastic::Helpers::FormHelper.builder = FormtasticRebootstrap::FormBuilder
+
+Add the following line to the top of your <tt>application.css</tt> file:
+
+    # app/assets/stylesheets/application.css
+    *= require formtastic_rebootstrap
+
+Make sure you've already downloaded and installed Formtastic! Do *not* however require formtastic in your `application.css` file or you will have many bootstrap/formtastic_rebootstrap styles overwritten. 
+
+
+## Formtastic vs. Formtastic Bootstrap
+
+THIS SECTION IS OUT OF DATE.
+
+### Overview
+
+In general, Formtastic creates very verbose HTML whereas
+Bootstrap expects (ever) simpler HTML.  Every attempt has been
+made to generate the HTML expected by Bootstrap while still
+generating the rich HTML provided by Formtastic.  When there
+is a conflict, Bootstrap wins.
+
+
+### Major Difference in Behavior
+
+THIS SECTION IS OUT OF DATE
+
+* Formtastic Bootstrap omits the <tt>label</tt> class on label tags since Twitter Bootstrap uses this tag in another context (and it makes bad things happen.)
+* Formtastic Bootstrap puts the <tt>input</tt> label in a different place because it makes Bootstrap behave correctly.
+* Formtastic Bootstrap renders <tt>:date</tt>, <tt>:datetime</tt> and <tt>:time</tt> as text fields since this is how Twitter Bootstrap presents these data types  (Formtastic renders them as dropdowns.) Some Rails magic may have been lost here.  Additionally:
+  * <tt>:date</tt> et al are tagged with the <tt>stringish</tt> class.
+  * Hidden fields are not generated.
+* Fieldsets are simply nested.
+* <tt>f.buttons :name</tt> is not supported.  This generates a <tt>fieldset</tt> and <tt>legend</tt> tag which will cause the wrong thing to happen in Bootstrap.
+
+Bootstrap is somewhat incomplete, and in a few cases an inference needed to be drawn to determine a course of action.  If you disagree with any of these choices, feel free to let me know.
+
+The gem also provides some "shim" CSS where Bootstrap is missing styles provided Formtastic.
+
+### Other
+
+A lot of the code (especially the test suite) was copied
+over from Formtastic and then beaten into submission.  I'm
+sure you'll find some ugliness in there.  In general, I
+mimicked the Formtastic code structure as much as possible.
+
+In particular:
+
+* Bootstrap doesn't say anything about nested <tt>formfields</tt>.
+* Bootstrap doesn't explicitly lay out a <tt>:boolean</tt> control.
+* Bootstrap doesn't explicitly say everything that needs to be said about <tt>:datetime</tt>, <tt>:date</tt>, and <tt>:time</tt>.
+* I've inferred what <tt>:datetime</tt> should do since there's not example of a single <tt>:datetime</tt>.
+* In some places the markup is tortuous (e.g. <tt>:boolean</tt>.)  Hopefully as Bootstrap evolves these can get simplified!
+* Bootstrap uses different HTML classes for sentence-based inline/block error messages.
+
+### What's Missing
+
+Contributions are welcome!
+
+* Formtastic's <tt>:country</tt> has not yet been implemented.
+* I'm sure there's lots ...
+
+## Usage
+
+In general, the usage should be identical to Formtastic's.  Some changes have been introduced in order to support Bootstrap-specific controls.
+
+### Bootstrap-specific Controls
+
+#### Prepended Text
+To create a Prepended Text field, use the ```:prepend``` option.  This works on any text field input type, like ```:url```, ```:search```, and of course ```:string```
+
+    <%= semantic_form_for @user do |f| %>
+      <%= f.inputs do %>
+        <%= f.input :handle, :prepend => '@' %>
+      <% end %>
+    <% end %>
+
+#### Appended Text
+To create an Appended Text field, use the ```:append``` option.  This works on any text field input type, like ```:url```, ```:search```, and of course ```:string```
+
+    <%= semantic_form_for @user do |f| %>
+      <%= f.inputs do %>
+        <%= f.input :handle, :append => '%' %>
+      <% end %>
+    <% end %>
+
+#### Appended Content
+To add appended elements that are not contained within an add-on span
+use the ```:append_content``` or ```:prepend_content``` option.
+
+    <%= semantic_form_for @user do |f| %>
+      <%= f.inputs do %>
+        <%= f.input :handle, :append_content => content_tag(:a, "Click Here", :class => 'btn') %>
+      <% end %>
+    <% end %>
+
+## Contributing
+
+### Contributors
+
+A big thank you [to all contributors](https://github.com/mjbellantoni/formtastic_rebootstrap/contributors)!
+
+### Submitting Issues
+
+If you're filing a bug, thank you!  Secondly, in the report please include:
+
+* The version of Formtastic you're using.
+* The version of Twitter Bootstrap you're using.
+* The code for your form.
+* Anything else you think will help!
+
+### Source Contributions
+
+Source contributions are very welcome!  Most of the recent work on this package has been done by the community.
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it and to run the test suite.  **If you don't have tests, I won't accept the pull.**  If you need help with this, please ask.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+### To Do
+
+* Field Types
+ * Basic Formtastic
+   * :country
+   * :time_zone
+ * Fancy Bootstrap Fields
+   * Date Range
+   * Prepend Checkbox
+   * Appended Checkbox
+* :datetime, :date, :time
+ * As rich functionally as their Rails counterparts.
+ * Extract into a standalone gem.
+* Tests
+ * Fill in all pending specs
+ * Refactor
+ * More -- See if I'm making sure the Bootstrap classes are present.
+* Documentation
+* Refactor :boolean to use common "choices" code (if possible.) (Not sure it is.)
+* Boostrap
+  * Why 'help-inline' and 'help-block' when they could have done p.help and span.help?
+
+
+## Copyright
+
+Copyright (c) 2013-2015 Matthew Bellantoni. See LICENSE.txt for further details.
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/action_view/helpers/text_field_date_helper.rb

@@ -0,0 +1,166 @@
+require 'action_view/helpers/form_tag_helper'
+
+module ActionView
+  module Helpers
+
+    module TextFieldDateHelper
+
+      # These two handle an object with a method that returns a Date or Time object.
+      def date_text_field(object_name, method, options = {}, html_options = {})
+        InstanceTag.new(object_name, method, self, options.delete(:object)).to_date_text_field_tag(options, html_options)
+      end
+
+      def time_text_field(object_name, method, options = {}, html_options = {})
+        InstanceTag.new(object_name, method, self, options.delete(:object)).to_time_text_field_tag(options, html_options)
+      end
+
+      # These two handle Date and Time objects.
+      def text_field_date(date = Date.current, options = {}, html_options = {})
+        DateTimeSelector.new(date, options, html_options).text_field_date
+      end
+
+      def text_field_time(time = Time.current, options = {}, html_options = {})
+        DateTimeSelector.new(time, options, html_options).text_field_time
+      end
+    end
+
+    class DateTimeSelector
+
+      include ActionView::Helpers::FormTagHelper
+
+      def text_field_date
+        order = date_order.dup
+
+        @options[:discard_hour]     = true
+        @options[:discard_minute]   = true
+        @options[:discard_second]   = true
+
+        @options[:discard_year]   ||= true unless order.include?(:year)
+        @options[:discard_month]  ||= true unless order.include?(:month)
+        @options[:discard_day]    ||= true if @options[:discard_month] || !order.include?(:day)
+
+        # Save this so we can restore it.
+        original_datetime_separator_separator = @options[:datetime_separator]
+        original_date_separator = @options[:date_separator]
+
+        @options[:datetime_separator] = ""
+        @options[:date_separator] = " "
+
+        # If the day is hidden and the month is visible, the day should be set to the 1st so all month choices are
+        # valid (otherwise it could be 31 and February wouldn't be a valid date)
+        if @datetime && @options[:discard_day] && !@options[:discard_month]
+          @datetime = @datetime.change(:day => 1)
+        end
+
+        [:day, :month, :year].each { |o| order.unshift(o) unless order.include?(o) }
+
+        build_text_field_from_types(order).tap do
+          # Restore.
+          @options[:datetime_separator] = original_datetime_separator_separator
+          @options[:date_separator] = original_date_separator
+        end
+      end
+
+      def text_field_time
+        order = []
+
+        @options[:discard_month]    = true
+        @options[:discard_year]     = true
+        @options[:discard_day]      = true
+        @options[:discard_second] ||= true unless @options[:include_seconds]
+
+        # Save this so we can restore it.
+        original_datetime_separator = @options[:datetime_separator]
+        original_time_separator = @options[:time_separator]
+        original_date_separator = @options[:date_separator]
+
+        @options[:datetime_separator] = ''
+        @options[:time_separator] = ':'
+        @options[:date_separator] = " "
+
+        order += [:year, :month, :day] unless @options[:ignore_date]
+
+        order += [:hour, :minute]
+        order << :second if @options[:include_seconds]
+
+        build_text_field_from_types(order).tap do
+          # Restore.
+          @options[:datetime_separator] = original_datetime_separator
+          @options[:date_separator] = original_date_separator
+          @options[:time_separator] = original_time_separator
+        end
+      end
+
+      def text_field_second
+        unless @options[:use_hidden] || @options[:discard_second]
+          build_text(:second, sec)
+        end
+      end
+
+      def text_field_minute
+        unless @options[:use_hidden] || @options[:discard_minute]
+          build_text(:minute, min)
+        end
+      end
+
+      def text_field_hour
+        unless @options[:use_hidden] || @options[:discard_hour]
+          build_text(:hour, hour, :ampm => @options[:ampm])
+        end
+      end
+
+      def text_field_day
+        unless @options[:use_hidden] || @options[:discard_day]
+          build_text(:day, day, :leading_zeros => false)
+        end
+      end
+
+      def text_field_month
+        unless @options[:use_hidden] || @options[:discard_month]
+          build_text(:month, month.nil? ? "" : month_name(month), :leading_zeros => false)
+        end
+      end
+
+      def text_field_year
+        unless @options[:use_hidden] || @options[:discard_year]
+          build_text(:year, year, :leading_zeros => false)
+        end
+      end
+
+      def build_text_field_from_types(order)
+        input = ''
+        order.reverse.each do |type|
+          separator = separator(type) unless type == order.first # don't add on last field
+          input.insert(0, separator.to_s + send("text_field_#{type}").to_s)
+        end
+        text_field_tag("", input.html_safe, @html_options).html_safe
+      end
+
+      def build_text(selected, value, options = {})
+        unless value.nil?
+          options.reverse_merge!({:leading_zeros => true, :ampm => false})
+          leading_zeros = options.delete(:leading_zeros)
+          value = leading_zeros ? sprintf("%02d", value) : value
+          text = options[:ampm] ? AMPM_TRANSLATION[value] : value
+        else
+          ""
+        end
+      end
+
+    end
+
+    class InstanceTag #:nodoc:
+      def to_date_text_field_tag(options = {}, html_options = {})
+       datetime_selector(options, html_options).text_field_date.html_safe
+      end
+
+      def to_time_text_field_tag(options = {}, html_options = {})
+       datetime_selector(options, html_options).text_field_time.html_safe
+      end
+    end
+
+    autoload :TextFieldDateHelper
+    include TextFieldDateHelper
+
+  end
+end

data/lib/formtastic_rebootstrap/actions/base.rb

@@ -0,0 +1,27 @@
+module FormtasticRebootstrap
+  module Actions
+    module Base
+
+      # Bootstrap doesn't have wrappers.
+      def wrapper(&block)
+        template.capture(&block)
+      end
+
+      # Default button class
+      def default_wrapper_classes
+        ["btn"]
+      end
+
+      # :wrapper_html member :class is prefixed with btn
+      # :button_html member :class is all encompassing
+      def default_button_html
+        {
+          :accesskey => accesskey,
+          :class => wrapper_class.strip,
+          :id => wrapper_id
+         }
+      end
+
+    end
+  end
+end

data/lib/formtastic_rebootstrap/actions/button_action.rb

@@ -0,0 +1,13 @@
+# <form...>
+#   <fieldset class="form-actions">
+#     <button class="btn" type="reset" value="Reset">
+#     <button class="btn" type="submit" value="Create Post">
+#   </fieldset>
+# </form>
+module FormtasticRebootstrap
+  module Actions
+    class ButtonAction < Formtastic::Actions::ButtonAction
+      include Base
+    end
+  end
+end

data/lib/formtastic_rebootstrap/actions/input_action.rb

@@ -0,0 +1,13 @@
+# <form...>
+#   <fieldset class="form-actions">
+#     <input class="btn" type="reset" value="Reset">
+#     <input class="btn" type="submit" value="Create Post">
+#   </fieldset>
+# </form>
+module FormtasticRebootstrap
+  module Actions
+    class InputAction < Formtastic::Actions::InputAction
+      include Base
+    end
+  end
+end

data/lib/formtastic_rebootstrap/actions/link_action.rb

@@ -0,0 +1,12 @@
+# <form...>
+#   <fieldset class="form-actions">
+#     <a class="btn" href="">Link</a>
+#   </fieldset>
+# </form>
+module FormtasticRebootstrap
+  module Actions
+    class LinkAction < Formtastic::Actions::LinkAction
+      include Base
+    end
+  end
+end

data/lib/formtastic_rebootstrap/actions.rb

@@ -0,0 +1,10 @@
+module FormtasticRebootstrap
+  module Actions
+    extend ActiveSupport::Autoload
+
+    autoload :Base,         'formtastic_rebootstrap/actions/base'
+    autoload :InputAction,  'formtastic_rebootstrap/actions/input_action'
+    autoload :LinkAction,   'formtastic_rebootstrap/actions/link_action'
+    autoload :ButtonAction, 'formtastic_rebootstrap/actions/button_action'
+  end
+end

data/lib/formtastic_rebootstrap/engine.rb

@@ -0,0 +1,4 @@
+module FormtasticRebootstrap
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/formtastic_rebootstrap/form_builder.rb

@@ -0,0 +1,45 @@
+module FormtasticRebootstrap
+
+  class FormBuilder < Formtastic::FormBuilder
+
+    configure :default_inline_error_class, 'help-inline'
+    configure :default_block_error_class,  'help-block'
+    configure :default_inline_hint_class,  'help-inline'
+    configure :default_block_hint_class,   'help-block'
+
+    self.input_namespaces = [::Object, ::FormtasticRebootstrap::Inputs, ::Formtastic::Inputs]
+    self.action_namespaces = [::Object, ::FormtasticRebootstrap::Actions, ::Formtastic::Actions]
+
+    # TODO: remove both class finders after formtastic 4 (where it will be default)
+    self.input_class_finder = ::Formtastic::InputClassFinder
+    self.action_class_finder = ::Formtastic::ActionClassFinder
+
+    def self.default_error_class
+      # self.default_inline_error_class
+      raise
+    end
+
+    def self.default_error_class=(error_class)
+      # self.default_inline_error_class = error_class
+      # self.default_block_error_class = error_class
+      raise
+    end
+
+    def self.default_hint_class
+      # self.default_inline_hint_class
+      raise
+    end
+
+    def self.default_hint_class=(hint_class)
+      # self.default_inline_hint_class = hint_class
+      # self.default_block_hint_class = hint_class
+      raise
+    end
+
+    include FormtasticRebootstrap::Helpers::InputsHelper
+    include FormtasticRebootstrap::Helpers::ErrorsHelper
+    include FormtasticRebootstrap::Helpers::ActionsHelper
+
+  end
+
+end

data/lib/formtastic_rebootstrap/helpers/actions_helper.rb

@@ -0,0 +1,24 @@
+module FormtasticRebootstrap
+  module Helpers
+    module ActionsHelper
+
+      include Formtastic::Helpers::ActionsHelper
+      include FormtasticRebootstrap::Helpers::FieldsetWrapper
+
+      def actions(*args, &block)
+
+        html_options = args.extract_options!
+        html_options[:class] ||= "form-actions"
+
+        if block_given?
+          field_set_and_list_wrapping(html_options, &block)
+        else
+          args = default_actions if args.empty?
+          contents = args.map { |action_name| action(action_name) }
+          field_set_and_list_wrapping(html_options, contents)
+        end
+      end
+
+    end
+  end
+end

data/lib/formtastic_rebootstrap/helpers/errors_helper.rb

@@ -0,0 +1,70 @@
+module FormtasticRebootstrap
+  module Helpers
+    module ErrorsHelper
+      include Formtastic::Helpers::FileColumnDetection
+      include Formtastic::Helpers::Reflection
+      include Formtastic::LocalizedString
+
+      INLINE_ERROR_TYPES = [:sentence, :list, :first]
+
+      # Generates a bootstrap error alert element containing
+      # an unordered list of error messages on the base object and optionally for a given
+      # set of named attribute. This is idea for rendering a block of error messages at the top of
+      # the form for hidden/special/virtual attributes (the Paperclip Rails plugin does this), or
+      # errors on the base model.
+      #
+      # A hash can be used as the last set of arguments to pass HTML attributes to the `<ul>`
+      # wrapper.
+      #
+      # @example A list of errors on the base model
+      #   <%= semantic_form_for ... %>
+      #     <%= f.semantic_errors %>
+      #     ...
+      #   <% end %>
+      #
+      # @example A list of errors on the base and named attributes
+      #   <%= semantic_form_for ... %>
+      #     <%= f.semantic_errors :something_special %>
+      #     ...
+      #   <% end %>
+      #
+      # @example A list of errors on the base model, with custom HTML attributes
+      #   <%= semantic_form_for ... %>
+      #     <%= f.semantic_errors :class => "awesome" %>
+      #     ...
+      #   <% end %>
+      #
+      # @example A list of errors on the base model and named attributes, with custom HTML attributes
+      #   <%= semantic_form_for ... %>
+      #     <%= f.semantic_errors :something_special, :something_else, :class => "awesome", :onclick => "Awesome();" %>
+      #     ...
+      #   <% end %>
+      def semantic_errors(*args)
+        html_options = args.extract_options!
+        args = args - [:base]
+        full_errors = args.inject([]) do |array, method|
+          attribute = localized_string(method, method.to_sym, :label) || humanized_attribute_name(method)
+          errors = Array(@object.errors[method.to_sym]).to_sentence
+          errors.present? ? array << [attribute, errors].join(" ") : array ||= []
+        end
+        full_errors << @object.errors[:base]
+        full_errors.flatten!
+        full_errors.compact!
+        return nil if full_errors.blank?
+
+        if html_options[:class].blank?
+          html_options[:class] = "alert alert-danger"
+        else
+          html_options[:class] = "alert alert-danger " + html_options[:class]
+        end
+
+        template.content_tag(:div, html_options) do
+          template.content_tag(:a, "&times;".html_safe, :class => "close", "data-dismiss" => "alert") +
+          template.content_tag(:ul, {:class => "error-list"}) do
+            Formtastic::Util.html_safe(full_errors.map { |error| template.content_tag(:li, Formtastic::Util.html_safe(error)) }.join)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/formtastic_rebootstrap/helpers/fieldset_wrapper.rb

@@ -0,0 +1,35 @@
+module FormtasticRebootstrap
+  module Helpers
+    module FieldsetWrapper
+
+      include Formtastic::Helpers::FieldsetWrapper
+
+      protected
+
+      def field_set_and_list_wrapping(*args, &block) #:nodoc:
+        contents = args.last.is_a?(::Hash) ? '' : args.pop.flatten
+        html_options = args.extract_options!
+
+        if block_given?
+          contents = if template.respond_to?(:is_haml?) && template.is_haml?
+            template.capture_haml(&block)
+          else
+            template.capture(&block)
+          end
+        end
+
+        # Ruby 1.9: String#to_s behavior changed, need to make an explicit join.
+        contents = contents.join if contents.respond_to?(:join)
+
+        legend = field_set_legend(html_options)
+        fieldset = template.content_tag(:fieldset,
+          Formtastic::Util.html_safe(legend) << Formtastic::Util.html_safe(contents),
+          html_options.except(:builder, :parent, :name)
+        )
+
+        fieldset
+      end
+
+    end
+  end
+end