nanoc-sprockets-filter 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nanoc-sprockets-filter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yann Lugrin
+
+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,96 @@
+# Nanoc::Sprockets::Filter
+
+A nanoc filter to use [Sprockets][sprockets], a Ruby library for compiling and serving web assets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nanoc-sprockets-filter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nanoc-sprockets-filter
+
+## Usage
+
+We recommand to install [sprockets-sass][sprockets-sass] and [sprockets-helpers][sprockets-helpers]
+gems for a better integration. Use [uglifier][uglifier] gem to minify
+javascripts. All this dependencies is optionnal and you can use another
+compressor supported by Sprockets.
+
+Require dependencies and configure Sprockets helpers to generate assets
+with digest.
+
+```ruby
+require 'sass'
+require 'uglifier'
+require 'sprockets-sass'
+require 'nanoc-sprockets-filter'
+
+Nanoc::Helpers::Sprockets.configure do |config|
+  config.environment = Nanoc::Filters::Sprockets.environment
+  config.prefix      = '/assets'
+  config.digest      = true
+end
+```
+
+Add compile rule for stylesheets and javascripts, `css_compressor`and
+`js_compressor` is optionnal and value can be replaced by any compressor
+supported by Sprockets.
+
+```ruby
+compile %r{/assets/(stylesheets|javascripts)/.+/} do
+  filter :sprockets, {
+    :css_compressor => :scss
+    :js_compressor  => :uglifier
+  }
+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)/.+/}, :rep => :gzip do
+  filter :sprockets, {
+    :css_compressor => :scss
+    :js_compressor  => :uglifier
+  }
+  filter :gzip
+end
+```
+
+Add route rule for all assets and use [sprockets-helpers][sprockets-helpers]
+to generate file path.
+
+```ruby
+route '/assets/*/' do
+  Nanoc::Helpers::Sprockets.asset_path(item)
+end
+```
+
+```ruby
+route '/assets/*/', :rep => :gzip do
+  Nanoc::Helpers::Sprockets.asset_path(item) + '.gz'
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[sprockets]: https://github.com/sstephenson/sprockets "Rack-based asset packaging"
+[sprockets-sass]: https://github.com/petebrowne/sprockets-sass "Better Sass integration with Sprockets 2.x"
+[sprockets-helpers]: https://github.com/petebrowne/sprockets-helpers "Asset path helpers for Sprockets 2.x applications"
+[uglifier]: https://github.com/lautis/uglifier "Ruby wrapper for UglifyJS JavaScript compressor"
+[nanoc-gzip-filter]: https://github.com/yannlugrin/nanoc-sprockets-filter "A nanoc filter to gzip content"
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/nanoc/filters/sprockets.rb

@@ -0,0 +1,46 @@
+require 'nanoc'
+
+module Nanoc
+  module Filters
+    class Sprockets < Nanoc::Filter
+      VERSION = '0.0.1'
+
+      type :text
+
+      def self.environment
+        nanoc_stderr = $stderr
+        $stderr = STDERR
+
+        environment = ::Sprockets::Environment.new(File.expand_path('.')) do |env|
+          assets =  ['javascripts', 'stylesheets', 'images', 'fonts']
+          paths =   ['content/assets/', 'lib/assets/', 'assets/', 'vendor/assets/' ].map{|p| assets.map{|f| "#{p}#{f}" } }.flatten
+
+          paths.each{ |path| env.append_path path }
+        end
+
+        $stderr = nanoc_stderr
+
+        environment
+      end
+
+      def environment
+        @environment ||= self.class.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]
+          asset.to_s
+        else
+          raise "error locating #{filename} / #{@item[:filename]}"
+        end
+      end
+
+    end
+  end
+end
+

data/lib/nanoc/helpers/sprockets.rb

@@ -0,0 +1,55 @@
+begin
+  require 'sprockets-helpers'
+rescue LoadError => e
+  $stderr.puts e
+  $stderr.puts "If you are using a Gemfile, make sure that the Gemfile contains sprockets-helpers ('gem \"sprockets-helpers\"')."
+  exit 1
+end
+
+module Nanoc
+  module Helpers
+    module Sprockets
+      module ModuleMethods
+
+        def asset_path(item_or_filename, options = {})
+          if item_or_filename.is_a?(Nanoc::Item)
+            filename = item_or_filename
+          else
+            filename = item_or_filename
+          end
+          filename = File.basename(filename).gsub(/^(\w+\.\w+).*/, '\1')
+
+          if rep_name = options.delete(:rep)
+            rep_prefix = rep_name.to_s + '_'
+          else
+            rep_prefix = ''
+          end
+
+          super(filename, options).gsub(/([^\/]+)$/, "#{rep_prefix}\\1")
+        end
+
+      end
+
+      def self.included(base)
+        base.send :include, ::Sprockets::Helpers
+        base.send :include, ModuleMethods
+      end
+
+      def method_missing(method, *args)
+        if ::Sprockets::Helpers.respond_to?(method)
+          if block_given?
+            ::Sprockets::Helpers.send(method, *args) do |*block_args|
+              yield *block_args
+            end
+          else
+            ::Sprockets::Helpers.send(method, *args)
+          end
+        else
+          super
+        end
+      end
+
+    end
+  end
+end
+

data/lib/nanoc-sprockets-filter.rb

@@ -0,0 +1,15 @@
+require 'nanoc'
+require 'sprockets'
+
+module Nanoc
+  module Filters
+    autoload 'Sprockets', 'nanoc/filters/sprockets'
+
+    Nanoc::Filter.register '::Nanoc::Filters::Sprockets', :sprockets
+  end
+
+  module Helpers
+    autoload 'Sprockets', 'nanoc/helpers/sprockets'
+  end
+end
+

data/nanoc-sprockets-filter.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nanoc/filters/sprockets', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Yann Lugrin']
+  gem.email         = ['yann.lugrin@sans-savoir.net']
+  gem.description   = %q{A nanoc filter to use Sprockets, a Ruby library for compiling and serving web assets.}
+  gem.summary       = %q{A nanoc filter to use Sprockets, a Ruby library for compiling and serving web assets.}
+  gem.homepage      = 'https://github.com/yannlugrin/nanoc-sprockets-filter'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'nanoc-sprockets-filter'
+  gem.require_paths = ['lib']
+  gem.version       = Nanoc::Filters::Sprockets::VERSION
+
+  gem.add_dependency 'nanoc',     '>= 3.4.0'
+  gem.add_dependency 'sprockets', '>= 2.8.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'sprockets-helpers'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-sprockets-filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yann Lugrin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-helpers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A nanoc filter to use Sprockets, a Ruby library for compiling and serving
+  web assets.
+email:
+- yann.lugrin@sans-savoir.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nanoc-sprockets-filter.rb
+- lib/nanoc/filters/sprockets.rb
+- lib/nanoc/helpers/sprockets.rb
+- nanoc-sprockets-filter.gemspec
+homepage: https://github.com/yannlugrin/nanoc-sprockets-filter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3970027099751348058
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3970027099751348058
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A nanoc filter to use Sprockets, a Ruby library for compiling and serving
+  web assets.
+test_files: []