faw_icon 0.7.4 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db43f1bc0f7f5ad5312f4a7d207c7726dea3c5fe75b66e9b054420792d8b9bb
-  data.tar.gz: 641ed0be7232090fd4112cf47cb8cf213d90ba3baa94a5ae7913735ddc9ab2e6
+  metadata.gz: 8dd810aea2dee37ab375e6609acd66af5d9fdb26ca005f194038909bbea8573a
+  data.tar.gz: 4b405f078816b80fa09fa45f1daf80b7a41e994eb56b3cb686529a2b9e25b863
 SHA512:
-  metadata.gz: e35e71ff1cbd11952e7c861adf609ea46854aa196c7a853dc4dc42355b5bbd2d46c8f978fe1443a0021746bf08dd1fb85ac21cf575517e04e36707afe89a9213
-  data.tar.gz: b31c50e65b73b5e9a010e39d9da2596ac0fb33a8ddccef1842b0e6d0f5a2ba097120c3f1c3a75277c21d5f3585289d70cea448363174732b13b67088f2ff3545
+  metadata.gz: fd4f7df5c71723babe994ac893c54465104047c896460d6fdb16b558b80b290065a497c1f5752d0fb8ba6671e311337f7c3306594ebc53a4e15fe99dc1c763f0
+  data.tar.gz: bbc8191ea0b25e9cda795dd08a91084e6e8b13a00209837cb7bccebb6080853f824d45b794b4eeacd744ba1b110034fbd146d33feffcdb546f339b0bcd2c7d64

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    faw_icon (0.7.4)
+    faw_icon (0.8.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -34,8 +34,6 @@ application.scss
 
     @import "fa-svg-with-js";
     
-Then copy the `fontawesome/advanced-options/metadata/icons.json` in `app/assets/javascripts/icons.json` 
-
 ## Configuration 
 The below options are also available for further customization
  
@@ -44,7 +42,7 @@ The below options are also available for further customization
 | icons_path                | app/assets/javascripts/icons.json |
 | raw_svg_path              | vendor/fa5/raw-svg                |
 | svg_sprites_path          | public/fa5/svg-sprites            |
-| source_type               | json (json, raw, sprite)          |
+| source_type               | json (json, raw, sprite, js)      |
 | icon_not_found            | `<svg>...</svg>`                  |
 | default_family_prefix     | fa                                |
 | default_replacement_class | svg-inline--fa                    |
@@ -61,16 +59,18 @@ end
 ```
 
 The configuration option `source_type` was added to address the performance hit from loading large json files 
-from the PRO collection and introduces three ways to include icons in the application.
+from the PRO collection and introduces several ways to include icons in the application.
  
 1. `json` load a json file, traverse and find the icon
 2. `raw` load a single svg file from the filesystem
 3. `sprite` load an svg sprite and target the icon by using svg fragment identifiers 
+4. `js` load one or more .js files according to the recommended way described at [svg-with-js](https://fontawesome.com/how-to-use/svg-with-js)
 
 They all have pros and cons so choose the one that is right for you.
  
 `json` a single file that contains everything however it will have a noticeable impact on performance when used with 
 the PRO collection because of the file size but not so much with the free one or a reduced set.
+In order to use copy the `fontawesome/advanced-options/metadata/icons.json` in `app/assets/javascripts/icons.json` 
 
 `raw` requires to push in your codebase all 2.986 icons unless they are hosted in a CDN, AWS or just a different repo.   
 
@@ -80,9 +80,15 @@ which makes them available for anyone to download whereas the `raw` ones are 'hi
 Read more about svg sprites in the [docs](https://fontawesome.com/how-to-use/svg-sprites) 
 and [browser support](https://fontawesome.com/how-to-use/svg-sprites#browser-support)
 
+`js` uses the recommended way from Font-Awesome however it introduces a rendering issue relating to turbolinks 
+[more info](https://github.com/FortAwesome/Font-Awesome/issues/11924) 
+
 However the paths to the icons can be configured and as long the parent folder with the style name i.e. `solid`, `regular`
 and so on remains the same feel free to place anywhere you like and if possible share your solution !
 
+It is best not to mix the `source_type` configurations if you decide to switch between two types make sure to keep only the
+assets relating to that `source_type` in order to avoid manifestations of unexpected behavior.
+
 At the same time feel free to create a pull request if you have another idea on how to include them
 or create an issue requesting a missing feature.   
 

data/faw_icon.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['alexwebgr']
   spec.email         = ['email@alex-web.gr']
 
-  spec.summary       = %q{A simple helper for Font-Awesome 5 using raw SVG}
+  spec.summary       = %q{A simple helper for Font-Awesome 5 using raw SVG and SVG-with-JS}
   spec.homepage      = "https://github.com/alexwebgr/faw_icon"
   spec.license       = "MIT"
 

data/lib/faw_icon/helper.rb

@@ -8,13 +8,15 @@ module FawIcon
     style = 'brands' if style == 'brand'
     fa_prefix = FawIcon.configuration.default_family_prefix
 
-    html_props[:class] = [fa_style(style), "#{fa_prefix}-#{name}", FawIcon.configuration.default_replacement_class]
+    html_props[:class] = [fa_style(style), "#{fa_prefix}-#{name}"]
+    html_props[:class] << FawIcon.configuration.default_replacement_class unless FawIcon.configuration.source_type == 'js'
     html_props[:class] << "#{fa_prefix}-#{options[:size]}" if options[:size]
     html_props[:class] << "#{fa_prefix}-fw" if options[:fixed_width]
     html_props[:class] << "#{fa_prefix}-spin" if options[:spin]
     html_props[:class] << options[:extra_class] if options[:extra_class]
     html_props[:transform] = options[:transform] if options[:transform]
     html_props[:mask] = options[:mask] if options[:mask]
+    html_props[:source_type] = FawIcon.configuration.source_type
 
     case FawIcon.configuration.source_type
       when 'json'
@@ -23,6 +25,8 @@ module FawIcon
         by_raw(style, name, html_props)
       when 'sprite'
         by_sprite(style, name, html_props)
+      when 'js'
+        by_js(html_props)
     end
   end
 
@@ -55,12 +59,19 @@ module FawIcon
     fa_tag(svg, html_props)
   end
 
+  def by_js(html_props)
+    doc = REXML::Document.new('<i>&nbsp;</i>')
+
+    fa_tag(doc.root, html_props)
+  end
+
   def fa_tag(svg = nil, html_props)
     svg = svg_not_found if svg.nil?
 
     svg.attributes['class'] = html_props[:class].join(' ')
     svg.attributes['data-fa-transform'] = html_props[:transform] if html_props[:transform]
     svg.attributes['data-fa-mask'] = html_props[:mask] if html_props[:mask]
+    svg.attributes['data-source-type'] = html_props[:source_type] if html_props[:source_type]
 
     svg.to_s.html_safe
   end

data/lib/faw_icon/version.rb

@@ -1,3 +1,3 @@
 module FawIcon
-  VERSION = "0.7.4"
+  VERSION = "0.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faw_icon
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.4
 platform: ruby
 authors:
 - alexwebgr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-02 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,5 +96,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A simple helper for Font-Awesome 5 using raw SVG
+summary: A simple helper for Font-Awesome 5 using raw SVG and SVG-with-JS
 test_files: []