ADO-2646 - FontAwesome 5 Pro

* We are looking to use pro-only FontAwesome 5 icons in an
  upcoming feature. We have a perpetual enterprise license
  for FontAwesome Pro, but we are forbidden from distributing
  the webfont files to "non-creators" in the license.
* Uploading the webfont files to this open-source package
  is considered a breach of the pro license (according to
  fontawesome support), so we need to create conditions
  to "enable" the pro icon set specifically for our
  organization's use.
* Symlink in the pro fontawesome files into
  'vendor/assets/fonts/font-awesome` when the configuration
  value of `font_awesome_pro_source_path` is provided.
* Because the files are symlinked into the vendored asset
  directory, they override the free files provided by
  the `font-awesome-sass` gem [1] in the asset pipeline.
* The `font-awesome-sass` gem does not provide unicode
  mappings for the pro-only icons. If we wish to use
  them, we need to define the unicode mapping in
  the `font_awesome_pro.scss` file.

[1]: FortAwesome/font-awesome-sass#146 (comment)
SEE: https://dev.azure.com/AMA-Ent/AMA-Ent/_workitems/edit/2646

README.md

@@ -32,6 +32,7 @@ Gem that will carry and deploy AMA assets.
 
 ```ruby
   Rails.configuration.assets.precompile += %w(shared.css)
+  Rails.configuration.font_awesome_pro_source_path = '~/source/to/font-awesome'
   Rails.configuration.stylesheet_resolver.remote = Rails.env.production?
 ```
 * Add the `ASSET_CLOUDFRONT_URL` variable to the relevant `.env` file for the application.

app/assets/stylesheets/font_awesome_pro.scss

@@ -0,0 +1,5 @@
+/*
+ * NOTE: font-awesome-sass does not define the pro-only icons. If you want
+ * use one, you must define it below.
+ */
+.#{$fa-css-prefix}-tire:before { content: fa-content(\f631); }

app/assets/stylesheets/shared.scss

@@ -2,6 +2,7 @@
 @import "webfonts/index";
 @import "font-awesome-sprockets";
 @import "font-awesome";
+@import "font_awesome_pro";
 @import "foundation_and_overrides";
 @import "foundation";
 @import "layout/index";

lib/ama/styles/engine.rb

@@ -17,12 +17,17 @@ class Engine < ::Rails::Engine
       end
 
       config.after_initialize do |app|
+        # are we using bundled assets? (i.e. dev/local)
         if app.config.stylesheet_resolver.local? && Rails.env.development?
-          if !app.root.join('vendor', 'assets', 'fonts', 'font-awesome').exist?
-            Rake::Task['assets:fa5_pro'].invoke(
-              '~/src/rails_envs/font-awesome',
-              app.root.to_s
-            )
+          # is a source location provided for the font awesome pro font files?
+          if app.config.font_awesome_pro_source_path.present?
+            # are there already pro files in the application asset folder?
+            if !app.root.join('vendor', 'assets', 'fonts', 'font-awesome').exist?
+              Rake::Task['assets:fa5_pro'].invoke(
+                app.config.font_awesome_pro_source_path,
+                app.root.to_s
+              )
+            end
           end
         end
       end

lib/ama/styles/internal/deployment.rb

@@ -14,11 +14,11 @@ class Deployment
 
         def run
           sprockets_tasks
-          # upload_files
+          upload_files
           log('Generating fallback stylesheet...'.colorize(:yellow))
-          # upload_fallback_stylesheet
+          upload_fallback_stylesheet
           log('Verifying S3 integrity...'.colorize(:yellow))
-          # request
+          request
           log('SUCCESS!'.colorize(:green) + ' 🎨')
         end
 
@@ -49,10 +49,12 @@ def log(msg)
 
         def precompile_assets
           Rake::Task['assets:copy_raw_assets'].invoke
-          Rake::Task['assets:fa5_pro'].invoke(
-            '~/src/rails_envs/ama_styles',
-            GEM_ROOT_PATH
-          )
+          if (font_awesome_pro?)
+            Rake::Task['assets:fa5_pro'].invoke(
+              Rails.configuration.font_awesome_pro_source_path,
+              GEM_ROOT_PATH
+            )
+          end
           Rake::Task['assets:precompile'].invoke
         end
 
@@ -70,6 +72,10 @@ def assets_files
           end
         end
 
+        def font_awesome_pro?
+          Rails.configuration.font_awesome_pro_source_path.present?
+        end
+
         def upload_files
           assets_files.each do |file|
             path = Pathname.new(file)

lib/ama/styles/internal/environment.rb

@@ -60,6 +60,7 @@ def configure_assets
           config.eager_load = false
           config.assets.css_compressor = :sass
           config.assets.precompile += %w[shared.css]
+          config.font_awesome_pro_source_path = ENV['FONT_AWESOME_PRO_SOURCE_PATH']
         end
 
         def configure_api

lib/ama/styles/version.rb

@@ -2,6 +2,6 @@
 
 module AMA
   module Styles
-    VERSION = '2.9.0'
+    VERSION = '3.0.0'
   end
 end