fa_rails 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bedbb3b52f82b24d5ef7d78088141fcf16710258
-  data.tar.gz: aad0ad0db36223df9317c8fe54d0a61a879a5ba1
+  metadata.gz: 1ac5856744bf6210fbf8d25ad918d04b1400e4b6
+  data.tar.gz: 434637241dbce4c9b753f0190b9ac5bc98093f1a
 SHA512:
-  metadata.gz: 2ac8ff919be13408c0c1093bfc260eb6eb86b532b90236c5e7cf4234eb1b35ab1764a903641f256ac0dbe2d228918d2bf155eb5c22d6e02f9d197342bb09e777
-  data.tar.gz: dff2c8aa2b9ea64e4924d241ff4fd0922bf52747fd63a37b223765b97e0917d3c14b9891a3590c3977a5537c6d11285f238ed202c2efa3af8a086b641b32e0a8
+  metadata.gz: e4597b5992842776f509f9c43509df54e89d6a13658c9018b94e25fc168c41121ce6217b5682870066901183718ecb987a712570c21029a6d57617cac7171fed
+  data.tar.gz: 0613746247f5dc8a6d86e76a7ee4548c7441e3f62b65301bcfdcd857e3a2f6d85739b9d7ef829373e0612131c288cda0365c3fafb20ef55714cdc52a97e34a35

data/Gemfile.lock

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

data/README.md

@@ -136,24 +136,29 @@ css # String – arbitrary CSS classes, space-delimited, applied to the layer st
 ```ruby
 # Fixed-width lock icon
 FA::Icon.p('lock', fa: 'fw')
-#=> "<i class='fas fa-fw fa-lock' data-fa-transform='' title=''></i>"
+#=> "<i class='fas fa-fw fa-lock fa-1x' data-fa-transform='' title=''></i>"
 
 # Counter span, with value 5
 FA::Span.p('counter', 5)
-#=> "<span class='fa-layers-counter ' data-fa-transform=''>5</span>
+#=> "<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.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>" \
+#   "<i class='fas fa-stack-1x gray fa-envelope fa-1x' data-fa-transform='grow-0' title='Invalid email address'></i>" \
+#   "<i class='fas fa-stack-1x red fa-exclamation fa-1x' data-fa-transform='grow-0' title='Invalid email address'></i>" \
 #   "</span>"
 
 # Blue envelope with red counter on the top left corner, with value 7
 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" \
-#   "</span>" \
+#   "<i class='fas fa-stack-1x blue fa-envelope fa-1x' data-fa-transform='grow-0' title=''></i>" \
+#   "<span class='fa-stack-1x red fa-layers-counter fa-layers-top-left' data-fa-transform='grow-0'>7</span>" \
 #   "</span>"
+
+# The same stack, but using FA::Build
+FA::Build.p do |b|
+  b.icon('circle')
+  b.span('counter', 7)
+end
 ```

data/fa_rails.gemspec

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module FA
+  # FontAwesome 5 (Pro) Helper for piecewise building layered icons and spans
+  class Build < FA::Layer
+    # Creates a new Layer instance
+    #
+    # Add icons or spans to the stack from bottom to top
+    #
+    # This is a variand of FA::Layer, to allow for DSL building stacks
+    #
+    # Note: scaling counters does not work well with :grow, so should use the
+    # older "fa-3x" syntax in :css instead.
+    #
+    # @param [Array] icons The complete hash configurations for each icon/span
+    # @param [String] title The tooltip text
+    # @param [Integer] grow An additional global scaling factor added in
+    # @param [String] css Additional arbitrary CSS classes, space-delimited
+    def initialize(icons = {}, title: nil, grow: 0, css: '')
+      super
+      @contents = ''
+      yield(self) if block_given?
+    end
+
+    # Outputs the formatted stack of icons and spans directly.
+    def raw
+      build { @contents }
+    end
+
+    # Adds an icon to the stack using the same argument format.
+    def icon(icon, **options)
+      @contents += FA::Icon.p(icon, full_options(options))
+      self
+    end
+
+    # Adds a span to the stack using the same argument format.
+    def span(type, text, **options)
+      @contents += FA::Span.p(type, text, full_options(options))
+      self
+    end
+
+    # Shortcut for create and output safe
+    def self.p(*args, &block)
+      new(*args, &block).safe
+    end
+
+    private
+
+    def default_options
+      { title: @title, grow: @grow, css: @css, size: 1, fa: '' }
+    end
+
+    def full_options(options)
+      options = default_options.merge(options)
+      options[:fa] += " stack-#{options[:size]}x"
+      options
+    end
+  end
+end

data/lib/fa/layer.rb

@@ -23,16 +23,19 @@ module FA
 
     # Outputs the formatted stack of icons and spans directly.
     def raw
-      span_top = "<span class='icon fa-layers fa-stack fa-fw #{@css}' " \
-        "title='#{@title}'>"
-      span_bottom = '</span>'
-
       @icons.each do |i|
         i[:options] = combine_options(i, combine_grows(i, @grow))
         i[:options][:title] = @title
       end
 
-      span_top + parse_all(@icons).join + span_bottom
+      build { parse_all(@icons).join }
+    end
+
+    private
+
+    def build
+      "<span class='icon fa-layers fa-stack fa-fw #{@css}' " \
+      "title='#{@title}'>#{yield}</span>"
     end
   end
 end

data/lib/fa.rb

@@ -9,5 +9,6 @@ module FA
   require 'fa/icon'
   require 'fa/span'
   require 'fa/layer'
+  require 'fa/build'
   require 'fa/link'
 end

data/spec/lib/fa_spec.rb

@@ -91,6 +91,22 @@ RSpec.describe FA do
     end
   end
 
+  describe 'build' do
+    it 'should generate the correct layer' do
+      layer = FA::Build.p do |b|
+        b.icon('circle')
+        b.span('counter', 7)
+      end
+
+      expect(layer).to eql(
+        "<span class='icon fa-layers fa-stack fa-fw ' title=''>" \
+        "<i class='fas fa-stack-1x fa-circle fa-1x' data-fa-transform='grow-0' title=''></i>" \
+        "<span class='fa-stack-1x fa-layers-counter ' data-fa-transform='grow-0'>7</span>" \
+        '</span>'
+      )
+    end
+  end
+
   describe 'span' do
     it 'should generate the correct span from a string or symbol type' do
       expect(FA::Span.p(:text, 'Hello')).to eql(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fa_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Julian Fiander
@@ -85,6 +85,7 @@ files:
 - fa_rails.gemspec
 - lib/fa.rb
 - lib/fa/base.rb
+- lib/fa/build.rb
 - lib/fa/icon.rb
 - lib/fa/layer.rb
 - lib/fa/link.rb