font-awesome-rails 3.2.0.0 → 4.7.0.8

data/app/helpers/font_awesome/rails/icon_helper.rb

@@ -0,0 +1,100 @@
+module FontAwesome
+  module Rails
+    module IconHelper
+      # 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", original_options = {})
+        options = original_options.deep_dup
+        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", original_options = {})
+        options = original_options.deep_dup
+        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
+  end
+end

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

@@ -1,8 +1,6 @@
-module Font
-  module Awesome
-    module Rails
-      class Engine < ::Rails::Engine
-      end
+module FontAwesome
+  module Rails
+    class Engine < ::Rails::Engine
     end
   end
 end

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

@@ -1,7 +1,6 @@
-module Font
-  module Awesome
-    module Rails
-      VERSION = "3.2.0.0"
-    end
+module FontAwesome
+  module Rails
+    FA_VERSION = "4.7.0"
+    VERSION = "4.7.0.8"
   end
 end

data/test/dummy/.gitignore

@@ -0,0 +1,2 @@
+/log
+/tmp

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/sprockets-require.css

@@ -1,3 +1,3 @@
 /*
  *= require font-awesome
- */
+ */

data/test/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,2 @@
+class PagesController < ActionController::Base
+end

data/test/dummy/app/views/pages/icons.html.erb

@@ -0,0 +1,3 @@
+<%= fa_icon "flag" %>
+
+<%= fa_stacked_icon "twitter", :base => "check-empty" %>

data/test/dummy/config/application.rb

@@ -14,5 +14,6 @@ module Dummy
     # replacement for environments/*.rb
     config.active_support.deprecation = :stderr
     config.eager_load = false
+    config.active_support.test_order = :random rescue nil
   end
 end

data/test/dummy/config/initializers/secret_token.rb

@@ -4,5 +4,19 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Dummy::Application.config.secret_token    = 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef'
-Dummy::Application.config.secret_key_base = 'deadbeef' if Dummy::Application.config.respond_to?(:secret_key_base)
+#
+# avoid deprecation warnings if building against older versions of Rails
+
+# secret_token migrated to secret_key_base in Rails 4
+SKB_VERSION = Gem::Version.new('4.0.0')
+
+# Get the current Rails version.
+RAILS_VERSION = Rails.respond_to?(:version) ? Gem::Version.new(Rails.version) : Gem::Version.new('3.22')
+
+# if we're running an old version of Rails
+if RAILS_VERSION < SKB_VERSION 
+  Dummy::Application.config.secret_token    = 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef'
+else
+  Dummy::Application.config.secret_key_base = 'deadbeef' if Dummy::Application.config.respond_to?(:secret_key_base)
+end 
+

data/test/dummy/config/routes.rb

@@ -1,2 +1,3 @@
 Dummy::Application.routes.draw do
+  get "/icons", :to => "pages#icons"
 end

data/test/font_awesome_rails_test.rb

@@ -4,34 +4,35 @@ class FontAwesomeRailsTest < ActionDispatch::IntegrationTest
   teardown { clean_sprockets_cache }
 
   test "engine is loaded" do
-    assert_equal ::Rails::Engine, Font::Awesome::Rails::Engine.superclass
+    assert_equal ::Rails::Engine, FontAwesome::Rails::Engine.superclass
   end
 
   test "fonts are served" do
     get "/assets/fontawesome-webfont.eot"
     assert_response :success
-    get "/assets/fontawesome-webfont.ttf"
+    get "/assets/fontawesome-webfont.woff2"
     assert_response :success
     get "/assets/fontawesome-webfont.woff"
     assert_response :success
+    get "/assets/fontawesome-webfont.ttf"
+    assert_response :success
+    get "/assets/fontawesome-webfont.svg"
+    assert_response :success
   end
 
   test "stylesheets are served" do
     get "/assets/font-awesome.css"
     assert_font_awesome(response)
-    get "/assets/font-awesome-ie7.min.css"
-    assert_response :success
-    get "/assets/font-awesome-ie7.css"
-    assert_response :success
   end
 
   test "stylesheets contain asset pipeline references to fonts" do
     get "/assets/font-awesome.css"
-    assert_match "/assets/fontawesome-webfont.eot",  response.body
-    assert_match "/assets/fontawesome-webfont.eot?#iefix", response.body
-    assert_match "/assets/fontawesome-webfont.woff", response.body
-    assert_match "/assets/fontawesome-webfont.ttf",  response.body
-    assert_match "/assets/fontawesome-webfont.svg#fontawesomeregular", response.body
+    assert_match %r{/assets/fontawesome-webfont(-\w+)?\.eot},  response.body
+    assert_match %r{/assets/fontawesome-webfont(-\w+)?\.eot\?#iefix}, response.body
+    assert_match %r{/assets/fontawesome-webfont(-\w+)?\.woff2}, response.body
+    assert_match %r{/assets/fontawesome-webfont(-\w+)?\.woff}, response.body
+    assert_match %r{/assets/fontawesome-webfont(-\w+)?\.ttf},  response.body
+    assert_match %r{/assets/fontawesome-webfont(-\w+)?\.svg#fontawesomeregular}, response.body
   end
 
   test "stylesheet is available in a css sprockets require" do
@@ -49,6 +50,13 @@ class FontAwesomeRailsTest < ActionDispatch::IntegrationTest
     assert_font_awesome(response)
   end
 
+  test "helpers should be available in the view" do
+    get "/icons"
+    assert_response :success
+    assert_select "i.fa.fa-flag"
+    assert_select "span.fa-stack"
+  end
+
   private
 
   def clean_sprockets_cache

data/test/icon_helper_test.rb

@@ -0,0 +1,138 @@
+require 'test_helper'
+
+class FontAwesome::Rails::IconHelperTest < ActionView::TestCase
+
+  test "#fa_icon with no args should render a flag icon" do
+    assert_icon i("fa fa-flag")
+  end
+
+  test "#fa_icon should render different individual icons" do
+    assert_icon i("fa fa-flag"),         "flag"
+    assert_icon i("fa fa-camera-retro"), "camera-retro"
+    assert_icon i("fa fa-cog"),          "cog"
+    assert_icon i("fa fa-github"),       "github"
+  end
+
+  test "#fa_icon should render icons with multiple modifiers" do
+    assert_icon i("fa fa-pencil fa-fixed-width"), "pencil fixed-width"
+    assert_icon i("fa fa-flag fa-4x"),            "flag 4x"
+    assert_icon i("fa fa-refresh fa-2x fa-spin"), "refresh 2x spin"
+  end
+
+  test "#fa_icon should render icons with array modifiers" do
+    assert_icon i("fa fa-flag"),                  ["flag"]
+    assert_icon i("fa fa-check fa-li"),           ["check", "li"]
+    assert_icon i("fa fa-flag fa-4x"),            ["flag", "4x"]
+    assert_icon i("fa fa-refresh fa-2x fa-spin"), ["refresh", "2x", "spin"]
+  end
+
+  test "#fa_icon should incorporate additional class styles" do
+    assert_icon i("fa fa-flag pull-right"),                "flag",         :class => "pull-right"
+    assert_icon i("fa fa-flag fa-2x pull-right"),          ["flag", "2x"], :class => ["pull-right"]
+    assert_icon i("fa fa-check fa-li pull-right special"), "check li",     :class => "pull-right special"
+    assert_icon i("fa fa-check pull-right special"),       "check",        :class => ["pull-right", "special"]
+  end
+
+  test "#fa_icon should incorporate a text suffix" do
+    assert_icon "#{i("fa fa-camera-retro")} Take a photo", "camera-retro", :text => "Take a photo"
+  end
+
+  test "#fa_icon should be able to put the icon on the right" do
+    assert_icon "Submit #{i("fa fa-chevron-right")}", "chevron-right", :text => "Submit", :right => true
+  end
+
+  test "#fa_icon should html escape text" do
+    assert_icon "#{i("fa fa-camera-retro")} &lt;script&gt;&lt;/script&gt;", "camera-retro", :text => "<script></script>"
+  end
+
+  test "#fa_icon should not html escape safe text" do
+    assert_icon "#{i("fa fa-camera-retro")} <script></script>", "camera-retro", :text => "<script></script>".html_safe
+  end
+
+  test "#fa_icon should pull it all together" do
+    assert_icon "#{i("fa fa-camera-retro pull-right")} Take a photo", "camera-retro", :text => "Take a photo", :class => "pull-right"
+  end
+
+  test "#fa_icon should pass all other options through" do
+    assert_icon %(<i class="fa fa-user" data-id="123"></i>), "user", :data => { :id => 123 }
+  end
+
+  test '#fa_icon does not modify options' do
+    icon_options = { :class => 'foo', :data => { :id => 123 }, :text => 'bar' }
+    assert_icon %(<i class="fa fa-user foo" data-id="123"></i> bar), "user", icon_options
+    assert_includes icon_options, :class
+    assert_includes icon_options, :text
+    assert_includes icon_options, :data
+  end
+
+  test "#fa_stacked_icon with no args should render a flag icon" do
+    expected = %(<span class="fa-stack">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-flag fa-stack-1x")}</span>)
+    assert_stacked_icon expected
+  end
+
+  test "#fa_stacked_icon should render a stacked icon" do
+    expected = %(<span class="fa-stack">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-twitter fa-stack-1x")}</span>)
+    assert_stacked_icon expected, "twitter", :base => "square-o"
+    expected = %(<span class="fa-stack">#{i("fa fa-square fa-stack-2x")}#{i("fa fa-terminal fa-inverse fa-stack-1x")}</span>)
+    assert_stacked_icon expected, ["terminal", "inverse"], :base => ["square"]
+  end
+
+  test "#fa_stacked_icon should incorporate additional class styles" do
+    expected = %(<span class="fa-stack pull-right">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-twitter fa-stack-1x")}</span>)
+    assert_stacked_icon expected, "twitter", :base => "square-o", :class => "pull-right"
+  end
+
+  test "#fa_stacked_icon should reverse the stack" do
+    expected = %(<span class="fa-stack">#{i("fa fa-facebook fa-stack-1x")}#{i("fa fa-ban fa-stack-2x")}</span>)
+    assert_stacked_icon expected, "facebook", :base => "ban", :reverse => "true"
+  end
+
+  test "#fa_stacked_icon should be able to put the icon on the right" do
+    expected = %(Go <span class="fa-stack">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-exclamation fa-stack-1x")}</span>)
+    assert_stacked_icon expected, "exclamation", :text => "Go", :right => true
+  end
+
+  test "#fa_stacked_icon should html escape text" do
+    expected = %(<span class="fa-stack">#{i("fa fa-check-empty fa-stack-2x")}#{i("fa fa-twitter fa-stack-1x")}</span> &lt;script&gt;)
+    assert_stacked_icon expected, "twitter", :base => "check-empty", :text => "<script>"
+  end
+
+  test "#fa_stacked_icon should not html escape safe text" do
+    expected = %(<span class="fa-stack">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-twitter fa-stack-1x")}</span> <script>)
+    assert_stacked_icon expected, "twitter", :base => "square-o", :text => "<script>".html_safe
+  end
+
+  test "#fa_stacked_icon should accept options for base and main icons" do
+    expected = %(<span class="fa-stack">#{i("fa fa-camera fa-stack-1x text-info")}#{i("fa fa-ban fa-stack-2x text-error")}</span>)
+    assert_stacked_icon expected, "camera", :base => "ban", :reverse => true, :base_options => { :class => "text-error" }, :icon_options => { :class => "text-info" }
+  end
+
+  test "#fa_stacked_icon should pass all other options through" do
+    expected = %(<span class="fa-stack" data-id="123">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-user fa-stack-1x")}</span>)
+    assert_stacked_icon expected, "user", :base => "square-o", :data => { :id => 123 }
+  end
+
+  test '#fa_stacked_icon does not modify options' do
+    icon_options = { :class => 'foo', :base => "square-o", :data => { :id => 123 } }
+    expected = %(<span class="fa-stack foo" data-id="123">#{i("fa fa-square-o fa-stack-2x")}#{i("fa fa-user fa-stack-1x")}</span>)
+    assert_stacked_icon expected, "user", icon_options
+    assert_includes icon_options, :class
+    assert_includes icon_options, :data
+  end
+
+  private
+
+  def assert_icon(expected, *args)
+    message = "`fa_icon(#{args.inspect[1...-1]})` should return `#{expected}`"
+    assert_dom_equal expected, fa_icon(*args), message
+  end
+
+  def assert_stacked_icon(expected, *args)
+    message = "`fa_stacked_icon(#{args.inspect[1...-1]})` should return `#{expected}`"
+    assert_dom_equal expected, fa_stacked_icon(*args), message
+  end
+
+  def i(classes)
+    %(<i class="#{classes}"></i>)
+  end
+end

metadata

@@ -1,146 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: font-awesome-rails
 version: !ruby/object:Gem::Version
-  version: 3.2.0.0
+  version: 4.7.0.8
 platform: ruby
 authors:
 - bokmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '8.0'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  name: railties
+        version: '8.0'
 - !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  name: activesupport
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  name: tzinfo
 - !ruby/object:Gem::Dependency
+  name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  name: sass-rails
-description: I like font-awesome. I like the asset pipeline. I like semantic versioning.
-  If you do too, you're welcome.
+description: font-awesome-rails provides the Font-Awesome web fonts and stylesheets
+  as a Rails engine for use with the asset pipeline.
 email:
 - dbock@codesherpas.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/fonts/FontAwesome.otf
 - app/assets/fonts/fontawesome-webfont.eot
 - app/assets/fonts/fontawesome-webfont.svg
 - app/assets/fonts/fontawesome-webfont.ttf
 - app/assets/fonts/fontawesome-webfont.woff
-- app/assets/fonts/FontAwesome.otf
-- app/assets/stylesheets/font-awesome-ie7.css
-- app/assets/stylesheets/font-awesome-ie7.min.css
+- app/assets/fonts/fontawesome-webfont.woff2
 - app/assets/stylesheets/font-awesome.css.erb
+- app/helpers/font_awesome/rails/icon_helper.rb
+- lib/font-awesome-rails.rb
 - lib/font-awesome-rails/engine.rb
 - lib/font-awesome-rails/version.rb
-- lib/font-awesome-rails.rb
-- LICENSE
-- Rakefile
-- README.md
+- test/dummy/.gitignore
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/stylesheets/sass-import.css.sass
 - test/dummy/app/assets/stylesheets/scss-import.css.scss
 - test/dummy/app/assets/stylesheets/sprockets-require.css
+- test/dummy/app/controllers/pages_controller.rb
+- test/dummy/app/views/pages/icons.html.erb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/environment.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/log/test.log
 - test/font_awesome_rails_test.rb
+- test/icon_helper_test.rb
 - test/test_helper.rb
 homepage: https://github.com/bokmann/font-awesome-rails
 licenses:
 - MIT
 - SIL Open Font License
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 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:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: an asset gemification of the font-awesome icon font library
 test_files:
+- test/dummy/.gitignore
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/assets/stylesheets/sass-import.css.sass
 - test/dummy/app/assets/stylesheets/scss-import.css.scss
 - test/dummy/app/assets/stylesheets/sprockets-require.css
+- test/dummy/app/controllers/pages_controller.rb
+- test/dummy/app/views/pages/icons.html.erb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/environment.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/log/test.log
 - test/font_awesome_rails_test.rb
+- test/icon_helper_test.rb
 - test/test_helper.rb