faw_icon 0.3.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 383773c7210860d5527e08957d48355d15b4d0ddff7c694fae5c24be56de8174
-  data.tar.gz: 0d3020605c6ce388f2ab7a339841ad5c664488705aadf9e841ebd19aaf61b05f
+  metadata.gz: b9b783bfac785840004b982c9bc0fa71a93e74f82706076a7c6df5911c8b928c
+  data.tar.gz: 4a44897161e5ad7bc9e1c822e9d1217f6552d585c1b16f5848cfd60c94686223
 SHA512:
-  metadata.gz: 69c7d2496c26cebc7fbe62b1205cd1b3044cd5aadf4e5c95d30ab87bfa7c8eda02d95d68fd1630c973c9468fb0fc1954f52ffe84a8ac4617833a854d164fb5ec
-  data.tar.gz: dbd364974be9439e7b8d644c5f93ef27d3bf74d2bf84ac458e2729b09713df578bd89f6fa04cc1ca64f1d896d4f56d18130806e534ae4288a3cc41726f2c25bb
+  metadata.gz: 1ab604a4f8ad785d741c2bd2c913799cf0c295716e511bb262ce017fdef3b9417c2336d2b5a4d5b8c75c2c1eb3212eee4a5af4f84ebc60b33e02017cb56e2625
+  data.tar.gz: db39ddd9fd2ffb4818b72f70f253fe961fb903e2d0f259069de427f5623f07faf396f52e10ae22b7b466e2110271e0234bd0ea496d9ecd6ddeec139c7f73b535

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,9 @@
 ### Minimalistic ruby gem that exposes a tag helper for Font Awesome icon sets.
 
 By design it does not bundle any icons making it super fast to download and install 
-as well as providing the ability to use new icons as they become available, custom ones or the PRO collection.       
+as well as providing the ability to use new icons as they become available, custom ones or the PRO collection.  
+
+[![Gem Version](https://badge.fury.io/rb/faw_icon.svg)](https://badge.fury.io/rb/faw_icon)     
 
 ## Installation
 
@@ -32,7 +34,26 @@ 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
+ 
+| Property                  | Default                           |
+|---------------------------|-----------------------------------|
+| icons_path                | app/assets/javascripts/icons.json |
+| default_family_prefix     | fa                                |
+| default_replacement_class | svg-inline--fa                    |
+
+Simply create an initializer under `/config/initializers/faw_icon.rb` and modify as needed !
+If you no option is supplied the default will be used
      
+```ruby
+FawIcon.configure do |config|
+  config.icons_path = 'app/assets/javascripts/icons.json'
+  config.default_family_prefix = 'fa'
+  config.default_replacement_class = 'svg-inline--fa'
+end
+```     
 ## 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

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

data/lib/faw_icon/configuration.rb

@@ -0,0 +1,24 @@
+require "faw_icon/version"
+
+module FawIcon
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :icons_path
+    attr_accessor :default_family_prefix
+    attr_accessor :default_replacement_class
+
+    def initialize
+      @icons_path = 'app/assets/javascripts/icons.json'
+      @default_family_prefix = 'fa'
+      @default_replacement_class = 'svg-inline--fa'
+    end
+  end
+end

data/lib/faw_icon/helper.rb

@@ -1,11 +1,12 @@
 require "faw_icon/version"
+require "faw_icon/configuration"
 
 module FawIcon
   def faw_icon(style, name, options = {})
     style = 'brands' if style == 'brand'
-    fa_prefix = 'fa'
+    fa_prefix = FawIcon.configuration.default_family_prefix
     html_props = {}
-    icons = JSON.parse(File.read('app/assets/javascripts/icons.json'))
+    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>'
 
@@ -16,7 +17,7 @@ module FawIcon
       end
     end
 
-    html_props[:class] = [fa_style(style), "#{fa_prefix}-#{name}", 'svg-inline--fa']
+    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]

data/lib/faw_icon/version.rb

@@ -1,3 +1,3 @@
 module FawIcon
-  VERSION = "0.3.2"
+  VERSION = "0.4.2"
 end

data/lib/faw_icon.rb

@@ -1,3 +1,4 @@
 require "faw_icon/version"
+require "faw_icon/configuration"
 require "faw_icon/helper"
 require "faw_icon/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faw_icon
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.2
 platform: ruby
 authors:
 - alexwebgr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - Rakefile
 - faw_icon.gemspec
 - lib/faw_icon.rb
+- lib/faw_icon/configuration.rb
 - lib/faw_icon/helper.rb
 - lib/faw_icon/railtie.rb
 - lib/faw_icon/version.rb
@@ -95,5 +96,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A simple gem for Font-Awesome 5 using SVG-with-JS only
+summary: A simple helper for Font-Awesome 5 using raw SVG
 test_files: []