fa_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a72e373530cd8a3caedad00de37025fb2187e006
-  data.tar.gz: cd91f707b79ab534a6e33c2eb93a136ce545882d
+  metadata.gz: 9fbd3a8577ad17608b6c22a6f859bd6c5310d754
+  data.tar.gz: 2ad7baf895420340358d2a3b996d737094eeb017
 SHA512:
-  metadata.gz: 27ba03ee38ef0b3989b296d7871e29b3bc5fb02abe76cfcd1378303bbad953cafd663bce525f05a1dc54486b732a3ed1343f334e13bc12e6a4bbed7e4dc5a88b
-  data.tar.gz: 03d4a55e8a63b0bb1586f18ae4608b5e62d853f39adb5b81a0b92184b2b6679e6f0d507baf7d061ad45dcedb26e5cf44703c033502fa4e1a5fb84f9e3d5b49e8
+  metadata.gz: 422152f48a9815e5423118f43f1e8d5851d1926dda4500ba8584525a0a96e0af3bae1dd1273fd5cad7feb93a062ccaae2bda4b71c6d765ee1816626b8583e90d
+  data.tar.gz: 3fa5f813afa216497416d20cd180e03a943b32b4d7f9ac3c2e7720109b3b8baf6e51e4c8e6b7f81f17543bf472239fc9ee35344ef52f1d1bef0f8201b700c197

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fa_rails (0.1.3)
+    fa_rails (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -10,6 +10,8 @@ You must still have your own FontAwesome Pro license, or install the
 [Free](https://use.fontawesome.com/releases/v5.2.0/fontawesome-free-5.2.0-web.zip)
 package.
 
+### Local Files
+
 Copy the complete `js` and `css` directories from the
 [web download](https://fontawesome.com/releases/5.2.0/web/download) into the
 corresponding locations in your app, and ensure you correctly include all files.
@@ -20,6 +22,26 @@ Add the following to `config/application.rb`:
 require 'fa'
 ```
 
+### FontAwesome CDN
+
+Go to the FontAwesome
+[How to Use](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=web-fonts-with-css)
+page and copy the appropriate CDN link tag:
+
+#### Free
+
+```html
+<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.2.0/css/all.css" integrity="sha384-some-key-here" crossorigin="anonymous">
+```
+
+#### Pro
+
+```html
+<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.2.0/css/all.css" integrity="sha384-some-key-here" crossorigin="anonymous">
+```
+
+**Be sure to also need to register each domain that will use this CDN link.**
+
 ## Usage
 
 The `FA` module contains three main subclasses: `Icon`, `Span`, and `Layer`.

data/fa_rails.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name          = 'fa_rails'
-  s.version       = '0.1.4'
-  s.date          = '2018-07-28'
+  s.version       = '0.1.5'
+  s.date          = '2018-07-30'
   s.summary       = 'FontAwesome helper for Rails'
   s.description   = 'A helper module for using FontAwesome icons in Rails.'
   s.homepage      = 'http://rubygems.org/gems/fa_rails'

data/lib/fa/base.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
 
 module FA
-  # FontAwesome 5 (Pro) Helper core class
+  # FontAwesome 5 (Pro) Helper core class for inheritance
   class Base
+    # Outputs the formatted string directly.
     def raw
       #
     end
 
+    # Attempts to call `.html_safe` on the the output of `raw`, if available.
     def safe
-      safe_output(raw)
+      output = raw
+      output.respond_to?(:html_safe) ? output.html_safe : output
     end
 
     private
 
-    def safe_output(output)
-      # html_safe: No user content
-      output.respond_to?(:html_safe) ? output.html_safe : output
-    end
-
     def parse_all(icons)
       icons.map do |icon|
         name = icon[:name]

data/lib/fa/icon.rb

@@ -3,6 +3,11 @@
 module FA
   # FontAwesome 5 (Pro) Helper for generating icons
   class Icon < FA::Base
+    # Creates a new Icon instance
+    #
+    # @param [Hash] fa The complete icon configuration
+    # @param [String] fa The icon name to generate
+    # @param [Hash] options Additional configuration options
     def initialize(fa, options = {})
       @options = options
       if fa.is_a?(Hash)
@@ -15,6 +20,7 @@ module FA
       end
     end
 
+    # Outputs the formatted icon directly.
     def raw
       parse_icon(@name, @options)
     end

data/lib/fa/layer.rb

@@ -3,17 +3,25 @@
 module FA
   # FontAwesome 5 (Pro) Helper for generating layered icons and spans
   class Layer < FA::Base
+    # Creates a new Layer instance
+    #
+    # Add icons or spans to the stack from bottom to top
+    #
+    # Note: scaling counters does not work well with :grow, so should use the
+    # older "fa-3x" syntax in :css instead.
+    #
+    # @param [Array] icons The complete hash configurations for each icon/span
+    # @param [String] title The tooltip text
+    # @param [Integer] grow An additional global scaling factor added in
+    # @param [String] css Additional arbitrary CSS classes, space-delimited
     def initialize(icons = {}, title: nil, grow: 0, css: '')
-      # Add icons to the stack bottom to top
-      #
-      # Note: scaling counters does not work well with :grow, so should use the
-      # older "fa-3x" syntax in :css instead.
       @icons = icons
       @title = title
       @grow = grow
       @css = css
     end
 
+    # Outputs the formatted stack of icons and spans directly.
     def raw
       span_top = "<span class='icon fa-layers fa-fw #{@css}' title='#{@title}'>"
       span_bottom = '</span>'

data/lib/fa/span.rb

@@ -3,6 +3,12 @@
 module FA
   # FontAwesome 5 (Pro) Helper for generating spans (counters and text)
   class Span < FA::Base
+    # Creates a new Span instance
+    #
+    # @param [Hash] fa The complete span configuration
+    # @param [String] fa The span type to generate
+    # @param [String] test The contents of the span
+    # @param [Hash] options Additional configuration options
     def initialize(fa, text = '', options = {})
       if fa.is_a?(Hash)
         set_options(fa[:type].to_sym, fa[:text], fa[:options])
@@ -13,6 +19,7 @@ module FA
       end
     end
 
+    # Outputs the formatted span directly.
     def raw
       parse_span(@type, @text, @options)
     end

data/lib/fa.rb

@@ -1,9 +1,20 @@
 # frozen_string_literal: true
 
 # FontAwesome 5 (Pro) Helper
+#
+# @author Julian Fiander
+# @since 0.1.0
 module FA
   require 'fa/base'
   require 'fa/icon'
   require 'fa/span'
   require 'fa/layer'
+
+  def fa_cdn_link(version:, integrity:, pro: true)
+    subdomain = pro ? 'pro' : 'use'
+    url = "https://#{subdomain}.fontawesome.com/releases/#{version}/css/all.css"
+
+    "<link rel=\"stylesheet\" href=\"#{url}\" " \
+    "integrity=\"#{integrity}\" crossorigin=\"anonymous\">"
+  end
 end

data/spec/lib/fa_spec.rb

@@ -3,6 +3,17 @@
 require 'spec_helper'
 
 RSpec.describe FA do
+  include FA
+
+  it 'should generate the correct link tag' do
+    tag = fa_cdn_link(version: 'v0.1.2', integrity: 'sha384-abc', pro: true)
+    expect(tag).to eql(
+      '<link rel="stylesheet" ' \
+      'href="https://pro.fontawesome.com/releases/v0.1.2/css/all.css" ' \
+      'integrity="sha384-abc" crossorigin="anonymous">'
+    )
+  end
+
   describe 'icon' do
     it 'should generate the correct icon from a string or symbol name' do
       expect(FA::Icon.new('help').safe).to eql(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fa_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Julian Fiander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-28 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake