pakyow-assets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c34ffdb89232d029de7ea67d0c441153098183d5
+  data.tar.gz: 9212199c36c2c08afdb61b0148d8203069b3e6fe
+SHA512:
+  metadata.gz: a5cbc1673ea231a0f72bc71a6fb131e36a99b0ca2ec3af0cdbfa4ef93b05bf6b3c4f7dfc5451ce342e9b140fe36bf494ece811690c4f3d3a83e62e6c6d502de1
+  data.tar.gz: 126b7a3f9334e2bbe8b1be17722317885192b94b9d0a0484c3fcd015462c40baae9f6edc3255ec3f554c095066d8505adadfdcb4698448af0f69f4e287d41b05

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Bryan Powell
+
+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,58 @@
+# pakyow-assets
+
+Asset handling for [Pakyow](http://pakyow.com). It's intended to be lightweight
+and fast in development while providing powerful fingerprinting and caching
+support for production environments.
+
+In development, assets are compiled on demand rather than up-front. They'll only
+be recompiled again when the source changes.
+
+When starting up in production, Pakyow will compile, minify, and fingerprint
+every asset file. Fingerprinted filenames are automatically handled.
+
+Bundled preprocessors include: js, css, png, gif, jpg, favicon, and sass.
+
+# Installation
+
+Place inside your Gemfile
+
+    gem 'pakyow-assets'
+
+Run `bundle install` and restart your app server.
+
+# Usage
+
+Place all assets in a `app/assets` directory. When compiled, assets will mimic
+the directory structure. During development, all assets will be compiled to a
+`.assets` directory by default. Pakyow will serve requests to all assets when
+running in a development environment. The idea in production is for all assets
+to be in a non-minified state, making debugging easy.
+
+*Note that all compiled assets should be excluded from version control as they
+will be compiled and fingerprinted when deployed to a production environment.*
+
+In production, assets will automatically be minified and fingerprinted. As a
+developer you don't have to worry about caching or fingerprints; Pakyow takes
+care of all of that for you.
+
+## Configuration
+
+There are many configuration options available. Take a look at `lib/config.rb`
+for all the available options.
+
+## Custom Preprocessor
+
+Pakyow Assets can easily be extended. Take a look at the existing preprocessors
+in `lib/preprocessors` for examples.
+
+## External Asset Store
+
+Any number of asset stores can be registered:
+
+```ruby
+Pakyow::Config.assets.stores[:store_name] = 'absolute_path_to_store'
+```
+
+# License
+
+pakyow-assets is released under the [MIT License](http://opensource.org/licenses/MIT).

data/lib/assets.rb

@@ -0,0 +1,166 @@
+require 'fileutils'
+
+module Pakyow
+  module Assets
+    def self.register_path_with_name(path, name)
+      stores[name] = {
+        path: path,
+        assets: assets_at_path(path)
+      }
+    end
+
+    def self.assets_at_path(path)
+      Dir.glob(File.join(path, '**/[!_]*.[a-z]*')).map { |asset|
+        String.normalize_path(asset[path.length..-1])
+      }
+    end
+
+    def self.stores
+      @stores ||= {}
+    end
+
+    def self.preprocessors
+      @preprocessors ||= {}
+    end
+
+    def self.dependents
+      @dependents ||= {}
+    end
+
+    def self.compiled_asset_path_for_request_path(path)
+      path = String.normalize_path(path)
+      ext = File.extname(path)
+
+      return unless path =~ /\.(.*)$/
+      return unless preprocessor?(ext)
+
+      path_regex = /#{path.gsub(ext, '')}\.(#{alias_exts(ext).map(&:to_s).join('|')})/
+
+      @stores.each_pair do |name, info|
+        if asset = info[:assets].find { |asset| asset =~ path_regex }
+          return compile_asset_at_path(asset, info[:path])
+        end
+      end
+
+      nil
+    end
+
+    def self.normalize_ext(ext)
+      ext.gsub(/[^a-z]/, '').to_sym
+    end
+
+    def self.alias_exts(ext)
+      preprocessors.select { |_, info|
+        info[:output_ext] == normalize_ext(ext)
+      }.keys
+    end
+
+    def self.output_ext(ext)
+      ".#{preprocessors[normalize_ext(ext)][:output_ext]}"
+    end
+
+    def self.preprocessor?(ext)
+      preprocessors.values.map { |info| info[:output_ext] }.flatten.include?(normalize_ext(ext))
+    end
+
+    def self.compile_asset_at_path(asset, path)
+      absolute_path = File.join(path, asset)
+
+      asset_dir = File.dirname(asset)
+      asset_ext = output_ext(File.extname(asset))
+      asset_file = File.basename(asset, '.*')
+
+      compiled_path = File.join(
+        Pakyow::Config.app.root,
+        Pakyow::Config.assets.compiled_asset_path,
+        asset_dir,
+        "#{asset_file + '-' + asset_hash(absolute_path) + asset_ext}"
+      )
+
+      unless File.exists?(compiled_path)
+        FileUtils.mkdir_p(File.dirname(compiled_path))
+        FileUtils.rm(Dir.glob(File.join(Pakyow::Config.app.root, Pakyow::Config.assets.compiled_asset_path, asset_dir, "#{asset_file}-*#{asset_ext}")))
+        File.open(compiled_path, 'wb+') { |fp| fp.write(preprocess(absolute_path)) }
+      end
+
+      compiled_path
+    end
+
+    def self.preprocessor(*exts, output: nil, fingerprint_contents: false, &block)
+      exts.each do |ext|
+        preprocessors[ext] = {
+          block: block,
+          output_ext: output || ext,
+          fingerprint_contents: fingerprint_contents
+        }
+      end
+    end
+
+    def self.dependencies(*exts, &block)
+      exts.each do |ext|
+        dependents[ext] = block
+      end
+    end
+
+    def self.preprocess(path)
+      preprocessor = preprocessors[normalize_ext(File.extname(path))]
+      block = preprocessor[:block]
+
+      contents = block.nil? ? File.open(path, 'rb').read : block.call(path)
+      preprocessor[:fingerprint_contents] ? mixin_fingerprints(contents) : contents
+    end
+
+    def self.precompile
+      if File.exists?(Pakyow::Config.assets.compiled_asset_path)
+        FileUtils.rm_r(Pakyow::Config.assets.compiled_asset_path)
+      end
+
+      stores.each do |_, info|
+        info[:assets].each do |asset|
+          compile_asset_at_path(asset, info[:path])
+          absolute_path = File.join(info[:path], asset)
+
+          fingerprint = Digest::MD5.file(absolute_path).hexdigest
+
+          fingerprinted_asset = File.join(
+            File.dirname(asset),
+            "#{File.basename(asset, '.*')}-#{fingerprint + output_ext(File.extname(asset))}",
+          )
+
+          replaceable_asset = File.join(
+            File.dirname(asset),
+            File.basename(asset, '.*') + output_ext(File.extname(asset)),
+          )
+
+          manifest[replaceable_asset] = fingerprinted_asset
+        end
+      end
+    end
+
+    def self.manifest
+      @manifest ||= {}
+    end
+
+    def self.mixin_fingerprints(content)
+      return content if content.nil? || content.empty?
+
+      manifest.each do |asset, fingerprinted_asset|
+        content = content.gsub(asset, fingerprinted_asset)
+      end
+
+      content
+    end
+
+    def self.asset_hash(absolute_path)
+      Digest::MD5.hexdigest(dependencies_for(absolute_path).concat([absolute_path]).map { |filename|
+        Digest::MD5.file(filename).hexdigest
+      }.flatten.join)
+    end
+
+    def self.dependencies_for(absolute_path)
+      block = dependents[normalize_ext(File.extname(absolute_path))]
+      return [] if block.nil?
+      block.call(absolute_path)
+    end
+  end
+end

data/lib/config.rb

@@ -0,0 +1,37 @@
+Pakyow::Config.register(:assets) { |config|
+
+  # registered asset stores
+  config.opt :stores, lambda {
+    @stores ||= {
+      default: File.join(Pakyow::Config.app.root, 'app', 'assets')
+    }
+  }
+
+  # whether or not pakyow should host assets
+  config.opt :compile_on_request
+
+  # whether pakyow should compile assets on startup
+  config.opt :compile_on_startup
+
+  # where assets should be compiled to
+  config.opt :compiled_asset_path
+
+  # whether or not to cache the assets
+  config.opt :cache
+
+  # whether or not to minify the assets
+  config.opt :minify
+
+}.env(:development) { |opts|
+  opts.cache = false
+  opts.compile_on_request = true
+  opts.compile_on_startup = false
+  opts.compiled_asset_path = '.assets'
+  opts.minify = false
+}.env(:production) { |opts|
+  opts.cache = true
+  opts.compile_on_request = false
+  opts.compile_on_startup = true
+  opts.compiled_asset_path = 'public'
+  opts.minify = true
+}

data/lib/middleware.rb

@@ -0,0 +1,38 @@
+module Pakyow
+  module Assets
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if Pakyow::Config.assets.compile_on_request
+          path = Pakyow::Assets.compiled_asset_path_for_request_path(env['PATH_INFO'])
+        else
+          path = File.join(Pakyow::Config.assets.compiled_asset_path, env['PATH_INFO'])
+        end
+
+        if path =~ /\.(.*)$/ && File.exists?(path)
+          catch :halt do
+            app = Pakyow.app.dup
+            app.context = AppContext.new(Request.new(env), Response.new)
+
+            headers = {
+              'Content-Type' => Rack::Mime.mime_type(File.extname(path))
+            }
+
+            if Pakyow::Config.assets.cache
+              mtime = File.mtime(path)
+              headers['Age'] = (Time.now - mtime).to_i
+              headers['Cache-Control'] = 'public, max-age=31536000'
+            end
+
+            [200, headers, File.open(path)]
+          end
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/pakyow-assets.rb

@@ -0,0 +1,29 @@
+require_relative 'assets'
+require_relative 'config'
+require_relative 'middleware'
+require_relative 'version'
+
+require_relative 'preprocessors/css-preprocessor'
+require_relative 'preprocessors/image-preprocessor'
+require_relative 'preprocessors/javascript-preprocessor'
+require_relative 'preprocessors/sass-preprocessor'
+
+Pakyow::App.after :init do
+  config.assets.stores.each_pair do |name, path|
+    Pakyow::Assets.register_path_with_name(path, name)
+  end
+
+  if config.assets.compile_on_startup
+    Pakyow::App.processor :html do |content|
+      Pakyow::Assets.mixin_fingerprints(content)
+    end
+
+    Pakyow.logger.debug 'Precompiling assets...'
+    Pakyow::Assets.precompile
+    Pakyow.logger.debug 'Finished precompiling!'
+  end
+end
+
+Pakyow::App.middleware do |builder|
+  builder.use Pakyow::Assets::Middleware
+end

data/lib/preprocessors/css-preprocessor.rb

@@ -0,0 +1,16 @@
+require 'yui/compressor'
+
+Pakyow::Assets.preprocessor :css, fingerprint_contents: true do |path|
+  content = File.open(path).read
+
+  if Pakyow::Config.assets.minify
+    begin
+      YUI::CssCompressor.new.compress(content)
+    rescue YUI::Compressor::RuntimeError
+      Pakyow.logger.warn "Unable to minify #{path}; using raw content"
+      content
+    end
+  else
+    content
+  end
+end

data/lib/preprocessors/image-preprocessor.rb

@@ -0,0 +1 @@
+Pakyow::Assets.preprocessor :png, :jpg, :gif, :ico

data/lib/preprocessors/javascript-preprocessor.rb

@@ -0,0 +1,16 @@
+require 'yui/compressor'
+
+Pakyow::Assets.preprocessor :js, fingerprint_contents: true do |path|
+  content = File.open(path).read
+
+  if Pakyow::Config.assets.minify
+    begin
+      YUI::JavaScriptCompressor.new(munge: true).compress(content)
+    rescue YUI::Compressor::RuntimeError
+      Pakyow.logger.warn "Unable to minify #{path}; using raw content"
+      content
+    end
+  else
+    content
+  end
+end

data/lib/preprocessors/sass-preprocessor.rb

@@ -0,0 +1,23 @@
+require 'sass'
+require 'yui/compressor'
+
+Pakyow::Assets.preprocessor :scss, :sass, output: :css, fingerprint_contents: true do |path|
+  content = Sass::Engine.for_file(path, {}).render
+
+  if Pakyow::Config.assets.minify
+    begin
+      YUI::CssCompressor.new.compress(content)
+    rescue YUI::Compressor::RuntimeError
+      Pakyow.logger.warn "Unable to minify #{path}; using raw content"
+      content
+    end
+  else
+    content
+  end
+end
+
+Pakyow::Assets.dependencies :scss, :sass do |path|
+  Sass::Engine.for_file(path, {}).dependencies.map { |dependency|
+    dependency.options[:filename]
+  }
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+module Pakyow
+  module Assets
+    VERSION = '0.1.0'.freeze
+  end
+end

data/pakyow-assets.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pakyow-assets'
+  spec.summary       = 'Pakyow Assets'
+  spec.description   = 'Asset Handling for Pakyow'
+  spec.author        = 'Bryan Powell'
+  spec.email         = 'bryan@metabahn.com'
+  spec.homepage      = 'http://pakyow.org'
+  spec.version       = Pakyow::Assets::VERSION
+  spec.require_path  = 'lib'
+  spec.files         = `git ls-files`.split("\n")
+  spec.license       = 'MIT'
+
+  spec.add_dependency('pakyow-support', '~> 0')
+  spec.add_dependency('pakyow-core', '~> 0')
+  spec.add_dependency('pakyow-presenter', '~> 0')
+
+  spec.add_dependency('sass', '~> 3.4')
+  spec.add_dependency('yui-compressor', '~> 0.12')
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: pakyow-assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pakyow-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pakyow-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pakyow-presenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yui-compressor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Asset Handling for Pakyow
+email: bryan@metabahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/assets.rb
+- lib/config.rb
+- lib/middleware.rb
+- lib/pakyow-assets.rb
+- lib/preprocessors/css-preprocessor.rb
+- lib/preprocessors/image-preprocessor.rb
+- lib/preprocessors/javascript-preprocessor.rb
+- lib/preprocessors/sass-preprocessor.rb
+- lib/version.rb
+- pakyow-assets.gemspec
+homepage: http://pakyow.org
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Pakyow Assets
+test_files: []
+has_rdoc: