fa_rails 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3968254b8c159868cfb8ea652f34eff2326c36f
-  data.tar.gz: 11acb7f382f5aad18ad03b34bb927fc3eaeb1cfa
+  metadata.gz: bedbb3b52f82b24d5ef7d78088141fcf16710258
+  data.tar.gz: aad0ad0db36223df9317c8fe54d0a61a879a5ba1
 SHA512:
-  metadata.gz: 122bb5a2e2f171f2208a04015defbce07e7865aef2a4c286c0a79e6ed1b4a163097289bb75b3bda665110ef8f40fea0e7ef96d06650e5643eed6c497fd03fc9f
-  data.tar.gz: f83c382aaff389202657466094af61f4e479539797a47e96dcc9e29b9dfb4dc66a4667989d0b6e0c0468b5618c086a37585e39c6c1204b8cfc88338f3874b752
+  metadata.gz: 2ac8ff919be13408c0c1093bfc260eb6eb86b532b90236c5e7cf4234eb1b35ab1764a903641f256ac0dbe2d228918d2bf155eb5c22d6e02f9d197342bb09e777
+  data.tar.gz: dff2c8aa2b9ea64e4924d241ff4fd0922bf52747fd63a37b223765b97e0917d3c14b9891a3590c3977a5537c6d11285f238ed202c2efa3af8a086b641b32e0a8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fa_rails (0.1.13)
+    fa_rails (0.1.14)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -67,6 +67,9 @@ All three classes respond to two output methods: `raw` and `safe`.
 - `raw` outputs the formatted string directly
 - `safe` attempts to call `.html_safe` on the formatted string, if available
 
+For convenience, each class also has a `p` method, which will create a new
+instance, and return its `safe` output.
+
 ### Icon
 
 A single FontAwesome icon.
@@ -132,22 +135,22 @@ css # String – arbitrary CSS classes, space-delimited, applied to the layer st
 
 ```ruby
 # Fixed-width lock icon
-FA::Icon.new('lock', fa: 'fw').safe
+FA::Icon.p('lock', fa: 'fw')
 #=> "<i class='fas fa-fw fa-lock' data-fa-transform='' title=''></i>"
 
 # Counter span, with value 5
-FA::Span.new('counter', 5).safe
+FA::Span.p('counter', 5)
 #=> "<span class='fa-layers-counter ' data-fa-transform=''>5</span>
 
 # Gray envelope icon with red exclamation mark overlayed, with tooltip 'Invalid email address'
-FA::Layer.new([{ name: 'envelope', options: { css: :gray } }, { name: 'exclamation', options: { css: :red } }], title: 'Invalid email address').safe
+FA::Layer.p([{ name: 'envelope', options: { css: :gray } }, { name: 'exclamation', options: { css: :red } }], title: 'Invalid email address')
 #=> "<span class='icon fa-layers fa-stack fa-fw ' title='Invalid email address'>" \
 #   "<i class='fas gray fa-envelope' data-fa-transform='grow-0' title=''></i>" \
 #   "<i class='fas red fa-exclamation' data-fa-transform='grow-0' title=''></i>" \
 #   "</span>"
 
 # Blue envelope with red counter on the top left corner, with value 7
-FA::Layer.new([{ name: 'envelope', options: { css: :blue } }, { name: 'counter', text: 7, options: { css: :red, position: :tl } }]).safe
+FA::Layer.p([{ name: 'envelope', options: { css: :blue } }, { name: 'counter', text: 7, options: { css: :red, position: :tl } }])
 #=> "<span class='icon fa-layers fa-stack fa-fw ' title=''>" \
 #   "<i class='fas gray fa-envelope' data-fa-transform='grow-0' title=''></i>" \
 #   "<span class='red fa-layers-counter ' data-fa-transform='grow-0'>7" \

data/fa_rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'fa_rails'
-  s.version       = '0.1.13'
+  s.version       = '0.1.14'
   s.date          = '2018-07-30'
   s.summary       = 'FontAwesome helper for Rails'
   s.description   = 'A helper module for using FontAwesome icons in Rails.'

data/lib/fa/base.rb

@@ -14,6 +14,11 @@ module FA
       output.respond_to?(:html_safe) ? output.html_safe : output
     end
 
+    # Shortcut for create and output safe
+    def self.p(*args)
+      new(*args).safe
+    end
+
     private
 
     def parse_all(icons)

data/spec/lib/fa_spec.rb

@@ -14,32 +14,32 @@ RSpec.describe FA do
 
   describe 'icon' do
     it 'should generate the correct icon from a string or symbol name' do
-      expect(FA::Icon.new('help').safe).to eql(
+      expect(FA::Icon.p('help')).to eql(
         "<i class='fas fa-help fa-1x' data-fa-transform='' title=''></i>"
       )
 
-      expect(FA::Icon.new(:help).safe).to eql(
+      expect(FA::Icon.p(:help)).to eql(
         "<i class='fas fa-help fa-1x' data-fa-transform='' title=''></i>"
       )
     end
 
     it 'should generate the correct icon from a configuration hash' do
       fa = { name: 'help', options: { style: :light, size: 2 } }
-      expect(FA::Icon.new(fa).safe).to eql(
+      expect(FA::Icon.p(fa)).to eql(
         "<i class='fal fa-help fa-2x' data-fa-transform='' title=''></i>"
       )
     end
 
     it 'should raise ArgumentError for other input types' do
       [nil, [], 0].each do |fa|
-        expect { FA::Icon.new(fa).safe }.to raise_error(
+        expect { FA::Icon.p(fa) }.to raise_error(
           ArgumentError, 'Unexpected argument type.'
         )
       end
     end
 
     it 'should generate the correct brand icon' do
-      expect(FA::Icon.new(:github, style: :brands).safe).to eql(
+      expect(FA::Icon.p(:github, style: :brands)).to eql(
         "<i class='fab fa-github fa-1x' data-fa-transform='' title=''></i>"
       )
     end
@@ -53,7 +53,7 @@ RSpec.describe FA do
         { name: 'exclamation', options: { style: :regular } }
       ]
 
-      expect(FA::Layer.new(icons, grow: 2).safe).to eql(
+      expect(FA::Layer.p(icons, grow: 2)).to eql(
         "<span class='icon fa-layers fa-stack fa-fw ' title=''>" \
         "<i class='fas fa-stack-1x fa-square fa-1x' data-fa-transform='grow-2' title=''></i>" \
         "<i class='fas fa-stack-1x fa-circle fa-1x' data-fa-transform='grow-3' title=''></i>" \
@@ -68,7 +68,7 @@ RSpec.describe FA do
         { name: :counter, text: 17, options: { position: :tl } }
       ]
 
-      expect(FA::Layer.new(icons).safe).to eql(
+      expect(FA::Layer.p(icons)).to eql(
         "<span class='icon fa-layers fa-stack fa-fw ' title=''>" \
         "<i class='fas fa-stack-1x fa-square fa-1x' data-fa-transform='grow-0' title=''></i>" \
         "<span class='fa-stack-1x fa-layers-counter fa-layers-top-left' data-fa-transform='grow-0'>17</span>" \
@@ -82,7 +82,7 @@ RSpec.describe FA do
         { name: :exclamation, title: 'wrong 2' }
       ]
 
-      expect(FA::Layer.new(icons, title: 'right').safe).to eql(
+      expect(FA::Layer.p(icons, title: 'right')).to eql(
         "<span class='icon fa-layers fa-stack fa-fw ' title='right'>" \
         "<i class='fas fa-stack-1x fa-square fa-1x' data-fa-transform='grow-0' title='right'></i>" \
         "<i class='fas fa-stack-1x fa-exclamation fa-1x' data-fa-transform='grow-0' title='right'></i>" \
@@ -93,14 +93,14 @@ RSpec.describe FA do
 
   describe 'span' do
     it 'should generate the correct span from a string or symbol type' do
-      expect(FA::Span.new(:text, 'Hello').safe).to eql(
+      expect(FA::Span.p(:text, 'Hello')).to eql(
         "<span class='fa-layers-text ' data-fa-transform=''>Hello</span>"
       )
     end
 
     it 'should generate the correct span from a configuration hash' do
       span = { type: :text, text: 'World', options: { position: :bl } }
-      expect(FA::Span.new(span).safe).to eql(
+      expect(FA::Span.p(span)).to eql(
         "<span class='fa-layers-text fa-layers-bottom-left' " \
         "data-fa-transform=''>World</span>"
       )
@@ -108,7 +108,7 @@ RSpec.describe FA do
 
     it 'should raise ArgumentError for other input types' do
       [nil, [], 0].each do |fa|
-        expect { FA::Span.new(fa).safe }.to raise_error(
+        expect { FA::Span.p(fa) }.to raise_error(
           ArgumentError, 'Unexpected argument type.'
         )
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fa_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Julian Fiander