railsstrap 3.3.4 → 4.0.0.beta2

data/lib/railsstrap/core_ext/rails/form/submit_helper.rb

@@ -0,0 +1,23 @@
+require 'railsstrap/core_ext/rails/form/base_helper'
+
+module Railsstrap
+  module Form
+    module SubmitHelper
+      include BaseHelper
+
+      def submit(value=nil, options={})
+        context = options.delete(:context) || 'primary'
+        append_class! options, "btn btn-#{context}"
+        if horizontal_form?
+          content_tag :div, class: 'form-group' do
+            content_tag :div, class: 'col-sm-offset-3 col-sm-9' do
+              super value, options
+            end
+          end
+        else
+          super value, options
+        end
+      end
+    end
+  end
+end

data/lib/railsstrap/core_ext/rails/form_builder.rb

@@ -0,0 +1,46 @@
+require 'railsstrap/core_ext/rails/form/check_box_helper'
+require 'railsstrap/core_ext/rails/form/field_helper'
+require 'railsstrap/core_ext/rails/form/fieldset_helper'
+require 'railsstrap/core_ext/rails/form/fields_for_helper'
+require 'railsstrap/core_ext/rails/form/file_field_helper'
+require 'railsstrap/core_ext/rails/form/legend_helper'
+require 'railsstrap/core_ext/rails/form/radio_button_helper'
+require 'railsstrap/core_ext/rails/form/select_helper'
+require 'railsstrap/core_ext/rails/form/static_control_helper'
+require 'railsstrap/core_ext/rails/form/submit_helper'
+
+module Railsstrap
+  # @api private
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    include ActionView::Helpers::SanitizeHelper
+    extend ActionView::Helpers::SanitizeHelper::ClassMethods
+    include Form::CheckBoxHelper
+    include Form::FieldHelper
+    include Form::FieldsetHelper
+    include Form::FieldsForHelper
+    include Form::FileFieldHelper
+    include Form::LegendHelper
+    include Form::RadioButtonHelper
+    include Form::SelectHelper
+    include Form::StaticControlHelper
+    include Form::SubmitHelper
+
+    # @note: field_helpers are returned as symbols in ActionView 4 and as
+    #   strings in ActionView 3
+    def self.textual_field_helpers
+      non_textual_field_helpers = %w(label hidden_field range_field check_box
+        file_field radio_button select submit fields_for label)
+      field_helpers.map(&:to_s) - non_textual_field_helpers
+    end
+
+    # Use the same template for all the textual field helpers such as
+    # email_field, password_field, etc.
+    # Exclude the ones that should not have additional styles.
+    # Do not show error icons on number_field not to cover the sliders.
+    textual_field_helpers.each do |field_type|
+      define_method field_type do |method, options = {}|
+        field(method, field_type, options) { super method, options }
+      end
+    end
+  end
+end

data/lib/railsstrap/core_ext/rails/form_for_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'railsstrap/core_ext/rails/base_helper'
+require 'railsstrap/core_ext/rails/form_builder'
+
+module Railsstrap
+  module Rails
+    module Helpers
+      include BaseHelper
+      include ActionView::Helpers::FormHelper # for form_for
+
+      def form_for(record, options = {}, &block)
+        options[:layout] ||= 'navbar' if Railsstrap::Stack.find(Railsstrap::Navbar)
+        add_form_options!(options) if options[:layout]
+        html = super record, options, &block
+
+        if Railsstrap::Stack.find(Railsstrap::Nav)
+          container = Railsstrap::Base.new(self) { html }
+          container.render_tag :li
+        else
+          html
+        end
+      end
+
+      private
+
+      def add_form_options!(options)
+        options[:html] ||= {}
+        options[:html][:role] = 'form'
+        append_class! options[:html], class_for(options[:layout])
+        options.merge! builder: FormBuilder
+      end
+
+      def class_for(layout)
+        case layout.to_s
+        when 'navbar' then
+          'navbar-form'
+        when 'inline' then
+          'form-inline'
+        when 'horizontal' then
+          'form-horizontal'
+        end
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/alert_box_helper.rb

@@ -0,0 +1,41 @@
+require 'railsstrap/classes/alert_box'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled alert message.
+    # @see http://getbootstrap.com/components/docs/4.0/alerts
+    # @return [String] the HTML to display a Bootstrap-styled alert message.
+    # @overload alert_box(content, options = {})
+    #   @param [#to_s] content the content to display in the alert.
+    #   @param [Hash] options the options for the alert box. Any option not
+    #     listed below is passed as an HTML attribute to the alert’s `<div>`.
+    #   @option options [Boolean] :dismissible (false) whether to display an
+    #     '×' to the right of the box that can be clicked to dismiss the alert.
+    #   @option options [#to_s] :variant (:info) the variant alternative to
+    #     apply to the alert. Can be `:danger`, `:info`, `:success` or
+    #     `:warning`.
+    #   @option options [#to_s] :priority if set to one of the priority levels
+    #     of Rails flash contents, determines the variant of the alert box.
+    #     Can be :alert or :notice.
+    #   @example Display a dismissible alert box with a plain-text content.
+    #       alert_box 'User updated successfully', dismissible: true
+    # @overload alert_box(options = {}, &block)
+    #   @param [Hash] options the options for the alert box (see above).
+    #   @yieldreturn [#to_s] the content to display in the alert.
+    #   @example Display a success alert box with an HTML content.
+    #       alert_box variant: :success do
+    #         content_tag :strong, 'User updated successfully'
+    #       end
+    def alert_box(*args, &block)
+      alert_box = Railsstrap::AlertBox.new(self, *args, &block)
+      alert_box.extract! :variant, :priority, :dismissible, :dismiss, :size
+
+      alert_box.append_class! :alert
+      alert_box.append_class! alert_box.size_class
+      alert_box.append_class! alert_box.variant_class
+      alert_box.merge! role: :alert
+      alert_box.prepend_html! alert_box.dismissible_button
+      alert_box.render_tag :div
+    end
+  end
+end

data/lib/railsstrap/helpers/aside_helper.rb

@@ -0,0 +1,57 @@
+require 'railsstrap/classes/aside'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled aside. Asides inherit from Aside, but
+    # are pinned to the left or right of the screen.
+    # @see https://github.com/toadkicker/railsstrap/wiki/Aside-Helper
+    # @return [String] the HTML to display a Bootstrap-styled aside.
+    # @overload aside(body, options = {})
+    #   @param [#to_s] body the content to display as the aside body.
+    #   @param [Hash] options the options for the aside. Any option not listed
+    #     below is ignored, except for `:id` which is passed as an HTML
+    #     attribute to the aside’s `<div>`.
+    #   @option options [#to_s] :title ('Aside') the title of the aside.
+    #   @option options [#to_s] :body the content to display as the aside body.
+    #     Using this option is equivalent to passing the body as an argument.
+    #   @option options [#to_s] :size the size of the aside. Can be `:large`
+    #     (alias `:lg`) or `:small` (alias `:sm`).
+    #   @option options [Hash] :button the options for the toggle button.
+    #     * :caption (#to_s) ('Aside') the caption of the toggle button.
+    #     * :variant (#to_s) (:default) the variant alternative to apply to
+    #        the toggle button. Can be `:danger`, `:info`, `:link`, `:primary`,
+    #       `:success` or `:warning`.
+    #     * :size (#to_s) the size of the toggle button. Can be `:extra_small`
+    #       (alias `:xs`), `:large` (alias `:lg`) or `:small` (alias `:sm`).
+    #     * :layout (#to_s) if set to `:block`, span the button for the full
+    #       width of the parent.
+    #   @example Display a simple aside toggled by a blue button.
+    #       aside 'You clicked me!', title: 'Click me', button: {variant: :info}
+    # @overload aside(options = {}, &block)
+    #   @param [Hash] options the options for the aside (see above).
+    #   @yieldreturn [#to_s] the content to display in the aside.
+    #   @example Display a aside with HTML content.
+    #       aside title: 'Click me' do
+    #         content_tag :div, class: 'aside-body' do
+    #           content_tag :em, 'You clicked me!'
+    #         end
+    #       end
+
+    def aside(*args, &block)
+      aside = Railsstrap::Aside.new self, *args, &block
+      aside.extract! :button, :size, :body, :title, :id
+
+      aside.extract_from :button, [:variant, :size, :layout, :caption]
+      aside.append_class_to! :button, :btn
+      aside.append_class_to! :button, aside.button_variant_class
+      aside.append_class_to! :button, aside.button_size_class
+      aside.merge! button: {caption: aside.caption}
+
+      aside.append_class_to! :div, :'aside-dialog'
+      aside.append_class_to! :div, aside.dialog_size_class
+      aside.merge! div: {title: aside.title, id: aside.id}
+
+      aside.render_partial 'aside'
+    end
+  end
+end

data/lib/railsstrap/helpers/badge_helper.rb

@@ -0,0 +1,41 @@
+require 'railsstrap/classes/badge'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled badge message.
+    # @see http://getbootstrap.com/components/docs/4.0/badges
+    # @return [String] the HTML to display a Bootstrap-styled badge message.
+    # @overload badge(content, options = {})
+    #   @param [#to_s] content the content to display in the badge.
+    #   @param [Hash] options the options for the badge. Any option not
+    #     listed below is passed as an HTML attribute to the badge’s `<div>`.
+    #   @option options [Boolean] :dismissible (false) whether to display an
+    #     '×' to the right of the box that can be clicked to dismiss the badge.
+    #   @option options [#to_s] :variant (:info) the variant alternative to
+    #     apply to the badge. Can be `:danger`, `:info`, `:success` or
+    #     `:warning`.
+    #   @option options [#to_s] :priority if set to one of the priority levels
+    #     of Rails flash contents, determines the variant of the badge.
+    #     Can be :badge or :notice.
+    #   @example Display a dismissible badge with a plain-text content.
+    #       badge 'User updated successfully', dismissible: true
+    # @overload badge(options = {}, &block)
+    #   @param [Hash] options the options for the badge (see above).
+    #   @yieldreturn [#to_s] the content to display in the badge.
+    #   @example Display a success badge with an HTML content.
+    #       badge variant: :success do
+    #         content_tag :strong, 'User updated successfully'
+    #       end
+    def badge(*args, &block)
+      badge = Railsstrap::Badge.new(self, *args, &block)
+      badge.extract! :variant, :priority, :dismissible
+
+      badge.append_class! :badge
+      badge.append_class! badge.variant_class
+      badge.append_class! badge.pill_class
+      badge.merge! role: :badge
+      badge.prepend_html! badge.dismissible_button
+      badge.render_tag
+    end
+  end
+end

data/{app/helpers/railsstrap → lib/railsstrap/helpers}/breadcrumbs_helper.rb

@@ -1,9 +1,8 @@
 module Railsstrap
-  module BreadcrumbsHelper
+  module Helpers
     #TODO: make divider optional
     def render_breadcrumbs(divider = '/', options={}, &block)
-      default_options = { :class => '', :item_class => '', :divider_class => '', :active_class => 'active' }.merge(options)
-      #TODO: is default_options merged in and then unused?
+      { :class => '', :item_class => '', :divider_class => '', :active_class => 'active' }.merge(options)
       content = render :partial => 'railsstrap/breadcrumbs', :layout => false, :locals => { :divider => divider, options: options }
       if block_given?
         capture(content, &block)

data/lib/railsstrap/helpers/button_group_helper.rb

@@ -0,0 +1,34 @@
+require 'railsstrap/classes/button'
+require 'railsstrap/classes/button_group'
+
+module Railsstrap
+  module Helpers
+    #Displays a Bootstrap-styled button group or toolbar.
+    # @see http://getbootstrap.com/docs/4.0/components/button-group
+    # @return [String] the HTML to display a Bootstrap-styled button.
+    # @overload button_group(caption, options = {})
+    #   @param [#to_s] caption the buttons for the group
+    #   @option options [#to_s] :toolbar creates a div.btn-toolbar
+    #   @option options [#to_s] :role (:group) Sets the role attribute
+    #   @option options [#to_s] :size the size of the button group. Specifying
+    #     size here causes the inner buttons to match this size. Buttons cannot
+    #     be different sizes inside a group.
+    #   @option options [#to_s] :vertical orient the button group vertically.
+    #   @example Display a button group
+    #       button_group size: :lg, do
+    #         button caption, options
+    #         button caption, options
+    #       end
+    def button_group(*args, &block)
+      btn_group = Railsstrap::ButtonGroup.new(self, *args, &block)
+      btn_group.extract! :group, :toolbar, :role, :size, :vertical
+
+      btn_group.append_class! 'btn-group'
+      btn_group.append_class! btn_group.vertical_class
+      btn_group.append_class! btn_group.size_class
+      btn_group.append_class! btn_group.toolbar_class
+      btn_group.merge! btn_group.role_name
+      btn_group.content_tag :div
+    end
+  end
+end

data/lib/railsstrap/helpers/button_helper.rb

@@ -0,0 +1,40 @@
+require 'railsstrap/classes/button'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled button.
+    # @see http://getbootstrap.com/css/#buttons
+    # @return [String] the HTML to display a Bootstrap-styled button.
+    # @overload button(caption, options = {})
+    #   @param [#to_s] caption the caption to display in the button.
+    #   @param [Hash] options the options for the button. Any option not
+    #     listed below is passed as an HTML attribute to the `<button>` tag.
+    #   @option options [#to_s] :variant (:default) the variant alternative
+    #     to apply to the button. Can be `:danger`, `:info`, `:link`,
+    #     `:primary`, `:success` or `:warning`.
+    #   @option options [#to_s] :size the size of the button.
+    #     Can be `:extra_small` (alias `:xs`), `:large` (alias `:lg`) or
+    #     `:small` (alias `:sm`).
+    #   @option options [#to_s] :layout if set to `:block`, span the button
+    #     for the full width of the parent.
+    #   @example Display a button styled as a link.
+    #       button 'Click here', variant: :link
+    # @overload button(options = {}, &block)
+    #   @param [Hash] options the options for the button (see above).
+    #   @yieldreturn [#to_s] the caption to display in the button.
+    #   @example Display a button with an HTML caption.
+    #       button do
+    #         content_tag :strong, 'Click here'
+    #       end
+    def button(*args, &block)
+      button = Railsstrap::Button.new(self, *args, &block)
+      button.extract! :variant, :size, :layout
+
+      button.append_class! :btn
+      button.append_class! button.variant_class
+      button.append_class! button.size_class
+      button.append_class! button.layout_class
+      button.content_tag :button
+    end
+  end
+end

data/lib/railsstrap/helpers/button_to_helper.rb

@@ -0,0 +1,65 @@
+require 'railsstrap/classes/button_to'
+require 'railsstrap/classes/navbar'
+require 'railsstrap/classes/stack'
+
+module Railsstrap
+  module Helpers
+    # Overrides `button_to` to display a Bootstrap-styled button.
+    # Can only be used in Ruby frameworks that provide the `button_to` method.
+    # Only overrides the original method if called with any of the `:variant`,
+    # `:size` or `:layout` option, otherwise calls the original method.
+    # @see http://getbootstrap.com/css/#buttons
+    # @see http://getbootstrap.com/components/docs/4.0/navs
+    # @see http://getbootstrap.com/components/docs/4.0/navbar-buttons
+    # @see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-button_to
+    # @see http://rubydoc.info/gems/padrino-helpers/Padrino/Helpers/FormHelpers#button_to-instance_method
+    # @return [String] the HTML to display a Bootstrap-styled button.
+    # @overload button_to(caption, url, options = {})
+    #   @param [#to_s] caption the caption to display in the button.
+    #   @param [#to_s] url the URL to submit to.
+    #   @param [Hash] options the options for the button. Any option not
+    #     listed below is passed to the original `button_to` method.
+    #   @option options [#to_s] :variant (:default) the variant alternative
+    #     to apply to the button. Can be `:danger`, `:info`, `:link`,
+    #     `:primary`, `:success` or `:warning`.
+    #   @option options [#to_s] :size the size of the button.
+    #     Can be `:extra_small` (alias `:xs`), `:large` (alias `:lg`) or
+    #     `:small` (alias `:sm`).
+    #   @option options [#to_s] :layout if set to `:block`, span the button
+    #     for the full width of the parent.
+    #   @example Display a small button to submit to '/create_user'.
+    #       button_to 'Create', '/create_user', size: :small
+    # @overload button_to(url, options = {}, &block)
+    #   @param [#to_s] url the URL to submit to (see above).
+    #   @param [Hash] options the options for the button (see above).
+    #   @yieldreturn [#to_s] the caption to display in the button.
+    #   @example Display a danger button with HTML content to delete a user.
+    #       button_to '/user_destroy', variant: :danger do
+    #         content_tag :strong, "Delete user"
+    #       end
+    def button_to(*args, &block)
+      button_to = Railsstrap::ButtonTo.new self, *args, &block
+
+      if button_to.extract! :variant, :size, :layout
+        button_to.append_button_class! :btn
+        button_to.append_button_class! button_to.variant_class
+        button_to.append_button_class! button_to.size_class
+        button_to.append_button_class! button_to.layout_class
+        button_to.append_form_class! 'navbar-form' if Railsstrap::Stack.find(Railsstrap::Navbar)
+      end
+
+      html = if block_given? && button_to.accepts_block?
+        super button_to.url, button_to.attributes, &-> { button_to.content }
+      else
+        super button_to.content, button_to.url, button_to.attributes, &nil
+      end
+
+      if Railsstrap::Stack.find(Railsstrap::Nav)
+        container = Railsstrap::Base.new(self) { html }
+        container.render_tag :li
+      else
+        html
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/card_group_helper.rb

@@ -0,0 +1,28 @@
+require 'railsstrap/classes/card_group'
+
+module Railsstrap
+  module Helpers
+    # Wraps a set of Bootstrap-styled cards in a row.
+    # @see http://getbootstrap.com/components/docs/4.0/cards
+    # @see http://getbootstrap.com/css/#grid
+    # @return [String] the HTML to display a row of Bootstrap-styled cards.
+    # @param [Hash] options the options for the row. Any option not
+    #   listed below is passed as an HTML attribute to the row’s `<div>`.
+    # @option options [#to_s] :layout the class to wrap each card with.
+    #   Useful to specify a grid size for the column such as 'col-sm-4' to
+    #   indicate how many columns of the row each card should occupy.
+    # @yieldreturn [#to_s] the cards to display in a row.
+    # @example Display a row of two cards with the same width.
+    #   card_group layout: 'col-sm-6' do
+    #     card 'Panel #1', context: :success
+    #     card 'Panel #2', context: :info
+    #   end
+    def card_group(options = {}, &block)
+      card_group = Railsstrap::CardGroup.new self, options, &block
+      card_group.extract! :layout
+
+      card_group.append_class! card_group.layout
+      card_group.render_tag :div
+    end
+  end
+end