RubyGems - rake-pipeline-fork - Versions diffs - 0.8.0 - Mend

rake-pipeline-fork 0.8.0

Files changed (75) hide show

checksums.yaml +15 -0
data/.gitignore +18 -0
data/.rspec +1 -0
data/.travis.yml +12 -0
data/.yardopts +2 -0
data/GETTING_STARTED.md +268 -0
data/Gemfile +14 -0
data/LICENSE +20 -0
data/README.markdown +11 -0
data/README.yard +178 -0
data/Rakefile +21 -0
data/bin/rakep +4 -0
data/examples/copying_files.md +12 -0
data/examples/minifying_files.md +37 -0
data/examples/modifying_pipelines.md +67 -0
data/examples/multiple_pipelines.md +77 -0
data/lib/generators/rake/pipeline/install/install_generator.rb +70 -0
data/lib/rake-pipeline.rb +462 -0
data/lib/rake-pipeline/cli.rb +56 -0
data/lib/rake-pipeline/dsl.rb +9 -0
data/lib/rake-pipeline/dsl/pipeline_dsl.rb +246 -0
data/lib/rake-pipeline/dsl/project_dsl.rb +108 -0
data/lib/rake-pipeline/dynamic_file_task.rb +194 -0
data/lib/rake-pipeline/error.rb +17 -0
data/lib/rake-pipeline/file_wrapper.rb +182 -0
data/lib/rake-pipeline/filter.rb +249 -0
data/lib/rake-pipeline/filters.rb +4 -0
data/lib/rake-pipeline/filters/concat_filter.rb +63 -0
data/lib/rake-pipeline/filters/gsub_filter.rb +56 -0
data/lib/rake-pipeline/filters/ordering_concat_filter.rb +38 -0
data/lib/rake-pipeline/filters/pipeline_finalizing_filter.rb +21 -0
data/lib/rake-pipeline/graph.rb +178 -0
data/lib/rake-pipeline/manifest.rb +86 -0
data/lib/rake-pipeline/manifest_entry.rb +34 -0
data/lib/rake-pipeline/matcher.rb +141 -0
data/lib/rake-pipeline/middleware.rb +72 -0
data/lib/rake-pipeline/precompile.rake +8 -0
data/lib/rake-pipeline/project.rb +335 -0
data/lib/rake-pipeline/rails_plugin.rb +10 -0
data/lib/rake-pipeline/railtie.rb +34 -0
data/lib/rake-pipeline/reject_matcher.rb +29 -0
data/lib/rake-pipeline/server.rb +15 -0
data/lib/rake-pipeline/sorted_pipeline.rb +19 -0
data/lib/rake-pipeline/version.rb +6 -0
data/rails/init.rb +2 -0
data/rake-pipeline.gemspec +24 -0
data/spec/cli_spec.rb +71 -0
data/spec/concat_filter_spec.rb +37 -0
data/spec/dsl/pipeline_dsl_spec.rb +165 -0
data/spec/dsl/project_dsl_spec.rb +41 -0
data/spec/dynamic_file_task_spec.rb +119 -0
data/spec/encoding_spec.rb +106 -0
data/spec/file_wrapper_spec.rb +132 -0
data/spec/filter_spec.rb +332 -0
data/spec/graph_spec.rb +56 -0
data/spec/gsub_filter_spec.rb +87 -0
data/spec/manifest_entry_spec.rb +46 -0
data/spec/manifest_spec.rb +67 -0
data/spec/matcher_spec.rb +141 -0
data/spec/middleware_spec.rb +199 -0
data/spec/ordering_concat_filter_spec.rb +42 -0
data/spec/pipeline_spec.rb +232 -0
data/spec/project_spec.rb +295 -0
data/spec/rake_acceptance_spec.rb +738 -0
data/spec/rake_tasks_spec.rb +21 -0
data/spec/reject_matcher_spec.rb +31 -0
data/spec/sorted_pipeline_spec.rb +27 -0
data/spec/spec_helper.rb +38 -0
data/spec/support/spec_helpers/file_utils.rb +35 -0
data/spec/support/spec_helpers/filters.rb +37 -0
data/spec/support/spec_helpers/input_helpers.rb +23 -0
data/spec/support/spec_helpers/memory_file_wrapper.rb +31 -0
data/spec/support/spec_helpers/memory_manifest.rb +19 -0
data/tools/perfs +101 -0
metadata +215 -0

@@ -0,0 +1,738 @@
+require "rake-pipeline/filters"
+describe "A realistic project" do
+INPUTS = {
+"app/javascripts/jquery.js" => <<-HERE,
+var jQuery = {};
+HERE
+"app/javascripts/sproutcore.js" => <<-HERE,
+var SC = {};
+assert(SC);
+SC.hi = function() { console.log("hi"); };
+HERE
+"app/stylesheets/jquery.css" => <<-HERE,
+#jquery {
+  color: red;
+}
+HERE
+"app/stylesheets/sproutcore.css" => <<-HERE,
+#sproutcore {
+  color: green;
+}
+HERE
+"app/index.html" => <<-HERE,
+<html></html>
+HERE
+"app/junk.txt" => <<-HERE,
+junk
+HERE
+"app/main.dynamic" => <<-HERE,
+# main.dynamic
+static content
+@import("variables")
+HERE
+"variables.import" => <<-HERE,
+$rakep = awesome
+HERE
+}
+EXPECTED_JS_OUTPUT = <<-HERE
+var jQuery = {};
+var SC = {};
+SC.hi = function() { console.log("hi"); };
+HERE
+EXPECTED_CSS_OUTPUT = <<-HERE
+#jquery {
+  color: red;
+}
+#sproutcore {
+  color: green;
+}
+HERE
+EXPECTED_HTML_OUTPUT = <<-HERE
+<html></html>
+HERE
+EXPECTED_DYNAMIC_OUTPUT = <<-HERE
+# main.dynamic
+static content
+@import("variables")
+$rakep = awesome
+HERE
+  def input_wrapper(path)
+    Rake::Pipeline::FileWrapper.new(tmp, path)
+  end
+  def output_should_exist(expected = EXPECTED_JS_OUTPUT)
+    output = File.join(tmp, "public/javascripts/application.js")
+    temp   = File.join(tmp, "temporary")
+    File.exists?(output).should be_true
+    File.exists?(temp).should be_true
+    File.read(output).should == expected
+  end
+  concat_filter = Rake::Pipeline::ConcatFilter
+  dynamic_import_filter = Rake::Pipeline::SpecHelpers::Filters::DynamicImportFilter
+  strip_asserts_filter = Rake::Pipeline::SpecHelpers::Filters::StripAssertsFilter
+  memory_manifest = Rake::Pipeline::SpecHelpers::MemoryManifest
+  def copy_files
+    INPUTS.each do |name, string|
+      mkdir_p File.dirname(File.join(tmp, name))
+      File.open(File.join(tmp, name), "w") { |file| file.write(string) }
+    end
+  end
+  def delete_files
+    FileUtils.rm_rf File.join(tmp, "app/javascripts/jquery.js")
+  end
+  before do
+    Rake.application = Rake::Application.new
+    copy_files
+  end
+  describe "a pipeline" do
+    it "can successfully apply filters" do
+      concat = concat_filter.new
+      concat.manifest = memory_manifest.new
+      concat.last_manifest = memory_manifest.new
+      concat.input_files = INPUTS.keys.select { |key| key =~ /javascript/ }.map { |file| input_wrapper(file) }
+      concat.output_root = File.join(tmp, "temporary", "concat_filter")
+      concat.output_name_generator = proc { |input| "javascripts/application.js" }
+      strip_asserts = strip_asserts_filter.new
+      strip_asserts.manifest = memory_manifest.new
+      strip_asserts.last_manifest = memory_manifest.new
+      strip_asserts.input_files = concat.output_files
+      strip_asserts.output_root = File.join(tmp, "public")
+      strip_asserts.output_name_generator = proc { |input| input }
+      concat.generate_rake_tasks
+      Rake::Task.define_task(:default => strip_asserts.generate_rake_tasks)
+      Rake.application[:default].invoke
+      output_should_exist
+    end
+    it "supports filters with multiple outputs per input" do
+      concat = concat_filter.new
+      concat.manifest = memory_manifest.new
+      concat.last_manifest = memory_manifest.new
+      concat.input_files = INPUTS.keys.select { |key| key =~ /javascript/ }.map { |file| input_wrapper(file) }
+      concat.output_root = File.join(tmp, "temporary", "concat_filter")
+      concat.output_name_generator = proc { |input| [ "javascripts/application.js", input.sub(/^app\//, '') ] }
+      strip_asserts = strip_asserts_filter.new
+      strip_asserts.manifest = memory_manifest.new
+      strip_asserts.last_manifest = memory_manifest.new
+      strip_asserts.input_files = concat.output_files
+      strip_asserts.output_root = File.join(tmp, "public")
+      strip_asserts.output_name_generator = proc { |input| input }
+      concat.generate_rake_tasks
+      Rake::Task.define_task(:default => strip_asserts.generate_rake_tasks)
+      Rake.application[:default].invoke
+      output_should_exist
+      expected_files = {
+        "javascripts/jquery.js" => "var jQuery = {};\n",
+        "javascripts/sproutcore.js" => "var SC = {};\n\nSC.hi = function() { console.log(\"hi\"); };\n"
+      }
+      expected_files.each do |file, expected|
+        output_file = File.join(tmp, "public", file)
+        output = nil
+        lambda { output = File.read(output_file) }.should_not raise_error
+        output.should == expected
+      end
+    end
+    it "can be configured using the pipeline" do
+      pipeline = Rake::Pipeline.new
+      pipeline.project = Rake::Pipeline::Project.new
+      pipeline.add_input tmp, 'app/javascripts/*.js'
+      pipeline.output_root = File.expand_path("public")
+      pipeline.tmpdir = "temporary"
+      concat = concat_filter.new
+      concat.manifest = memory_manifest.new
+      concat.last_manifest = memory_manifest.new
+      concat.output_name_generator = proc { |input| "javascripts/application.js" }
+      strip_asserts = strip_asserts_filter.new
+      strip_asserts.manifest = memory_manifest.new
+      strip_asserts.last_manifest = memory_manifest.new
+      strip_asserts.output_name_generator = proc { |input| input }
+      pipeline.add_filters(concat, strip_asserts)
+      pipeline.invoke
+      output_should_exist
+    end
+  end
+  describe "using the pipeline DSL" do
+    attr_reader :project
+    shared_examples_for "the pipeline DSL" do
+      it "can be configured using the pipeline DSL" do
+        project.invoke
+        output_should_exist
+      end
+      it "can be configured using the pipeline DSL with an alternate Rake application" do
+        project.pipelines.first.rake_application = Rake::Application.new
+        project.invoke
+        output_should_exist
+      end
+      it "can be invoked repeatedly to reflected updated changes" do
+        project.invoke
+        age_existing_files
+        if respond_to?(:update_jquery)
+          update_jquery
+        else
+          File.open(File.join(tmp, "app/javascripts/jquery.js"), "w") do |file|
+            file.write "var jQuery = {};\njQuery.trim = function() {};\n"
+          end
+        end
+        expected = <<-HERE.gsub(/^ {10}/, '')
+          var jQuery = {};
+          jQuery.trim = function() {};
+          var SC = {};
+          SC.hi = function() { console.log("hi"); };
+        HERE
+        project.invoke
+        output_should_exist(expected)
+      end
+      it "can be restarted to reflect new files" do
+        project.invoke
+        age_existing_files
+        if respond_to?(:update_history)
+          update_history
+        else
+          File.open(File.join(tmp, "app/javascripts/history.js"), "w") do |file|
+            file.write "var History = {};\n"
+          end
+        end
+        project.invoke
+        expected = <<-HERE.gsub(/^ {10}/, '')
+          var History = {};
+          var jQuery = {};
+          var SC = {};
+          SC.hi = function() { console.log("hi"); };
+        HERE
+        output_should_exist(expected)
+      end
+      it "does not generate new files when things haven't changed" do
+        output_file  = File.join(tmp, "public/javascripts/application.js")
+        project.invoke
+        previous_mtime = File.mtime(output_file)
+        sleep 1
+        project.invoke
+        File.mtime(output_file).should == previous_mtime
+      end
+      it "handles deleted files" do
+        output_file  = File.join(tmp, "public/javascripts/application.js")
+        project.invoke
+        content = File.read output_file
+        delete_files
+        project.invoke
+        content.should_not == File.read(output_file)
+      end
+    end
+    describe "the raw pipeline DSL (with block strip_asserts_filter)" do
+      it_behaves_like "the pipeline DSL"
+      before do
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          input tmp, "app/javascripts/*.js" do
+            concat "javascripts/application.js"
+            filter(strip_asserts_filter) { |input| input }
+          end
+        end
+      end
+    end
+    describe "the raw pipeline DSL (with before_filter)" do
+      it_behaves_like "the pipeline DSL"
+      before do
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          before_filter Rake::Pipeline::ConcatFilter, "javascripts/application.js"
+          input tmp, "app/javascripts/*.js" do
+            filter strip_asserts_filter
+          end
+        end
+      end
+    end
+    describe "the raw pipeline DSL (with simple strip_asserts_filter)" do
+      it_behaves_like "the pipeline DSL"
+      before do
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          input tmp, "app/javascripts/*.js" do
+            concat "javascripts/application.js"
+            filter strip_asserts_filter
+          end
+        end
+      end
+    end
+    describe "using the matcher spec" do
+      def output_should_exist(expected=EXPECTED_JS_OUTPUT)
+        super
+        css = File.join(tmp, "public/stylesheets/application.css")
+        File.exists?(css).should be_true
+        File.read(css).should == EXPECTED_CSS_OUTPUT
+        html = File.join(tmp, "public/index.html")
+        File.exists?(html).should be_true
+        File.read(html).should == EXPECTED_HTML_OUTPUT
+        junk = File.join(tmp, "public/junk.txt")
+        File.exists?(junk).should be_false
+      end
+      it_behaves_like "the pipeline DSL"
+      before do
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          input File.join(tmp, "app") do
+            match "**/*.js" do
+              filter strip_asserts_filter
+              concat "javascripts/application.js"
+            end
+            match "**/*.css" do
+              concat "stylesheets/application.css"
+            end
+            match "**/*.html" do
+              concat
+            end
+          end
+        end
+      end
+    end
+    describe "using multiple pipelines (with after_filters)" do
+      def output_should_exist(expected=EXPECTED_JS_OUTPUT)
+        super
+        css = File.join(tmp, "public/stylesheets/application.css")
+        File.exists?(css).should be_true
+        File.read(css).should == EXPECTED_CSS_OUTPUT
+        html = File.join(tmp, "public/index.html")
+        File.exists?(html).should be_true
+        File.read(html).should == EXPECTED_HTML_OUTPUT
+        junk = File.join(tmp, "public/junk.txt")
+        File.exists?(junk).should be_false
+      end
+      it_behaves_like "the pipeline DSL"
+      before do
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          app_dir = File.join(tmp, "app")
+          after_filter Rake::Pipeline::ConcatFilter do |input|
+            ext = File.extname(input)
+            case ext
+            when ".js"
+              "javascripts/application.js"
+            when ".css"
+              "stylesheets/application.css"
+            when ".html"
+              input
+            end
+          end
+          input app_dir, "**/*.js" do
+            filter strip_asserts_filter
+          end
+          input app_dir, "**/*.css"
+          input app_dir, "**/*.html"
+        end
+      end
+    end
+    describe "using multiple pipelines" do
+      def output_should_exist(expected=EXPECTED_JS_OUTPUT)
+        super
+        css = File.join(tmp, "public/stylesheets/application.css")
+        File.exists?(css).should be_true
+        File.read(css).should == EXPECTED_CSS_OUTPUT
+        html = File.join(tmp, "public/index.html")
+        File.exists?(html).should be_true
+        File.read(html).should == EXPECTED_HTML_OUTPUT
+        junk = File.join(tmp, "public/junk.txt")
+        File.exists?(junk).should be_false
+      end
+      it_behaves_like "the pipeline DSL"
+      before do
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          app_dir = File.join(tmp, "app")
+          input app_dir, "**/*.js" do
+            filter strip_asserts_filter
+            concat "javascripts/application.js"
+          end
+          input app_dir, "**/*.css" do
+            concat "stylesheets/application.css"
+          end
+          input app_dir, "**/*.html" do
+            concat
+          end
+        end
+      end
+    end
+    describe "using the matcher spec (with multiple inputs to a single pipeline)" do
+      it_behaves_like "the pipeline DSL"
+      def tmp1
+        File.join(tmp, 'tmp1')
+      end
+      def tmp2
+        File.join(tmp, 'tmp2')
+      end
+      def update_jquery
+        File.open(File.join(tmp1, "app/javascripts/jquery.js"), "w") do |file|
+          file.write "var jQuery = {};\njQuery.trim = function() {};\n"
+        end
+      end
+      def update_history
+        File.open(File.join(tmp1, "app/javascripts/history.js"), "w") do |file|
+          file.write "var History = {};\n"
+        end
+      end
+      def copy_files
+        INPUTS.each do |name, string|
+          file = name =~ /\.js$/ ? File.join(tmp1, name) : File.join(tmp2, name)
+          mkdir_p File.dirname(file)
+          File.open(file, "w") { |f| f.write(string) }
+        end
+      end
+      def output_should_exist(expected=EXPECTED_JS_OUTPUT)
+        super
+        css = File.join(tmp, "public/stylesheets/application.css")
+        File.exists?(css).should be_true
+        File.read(css).should == EXPECTED_CSS_OUTPUT
+        html = File.join(tmp, "public/index.html")
+        File.exists?(html).should be_true
+        File.read(html).should == EXPECTED_HTML_OUTPUT
+        junk = File.join(tmp, "public/junk.txt")
+        File.exists?(junk).should be_false
+      end
+      def delete_files
+        FileUtils.rm_rf File.join(tmp1, "app/javascripts/jquery.js")
+      end
+      before do
+        tmp1 = self.tmp1
+        tmp2 = self.tmp2
+        @project = Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          inputs [File.join(tmp1, "app"), File.join(tmp2, "app")] do
+            match "**/*.js" do
+              filter strip_asserts_filter
+              concat "javascripts/application.js"
+            end
+            match "**/*.css" do
+              concat "stylesheets/application.css"
+            end
+            match "**/*.html" do
+              concat
+            end
+          end
+        end
+      end
+    end
+  end
+  describe "Dynamic dependencies" do
+    shared_examples_for "a pipeline with dynamic files" do
+      it "should handle changes in dynamic imports" do
+        project.invoke
+        content = File.read output_file
+        content.should == EXPECTED_DYNAMIC_OUTPUT
+        sleep 1
+        imported_file = File.join tmp, "variables.import"
+        File.open imported_file, "w" do |f|
+          f.write "true to trance"
+        end
+        project.invoke
+        content = File.read output_file
+        content.should include("true to trance")
+      end
+      it "should handle changes in dynamic source files" do
+        project.invoke
+        content = File.read output_file
+        content.should == EXPECTED_DYNAMIC_OUTPUT
+        sleep 1
+        imported_file = File.join tmp, "app/main.dynamic"
+        File.open imported_file, "w" do |f|
+          f.write "true to trance"
+        end
+        project.invoke
+        content = File.read output_file
+        content.should == "true to trance"
+      end
+      it "should handle dynamic dependencies being deleted" do
+        project.invoke
+        content = File.read output_file
+        content.should == EXPECTED_DYNAMIC_OUTPUT
+        sleep 1
+        imported_file = File.join tmp, "variables.import"
+        File.exists?(imported_file).should be_true
+        FileUtils.rm_rf imported_file
+        project.invoke
+      end
+      it "should not regenerate files when nothing changes" do
+        project.invoke
+        previous_mtime = File.mtime output_file
+        sleep 1 ; project.invoke
+        File.mtime(output_file).should == previous_mtime
+      end
+    end
+    describe "direct dependencies" do
+      let(:project) do
+        Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          input tmp, "app/*.dynamic" do
+            filter dynamic_import_filter
+          end
+        end
+      end
+      let(:output_file) { File.join tmp, "public", "app/main.dynamic" }
+      it_should_behave_like "a pipeline with dynamic files"
+    end
+    describe "transitive dependencies" do
+      let(:project) do
+        Rake::Pipeline::Project.build do
+          tmpdir "temporary"
+          output "public"
+          input tmp, "app/*.dynamic" do
+            filter dynamic_import_filter
+            concat "application.dyn"
+          end
+        end
+      end
+      let(:output_file) { File.join tmp, "public", "application.dyn" }
+      it_should_behave_like "a pipeline with dynamic files"
+    end
+  end
+  it "should work with nested matchers" do
+    project = Rake::Pipeline::Project.build do
+      tmpdir "temporary"
+      output "public"
+      input tmp, "app/**/*.js" do
+        match "**/*" do
+          match "**/*.js" do
+            filter strip_asserts_filter
+            concat "javascripts/application.js"
+          end
+        end
+      end
+    end
+    project.invoke
+    output_should_exist
+  end
+  describe "Handling mistakes" do
+    it "should raise an error when the tmp dir is added directly" do
+      project = Rake::Pipeline::Project.build do
+        output "public"
+        tmpdir "app"
+        input "app", "**/*" do
+          concat "tmp.js"
+        end
+      end
+      expect {
+        project.invoke ; project.invoke
+      }.to raise_error(Rake::Pipeline::TmpInputError)
+    end
+    it "should raise an error when the tmp dir is matched" do
+      project = Rake::Pipeline::Project.build do
+        output "public"
+        tmpdir "app/tmp"
+        input "app" do
+          # to generate temporary files
+          # which can be matched in the second invocation
+          match "**/*.js" do
+            concat "app.js"
+          end
+          match "tmp/**/*" do
+            concat "tmp.js"
+          end
+        end
+      end
+      expect {
+        project.invoke ; project.invoke
+      }.to raise_error(Rake::Pipeline::TmpInputError)
+    end
+    it "should not raise an error for internal temporary files" do
+      # Create a project with multiple filters and build
+      # steps to create intermediate build files
+      project = Rake::Pipeline::Project.build do
+        output "public"
+        tmpdir "temporary"
+        input tmp, "app/**/*" do
+          match "*.js" do
+            concat "application.js"
+          end
+          match "*.css" do
+            concat "application.css"
+          end
+          match "*.{js,css}" do
+            concat "every_file.application"
+          end
+        end
+      end
+      expect {
+        project.invoke
+      }.to_not raise_error(Rake::Pipeline::TmpInputError)
+    end
+  end
+end