railsstrap 3.3.4 → 4.0.0.beta2

data/lib/railsstrap/helpers/link_to_helper.rb

@@ -0,0 +1,61 @@
+require 'railsstrap/classes/link_to'
+require 'railsstrap/classes/alert_box'
+require 'railsstrap/classes/dropdown'
+require 'railsstrap/classes/nav'
+require 'railsstrap/classes/stack'
+require 'railsstrap/classes/vertical'
+
+module Railsstrap
+  module Helpers
+    # Overrides `link_to` to display a Bootstrap-styled link.
+    # Can only be used in Ruby frameworks that provide the `link_to` method.
+    # @see http://getbootstrap.com/components/docs/4.0/dropdowns
+    # @see http://getbootstrap.com/components/docs/4.0/nav
+    # @see http://getbootstrap.com/components/docs/4.0/navbar-brand-image
+    # @see http://getbootstrap.com/components/docs/4.0/navbar-links
+    # @see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-link_to
+    # @see http://www.rubydoc.info/github/padrino/padrino-framework/Padrino/Helpers/AssetTagHelpers#link_to-instance_method
+    # @return [String] the HTML to display a Bootstrap-styled link.
+    # @overload link_to(caption, url, options = {})
+    #   @param [#to_s] caption the caption to display in the link.
+    #   @param [#to_s] url the URL to link to.
+    #   @param [Hash] options the options for the original `link_to` method.
+    #   @example Display a plain-text link inside an alert-box.
+    #       alert_box do
+    #         link_to 'Check the terms and conditions', '/#terms'
+    #       end
+    # @overload button_to(url, options = {}, &block)
+    #   @param [#to_s] url the URL to link to (see above).
+    #   @param [Hash] options the options for the original `link_to` method.
+    #   @yieldreturn [#to_s] the caption to display in the link.
+    #   @example Display a link with HTML inside a dropdown.
+    #       dropdown 'Menu' do
+    #         link_to '/#terms' do
+    #           content_tag :strong, 'Check the terms and conditions'
+    #         end
+    #       end
+    def link_to(*args, &block)
+      link_to = Railsstrap::LinkTo.new self, *args, &block
+
+      link_to.append_class! :'alert-link' if Railsstrap::Stack.find(Railsstrap::AlertBox)
+      link_to.append_class! :'navbar-brand' if Railsstrap::Stack.find(Railsstrap::Vertical)
+      link_to.append_class! :'nav-link' if Railsstrap::Stack.find(Railsstrap::Nav)
+      link_to.merge! role: :menuitem if Railsstrap::Stack.find(Railsstrap::Dropdown)
+      link_to.merge! tabindex: -1 if Railsstrap::Stack.find(Railsstrap::Dropdown)
+      html = super link_to.content, link_to.url, link_to.attributes, &nil
+
+      if Railsstrap::Stack.find(Railsstrap::Dropdown)
+        container = Railsstrap::Base.new(self) {html}
+        container.merge! role: :presentation
+        container.render_tag :li
+      elsif Railsstrap::Stack.find(Railsstrap::Nav)
+        container = Railsstrap::Base.new(self) {html}
+        container.append_class! :active if link_to.current_page?
+        container.append_class! 'nav-item'
+        container.render_tag :li
+      else
+        html
+      end
+    end
+  end
+end

data/lib/railsstrap/helpers/modal_helper.rb

@@ -0,0 +1,55 @@
+require 'railsstrap/classes/modal'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled modal.
+    # @see http://getbootstrap.com/javascript/#modals
+    # @return [String] the HTML to display a Bootstrap-styled modal.
+    # @overload modal(body, options = {})
+    #   @param [#to_s] body the content to display as the modal body.
+    #   @param [Hash] options the options for the modal. Any option not listed
+    #     below is ignored, except for `:id` which is passed as an HTML
+    #     attribute to the modal’s `<div>`.
+    #   @option options [#to_s] :title ('Modal') the title of the modal.
+    #   @option options [#to_s] :body the content to display as the modal body.
+    #     Using this option is equivalent to passing the body as an argument.
+    #   @option options [#to_s] :size the size of the modal. Can be `:large`
+    #     (alias `:lg`) or `:small` (alias `:sm`).
+    #   @option options [Hash] :button the options for the toggle button.
+    #     * :caption (#to_s) ('Modal') the caption of the toggle button.
+    #     * :context (#to_s) (:default) the contextual 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 modal toggled by a blue button.
+    #       modal 'You clicked me!', title: 'Click me', button: {context: :info}
+    # @overload modal(options = {}, &block)
+    #   @param [Hash] options the options for the modal (see above).
+    #   @yieldreturn [#to_s] the content to display in the modal.
+    #   @example Display a modal with HTML content.
+    #       modal title: 'Click me' do
+    #         content_tag :div, class: 'modal-body' do
+    #           content_tag :em, 'You clicked me!'
+    #         end
+    #       end
+    def modal(*args, &block)
+      modal = Railsstrap::Modal.new self, *args, &block
+      modal.extract! :button, :size, :body, :title, :id, :dismissable, :dismiss
+
+      modal.extract_from :button, [:variant, :size, :layout, :caption]
+      modal.append_class_to! :button, :btn
+      modal.append_class_to! :button, modal.button_variant_class
+      modal.append_class_to! :button, modal.button_size_class
+      modal.merge! button: {caption: modal.caption}
+
+      modal.append_class_to! :div, :'modal-dialog'
+      modal.append_class_to! :div, modal.dialog_size_class
+      modal.merge! div: {title: modal.title, id: modal.id}
+
+      modal.render_partial 'modal'
+    end
+  end
+end

data/lib/railsstrap/helpers/nav_helper.rb

@@ -0,0 +1,34 @@
+require 'railsstrap/classes/nav'
+require 'railsstrap/classes/navbar'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled nav.
+    # @see http://getbootstrap.com/components/docs/4.0/nav
+    # @return [String] the HTML to display a Bootstrap-styled nav.
+    # @param [Hash] options the options for the nav. Any option not listed below
+    #   is passed as an HTML attribute to the alert’s `<ul>`.
+    # @option options [#to_s] the style of the nav. Can be `:tabs`
+    #   or `:pills`.
+    # @option options [#to_s] :layout the layout of the nav. Can be
+    #   `:justified`, `:center`, `:right`, `:fill`, or `:stacked`.
+    # @yieldreturn [#to_s] the content to display in the nav.
+    # @example Display a pills-styled nav with a link.
+    #   nav as: :pills do
+    #     link_to 'Home', '/'
+    #   end
+    def nav(options = {}, &block)
+      nav = Railsstrap::Nav.new(self, options, &block)
+      nav.extract! :as, :layout
+
+      nav.append_class! :nav
+      nav.append_class! nav.style_class
+      nav.append_class! nav.layout_class
+      nav.merge! role: :navigation
+
+
+
+      nav.render_tag :nav
+    end
+  end
+end

data/lib/railsstrap/helpers/navbar_helper.rb

@@ -0,0 +1,46 @@
+require 'railsstrap/helpers/horizontal_helper'
+require 'railsstrap/helpers/vertical_helper'
+
+module Railsstrap
+  module Helpers
+    # Displays a Bootstrap-styled navbar.
+    # @see http://getbootstrap.com/components/docs/4.0/navbar
+    # @return [String] the HTML to display a Bootstrap-styled navbar.
+    # @param [Hash] options the options for the navbar. Any option not listed
+    #   below is ignored, except for `:id` which is passed as an HTML
+    #   attribute to the navbar’s collapsable `<div>`.
+    # @option options [Boolean] :fluid (false) whether to use a fluid container
+    #   to surround the navbar content.
+    # @option options [Boolean] :inverted (false) whether to use an inverted
+    #   palette of colors.
+    # @option options [#to_s] :position the position of the navbar. Can be
+    #   `:top` (alias `:fixed_top`), `:bottom` (alias `:fixed_bottom`) or
+    #   `:static` (alias `:static_top`).
+    # @yieldreturn [#to_s] the content to display in the navbar.
+    # @example Display an inverted navbar with three links.
+    #   navbar inverted: true do
+    #     vertical do
+    #       image_tag('logo')
+    #     end
+    #     horizontal do
+    #       nav do
+    #         link_to 'Home', '/'
+    #         link_to 'Profile', '/profile'
+    #       end
+    #     end
+    #   end
+    def navbar(options = {}, &block)
+      navbar = Railsstrap::Navbar.new(self, options, &block)
+      navbar.extract! :variant, :text_variant, :position, :fluid, :id
+
+      navbar.append_class_to! :navigation, :navbar
+      navbar.append_class_to! :navigation, navbar.variant_class
+      navbar.append_class_to! :navigation, 'navbar-expand-lg'
+      navbar.append_class_to! :navigation, navbar.text_variant_class
+      navbar.append_class_to! :navigation, navbar.position_class
+      navbar.append_class_to! :div, navbar.layout_class
+
+      navbar.render_partial 'navbar'
+    end
+  end
+end

data/lib/railsstrap/helpers/progress_bar_helper.rb

@@ -0,0 +1,55 @@
+require 'railsstrap/classes/progress_bar'
+
+module Railsstrap
+  module Helpers
+    # Displays one or more Bootstrap-styled progress bars.
+    # @see http://getbootstrap.com/components/docs/4.0/progress
+    # @return [String] the HTML to display Bootstrap-styled progress bars.
+    # @overload progress_bar(bar_options = {}, container_options = {})
+    #   @param [Hash] bar_options the options to display a single progress bar.
+    #     Any option not listed below is passed as an HTML attribute to the
+    #     bar’s `<div>`.
+    #   @option bar_options [Boolean, #to_s] :label (false) the label to display
+    #     on top of the progress bar. If set to false, the label is hidden. If
+    #     set to true, the label is generated from the percentage value. Any
+    #     other provided value is used directly as the label.
+    #   @option bar_options [Boolean] :striped (false) whether to display a
+    #     striped version of the progress bar (rather than solid color).
+    #   @option bar_options [Boolean] :animated (false) whether to display an
+    #     animated version of the progress bar (rather than solid color).
+    #   @option bar_options [#to_s] :context (:default) the contextual
+    #     alternative to apply to the progress bar. Can be `:success`, `:info`,
+    #     `:warning` or `:danger`.
+    #   @param [Hash] container_options the options to pass as HTML attributes
+    #     to the container’s `<div>`.
+    #   @example Display a 30% warning progress bar.
+    #       progress_bar percentage: 30, context: :warning
+    # @overload progress_bar(stacked_bars_options = [], container_options = {})
+    #   @param [Hash] stacked_bars_options an array of bar_options (see above).
+    #     When an array is provided, a group of stacked progress bars is 
+    #     displayed, each one matching the corresponding bar options.
+    #   @param [Hash] container_options the options to pass as HTML attributes
+    #     to the container’s `<div>`.
+    #   @example Display two stacked progress bars.
+    #       progress_bar [{percentage: 30, context: :warning}, {percentage: 20}]
+    def progress_bar(args = nil, container_options = {})
+      progress_bars = Array.wrap(args).map do |options|
+        progress_bar = Railsstrap::ProgressBar.new self, nil, options
+        progress_bar.extract! :percentage, :context, :striped, :animated, :label
+
+        progress_bar.merge! progress_bar.aria_values
+        progress_bar.append_class! :'progress-bar'
+        progress_bar.append_class! progress_bar.context_class
+        progress_bar.append_class! progress_bar.striped_class
+        progress_bar.append_class! progress_bar.animated_class
+        progress_bar.merge! progress_bar.values
+        progress_bar.prepend_html! progress_bar.label
+        progress_bar
+      end
+
+      container = Railsstrap::Base.new self, progress_bars, container_options
+      container.append_class! :progress
+      container.render_tag :div
+    end
+  end
+end

data/lib/railsstrap/helpers/vertical_helper.rb

@@ -0,0 +1,34 @@
+require 'railsstrap/classes/navbar'
+require 'railsstrap/classes/vertical'
+
+module Railsstrap
+  module Helpers
+    # Displays the non-collapsable portion of a Bootstrap-styled navbar.
+    # @see http://getbootstrap.com/components/docs/4.0/navbar
+    # @return [String] the HTML to display the non-collapsable portion of a
+    #   Bootstrap-styled navbar.
+    # @overload vertical(content, options = {})
+    #   @param [#to_s] content the non-collapsable content to display in the
+    #     navbar.
+    #   @param [Hash] options the options to pass to the wrapping `<div>`.
+    # @overload vertical(options = {}, &block)
+    #   @param [Hash] options the options to pass to the wrapping `<div>`.
+    #   @yieldreturn [#to_s] the non-collapsable content to display in the
+    #     navbar.
+    # @example Display a navbar a non-collapsable links.
+    #   navbar do
+    #     vertical do
+    #       link_to 'Home', '/'
+    #     end
+    #   end
+    def vertical(*args, &block)
+      navbar = Railsstrap::Stack.find(Railsstrap::Navbar)
+      if navbar
+        vertical = Railsstrap::Vertical.new self, *args, &block
+        vertical.append_class! :'navbar-header'
+        vertical.prepend_html! vertical.toggle_button(navbar.id)
+        vertical.render_tag :div
+      end
+    end
+  end
+end

data/lib/railsstrap/version.rb

@@ -0,0 +1,3 @@
+module Railsstrap
+  VERSION = '4.0.0.beta2'
+end

data/lib/railsstrap/views/railsstrap/_aside.html.erb

@@ -0,0 +1,14 @@
+<button class="<%= button[:class] %>" data-toggle="modal" data-target="#<%= div[:id] %>"><%= button[:caption] %></button>
+<aside class="aside fade" id="<%= div[:id] %>" tabindex="-1" role="dialog" aria-labelledby="label-<%= div[:id] %>" aria-hidden="true">
+  <div class="<%= div[:class] %>">
+    <div class="aside-content">
+      <div class="aside-header">
+        <button type="button" class="close" data-dismiss="modal">
+          <span aria-hidden="true">&times;</span><span class="sr-only">Close</span>
+        </button>
+        <h4 class="aside-title" id="label-<%= div[:id] %>"><%= div[:title] %></h4>
+      </div>
+      <%= content %>
+    </div>
+  </div>
+</aside>

data/lib/railsstrap/views/railsstrap/_dismiss_button.html.erb

@@ -0,0 +1,4 @@
+<button type="button" class="close" data-dismiss="<%= dismiss ||= 'alert' %>">
+  <span aria-hidden="true">&times;</span>
+  <span class="sr-only">Close</span>
+</button>

data/lib/railsstrap/views/railsstrap/_dropdown.html.erb

@@ -0,0 +1,9 @@
+<div class="<%= div[:class] %>">
+  <button class="dropdown-toggle <%= button[:class] %>" type="button" id="<%= button[:id] %>" data-toggle="dropdown">
+    <%= button[:caption] %>
+    <span class="caret"></span>
+  </button>
+  <ul class="<%= ul[:class] %>" role="menu" aria-labelledby="<%= button[:id] %>">
+    <%= content %>
+  </ul>
+</div>

data/lib/railsstrap/views/railsstrap/_dropdown_split.html.erb

@@ -0,0 +1,10 @@
+<div class="<%= div[:class] %>">
+  <button type="button" class="<%= button[:class] %>"><%= button[:caption] %></button>
+  <button class="dropdown-toggle <%= button[:class] %>" type="button" id="<%= button[:id] %>" data-toggle="dropdown">
+    <span class="caret"></span>
+    <span class="sr-only">Toggle Dropdown</span>
+  </button>
+  <ul class="<%= ul[:class] %>" role="menu" aria-labelledby="<%= button[:id] %>">
+    <%= content %>
+  </ul>
+</div>

data/lib/railsstrap/views/railsstrap/_modal.html.erb

@@ -0,0 +1,14 @@
+<button class="<%= button[:class] %>" data-toggle="modal" data-target="#<%= div[:id] %>"><%= button[:caption] %></button>
+<div class="modal fade" id="<%= div[:id] %>" tabindex="-1" role="dialog" aria-labelledby="label-<%= div[:id] %>" aria-hidden="true">
+  <div class="<%= div[:class] %>">
+    <div class="modal-content">
+      <div class="modal-header">
+        <% if dismissible %>
+          <%= render 'dismiss_button', dismiss: 'modal' %>
+        <% end %>
+        <h4 class="modal-title" id="label-<%= div[:id] %>"><%= div[:title] %></h4>
+      </div>
+      <%= content %>
+    </div>
+  </div>
+</div>

data/lib/railsstrap/views/railsstrap/_navbar.html.erb

@@ -0,0 +1,5 @@
+<nav class="<%= navigation[:class] %>" role="navigation">
+  <div class="<%= div[:class] %>">
+    <%= content %>
+  </div>
+</nav>

data/spec/padrino/button_to_helper.rb

@@ -0,0 +1,35 @@
+shared_examples_for 'the button_to helper (Padrino)' do
+  all_tests_pass_with 'no button_to options (Padrino)'
+  all_tests_pass_with 'only extra button_to options (Padrino)'
+  all_tests_pass_with 'extra button_to options (Padrino)'
+  all_tests_pass_for 'the button_to helper'
+end
+
+#--
+
+shared_examples_for 'no button_to options (Padrino)' do
+  specify 'uses the original button_to helper' do
+    html = '<form action="/" accept-charset="UTF-8" method="post"><input type="hidden" name="authenticity_token" /><input type="submit" value="content" /></form>'
+    expect(:button_to).to generate html
+
+    # @note: Only Padrino >= 0.13.0 renders the content of the block as a
+    #        <button> so the exact content is only partially tested here.
+    expect(railsstrap.button_to('/'){ 'content' }).to include 'content'
+  end
+end
+
+shared_examples_for 'only extra button_to options (Padrino)' do
+  specify 'uses the original button_to helper' do
+    options = {class: 'big', id: 'my-form', submit_options: {class: 'important', data: {value: 1}, id: 'my-button_to'}}
+    html = '<form action="/" accept-charset="UTF-8" class="big" id="my-form" method="post"><input type="hidden" name="authenticity_token" /><input type="submit" value="content" class="important" data-value="1" id="my-button_to" /></form>'
+    expect(button_to: options).to generate html
+  end
+end
+
+shared_examples_for 'extra button_to options (Padrino)' do
+  specify 'passes the options to the form and the submit_options to the button' do
+    options = {variant: :info, class: 'big', id: 'my-form', submit_options: {class: 'important', data: {value: 1}, id: 'my-button_to'}}
+    html = '<form action="/" accept-charset="UTF-8" class="big" id="my-form" method="post"><input type="hidden" name="authenticity_token" /><input type="submit" value="content" class="important btn btn-info" data-value="1" id="my-button_to" /></form>'
+    expect(button_to: options).to generate html
+  end
+end

data/spec/padrino/link_to_helper.rb

@@ -0,0 +1,12 @@
+shared_examples_for 'the link_to helper (Padrino)' do
+  all_tests_pass_with 'no link_to caption (Padrino)'
+end
+
+#--
+
+shared_examples_for 'no link_to caption (Padrino)' do
+  specify 'uses the original link_to helper which sets an empty link text' do
+    html = '<a href="/"></a>'
+    expect(link_to: :nil_name).to generate html
+  end
+end

data/spec/padrino_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+Dir['./spec/padrino/*_helper.rb'].each {|f| require f}
+
+describe 'When used in Padrino or Middleman' do
+  let(:railsstrap) { PadrinoView.new }
+  before { Railsstrap.framework = :padrino }
+
+  all_tests_pass_for 'the alert_box helper'
+  all_tests_pass_for 'the bootstrap_css helper'
+  all_tests_pass_for 'the bootstrap_js helper'
+  all_tests_pass_for 'the bootstrap_theme_css helper'
+  all_tests_pass_for 'the button helper'
+  all_tests_pass_for 'the dropdown helper'
+  all_tests_pass_for 'the font_awesome_css helper'
+  all_tests_pass_for 'the glyphicon helper'
+  all_tests_pass_for 'the horizontal helper'
+  all_tests_pass_for 'the icon helper'
+  all_tests_pass_for 'the modal helper'
+  all_tests_pass_for 'the nav helper'
+  all_tests_pass_for 'the navbar helper'
+  all_tests_pass_for 'the card helper'
+  all_tests_pass_for 'the card_group helper'
+  all_tests_pass_for 'the progress_bar helper'
+  all_tests_pass_for 'the vertical helper'
+
+  all_tests_pass_for 'the button_to helper (Padrino)'
+  all_tests_pass_for 'the link_to helper (Padrino)'
+  all_tests_pass_for 'the link_to helper'
+end unless ENV['ONLY_RAILS']

data/spec/rails/button_to_helper.rb

@@ -0,0 +1,31 @@
+shared_examples_for 'the button_to helper (Rails)' do
+  all_tests_pass_with 'no button_to options (Rails)'
+  all_tests_pass_with 'only extra button_to options (Rails)'
+  all_tests_pass_with 'extra button_to options (Rails)'
+  all_tests_pass_for 'the button_to helper'
+end
+
+#--
+
+shared_examples_for 'no button_to options (Rails)' do
+  specify 'uses the original button_to helper' do
+    html = %r{^<form(?:| action="/") class="button_to" method="post"(?:| action="/")>(?:|<div>)<(input|button) type="submit"(>| value=")content(" />|</button>)(?:|</div>)</form>$}
+    expect(:button_to).to generate html
+  end
+end
+
+shared_examples_for 'only extra button_to options (Rails)' do
+  specify 'uses the original button_to helper' do
+    options = {class: 'important', data: {value: 1}, id: 'my-button_to'}
+    html = %r{<(input|button) class="important" data-value="1" id="my-button_to" type="submit"}
+    expect(button_to: options).to generate html
+  end
+end
+
+shared_examples_for 'extra button_to options (Rails)' do
+  specify 'passes the options to the button' do
+    options = {variant: :default, class: 'important', data: {value: 1}, id: 'my-button_to'}
+    html = %r{<(input|button) class="important btn btn-primary" data-value="1" id="my-button_to" type="submit"}
+    expect(button_to: options).to generate html
+  end
+end