rake-pipeline-web-filters 0.5.0 → 0.7.0

data/lib/rake-pipeline-web-filters/tilt_filter.rb

@@ -1,4 +1,4 @@
-require 'tilt'
+require 'rake-pipeline-web-filters/filter_with_dependencies'
 
 module Rake::Pipeline::Web::Filters
   # A filter that accepts a series of inputs and translates
@@ -6,6 +6,8 @@ module Rake::Pipeline::Web::Filters
   # to guess which template language to use based on the input
   # file extension.
   #
+  # Requires {http://rubygems.org/gems/tilt/ tilt}
+  #
   # @example
   #   !!!ruby
   #   Rake::Pipeline.build do
@@ -19,17 +21,24 @@ module Rake::Pipeline::Web::Filters
   #     end
   #   end
   class TiltFilter < Rake::Pipeline::Filter
+    include Rake::Pipeline::Web::Filters::FilterWithDependencies
+
     # @return [Hash] a hash of options to pass to Tilt
     #   when rendering.
     attr_reader :options
 
+    # @return [Object] an object to use as the rendering
+    #   context.
+    attr_reader :context
+
     # @param [Hash] options options to pass to the Tilt
     #   template class constructor.
     # @param [Proc] block a block to use as the Filter's
     #   {#output_name_generator}.
-    def initialize(options={}, &block)
+    def initialize(options={}, context = nil, &block)
       super(&block)
       @options = options
+      @context = context || Object.new
     end
 
     # Implement the {#generate_output} method required by
@@ -45,7 +54,7 @@ module Rake::Pipeline::Web::Filters
     def generate_output(inputs, output)
       inputs.each do |input|
         out = if (template_class = Tilt[input.path])
-          template_class.new(nil, 1, options) { |t| input.read }.render
+          template_class.new(nil, 1, options) { |t| input.read }.render(context)
         else
           input.read
         end
@@ -53,5 +62,9 @@ module Rake::Pipeline::Web::Filters
         output.write out
       end
     end
+
+    def external_dependencies
+      [ 'tilt' ]
+    end
   end
 end

data/lib/rake-pipeline-web-filters/uglify_filter.rb

@@ -0,0 +1,66 @@
+require 'rake-pipeline-web-filters/filter_with_dependencies'
+
+module Rake::Pipeline::Web::Filters
+  # A filter that uses the Uglify JS compressor to compress
+  # JavaScript input files.
+  #
+  # Requires {http://rubygems.org/gems/uglifier uglifier}.
+  #
+  # @example
+  #   !!!ruby
+  #   Rake::Pipeline.build do
+  #     input "app/assets", "**/*.js"
+  #     output "public"
+  #
+  #     # Compile each JS file under the app/assets
+  #     # directory.
+  #     filter Rake::Pipeline::Web::Filters::UglifyFilter
+  #   end
+  class UglifyFilter < Rake::Pipeline::Filter
+    include Rake::Pipeline::Web::Filters::FilterWithDependencies
+
+    # @return [Hash] a hash of options to pass to Uglify
+    #   when compiling.
+    attr_reader :options
+
+    # @param [Hash] options options to pass to Uglify
+    # @param [Proc] block a block to use as the Filter's
+    #   {#output_name_generator}.
+    def initialize(options={}, &block)
+      block ||= proc { |input| 
+        if input =~ %r{min.js$}
+          input
+        else
+          input.sub(/\.js$/, '.min.js')
+        end
+      }
+
+      super(&block)
+      @options = options
+    end
+
+    # Implement the {#generate_output} method required by
+    # the {Filter} API. Compiles each input file with Uglify.
+    #
+    # @param [Array<FileWrapper>] inputs an Array of
+    #   {FileWrapper} objects representing the inputs to
+    #   this filter.
+    # @param [FileWrapper] output a single {FileWrapper}
+    #   object representing the output.
+    def generate_output(inputs, output)
+      inputs.each do |input|
+        if input.path =~ %r{min.js$}
+          output.write input.read
+        else
+          output.write Uglifier.compile(input.read, options)
+        end
+      end
+    end
+
+    private
+
+    def external_dependencies
+      [ 'uglifier' ]
+    end
+  end
+end

data/lib/rake-pipeline-web-filters/version.rb

@@ -2,7 +2,7 @@ module Rake
   class Pipeline
     module Web
       module Filters
-        VERSION = "0.5.0"
+        VERSION = "0.7.0"
       end
     end
   end

data/lib/rake-pipeline-web-filters/yui_css_filter.rb

@@ -0,0 +1,70 @@
+require 'rake-pipeline-web-filters/filter_with_dependencies'
+
+module Rake::Pipeline::Web::Filters
+  # A filter that compresses CSS input files using
+  # the YUI CSS compressor.
+  #
+  # Requires {https://rubygems.org/gems/yui-compressor yui-compressor}
+  #
+  # @example
+  #   !!!ruby
+  #   Rake::Pipeline.build do
+  #     input "app/assets", "**/*.js"
+  #     output "public"
+  #
+  #     # Compress each CSS file under the app/assets
+  #     # directory.
+  #     filter Rake::Pipeline::Web::Filters::YUICssFilter
+  #   end
+  class YUICssFilter < Rake::Pipeline::Filter
+    include Rake::Pipeline::Web::Filters::FilterWithDependencies
+
+    # @return [Hash] a hash of options to pass to the
+    #   YUI compressor when compressing.
+    attr_reader :options
+
+    # @param [Hash] options options to pass to the YUI
+    #   CSS compressor.
+    # @param [Proc] block a block to use as the Filter's
+    #   {#output_name_generator}.
+    def initialize(options={}, &block)
+      block ||= proc { |input| 
+        if input =~ %r{min.css$}
+          input
+        else
+          input.sub /\.css$/, '.min.css'
+        end
+      }
+
+      super(&block)
+      @options = options
+    end
+
+    # Implement the {#generate_output} method required by
+    # the {Filter} API. Compresses each input file with
+    # the YUI CSS compressor.
+    #
+    # @param [Array<FileWrapper>] inputs an Array of
+    #   {FileWrapper} objects representing the inputs to
+    #   this filter.
+    # @param [FileWrapper] output a single {FileWrapper}
+    #   object representing the output.
+    def generate_output(inputs, output)
+      compressor = YUI::CssCompressor.new(options)
+      inputs.each do |input|
+        if input.path !~ /min\.css/
+          output.write compressor.compress(input.read)
+        else
+          output.write input.read
+        end
+      end
+    end
+
+  private
+
+    def external_dependencies
+      [ 'yui/compressor' ]
+    end
+  end
+end
+

data/lib/rake-pipeline-web-filters/yui_javascript_filter.rb

@@ -0,0 +1,59 @@
+require 'rake-pipeline-web-filters/filter_with_dependencies'
+
+module Rake::Pipeline::Web::Filters
+  # A filter that compresses JavaScript input files using
+  # the YUI JavaScript compressor.
+  #
+  # Requires {https://rubygems.org/gems/yui-compressor yui-compressor}
+  #
+  # @example
+  #   !!!ruby
+  #   Rake::Pipeline.build do
+  #     input "app/assets", "**/*.js"
+  #     output "public"
+  #
+  #     # Compress each JS file under the app/assets
+  #     # directory.
+  #     filter Rake::Pipeline::Web::Filters::YUIJavaScriptFilter
+  #   end
+  class YUIJavaScriptFilter < Rake::Pipeline::Filter
+    include Rake::Pipeline::Web::Filters::FilterWithDependencies
+
+    # @return [Hash] a hash of options to pass to the
+    #   YUI compressor when compressing.
+    attr_reader :options
+
+    # @param [Hash] options options to pass to the YUI
+    #   JavaScript compressor.
+    # @param [Proc] block a block to use as the Filter's
+    #   {#output_name_generator}.
+    def initialize(options={}, &block)
+      block ||= proc { |input| input.sub(/\.js$/, '.min.js') }
+      super(&block)
+      @options = options
+    end
+
+    # Implement the {#generate_output} method required by
+    # the {Filter} API. Compresses each input file with
+    # the YUI JavaScript compressor.
+    #
+    # @param [Array<FileWrapper>] inputs an Array of
+    #   {FileWrapper} objects representing the inputs to
+    #   this filter.
+    # @param [FileWrapper] output a single {FileWrapper}
+    #   object representing the output.
+    def generate_output(inputs, output)
+      compressor = YUI::JavaScriptCompressor.new(options)
+      inputs.each do |input|
+        output.write compressor.compress(input.read)
+      end
+    end
+
+    private
+
+    def external_dependencies
+      [ 'yui/compressor' ]
+    end
+  end
+end
+

data/rake-pipeline-web-filters.gemspec

@@ -15,10 +15,19 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Rake::Pipeline::Web::Filters::VERSION
 
-  gem.add_dependency "rake-pipeline"
+  gem.add_dependency "rake-pipeline", "~> 0.6"
+  gem.add_dependency "rack"
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "tilt"
   gem.add_development_dependency "sass"
   gem.add_development_dependency "compass"
+  gem.add_development_dependency "coffee-script"
+  gem.add_development_dependency "redcarpet", '~> 2.0'
+  gem.add_development_dependency "yui-compressor"
+  gem.add_development_dependency "uglifier"
+  gem.add_development_dependency "less"
+  gem.add_development_dependency "json"
+  gem.add_development_dependency "therubyracer"
+  gem.add_development_dependency "stylus"
 end

data/spec/cache_buster_filter_spec.rb

@@ -0,0 +1,105 @@
+describe "CacheBusterFilter" do
+  MemoryFileWrapper ||= Rake::Pipeline::SpecHelpers::MemoryFileWrapper
+  CacheBusterFilter ||= Rake::Pipeline::Web::Filters::CacheBusterFilter
+
+  let(:content) { "it doesn't matter" }
+
+  let(:input_file) {
+    MemoryFileWrapper.new '/path/to/input', 'file.txt', 'UTF-8', content
+  }
+
+  let(:output_root) {
+    '/path/to/output'
+  }
+
+  def setup_filter(filter)
+    filter.file_wrapper_class = MemoryFileWrapper
+    filter.input_files = [ input_file ]
+    filter.output_root = output_root
+    filter.rake_application = Rake::Application.new
+    filter
+  end
+
+  describe 'DEFAULT_KEY_GENERATOR' do
+
+    subject { CacheBusterFilter::DEFAULT_KEY_GENERATOR }
+
+    it "returns the MD5 hash of the input's file name and contents" do
+      expected = Digest::MD5.new << input_file.path << content
+      subject.call(input_file).should == expected
+    end
+
+  end
+
+  describe 'with the default cache key strategy' do
+
+    let(:output_file) {
+      key = CacheBusterFilter::DEFAULT_KEY_GENERATOR.call(input_file)
+      MemoryFileWrapper.new output_root, "file-#{key}.txt", 'UTF-8'
+    }
+
+    subject { setup_filter CacheBusterFilter.new }
+
+    it 'outputs to the MD5 hash of the file name and contents' do
+      subject.output_files.should == [ output_file ]
+    end
+
+    it 'passes file contents through unchanged' do
+      tasks = subject.generate_rake_tasks
+      tasks.each(&:invoke)
+      file = MemoryFileWrapper.files[ output_file.fullpath ]
+      file.body.should == content
+      file.encoding.should == 'UTF-8'
+    end
+
+  end
+
+  describe 'with a custom key strategy' do
+
+    let(:output_file) {
+      MemoryFileWrapper.new output_root, 'file-foo.txt', 'UTF-8'
+    }
+
+    subject do
+      setup_filter(CacheBusterFilter.new() { 'foo' })
+    end
+
+    it 'uses the custom key strategy' do
+      subject.output_files.should == [ output_file ]
+    end
+
+  end
+
+  describe 'for an input file with multiple dots' do
+    let(:input_file) {
+      MemoryFileWrapper.new '/path/to/input', 'my.text.file.txt', 'UTF-8', content
+    }
+
+    let(:output_file) {
+      MemoryFileWrapper.new output_root, "my.text.file-foo.txt", 'UTF-8'
+    }
+
+    subject { setup_filter(CacheBusterFilter.new() { 'foo' }) }
+
+    it 'appends the busting key to the penultimate part' do
+      subject.output_files.should == [ output_file ]
+    end
+  end
+
+  describe 'for an input file with no dots' do
+    let(:input_file) {
+      MemoryFileWrapper.new '/path/to/input', 'my_text_file', 'UTF-8', content
+    }
+
+    let(:output_file) {
+      MemoryFileWrapper.new output_root, "my_text_file-foo", 'UTF-8'
+    }
+
+    subject { setup_filter(CacheBusterFilter.new() { 'foo' }) }
+
+    it 'appends the busting key to the end of the filename' do
+      subject.output_files.should == [ output_file ]
+    end
+  end
+
+end

data/spec/chained_filter_spec.rb

@@ -0,0 +1,76 @@
+describe "ChainedFilter" do
+  MemoryFileWrapper ||= Rake::Pipeline::SpecHelpers::MemoryFileWrapper
+  ChainedFilter ||= Rake::Pipeline::Web::Filters::ChainedFilter
+
+  input_file1 = MemoryFileWrapper.new("/path", "input.js.strip_asserts.erb", "UTF-8", <<-CONTENT)
+assert("must be true", true);
+Input = {};
+<%= $chained_filter_title %> = {};
+  CONTENT
+
+  input_file2 = MemoryFileWrapper.new("/path", "input.js.erb.strip_asserts", "UTF-8", <<-CONTENT)
+assert("must be true", true);
+Input = {};
+<%= $chained_filter_title %> = {};
+  CONTENT
+
+  EXPECTED_OUTPUT = <<-EXPECTED
+
+Input = {};
+Chained = {};
+  EXPECTED
+
+  let(:erb_filter) do
+    Class.new(Rake::Pipeline::Filter) do
+      def generate_output(inputs, output)
+        inputs.each do |input|
+          output.write ERB.new(input.read).result
+        end
+      end
+    end
+  end
+
+  let(:strip_asserts_filter) do
+    Class.new(Rake::Pipeline::Filter) do
+      def generate_output(inputs, output)
+        inputs.each do |input|
+          output.write input.read.gsub(/^assert.*$/, '')
+        end
+      end
+    end
+  end
+
+  before do
+    $chained_filter_title = "Chained"
+  end
+
+  after do
+    $chained_filter_title = nil
+  end
+
+  [ input_file1, input_file2 ].each do |file_wrapper|
+    it "should run through the filters in order" do
+      filter = ChainedFilter.new(
+        :types => {
+          :erb => erb_filter,
+          :strip_asserts => strip_asserts_filter
+        }
+      )
+
+      filter.file_wrapper_class = MemoryFileWrapper
+      filter.input_files = [ file_wrapper ]
+      filter.output_root = "/output"
+      filter.rake_application = Rake::Application.new
+
+      filter.output_files.should == [ MemoryFileWrapper.new("/output", "input.js", "UTF-8") ]
+
+      tasks = filter.generate_rake_tasks
+      tasks.each(&:invoke)
+
+      file = MemoryFileWrapper.files["/output/input.js"]
+      file.body.should == EXPECTED_OUTPUT
+      file.encoding.should == "UTF-8"
+    end
+  end
+
+end