jekyll-assets 0.2.3 → 0.3.0

data/HISTORY.md

@@ -1,3 +1,8 @@
+### 0.3.0 (2013-01-08)
+
+* Add complimentary filters (same names as tags).
+
+
 ### 0.2.3 (2013-01-07)
 
 * Add built-in bourbon support as: `require "jekyll-assets/bourbon"`.

data/README.md

@@ -60,13 +60,28 @@ into `_plugins/ext.rb` file:
 require "jekyll-assets"
 ```
 
-Once plugin installed, you'll have following liquid tags available:
+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`
 
+Also you'll have complimentary Liquid filters as well:
+
+- `{{ 'app' | javascript }}`: Generates `<script>` tag for `app.js`
+- `{{ 'app' | stylesheet }}`: Generates `<link>` tag for `app.css`
+- `{{ 'logo.png' | asset_path }}`: Returns _resulting_ URL for `logo.png`
+- `{{ 'app.css' | asset }}`: Returns _compiled_ body of `app.css`
+
+Filters are used mostly to render tag (or asset source) using variable that
+holds value of asset logical path rather than specifiyng it directly. Here's
+an example that speaks for itself:
+
+```
+{% if page.custom_css %}{{ page.custom_css | stylesheet }}{% endif %}
+```
+
 All compiled assets will be stored under `assets/` dir of generated site.
 
 Pipeline assets should be under your sources directory of Jekyll site. When a

data/lib/jekyll/assets_plugin.rb

@@ -3,6 +3,7 @@ require 'liquid'
 
 
 require 'jekyll/assets_plugin/site_patch'
+require 'jekyll/assets_plugin/filters'
 require 'jekyll/assets_plugin/tag'
 require 'jekyll/assets_plugin/version'
 
@@ -10,7 +11,10 @@ require 'jekyll/assets_plugin/version'
 Jekyll::Site.send :include, Jekyll::AssetsPlugin::SitePatch
 
 
-Liquid::Template.register_tag('javascript', Jekyll::AssetsPlugin::Tag)
-Liquid::Template.register_tag('stylesheet', Jekyll::AssetsPlugin::Tag)
-Liquid::Template.register_tag('asset_path', Jekyll::AssetsPlugin::Tag)
-Liquid::Template.register_tag('asset',      Jekyll::AssetsPlugin::Tag)
+Liquid::Template.register_filter Jekyll::AssetsPlugin::Filters
+
+
+Liquid::Template.register_tag 'javascript', Jekyll::AssetsPlugin::Tag
+Liquid::Template.register_tag 'stylesheet', Jekyll::AssetsPlugin::Tag
+Liquid::Template.register_tag 'asset_path', Jekyll::AssetsPlugin::Tag
+Liquid::Template.register_tag 'asset',      Jekyll::AssetsPlugin::Tag

data/lib/jekyll/assets_plugin/configuration.rb

@@ -28,8 +28,8 @@ module Jekyll
     #
     # ##### dirname
     #
-    # Pathname of the destination of generated (bundled) assets relative to the
-    # destination of the root.
+    # Destination pathname of processed assets relative to the compiled site
+    # root (which is `_site` by default).
     #
     # Default: 'assets'
     #

data/lib/jekyll/assets_plugin/filters.rb

@@ -0,0 +1,18 @@
+# internal
+require 'jekyll/assets_plugin/renderer'
+
+
+module Jekyll
+  module AssetsPlugin
+    module Filters
+      %w{ asset asset_path javascript stylesheet }.each do |name|
+        module_eval <<-RUBY, __FILE__, __LINE__
+        def #{name} path                    # def stylesheet logical_path
+          r = Renderer.new @context, path   #   r = Renderer.new @context, path
+          r.render_#{name}                  #   r.render_stylesheet
+        end                                 # end
+        RUBY
+      end
+    end
+  end
+end

data/lib/jekyll/assets_plugin/renderer.rb

@@ -0,0 +1,48 @@
+module Jekyll
+  module AssetsPlugin
+    class Renderer
+      STYLESHEET = '<link rel="stylesheet" type="text/css" href="%s">'
+      JAVASCRIPT = '<script type="text/javascript" src="%s"></script>'
+
+      def initialize context, logical_path
+        @site = context.registers[:site]
+        @path = logical_path.strip
+      end
+
+      def render_asset
+        asset.to_s
+      end
+
+      def render_asset_path
+        unless @site.static_files.include? asset
+          @site.static_files << AssetFile.new(@site, asset)
+        end
+
+        return "#{@site.assets_config.baseurl.chomp '/'}/#{asset.digest_path}"
+      end
+
+      def render_javascript
+        @path << '.js' if File.extname(@path).empty?
+
+        JAVASCRIPT % render_asset_path
+      end
+
+      def render_stylesheet
+        @path << '.css' if File.extname(@path).empty?
+
+        STYLESHEET % render_asset_path
+      end
+
+      protected
+
+      def asset
+        unless @asset ||= @site.assets[@path]
+          raise AssetFile::NotFound, "couldn't find file '#{@path}'"
+        end
+
+        @asset
+      end
+    end
+  end
+end
+

data/lib/jekyll/assets_plugin/tag.rb

@@ -2,8 +2,8 @@
 require 'liquid'
 
 
-# stdlib
-require 'set'
+# internal
+require 'jekyll/assets_plugin/renderer'
 
 
 module Jekyll
@@ -47,67 +47,8 @@ module Jekyll
     #
     #
     class Tag < Liquid::Tag
-      STYLESHEET = '<link rel="stylesheet" type="text/css" href="%s">'
-      JAVASCRIPT = '<script type="text/javascript" src="%s"></script>'
-      EXTENSIONS = { 'stylesheet' => '.css', 'javascript' => '.js' }
-
-      @@errors = Set.new
-
-      def initialize tag_name, logical_path, tokens
-        super
-
-        @logical_path = logical_path.strip
-
-        # append auto-guessed extension if needed
-        @logical_path << default_extension if File.extname(@logical_path).empty?
-      end
-
       def render context
-        send :"render_#{@tag_name}", context
-      end
-
-      protected
-
-      def default_extension
-        EXTENSIONS[@tag_name].to_s
-      end
-
-      def with_asset context, &block
-        site  = context.registers[:site]
-        path  = @logical_path
-        asset = site.assets[path]
-
-        raise AssetFile::NotFound, "couldn't find file '#{path}'" unless asset
-
-        yield asset, site
-      end
-
-      def render_asset context
-        with_asset context do |asset|
-          return asset.to_s
-        end
-      end
-
-      def render_asset_path context
-        with_asset context do |asset, site|
-          unless site.static_files.include? asset
-            site.static_files << AssetFile.new(site, asset)
-          end
-
-          return "#{site.assets_config.baseurl.chomp '/'}/#{asset.digest_path}"
-        end
-      end
-
-      def render_javascript context
-        if url = render_asset_path(context)
-          return JAVASCRIPT % [url]
-        end
-      end
-
-      def render_stylesheet context
-        if url = render_asset_path(context)
-          return STYLESHEET % [url]
-        end
+        Renderer.new(context, @markup).send :"render_#{@tag_name}"
       end
     end
   end

data/lib/jekyll/assets_plugin/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AssetsPlugin
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/spec/lib/jekyll/assets_plugin/filters_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+
+module Jekyll::AssetsPlugin
+  describe Filters do
+    let(:context) { { :registers => { :site => @site } } }
+
+    def render content
+      Liquid::Template.parse(content).render({}, context)
+    end
+
+    context "{{ '<file>' | stylesheet }}" do
+      def tag_re name
+        file = "/assets/#{name}-[a-f0-9]{32}\.css"
+        Regexp.new "^#{Renderer::STYLESHEET % file}$"
+      end
+
+      context "when <file> exists" do
+        subject { render("{{ 'app.css' | stylesheet }}") }
+        it { should match tag_re("app") }
+      end
+
+      context "when <file> extension is omited" do
+        subject { render("{{ 'app' | stylesheet }}") }
+        it { should match tag_re("app") }
+      end
+
+      context "when <file> does not exists" do
+        subject { render("{{ 'not-found.css' | stylesheet }}") }
+        it { should match "Liquid error: couldn't find file 'not-found.css'" }
+      end
+    end
+
+    context "{{ '<file>' | javascript }}" do
+      def tag_re name
+        file = "/assets/#{name}-[a-f0-9]{32}\.js"
+        Regexp.new "^#{Renderer::JAVASCRIPT % file}$"
+      end
+
+      context "when <file> exists" do
+        subject { render("{{ 'app.js' | javascript }}") }
+        it { should match tag_re("app") }
+      end
+
+      context "when <file> extension omited" do
+        subject { render("{{ 'app' | javascript }}") }
+        it { should match tag_re("app") }
+      end
+
+      context "when <file> does not exists" do
+        subject { render("{{ 'not-found.js' | javascript }}") }
+        it { should match "Liquid error: couldn't find file 'not-found.js'" }
+      end
+    end
+
+    context "{{ '<file.ext>' | asset_path }}" do
+      context "when <file> exists" do
+        subject { render("{{ 'app.css' | asset_path }}") }
+        it { should match(%r{^/assets/app-[a-f0-9]{32}\.css$}) }
+      end
+
+      context "when <file> does not exists" do
+        subject { render("{{ 'not-found.css' | asset_path }}") }
+        it { should match "Liquid error: couldn't find file 'not-found.css'" }
+      end
+
+      context "with baseurl given as /foobar/" do
+        before { context[:registers][:site].assets_config.baseurl = "/foobar/" }
+        subject { render("{{ 'app.css' | asset_path }}") }
+        it { should match(%r{^/foobar/app-[a-f0-9]{32}\.css$}) }
+      end
+    end
+
+    context "{{ '<file.ext>' | asset }}" do
+      context "when <file> exists" do
+        subject { render("{{ 'app.css' | asset }}") }
+        it { should match(/body \{ background-image: url\(.+?\) \}/) }
+      end
+
+      context "when <file> does not exists" do
+        subject { render("{{ 'not-found.js' | asset }}") }
+        it { should match "Liquid error: couldn't find file 'not-found.js'" }
+      end
+    end
+  end
+end

data/spec/lib/jekyll/assets_plugin/tag_spec.rb

@@ -12,25 +12,20 @@ module Jekyll::AssetsPlugin
     context '{% stylesheet <file> %}' do
       def tag_re name
         file = "/assets/#{name}-[a-f0-9]{32}\.css"
-        Regexp.new "^#{Tag::STYLESHEET % file}$"
+        Regexp.new "^#{Renderer::STYLESHEET % file}$"
       end
 
-      context 'when <file> is bundled' do
+      context 'when <file> exists' do
         subject { render('{% stylesheet app.css %}') }
         it { should match tag_re("app") }
       end
 
-      context 'when <file> is not explicitly bundled' do
-        subject { render('{% stylesheet vapor.css %}') }
-        it { should match tag_re("vapor") }
-      end
-
       context 'when <file> extension is omited' do
         subject { render('{% stylesheet app %}') }
         it { should match tag_re("app") }
       end
 
-      context 'when <file> is not found' do
+      context 'when <file> does not exists' do
         subject { render('{% stylesheet not-found.css %}') }
         it { should match "Liquid error: couldn't find file 'not-found.css'" }
       end
@@ -39,55 +34,32 @@ module Jekyll::AssetsPlugin
     context '{% javascript <file> %}' do
       def tag_re name
         file = "/assets/#{name}-[a-f0-9]{32}\.js"
-        Regexp.new "^#{Tag::JAVASCRIPT % file}$"
+        Regexp.new "^#{Renderer::JAVASCRIPT % file}$"
       end
 
-      context 'when <file> is bundled' do
+      context 'when <file> exists' do
         subject { render('{% javascript app.js %}') }
         it { should match tag_re("app") }
       end
 
-      context 'when <file> is not explicitly bundled' do
-        subject { render('{% javascript vapor.js %}') }
-        it { should match tag_re("vapor") }
-      end
-
       context 'when <file> extension omited' do
         subject { render('{% javascript app %}') }
         it { should match tag_re("app") }
       end
 
-      context 'when <file> is not found' do
+      context 'when <file> does not exists' do
         subject { render('{% javascript not-found.js %}') }
         it { should match "Liquid error: couldn't find file 'not-found.js'" }
       end
     end
 
     context '{% asset_path <file.ext> %}' do
-      context 'when <file> is bundled' do
+      context 'when <file> exists' do
         subject { render('{% asset_path app.css %}') }
         it { should match(%r{^/assets/app-[a-f0-9]{32}\.css$}) }
       end
 
-      context 'when <file> is not explicitly bundled, but required' do
-        subject { render('{% asset_path vapor.js %}') }
-        it { should match(%r{^/assets/vapor-[a-f0-9]{32}\.js$}) }
-
-        it "should be appended to the static files list" do
-          asset = context[:registers][:site].assets["vapor.js"]
-
-          context[:registers][:site].static_files.include?(asset).should be_true
-        end
-
-        it "should be bundled file automagically upon site#write" do
-          context[:registers][:site].cleanup
-          context[:registers][:site].write
-
-          File.exist?("#{fixtures_path.join '_site'}#{subject}").should be_true
-        end
-      end
-
-      context 'when <file> is not found' do
+      context 'when <file> does not exists' do
         subject { render('{% asset_path not-found.js %}') }
         it { should match "Liquid error: couldn't find file 'not-found.js'" }
       end
@@ -105,7 +77,7 @@ module Jekyll::AssetsPlugin
         it { should match(/body \{ background-image: url\(.+?\) \}/) }
       end
 
-      context 'when <file> is not found' do
+      context 'when <file> does not exists' do
         subject { render('{% asset_path not-found.js %}') }
         it { should match "Liquid error: couldn't find file 'not-found.js'" }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-assets
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -164,6 +164,8 @@ files:
 - lib/jekyll/assets_plugin.rb
 - lib/jekyll/assets_plugin/asset_file.rb
 - lib/jekyll/assets_plugin/configuration.rb
+- lib/jekyll/assets_plugin/filters.rb
+- lib/jekyll/assets_plugin/renderer.rb
 - lib/jekyll/assets_plugin/site_patch.rb
 - lib/jekyll/assets_plugin/tag.rb
 - lib/jekyll/assets_plugin/version.rb
@@ -184,6 +186,7 @@ files:
 - spec/lib/jekyll-assets/compass_spec.rb
 - spec/lib/jekyll/assets_plugin/asset_file_spec.rb
 - spec/lib/jekyll/assets_plugin/configuration_spec.rb
+- spec/lib/jekyll/assets_plugin/filters_spec.rb
 - spec/lib/jekyll/assets_plugin/site_patch_spec.rb
 - spec/lib/jekyll/assets_plugin/tag_spec.rb
 - spec/spec_helper.rb
@@ -211,7 +214,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: jekyll-assets-0.2.3
+summary: jekyll-assets-0.3.0
 test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/_assets/app.css.erb
@@ -230,6 +233,7 @@ test_files:
 - spec/lib/jekyll-assets/compass_spec.rb
 - spec/lib/jekyll/assets_plugin/asset_file_spec.rb
 - spec/lib/jekyll/assets_plugin/configuration_spec.rb
+- spec/lib/jekyll/assets_plugin/filters_spec.rb
 - spec/lib/jekyll/assets_plugin/site_patch_spec.rb
 - spec/lib/jekyll/assets_plugin/tag_spec.rb
 - spec/spec_helper.rb