nanoc-sprockets 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b64436c4d2e8ee089640dd6725cce5947add84b
-  data.tar.gz: c6b67620a1ff4e626949f573b10ba10f2096cf47
+  metadata.gz: d5fddcc2e8cd9e9914b917fcbdf22ae16a26acd6
+  data.tar.gz: 8fcdcd1039cc8531b35dd7a660f9edc192daa257
 SHA512:
-  metadata.gz: 5db505ce5a9f404fa801dde354696d976523715b87d83ca0547a8f1032135adba52312db4efe3c7f720e8210d79921c5b2d107848c3c68c2487bdc292695718b
-  data.tar.gz: d84c6262f801aa52c0e9f5e436da668708db4ae45bc69e48aedd3161c8fdf5fa55ef3acc6ae5e040d04ae0743735a71b4fcb14762b06f57dddc8f46e54f16872
+  metadata.gz: 213ed748b50091aa45914092bda54071d768133831b8af64191d6ca10d7cc55323345bee20b46d12e8e4b259f573c60cd00a336b17cf64e734449d27b6a3f425
+  data.tar.gz: 511c13e519aa1365e62ef6f292d66cb0ab388bf438956aac61f26ea3715d9f5fa58ee369c47c23dcb594f39d07a57b332ae84dfef3cb90612f65c363c51fb80c

data/README.md

@@ -15,7 +15,11 @@ Add *nanoc-sprockets* to you Gemfile.
 
      gem 'nanoc-sprockets'
 
-### Usage
+## Config
+
+In default.rb, require nanoc-sprockets:
+
+    require 'nanoc-sprockets'
 
 Add a new entry in your *nanoc.yaml*.
 
@@ -32,11 +36,46 @@ data_sources:
     js_compressor: uglifier
 ```
 
-### License
+* items_root: the default prefix for you assets identifier
+* compile: an array of js and css files to load as nanoc's items. Any other files are loaded automatically
+* path: the path to the assets
+* css_compressor: See [sprockets minifying assets][sprockets-minify-assets]
+* js_compressor: See [sprockets minifying assets][sprockets-minify-assets]
+* assets_additionnal_paths: an array of paths to be added to sprockets. Can be vendor/assets/javascript for example
+* digest: The assets path will have a digest. You should toggle it to false during development.
+* assets_host: Link to assets from a dedicated server.
+
+Add specific rules for assets in *Rules*:
+
+```ruby
+compile '/assets/*/' do
+end
+route '/assets/*/' do
+  Sprockets::Helpers.asset_path(item[:filename])
+end
+```
+
+If you plan to use sass, you should probably install the *[sprockets-sass][]* gem. Also install the *[uglifier][]* gem to minify javascript.
+
+## Usage
+
+To link to any assets, use the helpers providers by [sprockets-helpers][].
+
+* image_path
+* font_path
+* stylesheet_path
+* javascript_path
+* asset_path
+
+## License
 
 (c) 2014 Stormz
 
 MIT
 
-[sprockets]: https://github.com/sstephenson/sprockets
+[sprockets]: https://github.com/sstephenson/sprockets-minify-assets
 [nanoc]: http://nanoc.ws/
+[sprockets-minify-assets]: https://github.com/sstephenson/sprockets#minifying-assets
+[sprockets-sass]: https://github.com/petebrowne/sprockets-sass/
+[sprockets-helpers]: https://github.com/petebrowne/sprockets-helpers
+[uglifier]: https://github.com/lautis/uglifier

data/lib/nanoc-sprockets.rb

@@ -10,6 +10,14 @@ module Nanoc::DataSources
       path =~ /assets/ && !%w(.js .css).include?(File.extname(filename))
     end
 
+    def up
+      @config = {
+        path: 'assets',
+        compile: [],
+        assets_additionnal_paths: []
+      }.merge(@config)
+    end
+
     def items
       assets = environment.each_logical_path(*compiled_assets).to_a
 
@@ -17,12 +25,9 @@ module Nanoc::DataSources
         asset = environment.find_asset(bundle)
         is_binary = !!(asset.pathname && !@site.config[:text_extensions].include?(File.extname(asset.pathname)[1..-1]))
 
+        content_of_filename = is_binary ? asset.pathname : asset.to_s
         attributes = {filename: bundle, binary: is_binary, mtime: asset.mtime}
-        if is_binary
-          Nanoc::Item.new(asset.pathname, attributes, bundle, attributes)
-        else
-          Nanoc::Item.new(asset.to_s, attributes, bundle, attributes)
-        end
+        Nanoc::Item.new(content_of_filename, attributes, bundle, attributes)
       end
     end
 
@@ -34,11 +39,11 @@ module Nanoc::DataSources
     def create_environment
       env = ::Sprockets::Environment.new
 
-      env.append_path File.join(config[:path], 'javascripts')
-      env.append_path File.join(config[:path], 'images')
-      env.append_path File.join(config[:path], 'stylesheets')
-      config[:assets_path].each do |path|
-        env.append_path File.join(config[:path], path)
+      %w(javascripts images stylesheets fonts).each do |asset|
+        env.append_path File.join(config[:path], asset)
+      end
+      config[:assets_additionnal_paths].each do |path|
+        env.append_path path
       end
       env.js_compressor  = config[:js_compressor].to_sym
       env.css_compressor = config[:css_compressor].to_sym
@@ -47,7 +52,8 @@ module Nanoc::DataSources
       Sprockets::Helpers.configure do |c|
         c.environment = env
         c.prefix      = config[:items_root]
-        c.digest      = production?
+        c.asset_host  = config[:asset_host] if config[:asset_host]
+        c.digest      = config[:digest]     if config[:digest]
       end
       env
     end

data/nanoc-sprockets.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'nanoc-sprockets'
-  s.version     = '0.0.1'
-  s.summary     = "Use sprockets as a datasource for nanoc"
-  s.description = "A simple hello world gem"
+  s.version     = '0.0.2'
+  s.summary     = 'Use sprockets as a datasource for nanoc.'
+  s.description = 'Use sprockets as a datasource for nanoc.'
   s.homepage    = 'https://github.com/stormz/nanoc-sprockets'
   s.license     = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-sprockets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -38,7 +38,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
-description: A simple hello world gem
+description: Use sprockets as a datasource for nanoc.
 email: francois@2metz.fr
 executables: []
 extensions: []
@@ -70,6 +70,6 @@ rubyforge_project:
 rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
-summary: Use sprockets as a datasource for nanoc
+summary: Use sprockets as a datasource for nanoc.
 test_files: []
 has_rdoc: