nanoc-sprockets3 1.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52611d2cfa03fe313781712dca2de841e01ec055
+  data.tar.gz: cd41d0f48ce71ca8f7efd4dcbe4b175a1780843f
+SHA512:
+  metadata.gz: 77775cc7d0fc9129c2d353febd6dbbc3c764db8bcfecaeb1d926869d5a913f759eab8830757932bf917fa9a3669072f4cb51f0a17c522d41352a5be6819a0940
+  data.tar.gz: 15b1e2e5f8fe870792731e199a5f2e2287ad348db9aa18c17c788ae1aead1074771415e7bbaffe097e73c0a56e86025ae0d1bf3a43f1fef7ad4d5a14cbf2391c

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Remi Barraquand
+
+MIT License
+
+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,142 @@
+# Nanoc::Sprockets3
+
+A nanoc extension to use [Sprockets 3.x][sprockets], a Ruby library for compiling and serving web assets.
+
+You are using [nanoc-sprockets-filter][nanoc-sprockets-filter] or [nanoc-sprockets-datasource][nanoc-sprockets] and
+you would like to use Sprockets 3.x to take advantages of the news features then [nanoc-sprockets3] is
+what you are looking for !
+
+**Note:** *Unlike [nanoc-sprockets-filter] or [nanoc-sprockets] that lack a support
+for dependency tracking, which is annoying when working with partials and/or livereload, [nanoc-sprockets3] is built
+on top of [Sprockets 3.x][sprockets] and integrates seamlessly with Nanoc3/nanoc4 and livereload.
+With [nanoc-sprockets3] no need to clear the cache or purge the output to regenerate your assets whenever partials
+or dependencies change !*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nanoc-sprockets3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nanoc-sprockets3
+
+## Configuration
+
+[nanoc-sprockets3][nanoc-sprockets3] does not require any mandatory configuration, however you may want to configure it
+for your needs. Currently you can configure [nanoc-sprockets3][nanoc-sprockets3] with two parameters:
+ - *prefix* which is the prefix to give to all assets
+ - *environment* which is the Sprockets environment to use
+
+The default environment is configured with the following paths
+- content/assets/
+- vendor/assets/
+- static/assets/
+
+concatenated with the following sub-paths
+- stylesheets
+- stylesheets/pages
+- stylesheets/vendor
+- javascripts
+- javascripts/pages
+- javascripts/vendor
+- fonts
+
+To load the default  [nanoc-sprockets] configuration do as follow:
+
+```ruby
+include Nanoc::Sprockets::Helper
+
+```
+
+To fully customize the [nanoc-sprockets] configuration do as follow:
+
+```ruby
+include Nanoc::Sprockets::Helper
+
+Nanoc::Sprockets::Helper.configure do |config|
+  config.environment = ::Sprockets::Environment.new(File.expand_path('.')) do |env|
+    env.append_path 'app/assets/javascripts'
+    env.append_path 'lib/assets/javascripts'
+    env.append_path 'vendor/assets/jquery'
+  end
+  config.prefix      = '/assets'
+end
+```
+
+**Note:** you can find more advanced configuration on the [sprockets website][sprockets].
+
+## Usage
+
+We recommend the use of [uglifier][uglifier] gem to minify javascripts.
+You may use any other compressor supported by Sprockets.
+
+Add compile rule for stylesheets and javascripts, `css_compressor`and `js_compressor` is optional
+and value can be replaced by any compressor supported by Sprockets.
+Add route rule for all assets and use `Nanoc::Sprockets::Helper.asset_path(item)` to generate file path.
+
+```ruby
+compile %r{/assets/(stylesheets|javascripts)/.+/} do
+  filter :sprockets, {
+    :css_compressor => :scss,
+    :js_compressor  => :uglifier
+  }
+end
+
+route '/assets/*/' do
+  Nanoc::Sprockets::Helper.asset_path(item)
+end
+```
+
+You can use [nanoc-gzip-filter][nanoc-gzip-filter] to create a
+gzipped version of stylesheets and javascripts files.
+
+```ruby
+compile %r{/assets/(stylesheets|javascripts)/.+/} do
+  filter :sprockets, {
+    :css_compressor => :scss,
+    :js_compressor  => :uglifier
+  }
+  snapshot :text
+  filter :gzip
+end
+
+route '/assets/*/', :snapshot => :text do
+  Nanoc::Sprockets::Helper.asset_path(item)
+end
+
+route '/assets/*/' do
+  Nanoc::Sprockets::Helper.asset_path(item) + '.gz'
+end
+```
+
+**Note:** Don't forget to require 'nanoc-sprockets' (e.g in `lib/default.rb`)
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/nanoc-sprockets/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Acknowledgement
+
+I wrote this plugin to bring the support of Sprockets 3.x to nanoc and take benefit of the dependencies tracking system
+introduced in Sprockets 3.x.
+
+This plugin is inspired by [nanoc-sprockets-filter][nanoc-sprockets-filter] which support Sprockets 2.x but lacks a support
+for dependency tracking which makes it annoying to use with livereload and partials.
+
+[nanoc-sprockets3]: https://github.com/barraq/nanoc-sprockets "Sprockets 3.x support for nanoc"
+[sprockets]: https://github.com/sstephenson/sprockets "Rack-based asset packaging"
+[nanoc-sprockets-filter]: https://github.com/yannlugrin/nanoc-sprockets-filter "A nanoc filter to use Sprocket 2.x"
+[nanoc-sprockets]: https://github.com/stormz/nanoc-sprockets "Use sprockets 2.x as a datasource for nanoc"
+[nanoc-gzip-filter]: https://github.com/yannlugrin/nanoc-gzip-filter "A Nanoc filter to gzip content"
+[uglifier]: https://github.com/lautis/uglifier "Ruby wrapper for UglifyJS JavaScript compressor"

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nanoc/sprockets/filter.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Nanoc::Sprockets
+
+  class Filter < Nanoc::Filter
+
+    identifier :sprockets
+    type :text
+
+    def environment
+      @environment ||= Nanoc::Sprockets::Helper.environment
+    end
+
+    def run(content, params = {})
+      filename = File.basename(@item[:filename])
+
+      environment.css_compressor = params[:css_compressor]
+      environment.js_compressor  = params[:js_compressor]
+
+      if asset = environment[filename]
+        update_dependencies_for_current_item(asset.metadata[:dependency_paths])
+        asset.to_s
+      else
+        raise "error locating #{filename} / #{@item[:filename]}"
+      end
+    end
+
+    def update_dependencies_for_current_item(dependencies)
+      dependencies.each do |dep|
+        item = imported_filename_to_item(dep)
+        depend_on([item]) unless item.nil? or item.identifier == @item.identifier
+      end
+    end
+
+    def imported_filename_to_item(filename)
+      @items.find do |i|
+        i.raw_filename &&
+            Pathname.new(i.raw_filename).realpath == Pathname.new(filename).realpath
+      end
+    end
+  end
+end

data/lib/nanoc/sprockets/helper.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'sprockets'
+
+module Nanoc::Sprockets
+
+  module Helper
+
+    DEFAULT_ASSETS_DIRS = [
+        'stylesheets', 'stylesheets/pages', 'stylesheets/vendor',
+        'javascripts', 'javascripts/pages', 'javascripts/vendor',
+        'fonts'
+    ]
+
+    DEFAULT_ASSETS_PATHS = [
+        'content/assets/', 'vendor/assets/', 'static/assets/'
+    ]
+
+    class << self
+      # Set the Sprockets environment to search for assets.
+      # This defaults to the context's #environment method.
+      def environment
+        @environment ||= ::Sprockets::Environment.new(File.expand_path('.')) do |env|
+          paths =   DEFAULT_ASSETS_DIRS + DEFAULT_ASSETS_PATHS.map{|p| DEFAULT_ASSETS_DIRS.map{|f| "#{p}#{f}"}}.flatten
+          paths.each{ |path| env.append_path path }
+        end
+      end
+      attr_writer :environment
+
+      # The base URL the Sprocket environment is mapped to.
+      # This defaults to '/assets'.
+      def prefix
+        @prefix ||= '/assets'
+      end
+      attr_writer :prefix
+
+    end
+
+    # Convience method for configuring Nanoc::Sprockets::Helpers.
+    def configure
+      yield self
+    end
+
+    # Returns the path to an item or a filename either in the Sprockets environment.
+    def asset_path(item_or_filename, options = {})
+      if item_or_filename.is_a?(::Nanoc::Item)
+        filename = item_or_filename[:filename]
+      else
+        filename = item_or_filename
+      end
+      filename = File.basename(filename).gsub(/^(\w+\.\w+).*/, '\1')
+
+      if asset = Helper.environment[filename]
+        File.join(Helper.prefix, asset.logical_path)
+      else
+        raise "error locating #{filename}."
+      end
+    end
+  end
+
+end

data/lib/nanoc/sprockets/version.rb

@@ -0,0 +1,5 @@
+module Nanoc
+  module Sprockets
+    VERSION = "1.0.0.1"
+  end
+end

data/lib/nanoc/sprockets.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Nanoc
+  module Sprockets
+  end
+end
+
+require "nanoc/sprockets/version"
+require "nanoc/sprockets/helper"
+require "nanoc/sprockets/filter"

data/lib/nanoc-sprockets.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'nanoc/sprockets'

data/nanoc-sprockets.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nanoc/sprockets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nanoc-sprockets3'
+  spec.version       = Nanoc::Sprockets::VERSION
+  spec.homepage      = 'https://github.com/barraq/nanoc-sprockets'
+  spec.summary       = %q{Sprockets 3.x support for nanoc.}
+  spec.description   = %q{Provides Sprockets 3.x helper and filter for nanoc.}
+
+  spec.authors       = ["Remi Barraquand"]
+  spec.email         = ["dev@remibarraquand.com"]
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.rdoc_options     = [ '--main', 'README.md' ]
+  spec.extra_rdoc_files = [ 'LICENSE', 'README.md' ]
+
+  spec.add_runtime_dependency 'sprockets', '~> 3.0.0.beta'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-sprockets3
+version: !ruby/object:Gem::Version
+  version: 1.0.0.1
+platform: ruby
+authors:
+- Remi Barraquand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Provides Sprockets 3.x helper and filter for nanoc.
+email:
+- dev@remibarraquand.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nanoc-sprockets.rb
+- lib/nanoc/sprockets.rb
+- lib/nanoc/sprockets/filter.rb
+- lib/nanoc/sprockets/helper.rb
+- lib/nanoc/sprockets/version.rb
+- nanoc-sprockets.gemspec
+homepage: https://github.com/barraq/nanoc-sprockets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Sprockets 3.x support for nanoc.
+test_files: []