bankrupt 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13362fcd14a5a3f976a5de6a3055f7f6b7d208e4fdb2e5dffae4e9b41ff13b90
-  data.tar.gz: 9316fbd60714bdf91517690def44d1ded019fd16b44a1359343931bf42bf4eca
+  metadata.gz: b7605a8034097043298a51ba0cea61725c7befef7e7c1456c5dfa80cdeb500a6
+  data.tar.gz: cde2061f0af7b265d5d7cf347318598c2ea8145d566d9fcfed48b4cf4814f492
 SHA512:
-  metadata.gz: be6cb9347bcd9b34994dfe32922428eeb2aab18c65848f1466de412f6c381443ddacf4ab6c7fe5fe579446adfd8aedbf440a4afe113100781cd083bf43fd07f8
-  data.tar.gz: 78cd04a3fa41eef143431ac56a860a94d70757fe125e9b844f48d7599abdbd79abe10f56234fb2fc17832eaec6bb56320256e0cb0cde2d22090359fe9e3bf2cf
+  metadata.gz: d392a244a8aebfbd509e9af128b14795aaf241d6c75b10db9794579f5bb2cbd18e6664b248ac82b39f77d972503438dbbe9d56285e10adbc42c01df5ac2f48c4
+  data.tar.gz: bfba6c8fd639df3b8a5f9dcf3a80f3e62893a1dea003e0087ebda7ed7feff1b308935880ade03de7a859e5f6964587058c9c2f48b2c31eaddc789dfc8b391afa

data/.github/workflows/default.yml

@@ -0,0 +1,23 @@
+---
+name: CI
+on: push
+
+jobs:
+  main:
+    name: ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: bundle exec rubocop
+      - run: bundle exec rspec
+      - run: bundle exec yard
+      - run: gem build bankrupt.gemspec

data/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+---
+name: Publish Rubygem
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  main:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+      - run: gem build bankrupt.gemspec
+
+      - name: setup credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GH_API_KEY}\n" > $HOME/.gem/credentials
+          printf -- ":rubygems_api_key: ${RUBYGEMS_API_KEY}\n" >> $HOME/.gem/credentials
+        env:
+          GH_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+
+      - name: publish to rubygems
+        run: |
+          gem push *.gem
+      - name: publish to github packages
+        run: |
+          gem push --key github --host https://rubygems.pkg.github.com/${{ github.repository_owner }} *.gem

data/.rubocop.yml

@@ -1,25 +1,35 @@
 ---
-require: rubocop-rspec
+require:
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.4.0
+  NewCops: enable
+  TargetRubyVersion: 2.5.0
 
 Layout/ExtraSpacing:
   AllowForAlignment: false
 
-Metrics/BlockLength:
+Layout/LineLength:
   Max: 80
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 100
   Exclude:
     - 'spec/**/*_spec.rb'
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 
 RSpec/DescribeClass:
   Exclude:
     - 'spec/bankrupt/tasks_spec.rb'
 
 RSpec/ExampleLength:
+  Max: 6
   Exclude:
     - 'spec/bankrupt/tasks_spec.rb'
 
@@ -32,3 +42,6 @@ RSpec/MultipleExpectations:
 
 RSpec/NestedGroups:
   Max: 6
+
+RSpec/StubbedMock:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -3,6 +3,28 @@
 This file keeps track of changes between releases for the bankrupt project
 which adheres to [semantic versioning](https://semver.org).
 
+## v3.0.0 2021-08-21
+
+* Drop support for ruby 2.4.x.
+* Mark uploaded assets as `immutable` in the `Cache-Control` header.
+
+## v2.1.2 2020-01-20
+
+Take options into account to ensure unique asset lookups.
+
+## v2.1.1 2020-01-09
+
+Ensure that the `purge` task works with hashless assets.
+
+## 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

@@ -1,7 +1,7 @@
 # Bankrupt
 
 [![RubyGems](https://img.shields.io/gem/v/bankrupt.svg)](https://rubygems.org/gems/bankrupt)
-[![Build Status](https://travis-ci.org/mfinelli/bankrupt.svg?branch=master)](https://travis-ci.org/mfinelli/bankrupt)
+![Build Status](https://github.com/mfinelli/bankrupt/workflows/CI/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/mfinelli/bankrupt/badge.svg?branch=master)](https://coveralls.io/github/mfinelli/bankrupt?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f13a4521623d19c8eb4a/maintainability)](https://codeclimate.com/github/mfinelli/bankrupt/maintainability)
 [![Inline docs](http://inch-ci.org/github/mfinelli/bankrupt.svg?branch=master)](http://inch-ci.org/github/mfinelli/bankrupt)
@@ -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-2021 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/bankrupt.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Load files from local disk or from a CDN in production.'
   spec.homepage = 'https://github.com/mfinelli/bankrupt'
   spec.license = 'Apache-2.0'
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard'

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.
@@ -49,9 +49,6 @@ module Bankrupt
   #
   # @todo we compute the options on every call, we should do the
   #        lookup first and short circuit
-  # @todo lookup needs to be based on path _and_ options so that the
-  #        same asset can be used in multiple places with e.g. different
-  #        css classes applied
   #
   # @param path [String] relative (from public) path to the img
   # @param options [Hash] additional attributes to add to the img tag
@@ -60,7 +57,7 @@ module Bankrupt
     o = Hash(options).map { |k, v| "#{k}='#{v}'" }.join(' ')
 
     asset_html(path, [IMAGE_CDN.chomp, o].join(' '),
-               [IMAGE_LOCAL.chomp, o].join(' '))
+               [IMAGE_LOCAL.chomp, o].join(' '), options)
   end
 
   # Return a javascript html tag for the asset.
@@ -79,14 +76,30 @@ 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], hashless: details[:hashless])
+  rescue KeyError
+    "/#{path}"
+  end
+
   private
 
   # Return a precomputed asset path if it exists
   #
   # @param path [String] asset on which to perform the lookup
+  # @param options [String] the options string to use in the lookup
   # @return [String] the rendered slim template with the asset in place
-  def lookup(path)
-    @_assets.fetch(path)
+  def lookup(path, options = nil)
+    if actual_options?(options)
+      @_assets.fetch([path, options].join('?'))
+    else
+      @_assets.fetch(path)
+    end
   rescue KeyError
     nil
   end
@@ -95,19 +108,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: hashless)].join('/')
   end
 
   # Generate the asset HTML. If the asset exists in the lookup hash then
@@ -116,24 +135,57 @@ module Bankrupt
   # @param path [String] relative path to the asset
   # @param cdn [String] a slim template for generating a cdn asset
   # @param local [String] a slim template for generating a local asset
+  # @param options [String] options as a string to make unique lookups
   # @return [String] the asset html
-  def asset_html(path, cdn, local)
-    if (asset = lookup("/#{path}"))
+  def asset_html(path, cdn, local, options = nil)
+    opts = options_string(options)
+
+    if (asset = lookup("/#{path}", opts))
       return asset
     end
 
+    lookup_path = "/#{actual_options?(opts) ? [path, opts].join('?') : path}"
+
     begin
       details = ASSETS.fetch(path)
 
-      fullpath = create_fullpath(path, details[:md5])
+      fullpath = create_fullpath(path, details[:md5],
+                                 hashless: details[:hashless])
 
-      @_assets["/#{path}"] = Slim::Template.new { cdn }.render(
+      @_assets[lookup_path] = Slim::Template.new { cdn }.render(
         ASSET.new(fullpath, details[:sri])
       )
     rescue KeyError
-      @_assets["/#{path}"] = Slim::Template.new { local }.render(
+      @_assets[lookup_path] = Slim::Template.new { local }.render(
         ASSET.new("/#{path}", nil)
       )
     end
   end
+
+  # Turn the options hash into a concatenated string for use in the lookup.
+  #
+  # @param options [Hash] the options has to convert
+  # @return [String] concatenated options suitable for use in lookups
+  def options_string(options)
+    return nil if Hash(options).size.zero?
+
+    options.map do |k, v|
+      [k.to_s, v.to_s].join
+    end.join.gsub(/[^A-Za-z0-9\-_]/, '')
+  end
+
+  # Determine if we actually have options regardless if input is a string,
+  # hash, or nil.
+  #
+  # @param options [String, Hash] options to check
+  # @return [Boolean] true if there are options, false otherwise
+  def actual_options?(options)
+    return false if options.nil?
+
+    if (options.is_a?(String) || options.is_a?(Hash)) && !options.size.zero?
+      true
+    else
+      false
+    end
+  end
 end

data/lib/bankrupt/tasks.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018-2019 Mario Finelli
+# Copyright 2018-2021 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,18 +32,22 @@ 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]),
         content_length: File.size(f),
         content_type: MiniMime.lookup_by_filename(f).content_type,
-        cache_control: 'public, max-age=31536000',
+        cache_control: 'public, max-age=31536000, immutable',
         server_side_encryption: 'AES256',
         storage_class: 'STANDARD',
         metadata: {
@@ -63,11 +68,15 @@ namespace :bankrupt do
 
     local = JSON.parse(File.read(File.join(APP_ROOT, 'tmp', 'assets.json')),
                        symbolize_names: true).map do |_key, asset|
-      File.join(
-        CDN_PREFIX,
-        [[asset[:filename].split(ex = File.extname(asset[:filename])).first,
-          asset[:md5]].join('-'), ex].join
-      )
+      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
     end
 
     if local.empty?
@@ -90,15 +99,22 @@ 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}'
+
+    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)) do |file|
+    Dir.glob(File.join(APP_ROOT, 'public', file_glob)).sort.each do |file|
       md5 = Digest::MD5.file(file).to_s
       basename = File.basename(file)
 
       # undo the hash that we have webpack insert (but is important so the
       # final css uses the correct path)
-      if basename.match?(/\-#{md5}\.#{File.extname(file).delete('.')}$/)
+      if basename.match?(/-#{md5}\.#{File.extname(file).delete('.')}$/)
         File.rename(file,
                     (file = File.join(
                       File.dirname(file),
@@ -110,8 +126,18 @@ namespace :bankrupt do
         filename: basename,
         md5: md5,
         babble: Digest::MD5.file(file).bubblebabble,
-        sri: 'sha384-' + Digest::SHA384.file(file).base64digest.to_s
+        sri: "sha384-#{Digest::SHA384.file(file).base64digest}"
       }
+
+      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/util.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018 Mario Finelli
+# Copyright 2018-2021 Mario Finelli
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,9 +22,9 @@ module Bankrupt
     # @param path [String] path to the manifest
     # @return [Hash] parsed manifest or empty hash on error
     def self.parse_manifest(path)
-      Hash[JSON.parse(File.read(path)).map do |k, v|
-        [k.freeze, Hash[v.map { |l, b| [l.to_sym, b.freeze] }].freeze]
-      end].freeze
+      JSON.parse(File.read(path)).map do |k, v|
+        [k.freeze, v.map { |l, b| [l.to_sym, b.freeze] }.to_h.freeze]
+      end.to_h.freeze
     rescue StandardError
       {}
     end

data/lib/bankrupt/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2018-2019 Mario Finelli
+# Copyright 2018-2021 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 = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bankrupt
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Mario Finelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2021-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -156,6 +156,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -206,10 +220,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/default.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -231,14 +247,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A sinatra helper to load assets locally and production.

data/.travis.yml

@@ -1,20 +0,0 @@
----
-sudo: false
-
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-
-before_install:
-  - gem update --system
-  - gem --version
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec
-  - bundle exec yard
-
-notifications:
-  email: false