fa_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dbacdc4e0a4e68f79cfc68e8bb41711e43300e3
-  data.tar.gz: fec55616a7eaaa224bab094b25268b47d6b025be
+  metadata.gz: 426ebafa62f8215649caebd5b5a032a8e6811edb
+  data.tar.gz: 78512e22aa49f1869bae9b3772b1b27680c4663d
 SHA512:
-  metadata.gz: dd4692e88c2772c21655bd288302fa24f7e0dc89ed2e8ec25b0ba1c69085569ef657f563f498ad8ce18065f404b9a577047fd2c4f2603f724d2dbb9d4443d400
-  data.tar.gz: 25a690db403ab8e3006eca15d0bbc585a92b092a70db0293dc2ee43e6a03debdc8b980661ad8858598cbdac9fe78ffda9802f554b440d50cc1749a48e33354d0
+  metadata.gz: c51c668fbe28857e2e6f4fd4c9b1bbffa3844b0072109f66d71dfbcf6edbc1e433c84fe40cacff2c5e2f4cd4919c2771f33de261051daa58758dc43b5355be67
+  data.tar.gz: 51980ca1a7a4be0e919c1d38eae5989bc33c0a2b394cc8b6fef765ac1d7f23a11019a3678a159744ce1c6508d294b652691bd6789a94afbd2969b006b42336c5

data/fa_rails.gemspec

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

data/lib/fa/icon.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class FA::Icon < FA
+  def initialize(fa, options = {})
+    @options = options
+    if fa.is_a?(Hash)
+      @name = fa[:name]
+      @options = fa[:options]
+    elsif fa.is_a?(String) || fa.is_a?(Symbol)
+      @name = fa.to_s
+    else
+      raise ArgumentError, 'Unexpected argument type.'
+    end
+  end
+
+  def raw
+    parse_icon(@name, @options)
+  end
+end

data/lib/fa/layer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class FA::Layer < FA
+  def initialize(icons = {}, title: nil, grow: 0, css: '')
+    # Add icons to the stack bottom to top
+    #
+    # Note: scaling ounters does not work well with :grow, so should use the
+    # older "fa-3x" syntax in :css instead.
+    span_top = "<span class='icon fa-layers fa-fw #{css}' title='#{title}'>"
+    span_bottom = '</span>'
+
+    icons.each { |i| i[:options] = combine_options(i, combine_grows(i, grow)) }
+
+    @output = span_top + parse_all(icons).join + span_bottom
+  end
+
+  def raw
+    @output
+  end
+end

data/lib/fa/span.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class FA::Span < FA
+  def initialize(fa, text = '', options = {})
+    @options = options
+    if fa.is_a?(Hash)
+      @type = fa[:type].to_sym
+      @text = fa[:text]
+      @options = fa[:options]
+    elsif fa.is_a?(String) || fa.is_a?(Symbol)
+      @type = fa.to_s
+    else
+      raise ArgumentError, 'Unexpected argument type.'
+    end
+  end
+
+  def raw
+    parse_span(@type, @text, @options)
+  end
+end

data/lib/{font_awesome_helper.rb → fa.rb}

@@ -1,50 +1,23 @@
 # frozen_string_literal: true
 
 # FontAwesome 5 (Pro) Helper
-module FontAwesomeHelper
-  # html_safe: No user content
-  def fa_layer(icons = {}, title: nil, grow: 0, css: '')
-    # Add icons to the stack bottom to top
-    #
-    # Note: scaling ounters does not work well with :grow, so should use the
-    # older "fa-3x" syntax in :css instead.
-    span_top = "<span class='icon fa-layers fa-fw #{css}' title='#{title}'>"
-    span_bottom = '</span>'
-
-    icons.each { |i| i[:options] = combine_options(i, combine_grows(i, grow)) }
+class FA
+  require 'fa/icon'
+  require 'fa/span'
+  require 'fa/layer'
 
-    output = span_top + parse_all(icons).join + span_bottom
-    safe_output(output)
-  end
-
-  def fa_icon(fa, options = {})
-    if fa.is_a?(Hash)
-      name = fa[:name]
-      options = fa[:options]
-    elsif fa.is_a?(String) || fa.is_a?(Symbol)
-      name = fa.to_s
-    else
-      raise ArgumentError, 'Unexpected argument type.'
-    end
-    safe_output(parse_icon(name, options))
+  def raw
+    #
   end
 
-  def fa_span(fa, text = '', options = {})
-    if fa.is_a?(Hash)
-      type = fa[:type].to_sym
-      text = fa[:text]
-      options = fa[:options]
-    elsif fa.is_a?(String) || fa.is_a?(Symbol)
-      type = fa.to_s
-    else
-      raise ArgumentError, 'Unexpected argument type.'
-    end
-    safe_output(parse_span(type, text, options))
+  def safe
+    safe_output(raw)
   end
 
   private
 
   def safe_output(output)
+    # html_safe: No user content
     output.respond_to?(:html_safe) ? output.html_safe : output
   end
 

data/spec/helpers/{font_awesome_helper_spec.rb → fa_spec.rb}

@@ -1,38 +1,34 @@
 # frozen_string_literal: true
 
-require 'font_awesome_helper'
-
-RSpec.describe do
-  include FontAwesomeHelper
-
+RSpec.describe FA do
   describe 'icon' do
     it 'should generate the correct icon from a string or symbol name' do
-      expect(fa_icon('help')).to eql(
+      expect(FA::Icon.new('help')).to eql(
         "<i class='fas fa-help' data-fa-transform='' title=''></i>"
       )
 
-      expect(fa_icon(:help)).to eql(
+      expect(FA::Icon.new(:help)).to eql(
         "<i class='fas fa-help' 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(fa)).to eql(
+      expect(FA::Icon.new(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(fa) }.to raise_error(
+        expect { FA::Icon.new(fa) }.to raise_error(
           ArgumentError, 'Unexpected argument type.'
         )
       end
     end
 
     it 'should generate the correct brand icon' do
-      expect(fa_icon(:github, style: :brands)).to eql(
+      expect(FA::Icon.new(:github, style: :brands)).to eql(
         "<i class='fab fa-github' data-fa-transform='' title=''></i>"
       )
     end
@@ -46,7 +42,7 @@ RSpec.describe do
         { name: 'exclamation', options: { style: :regular } }
       ]
 
-      expect(fa_layer(icons, grow: 2)).to eql(
+      expect(FA::Layer.new(icons, grow: 2)).to eql(
         "<span class='icon fa-layers fa-fw ' title=''>" \
         "<i class='fas fa-square' data-fa-transform='grow-2' title=''></i>" \
         "<i class='fas fa-circle' data-fa-transform='grow-3' title=''></i>" \
@@ -61,7 +57,7 @@ RSpec.describe do
         { name: :counter, text: 17, options: { position: :tl } }
       ]
 
-      expect(fa_layer(icons)).to eql(
+      expect(FA::Layer.new(icons)).to eql(
         "<span class='icon fa-layers fa-fw ' title=''>" \
         "<i class='fas fa-square' data-fa-transform='grow-0' title=''></i>" \
         "<span class='fa-layers-counter fa-layers-top-left' " \
@@ -72,14 +68,14 @@ RSpec.describe do
 
   describe 'span' do
     it 'should generate the correct span from a string or symbol type' do
-      expect(fa_span(:text, 'Hello')).to eql(
+      expect(FA::Span.new(: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(span)).to eql(
+      expect(FA::Span.new(span)).to eql(
         "<span class='fa-layers-text fa-layers-bottom-left' " \
         "data-fa-transform=''>World</span>"
       )
@@ -87,7 +83,7 @@ RSpec.describe do
 
     it 'should raise ArgumentError for other input types' do
       [nil, [], 0].each do |fa|
-        expect { fa_span(fa) }.to raise_error(
+        expect { FA::Span.new(fa) }.to raise_error(
           ArgumentError, 'Unexpected argument type.'
         )
       end

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ Bundler.setup
 require 'simplecov'
 SimpleCov.start
 
+require 'fa'
+
 RSpec.configure do |config|
   #
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fa_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Julian Fiander
@@ -102,8 +102,11 @@ files:
 - README.md
 - Rakefile
 - fa_rails.gemspec
-- lib/font_awesome_helper.rb
-- spec/helpers/font_awesome_helper_spec.rb
+- lib/fa.rb
+- lib/fa/icon.rb
+- lib/fa/layer.rb
+- lib/fa/span.rb
+- spec/helpers/fa_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/fa_rails
 licenses:
@@ -132,5 +135,5 @@ signing_key:
 specification_version: 4
 summary: FontAwesome helper for Rails
 test_files:
-- spec/helpers/font_awesome_helper_spec.rb
+- spec/helpers/fa_spec.rb
 - spec/spec_helper.rb