font_awesome5_rails 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c8728f685eefcbdd4552b63e7f2f9fbd65936c484171b3da60e602202de3836
-  data.tar.gz: 55c5a2474b564c201f0e3c08d264ad135fec3ef225f900445eb2ab5fc9c8c79a
+  metadata.gz: fce62a97997f16202fbb41c0be992ccd4ed2bb71c9dec2d99423dca6d88dd78f
+  data.tar.gz: aa16178143f28cee6a43f56d4b712a6eee0f5d330a3f76a647767cefedb9d436
 SHA512:
-  metadata.gz: e4e204bc14a2fdbe630252901b5e71680ca97abbf4d833c68b67c92e768aa4ab59ac1aa164979f3e73aa2f4c1d746bc8b51ca352f1adecf35855d5a302cb273b
-  data.tar.gz: 6fc8206394ff8adc43b773090da3efc86975f272d596298186aff308c8178b926c43cab859b35ba8a71d830d3473b4d190cda34484ab2ad3316ff538ca969d36
+  metadata.gz: ddb46f82c0262b631b3f22bafefae72bbf70ba8dd2805ca56783f2d3d50e25e1c2d905fe0b7dc131b6b4c15f3c58a2b12667eb0a03de56e7d83d829ac81562b8
+  data.tar.gz: 32a56d7102fc10eb9fa7c6353d8692ad6889c9f2ae668377d216cca3be69477385b58804b5c7ef8f662e3fafd349660b95bdc869db7fc7956f3c3d8668350ccd

data/README.md

@@ -1,5 +1,5 @@
 # Font Awesome 5 Rails
-[![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=6&v=1.4.0&x2=0)](https://badge.fury.io/rb/font_awesome5_rails)
+[![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=6&v=1.5.0&x2=0)](https://badge.fury.io/rb/font_awesome5_rails)
 [![FA5 version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh&type=6&v=5.15.3&x2=0)](https://github.com/tomkra/font_awesome5_rails/blob/master/lib/font_awesome5_rails/version.rb)
 [![Build Status](https://travis-ci.org/tomkra/font_awesome5_rails.svg?branch=master)](https://travis-ci.org/tomkra/font_awesome5_rails)
 [![HitCount](http://hits.dwyl.io/tomkra/tomkra/font_awesome5_rails.svg)](http://hrits.dwyl.io/tomkra/tomkra/font_awesome5_rails)
@@ -23,6 +23,7 @@ Keep track of changes in [Changelog](https://github.com/tomkra/font_awesome5_rai
   - **[Layered and Stacked icons](#layered-and-stacked-icons)** <br />
 
 **[Use as images](#use-as-images)** <br />
+**[Use inline SVGs](#use-inline-svgs)** <br />
 **[FontAwesome 5 Pro icons](#fontawesome-5-pro-icons)** <br />
 **[Release notes](#release-notes)** <br />
 **[Buy me a coffee](#buy-me-a-coffee)** <br />
@@ -104,17 +105,18 @@ fa_icon(:camera_retro, text: 'Camera', right: true)
 # => <i class="fas fa-camera-retro"></i>
 ```
 
-### Solid, Regular, Light, Brand, Duotone icon types
+### Solid, Regular, Light, Brand, Duotone, Uploaded icon types
 In Font Awesome 5 there are several different types of icons. In font_awesome5_rails gem default icon type is ```solid```.
 If you want to use different icon style you can do this through ```type``` attribute.
 
-| Style         | type: | type:  |
-| ------------- |-------|--------|
-| Solid         | :fas  |:solid  |
-| Regular       | :far  |:regular|
-| Light         | :fal  |:light  |
-| Brand         | :fab  |:brand  |
-| Duotone       | :fad  |:duotone|
+|Style        | type: | type:   |
+|-------------|-------|---------|
+|Solid        | :fas  |:solid   |
+|Regular      | :far  |:regular |
+|Light        | :fal  |:light   |
+|Brand        | :fab  |:brand   |
+|Duotone      | :fad  |:duotone |
+|Kit Uploaded | :fak  |:uploaded|
 
 
 ```ruby
@@ -136,6 +138,12 @@ fa_icon('camera-retro', type: :duotone)
 fa_icon('camera-retro', type: :fab)
 # => <i class="fab fa-camera-retro"></i>
 
+fa_icon('custom-uploaded', type: :fak)
+# => <i class="fak fa-custom-uploaded"></i>
+
+fa_icon('custom-uploaded', type: :uploaded)
+# => <i class="fak fa-custom-uploaded"></i>
+
 ```
 
 Each icon type has its own helper method so you don't need to provide the ```type``` attribute in every call.
@@ -255,6 +263,22 @@ More examples can be found in specs.
 
 More animation and data attributes can be found on [FontAwesome documentation](https://fontawesome.com/how-to-use/svg-with-js).
 
+
+## Use inline SVGs
+You can also include icons as inline SVGs in your views directly, avoiding any JS entirely.
+```ruby
+fa_inline_icon('camera') # defaults to solid
+fa_inline_icon('camera', style: :solid)
+fa_inline_icon('camera', class: 'my-svg')
+```
+
+There are also helpers for the various styles available:
+```ruby
+fas_inline_icon('camera')
+fab_inline_icon('facebook')
+far_inline_icon('bell')
+```
+
 ## FontAwesome 5 Pro icons
 Due to licence policy this gem pack only free FA5 icons. However ```fa_icon``` helper support all types of icons. If you purchased FA5 Pro icons and want to use helpers provided by this gem it's possible.
 1. Add this gem to your ```Gemfile``` without including anything to ```application.css``` and ```application.js```.
@@ -276,4 +300,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 ### Buy me a coffee
 If you liked this gem, you can
 <a href="https://www.buymeacoffee.com/tomkra" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
-.
+.

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

@@ -5,6 +5,19 @@ require 'font_awesome5_rails/parsers/fa_stacked_icon_parser'
 module FontAwesome5
   module Rails
     module IconHelper
+      ICON_TYPES = %w(fas far fal fab fad fak).freeze
+
+      def fa_inline_icon(icon, options = {})
+        file = FontAwesome5Rails::Parsers::FaIconParser.new(icon, options).file
+        return nil unless Pathname.new(file).exist?
+
+        doc = Nokogiri::XML(File.read(file))
+        svg = doc.root
+        svg[:fill] = 'currentColor'
+        classes = [options[:class], svg[:class]].flatten.compact.join ' '
+        svg[:class] = classes if classes
+        ActiveSupport::SafeBuffer.new(svg.to_s)
+      end
 
       def fa5_icon(icon, options = {})
         FontAwesome5Rails::Parsers::FaIconParser.new(icon, options).tag
@@ -34,12 +47,17 @@ module FontAwesome5
         end
       end
 
-      %w(fas far fal fab fad).each do |type|
+      ICON_TYPES.each do |type|
         define_method :"#{type}_icon" do |icon, options = {}|
           options[:type] = type.to_sym unless options.key? :type
           fa_icon(icon, options)
         end
 
+        define_method :"#{type}_inline_icon" do |icon, options = {}|
+          options[:type] = type.to_sym unless options.key? :type
+          fa_inline_icon(icon, options)
+        end
+
         define_method :"#{type}_stacked_icon" do |icon, options = {}|
           options[:type] = type.to_sym unless options.key? :type
           fa_stacked_icon(icon, options)

data/lib/font_awesome5_rails/parsers/fa_icon_parser.rb

@@ -6,6 +6,8 @@ module FontAwesome5Rails
       include ActionView::Helpers::TagHelper
       include ParseMethods
 
+      GEM_PATH = Pathname.new('../../../../').expand_path(__FILE__)
+
       attr_reader :icon, :options, :data, :style, :text, :title, :right, :attrs
 
       def initialize(icon, options)
@@ -33,6 +35,11 @@ module FontAwesome5Rails
         @right ? (text_content_tag + icon_content_tag) : (icon_content_tag + text_content_tag)
       end
 
+      def file
+        file = GEM_PATH.join("app/assets/images/fa5/#{icon_type_path(@options[:type])}/#{@icon}.svg")
+        file.exist? ? file : nil
+      end
+
       private
 
       def parse_classes

data/lib/font_awesome5_rails/parsers/parse_methods.rb

@@ -13,11 +13,30 @@ module FontAwesome5Rails
           'fab'
         when :fad, :duotone
           'fad'
+        when :fak, :uploaded
+          'fak'
         else
           'fas'
         end
       end
 
+      def icon_type_path(type)
+        return 'solid' if type.nil?
+
+        case type.to_sym
+        when :far, :regular
+          'regular'
+        when :fal, :light
+          'light'
+        when :fab, :brand
+          'brands'
+        when :fad, :duotone
+          'duotone'
+        else
+          'solid'
+        end
+      end
+
       def prepend_fa(string)
         "fa-#{string}"
       end

data/lib/font_awesome5_rails/version.rb

@@ -1,4 +1,4 @@
 module FontAwesome5Rails
-  FA_VERSION = '5.15.3'
-  VERSION = '1.4.0'
+  FA_VERSION = '5.15.3'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/spec/font_awesome5_rails_spec.rb

@@ -43,11 +43,13 @@ describe FontAwesome5Rails do
         expect(send(subject, 'camera-retro', type: :fal)).to eq '<i class="fal fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :fab)).to eq '<i class="fab fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :fad)).to eq '<i class="fad fa-camera-retro"></i>'
+        expect(send(subject, 'camera-retro', type: :fak)).to eq '<i class="fak fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :solid)).to eq '<i class="fas fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :regular)).to eq '<i class="far fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :light)).to eq '<i class="fal fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :brand)).to eq '<i class="fab fa-camera-retro"></i>'
         expect(send(subject, 'camera-retro', type: :duotone)).to eq '<i class="fad fa-camera-retro"></i>'
+        expect(send(subject, 'camera-retro', type: :uploaded)).to eq '<i class="fak fa-camera-retro"></i>'
       end
 
       it 'should return correct class tags' do
@@ -196,6 +198,15 @@ describe FontAwesome5Rails do
     end
   end
 
+  describe 'fa_inline_icon tags' do
+    it 'should return correct tags' do
+      expect(send(:fa_inline_icon,
+                  'square')).to match '<path d="M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48z"/>'
+      expect(send(:fa_inline_icon,
+                  'square', type: :regular)).to match '<path d="M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48zm-6 400H54c-3.3 0-6-2.7-6-6V86c0-3.3 2.7-6 6-6h340c3.3 0 6 2.7 6 6v340c0 3.3-2.7 6-6 6z"/>'
+    end
+  end
+
   describe '[fas, far, fal, fab, fad, far_stacked_icon]_icon helper method' do
     %w(fas far fal fab fad).each do |type|
       it "#{type}_icon should be defined and use the right icon type" do
@@ -203,8 +214,21 @@ describe FontAwesome5Rails do
 
         expect(self).to respond_to(method)
         expect(send(method, 'camera-retro')).to eq "<i class=\"#{type} fa-camera-retro\"></i>"
-        expect(send(method, 'camera-retro', type: :fal)).to eq "<i class=\"fal fa-camera-retro\"></i>"
-        expect(send(method, 'camera-retro', type: :brand, class: 'test')).to eq "<i class=\"fab fa-camera-retro test\"></i>"
+        expect(send(method, 'camera-retro', type: :fal)).to eq '<i class="fal fa-camera-retro"></i>'
+        expect(send(method, 'camera-retro', type: :brand,
+                                            class: 'test')).to eq '<i class="fab fa-camera-retro test"></i>'
+      end
+    end
+  end
+
+  describe '[fas, far]_inline_icon helper method' do
+    %w[fas far].each do |type|
+      it "#{type}_inline_icon should be defined and use the right icon type" do
+        method = :"#{type}_inline_icon"
+
+        expect(self).to respond_to(method)
+        expect(send(method,
+                    'square')).to match '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512" fill="currentColor" class="">'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: font_awesome5_rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - tomkra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement