andy_rails_toolbox 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09558d094c0ae5cdf3d627a0cca25cdaf278c090
-  data.tar.gz: 5ab9aff7165be3c1417ddbfe14a87d3df1e3a64a
+  metadata.gz: 7ec7999c1f2abf182ec385152af0025d4fd7864e
+  data.tar.gz: 818c24d74ccb8af8e928a88db5b5874367d0efe4
 SHA512:
-  metadata.gz: c3e52ad10fe2ae6b9d656f8c31e5fdca5ccb3b4e4e9c09fd373ecece131664112e2893ab4676f8a07327666074cb72ab7b40ae8017fef44049c38af4e506934e
-  data.tar.gz: 7daa0744291b77cf196cd9ca18f7b866c95f75fc5147e5b7dc6984115776c7ce3c33be1d0ec55cb8144f61e018344e97db5b7b03f8410e70faee2a7f1d6bf881
+  metadata.gz: 392ca668c9f2f7328ca759696495babed7dddb910734431032d241a8fd2aaad7892b3e96a56450c9c91124830fa392f8e61cfa1fc676244ad6f4285622905b91
+  data.tar.gz: a043389d4987a619dc966e9a154178be73831c80e16bee7bc22a5e127a27c1e42da76393b888df1170681a3fe878b2d91e30ce74a39db3f1928aed35e81b40d0

data/README.md

@@ -1,4 +1,4 @@
-# Andy Rails Toolbox
+# Andy Rails Toolbox [![Gem Version](https://badge.fury.io/rb/andy_rails_toolbox.svg)](http://badge.fury.io/rb/andy_rails_toolbox)
 
 Andy Rails Toolbox includes many useful helpers for rails development.
 
@@ -39,14 +39,14 @@ Examples
 
 ICONS
 
-``` rb
+``` ruby
 bs_icon 'user'
 # => <span class="glyphicon glyphicon-user"></span>
 ```
 
 BUTTONS
 
-``` rb
+``` ruby
 html_button 'button'
 # => <button name="button" type="button" class="btn btn-default">button</button>
 html_button 'button', color: 'primary'
@@ -73,7 +73,7 @@ input_submit 'input button'
 
 IMAGES
 
-``` rb
+``` ruby
 image_responsive 'pic.png'
 # => <img class="img-responsive" src="/images/pic.png" alt="Pic" />
 image_rounded 'pic.png'
@@ -105,7 +105,7 @@ irb(main):002:0> Pygments.styles
 
 Examples
 
-``` rb
+``` ruby
 markdown '# h1'
 # => <h1>h1</h1>
 markdown '## h2'
@@ -118,7 +118,7 @@ markdown @post.content
 
 #### QrcodeHelper Examples
 
-``` rb
+``` ruby
 qrcode 'Hello world!'
 ```
 
@@ -126,7 +126,7 @@ qrcode 'Hello world!'
 
 QRCode options parameters: <a href="https://google-developers.appspot.com/chart/infographics/docs/qr_codes#overview" target="_blank">Here</a>
 
-``` rb
+``` ruby
 qrcode 'Hello world!', width: '300', output_encoding: 'Shift_JIS', error_correction_level: 'H', margin: '10'
 ```
 
@@ -134,17 +134,18 @@ qrcode 'Hello world!', width: '300', output_encoding: 'Shift_JIS', error_correct
 
 Font Awesome icons Homepage: <a href="http://fortawesome.github.io/Font-Awesome/" target="_blank">http://fortawesome.github.io/Font-Awesome/</a>
 
-Add below codes to layout `app/views/layout/application.html.erb`
+In your `application.css`, include the css file:
 
-``` erb
-...
-<%= stylesheet_link_tag '//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css' %>
-...
+```css
+/*
+ *= require font-awesome
+ */
 ```
+Then restart your webserver if it was previously running
 
 Examples
 
-``` rb
+``` ruby
 fa_icon "user"
 # => <i class="fa fa-user"></i>
 
@@ -160,7 +161,7 @@ fa_icon "user 4x"
 
 #### HashHelper Examples
 
-``` rb
+``` ruby
 options = { a: '1', b: '2', c: '3' }
 
 get_value :a, options
@@ -194,7 +195,7 @@ Add below codes to file `app/assets/javascripts/application.js`
 
 Use in View
 
-``` rb
+``` ruby
 timeago '2014-11-21 09:38:27.256503'
 # => '2個月之前'
 ```

data/Rakefile

@@ -14,10 +14,4 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 Bundler::GemHelper.install_tasks
-

data/app/assets/javascripts/jquery.timeago.load.coffee

@@ -1,3 +1,4 @@
 $ ->
   # timeago
-  $('abbr.timeago').timeago();
+  $('abbr.timeago').timeago()
+  $('abbr.timeago').tooltip()

data/app/helpers/bootstrap_helper.rb

@@ -1,111 +1,160 @@
 module BootstrapHelper
-  #############
-  ### ICONS ###
-  #############
+
+  # --------- #
+  # - ICONS - #
+  # --------- #
 
   # Generates an icon.
-  def bs_icon(icon, options = {})
-    icon = %(glyphicon glyphicon-#{icon})
-    add_css_class icon, options
-    tag = pop_value :tag, options, :span
-    content_tag tag, '', options
+  def bs_icon(icon, html_options = {})
+    html_options = html_options.stringify_keys
+    classes = ['glyphicon']
+    classes << "glyphicon-#{icon}"
+    if preset_class = html_options.delete('class')
+      classes << preset_class
+    end
+    html_options['class'] = classes * ' '
+
+    content_tag(:span, nil, html_options)
   end
 
-  ###############
-  ### BUTTONS ###
-  ###############
+  # ---------------- #
+  # - LINK BUTTONS - #
+  # ---------------- #
 
-  # Generates a button.
-  def button(label = 'Button', options = {})
-    html_button label, options
+  # Generates a link button.
+  def link_button(label = nil, options = nil, html_options = nil, &block)
+    html_options, options, label = options, label, capture(&block) if block_given?
+
+    html_options ||= {}
+    html_options = html_options.stringify_keys
+    html_options = normalize_button_options_for_bootstrap(html_options)
+
+    if (label_hidden = html_options.delete('label_hidden')) && !block_given?
+      label = content_tag :span, label, class: "hidden-#{label_hidden}"
+    end
+
+    if (icon = html_options.delete('icon')) && !block_given?
+      label = fa_icon(icon, text: label)
+    end
+
+    if html_options['confirm']
+      html_options['data-confirm'] = html_options.delete('confirm')
+    end
+
+    if html_options['disable_with']
+      html_options['data-disable-with'] = html_options.delete('disable_with')
+    end
+
+    link_to(label, options, html_options)
   end
 
-  # Generates a html submit button.
-  def html_button(label = 'Button', options = {})
-    btn :html_button, label, options
+  def new_button(label = nil, options = nil, html_options = nil)
+    button_options = { icon: 'plus', color: 'primary' }
+    html_options ||= {}
+    html_options.update button_options
+
+    link_button(label, options, html_options)
   end
 
-  # Generates a submit button.
-  def submit_button(label = 'Submit', options = {})
-    btn :submit_button, label, options
+  # Generates a link show button.
+  def show_button(label = nil, options = nil, html_options = nil)
+    button_options = { icon: 'search', color: 'info' }
+    html_options ||= {}
+    html_options.update button_options
+
+    link_button(label, options, html_options)
   end
 
-  # Generates a reset button.
-  def reset_button(label = 'Reset', options = {})
-    btn :reset_button, label, options
+  # Generates a link edit button.
+  def edit_button(label = nil, options = nil, html_options = nil)
+    button_options = { icon: 'edit', color: 'warning' }
+    html_options ||= {}
+    html_options.update button_options
+
+    link_button(label, options, html_options)
   end
 
-  # Generates a link submit button.
-  def link_button(label = 'Submit', options = {})
-    btn :link_button, label, options
+  # Generates a link destroy button.
+  def destroy_button(label = nil, options = nil, html_options = nil)
+    button_options = { icon: 'trash', color: 'danger', method: :delete, confirm: 'Are you sure?' }
+    html_options ||= {}
+    html_options.update button_options
+
+    link_button(label, options, html_options)
   end
 
-  # Generates a input button.
-  def input_button(label = 'Button', options = {})
-    btn :input_button, label, options
+  # Generates a link back button.
+  def back_button(label = nil, options = nil, html_options = nil)
+    button_options = { icon: 'reply' }
+    html_options ||= {}
+    html_options.update button_options
+
+    link_button(label, options, html_options)
   end
 
-  # Generates a input submit button.
-  def input_submit(label = 'Submit', options = {})
-    btn :input_submit, label, options
+  # Generates a link cancel button.
+  def cancel_button(label = nil, options = nil, html_options = nil)
+    button_options = { icon: 'ban' }
+    html_options ||= {}
+    html_options.update button_options
+
+    link_button(label, options, html_options)
   end
 
+  # ----------- #
+  # - BUTTONS - #
+  # ----------- #
+
   # Generates a button.
-  def btn(type, label, options = {})
-    add_css_class 'btn', options
+  def button(label = nil, html_options = nil, &block)
+    html_options, label = label, capture(&block) if block_given?
 
-    color = pop_value :color, options, 'default'
-    add_css_class(%(btn-#{color}), options) if color
+    html_options ||= {}
+    html_options = html_options.stringify_keys
+    html_options = normalize_button_options_for_bootstrap(html_options, :button)
 
-    size = pop_value :size, options
-    add_css_class(%(btn-#{size}), options) if size
+    html_options['type'] ||= 'button'
 
-    block = pop_value :block, options
-    add_css_class('btn-block', options) if block
+    if (label_hidden = html_options.delete('label_hidden')) && !block_given?
+      label = content_tag :span, label, class: "hidden-#{label_hidden}"
+    end
 
-    add_active_class options
+    if (icon = html_options.delete('icon')) && !block_given?
+      label = fa_icon(icon, text: label)
+    end
 
-    icon = pop_value :icon, options
-    unless type.to_s.include? 'input'
-      if icon
-        label = fa_icon(icon) + ' ' + label
-      end
+    if html_options['confirm']
+      html_options['data-confirm'] = html_options.delete('confirm')
     end
 
-    create_button type, label, options
-  end
-
-  def create_button(type, label, options)
-    url = pop_value :url, options, '#'
-    case type
-    when :html_button
-      options[:type] = :button unless options[:type]
-      button_tag label, options
-    when :submit_button
-      options[:name] = nil
-      options[:type] = :submit
-      button_tag label, options
-    when :reset_button
-      options[:name] = nil
-      options[:type] = :reset
-      button_tag label, options
-    when :link_button
-      options[:role] = :button
-      link_to label, url, options
-    when :input_button
-      options[:value] = label
-      options[:type] = :button
-      tag 'input', options
-    when :input_submit
-      submit_tag label, options
-    else
-      # type code here
+    if html_options['disable_with']
+      html_options['data-disable-with'] = html_options.delete('disable_with')
     end
+
+    button_tag(label, html_options)
+  end
+
+  # Generates a submit button.
+  def submit_button(label = nil, html_options = nil)
+    button_options = { icon: 'check', color: 'primary', name: 'submit', type: 'submit' }
+    html_options ||= {}
+    html_options.update button_options
+
+    button(label, html_options)
   end
 
-  ##############
-  ### IMAGES ###
-  ##############
+  # Generates a reset button.
+  def reset_button(label = nil, html_options = nil)
+    button_options = { icon: 'eraser', name: 'reset', type: 'reset' }
+    html_options ||= {}
+    html_options.update button_options
+
+    button(label, html_options)
+  end
+
+  # ---------- #
+  # - IMAGES - #
+  # ---------- #
 
   # Generates a responsive-friendly image tag
   def image_responsive(source, options = {})
@@ -131,9 +180,55 @@ module BootstrapHelper
     image_tag source, options
   end
 
-  #################
-  ### UTILITIES ###
-  #################
+  # ------------ #
+  # - OVERRIDE - #
+  # ------------ #
+
+  # override rails helper: content_tag
+  def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+    if block_given?
+      options = content_or_options_with_block if content_or_options_with_block.is_a? Hash
+      normalize_typography_options(options) if options
+      content_tag_string name, capture(&block), options, escape
+    else
+      normalize_typography_options(options) if options
+      content_tag_string name, content_or_options_with_block, options, escape
+    end
+  end
+
+  private
+
+  def normalize_button_options_for_bootstrap(html_options = {}, type = :link)
+    classes = ['btn']
+    if color = html_options.delete('color')
+      classes << "btn-#{color}"
+    else
+      classes << 'btn-default'
+    end
+    if size = html_options.delete('size')
+      classes << "btn-#{size}"
+    end
+    if block = html_options.delete('block')
+      classes << 'btn-block'
+    end
+    if active = html_options.delete('active')
+      classes << 'active'
+    end
+    if type == :link && html_options['disabled']
+      html_options.delete('disabled')
+      classes << 'disabled'
+    end
+    if preset_class = html_options.delete('class')
+      classes << preset_class
+    end
+
+    html_options['class'] = classes * ' '
+    html_options
+  end
+
+  # ------------- #
+  # - UTILITIES - #
+  # ------------- #
 
   # Appends new class names to the given options.
   def add_css_class(class_names, options)
@@ -192,20 +287,4 @@ module BootstrapHelper
     add_color_class options
     add_bgcolor_class options
   end
-
-  ################
-  ### OVERRIDE ###
-  ################
-
-  # override rails helper: content_tag
-  def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
-    if block_given?
-      options = content_or_options_with_block if content_or_options_with_block.is_a? Hash
-      normalize_typography_options(options) unless options.nil?
-      content_tag_string name, capture(&block), options, escape
-    else
-      normalize_typography_options(options) unless options.nil?
-      content_tag_string name, content_or_options_with_block, options, escape
-    end
-  end
 end

data/app/helpers/hash_helper.rb

@@ -1,7 +1,8 @@
 module HashHelper
-  ############
-  ### Hash ###
-  ############
+
+  # -------- #
+  # - Hash - #
+  # -------- #
 
   # Returns a specific value from the given hash (or the default value if not set).
   def get_value(key, hash, default_value = nil)

data/app/helpers/qrcode_helper.rb

@@ -1,5 +1,5 @@
 module QrcodeHelper
-  def qrcode(data='', options = {})
+  def qrcode(data = '', options = {})
     # Google API: https://google-developers.appspot.com/chart/infographics/docs/qr_codes
     width = pop_value :width, options, '200'
     output_encoding = pop_value :output_encoding, options

data/lib/andy_rails_toolbox/bootstrap-sass.rb

@@ -0,0 +1 @@
+require 'bootstrap-sass'

data/lib/andy_rails_toolbox/font-awesome-rails.rb

@@ -0,0 +1 @@
+require 'font-awesome-rails'

data/lib/andy_rails_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AndyRailsToolbox
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/andy_rails_toolbox.rb

@@ -1,3 +1,6 @@
+require 'andy_rails_toolbox/font-awesome-rails'
+require 'andy_rails_toolbox/bootstrap-sass'
+
 module AndyRailsToolbox
   class Engine < ::Rails::Engine
     initializer 'andy_rails_toolbox' do

metadata

@@ -1,43 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: andy_rails_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - ChouAndy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.3
 description: Andy Rails Toolbox includes many useful helpers for rails development.
 email:
 - chouandy625@gmail.com
@@ -52,12 +118,13 @@ files:
 - app/assets/javascripts/jquery.timeago.load.coffee
 - app/assets/javascripts/jquery.timeago.zh-TW.js
 - app/helpers/bootstrap_helper.rb
-- app/helpers/font_awesome_helper.rb
 - app/helpers/hash_helper.rb
 - app/helpers/markdown_helper.rb
 - app/helpers/qrcode_helper.rb
 - app/helpers/timeago_helper.rb
 - lib/andy_rails_toolbox.rb
+- lib/andy_rails_toolbox/bootstrap-sass.rb
+- lib/andy_rails_toolbox/font-awesome-rails.rb
 - lib/andy_rails_toolbox/version.rb
 homepage: https://github.com/ChouAndy/andy_rails_toolbox
 licenses:
@@ -71,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -79,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Includes many useful helpers for rails development.

data/app/helpers/font_awesome_helper.rb

@@ -1,94 +0,0 @@
-module FontAwesomeHelper
-  # Creates an icon tag given an icon name and possible icon
-  # modifiers.
-  #
-  # Examples
-  #
-  #   fa_icon "camera-retro"
-  #   # => <i class="fa fa-camera-retro"></i>
-  #
-  #   fa_icon "camera-retro", text: "Take a photo"
-  #   # => <i class="fa fa-camera-retro"></i> Take a photo
-  #   fa_icon "chevron-right", text: "Get started", right: true
-  #   # => Get started <i class="fa fa-chevron-right"></i>
-  #
-  #   fa_icon "camera-retro 2x"
-  #   # => <i class="fa fa-camera-retro fa-2x"></i>
-  #   fa_icon ["camera-retro", "4x"]
-  #   # => <i class="fa fa-camera-retro fa-4x"></i>
-  #   fa_icon "spinner spin lg"
-  #   # => <i class="fa fa-spinner fa-spin fa-lg">
-  #
-  #   fa_icon "quote-left 4x", class: "pull-left"
-  #   # => <i class="fa fa-quote-left fa-4x pull-left"></i>
-  #
-  #   fa_icon "user", data: { id: 123 }
-  #   # => <i class="fa fa-user" data-id="123"></i>
-  #
-  #   content_tag(:li, fa_icon("check li", text: "Bulleted list item"))
-  #   # => <li><i class="fa fa-check fa-li"></i> Bulleted list item</li>
-  def fa_icon(names = 'flag', options = {})
-    classes = ['fa']
-    classes.concat Private.icon_names(names)
-    classes.concat Array(options.delete(:class))
-    text = options.delete(:text)
-    right_icon = options.delete(:right)
-    icon = content_tag(:i, nil, options.merge(class: classes))
-    Private.icon_join(icon, text, right_icon)
-  end
-
-  # Creates an stack set of icon tags given a base icon name, a main icon
-  # name, and possible icon modifiers.
-  #
-  # Examples
-  #
-  #   fa_stacked_icon "twitter", base: "square-o"
-  #   # => <span class="fa-stack">
-  #   # =>   <i class="fa fa-square-o fa-stack-2x"></i>
-  #   # =>   <i class="fa fa-twitter fa-stack-1x"></i>
-  #   # => </span>
-  #
-  #   fa_stacked_icon "terminal inverse", base: "square", class: "pull-right", text: "Hi!"
-  #   # => <span class="fa-stack pull-right">
-  #   # =>   <i class="fa fa-square fa-stack-2x"></i>
-  #   # =>   <i class="fa fa-terminal fa-inverse fa-stack-1x"></i>
-  #   # => </span> Hi!
-  #
-  #   fa_stacked_icon "camera", base: "ban-circle", reverse: true
-  #   # => <span class="fa-stack">
-  #   # =>   <i class="fa fa-camera fa-stack-1x"></i>
-  #   # =>   <i class="fa fa-ban-circle fa-stack-2x"></i>
-  #   # => </span>
-  def fa_stacked_icon(names = 'flag', options = {})
-    classes = Private.icon_names('stack').concat(Array(options.delete(:class)))
-    base_names = Private.array_value(options.delete(:base) || 'square-o').push('stack-2x')
-    names = Private.array_value(names).push('stack-1x')
-    base = fa_icon(base_names, options.delete(:base_options) || {})
-    icon = fa_icon(names, options.delete(:icon_options) || {})
-    icons = [base, icon]
-    icons.reverse! if options.delete(:reverse)
-    text = options.delete(:text)
-    right_icon = options.delete(:right)
-    stacked_icon = content_tag(:span, safe_join(icons), options.merge(class: classes))
-    Private.icon_join(stacked_icon, text, right_icon)
-  end
-
-  module Private
-    extend ActionView::Helpers::OutputSafetyHelper
-
-    def self.icon_join(icon, text, reverse_order = false)
-      return icon if text.blank?
-      elements = [icon, ERB::Util.html_escape(text)]
-      elements.reverse! if reverse_order
-      safe_join(elements, ' ')
-    end
-
-    def self.icon_names(names = [])
-      array_value(names).map { |n| "fa-#{n}" }
-    end
-
-    def self.array_value(value = [])
-      value.is_a?(Array) ? value : value.to_s.split(/\s+/)
-    end
-  end
-end