railsstrap 3.3.4 → 4.0.0.beta2

data/lib/railsstrap/helpers/card_helper.rb

@@ -0,0 +1,56 @@
+require 'railsstrap/classes/card'
+require 'railsstrap/classes/card_group'
+require 'railsstrap/classes/stack'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled card.
+    # @see http://getbootstrap.com/components/docs/4.0/cards
+    # @return [String] the HTML to display a Bootstrap-styled card.
+    # @overload card(body, options = {})
+    #   @param [#to_s] body the content to display as the card body.
+    #   @param [Hash] options the options for the card. Any option not
+    #     listed below is passed as an HTML attribute to the card’s `<div>`.
+    #   @option options [#to_s] :title the text to display as the card title.
+    #   @option options [#to_s] :header the text to display as the card
+    #     header.
+    #   @option options :img the image used in the top of the card.
+    #   @option options [#to_s] :body the text to display as the card body.
+    #     Using this option is equivalent to passing the body as an argument.
+    #   @option options [#to_s] :variant (#to_s) (:default) the variant
+    #     alternative to apply to the card header and border. Can be
+    #     `:danger`, `:info`, `:primary`, `:success` or `:warning`.
+    #   @option options [#to_s] :tag (#to_s) (:div) the HTML tag to wrap the
+    #     card into.
+    #   @example Display an informative card with plain-text content.
+    #       card 'You accepted the Terms of service.', variant: :success
+    # @overload card(options = {}, &block)
+    #   @param [Hash] options the options for the card (see above).
+    #   @yieldreturn [#to_s] the content to display in the card.
+    #   @example Display a card with HTML content.
+    #       card title: 'Thanks' do
+    #         content_tag :div, class: 'card-body' do
+    #           content_tag :em, 'ou accepted the Terms of service.'
+    #         end
+    #       end
+    def card(*args, &block)
+      card = Railsstrap::Card.new self, *args, &block
+      card.extract! :body, :variant, :title, :header, :tag, :img
+
+      card.append_class! :card
+      card.append_class! card.variant_class
+      card.append_class! card.text_variant_class
+      card.prepend_html! card.image_cap
+      card.merge_html! card.body
+      card.prepend_html! card.header
+
+      if card_row = Railsstrap::Stack.find(Railsstrap::CardGroup)
+        container = Railsstrap::Base.new(self) { card.content_tag card.tag }
+        container.append_class! card_row.layout
+        container.render_tag :div
+      else
+        card.render_tag card.tag
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/cdn_helper.rb

@@ -0,0 +1,93 @@
+require 'railsstrap/classes/cdn'
+
+module Railsstrap
+  module Helpers
+    # @see https://cdnjs.com/libraries/jquery/
+    # @return [String] the URL of the jQuery JS file
+    # @param [Hash] options the options for which JS file to retrieve.
+    # @option options [String] :version the version of jQuery.
+    # @option options [String] :scheme the URI scheme to use.
+    # @option options [Boolean] :minified whether to use the minified version.
+    def jquery_js(options = {})
+      Railsstrap::Cdn.jquery_js options.merge(name: 'jquery', extension: 'js')
+    end
+
+    # @see https://cdnjs.com/libraries/popper.js
+    # @return [String] the URL of the Popper JS file
+    # @param [Hash] options the options for which JS file to retrieve.
+    # @option options [String] :version the version of Popper.
+    # @option options [String] :scheme the URI scheme to use.
+    # @option options [Boolean] :minified whether to use the minified version.
+    def popper_js(options = {})
+      Railsstrap::Cdn.popper_js options.merge(name: 'popper', extension: 'js')
+    end
+
+    # @see http://www.bootstrapcdn.com
+    # @return [String] the URL of the Bootstrap CSS file
+    # @param [Hash] options the options for which CSS file to retrieve.
+    # @option options [String] :version the version of Bootstrap.
+    # @option options [String] :scheme the URI scheme to use.
+    # @option options [Boolean] :minified whether to use the minified version.
+    def bootstrap_css(options = {version: '4.0.0'})
+      Railsstrap::Cdn.bootstrap_css options
+    end
+
+    # @see http://www.bootstrapcdn.com
+    # @return [String] the URL of the Bootstrap Theme CSS file
+    # @param [Hash] options the options for which CSS file to retrieve.
+    # @option options [String] :version the version of Bootstrap.
+    # @option options [String] :scheme the URI scheme to use.
+    # @option options [Boolean] :minified whether to use the minified version.
+    def bootstrap_theme_css(options = {})
+      Railsstrap::Cdn.bootstrap_theme options
+    end
+
+    # @see http://www.cdnjs.com
+    # @return [String] the URL of the Font Awesome CSS file
+    # @param [Hash] options the options for which CSS file to retrieve.
+    # @option options [String] :version the version of Font Awesome.
+    # @option options [String] :scheme the URI scheme to use.
+    # @option options [Boolean] :minified whether to use the minified version.
+    # @see http://fontawesome.io/get-started/
+    def font_awesome_css(options = {})
+      Railsstrap::Cdn.font_awesome options
+    end
+
+    # @see http://www.bootstrapcdn.com
+    # @return [String] the URL of the Font Awesome CSS file
+    # @param [Hash] options the options for which CSS file to retrieve.
+    # @option options [String] :version the version of Font Awesome. 5.0+ is required.
+    # @option options [String] :scheme the URI scheme to use.
+    # @see http://fontawesome.io/get-started/
+    def font_awesome_js(options = {})
+      options[:version] = options[:version].nil? ? '5.0.6' : options[:version]
+      options[:scheme] = options[:scheme].nil? ? 'https' : options[:version].to_s
+      "#{options[:scheme]}://use.fontawesome.com/releases/v#{options[:version]}/js/all.js"
+    end
+
+    # @see http://www.bootstrapcdn.com
+    # @return [String] the URL of the Bootstrap JS file
+    # @param [Hash] options the options for which JS file to retrieve.
+    # @option options [String] :version the version of Bootstrap.
+    # @option options [String] :scheme the URI scheme to use.
+    # @option options [Boolean] :minified whether to use the minified version.
+    def bootstrap_js(options = {})
+      Railsstrap::Cdn.bootstrap_js(options)
+    end
+
+    # @see https://cdnjs.com/
+    # @return [String] The URL of the library from cdnjs.com
+    # @param [Hash] options the options for which JS file to retrieve.
+    # @option options [String] :version the semver of the file
+    # @option options [String] :extension .js or .css
+    # @option options [Boolean] :minified whether to use the minified version.
+    # @option options [String] :library the name of the library to retrieve
+    # @option options [String] :scheme http/https (no colon)
+    # @option options [String] :path @default 'ajax/libs' (no trailing slashes)
+    # @option options [String] :host 'cdnjs.cloudflare.com'
+    def cdn(options = {})
+      content_tag :script, nil, src: Railsstrap::Cdn.cdn_asset(options)
+    end
+
+  end
+end

data/lib/railsstrap/helpers/date_picker_helper.rb

@@ -0,0 +1,78 @@
+# Railsstrap Datepicker Helper
+# Based on https://tempusdominus.github.io/bootstrap-4
+
+# Setup instructions:
+# open your application.js & application.css asset manifest file and uncomment the block to include the UI libraries
+# use the date_picker helper for the html and the date_picker_javascript helper in your templates
+#
+# If passing data attributes as symbols, please use underscore to separate words; otherwise pass strings.
+# The full JS API is supported as data attributes or javascript.
+#
+# You can use the HTML helper which will handle the javascript configuration for you, or use the JS helper
+# and create your own standard bootstrap form input group.
+#
+# <div class="form-group">
+#   <div class="input-group date" id="datetimepicker1" data-target-input="nearest">
+#     <input type="text" class="form-control datetimepicker-input" data-target="#datetimepicker1"/>
+#     <div class="input-group-append" data-target="#datetimepicker1" data-toggle="datetimepicker">
+#     <div class="input-group-text"><i class="fa fa-calendar"></i></div>
+#   </div>
+# </div>
+
+module Railsstrap
+  module Helpers
+    module DatePicker
+      def date_picker(options = {})
+        opts = default_dp_options.deep_merge(options)
+        content_tag(:div, class: "input-group date #{opts[:class]}", id: opts[:id], data: opts[:data]) {
+          opts[:show_input] ? date_picker_input(opts) + date_picker_icon(opts) : date_picker_icon(opts)
+        }
+      end
+
+      def date_picker_icon(options = {})
+        opts = default_dp_options.deep_merge(options)
+        content_tag opts[:icon_wrapper_tag], icon(opts[:icon]), class: opts[:icon_wrapper_class]
+      end
+
+      def date_picker_input(options = {})
+        opts = default_dp_options.deep_merge(options)
+        text_field_tag opts[:input_name], '', class: opts[:input_class]
+      end
+
+      def date_picker_javascript(options = {})
+        opts = default_js_options.deep_merge(options)
+        javascript_tag "(function ($) { $('#{opts[:selector]}').datetimepicker(#{opts.to_json});})(jQuery);"
+      end
+
+      protected
+      def default_dp_options
+        {
+          id: 'date_picker',
+          wrapper_tag: :div,
+          show_input: true,
+          input_name: 'date_picker',
+          input_class: 'form-control datetimepicker-input',
+          input_type: 'text',
+          wrapper_class: 'input-group date',
+          icon_wrapper_tag: :span,
+          icon_wrapper_class: 'input-group-append',
+          icon: 'calendar',
+          data: {datepicker: true, locale: 'en', target_input: 'nearest'}
+        }
+      end
+
+      def default_js_options
+        {
+          selector: '[data-datepicker="true"]',
+          locale: 'en',
+          icons: {
+            time: 'far fa-clock-o',
+            date: 'far fa-calendar',
+            up: 'far fa-chevron-up',
+            down: 'far fa-chevron-down'
+          }
+        }
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/dropdown_helper.rb

@@ -0,0 +1,49 @@
+require 'railsstrap/classes/dropdown'
+
+module Railsstrap
+  module Helpers
+    # @see http://getbootstrap.com/components/docs/4.0/dropdowns
+    # @see http://getbootstrap.com/components/docs/4.0/btn-dropdowns
+    # @return [String] an HTML block to display a dropdown.
+    # @example A right-aligned dropdown with a links.
+    #   dropdown 'Menu', align: :right do
+    #     content_tag :li, link_to('Home', '/')
+    #   end
+    # @param [#to_s] caption the caption for the dropdown button.
+    # @param [Hash] options the display options for the dropdown.
+    # @option options [Boolean] :groupable (true) if true, uses the "btn-group"
+    #   class rather than then "dropdown" class, so that multiple dropdown
+    #   buttons can be aligned in the same row (as a group of buttons).
+    # @option options [Boolean] :split (false) if true, creates a split button
+    #   that only toggles the dropdown when clicked on the rightmost part.
+    # @option options [#to_s] :direction if set to :up, the dropdown appears
+    #   above the button, rather than below.
+    # @option options [#to_s] :layout if set to `:block`, span the dropdown
+    #   button for the full width of the parent. Note that :groupable takes
+    #   precedence, so it must be set to `false` to display a full-width button.
+    # @option options [#to_s] :align if set to :right, the dropdown is aligned
+    #   to the right-end of the button, rather than to the left-end.
+    # @option options [#to_s] :variant (:default) the variant for the button,
+    #   which determines its color.
+    # @option options [#to_s] :size the size of the button.
+    # @yieldreturn [#to_s] the content of the dropdown.
+    def dropdown(caption, options = {}, &block)
+      dropdown = Railsstrap::Dropdown.new self, nil, options, &block
+      dropdown.extract! :id, :groupable, :direction, :align, :split, :variant,
+                        :size, :layout, :button
+
+      dropdown.extract_from :button, [:variant, :size, :layout]
+      dropdown.merge! button: {caption: caption, id: dropdown.id}
+      dropdown.append_class_to! :button, :btn
+      dropdown.append_class_to! :button, dropdown.variant_class
+      dropdown.append_class_to! :button, dropdown.size_class
+      dropdown.append_class_to! :button, dropdown.layout_class
+      dropdown.append_class_to! :div, dropdown.groupable_class
+      dropdown.append_class_to! :div, dropdown.direction_class
+      dropdown.append_class_to! :ul, :'dropdown-menu'
+      dropdown.append_class_to! :ul, dropdown.align_class
+
+      dropdown.render_partial dropdown.partial
+    end
+  end
+end

data/{app/helpers/railsstrap/bootstrap_flash_helper.rb → lib/railsstrap/helpers/flash_helper.rb}

@@ -1,7 +1,7 @@
-module Railsstrap
-  module BootstrapFlashHelper
-    ALERT_TYPES = [:success, :info, :warning, :danger] unless const_defined?(:ALERT_TYPES)
+require 'railsstrap/classes/base'
 
+module Railsstrap
+  module Helpers
     def bootstrap_flash(options = {})
 
       flash_messages = []
@@ -9,10 +9,10 @@ module Railsstrap
 
       flash.each do |type, message|
         default_opts = {
-            show_close: true,
-            type: :info,
-            container_tag: :div,
-            animation: 'fade in'
+          show_close: true,
+          type: :info,
+          container_tag: :div,
+          animation: 'animate fade show'
         }
         opts = default_opts.merge(options)
 
@@ -20,16 +20,16 @@ module Railsstrap
         next if message.blank?
 
         type = type.to_sym
-        type = :success if type == :notice
-        type = :danger  if type == :alert
-        type = :danger  if type == :error
-        next unless ALERT_TYPES.include?(type)
+        type = :info if type == :notice
+        type = :warning if type == :alert
+        type = :danger if type == :error
+        next unless Railsstrap::Classes::Base.variant_types.include?(type)
 
         Array(message).each do |msg|
 
           text = content_tag(opts[:container_tag],
                              (opts[:show_close] ? close_button : '') +
-                             msg.html_safe, :class => "alert #{opts[:animation]} alert-#{type} #{opts[:class]}")
+                               msg.html_safe, :class => "alert #{opts[:animation]} alert-#{type} #{opts[:class]}")
           flash_messages << text if msg
         end
       end

data/lib/railsstrap/helpers/form_errors.rb

@@ -0,0 +1,36 @@
+module Railsstrap
+  module Helpers
+    # @return [String] an HTML block to display a dropdown.
+    # @example errors_for(@widgets)
+    # @description Displays a Bootstrap card containing form errors.
+    #   If a block is provide, uses the block for handling the error message output.
+    #   Inherits all the same properties as Railsstrap::Classes::Card
+    # @options [param] Change the title text and styling of the errors
+    # @options option [#to_s] :variant
+    def errors_for(object, options = {}, &block)
+      if object.errors.any?
+        opts = {
+          body: content_tag(:ol) {
+            object.errors.full_messages.each do |msg|
+              concat content_tag(:li, msg)
+            end
+          },
+          variant: :danger,
+          text_variant: 'text-white',
+          header: "#{pluralize(object.errors.count, 'error')} prohibited this #{object.class.name.downcase} from being saved:"
+        }.merge options
+        card = Railsstrap::Classes::Card.new(self, opts, &block)
+        card.extract! :body, :variant, :text_variant, :title, :header, :tag, :img
+
+        card.append_class! :card
+        card.append_class! card.variant_class
+        card.append_class! card.text_variant_class
+        card.prepend_html! card.image_cap
+        card.merge_html! card.body
+        card.prepend_html! card.header
+        card.render_tag card.tag
+
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/glyphicon_helper.rb

@@ -0,0 +1,21 @@
+require 'railsstrap/helpers/icon_helper'
+
+module Railsstrap
+  module Helpers
+    # Displays any of the 200 glyphicons available in Bootstrap.
+    # @deprecated Use {#icon} instead.
+    # @see http://glyph.smarticons.co/
+    # @return [String] the HTML to display a glyphicon.
+    # @param [#to_s] name the name of the icon to display, with either dashes
+    #   or underscores to separate multiple words.
+    # @param [Hash] options the options to pass to the icon’s `<span>`.
+    # @example Display the "zoom-in" glyphicon
+    #   glyphicon :zoom_in
+    def glyphicon(name = nil, options)
+      if options.is_a?(Symbol || String)
+        return icon options, library: :glyphicons
+      end
+      icon name, options.merge(library: :glyphicons)
+    end
+  end
+end

data/lib/railsstrap/helpers/horizontal_helper.rb

@@ -0,0 +1,36 @@
+require 'railsstrap/classes/navbar'
+
+module Railsstrap
+  module Helpers
+    # Displays the collapsable portion of a Bootstrap-styled navbar.
+    # @see http://getbootstrap.com/components/docs/4.0/navbar
+    # @return [String] the HTML to display the collapsable portion of a
+    #   Bootstrap-styled navbar.
+    # @overload horizontal(content, options = {})
+    #   @param [#to_s] content the collapsable content to display in the navbar.
+    #   @param [Hash] options the options to pass to the wrapping `<div>`.
+    #     Note that the `:id` option is ignored since the id must generated
+    #     by the navbar in order to match with the target of the toggle button.
+    # @overload horizontal(options = {}, &block)
+    #   @param [Hash] options the options to pass to the wrapping `<div>`.
+    #   @yieldreturn [#to_s] the collapsable content to display in the navbar.
+    # @example Display a navbar with two collapsable links.
+    #   navbar do
+    #     horizontal do
+    #       nav do
+    #         link_to 'Home', '/'
+    #         link_to 'Profile', '/profile'
+    #       end
+    #     end
+    #   end
+    def horizontal(*args, &block)
+      navbar = Railsstrap::Stack.find(Railsstrap::Navbar)
+      if navbar
+        horizontal = Railsstrap::Base.new self, *args, &block
+        horizontal.append_class! :'collapse navbar-collapse'
+        horizontal.merge! id: navbar.id
+        horizontal.render_tag :div
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/icon_helper.rb

@@ -0,0 +1,26 @@
+require 'railsstrap/classes/icon'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled vector icon.
+    # @see https://getbootstrap.com/docs/4.0/extend/icons/
+    # @return [String] the HTML to display a vector (font) icon.
+    # @param [#to_s] name the name of the icon to display, with either dashes
+    #   or underscores to separate multiple words.
+    # @param [Hash] options the options for the icon tag. Any option not
+    #   listed below is passed as an HTML attribute to the icon’s `<span>`.
+    # @option options [#to_s] :library (:glyphicons) the vector icon library
+    #   to use. Valid values are 'glyphicon', 'glyphicons' (for Glyphicons),
+    #   'far', 'fas' and 'fal' (for Font Awesome).
+    # @example Display the "fire" font awesome standard icon with a title
+    #   icon 'fire', library: :font_awesome, title: 'Hot'
+    def icon(name = nil, options = {})
+      icon = Railsstrap::Icon.new self, nil, options.merge(name: name)
+      icon.extract! :library, :name, :tag
+
+      icon.append_class! icon.library_class
+      icon.append_class! icon.name_class
+      icon.render_tag icon.tag
+    end
+  end
+end