fa_rails 0.1.21 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f664c27729b24055feaa406ad8847a1cd8e2c6bf176d513dff946c0cacfd088b
-  data.tar.gz: c2b3557385fe58d2c0cc87cc5f88b64b4a420cbf4ab521062e794253e2fc2672
+  metadata.gz: 9b54f242a9e548eec5062f96702e9932068fe7c7c51859b5447da6365f2ffe98
+  data.tar.gz: 37fa7e6971c0db4f1bf67ff689e0ce30e52b5f1c7df9ff73af208b96c8589998
 SHA512:
-  metadata.gz: 7f5b7a3d34e521837f5576c4a4da657c6e7d91fb30a131a32427f1750ffd183ab0281c1f11209c370ad96a11810f1e3a0b5381a947b6a126288aaa17e0652127
-  data.tar.gz: c6bfde33dce0ae1403553ca8ff1e36943e203ba6819010b9845b442e0ae46a242c16c63c424c121475af3fa6652f687dcec671150c4bff55613ac491cdeec7fc
+  metadata.gz: 574d7b97c657e3030300737364079cfb095fc7fbdde7c018f2efda666c2b460eb5788639ef44786bbb3eb4b046ca906d937b573c0eb0ccdfcf561c80f2685ab6
+  data.tar.gz: 7cef6d1273dbf03b156505e48e3f91685f1fefc3f8c79a852bdf5abf1fc3a2366b881b34b84a3bb0b20020d784a1dc1618fcdd651e424091850d2eba8f25844a

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    fa_rails (0.1.21)
+    fa_rails (0.1.26)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
     docile (1.3.1)
-    json (2.1.0)
-    rake (12.3.1)
+    json (2.3.1)
+    rake (12.3.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)

data/README.md

@@ -29,29 +29,41 @@ corresponding locations in your app, and ensure you correctly include all files.
 
 ### FontAwesome CDN
 
-Go to the FontAwesome
-[How to Use](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=web-fonts-with-css)
-page and copy the appropriate CDN link tag.
+You can also link into the FontAwesome CDN, in either of two ways:
 
-You can also `include FA`, then use the built-in helper method in your layout:
+#### Version-Specific Link
+
+You can use this helper method in your layout:
 
 ```ruby
 FA::Link.new(version: 'v5.3.1', integrity: 'sha384-some-key-here').safe
 ```
 
-#### Free
+Or, go to the FontAwesome
+[How to Use](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=web-fonts-with-css)
+page and copy the appropriate CDN link tag.
+
+**Be sure to also register each domain that will use this CDN link.**
+
+##### Free
 
 ```html
 <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css" integrity="sha384-some-key-here" crossorigin="anonymous">
 ```
 
-#### Pro
+##### Pro
 
 ```html
 <link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.3.1/css/all.css" integrity="sha384-some-key-here" crossorigin="anonymous">
 ```
 
-**Be sure to also register each domain that will use this CDN link.**
+#### Kit Link
+
+Use this helper method in your layout:
+
+```ruby
+FA::Link.kit('kit-id')
+```
 
 ## Usage
 
@@ -147,10 +159,21 @@ css #=> String – arbitrary CSS classes, space-delimited, applied to the layer
 FA::Icon.p('lock', fa: 'fw')
 #=> "<i class='fas fa-fw fa-lock fa-1x' style='' data-fa-transform='' title=''></i>"
 
+# Duotone fire-alt icon with swapped opacity
+FA::Icon.p('fire-alt', fa: 'swap-opacity')
+#=> "<i class='fas fa-swap-opacity fa-fire-alt fa-1x' style='' data-fa-transform='' title=''></i>"
+
 # Duotone fire-alt icon with specified opacities
 FA::Icon.p('fire-alt', style: :duotone, raw_css: { '--fa-primary-opacity' => '0.6', '--fa-secondary-opacity' => '0.4' })
 #=> "<i class='fad fa-fire-alt fa-1x' style='--fa-primary-opacity: 0.4; --fa-secondary-opacity: 0.6;' data-fa-transform='' title=''></i>"
 
+# You can also use this simplified configuration option for adding styles
+#   This is reforatted and merged into :raw_css
+#   Accepts either snake_case symbols or spear-case strings as keys, and strings or symbols as values
+#   This is the easiest way to add primary/secondary styles for duotone icons
+FA::Icon.p('fire-alt', style: :duotone, fa_styles: { primary_opacity: '0.6', secondary_opacity: '0.4', primary_color: :green, secondary_color: '#DD2200' })
+#=> "<i class='fad fa-fire-alt fa-1x' style='--fa-primary-opacity: 0.6; --fa-secondary-opacity: 0.4; --fa-primary-color: green; --fa-secondary-color: #DD2200;' data-fa-transform='' title=''></i>"
+
 # Counter span, with value 5
 FA::Span.p('counter', 5)
 #=> "<span class='fa-layers-counter ' style='' data-fa-transform=''>5</span>"

data/fa_rails.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name          = 'fa_rails'
-  s.version       = '0.1.21'
-  s.date          = '2019-08-09'
+  s.version       = '0.1.26'
+  s.date          = '2021-04-03'
   s.summary       = 'FontAwesome helper for Rails'
   s.description   = 'A helper module for using FontAwesome icons in Rails.'
   s.homepage      = 'http://rubygems.org/gems/fa_rails'

data/lib/fa/base.rb

@@ -3,6 +3,11 @@
 module FA
   # FontAwesome 5 (Pro) Helper core class for inheritance
   class Base
+    STYLES = {
+      solid: 's', regular: 'r', light: 'l', thin: 't',
+      duotone: 'd', brands: 'b', kit_upload: 'k'
+    }.freeze
+
     # Outputs the formatted string directly.
     def raw
       #
@@ -93,6 +98,7 @@ module FA
 
     def parse_options(options)
       parse_classes(options)
+      options = merge_fa_styles(options)
       parse_styles(options)
       parse_transforms(options)
     end
@@ -100,8 +106,24 @@ module FA
     def parse_classes(options)
       @classes = []
       @classes << parse_style(options)
-      @classes << options[:fa].to_s.split(' ').map { |c| "fa-#{c}" }
-      @classes << options[:css].to_s.split(' ')
+      @classes << format_classes(options[:fa], prefix: 'fa-')
+      @classes << format_classes(options[:css])
+    end
+
+    def format_classes(classes, prefix: nil)
+      classes = classes.to_s.split(' ') unless classes.is_a?(Array)
+      classes.map { |c| "#{prefix}#{c}" }
+    end
+
+    def merge_fa_styles(options)
+      fa_styles = options.delete(:fa_styles)
+      return options unless fa_styles
+
+      fa_styles = fa_styles.each_with_object({}) do |(k, v), hash|
+        hash["--fa-#{k.to_s.tr('_', '-')}"] = v.to_s
+      end
+      options[:raw_css] = options[:raw_css].merge(fa_styles)
+      options
     end
 
     def parse_styles(options)
@@ -118,10 +140,10 @@ module FA
     end
 
     def parse_style(options)
-      return if options[:css].to_s.match?(/fa[srldb]/)
-      return 'fas' unless %i[solid regular light duotone brands].include?(options[:style])
+      return if options[:css].to_s.match?(/fa[srldbk]/)
+      return 'fas' unless STYLES.keys.include?(options[:style])
 
-      'fa' + { solid: 's', regular: 'r', light: 'l', duotone: 'd', brands: 'b' }[options[:style]]
+      'fa' + STYLES[options[:style]]
     end
   end
 end

data/spec/lib/fa_spec.rb

@@ -28,11 +28,13 @@ RSpec.describe FA do
   end
 
   describe 'icon' do
-    it 'should generate the correct icon from a string or symbol name' do
+    it 'should generate the correct icon from a string name' do
       expect(FA::Icon.p('help')).to eql(
         "<i class='fas fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
       )
+    end
 
+    it 'should generate the correct icon from a symbol name' do
       expect(FA::Icon.p(:help)).to eql(
         "<i class='fas fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
       )
@@ -45,6 +47,36 @@ RSpec.describe FA do
       )
     end
 
+    it 'should correctly handle a string fa option' do
+      expect(FA::Icon.p(:help, fa: 'fw 2x')).to eql(
+        "<i class='fas fa-fw fa-2x fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
+      )
+    end
+
+    it 'should correctly handle an array fa option' do
+      expect(FA::Icon.p(:help, fa: %i[fw 2x])).to eql(
+        "<i class='fas fa-fw fa-2x fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
+      )
+    end
+
+    it 'should correctly handle a string css option' do
+      expect(FA::Icon.p(:help, css: 'green big')).to eql(
+        "<i class='fas green big fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
+      )
+    end
+
+    it 'should correctly handle an array css option' do
+      expect(FA::Icon.p(:help, css: %i[green big])).to eql(
+        "<i class='fas green big fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
+      )
+    end
+
+    it 'should correctly handle a nil css option' do
+      expect(FA::Icon.p(:help, css: nil)).to eql(
+        "<i class='fas fa-help fa-1x' style='' data-fa-transform='' title=''></i>"
+      )
+    end
+
     it 'should raise ArgumentError for other input types' do
       [nil, [], 0].each do |fa|
         expect { FA::Icon.p(fa) }.to raise_error(
@@ -58,6 +90,19 @@ RSpec.describe FA do
         "<i class='fab fa-github fa-1x' style='' data-fa-transform='' title=''></i>"
       )
     end
+
+    it 'should generate the correct icon with styles' do
+      expect(
+        FA::Icon.p(
+          'fire-alt', style: :duotone, fa_styles: {
+            primary_opacity: '0.6', secondary_opacity: '0.4', primary_color: :green, secondary_color: '#DD2200'
+          }
+        )
+      ).to eql(
+        "<i class='fad fa-fire-alt fa-1x' style='--fa-primary-opacity: 0.6; --fa-secondary-opacity: 0.4; " \
+        "--fa-primary-color: green; --fa-secondary-color: #DD2200;' data-fa-transform='' title=''></i>"
+      )
+    end
   end
 
   describe 'layer' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fa_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.26
 platform: ruby
 authors:
 - Julian Fiander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2021-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -113,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: FontAwesome helper for Rails