font-awesome5-rails 1.0.0

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

@@ -0,0 +1,134 @@
+module FontAwesome5
+  module Rails
+    module IconHelper
+      # Creates an icon tag given an icon name and possible icon
+      # modifiers.
+      #
+      # Examples
+      #
+      #   fa_solid_icon "camera-retro"
+      #   # => <i class="fa fa-camera-retro"></i>
+      #
+      #   fa_solid_icon "camera-retro", text: "Take a photo"
+      #   # => <i class="fa fa-camera-retro"></i> Take a photo
+      #   fa_solid_icon "chevron-right", text: "Get started", right: true
+      #   # => Get started <i class="fa fa-chevron-right"></i>
+      #
+      #   fa_solid_icon "camera-retro 2x"
+      #   # => <i class="fa fa-camera-retro fa-2x"></i>
+      #   fa_solid_icon ["camera-retro", "4x"]
+      #   # => <i class="fa fa-camera-retro fa-4x"></i>
+      #   fa_solid_icon "spinner spin lg"
+      #   # => <i class="fa fa-spinner fa-spin fa-lg">
+      #
+      #   fa_solid_icon "quote-left 4x", class: "pull-left"
+      #   # => <i class="fa fa-quote-left fa-4x pull-left"></i>
+      #
+      #   fa_solid_icon "user", data: { id: 123 }
+      #   # => <i class="fa fa-user" data-id="123"></i>
+      #
+      #   content_tag(:li, fa_solid_icon("check li", text: "Bulleted list item"))
+      #   # => <li><i class="fa fa-check fa-li"></i> Bulleted list item</li>
+      def fa_solid_icon(names = "camera-retro", original_options = {})
+        options = original_options.deep_dup
+        classes = ["fas"]
+        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
+
+      def fa_regular_icon(names = "camera-retro", original_options = {})
+        options = original_options.deep_dup
+        classes = ["far"]
+        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
+
+      def fa_light_icon(names = "camera-retro", original_options = {})
+        options = original_options.deep_dup
+        classes = ["far"]
+        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
+
+
+      def fa_brand_icon(names = "font-awesome", original_options = {})
+        options = original_options.deep_dup
+        classes = ["fab"]
+        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_solid_icon(base_names, options.delete(:base_options) || {})
+        icon = fa_solid_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-awesome5-rails.rb

@@ -0,0 +1,2 @@
+require "font-awesome5-rails/version"
+require "font-awesome5-rails/engine" if defined?(::Rails)

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

@@ -0,0 +1,6 @@
+module FontAwesome5
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module FontAwesome5
+  module Rails
+    FA_VERSION = "5.0.6"
+    VERSION = "1.0.0"
+  end
+end

data/test/dummy/.gitignore

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

data/test/dummy/app/assets/stylesheets/sass-import.css.sass

@@ -0,0 +1 @@
+@import font-awesome5

data/test/dummy/app/assets/stylesheets/scss-import.css.scss

@@ -0,0 +1 @@
+@import "font-awesome5";

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

@@ -0,0 +1,3 @@
+/*
+ *= require font-awesome5
+ */

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,5 @@
+<%= fa_solid_icon "flag" %>
+<%= fa_regular_icon "flag" %>
+<%= fa_brand_icon "font-awesome" %>
+
+<%= fa_stacked_icon "twitter", :base => "check-empty" %>

data/test/dummy/config.ru

@@ -0,0 +1,3 @@
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../boot', __FILE__)
+
+# require "rails/all"
+require "sprockets/railtie"
+
+Bundler.require(:default, :development)
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+    config.assets.enabled = true
+    config.assets.version = '1.0'
+
+    # 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/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,4 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+# Initialize the rails application
+Dummy::Application.initialize!

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

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# 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)

data/test/dummy/config/routes.rb

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

data/test/font_awesome5_rails_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+class FontAwesome5RailsTest < ActionDispatch::IntegrationTest
+  teardown { clean_sprockets_cache }
+
+  test "engine is loaded" do
+    assert_equal ::Rails::Engine, FontAwesome5::Rails::Engine.superclass
+    puts "Engine is Loaded"
+  end
+
+  test "fonts are served" do
+    get "/assets/fa-brands-400.eot"
+    assert_response :success
+    get "/assets/fa-brands-400.ttf"
+    assert_response :success
+    get "/assets/fa-brands-400.woff2"
+    assert_response :success
+    get "/assets/fa-regular-400.svg"
+    assert_response :success
+    get "/assets/fa-regular-400.woff"
+    assert_response :success
+    get "/assets/fa-solid-900.eot"
+    assert_response :success
+    get "/assets/fa-solid-900.ttf"
+    assert_response :success
+    get "/assets/fa-solid-900.woff2"
+    assert_response :success
+    get "/assets/fa-brands-400.svg"
+    assert_response :success
+    get "/assets/fa-brands-400.woff"
+    assert_response :success
+    get "/assets/fa-regular-400.eot"
+    assert_response :success
+    get "/assets/fa-regular-400.ttf"
+    assert_response :success
+    get "/assets/fa-regular-400.woff2"
+    assert_response :success
+    get "/assets/fa-solid-900.svg"
+    assert_response :success
+    get "/assets/fa-solid-900.woff"
+    assert_response :success
+    puts "Fonts are served"
+
+  end
+
+
+  test "stylesheets are served" do
+    get "/assets/font-awesome5.css"
+    assert_font_awesome(response)
+  end
+
+  test "stylesheets contain asset pipeline references to fonts" do
+    get "/assets/font-awesome5.css"
+    assert_match %r{/assets/fa-brands-400(-\w+)?\.eot},  response.body
+    assert_match %r{/assets/fa-brands-400(-\w+)?\.ttf},  response.body
+    assert_match %r{/assets/fa-brands-400(-\w+)?\.woff2},  response.body
+    assert_match %r{/assets/fa-regular-400(-\w+)?\.svg},  response.body
+    assert_match %r{/assets/fa-regular-400(-\w+)?\.woff},  response.body
+    assert_match %r{/assets/fa-solid-900(-\w+)?\.eot},  response.body
+    assert_match %r{/assets/fa-solid-900(-\w+)?\.ttf},  response.body
+    assert_match %r{/assets/fa-solid-900(-\w+)?\.woff2},  response.body
+    assert_match %r{/assets/fa-brands-400(-\w+)?\.svg},  response.body
+    assert_match %r{/assets/fa-brands-400(-\w+)?\.woff},  response.body
+    assert_match %r{/assets/fa-regular-400(-\w+)?\.eot},  response.body
+    assert_match %r{/assets/fa-regular-400(-\w+)?\.ttf},  response.body
+    assert_match %r{/assets/fa-regular-400(-\w+)?\.woff2},  response.body
+    assert_match %r{/assets/fa-solid-900(-\w+)?\.svg},  response.body
+    assert_match %r{/assets/fa-solid-900(-\w+)?\.woff},  response.body
+  end
+
+  test "stylesheet is available in a css sprockets require" do
+    get "/assets/sprockets-require.css"
+    assert_font_awesome(response)
+  end
+
+  test "stylesheet is available in a sass import" do
+    get "/assets/sass-import.css"
+    assert_font_awesome(response)
+  end
+
+  test "stylesheet is available in a scss import" do
+    get "/assets/scss-import.css"
+    assert_font_awesome(response)
+  end
+
+  test "helpers should be available in the view" do
+    get "/icons"
+    assert_response :success
+    assert_select "i.fas.fa-flag"
+    assert_select "i.far.fa-flag"
+    assert_select "i.fab.fa-font-awesome"
+    assert_select "span.fa-stack"
+  end
+
+  private
+
+  def clean_sprockets_cache
+    FileUtils.rm_rf File.expand_path("../dummy/tmp",  __FILE__)
+  end
+
+  def assert_font_awesome(response)
+    assert_response :success
+    assert_match(/font-family:\s*'Font Awesome/, response.body)
+  end
+end

data/test/icon_helper_test.rb

@@ -0,0 +1,138 @@
+require 'test_helper'
+
+class FontAwesome5::Rails::IconHelperTest < ActionView::TestCase
+
+  test "#fa_solid_icon with no args should render a flag icon" do
+    assert_icon i("fas fa-camera-retro")
+  end
+
+  test "#fa_solid_icon should render different individual icons" do
+    assert_icon i("fas fa-flag"),         "flag"
+    assert_icon i("fas fa-camera-retro"), "camera-retro"
+    assert_icon i("fas fa-cog"),          "cog"
+    assert_icon i("fas fa-github"),       "github"
+  end
+
+  test "#fa_solid_icon should render icons with multiple modifiers" do
+    assert_icon i("fas fa-pencil fa-fixed-width"), "pencil fixed-width"
+    assert_icon i("fas fa-flag fa-4x"),            "flag 4x"
+    assert_icon i("fas fa-refresh fa-2x fa-spin"), "refresh 2x spin"
+  end
+
+  test "#fa_solid_icon should render icons with array modifiers" do
+    assert_icon i("fas fa-flag"),                  ["flag"]
+    assert_icon i("fas fa-check fa-li"),           ["check", "li"]
+    assert_icon i("fas fa-flag fa-4x"),            ["flag", "4x"]
+    assert_icon i("fas fa-refresh fa-2x fa-spin"), ["refresh", "2x", "spin"]
+  end
+
+  test "#fa_solid_icon should incorporate additional class styles" do
+    assert_icon i("fas fa-flag pull-right"),                "flag",         :class => "pull-right"
+    assert_icon i("fas fa-flag fa-2x pull-right"),          ["flag", "2x"], :class => ["pull-right"]
+    assert_icon i("fas fa-check fa-li pull-right special"), "check li",     :class => "pull-right special"
+    assert_icon i("fas fa-check pull-right special"),       "check",        :class => ["pull-right", "special"]
+  end
+
+  test "#fa_solid_icon should incorporate a text suffix" do
+    assert_icon "#{i("fas fa-camera-retro")} Take a photo", "camera-retro", :text => "Take a photo"
+  end
+
+  test "#fa_solid_icon should be able to put the icon on the right" do
+    assert_icon "Submit #{i("fas fa-chevron-right")}", "chevron-right", :text => "Submit", :right => true
+  end
+
+  test "#fa_solid_icon should html escape text" do
+    assert_icon "#{i("fas fa-camera-retro")} &lt;script&gt;&lt;/script&gt;", "camera-retro", :text => "<script></script>"
+  end
+
+  test "#fa_solid_icon should not html escape safe text" do
+    assert_icon "#{i("fas fa-camera-retro")} <script></script>", "camera-retro", :text => "<script></script>".html_safe
+  end
+
+  test "#fa_solid_icon should pull it all together" do
+    assert_icon "#{i("fas fa-camera-retro pull-right")} Take a photo", "camera-retro", :text => "Take a photo", :class => "pull-right"
+  end
+
+  test "#fa_solid_icon should pass all other options through" do
+    assert_icon %(<i class="fas fa-user" data-id="123"></i>), "user", :data => { :id => 123 }
+  end
+
+  test '#fa_solid_icon does not modify options' do
+    icon_options = { :class => 'foo', :data => { :id => 123 }, :text => 'bar' }
+    assert_icon %(<i class="fas 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("fas fa-square-o fa-stack-2x")}#{i("fas 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("fas fa-square-o fa-stack-2x")}#{i("fas fa-twitter fa-stack-1x")}</span>)
+    assert_stacked_icon expected, "twitter", :base => "square-o"
+    expected = %(<span class="fa-stack">#{i("fas fa-square fa-stack-2x")}#{i("fas 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("fas fa-square-o fa-stack-2x")}#{i("fas 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("fas fa-facebook fa-stack-1x")}#{i("fas 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("fas fa-square-o fa-stack-2x")}#{i("fas 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("fas fa-check-empty fa-stack-2x")}#{i("fas 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("fas fa-square-o fa-stack-2x")}#{i("fas 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("fas fa-camera fa-stack-1x text-info")}#{i("fas 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("fas fa-square-o fa-stack-2x")}#{i("fas 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("fas fa-square-o fa-stack-2x")}#{i("fas 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_solid_icon(#{args.inspect[1...-1]})` should return `#{expected}`"
+    assert_dom_equal expected, fa_solid_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