railsstrap 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5368848076f90de4d3bb93d722da03a756c8587
-  data.tar.gz: 89ace966b95408b74b85a76027cec3504d264def
+  metadata.gz: f8b40a637cd238fc544f48492e0c13ccfda32a29
+  data.tar.gz: a3afbde82508a3dbd9539ac62b0c210555376d5f
 SHA512:
-  metadata.gz: 84d1f162e59603eba4dd0a94d284c23ce7304a5d2acec3f13d0351f569130505a609813da16aebdf2c37aa2ed3da51bd170f993ff7f27d09c5c89d4a16a13057
-  data.tar.gz: 0b193c4a8a0d599cf33a6b56587dae0ea6b59302d212ea496348b0a6d350290c97bd9b25a67b1f186a9f9ebcd85806fd70c326a1da71bcf37cc6a8140c35eb72
+  metadata.gz: eab6acbafb4c2a3c58fb434436df0f49b5a1268dc4da98426c4be99bcc91b1fcd09b2db0be49f467b75566505dfd5a2c5bc6001281240ebd73604b6934a6dfbf
+  data.tar.gz: de986680ea4fe4d74a7e84da5ba20b9fdaf36468416801f70067a467d2c12af8abaeb37c719cfffdd5b7ccd6311dfe9fa17bf8f65fd18a2b7c3b222817f01a0e

data/README.md

@@ -14,13 +14,13 @@ Railsstrap is more than just another gem providing bootstrap and fontawesome for
 
 ##Bootstrap additions
 
-###Custom Components (in development)
-* Asides - A modal that slides in from the left or right. Used often in mobile apps for off-screen sidebars or overlays.
-* Callouts - Similar to an alert, it is used for drawing attention to content. - New in 3.3.0!
-* Date & Time picker - A styled HTML5 datepicker. - New in 3.3.1!
-* Modal enhancements - animations and real centering placement.
-* Popover enhancements - animations and custom placements for popover arrows and locations.
-* Tooltip - animations and custom placements for tooltip arrows and locations.
+###Custom Components
+* [Asides](https://github.com/toadkicker/railsstrap/wiki/Bootstrap-Additions#aside) - A modal that slides in from the left or right. Used often in mobile apps for off-screen sidebars or overlays. - New in 3.3.2!
+* [Callouts](https://github.com/toadkicker/railsstrap/wiki/Bootstrap-Additions#callout) - Similar to an alert, it is used for drawing attention to content. - New in 3.3.0!
+* [Date & Time picker](https://github.com/toadkicker/railsstrap/wiki/Bootstrap-Additions#datepicker--timepicker) - A styled HTML5 datepicker. - New in 3.3.1!
+* [Modal enhancements](https://github.com/toadkicker/railsstrap/wiki/Bootstrap-Additions#modal) - animations and real centering placement.
+* [Popover enhancements](https://github.com/toadkicker/railsstrap/wiki/Bootstrap-Additions#popover) - animations and custom placements for popover arrows and locations.
+* [Tooltip](https://github.com/toadkicker/railsstrap/wiki/Bootstrap-Additions#tooltip) - animations and custom placements for tooltip arrows and locations.
 
 ###Animations
 
@@ -32,7 +32,10 @@ An example application is available at [toadkicker/teststrap](https://github.com
 ## Quick install
 Open your Gemfile, and add the gem to your list of dependencies.
 
-```gem railsstrap```
+```
+gem less-rails
+gem railsstrap
+```
 
 Then run the installer
 
@@ -41,26 +44,9 @@ bundle install
 bundle exec rails g railsstrap:install
 ```
 
-This will insert the appropriate entries into your application.js and application.css files. It will also provide you with the ability to customize Bootstrap and FontAwesome to your liking.
-
-####Hotfix note for v3.2.0.2 and lower:
-
-You will need to precompile your assets for FontAwesome support. To do this add this line:
-
-This is verbose:
-```
-Rails.application.config.assets.precompile += %w( fontawesome/fonts/fontawesome-webfont.eot fontawesome/fonts/fontawesome-webfont.woff fontawesome/fonts/fontawesome-webfont.ttf fontawesome/fonts/fontawesome-webfont.svg )
-```
-
-This is all you really need:
-```
-Rails.application.config.assets.precompile += %w(.svg .eot .woff .ttf)
-```
-
-For Rails 3 applications, add it to ```config/environments/production.rb```. For Rails 4, add it to ```config/initializers/assets.rb```.
-
+This will insert the appropriate entries into your application.js and application.css files, as well as configure rails asset pipeline. It will also provide you with the ability to customize Bootstrap and FontAwesome to your liking.
 
-Most of the info you'll need is in the wiki, and if it isn't please contribute!
+Most of the info you'll need is in the [wiki](https://github.com/toadkicker/railsstrap/wiki/Installing), and if it isn't please contribute!
 
 ##Building the gem
 

data/app/helpers/railsstrap/aside_helper.rb

@@ -0,0 +1,59 @@
+module Railsstrap
+  module AsideHelper
+
+    #asides have a header, a body, a footer for options.
+    def aside_dialog(options = {}, &block)
+      opts = default_aside_options.merge(options)
+      content_tag :div, :id => opts[:id], :class => "railsstrap-aside aside #{opts[:class]}", :data => { :backdrop => 'false' } do
+        content_tag :div, :class => "aside-dialog #{opts['size']}" do
+          content_tag :div, :class => 'aside-content' do
+            aside_header(opts[:header], &block) +
+            aside_body(opts[:body], &block) +
+            aside_footer(opts[:footer], &block)
+          end
+        end
+      end
+    end
+
+    def aside_header(options, &block)
+      content_tag :div, :class => 'aside-header' do
+        if options[:show_close]
+          close_button(options[:dismiss]) +
+          content_tag(:h4, options[:title], :class => 'aside-title', &block)
+        else
+          content_tag(:h4, options[:title], :class => 'aside-title', &block)
+        end
+      end
+    end
+
+    def aside_body(options, &block)
+      content_tag :div, options[:content], :class => 'aside-body', :style => options[:style], &block
+    end
+
+    def aside_footer(options, &block)
+      content_tag :div, options[:content], :class => 'aside-footer', &block
+    end
+
+    def close_button(dismiss)
+      content_tag :button, '×'.html_safe, :class => 'close', :data => {:dismiss => dismiss}, :'aria-hidden' => true
+    end
+
+    def aside_toggle(options = nil, &block)
+      opts = { :content => 'Close', :class => 'btn btn-default', :data => { :toggle => 'aside'}, :href => options[:dialog] }.merge(options)
+      content = opts[:content]
+      opts.delete :content
+      block_given? ? content_tag(:a, content, opts, true, &block) : content_tag(:a, content, opts, true)
+    end
+
+    def aside_cancel_button(content, options)
+      default_opts = { :class => 'btn railsstrap-aside-cancel-button' }
+      content_tag_string :a, content, default_opts.merge(options)
+    end
+
+    protected
+    def default_aside_options
+      {:id => 'aside', :size => '', :show_close => true, :dismiss => true}
+    end
+
+  end
+end

data/app/helpers/railsstrap/badge_label_helper.rb

@@ -4,10 +4,6 @@ module Railsstrap
       badge_label(:badge, *args)
     end
 
-    def tag_label(*args)
-      badge_label(:label, *args)
-    end
-
     private
     def badge_label(what, value, type = nil)
       klass = [what]

data/app/helpers/railsstrap/bootstrap_flash_helper.rb

@@ -29,7 +29,7 @@ module Railsstrap
 
           text = content_tag(opts[:container_tag],
                              (opts[:show_close] ? close_button : '') +
-                             msg, :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/app/helpers/railsstrap/date_picker_helper.rb

@@ -37,23 +37,31 @@ module Railsstrap
   module DatePickerHelper
 
     def date_picker(options = {})
-      opts = default_options.merge(options)
-      input = text_field_tag opts[:input_name], '', class: opts[:input_class]
-      icon_wrapper = content_tag opts[:icon_wrapper_tag], class: opts[:icon_wrapper_class] do
-        content_tag :i, '', class: opts[:icon]
-      end
+      opts = default_dp_options.merge(options)
       content_tag(opts[:wrapper_tag], id: opts[:id], class: opts[:wrapper_class], data: opts[:data]) {
-        opts[:show_input] ? input + icon_wrapper : icon_wrapper
+        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.merge(options)
+      content_tag opts[:icon_wrapper_tag], class: opts[:icon_wrapper_class] {
+        content_tag :i, '', class: opts[:icon]
+      }
+    end
+
+    def date_picker_input(options = {})
+      opts = default_dp_options.merge(options)
+      text_field_tag opts[:input_name], '', class: opts[:input_class]
+    end
+
     def date_picker_javascript(options = {})
       opts = default_js_options.merge(options)
       javascript_tag "(function ($) { $('#{opts[:selector]}').datetimepicker(#{opts.to_json});})(jQuery);"
     end
 
-    private
-    def default_options
+    protected
+    def default_dp_options
       { id: 'date_picker',
         wrapper_tag: :div,
         show_input: true,

data/app/helpers/railsstrap/modal_helper.rb

@@ -1,19 +1,15 @@
 module Railsstrap
   module ModalHelper
 
-    def default_options
-      return {:id => 'modal', :size => '', :show_close => true, :dismiss => true}
-    end
-
     #modals have a header, a body, a footer for options.
     def modal_dialog(options = {}, &block)
-      opts = default_options.merge(options)
-      content_tag :div, :id => options[:id], :class => "railsstrap-modal modal fade" do
+      opts = default_modal_options.merge(options)
+      content_tag :div, :id => opts[:id], :class => "railsstrap-modal modal #{opts[:class]} fade" do
         content_tag :div, :class => "modal-dialog #{opts['size']}" do
-          content_tag :div, :class => "modal-content" do
-            modal_header(options[:header], &block) +
-            modal_body(options[:body], &block) +
-            modal_footer(options[:footer], &block)
+          content_tag :div, :class => 'modal-content' do
+            modal_header(opts[:header], &block) +
+            modal_body(opts[:body], &block) +
+            modal_footer(opts[:footer], &block)
           end
         end
       end
@@ -39,26 +35,24 @@ module Railsstrap
     end
 
     def close_button(dismiss)
-      #It doesn't seem to like content_tag, so we do this instead.
-      raw("<button class=\"close\" data-dismiss=\"#{dismiss}\" aria-hidden=\"true\">&times;</button>")
+      content_tag :button, '&times;'.html_safe, :class => 'close', :data => {:dismiss => dismiss}, :'aria-hidden' => true
     end
 
-    def modal_toggle(content_or_options = nil, options, &block)
-      if block_given?
-        options = content_or_options if content_or_options.is_a?(Hash)
-        default_options = { :class => 'btn btn-default', "data-toggle" => "modal", "href" => options[:dialog] }.merge(options)
-
-        content_tag :a, nil, default_options, true, &block
-      else
-        default_options = { :class => 'btn btn-default', "data-toggle" => "modal", "href" => options[:dialog] }.merge(options)
-        content_tag :a, content_or_options, default_options, true
-      end
+    def modal_toggle(options = nil, &block)
+      opts = { :content => 'Close', :class => 'btn btn-default', :data => { :toggle => 'modal'}, :href => options[:dialog] }.merge(options)
+      content = opts[:content]
+      opts.delete :content
+      block_given? ? content_tag(:a, content, opts, true, &block) : content_tag(:a, content, opts, true)
     end
 
     def modal_cancel_button(content, options)
-      default_opts = { :class => "btn railsstrap-modal-cancel-button" }
+      default_opts = { :class => 'btn railsstrap-modal-cancel-button' }
+      content_tag_string :a, content, default_opts.merge(options)
+    end
 
-      content_tag_string "a", content, default_opts.merge(options)
+    protected
+    def default_modal_options
+      {:id => 'modal', :size => '', :show_close => true, :dismiss => true}
     end
 
   end

data/lib/generators/railsstrap/install/templates/bootstrap_and_overrides.less

@@ -1,26 +1,42 @@
-@import "bootstrap/less/bootstrap";
-//If you want exotic placement features, animations, and more, import this
-//@import "railsstrap";
-
-// Glyphicons - included by default in bootstrap.
-// You may need to customize config/initializers/assets.rb (Rails 4), or config/environments/[env].rb to add font paths in.
-// In either case of FontAwesome or Glyphicons, the railsstrap:install task should insert the appropriate entries for you.
-
-// Your custom LESS stylesheets goes here
-//
-// Since railsstrap was imported above you have access to its mixins which
-// you may use and inherit here, ex:
-// @import "bootstrap/less/mixins/alerts.less;
-//
-// If you'd like to override railsstrap's own variables, you can do so here as well
-// See http://bootstrap.github.com/bootstrap/customize.html#variables for their names and documentation
-//
-// Example:
-// @import (reference) 'bootstrap/less/variables.less';
-// @link-color: #ff0000;
-//
-// Date and Time Picker
-//
-// To enable the date and time picker, uncomment this line:
-// @import "datepicker/datepicker.less";
-// Don't forget to include the javascript library as well.
+/*
+ Bootstrap
+ This line imports bootstrap, modified to use glyphicons from Cloudflare CDN.
+*/
+@import "bootstrap";
+
+/*
+ Glyphicons - included by default in bootstrap.
+ If for any reason you prefer to have them as part of the asset pipeline, uncomment this.
+ If you choose to use this, open config/initializers/assets.rb (rails 4) and add this line:
+ Rails.application.config.assets.precompile += %w( *.eot *.woff *.ttf *.svg )
+*/
+
+// @import "glyphicons";
+
+/*
+  FontAwesome is hosted via CDN as well. If you prefer to have them included in the asset
+  pipeline, comment this out and see the next section.
+*/
+@import 'fontawesome';
+
+/*
+ Font Awesome
+ If for some reason you want fontawesome as part of the asset pipeline, comment out
+ the above refererence and uncomment the following lines. If you choose to use this, open
+ config/initializers/assets.rb (rails 4) and add this line:
+ Rails.application.config.assets.precompile += %w( *.eot *.woff *.ttf *.svg )
+*/
+
+//@import 'fontawesome-local';
+
+//If you want exotic placement features, animations, and more, import this:
+@import "railsstrap";
+
+/*
+ Date and Time Picker (https://github.com/toadkicker/railsstrap/wiki/Date-and-Time-Picker)
+ To enable the date and time picker, uncomment this line:
+ Don't forget to include the javascript library as well.
+*/
+
+//@import "datepicker/datepicker";
+

data/lib/railsstrap/constants.rb

@@ -1,6 +1,6 @@
 module Railsstrap
   module Constants
     #we follow along with Bootstrap's version number for easy identification
-    VERSION = '3.3.1'
+    VERSION = '3.3.2'
   end
 end

data/lib/railsstrap/engine.rb

@@ -13,17 +13,21 @@ module Railsstrap
   class Engine < ::Rails::Engine
 
     initializer 'railsstrap.setup',
-      :group => :all do |app|
-          bowerrc = File.read(File.join(config.root, '.bowerrc'))
-          app.config.assets.paths << File.join(bowerrc['directory'])
-        end
+                :after => 'railsstrap.before.load_config_initializers',
+                :group => :all do |app|
+      bowerrc = File.read(File.join(config.root, '.bowerrc'))
+      app.config.less.paths << File.join(bowerrc['directory'])
+      app.config.assets.paths << File.join(bowerrc['directory'])
+      app.config.app_generators.stylesheet_engine :less
+    end
 
     initializer 'railsstrap.setup_helpers' do |app|
       app.config.to_prepare do
         ActionController::Base.send :include, Railsstrap::Breadcrumbs
       end
 
-      [Railsstrap::BootstrapFlashHelper,
+      [Railsstrap::AsideHelper,
+       Railsstrap::BootstrapFlashHelper,
        Railsstrap::FormErrorsHelper,
        Railsstrap::ModalHelper,
        Railsstrap::GlyphHelper,

data/spec/lib/railsstrap/aside_helper_spec.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+require 'spec_helper'
+require_relative '../../../app/helpers/railsstrap/aside_helper'
+
+include ActionView::Helpers
+include ActionView::Context
+include Railsstrap::AsideHelper
+
+describe Railsstrap::AsideHelper, :type => :helper do
+  header_with_close = {:show_close => true, :dismiss => 'aside', :title => 'Aside header'}
+  header_without_close = {:show_close => false, :title => 'Aside header'}
+  options = {:id => "aside",
+             :header => header_with_close,
+             :body => {content: 'This is the body'},
+             :footer => {content: content_tag(:button, 'Save', :class => 'btn')}
+  }
+
+  it 'returns a complete aside' do
+    expect(aside_dialog(options).gsub(/\s/, '')).to eql BASIC_ASIDE.gsub(/\s/, '')
+  end
+
+  it 'returns a left aside' do
+    options[:class] = 'left'
+    expect(aside_dialog(options).gsub(/\s/, '')).to eql LEFT_ASIDE.gsub(/\s/, '')
+  end
+
+  it 'returns a aside header with a close button if show_close is true' do
+    expect(aside_header(header_with_close).gsub(/\s/, '')).to eql ASIDE_HEADER_WITH_CLOSE.gsub(/\s/, '')
+  end
+
+  it 'renders a aside header without a close button' do
+    expect(aside_header(header_without_close).gsub(/\s/, '')).to eql ASIDE_HEADER_WITHOUT_CLOSE.gsub(/\s/, '')
+  end
+
+  it 'renders a aside body' do
+    expect(aside_body(options[:body]).gsub(/\s/, '')).to eql ASIDE_BODY.gsub(/\s/, '')
+  end
+
+  it 'renders a aside footer' do
+    expect(aside_footer(options[:footer]).gsub(/\s/, '')).to eql ASIDE_FOOTER.gsub(/\s/, '')
+  end
+
+  it 'renders a close button' do
+    expect(close_button('aside')).to eql ASIDE_CLOSE_BUTTON.gsub(/\n/, '')
+  end
+
+  it 'renders a aside toggle button' do
+    expect(aside_toggle(:content => 'Save', :href => "#aside").gsub(/\s/, '')).to eql ASIDE_TOGGLE.gsub(/\s/, '')
+  end
+
+  it 'renders a aside toggle button with options changed' do
+    expect(aside_toggle(:content => 'Save', :href => "#aside", :data => {:foo => true, :toggle => 'aside'}).gsub(/\s/, '')).to eql ASIDE_TOGGLE_OPTS.gsub(/\s/, '')
+  end
+
+  it 'renders a aside toggle button with a block given' do
+    expect(aside_toggle(:href => "#aside", :data => {:foo => true, :toggle => 'aside'}){ content_tag(:span, 'Blocks Rock', class: "i-added-you") }.gsub(/\s/, '')).to eql ASIDE_TOGGLE_BLOCK.gsub(/\s/, '')
+  end
+
+  it 'renders a cancel button' do
+    expect(aside_cancel_button('Cancel', :href => "#aside", :data => {:dismiss => 'aside'}).gsub(/\s/, '')).to eql ASIDE_CANCEL_BUTTON.gsub(/\s/, '')
+  end
+end
+
+BASIC_ASIDE = <<-HTML
+<div id="aside" class="railsstrap-aside aside" data-backdrop="false">
+  <div class="aside-dialog ">
+    <div class="aside-content">
+      <div class="aside-header">
+        <button class="close" data-dismiss="aside" aria-hidden="true">&times;</button>
+        <h4 class="aside-title">Aside header</h4>
+      </div>
+      <div class="aside-body">This is the body</div>
+      <div class="aside-footer">
+        <button class="btn">Save</button>
+      </div>
+    </div>
+  </div>
+</div>
+HTML
+
+LEFT_ASIDE = <<-HTML
+<div id="aside" class="railsstrap-aside aside left" data-backdrop="false">
+  <div class="aside-dialog ">
+    <div class="aside-content">
+      <div class="aside-header">
+        <button class="close" data-dismiss="aside" aria-hidden="true">&times;</button>
+        <h4 class="aside-title">Aside header</h4>
+      </div>
+      <div class="aside-body">This is the body</div>
+      <div class="aside-footer">
+        <button class="btn">Save</button>
+      </div>
+    </div>
+  </div>
+</div>
+HTML
+
+ASIDE_BODY = <<-HTML
+<div class="aside-body">This is the body</div>
+HTML
+
+ASIDE_FOOTER = <<-HTML
+<div class="aside-footer"><button class="btn">Save</button></div>
+HTML
+
+ASIDE_HEADER_WITHOUT_CLOSE = <<-HTML
+<div class="aside-header"><h4 class="aside-title">Aside header</h4></div>
+HTML
+
+ASIDE_HEADER_WITH_CLOSE = <<-HTML
+<div class="aside-header">
+  <button class="close" data-dismiss="aside" aria-hidden="true">&times;</button>
+  <h4 class="aside-title">Aside header</h4>
+</div>
+HTML
+
+ASIDE_TOGGLE = <<-HTML
+<a class="btn btn-default" data-toggle="aside" href="#aside">Save</a>
+HTML
+
+ASIDE_TOGGLE_OPTS = <<-HTML
+<a class="btn btn-default" data-foo="true" data-toggle="aside" href="#aside">Save</a>
+HTML
+
+ASIDE_TOGGLE_BLOCK = <<-HTML
+<a class="btn btn-default" data-foo="true" data-toggle="aside" href="#aside">
+  <span class="i-added-you">
+    Blocks Rock
+  </span>
+</a>
+HTML
+
+ASIDE_CANCEL_BUTTON = <<-HTML
+<a class="btn railsstrap-aside-cancel-button" href="#aside" data-dismiss="aside">Cancel</a>
+HTML
+
+ASIDE_CLOSE_BUTTON = <<-HTML
+<button class="close" data-dismiss="aside" aria-hidden="true">&times;</button>
+HTML
+