jekyll-assets 0.2.0 → 0.2.1

data/README.md

@@ -6,8 +6,8 @@
 
 Jekyll plugin, that adds Rails-alike assets pipeline, that means that:
 
-- It allows you to write these assets in other languages such as CoffeeScript,
-  Sass, Less and ERB.
+- It allows you to write javascript/css assets in other languages such as
+  CoffeeScript, Sass, Less and ERB.
 - It allows you to specify dependencies between your assets and automatically
   concatenates them.
 - It allows you to minify/compress your JavaScript and CSS assets using
@@ -22,8 +22,8 @@ Jekyll-Assets uses fabulous [Sprockets][sprockets] under the hood, so you may
 refer to Rails guide about [Asset Pipeline][rails-guide] for detailed
 information about amazing features it gives you.
 
-*Notice:* You must have an [ExecJS][extjs] supported runtime in order to use
-CoffeeScript.
+*Note:* You must have an [ExecJS][extjs] supported runtime in order to use
+  CoffeeScript.
 
 
 [rails-guide]:  http://guides.rubyonrails.org/asset_pipeline.html
@@ -57,10 +57,10 @@ require "jekyll-assets"
 
 Once plugin installed, you'll have following liquid tags available:
 
-- `javascript app`: Generates `<script>` tag for `app.js`
-- `stylesheet app`: Generates `<link>` tag for `app.css`
-- `asset_path logo.png`: Returns _resulting_ URL for `logo.png`
-- `asset app.css`: Returns _compiled_ body of `app.css`
+- `{% javascript app %}`: Generates `<script>` tag for `app.js`
+- `{% stylesheet app %}`: Generates `<link>` tag for `app.css`
+- `{% asset_path logo.png %}`: Returns _resulting_ URL for `logo.png`
+- `{% asset app.css %}`: Returns _compiled_ body of `app.css`
 
 All compiled assets will be stored under `assets/` dir of generated site.
 
@@ -96,8 +96,8 @@ $(function () {
 });
 ```
 
-Now, if you want to use CoffeScript, just add `.coffee` suffix to the file you
-want and you good to go. For example, here's how your `app.js.coffe` might look
+If you want to use CoffeScript, just add `.coffee` suffix to the file you want
+and you're good to go. For example, here's how your `app.js.coffe` might look
 like:
 
 ``` coffeescript
@@ -107,7 +107,13 @@ $ ->
   alert 'I love BIG BOOKS! And small ones too!'
 ```
 
-Now, you might want your stylesheets and javascripts to be minified. In this
+Notice, that `vendor/jquery` is not required to be coffee script. You can easily
+mix CoffeeScript and vanilla JavaScript, CSS and SCSS and SASS and LESS. The
+difference is only in comments styles used with _directives_.
+
+See detailes information about these _directives_ below.
+
+You might also want your stylesheets and javascripts to be minified. In this
 case just install `uglifier` gem and add following lines into your `config.yml`:
 
 ``` yaml
@@ -117,16 +123,15 @@ assets:
     css:  sass
 ```
 
-You might want to use YUI compressor for minification. In this case install
-`yui-compressor` gem and put `yui` in place of `uglifier` and/or `sass` in the
-config file.
+If you want to use YUI compressor for minification, install `yui-compressor`
+gem and put `yui` in place of `uglifier` and/or `sass` in the config file.
 
 Let's go crazy now! Assume you want your blog's `body` background color to be
 white all the time, but red in December. Just add `.erb` suffix extension and
 you can use ruby to "pre-process" asset, something like this:
 
 ```
-# file: _assets/stylesheets/app.css.sass.erb
+// file: _assets/stylesheets/app.css.sass.erb
 
 body
   background-color: <%= (12 == Date.today.month) ? "red" : "white" %>
@@ -153,6 +158,25 @@ $ ->
     info: "I love BIG BOOKS! And small ones too!"
 ```
 
+Finally, you might want to store your assets on [Amazon S3][amazon-s3] or any
+CDN service you like. As said previously, all compiled/processed assets got
+special MD5 checksum appended to their original filenames. So, for example,
+your `app.js.coffee` will become something like:
+
+    app-4f41243847da693a4f356c0486114bc6.js
+
+By default, generated URLs will have `/assets/` prefixes, but you will want to
+change this if you are going to host assets somewhere else. This can be easily
+changed via configuration:
+
+``` yaml
+assets:
+  baseurl: //my.super-cool-cdn.com/
+```
+
+[amazon-s3]: http://aws.amazon.com/s3
+
+
 That's all. Feel free to ask questions if any on [twitter][twitter],
 [jabber][jabber] or [e-mail][e-mail].
 
@@ -161,6 +185,97 @@ That's all. Feel free to ask questions if any on [twitter][twitter],
 [e-mail]:   mailto://ixti@member.fsf.org
 
 
+## The Directive Processor
+
+*Note:* This section extracted from [Sprockets][sprockets] README.
+
+Sprockets runs the *directive processor* on each CSS and JavaScript
+source file. The directive processor scans for comment lines beginning
+with `=` in comment blocks at the top of the file.
+
+    //= require jquery
+    //= require jquery-ui
+    //= require backbone
+    //= require_tree .
+
+The first word immediately following `=` specifies the directive
+name. Any words following the directive name are treated as
+arguments. Arguments may be placed in single or double quotes if they
+contain spaces, similar to commands in the Unix shell.
+
+**Note**: Non-directive comment lines will be preserved in the final
+  asset, but directive comments are stripped after
+  processing. Sprockets will not look for directives in comment blocks
+  that occur after the first line of code.
+
+
+### Supported Comment Types
+
+The directive processor understands comment blocks in three formats:
+
+    /* Multi-line comment blocks (CSS, SCSS, JavaScript)
+     *= require foo
+     */
+
+    // Single-line comment blocks (SCSS, JavaScript)
+    //= require foo
+
+    # Single-line comment blocks (CoffeeScript)
+    #= require foo
+
+
+### Sprockets Directives
+
+You can use the following directives to declare dependencies in asset
+source files.
+
+For directives that take a *path* argument, you may specify either a
+logical path or a relative path. Relative paths begin with `./` and
+reference files relative to the location of the current file.
+
+#### The `require` Directive
+
+`require` *path* inserts the contents of the asset source file
+specified by *path*. If the file is required multiple times, it will
+appear in the bundle only once.
+
+#### The `include` Directive
+
+`include` *path* works like `require`, but inserts the contents of the
+specified source file even if it has already been included or
+required.
+
+#### The `require_directory` Directive
+
+`require_directory` *path* requires all source files of the same
+format in the directory specified by *path*. Files are required in
+alphabetical order.
+
+#### The `require_tree` Directive
+
+`require_tree` *path* works like `require_directory`, but operates
+recursively to require all files in all subdirectories of the
+directory specified by *path*.
+
+#### The `require_self` Directive
+
+`require_self` tells Sprockets to insert the body of the current
+source file before any subsequent `require` or `include` directives.
+
+#### The `depend_on` Directive
+
+`depend_on` *path* declares a dependency on the given *path* without
+including it in the bundle. This is useful when you need to expire an
+asset's cache in response to a change in another file.
+
+#### The `stub` Directive
+
+`stub` *path* allows dependency to be excluded from the asset bundle.
+The *path* must be a valid asset and may or may not already be part
+of the bundle. Once stubbed, it is blacklisted and can't be brought
+back by any other `require`.
+
+
 ## Configuration
 
 You can fine-tune configuration by editing your `_config.yml`:

data/jekyll-assets.gemspec

@@ -6,10 +6,14 @@ Gem::Specification.new do |gem|
   gem.name          = "jekyll-assets"
   gem.version       = Jekyll::AssetsPlugin::VERSION
   gem.homepage      = "http://ixti.github.com/jekyll-assets"
-  gem.authors       = %w{Aleksey V Zapparov}
+  gem.authors       = "Aleksey V Zapparov"
   gem.email         = %w{ixti@member.fsf.org}
   gem.summary       = "jekyll-assets-#{Jekyll::AssetsPlugin::VERSION}"
-  gem.description   = %q{Adds assets pipelines for Jekyll}
+  gem.description   = <<-DESC
+  Jekyll plugin, that allows you to write javascript/css assets in
+  other languages such as CoffeeScript, Sass, Less and ERB, concatenate
+  them, respecting dependencies, minify and many more.
+  DESC
 
   gem.add_dependency "jekyll"
   gem.add_dependency "sprockets", "~> 2.8"

data/lib/jekyll/assets_plugin/asset_file.rb

@@ -45,8 +45,8 @@ module Jekyll
 
       def == other
         case other
-        when AssetFile        then other.asset.logical_path == asset.logical_path
-        when Sprockets::Asset then other.logical_path == asset.logical_path
+        when AssetFile        then same_asset? other.asset
+        when Sprockets::Asset then same_asset? other
         else false
         end
       end
@@ -54,6 +54,12 @@ module Jekyll
       def to_s
         "#<Jekyll::AssetsPlugin::AssetFile:#{asset.logical_path}>"
       end
+
+      protected
+
+      def same_asset? other
+        other.pathname.cleanpath == asset.pathname.cleanpath
+      end
     end
   end
 end

data/lib/jekyll/assets_plugin/site_patch.rb

@@ -26,15 +26,15 @@ module Jekyll
           @assets.css_compressor  = assets_config.css_compressor
 
           # bind jekyll and Sprockets context together
-          @assets.context_class.instance_variable_set :@jekyll_site, self
+          @assets.context_class.instance_variable_set :@site, self
 
           @assets.context_class.class_eval do
-            def jekyll_site
-              self.class.instance_variable_get :@jekyll_site
+            def site
+              self.class.instance_variable_get :@site
             end
 
             def asset_baseurl
-              jekyll_site.assets_config.baseurl.chomp "/"
+              site.assets_config.baseurl.chomp "/"
             end
 
             def asset_path(path, options = {})
@@ -42,8 +42,8 @@ module Jekyll
                 raise AssetFile::NotFound, "couldn't find file '#{path}'"
               end
 
-              unless jekyll_site.static_files.include? asset
-                jekyll_site.static_files << AssetFile.new(jekyll_site, asset)
+              unless site.static_files.include? asset
+                site.static_files << AssetFile.new(site, asset)
               end
 
               "#{asset_baseurl}/#{asset.digest_path}".squeeze "/"

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,17 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
-- Aleksey
-- V
-- Zapparov
+- Aleksey V Zapparov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-28 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -109,7 +107,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds assets pipelines for Jekyll
+description: ! "  Jekyll plugin, that allows you to write javascript/css assets in\n
+  \ other languages such as CoffeeScript, Sass, Less and ERB, concatenate\n  them,
+  respecting dependencies, minify and many more.\n"
 email:
 - ixti@member.fsf.org
 executables: []
@@ -172,7 +172,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.2.0
+summary: jekyll-assets-0.2.1
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb