nfg_ui 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f61158331b40d623b2841200a49849f0afc8ac396b4e14d0c422d565e428276b
-  data.tar.gz: 4e662c099cdcacb5aadbaa096fc8a31d0aab5c5a9b07283fd11dd87b3d56e652
+  metadata.gz: f0724b78919c0829c296004c09b2bae90a2b0492bc4d637c28a2a4dc5c5c4d7f
+  data.tar.gz: 9e8841a495673888802bb12df9bb9d3b92b32ad7042c6a2ee458f980c189c71b
 SHA512:
-  metadata.gz: 610dc6560c3d1f3203efda9a84778921c89b75b1e4d4c347ef9057beca044f281fc6f23df9ec229988a26e3efdb2d679ef41c83c4e0a2cde18615e6cff00b3c6
-  data.tar.gz: ff44548766c96889fcf7f0a81c5bc65d52930a269f4971a686c5952e75e7d1bae70b0b1d59e5d06650654f3b7db953206754e5cd19fde0f9c5f22f0ce2c5e971
+  metadata.gz: 40b97acfd1869140887b904f0c6a275f96290f67b6dd9f0b1ddba242fc9947f429e3efdc3b5c70805e93fc5aef55d139e99cb53fc52a1981adca6f18719e5e8d
+  data.tar.gz: d4dafdd6a2f3a401266526259ddb12a773b927557f4d12c06547a034516c3cffa669b5545421227fe3dd2a6c23bd89a1579dfe657c4afd0793d2626bb329b557

data/README.md

@@ -88,6 +88,46 @@ Examples:
   = ui.nfg :icon, 'trash', class: 'mr-1', text: 'Delete Row'
 ```
 
+## Asset publishing
+
+### Depedency Installation
+
+NFG UI assets are published for cross-site usage to a publicly-accessible AWS S3 bucket (`s3://nfg-ui/v#.##.#/`) using the AWS command-line interface:
+
+1. [Install the AWS command-line interface](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-mac.html#cliv2-mac-install-gui)
+2. Install AWS credentials provided by anyone on the team who has permissions to mint IAM users (such as Mike or Timothy). The credentials are sensitive and should be stored at `~/.aws/credentials`. See example below.
+3. (Optional but recommended) Install `~/.aws/config` per below to set a default region for S3 operations.
+
+```
+# Example ~/.aws/credentials file
+
+[default]
+aws_access_key_id = ####################
+aws_secret_access_key = ########################################
+
+# Example ~/.aws/config
+[default]
+region = us-east-1
+```
+
+4. Use the following command to confirm successful installation:
+
+```
+aws s3 ls --recursive s3://nfg-ui/
+```
+
+### Workflow
+
+After `rake release` successfully completes, the `rake publish` task will run. This command wraps a separate `rake publish` task contained within the `/publisher` subdirectory.
+`/publisher` contains a skeleton Rails app. The `rake publish` task contained within `/publisher` precompiles the assets that are part of the new `nfg_ui` release and uploads them to S3. 
+
+If necessary, `rake publish` can be invoked from within the `nfg_ui` parent directory, separately:
+
+```
+rake publish           # upload assets to S3; fails if files are already exist for the release
+rake publish[override] # uploads assets to S3 without checking for existing files
+```
+
 #### Trait details
 Traits are designed to allow you to speedily build components, or pre-design complex components using meaningful symbols.
 

data/Rakefile

@@ -15,9 +15,35 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 APP_RAKEFILE = File.expand_path("spec/test_app/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
 
+load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'
 
 require 'bundler/gem_tasks'
+
+desc <<~DESC
+  Publish precompiled assets to s3://nfg-ui.  This task is automatically invoked after successful "rake release" and normally it should not be called directly.
+  Requires installation of AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html
+  Please see additional instructions in README.md.
+DESC
+task :publish, %i[override_flag] do |_, override_flag: nil|
+  require 'fileutils'
+
+  version = Bundler.load_gemspec("#{__dir__}/nfg_ui.gemspec").version
+  puts "Compiling and publishing NFG UI v#{version} assets"
+
+  subtask_args = version.to_s
+  subtask_args << ",#{override_flag}" if override_flag
+
+  Dir.chdir("#{__dir__}/publisher") do
+    Bundler.with_clean_env do
+      sh "RAILS_ENV=production bundle exec rake publish[#{subtask_args}]" do |ok, _|
+        puts 'unable to publish assets' unless ok
+      end
+    end
+  end
+end
+
+Rake::Task['release'].enhance do
+  Rake::Task['publish'].invoke # runs :publish task after successful release
+end

data/lib/nfg_ui/components/elements/avatar.rb

@@ -21,7 +21,7 @@ module NfgUi
         def render
           content_tag(as, html_options) do
             if image.present?
-              image_tag image, alt: alt.presence
+              image_tag view_context.image_path(image), alt: alt.presence
             elsif body.present?
               content_tag(:span, (block_given? ? yield : body), class: body_css_class)
             end

data/lib/nfg_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NfgUi
-  VERSION = '0.11.0'
+  VERSION = '0.11.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nfg_ui
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Jonathan Roehm
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap