asset_manifest 1.0.0.pre.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60c26b354f46bb76f50c8d4a1cbec0b81b34584a
+  data.tar.gz: 19c9d5a20eded7714f188233edcd5d920d7a7b5d
+SHA512:
+  metadata.gz: 9b2f14e2cdae4e98842eb232089c9c38be813e24819b151a7e0f2a5e37c4e599334f106f58077d70ac2471b5620ea61c1d2a16f3b9e22aa03f7201064915ea05
+  data.tar.gz: 81fba360287012e033e387c41a3ccabef024c8b20a17c8e3c6029cf0c6970c5ca2f38d16f2cc0db4c518683697cf8c66329bff8eb3bba9e27d1071e909694e1e

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Nicolas Sanguinetti <foca@13floor.org>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# Asset Manifest
+
+Tiny set of utilities to compute subresource integrity and cache busting
+checksums for static assets.
+
+## How it works
+
+Asset Manifest provides two main utilities:
+
+* An executable that you should run when compiling your static assets. This
+  generates a `manifest` file that includes the SRI hash and a checksum (for
+  cache-busting purposes) of each of your assets.
+
+* A ruby library to generate the proper links to the assets taking into account
+  the data from your manifest.
+
+## Usage
+
+Somewhere in your makefile, you'll want to generate the `public/manifest.json`
+file like so:
+
+``` Makefile
+# Assuming you keep an ASSETS list with all the assets you're compiling...
+ASSETS += public/css/app.css
+ASSETS += public/css/app.min.css
+ASSETS += public/js/app.js
+ASSETS += public/js/app.min.js
+
+# ...you'd want a rule like this one:
+public/manifest.json: $(ASSETS)
+	asset-manifest -d public $^ > $@
+```
+
+Then, in your app, you'll want to initialize `AssetManifest::Helpers` passing
+the contents of this JSON file:
+
+``` ruby
+assets = AssetManifest::Helpers.new(
+  JSON.parse(File.read("./public/manifest.json")),
+  { minify: ENV["RACK_ENV"] == "production" }
+)
+```
+
+Finally, you'll want to pass this object to your views, so that you can do the
+following:
+
+``` erb
+<%= assets.stylesheet_tag("/css/app.css") %>
+<%= assets.script_tag("/js/app.js") %>
+```
+
+This would produce output similar to:
+
+``` html
+<link rel="stylesheet"
+      href="/css/app-07915293e2bb992a67c618e1aa335d978efc3734.css"
+      integrity="sha256-yqqr5VJwz1IM5iTlSram51zrBvuE21FbiYgNnD2fwgE=">
+<script src="/js/app-1a4aefaba81b61c7ea763d42fcb39584e5784c32.js"
+        integrity="sha256-ZmTdnjlqI4ppv9cW8Y5i6PixtV4CQlVUvxB2iySwU94="></script>
+```
+
+(Whitespace added for clarity)
+
+### With Rake instead of Make
+
+Assuming you have an `ASSETS` constant with the list of assets, you can use the
+following example in your `Rakefile` to re-generate your manifest when your
+assets change.
+
+``` rake
+rule "public/manifest.json" => ASSETS do |t|
+  sh "asset-manifest -d public #{t.prerequisites.join(" ")} > #{t.name}"
+end
+
+task assets: ASSETS
+task assets: "public/manifest.json"
+```
+
+You can add this file to your `assets` so that the file is automatically
+generated when your source assets change.
+
+## Cuba plugin
+
+If you use [Cuba](http://cuba.is), then you can just do this:
+
+``` ruby
+require "asset_manifest/cuba"
+Cuba.plugin AssetManifest::Cuba
+```
+
+This will set up an `assets` helper available in all your apps that you can use
+/ pass to the templates.
+
+## License
+
+This project is shared under the MIT license. See the attached [LICENSE][] file
+for details.
+
+[LICENSE]: ./LICENSE

data/bin/asset-manifest

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "json"
+require "digest/sha1"
+require "digest/sha2"
+require "fileutils"
+require "asset_manifest"
+
+options = {}
+OptionParser.new do |o|
+  o.banner = "Usage: #{File.basename($0)} [options] asset..."
+
+  o.on("-d", "--directory DIR", "Public directory") do |dir|
+    options[:dir] = dir
+  end
+end.parse!(ARGV)
+
+manifest = Hash.new { |h,k| h[k] = {} }
+
+ARGV.each do |path|
+  key = path.sub(/^#{Regexp.escape(options[:dir])}/, "")
+
+  body = File.read(path)
+  manifest[key][:integrity] = "sha256-" + Array(Digest::SHA256.digest(body)).pack("m0")
+  manifest[key][:checksum] = Digest::SHA1.hexdigest(body)
+
+  asset = AssetManifest::Asset.new(path.sub(".min.", "."), {
+    manifest: manifest.dup,
+    minify: path.include?(".min."),
+    integrity: manifest[key][:integrity],
+    checksum: manifest[key][:checksum],
+  })
+
+  FileUtils.cp(File.join(Dir.pwd, path), asset.path)
+end
+
+puts JSON.dump(manifest)

data/lib/asset_manifest/cuba.rb

@@ -0,0 +1,59 @@
+require_relative "../asset_manifest"
+
+# Cuba plugin to simplify using AssetManifest. Gives you an entrypoint into the set of
+# helpers to render different HTML tags.
+#
+# All you need to do is add this:
+#
+#   Cuba.plugin AssetManifest::Cuba
+#
+# For example, in your template you could do something like this:
+#
+#   <%= assets.stylesheet_tag("/css/main.css") %>
+#   <%= assets.script_tag("/js/main.js") %>
+#
+# Configuration
+# -------------
+#
+# You can configure the following things:
+#
+# * `Cuba.settings[:asset_manifest][:public]`:
+#   The public directory where assets go. Defaults to `./public`.
+#
+# * `Cuba.settings[:asset_manifest][:manifest]`:
+#   Path to the asset manifest. Defaults to `{{ public }}/manifest.json`.
+#
+# * `Cuba.settings[:asset_manifest][:minified]`:
+#   Whether to append a `min` to the filename. If this is trueish, then a link
+#   to `foo.xyz` would turn to a link to `foo.min.xyz`. Defaults to `nil`.
+#
+# * `Cuba.settings[:asset_manifest][:asset_host]`:
+#   Host to serve assets from. Defaults to an empty String (same root as the
+#   Cuba app).
+#
+module AssetManifest::Cuba
+  def self.setup(app)
+    settings = app.settings[:asset_manifest] ||= {}
+
+    settings[:public] ||= "./public"
+    settings[:manifest] ||= File.join(settings[:public], "manifest.json")
+    settings[:minified] ||= nil
+    settings[:asset_host] ||= ""
+  end
+
+  # Public: Helper proxy for your apps.
+  #
+  # Example:
+  #
+  #     <%= assets.stylesheet_tag("/css/main.css") %>
+  #
+  def assets
+    @_assets ||= AssetManifest::Helpers.new(
+      JSON.parse(File.read(settings[:asset_manifest][:manifest])),
+      {
+        minify: settings[:asset_manifest][:minified],
+        host: settings[:asset_manifest][:asset_host],
+      }
+    )
+  end
+end

data/lib/asset_manifest/version.rb

@@ -0,0 +1,3 @@
+module AssetManifest
+  VERSION = "1.0.0.pre.rc1".freeze
+end

data/lib/asset_manifest.rb

@@ -0,0 +1,165 @@
+require_relative "asset_manifest/version"
+
+module AssetManifest
+  class Helpers
+    def initialize(manifest, asset_options = {})
+      @manifest = manifest
+      @asset_options = asset_options
+    end
+
+    # Public: Generate a <link> tag.
+    #
+    # path   - The absolute path (for the browser) to the stylesheet.
+    # html   - A Hash with HTML attribute mappings for this tag.
+    # **opts - Any keyword arguments will be forwarded to the initializer of
+    #          AssetManifest::Asset to calculate the tag's attributes.
+    #
+    # Returns a String.
+    def link_tag(path, html: {}, **opts)
+      link = asset(path, opts)
+      attrs = attributes(html)
+      attrs.concat(sri(link))
+      %Q(<link href="#{link.url}" #{attrs.join(" ")}>)
+    end
+
+    # Public: Generate a <link> tag to a stylesheet.
+    #
+    # path   - The absolute path (for the browser) to the stylesheet.
+    # html   - A Hash with HTML attribute mappings for this tag.
+    # **opts - Any keyword arguments will be forwarded to the initializer of
+    #          AssetManifest::Asset to calculate the tag's attributes.
+    #
+    # Returns a String.
+    def stylesheet_tag(path, html: {}, **opts)
+      html.update(rel: "stylesheet")
+      link_tag(path, html: html, **opts)
+    end
+
+    # Public: Generate a <script> tag to a JS file.
+    #
+    # path   - The absolute path (for the browser) to the script.
+    # html   - A Hash with HTML attribute mappings for this tag.
+    # **opts - Any keyword arguments will be forwarded to the initializer of
+    #          AssetManifest::Asset to calculate the tag's attributes.
+    #
+    # Returns a String.
+    def script_tag(path, html: {}, **opts)
+      script = asset(path, opts)
+      attrs = attributes(html)
+      attrs.concat(sri(script))
+      %Q(<script src="#{script.url}" #{attrs.join(" ")}></script>)
+    end
+
+    # Public: Generate an <img> tag.
+    #
+    # path   - The absolute path (for the browser) to the image.
+    # html   - A Hash with HTML attribute mappings for this tag.
+    # **opts - Any keyword arguments will be forwarded to the initializer of
+    #          AssetManifest::Asset to calculate the tag's attributes.
+    #
+    # Returns a String.
+    def image_tag(path, html: {}, **opts)
+      image = asset(path, opts)
+      attrs = attributes(html)
+      %Q(<img src="#{image.url}" #{attrs.join(" ")}>)
+    end
+
+    # Internal: Generate an attribute list from a Hash. If there's a `:data` key
+    # and it's itself a Hash, its keys will get a `data-` prefix.
+    #
+    # opts   - A Hash of attribute => value mappings. If a value is the literal
+    #          `true`, then we'll consider the attribute to be a Boolean
+    #          attribute and output it without value (ie. `{ hidden: true }`
+    #          would transform into `["hidden"]`, not `['hidden="true"']`.
+    # prefix - A prefix to add to attribute names. Defaults to an empty String.
+    #
+    # Returns an Array of 'attribute="value"' Strings.
+    def attributes(opts, prefix="")
+      attrs = []
+
+      if Hash === opts[:data]
+        attrs.concat(attributes(opts.delete(:data), "data-"))
+      end
+
+      attrs.concat(
+        opts.map { |attr, val| val == true ? attr : %Q(#{attr}="#{val}") }
+      )
+
+      attrs
+    end
+
+    # Internal: Returns an AssetManifest::Asset for the given path, using the default
+    # asset options and any other options passed in the `opts` Hash.
+    def asset(path, opts)
+      Asset.new(path, manifest: @manifest, **@asset_options.merge(opts))
+    end
+
+    # Internal: Generate the Sub-Resource Integrity attributes for the tags that
+    # require it.
+    #
+    # tag - An AssetManifest::Asset object.
+    #
+    # Returns an Array of attribute=value Strings.
+    def sri(asset)
+      attrs = [%Q(integrity="#{asset.integrity}")]
+      attrs << %Q(crossorigin="#{asset.cors}") if asset.cors?
+      attrs
+    end
+  end
+
+  class Asset
+    # Public: Returns a String with the SRI hash for this asset.
+    attr_reader :integrity
+
+    # Public: Returns a String with the value of the crossorigin attribute, or
+    # `nil` if the asset isn't served from a special asset host.
+    attr_reader :cors
+
+    def initialize(path, manifest:,
+                         host: "",
+                         minify: nil,
+                         integrity: nil,
+                         checksum: nil,
+                         cors: "anonymous")
+      minify = (minify if minify) # Ensure `false` gets converted to `nil`
+      @path = base_path(path, minify)
+      @manifest = manifest[@path]
+      @integrity = integrity || @manifest.fetch("integrity")
+      @checksum = checksum || @manifest.fetch("checksum")
+      @minify = minify
+      @host = host
+      @cors = cors if cors?
+    end
+
+    # Public: Returns a String with the path to the asset from the host's root
+    # (i.e. without the asset host).
+    def path
+      @_path ||= begin
+        sep = @minify ? ".min." : "."
+        *asset, ext = @path.split(sep)
+        asset.last << "-#{@checksum}"
+        [*asset, ext].join(sep)
+      end
+    end
+
+    # Public: Returns a String with the full URL of the asset (including the
+    # asset host, if any).
+    def url
+      @url ||= File.join(@host, path)
+    end
+
+    # Public: Returns a Boolean representing whether we should set up a
+    # `crossorigin` attribute for this asset.
+    def cors?
+      @host != ""
+    end
+
+    private
+
+    def base_path(path, minify)
+      minify = "min" if minify
+      *asset, ext = path.split(".")
+      [*asset, *minify, ext].join(".")
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: asset_manifest
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.rc1
+platform: ruby
+authors:
+- Nicolas Sanguinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: AssetManifest provides utilities for generating SRI and cache-busting
+  hashes to your static assets during compilation.
+email:
+- contacto@nicolassanguinetti.info
+executables:
+- asset-manifest
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/asset-manifest
+- lib/asset_manifest.rb
+- lib/asset_manifest/cuba.rb
+- lib/asset_manifest/version.rb
+homepage: http://github.com/13floor/asset_manifest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Utilities for serving your static assets.
+test_files: []