bunto-assets 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b31429ffff3e57efcf0c643a23cdf1b3a02bc8d
+  data.tar.gz: 773fe2c9059efc63d4696517fd2b31a1af3a5aed
+SHA512:
+  metadata.gz: c40b39c878020cfae98efff6d70bdf43de74850056316296a54ece7b43c1da5325e318ecee9a7dbdd100fb5c69dcbc108373b5af2939732b633b67da38f03478
+  data.tar.gz: 1bf712167ae3b29691fc45870401d1d540ab17a03c482b9d014a864767e93c0634dec6311d2f659fc1854374125634802dedf03b389c401459db8e1aa33f1877

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+group :development do
+  gem "therubyracer", :platforms => :mri, :require => false
+  gem "pry", :require => false
+end
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gem "uglifier", :require => false
+gem "sprockets-es6", "~> 0.6", :require => false
+gem "autoprefixer-rails", "~> 6.0", :require => false
+gem "font-awesome-sass", "~> 4.4", :require => false
+gem "bootstrap-sass", "~> 3.3", :require => false
+gem "mini_magick", "~> 4.2", :require => false

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012-2015 Aleksey V Zapparov (http://ixti.net/)
+Copyright (c) 2015-present Jordon Bedwell (https://envygeeks.io)
+Copyright (c) 2016-present Suriyaa Kudo (https://j.mp/ItsSuriyaa)
+
+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,275 @@
+[![Build Status](https://travis-ci.org/bunto/bunto-assets.svg?branch=master)][travis]
+
+[travis]: https://travis-ci.org/bunto/bunto-assets
+
+# Bunto Assets
+
+Bunto assets is an asset pipeline using Sprockets (v3) to build especially
+for Bunto. It utilizes new features of both Sprockets and Bunto to achieve
+a clean and extensible assets platform for Bunto.
+
+## Using Bunto Assets with Bunto
+
+Add `gem "bunto-assets"` to your `Gemfile` and add `bunto-assets`
+to your `_config.yml` like the following:
+
+```yaml
+gems:
+  - bunto-assets
+```
+
+## Configuration
+
+A lot of our configuration transforms based on the `BUNTO_ENV` variable
+set in your environment. Such as digesting and whether or not to enable the
+CDN. Some of them can be explicitly overridden but a few cannot right now.
+You should set your `BUNTO_ENV=development` on your development
+machine and `BUNTO_ENV=production` when building to push.
+
+```yaml
+assets:
+  compress:
+    css: false | true | default - development: false, production: true
+    js: false | true | default - development: false, production: true
+  cache: false | directory | default: .asset-cache
+  cdn: https://cdn.example.com
+  skip_baseurl_with_cdn: false
+  skip_prefix_with_cdn: false
+  prefix: "/assets"
+  assets:
+    - "*.png"
+    - "bundle.css"
+  digest: true
+  sources:
+    - _assets/css
+    - _assets/images
+    - _assets/javascripts
+    - _assets/stylesheets
+    - _assets/fonts
+    - _assets/img
+    - _assets/js
+  features:
+    liquid: true | false | default: false
+    automatic_img_size: true | false | default: true
+    automatic_img_alt : true | false | default: true
+```
+
+### Liquid Processing with your Bunto context
+
+By default (whether `features.liquid` is true or false) we will process
+all files with the extension ".liquid", so if you give us ".scss.liquid"
+we will parse the liquid and then we will parse the SCSS and finally
+output your ".css" file.
+
+When `features.liquid` is set to true, we will process ***ALL*** files
+through Liquid, regardless of whether they have the ".liquid" extension.
+Use this at your own risk.
+
+### Cache Folder
+
+If you plan to change the `cache` folder, please make sure to add that
+folder to your `exclude` list in Bunto or you will generate over and over
+and over again, `.` folders are not ignored by default.
+
+### Sources
+
+The listed resources in the example are all defaults. It should be noted
+that we append your sources instead of replace our resources with yours. So
+if you add `_assets/folder` then we will append that to our sources and
+both will work.
+
+***NOTE: if you use our `_assets` base folder container as a base folder for
+your sprockets, we will not append our sources, we will only use that
+folder as the sole source (base folder.)***
+
+### Digesting
+
+* Disable digesting by default in development.
+* Digest by default in production.
+
+***You can force digesting with `digest: true` in your `_config.yml`***
+
+### Compression
+
+* Requires sass and uglifier.
+* Disable compression by default in development.
+* Enable by default in production.
+
+### Bower Components
+
+Modify your `.bowerrc` file and add:
+
+```json
+{
+  "directory": "_assets/bower"
+}
+```
+
+And then add `_assets/bower` to your sources list and Sprockets will do the
+the rest for you... you can even `//= require bower_asset.js`. We will even
+compress them for you per normal if Sprockets supports it and allows us to.
+
+***You do not need to modify your `.bowerrc` file, you can optionally just
+add it to your sources list and it will work that way too! As long as it's in
+your Bunto folder.***
+
+## Tags
+
+* image, img
+* javascript, js
+* stylesheet, css, style
+* asset, asset_source
+* asset_path
+
+### Tag Example:
+
+```liquid
+{% img src magick:2x alt:'This is my alt' %}
+{% img src magick:2x alt:'This is my alt' sprockets:accept:image/gif %}
+```
+
+### What do the colons mean? Proxies/Tags
+
+* `argument` is a boolean HTML argument.
+* `key:value` is an HTML key="value" if no proxy exists.
+* `proxy:key:value` will set a proxy key with the given value.
+* `proxy:key` is a boolean argument if the proxy and key exists.
+* `unknown:key:value` will raise `DoubleColonError`, escape it.
+* `proxy:unknown:value` will raise a `UnknownProxyError`.
+
+Lets say we have `sprockets` proxies and sprockets allows you to proxy accept,
+if you send `{% img src sprockets:accept:image/gif }` then Sprockets find_asset
+will get `{ :accept => "image/gif" }` but if you try to proxy "unknown" on
+sprockets we will raise a Proxy error. For more information then look at
+`parser_spec.rb` in the spec folder because it literally lays out the ground
+rules for our tags as a specification.
+
+### Current Proxies:
+
+* `sprockets:accept:<value>`
+* `sprockets:write_to:<value>`
+
+## Liquid Variables
+
+We support liquid arguments for tag values (but not tag keys), and we also
+support Liquid pre-processing (with your Bunto context) sass/less/css files
+you need do nothing special for the preprocessing an entire file, it's
+always done.
+
+An example of using Liquid in your tags:
+
+```liquid
+{% img '{{ image_path }}' %}
+{% img '{{ image_path }}' proxy:key:'{{ value }}' %}
+{% img {{\ image_path\ }} %}
+```
+
+An example of using Liquid in your SCSS:
+
+```scss
+.bg {
+  background: url(asset_path("{{ site.background_image }}"));
+}
+```
+
+You have full access to your entire Bunto context from any liquid
+processing we do, so you can do whatever you like and be as dynamic as you
+like, including full loops and conditional Liquid based CSS since we
+pre-process your text files.
+
+## Getting a list of your assets and basic info from Liquid
+
+We provide all *your* assets as a hash of Liquid Drops so you can get basic
+info that we wish you to have access to without having to prepare the class.
+
+```liquid
+{{ assets["bundle.css"].content_type }} => "text/css"
+{{ assets["images.jpg"].width  }} => 62
+{{ assets["images.jpg"].height }} => 62
+```
+
+The current list of available accessors:
+
+* `logical_path`
+* `content_type` -> `type`
+* `filename`
+* `basename`
+* `width`
+* `height`
+
+If you would like more, please feel free to add a pull request, at this
+time we will reject all pull requests that wish to add any digested paths as
+those are dynamically created when a proxy is ran so we can never predict
+it reliably unless we proxy and that would be a performance problem.
+
+## ERB Support
+
+ERB Support is removed in favor of trying to get this included on Github Pages
+eventually (if I can.) Having ERB presents a security risk to Github because it
+would allow you to use Ruby in ways they don't want you to.
+
+## Filters
+
+There is a full suite of filters, actually, any tag and any proxy can be a
+filter by way of filter arguments, take the following example:
+
+```liquid
+{{ src | img : "magick:2x magick:quality:92" }}
+```
+
+## Hooks
+
+* `:env => [:init]`
+
+You can register and trigger hooks like so:
+
+```ruby
+Bunto::Assets::Hook.register :env, :init do
+  # Your Work
+end
+```
+
+## Sass Helpers
+
+***Our currently supported helpers are:***
+
+* asset_path
+* image_path
+* font_path
+
+## Addons
+
+* CSS Auto Prefixer - add "autoprefixer-rails" to your Gemfile.
+* ES6 Transpiler (through Babel) - add "sprockets-es6" to your Gemfile.
+* Image Magick - add "mini_magick" to your Gemfile, only works with `img`, `image`.
+* Bootstrap - add "bootstrap-sass" to your Gemfile and "@import 'bootstrap'"
+* Font Awesome - add "font-awesome-sass" to your Gemfile.
+
+***Please note that some of these (if not all) have trouble with Rhino --
+`therubyrhino` so you would probably be best to just use Node.js or io.js at
+that point rather than trying to fight it.***
+
+### Image Magick Proxy arguments:
+
+* `magick:resize:<value>`
+* `magick:format:<value>`
+* `magick:quality:<value>`
+* `magick:rotate:<value>`
+* `magick:gravity:<value>`
+* `magick:crop:<value>`
+* `magick:flip:<value>`
+* `magick:quadruple`, `magick:4x`
+* `magick:one-third`, `magick:1/3`
+* `magick:three-fourths`, `magick:3/4`
+* `magick:two-fourths`, `magick:2/4`
+* `magick:two-thirds`, `magick:2/3`
+* `magick:one-fourth`, `magick:1/4`
+* `magick:half`, `magick:1/2`
+
+## Having trouble with our documentation?
+
+If you do not understand something in our documentation please feel
+free to file a ticket and it will be explained and the documentation updated,
+however... if you have already figured out the problem please feel free to
+submit a pull request with clarification in the documentation and we'll
+happily work with you on updating it.

data/Rakefile

@@ -0,0 +1,3 @@
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]

data/lib/bunto/assets/addons/autoprefixer.rb

@@ -0,0 +1,13 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+try_require_if_javascript "autoprefixer-rails" do
+  Bunto::Assets::Hook.register :env, :init do |env|
+    AutoprefixerRails.install(env, env.asset_config[
+      "autoprefixer"
+    ])
+  end
+end

data/lib/bunto/assets/addons/bootstrap.rb

@@ -0,0 +1,7 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+try_require "bootstrap-sass"

data/lib/bunto/assets/addons/font_awesome.rb

@@ -0,0 +1,7 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+try_require "font-awesome-sass"

data/lib/bunto/assets/addons/javascript.rb

@@ -0,0 +1,11 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+try_require_if_javascript "sprockets/es6" do
+  if ExecJS.runtime.is_a?(ExecJS::RubyRhinoRuntime)
+    Bunto.logger.warn "ES6 transpiler has trouble with RubyRhino, use Node"
+  end
+end

data/lib/bunto/assets/cached.rb

@@ -0,0 +1,20 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+module Bunto
+  module Assets
+    class Cached < Sprockets::CachedEnvironment
+      attr_reader :bunto
+      attr_reader :parent
+
+      def initialize(env)
+        @parent = env
+        @bunto = env.bunto
+        super env
+      end
+    end
+  end
+end

data/lib/bunto/assets/config.rb

@@ -0,0 +1,76 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+module Bunto
+  module Assets
+    module Config
+      DefaultSources = %W(
+        _assets/css _assets/stylesheets
+        _assets/images _assets/img _assets/fonts
+        _assets/javascripts _assets/js
+      ).freeze
+
+      # ----------------------------------------------------------------------
+
+      Development = {
+        "skip_baseurl_with_cdn" => false,
+        "skip_prefix_with_cdn"  => false,
+        "prefix"    => "/assets",
+        "digest"    => false,
+        "assets"    => [],
+
+        "compress"  => {
+          "css"     => false,
+          "js"      => false
+        },
+
+        "features" => {
+          "automatic_img_alt"  => true,
+          "automatic_img_size" => true,
+          "liquid" => false
+        }
+      }.freeze
+
+      # ----------------------------------------------------------------------
+
+      Production = Development.merge({
+        "digest"    => true,
+        "compress"  => {
+          "css"     => true,
+          "js"      => true
+        }
+      }).freeze
+
+      # ----------------------------------------------------------------------
+
+      def self.merge_sources(bunto, config)
+        config["sources"] ||= []
+        return if config["sources"].grep(/\A\s*_assets\/?\s*\Z/).size > 0
+        sources = DefaultSources + config["sources"].to_a
+
+        config["sources"] = Set.new(sources.map do |val|
+          bunto.in_source_dir(val)
+        end)
+      end
+
+      # ----------------------------------------------------------------------
+
+      def self.defaults
+        if %W(development test).include?(Bunto.env)
+          then Development else Production
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def self.merge(new_hash, old_hash = defaults)
+        old_hash.merge(new_hash) do |_, old_val, new_val|
+          old_val.is_a?(Hash) && new_val.is_a?(Hash) ? merge(new_val, old_val) : new_val
+        end
+      end
+    end
+  end
+end

data/lib/bunto/assets/env.rb

@@ -0,0 +1,207 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016-present - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+module Bunto
+  module Assets
+    class Env < Sprockets::Environment
+      attr_reader :bunto, :used
+
+      class << self
+        attr_accessor :past
+        def liquid_proxies
+          Liquid::Tag::Proxies
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def excludes
+        excludes = Set.new
+        excludes << strip_path(in_cache_dir)
+        excludes
+      end
+
+      # ----------------------------------------------------------------------
+
+      def all_unparsed_assets
+        @unparsed_assets ||= logical_paths.select do |(_, val)|
+          val.start_with?(bunto.in_source_dir)
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def to_liquid_payload
+        bunto.sprockets.all_unparsed_assets.each_with_object({}) do |(key, val), hash|
+          hash[key] = Bunto::Assets::Liquid::Drop.new(
+            val, bunto
+          )
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def initialize(path, bunto = nil)
+        bunto, path = path, nil if path.is_a?(Bunto::Site)
+        @bunto = bunto
+        @used = Set.new
+
+        path ? super(path) : super()
+        Hook.trigger :env, :init do |hook|
+          hook.arity > 0 || 0 > hook.arity ? hook.call(self) : instance_eval(&hook)
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def liquid_proxies
+        self.class.liquid_proxies
+      end
+
+      # ----------------------------------------------------------------------
+      # Make sure a path falls withint our cache dir.
+      # ----------------------------------------------------------------------
+
+      def in_cache_dir(*paths)
+        cache_dir = asset_config["cache"] || ".asset-cache"
+        bunto.in_source_dir(cache_dir, *paths)
+      end
+
+      # ----------------------------------------------------------------------
+      # Merged form of `#extra_assets`
+      # ----------------------------------------------------------------------
+
+      def all_assets
+        Set.new(@used).merge extra_assets
+      end
+
+      # ----------------------------------------------------------------------
+      # Assets you tell us you want to always compile, even if you do not
+      # use them.  Just like Rails this is probably normally used.
+      # ----------------------------------------------------------------------
+
+      def extra_assets
+        assets = asset_config["assets"] ||= []
+        each_logical_path(*assets).map do |v|
+          find_asset v
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      def cdn?
+        !dev? && asset_config.key?("cdn") && \
+          asset_config["cdn"]
+      end
+
+      # ----------------------------------------------------------------------
+
+      def baseurl
+        ary = []
+
+        ary << bunto.config["baseurl"] unless cdn? && asset_config["skip_baseurl_with_cdn"]
+        ary <<  asset_config[ "prefix"] unless cdn? && asset_config[ "skip_prefix_with_cdn"]
+
+        File.join(*ary.delete_if do |val|
+          val.nil? || val.empty?
+        end)
+      end
+
+      # ----------------------------------------------------------------------
+
+      def dev?
+        %W(development test).include?(Bunto.env)
+      end
+
+      # ----------------------------------------------------------------------
+
+      def compress?(what)
+        !!asset_config["compress"] \
+          .fetch(what, false)
+      end
+
+      # ----------------------------------------------------------------------
+
+      def asset_config
+        bunto.config["assets"] ||= {}
+      end
+
+      # ----------------------------------------------------------------------
+
+      def digest?
+        !!asset_config["digest"]
+      end
+
+      # ----------------------------------------------------------------------
+      # Prefix path prefixes the path with the baseurl and the cdn if it
+      # exists and is in the right mode to use it.  Otherwise it will only use
+      # the baseurl and asset prefix.  All of these can be adjusted.
+      # ----------------------------------------------------------------------
+
+      def prefix_path(path = nil)
+        cdn = asset_config["cdn"]
+        base_url = baseurl
+
+        path_ = []
+        path_ << base_url unless base_url.empty?
+        path_ << path unless path.nil?
+
+        url = cdn && cdn?? File.join(cdn, *path_) : File.join(*path_)
+        url.chomp("/")
+      end
+
+      # ----------------------------------------------------------------------
+
+      def cached
+        Cached.new(self)
+      end
+
+      # ----------------------------------------------------------------------
+
+      def write_all
+        past = self.class.past ||= Set.new
+        (@used.any?? all_assets : past).each do |obj|
+          if past.add(obj) && path = as_path(obj)
+            obj.write_to path
+          end
+        end
+      end
+
+      # ----------------------------------------------------------------------
+
+      private
+      def strip_path(path)
+        path.sub(bunto.in_source_dir("/"), "")
+      end
+
+      # ----------------------------------------------------------------------
+
+      private
+      def as_path(v)
+        path = digest?? v.digest_path : v.logical_path
+        bunto.in_dest_dir(File.join(asset_config[ "prefix"], path))
+      end
+
+      # ----------------------------------------------------------------------
+
+      class << self
+        def context_patches
+          Proc.new do
+            alias _old_asset_path asset_path
+            def asset_path(asset, _ = {})
+              rtn = _old_asset_path asset
+
+              return unless rtn
+              path = environment.find_asset(resolve(asset))
+              environment.parent.used.add(path)
+              rtn
+            end
+          end
+        end
+      end
+    end
+  end
+end