bankrupt 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683171c662debe1e9b1997633f30aa5b7d9cae6302c67e58db0435b225edcf3f
-  data.tar.gz: a99edeb946348365e9e78cf715482b8402df6711774e481270918ae7363e9a96
+  metadata.gz: 9881aed762cf1b7c364718161f3432a0dc0cadd735a56452f0783f915f8152ac
+  data.tar.gz: 342de62d65f9321e759d8f919942526ef2894cb995f134ea21aec08ea877b50a
 SHA512:
-  metadata.gz: d167fd1aa94bef42993071c7fc9700f87c1cd70952b970cc00276b5e19f4476170b7cf56e82f37dd7ed331ecea66704253468b4c552b356e83c95ec7b6fc747b
-  data.tar.gz: 5134e5f34bf084d11cfbaa694a8a747616dca77892e0a22d81513ccceb259ee79c1f7a6d7730ba589ee4aa615bc9a124daac7ef9dd2728c828795884e5c34a7a
+  metadata.gz: d09c883f9d5244e44297a62442516043bad996cc557551bc2470e6b7b9d0a62cf86d93c07862f2fea6ffa361634fb9386ea48e675c301657cfad2a51937f6508
+  data.tar.gz: 2ea0da6c668536fa73de4ee9760762425ca7d7c733a6fe7efaffcb569ed2a798f8748f7c84c6cf4cdeabea8ace5fc22c6dbf106e265e7a5b9a305390655e5348

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

@@ -1,3 +1,8 @@
 /.bundle
+/.yardoc
+/coverage
+/doc
 /Gemfile.lock
 /vendor/bundle
+/*.gem
+/*.gem.asc

data/.rubocop.yml

@@ -0,0 +1,23 @@
+---
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3.7
+
+Layout/ExtraSpacing:
+  AllowForAlignment: false
+
+Metrics/BlockLength:
+  Max: 60
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/bankrupt/util_spec.rb'
+
+Metrics/MethodLength:
+  Max: 15
+
+RSpec/NestedGroups:
+  Max: 5

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Bankrupt Change Log
+
+This file keeps track of changes between releases for the bankrupt project
+which adheres to [semantic versioning](https://semver.org).
+
+## v1.0.0 2018-08-10
+
+First stable release. Combines all old, internal code (rake tasks, helper
+module) with new updates (modification for public release, utility methods).
+
+* Add rake task for generating manifest files.
+* Add rake task for uploading assets to AWS s3 bucket.
+* Add utility method for parsing manifest files.
+
+## v0.1.0 2018-07-25
+
+Initial release.

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -1,4 +1,103 @@
 # 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)
+[![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)
+
 A [sinatra](http://sinatrarb.com) helper to path assets during development and
 production.
+
+## Usage
+
+### Sinatra
+
+Before loading your app set a few constants:
+
+```ruby
+CDN = CONFIG[:cdn_url].to_s.freeze
+
+require 'bankrupt/util'
+ASSETS = Bankrupt::Util.parse_manifest(
+  File.join(APP_ROOT, 'tmp', 'assets.json')
+).freeze
+```
+
+Then include bankrupt as a helper in your app:
+
+```ruby
+require 'bankrupt'
+
+class App < Sinatra::Base
+  set :public_folder, File.join(APP_ROOT, 'public')
+
+  helpers Bankrupt
+
+  # TODO: there is a better way to do this
+  def initialize
+    @_assets = {}
+    super
+  end
+end
+```
+
+### Rake
+
+You can use the bundled rake task to generate the manifest file in the correct
+format using any assets found in the `public` folder. You can also upload the
+assets to an s3 bucket for use with cloudfront as a CDN.
+
+Make sure to add the extra dependencies to your gemfile:
+
+```ruby
+gem 'aws-sdk-s3'
+gem 'mini_mime'
+```
+
+In your rakefile you'll need to define several constants and then include
+the tasks:
+
+```ruby
+require 'bankrupt/tasks'
+require 'logger'
+
+APP_ROOT = __dir__.freeze unless defined?(APP_ROOT)
+CDN_BUCKET = 'your-s3-bucket'.freeze unless defined?(CDN_BUCKET)
+CDN_PREFIX = 'project'.freeze unless defined?(CDN_PREFIX)
+
+unless defined?(VERSION)
+  VERSION = JSON.parse(File.read(File.join(APP_ROOT, 'package.json')),
+                       symbolize_names: true).fetch(:version).freeze
+end
+
+LOG = Logger.new(STDOUT) unless defined?(LOG)
+```
+
+Finally set your default task:
+
+```ruby
+task default: if ENV['CLOUDBUILD'].to_s.casecmp?('true')
+                %i[bankrupt:cdn]
+              else
+                %i[bankrupt:manifest]
+              end
+```
+
+## License
+
+```
+Copyright 2018 Mario Finelli
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

data/bankrupt.gemspec

@@ -1,26 +1,38 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "bankrupt/version"
+require 'bankrupt/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bankrupt"
-  spec.version       = Bankrupt::VERSION
-  spec.authors       = ["Mario Finelli"]
-  spec.email         = ["mario@finel.li"]
+  spec.name = 'bankrupt'
+  spec.version = Bankrupt::VERSION
+  spec.authors = ['Mario Finelli']
+  spec.email = ['mario@finel.li']
 
-  spec.summary       = %q{A sinatra helper to load assets in development and production.}
-  spec.description   = %q{This gem loads files from disk locally and from a CDN in production.}
-  spec.homepage      = "https://github.com/mfinelli/bankrupt"
-  spec.license       = "Apache-2.0"
+  spec.summary = 'A sinatra helper to load assets locally and production.'
+  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.3.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
+  # spec.add_dependency 'aws-sdk-s3', '~> 1.0'
+  # spec.add_dependency 'mini_mime', '~> 1.0'
   spec.add_dependency 'slim', '~> 3.0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

data/lib/bankrupt.rb

@@ -1,3 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Mario Finelli
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'slim'
+
+# Read assets from a local cache, using files on disk for development and
+# from a CDN url if the CDN constant is set.
 module Bankrupt
   ASSET = Struct.new(:path, :sri).freeze
 

data/lib/bankrupt/tasks.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Mario Finelli
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'aws-sdk-s3'
+require 'base64'
+require 'digest/bubblebabble'
+require 'fileutils'
+require 'json'
+require 'mini_mime'
+require 'rake'
+
+namespace :bankrupt do
+  desc 'Upload files specified in the manifest to s3/cloudfront'
+  task cdn: [:manifest] do
+    s3 = Aws::S3::Client.new(region: 'eu-west-1')
+
+    JSON.parse(File.read(File.join(APP_ROOT, 'tmp', 'assets.json')),
+               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),
+        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,
+        server_side_encryption: 'AES256',
+        storage_class: 'STANDARD',
+        metadata: {
+          bankruptVersion: "v#{VERSION}"
+        }
+      )
+
+      LOG.info "Uploaded #{asset[:filename]} (#{r.etag})"
+    end
+  end
+
+  desc 'Generate an asset manifest file with sums and hashes'
+  task :manifest do
+    manifest = {}
+    file_glob = '*.{css,jpg,js,png,svg}'
+
+    Dir.glob(File.join(APP_ROOT, 'public', file_glob)) 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('.')}$/)
+        File.rename(file,
+                    (file = File.join(
+                      File.dirname(file),
+                      (basename = basename.gsub("-#{md5}", ''))
+                    )))
+      end
+
+      manifest[basename] = {
+        filename: basename,
+        md5: md5,
+        babble: Digest::MD5.file(file).bubblebabble,
+        sri: 'sha384-' + Digest::SHA384.file(file).base64digest.to_s
+      }
+    end
+
+    LOG.info "Generated asset manifest with #{manifest.keys.size} entries."
+
+    FileUtils.mkdir_p(File.join(APP_ROOT, 'tmp'))
+    File.write(File.join(APP_ROOT, 'tmp', 'assets.json'),
+               JSON.generate(manifest))
+  end
+end

data/lib/bankrupt/util.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Mario Finelli
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Bankrupt
+  # Utilities for working with asset manifest files.
+  class Util
+    # Parse the asset manifest
+    #
+    # @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
+    rescue StandardError
+      {}
+    end
+  end
+end

data/lib/bankrupt/version.rb

@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Mario Finelli
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 module Bankrupt
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bankrupt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mario Finelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -28,44 +28,148 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: pry
+  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: '1.16'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        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
+  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
+    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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
-description: This gem loads files from disk locally and from a CDN in production.
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+description: Load files from local disk or from a CDN in production.
 email:
 - mario@finel.li
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - bankrupt.gemspec
 - lib/bankrupt.rb
+- lib/bankrupt/tasks.rb
+- lib/bankrupt/util.rb
 - lib/bankrupt/version.rb
 homepage: https://github.com/mfinelli/bankrupt
 licenses:
@@ -79,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -90,5 +194,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A sinatra helper to load assets in development and production.
+summary: A sinatra helper to load assets locally and production.
 test_files: []