bankrupt 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13362fcd14a5a3f976a5de6a3055f7f6b7d208e4fdb2e5dffae4e9b41ff13b90
-  data.tar.gz: 9316fbd60714bdf91517690def44d1ded019fd16b44a1359343931bf42bf4eca
+  metadata.gz: 4b25ac977ea77fe68e18e583a9d6bab35e234c99684a07b49afd9d74e58292d7
+  data.tar.gz: ec15d4467fc340e988992495526dd6f006964d4a8359928bd894598b41913c9b
 SHA512:
-  metadata.gz: be6cb9347bcd9b34994dfe32922428eeb2aab18c65848f1466de412f6c381443ddacf4ab6c7fe5fe579446adfd8aedbf440a4afe113100781cd083bf43fd07f8
-  data.tar.gz: 78cd04a3fa41eef143431ac56a860a94d70757fe125e9b844f48d7599abdbd79abe10f56234fb2fc17832eaec6bb56320256e0cb0cde2d22090359fe9e3bf2cf
+  metadata.gz: b2ab7eaaf4e1d6fb2fc51d885ad3858ee6a432eb784f908fd9bc90c832ffe2fc48a1af0b628354edf4953aea0c34765797e73f56e67d5325b96f903ec51a34d9
+  data.tar.gz: 9c18b7c507883b9f3ce121339f6b951f51ddfaf32f7b24ef014fbe03ac5a242fdfb3a6e560ce0f8748ee43824bbfa69f753556e330d3fadc7d9654eed8c1bcfd

data/.rubocop.yml

@@ -8,7 +8,7 @@ Layout/ExtraSpacing:
   AllowForAlignment: false
 
 Metrics/BlockLength:
-  Max: 80
+  Max: 100
   Exclude:
     - 'spec/**/*_spec.rb'
 

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 before_install:
   - gem update --system

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 This file keeps track of changes between releases for the bankrupt project
 which adheres to [semantic versioning](https://semver.org).
 
+## v2.1.0 2020-01-06
+
+Add support for unversioned ("hashless") assets.
+
+* Add new configuration file and `hashless` option (file glob array) to upload
+  files to the CDN without their md5 hash appended.
+* Add new `raw` helper to just return the full URL of an asset.
+* Add upload support for PDF files.
+
 ## v2.0.1 2019-07-30
 
 Add support for uploading font files (`eot`, `ttf`, `woff`, and `woff2`) to

data/README.md

@@ -62,7 +62,14 @@ For images you can optionally pass a hash of options to apply additional
 attributes to the image:
 
 ```slim
-== image(img.jpg, alt: 'img')
+== image('img.jpg', alt: 'img')
+```
+
+To get the full path of an asset:
+
+```slim
+a href=raw('file.pdf')
+  | Click me!
 ```
 
 ### Rake
@@ -107,6 +114,17 @@ task default: if ENV['CLOUDBUILD'].to_s.casecmp?('true')
               end
 ```
 
+Note that it's possible to upload some files to the CDN _without_ their hash
+appended. Create a `.bankrupt.yml` file in the root of your project and provide
+an array of file globs to store "hashless":
+
+```yaml
+---
+hashless:
+  - "*.pdf"
+  - "image.png"
+```
+
 ### Rspec
 
 If you're testing your app with rspec or similar you need to stub the `CDN` and
@@ -138,7 +156,7 @@ end
 ## License
 
 ```
-Copyright 2018 Mario Finelli
+Copyright 2018-2020 Mario Finelli
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/bankrupt.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018-2019 Mario Finelli
+# Copyright 2018-2020 Mario Finelli
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -79,6 +79,17 @@ module Bankrupt
     asset_html(path, STYLESHEET_CDN, STYLESHEET_LOCAL)
   end
 
+  # Get the full path to the asset for use in e.g. a tags.
+  #
+  # @param path [String] relative (from public) path to the asset
+  # @return [String] full path to the asset
+  def raw(path)
+    details = ASSETS.fetch(path)
+    create_fullpath(path, details[:md5], details[:hashless])
+  rescue KeyError
+    "/#{path}"
+  end
+
   private
 
   # Return a precomputed asset path if it exists
@@ -95,19 +106,25 @@ module Bankrupt
   #
   # @param file [String] basename of the asset
   # @param digest [String] md5 hash of the asset
-  # @return [String] filename with digest e.g, style-123.css
-  def append_md5(file, digest)
+  # @param hashless [Boolean] if the file doesn't have the hash appended
+  # @return [String] filename with digest e.g, style-123.css (style.css if
+  #                  hashless)
+  def append_md5(file, digest, hashless = false)
+    return file if hashless
+
     [[file.split(ex = File.extname(file)).first, digest].join('-'), ex].join
   end
 
   # Generates the full path to the asset including CDN domain, if set.
   #
   # @param path [String] local path to the asset
+  # @param md5 [String] md5 hash of the asset
+  # @param hashless [Boolean] if the files doesn't have the hash appended
   # @return [String] new, full path to the asset
-  def create_fullpath(path, md5)
+  def create_fullpath(path, md5, hashless = false)
     return "/#{path}" if CDN.empty?
 
-    [CDN, append_md5(path, md5)].join('/')
+    [CDN, append_md5(path, md5, hashless)].join('/')
   end
 
   # Generate the asset HTML. If the asset exists in the lookup hash then
@@ -125,7 +142,7 @@ module Bankrupt
     begin
       details = ASSETS.fetch(path)
 
-      fullpath = create_fullpath(path, details[:md5])
+      fullpath = create_fullpath(path, details[:md5], details[:hashless])
 
       @_assets["/#{path}"] = Slim::Template.new { cdn }.render(
         ASSET.new(fullpath, details[:sri])

data/lib/bankrupt/tasks.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018-2019 Mario Finelli
+# Copyright 2018-2020 Mario Finelli
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ require 'fileutils'
 require 'json'
 require 'mini_mime'
 require 'rake'
+require 'yaml'
 
 namespace :bankrupt do
   desc 'Upload files specified in the manifest to s3/cloudfront'
@@ -31,12 +32,16 @@ namespace :bankrupt do
                symbolize_names: true).each do |_key, asset|
       r = s3.put_object(
         bucket: CDN_BUCKET,
-        key: File.join(CDN_PREFIX,
-                       [[
-                         asset[:filename].split(
-                           ex = File.extname(asset[:filename])
-                         ).first, asset[:md5]
-                       ].join('-'), ex].join),
+        key: if asset[:hashless]
+               File.join(CDN_PREFIX, asset[:filename])
+             else
+               File.join(CDN_PREFIX,
+                         [[
+                           asset[:filename].split(
+                             ex = File.extname(asset[:filename])
+                           ).first, asset[:md5]
+                         ].join('-'), ex].join)
+             end,
         body: File.read(f = File.join(APP_ROOT, 'public', asset[:filename])),
         acl: 'private',
         # content_md5: Base64.strict_encode64(asset[:md5]),
@@ -90,9 +95,16 @@ namespace :bankrupt do
   desc 'Generate an asset manifest file with sums and hashes'
   task :manifest do
     manifest = {}
-    file_glob = '*.{css,jpg,js,png,svg,eot,ttf,woff,woff2}'
+    file_glob = '*.{css,jpg,js,pdf,png,svg,eot,ttf,woff,woff2}'
 
-    Dir.glob(File.join(APP_ROOT, 'public', file_glob)) do |file|
+    config = begin
+               YAML.safe_load(File.read(File.join(APP_ROOT, '.bankrupt.yml')),
+                              [], [], true, symbolize_names: true)
+             rescue Errno::ENOENT
+               {}
+             end
+
+    Dir.glob(File.join(APP_ROOT, 'public', file_glob)).sort.each do |file|
       md5 = Digest::MD5.file(file).to_s
       basename = File.basename(file)
 
@@ -112,6 +124,16 @@ namespace :bankrupt do
         babble: Digest::MD5.file(file).bubblebabble,
         sri: 'sha384-' + Digest::SHA384.file(file).base64digest.to_s
       }
+
+      Array(config[:hashless]).each do |match|
+        # skip unless the file is in a "hashless" glob
+        next unless Dir.glob(File.join(APP_ROOT, 'public', match)).map do |f|
+                      File.basename(f)
+                    end.include?(basename)
+
+        manifest[basename][:hashless] = true
+        break
+      end
     end
 
     LOG.info "Generated asset manifest with #{manifest.keys.size} entries"

data/lib/bankrupt/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018-2019 Mario Finelli
+# Copyright 2018-2020 Mario Finelli
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,5 +15,5 @@
 # limitations under the License.
 
 module Bankrupt
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bankrupt
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Mario Finelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim