faw_icon 0.5.2 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b9dbf3d06ffd3784bacb087db692f4ecbdf46e6e40f1f66794d17632209f60
-  data.tar.gz: 5c6ff460462e1438c75b03337e091c2d0766da3c929374aabc910053f5f4730c
+  metadata.gz: 8b0005468e9555d36d639101ae0dd657cd1bae0c5baf2d2f7205fc206a2563fe
+  data.tar.gz: 738a343d552e5155f9faa171ad0f23c8dd1fc1bf7a55350cd53721ad71000bc2
 SHA512:
-  metadata.gz: 656459ecc1e2f9d17690d024612f6361a8c17e7f65acba99c6d1b98109fe8dc287af00af7cbe9237e729f4765c24ef682a770ae896a97c19a9c78491e0346ff6
-  data.tar.gz: 8095adb7f78bd0d16eb22de88c38eb75738e55a442b668d50d7bbc07ffa8b4ef1f11e16966fb02d873da97074bdc4dc961c4e505171b79d57014b31b084f3c08
+  metadata.gz: 3dd3c6b0ade33e08037cb727d9c005c2de467b2c07412023e92f64224f5354c7db5661217c4f3e6cfb903575e3ae2fdf93b70b07aee70dbf872ee64d1f385ea2
+  data.tar.gz: 7f8cbd4412975e7aa6b33e08f66739ef3d39ba545d4c4448f596fcc6cdf0adf6700a05d45a3eb34f045a3836ebb320823ff6c474a9669dd195a0f250cad52e82

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    faw_icon (0.5.2)
+    faw_icon (0.6.2)
+      nokogiri (~> 1.8, >= 1.8.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    mini_portile2 (2.3.0)
     minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
     rake (10.5.0)
 
 PLATFORMS

data/README.md

@@ -41,6 +41,10 @@ The below options are also available for further customization
 | Property                  | Default                           |
 |---------------------------|-----------------------------------|
 | 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)          |
+| icon_not_found            | `<svg>...</svg>`                    |
 | default_family_prefix     | fa                                |
 | default_replacement_class | svg-inline--fa                    |
 
@@ -53,7 +57,35 @@ FawIcon.configure do |config|
   config.default_family_prefix = 'fa'
   config.default_replacement_class = 'svg-inline--fa'
 end
-```     
+```
+
+The configuration option `source_type` is added in this release to address the performance hit from loading large json files 
+from the PRO collection and introduces three 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 
+
+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.
+
+`raw` requires to push in your codenase all 2.986 icons unless they are hosted in a CDN, AWS or just a different repo.   
+
+with `sprite` you only need four files but they can only be served from public folder for the fragment identifier feature to work 
+which makes them available for anyone to download whereas the `raw` ones are 'hidden' in the `vendor` folder. 
+
+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)
+
+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 !
+
+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.   
+
+
 ## Usage
 All options from [additional-styling](https://fontawesome.com/how-to-use/svg-with-js#additional-styling) are supported with the exception of 
 CSS Pseudo-elements.

data/faw_icon.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
 end

data/lib/faw_icon/configuration.rb

@@ -12,11 +12,19 @@ module FawIcon
 
   class Configuration
     attr_accessor :icons_path
+    attr_accessor :raw_svg_path
+    attr_accessor :svg_sprites_path
+    attr_accessor :source_type
+    attr_accessor :icon_not_found
     attr_accessor :default_family_prefix
     attr_accessor :default_replacement_class
 
     def initialize
       @icons_path = 'app/assets/javascripts/icons.json'
+      @raw_svg_path = 'vendor/fa5/raw-svg'
+      @svg_sprites_path = 'public/fa5/svg-sprites'
+      @source_type = 'json'
+      @icon_not_found = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><g><path fill="currentColor" d="M156.5,447.7l-12.6,29.5c-18.7-9.5-35.9-21.2-51.5-34.9l22.7-22.7C127.6,430.5,141.5,440,156.5,447.7z M40.6,272H8.5 c1.4,21.2,5.4,41.7,11.7,61.1L50,321.2C45.1,305.5,41.8,289,40.6,272z M40.6,240c1.4-18.8,5.2-37,11.1-54.1l-29.5-12.6 C14.7,194.3,10,216.7,8.5,240H40.6z M64.3,156.5c7.8-14.9,17.2-28.8,28.1-41.5L69.7,92.3c-13.7,15.6-25.5,32.8-34.9,51.5 L64.3,156.5z M397,419.6c-13.9,12-29.4,22.3-46.1,30.4l11.9,29.8c20.7-9.9,39.8-22.6,56.9-37.6L397,419.6z M115,92.4 c13.9-12,29.4-22.3,46.1-30.4l-11.9-29.8c-20.7,9.9-39.8,22.6-56.8,37.6L115,92.4z M447.7,355.5c-7.8,14.9-17.2,28.8-28.1,41.5 l22.7,22.7c13.7-15.6,25.5-32.9,34.9-51.5L447.7,355.5z M471.4,272c-1.4,18.8-5.2,37-11.1,54.1l29.5,12.6 c7.5-21.1,12.2-43.5,13.6-66.8H471.4z M321.2,462c-15.7,5-32.2,8.2-49.2,9.4v32.1c21.2-1.4,41.7-5.4,61.1-11.7L321.2,462z M240,471.4c-18.8-1.4-37-5.2-54.1-11.1l-12.6,29.5c21.1,7.5,43.5,12.2,66.8,13.6V471.4z M462,190.8c5,15.7,8.2,32.2,9.4,49.2h32.1 c-1.4-21.2-5.4-41.7-11.7-61.1L462,190.8z M92.4,397c-12-13.9-22.3-29.4-30.4-46.1l-29.8,11.9c9.9,20.7,22.6,39.8,37.6,56.9 L92.4,397z M272,40.6c18.8,1.4,36.9,5.2,54.1,11.1l12.6-29.5C317.7,14.7,295.3,10,272,8.5V40.6z M190.8,50 c15.7-5,32.2-8.2,49.2-9.4V8.5c-21.2,1.4-41.7,5.4-61.1,11.7L190.8,50z M442.3,92.3L419.6,115c12,13.9,22.3,29.4,30.5,46.1 l29.8-11.9C470,128.5,457.3,109.4,442.3,92.3z M397,92.4l22.7-22.7c-15.6-13.7-32.8-25.5-51.5-34.9l-12.6,29.5 C370.4,72.1,384.4,81.5,397,92.4z"></path><circle fill="currentColor" cx="256" cy="364" r="28"><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="r" values="28;14;28;28;14;28;"></animate><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="opacity" values="1;0;1;1;0;1;"></animate></circle><path fill="currentColor" opacity="1" d="M263.7,312h-16c-6.6,0-12-5.4-12-12c0-71,77.4-63.9,77.4-107.8c0-20-17.8-40.2-57.4-40.2c-29.1,0-44.3,9.6-59.2,28.7 c-3.9,5-11.1,6-16.2,2.4l-13.1-9.2c-5.6-3.9-6.9-11.8-2.6-17.2c21.2-27.2,46.4-44.7,91.2-44.7c52.3,0,97.4,29.8,97.4,80.2 c0,67.6-77.4,63.5-77.4,107.8C275.7,306.6,270.3,312,263.7,312z"><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="opacity" values="1;0;0;0;0;1;"></animate></path><path fill="currentColor" opacity="0" d="M232.5,134.5l7,168c0.3,6.4,5.6,11.5,12,11.5h9c6.4,0,11.7-5.1,12-11.5l7-168c0.3-6.8-5.2-12.5-12-12.5h-23 C237.7,122,232.2,127.7,232.5,134.5z"><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="opacity" values="0;0;1;1;0;0;"></animate></path></g></svg>'
       @default_family_prefix = 'fa'
       @default_replacement_class = 'svg-inline--fa'
     end

data/lib/faw_icon/helper.rb

@@ -3,35 +3,65 @@ require "faw_icon/configuration"
 
 module FawIcon
   def faw_icon(style, name, options = {})
+    html_props = {}
     style = 'brands' if style == 'brand'
     fa_prefix = FawIcon.configuration.default_family_prefix
-    html_props = {}
-    icons = JSON.parse(File.read(FawIcon.configuration.icons_path))
-    view_box = [0, 0, 512, 512]
-    svg_path = '<g><path fill="currentColor" d="M156.5,447.7l-12.6,29.5c-18.7-9.5-35.9-21.2-51.5-34.9l22.7-22.7C127.6,430.5,141.5,440,156.5,447.7z M40.6,272H8.5 c1.4,21.2,5.4,41.7,11.7,61.1L50,321.2C45.1,305.5,41.8,289,40.6,272z M40.6,240c1.4-18.8,5.2-37,11.1-54.1l-29.5-12.6 C14.7,194.3,10,216.7,8.5,240H40.6z M64.3,156.5c7.8-14.9,17.2-28.8,28.1-41.5L69.7,92.3c-13.7,15.6-25.5,32.8-34.9,51.5 L64.3,156.5z M397,419.6c-13.9,12-29.4,22.3-46.1,30.4l11.9,29.8c20.7-9.9,39.8-22.6,56.9-37.6L397,419.6z M115,92.4 c13.9-12,29.4-22.3,46.1-30.4l-11.9-29.8c-20.7,9.9-39.8,22.6-56.8,37.6L115,92.4z M447.7,355.5c-7.8,14.9-17.2,28.8-28.1,41.5 l22.7,22.7c13.7-15.6,25.5-32.9,34.9-51.5L447.7,355.5z M471.4,272c-1.4,18.8-5.2,37-11.1,54.1l29.5,12.6 c7.5-21.1,12.2-43.5,13.6-66.8H471.4z M321.2,462c-15.7,5-32.2,8.2-49.2,9.4v32.1c21.2-1.4,41.7-5.4,61.1-11.7L321.2,462z M240,471.4c-18.8-1.4-37-5.2-54.1-11.1l-12.6,29.5c21.1,7.5,43.5,12.2,66.8,13.6V471.4z M462,190.8c5,15.7,8.2,32.2,9.4,49.2h32.1 c-1.4-21.2-5.4-41.7-11.7-61.1L462,190.8z M92.4,397c-12-13.9-22.3-29.4-30.4-46.1l-29.8,11.9c9.9,20.7,22.6,39.8,37.6,56.9 L92.4,397z M272,40.6c18.8,1.4,36.9,5.2,54.1,11.1l12.6-29.5C317.7,14.7,295.3,10,272,8.5V40.6z M190.8,50 c15.7-5,32.2-8.2,49.2-9.4V8.5c-21.2,1.4-41.7,5.4-61.1,11.7L190.8,50z M442.3,92.3L419.6,115c12,13.9,22.3,29.4,30.5,46.1 l29.8-11.9C470,128.5,457.3,109.4,442.3,92.3z M397,92.4l22.7-22.7c-15.6-13.7-32.8-25.5-51.5-34.9l-12.6,29.5 C370.4,72.1,384.4,81.5,397,92.4z"></path><circle fill="currentColor" cx="256" cy="364" r="28"><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="r" values="28;14;28;28;14;28;"></animate><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="opacity" values="1;0;1;1;0;1;"></animate></circle><path fill="currentColor" opacity="1" d="M263.7,312h-16c-6.6,0-12-5.4-12-12c0-71,77.4-63.9,77.4-107.8c0-20-17.8-40.2-57.4-40.2c-29.1,0-44.3,9.6-59.2,28.7 c-3.9,5-11.1,6-16.2,2.4l-13.1-9.2c-5.6-3.9-6.9-11.8-2.6-17.2c21.2-27.2,46.4-44.7,91.2-44.7c52.3,0,97.4,29.8,97.4,80.2 c0,67.6-77.4,63.5-77.4,107.8C275.7,306.6,270.3,312,263.7,312z"><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="opacity" values="1;0;0;0;0;1;"></animate></path><path fill="currentColor" opacity="0" d="M232.5,134.5l7,168c0.3,6.4,5.6,11.5,12,11.5h9c6.4,0,11.7-5.1,12-11.5l7-168c0.3-6.8-5.2-12.5-12-12.5h-23 C237.7,122,232.2,127.7,232.5,134.5z"><animate attributeType="XML" repeatCount="indefinite" dur="2s" attributeName="opacity" values="0;0;1;1;0;0;"></animate></path></g>'
-
-    if icons[name].present?
-      if icons[name]['svg'][style].present?
-        svg_path = "<path d=\"#{icons[name]['svg'][style]['path']}\"/>"
-        view_box = icons[name]['svg'][style]['viewBox']
-      end
-    end
 
     html_props[:class] = [fa_style(style), "#{fa_prefix}-#{name}", FawIcon.configuration.default_replacement_class]
     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]
 
-    tag = []
-    tag << "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"#{view_box.join(' ')}\" class=\"#{html_props[:class].join(' ')}\""
-    tag << " data-fa-transform=\"#{options[:transform]}\"" if options[:transform]
-    tag << " data-fa-mask=\"#{options[:mask]}\"" if options[:mask]
-    tag << '>'
-    tag << svg_path
-    tag << '</svg>'
+    case FawIcon.configuration.source_type
+      when 'json'
+        by_json(style, name, html_props)
+      when 'raw'
+        by_raw(style, name, html_props)
+      when 'sprite'
+        by_sprite(style, name, html_props)
+    end
+  end
 
-    tag.join( '').html_safe
+  def by_json(style, name, html_props)
+    icons = JSON.parse(File.read(FawIcon.configuration.icons_path))
+
+    if icons[name].present? && icons[name]['svg'][style].present?
+      doc = Nokogiri::HTML(icons[name]['svg'][style]['raw'])
+      svg = doc.at_css 'svg'
+    end
+
+    fa_tag(svg, html_props)
+  end
+
+  def by_raw(style, name, html_props)
+    if File.exists? Rails.root.join(FawIcon.configuration.raw_svg_path, style, "#{name}.svg")
+      doc = File.open(Rails.root.join(FawIcon.configuration.raw_svg_path, style, "#{name}.svg")) { |f| Nokogiri::HTML(f) }
+      svg = doc.at_css 'svg'
+    end
+
+    fa_tag(svg, html_props)
+  end
+
+  def by_sprite(style, name, html_props)
+    if File.exists? Rails.root.join(FawIcon.configuration.svg_sprites_path, "fa-#{style}.svg")
+      doc = Nokogiri::HTML("<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 512 512\"><use xlink:href=\"/fa5/svg-sprites/fa-#{style}.svg##{name}\"></use></svg>")
+      svg = doc.at_css 'svg'
+    end
+
+    fa_tag(svg, html_props)
+  end
+
+  def fa_tag(svg = nil, html_props)
+    svg = icon_not_found if svg.nil?
+
+    svg['class'] = html_props[:class].join(' ')
+    svg['data-fa-transform'] = html_props[:transform] if html_props[:transform]
+    svg['data-fa-mask'] = html_props[:mask] if html_props[:mask]
+
+    svg.to_html.html_safe
   end
 
   def fa_style(style)
@@ -46,4 +76,10 @@ module FawIcon
         'fab'
     end
   end
+
+  def icon_not_found
+    doc = Nokogiri::HTML(FawIcon.configuration.icon_not_found)
+
+    doc.at_css 'svg'
+  end
 end

data/lib/faw_icon/version.rb

@@ -1,3 +1,3 @@
 module FawIcon
-  VERSION = "0.5.2"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faw_icon
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.2
 platform: ruby
 authors:
 - alexwebgr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-27 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
 description: 
 email:
 - email@alex-web.gr