fa_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 426ebafa62f8215649caebd5b5a032a8e6811edb
-  data.tar.gz: 78512e22aa49f1869bae9b3772b1b27680c4663d
+  metadata.gz: 0fd53c5e9810de9d7364425d8928e032741a5df3
+  data.tar.gz: adb052186b5ab4bedd77e27f43cc5e6d973a8915
 SHA512:
-  metadata.gz: c51c668fbe28857e2e6f4fd4c9b1bbffa3844b0072109f66d71dfbcf6edbc1e433c84fe40cacff2c5e2f4cd4919c2771f33de261051daa58758dc43b5355be67
-  data.tar.gz: 51980ca1a7a4be0e919c1d38eae5989bc33c0a2b394cc8b6fef765ac1d7f23a11019a3678a159744ce1c6508d294b652691bd6789a94afbd2969b006b42336c5
+  metadata.gz: e11ee40165dd680bc382c66cc2e9d2e62ba81c8e622a336b1a016c4f956712ed873791f6f1e190212058c9c5068ae7fc01bae148a856659ff3e2c375c47f0649
+  data.tar.gz: 02531dc100ff594a87528bf015dccee154d53bf5ba56b0418d2219b8bb6ab487eaa126331082b39a5bf892a189be741f5743f9da17047740934642c154d1cf58

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fa_rails (0.1.0)
+    fa_rails (0.1.2)
       file_utils (~> 1.1, >= 1.1.2)
 
 GEM

data/fa_rails.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'fa_rails'
-  s.version       = '0.1.1'
+  s.version       = '0.1.2'
   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.rb

@@ -1,130 +1,127 @@
 # frozen_string_literal: true
 
 # FontAwesome 5 (Pro) Helper
-class FA
-  require 'fa/icon'
-  require 'fa/span'
-  require 'fa/layer'
-
-  def raw
-    #
-  end
+module FA
+  class Base
+    require 'fa/icon'
+    require 'fa/span'
+    require 'fa/layer'
+
+    def raw
+      #
+    end
 
-  def safe
-    safe_output(raw)
-  end
+    def safe
+      safe_output(raw)
+    end
 
-  private
+    private
 
-  def safe_output(output)
-    # html_safe: No user content
-    output.respond_to?(:html_safe) ? output.html_safe : output
-  end
+    def safe_output(output)
+      # html_safe: No user content
+      output.respond_to?(:html_safe) ? output.html_safe : output
+    end
 
-  def parse_all(icons)
-    icons.map do |icon|
-      name = icon[:name]
-      options = icon[:options] || {}
+    def parse_all(icons)
+      icons.map do |icon|
+        name = icon[:name]
+        options = icon[:options] || {}
 
-      if %i[counter text].include?(name)
-        parse_span(name, icon[:text], options)
-      else
-        parse_icon(name, options)
+        if %i[counter text].include?(name)
+          parse_span(name, icon[:text], options)
+        else
+          parse_icon(name, options)
+        end
       end
     end
-  end
 
-  def parse_icon(name, options = {})
-    options = fa_options(options)
-    parse_options(options)
-    title = options[:title]
+    def parse_icon(name, options = {})
+      options = fa_options(options)
+      parse_options(options)
+      title = options[:title]
 
-    @classes << "fa-#{name}"
-    @classes << "fa-#{size_x(options[:size])}" if !!options[:size]
-    css = @classes.flatten.join(' ')
-    transforms = @transforms.join(' ')
+      @classes << "fa-#{name}"
+      @classes << "fa-#{size_x(options[:size])}" if !!options[:size]
+      css = @classes.flatten.join(' ')
+      transforms = @transforms.join(' ')
 
-    "<i class='#{css}' data-fa-transform='#{transforms}' title='#{title}'></i>"
-  end
+      "<i class='#{css}' data-fa-transform='#{transforms}' title='#{title}'></i>"
+    end
 
-  def parse_span(type, text, options = {})
-    options.delete(:style)
-    options = fa_options(options)
-    parse_options(options)
-    pos = options.delete(:position)
-    position = long_position(pos) if !!pos
+    def parse_span(type, text, options = {})
+      options.delete(:style)
+      options = fa_options(options)
+      parse_options(options)
+      pos = options.delete(:position)
+      position = long_position(pos) if !!pos
 
-    @classes << "fa-layers-#{type}"
-    @classes << (!!position ? "fa-layers-#{position}" : '')
-    css = @classes.flatten.reject { |c| c.to_s.match?(/^fa.$/) }.join(' ')
-    transforms = @transforms.join(' ')
+      @classes << "fa-layers-#{type}"
+      @classes << (!!position ? "fa-layers-#{position}" : '')
+      css = @classes.flatten.reject { |c| c.to_s.match?(/^fa.$/) }.join(' ')
+      transforms = @transforms.join(' ')
 
-    "<span class='#{css}' data-fa-transform='#{transforms}'>#{text}</span>"
-  end
+      "<span class='#{css}' data-fa-transform='#{transforms}'>#{text}</span>"
+    end
 
-  def fa_options(options)
-    default = { style: :solid, css: '', fa: '' }
+    def fa_options(options)
+      default = { style: :solid, css: '', fa: '' }
 
-    default.merge(options.to_h)
-  end
+      default.merge(options.to_h)
+    end
 
-  def combine_grows(i, grow)
-    if i.key?(:options) && i[:options].key?(:grow)
-      i[:options][:grow] + grow
-    else
-      grow
+    def combine_grows(i, grow)
+      if i.key?(:options) && i[:options].key?(:grow)
+        i[:options][:grow] + grow
+      else
+        grow
+      end
     end
-  end
 
-  def combine_options(i, combined_grow)
-    if i.key?(:options)
-      i[:options].merge(grow: combined_grow)
-    else
-      { grow: combined_grow }
+    def combine_options(i, combined_grow)
+      if i.key?(:options)
+        i[:options].merge(grow: combined_grow)
+      else
+        { grow: combined_grow }
+      end
     end
-  end
 
-  def size_x(size)
-    return '' unless !!size || size == 1
-    "#{size}x"
-  end
+    def size_x(size)
+      return '' unless !!size || size == 1
+      "#{size}x"
+    end
 
-  def long_position(position)
-    return 'top-right' if position == :tr
-    return 'top-left' if position == :tl
-    return 'bottom-right' if position == :br
-    return 'bottom-left' if position == :bl
-  end
+    def long_position(position)
+      return 'top-right' if position == :tr
+      return 'top-left' if position == :tl
+      return 'bottom-right' if position == :br
+      return 'bottom-left' if position == :bl
+    end
 
-  def parse_options(options)
-    parse_classes(options)
-    parse_transforms(options)
-  end
+    def parse_options(options)
+      parse_classes(options)
+      parse_transforms(options)
+    end
 
-  def parse_classes(options)
-    @classes = []
-    @classes << parse_style(options[:style])
-    @classes << options[:fa].to_s.split(' ').map { |c| "fa-#{c}" }
-    @classes << options[:css].to_s.split(' ')
-  end
+    def parse_classes(options)
+      @classes = []
+      @classes << parse_style(options[:style])
+      @classes << options[:fa].to_s.split(' ').map { |c| "fa-#{c}" }
+      @classes << options[:css].to_s.split(' ')
+    end
 
-  def parse_transforms(options)
-    @transforms = []
-    %i[grow shrink rotate up down left right].each do |transform|
-      if !!options[transform]
-        @transforms << "#{transform}-#{options[transform]}"
+    def parse_transforms(options)
+      @transforms = []
+      %i[grow shrink rotate up down left right].each do |transform|
+        if !!options[transform]
+          @transforms << "#{transform}-#{options[transform]}"
+        end
       end
     end
-  end
 
-  def parse_style(style)
-    return 'fas' unless %i[solid regular light brands].include?(style)
+    def parse_style(style)
+      return 'fas' unless %i[solid regular light brands].include?(style)
 
-    'fa' + {
-      solid: 's',
-      regular: 'r',
-      light: 'l',
-      brands: 'b'
-    }[style]
+      'fa' + { solid: 's', regular: 'r', light: 'l', brands: 'b' }[style]
+    end
   end
 end

data/lib/fa/icon.rb

@@ -1,19 +1,22 @@
 # 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.'
+module FA
+  # FontAwesome 5 (Pro) Helper for generating icons
+  class Icon < FA::Base
+    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
-  end
 
-  def raw
-    parse_icon(@name, @options)
+    def raw
+      parse_icon(@name, @options)
+    end
   end
 end

data/lib/fa/layer.rb

@@ -1,20 +1,23 @@
 # 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>'
+module FA
+  # FontAwesome 5 (Pro) Helper for generating layered icons and spans
+  class Layer < FA::Base
+    def initialize(icons = {}, title: nil, grow: 0, css: '')
+      # Add icons to the stack bottom to top
+      #
+      # Note: scaling counters 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)) }
+      icons.each { |i| i[:options] = combine_options(i, combine_grows(i, grow)) }
 
-    @output = span_top + parse_all(icons).join + span_bottom
-  end
+      @output = span_top + parse_all(icons).join + span_bottom
+    end
 
-  def raw
-    @output
+    def raw
+      @output
+    end
   end
 end

data/lib/fa/span.rb

@@ -1,20 +1,28 @@
 # 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.'
+module FA
+  # FontAwesome 5 (Pro) Helper for generating spans (counters and text)
+  class Span < FA::Base
+    def initialize(fa, text = '', options = {})
+      if fa.is_a?(Hash)
+        set_options(fa[:type].to_sym, fa[:text], fa[:options])
+      elsif fa.is_a?(String) || fa.is_a?(Symbol)
+        set_options(fa.to_s, text, options)
+      else
+        raise ArgumentError, 'Unexpected argument type.'
+      end
+    end
+
+    def raw
+      parse_span(@type, @text, @options)
     end
-  end
 
-  def raw
-    parse_span(@type, @text, @options)
+    private
+
+    def set_options(type, text, options)
+      @type = type
+      @text = text
+      @options = options
+    end
   end
 end

data/spec/helpers/fa_spec.rb

@@ -1,34 +1,36 @@
 # frozen_string_literal: true
 
+require 'spec_helper'
+
 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')).to eql(
+      expect(FA::Icon.new('help').safe).to eql(
         "<i class='fas fa-help' data-fa-transform='' title=''></i>"
       )
 
-      expect(FA::Icon.new(:help)).to eql(
+      expect(FA::Icon.new(:help).safe).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.new(fa)).to eql(
+      expect(FA::Icon.new(fa).safe).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) }.to raise_error(
+        expect { FA::Icon.new(fa).safe }.to raise_error(
           ArgumentError, 'Unexpected argument type.'
         )
       end
     end
 
     it 'should generate the correct brand icon' do
-      expect(FA::Icon.new(:github, style: :brands)).to eql(
+      expect(FA::Icon.new(:github, style: :brands).safe).to eql(
         "<i class='fab fa-github' data-fa-transform='' title=''></i>"
       )
     end
@@ -42,7 +44,7 @@ RSpec.describe FA do
         { name: 'exclamation', options: { style: :regular } }
       ]
 
-      expect(FA::Layer.new(icons, grow: 2)).to eql(
+      expect(FA::Layer.new(icons, grow: 2).safe).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>" \
@@ -57,7 +59,7 @@ RSpec.describe FA do
         { name: :counter, text: 17, options: { position: :tl } }
       ]
 
-      expect(FA::Layer.new(icons)).to eql(
+      expect(FA::Layer.new(icons).safe).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' " \
@@ -68,14 +70,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')).to eql(
+      expect(FA::Span.new(:text, 'Hello').safe).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)).to eql(
+      expect(FA::Span.new(span).safe).to eql(
         "<span class='fa-layers-text fa-layers-bottom-left' " \
         "data-fa-transform=''>World</span>"
       )
@@ -83,7 +85,7 @@ RSpec.describe FA do
 
     it 'should raise ArgumentError for other input types' do
       [nil, [], 0].each do |fa|
-        expect { FA::Span.new(fa) }.to raise_error(
+        expect { FA::Span.new(fa).safe }.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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Julian Fiander