fa_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0dbacdc4e0a4e68f79cfc68e8bb41711e43300e3
+  data.tar.gz: fec55616a7eaaa224bab094b25268b47d6b025be
+SHA512:
+  metadata.gz: dd4692e88c2772c21655bd288302fa24f7e0dc89ed2e8ec25b0ba1c69085569ef657f563f498ad8ce18065f404b9a577047fd2c4f2603f724d2dbb9d4443d400
+  data.tar.gz: 25a690db403ab8e3006eca15d0bbc585a92b092a70db0293dc2ee43e6a03debdc8b980661ad8858598cbdac9fe78ffda9802f554b440d50cc1749a48e33354d0

data/.gitignore

@@ -0,0 +1,3 @@
+doc/
+coverage/
+tmp/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    fa_rails (0.1.0)
+      file_utils (~> 1.1, >= 1.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.1)
+    file_utils (1.1.2)
+    json (2.1.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fa_rails!
+  rake (~> 12.2, >= 12.2.1)
+  rspec (~> 3.7, >= 3.7.0)
+  simplecov (~> 0.15, >= 0.15.1)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,18 @@
+# FA Rails
+
+A quick helper for using FontAwesome icons in Rails.
+
+## Installation
+
+**This gem is just the code for using FontAwesome in your Rails applications.**
+
+You must still have your own FontAwesome Pro license, or install the
+[Free](https://use.fontawesome.com/releases/v5.2.0/fontawesome-free-5.2.0-web.zip)
+package.
+
+Copy the
+[web download files](https://fontawesome.com/releases/5.2.0/web/download) to the
+appropriate locations in your app:
+
+- `js` => `app/asets/javascripts`
+- `css` => `app/assets/stylesheets`

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/fa_rails.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'fa_rails'
+  s.version       = '0.1.0'
+  s.date          = '2018-07-27'
+  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'
+  s.license       = 'GPL-3.0'
+  s.authors       = ['Julian Fiander']
+  s.email         = 'julian@fiander.one'
+  s.require_paths = %w[lib spec doc]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+
+  s.required_ruby_version = '~> 2.4'
+
+  s.add_runtime_dependency 'file_utils', '~> 1.1',  '>= 1.1.2'
+
+  s.add_development_dependency 'rake',      '~> 12.2', '>= 12.2.1'
+  s.add_development_dependency 'rspec',     '~> 3.7',  '>= 3.7.0'
+  s.add_development_dependency 'simplecov', '~> 0.15', '>= 0.15.1'
+end

data/lib/font_awesome_helper.rb

@@ -0,0 +1,157 @@
+# 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)) }
+
+    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))
+  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))
+  end
+
+  private
+
+  def safe_output(output)
+    output.respond_to?(:html_safe) ? output.html_safe : output
+  end
+
+  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)
+      end
+    end
+  end
+
+  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(' ')
+
+    "<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
+
+    @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
+
+  def fa_options(options)
+    default = { style: :solid, css: '', fa: '' }
+
+    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
+    end
+  end
+
+  def combine_options(i, combined_grow)
+    if i.key?(:options)
+      i[:options].merge(grow: combined_grow)
+    else
+      { grow: combined_grow }
+    end
+  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 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_transforms(options)
+    @transforms = []
+    %i[grow shrink rotate up down left right].each do |transform|
+      if !!options[transform]
+        @transforms << "#{transform}-#{options[transform]}"
+      end
+    end
+  end
+
+  def parse_style(style)
+    return 'fas' unless %i[solid regular light brands].include?(style)
+
+    'fa' + {
+      solid: 's',
+      regular: 'r',
+      light: 'l',
+      brands: 'b'
+    }[style]
+  end
+end

data/spec/helpers/font_awesome_helper_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'font_awesome_helper'
+
+RSpec.describe do
+  include FontAwesomeHelper
+
+  describe 'icon' do
+    it 'should generate the correct icon from a string or symbol name' do
+      expect(fa_icon('help')).to eql(
+        "<i class='fas fa-help' data-fa-transform='' title=''></i>"
+      )
+
+      expect(fa_icon(: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(
+        "<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(
+          ArgumentError, 'Unexpected argument type.'
+        )
+      end
+    end
+
+    it 'should generate the correct brand icon' do
+      expect(fa_icon(:github, style: :brands)).to eql(
+        "<i class='fab fa-github' data-fa-transform='' title=''></i>"
+      )
+    end
+  end
+
+  describe 'layer' do
+    it 'should generate the correct layer from string or symbol names' do
+      icons = [
+        { name: :square },
+        { name: :circle, options: { grow: 1 } },
+        { name: 'exclamation', options: { style: :regular } }
+      ]
+
+      expect(fa_layer(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>" \
+        "<i class='far fa-exclamation' data-fa-transform='grow-2' title=''>" \
+        '</i></span>'
+      )
+    end
+
+    it 'should generate the correct layer with a span' do
+      icons = [
+        { name: :square },
+        { name: :counter, text: 17, options: { position: :tl } }
+      ]
+
+      expect(fa_layer(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' " \
+        "data-fa-transform='grow-0'>17</span></span>"
+      )
+    end
+  end
+
+  describe 'span' do
+    it 'should generate the correct span from a string or symbol type' do
+      expect(fa_span(: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(
+        "<span class='fa-layers-text fa-layers-bottom-left' " \
+        "data-fa-transform=''>World</span>"
+      )
+    end
+
+    it 'should raise ArgumentError for other input types' do
+      [nil, [], 0].each do |fa|
+        expect { fa_span(fa) }.to raise_error(
+          ArgumentError, 'Unexpected argument type.'
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+  #
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: fa_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Fiander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: file_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: A helper module for using FontAwesome icons in Rails.
+email: julian@fiander.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- fa_rails.gemspec
+- lib/font_awesome_helper.rb
+- spec/helpers/font_awesome_helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/fa_rails
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- spec
+- doc
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: FontAwesome helper for Rails
+test_files:
+- spec/helpers/font_awesome_helper_spec.rb
+- spec/spec_helper.rb