faw_icon 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b69d366739f42aafd6f92431f5ae8a1ee59535cfc9fa91e5e8ac66a22049741
-  data.tar.gz: a154a2060a44811bb507320c3884363cb6a8334a93b08e5429a0e5e9f04922fd
+  metadata.gz: 7189106f2aa311399924cabc6ea478078dff205971f60ec3d8146673076ef985
+  data.tar.gz: '09821b560c5c90eae015410b4244dc32b0a850d34f02bb4d0c40d48c7acf0c59'
 SHA512:
-  metadata.gz: d989553d5322b1850732ca0c067c26553274b1c1ad88e4caed3203f31e2a6077fe55f6a184e350afbc2048b9fc6ee9e886007718dbeb77c029bd7e4f5d424fe3
-  data.tar.gz: eda0ed8cb67f58528b1ecd1b014fa89d7528b554fc34561a1e27a4e5deadfd46431822684328459bb065ecfc30c6b77462984c2d2332c963373fffa4f1fc033e
+  metadata.gz: ae7e75dbccd1b4d7bafb73fb6123ee91c9149247c854deac44d26b80c3c48fa485ad3f3cce3ea8a420675b66f1753d8a19b4c3134b4427145b8c739d3e8b752e
+  data.tar.gz: 394e6b9687f475e593e7e7142fc7726bb5f25af39145170d49a4c40086e86c578d8e265be25ae313069038160af6a45ab36e9c130ab0a476550e515cf748f519

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.2
+  - 3.2.0
+before_install: gem install bundler -v 2.4.2

data/Gemfile.lock

@@ -1,22 +1,20 @@
 PATH
   remote: .
   specs:
-    faw_icon (0.8.4)
+    faw_icon (1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
     rake (10.5.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2)
   faw_icon!
-  minitest (~> 5.0)
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.2
+   2.2.5

data/README.md

@@ -24,15 +24,16 @@ Or install it yourself as:
 
     $ gem install faw_icon
     
-You will need to download the .zip folder from [Font Awesome](https://fontawesome.com/get-started/svg-with-js)
+You will need to download the .zip folder from [Font Awesome](https://fontawesome.com/how-to-use/on-the-web/setup/hosting-font-awesome-yourself)
 where you can choose either the free or the PRO collection.
 
-Include in your application.scss the `fontawesome/svg-with-js/css/fa-svg-with-js.css` 
-ideally placing in the `app/assets/stylesheets/fa-svg-with-js.css` 
+Include in your application.scss the `fontawesome/css/svg-with-js.css` 
+ideally placing in the `app/assets/stylesheets/fontawesome/svg-with-js.css` 
 
 application.scss
 
-    @import "fa-svg-with-js";
+    @import "svg-with-js.min";
+    @import "fontawesome/all";
     
 ## Configuration 
 The below options are also available for further customization
@@ -64,21 +65,21 @@ from the PRO collection and introduces several ways to include icons in the appl
 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)
+4. `js` load one or more .js files according to the recommended way described at [svg-with-js](https://fontawesome.com/how-to-use/on-the-web/using-with/jquery)
 
 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` 
+In order to use copy the `fontawesome/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.   
+`raw` requires to push in your codebase all 2.986 icons unless they are hosted in a CDN, AWS or just a different repo. And keep them 
+under `vendor/fa5`  
 
 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)
+Read more about svg sprites in the [docs](https://fontawesome.com/how-to-use/on-the-web/advanced/svg-sprites)
 
 `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) 
@@ -94,20 +95,20 @@ 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 
+All options from [additional-styling](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons) are supported with the exception of 
 CSS Pseudo-elements.
  
 A mapping for the properties has been introduced in an attempt to make them more readable and easier to remember
 
-| Original property | Mapped property | Required | Original value     | Mapped value                 | Type    |
-|-------------------|-----------------|----------|--------------------|------------------------------|---------|
+| Original property | Mapped property | Required | Original value          | Mapped value                          | Type    |
+|-------------------|-----------------|----------|-------------------------|---------------------------------------|---------|
 | class             | style           | yes      | fas, far, fal, fab, fad | solid, regular, light, brand, duotone | string  |
-| class             | name            | yes      | fa-user            | user                         | string  |
-| class             | fixed_width     | no       | fa-fw              | true                         | boolean |
-| class             | spin            | no       | fa-spin            | true                         | boolean |
-| class             | extra_class     | no       | N/A                | any custom css class         | string  |
-| data-fa-transform | transform       | no       | grow-6             | grow-6                       | string  |
-| data-fa-mask      | mask            | no       | fas fa-comment     | fas fa-comment               | string  |
+| class             | name            | yes      | fa-user                 | user                                  | string  |
+| class             | fixed_width     | no       | fa-fw                   | true                                  | boolean |
+| class             | spin            | no       | fa-spin                 | true                                  | boolean |
+| class             | extra_class     | no       | N/A                     | any custom css class                  | string  |
+| data-fa-transform | transform       | no       | grow-6                  | grow-6                                | string  |
+| data-fa-mask      | mask            | no       | fas fa-comment          | fas fa-comment                        | string  |
 
 
 The `style` and `name` are required params and the rest optional ones go into a Hash in any order they might occur.
@@ -127,7 +128,10 @@ and the rest come in four variations but not all are available in the free colle
 Find them all in the [gallery](https://fontawesome.com/icons?d=gallery)    
 
 Note: Duotone style works just like all other icons, just use the 'duotone' style property.
-      
+
+## Troubleshooting
+If you get an error similar to this `cannot load such file -- rexml/document (LoadError)` you need to add [rexml](https://rubygems.org/gems/rexml) gem to your Gemfile 
+
 ## Contributing
 
 [Issues](https://github.com/alexwebgr/faw_icon/issues) and [pull requests](https://github.com/alexwebgr/faw_icon/pulls) are more than welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/faw_icon.gemspec

@@ -21,8 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
   # spec.required_ruby_version = '>= 2.5.0'
 end

data/lib/faw_icon/helper.rb

@@ -42,7 +42,17 @@ module FawIcon
   end
 
   def by_raw(style, name, html_props)
-    if File.exists? Rails.root.join(FawIcon.configuration.raw_svg_path, style, "#{name}.svg")
+    if (faw_spec = Gem.loaded_specs['faw_files'])
+      gem_folder = faw_spec.full_gem_path, 'vendor', 'assets', 'images', 'fa', 'raw-svg'
+      if File.exist? Rails.root.join(gem_folder.join("/"), style, "#{name}.svg")
+        doc = File.open(Rails.root.join(gem_folder.join("/"), style, "#{name}.svg")) { |f| REXML::Document.new(f) }
+        svg = doc.root
+      end
+
+      return fa_tag(svg, html_props)
+    end
+
+    if File.exist? 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| REXML::Document.new(f) }
       svg = doc.root
     end
@@ -51,7 +61,7 @@ module FawIcon
   end
 
   def by_sprite(style, name, html_props)
-    if File.exists? Rails.root.join(FawIcon.configuration.svg_sprites_path, "fa-#{style}.svg")
+    if File.exist? Rails.root.join(FawIcon.configuration.svg_sprites_path, "fa-#{style}.svg")
       doc = REXML::Document.new("<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 512 512\"><use href=\"/fa5/svg-sprites/fa-#{style}.svg##{name}\"></use></svg>")
       svg = doc.root
     end

data/lib/faw_icon/version.rb

@@ -1,3 +1,3 @@
 module FawIcon
-  VERSION = "1.1.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faw_icon
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - alexwebgr
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2025-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,21 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-description: 
+description:
 email:
 - email@alex-web.gr
 executables: []
@@ -77,7 +63,7 @@ homepage: https://github.com/alexwebgr/faw_icon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A simple helper for Font-Awesome 5 using raw SVG and SVG-with-JS
 test_files: []