contao 0.4.1 → 0.4.2

data/lib/contao/coffeescript_compiler.rb

@@ -11,20 +11,32 @@ module TechnoGate
       end
 
       def clean
-        FileUtils.rm_rf compiled_javascript_path.to_s if File.exists?(compiled_javascript_path)
+        FileUtils.rm_rf output_path.to_s if File.exists?(output_path)
 
         super
       end
 
       protected
 
+      def input_from_config_path
+        Application.config.javascripts_path
+      end
+
+      def output_from_config_path
+        Contao.expandify("tmp/compiled_javascript")
+      end
+
+      def compiler_name
+        :coffeescript
+      end
+
       # Compile assets
       #
       # This method compiled coffeescripts from
       # Application.config.javascripts_path into
       # Contao.root.join('tmp/compiled_javascript')
       def compile_assets
-        Application.config.javascripts_path.each do |src_path|
+        input_path.each do |src_path|
           Dir["#{Contao.expandify(src_path)}/**/*.coffee"].sort.each do |file|
             dest = compute_destination_filename(src_path, file)
             FileUtils.mkdir_p File.dirname(dest)
@@ -36,15 +48,11 @@ module TechnoGate
       end
 
       def compute_destination_filename(src_path, file)
-        dest = "#{compiled_javascript_path}/#{src_path.gsub('/', '_')}/"
+        dest = "#{output_path}/#{src_path.gsub('/', '_')}/"
         dest << file.gsub(/.*#{Regexp.escape src_path}\//, '').gsub(/\.coffee$/, '')
         dest << '.js' unless File.extname(dest) == '.js'
         dest
       end
-
-      def compiled_javascript_path
-        Contao.expandify("tmp/compiled_javascript")
-      end
     end
   end
 end

data/lib/contao/compiler.rb

@@ -39,6 +39,30 @@ module TechnoGate
         Contao.expandify(Contao::Application.config.assets_public_path)
       end
 
+      def input_from_config_path
+        raise "Child class must define this"
+      end
+
+      def input_from_options
+        @options[:input][compiler_name] rescue nil
+      end
+
+      def input_path
+        input_from_options || input_from_config_path
+      end
+
+      def output_from_config_path
+        raise "Child class must define this"
+      end
+
+      def output_from_options
+        @options[:output][compiler_name] rescue nil
+      end
+
+      def output_path
+        output_from_options || output_from_config_path
+      end
+
       # Prepare folders
       def prepare_folders
         FileUtils.mkdir_p assets_public_path

data/lib/contao/javascript_compiler.rb

@@ -12,6 +12,18 @@ module TechnoGate
 
       protected
 
+      def compiler_name
+        :javascript
+      end
+
+      def input_from_config_path
+        Application.config.javascripts_path
+      end
+
+      def output_from_config_path
+        Contao.expandify(Application.config.assets_public_path)
+      end
+
       # Compile assets
       #
       # This method compiles javascripts from
@@ -39,8 +51,11 @@ module TechnoGate
         FileUtils.mv tmp_app_js, application_js_path
       end
 
+      # Generate source folders give the exact source and the folder
+      # under tmp/compiled_javascript on which CoffeeScript compiler
+      # adds javascript files to.
       def javascripts_path
-        Application.config.javascripts_path.map do |path|
+        input_path.map do |path|
           ["tmp/compiled_javascript/#{path.gsub('/', '_')}", path]
         end.flatten
       end
@@ -51,7 +66,7 @@ module TechnoGate
       end
 
       def application_js_path
-        Contao.expandify(Application.config.assets_public_path).join("application.js")
+        Pathname(output_from_config_path).join("application.js")
       end
 
       def generate_manifest

data/lib/contao/stylesheet_compiler.rb

@@ -22,6 +22,17 @@ module TechnoGate
       end
 
       protected
+      def compiler_name
+        :stylesheet
+      end
+
+      # This class can't be told where to get assets from or where to compile to
+      # unless I figure out how to configure the UpdateProject without a file
+      def input_from_config_path
+      end
+      def output_from_config_path
+      end
+
       def compile_assets
         @updater ||= Compass::Commands::UpdateProject.new(
           Contao.root,

data/lib/contao/version.rb

@@ -1,3 +1,3 @@
 module Contao
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/lib/guard/assets.rb

@@ -1,5 +1,7 @@
 require 'guard'
 require 'guard/guard'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/try'
 
 module Guard
   class Assets < ::Guard::Guard
@@ -9,9 +11,8 @@ module Guard
     def initialize(watchers = [], options = {})
       super
 
-      @coffeescript_compiler = ::TechnoGate::Contao::CoffeescriptCompiler.new
-      @javascript_compiler  = ::TechnoGate::Contao::JavascriptCompiler.new
-      @stylesheet_compiler  = ::TechnoGate::Contao::StylesheetCompiler.new
+      @options   = options
+      @compilers = instantiate_compilers
     end
 
     # Call once when Guard starts. Please override initialize method to init stuff.
@@ -24,12 +25,11 @@ module Guard
     # This method should be principally used for long action like running all specs/tests/...
     # @raise [:task_has_failed] when run_all has failed
     def run_all
-      @stylesheet_compiler.clean
-      @coffeescript_compiler.clean
-      @javascript_compiler.clean
-      compile_stylesheet
-      compile_coffeescript
-      compile_javascript
+      @compilers.each do |compiler|
+        compiler.clean
+      end
+
+      call_compilers
     end
 
     # Called on file(s) modifications that the Guard watches.
@@ -47,6 +47,28 @@ module Guard
     end
 
     protected
+    def instantiate_compilers
+      @options.merge!(compilers: [:stylesheet, :coffeescript, :javascript]) unless @options[:compilers]
+
+      sort_compilers(@options[:compilers]).map(&:to_s).map do |compiler|
+        self.instance_variable_set(
+          "@#{compiler}_compiler",
+          "::TechnoGate::Contao::#{compiler.camelize}Compiler".constantize.new(@options)
+        )
+
+        self.instance_variable_get "@#{compiler}_compiler"
+      end
+    end
+
+    def sort_compilers(unsorted_compilers)
+      compilers = []
+      compilers << :stylesheet  if unsorted_compilers.include? :stylesheet
+      compilers << :coffeescript if unsorted_compilers.include? :coffeescript
+      compilers << :javascript  if unsorted_compilers.include? :javascript
+
+      compilers
+    end
+
     def compile(paths)
       coffeescript = javascript = stylesheet = false
 
@@ -56,21 +78,18 @@ module Guard
         stylesheet = true if !stylesheet && is_stylesheet?(path)
       end
 
-      compile_stylesheet if stylesheet
-      compile_coffeescript if coffeescript
-      compile_javascript if coffeescript || javascript
-    end
+      compilers = @compilers.clone
+      compilers.delete(:stylesheet) unless stylesheet
+      compilers.delete(:javascript) unless javascript
+      compilers.delete(:coffeescript) unless coffeescript
 
-    def compile_stylesheet
-      @stylesheet_compiler.compile
+      call_compilers compilers
     end
 
-    def compile_coffeescript
-      @coffeescript_compiler.compile
-    end
-
-    def compile_javascript
-      @javascript_compiler.compile
+    def call_compilers(compilers = @compilers)
+      compilers.each do |compiler|
+        compiler.compile
+      end
     end
 
     def is_coffeescript?(path)

data/spec/lib/contao/coffeescript_compiler_spec.rb

@@ -23,12 +23,7 @@ module TechnoGate
             '/root/my_awesome_project/vendor/assets/javascripts/simple_coffeescript_file.js.coffee',
           ].each do |file|
             FileUtils.mkdir_p File.dirname(file)
-            File.open(file, 'w') do |f|
-              f.write file.
-                gsub('/root/my_awesome_project/app/assets/javascripts/', '').
-                gsub('/root/my_awesome_project/lib/assets/javascripts/', '').
-                gsub('/root/my_awesome_project/vendor/assets/javascripts/', '')
-            end
+            File.open(file, 'w') { |f| f.write "Asset File" }
           end
         end
 
@@ -41,6 +36,18 @@ module TechnoGate
           File.exists?('/root/my_awesome_project/tmp/compiled_javascript/app_assets_javascripts/simple_javascript_file').should be_false
           File.exists?('/root/my_awesome_project/tmp/compiled_javascript/app_assets_javascripts/nested/script.js').should be_true
         end
+
+        it "should compile given a different output path" do
+          subject.should_receive(:output_from_options).at_least(:once).and_return('/root/wat')
+
+          subject.send :compile_assets
+
+          File.exists?('/root/wat/app_assets_javascripts/simple_coffeescript_file.js').should be_true
+          File.exists?('/root/wat/lib_assets_javascripts/simple_coffeescript_file.js').should be_true
+          File.exists?('/root/wat/vendor_assets_javascripts/simple_coffeescript_file.js').should be_true
+          File.exists?('/root/wat/app_assets_javascripts/simple_javascript_file').should be_false
+          File.exists?('/root/wat/app_assets_javascripts/nested/script.js').should be_true
+        end
       end
 
       describe "#compute_destination_filename" do

data/spec/lib/guard/assets_spec.rb

@@ -2,25 +2,61 @@ require 'spec_helper'
 
 module Guard
   describe Assets do
+    before :each do
+      @stylesheet_compiler = mock('stylesheet_compiler', clean: true, compile: true)
+      @coffeescript_compiler  = mock('coffeescript_compiler', clean: true, compile: true)
+      @javascript_compiler  = mock('javascript_compiler', clean: true, compile: true)
+      @compilers =
+        [@stylesheet_compiler, @coffeescript_compiler, @javascript_compiler]
+
+      subject.instance_variable_set :@stylesheet_compiler, @stylesheet_compiler
+      subject.instance_variable_set :@coffeescript_compiler, @coffeescript_compiler
+      subject.instance_variable_set :@javascript_compiler, @javascript_compiler
+      subject.instance_variable_set :@compilers, @compilers
+    end
+
     it "should inherit from Guard" do
       subject.class.superclass.should == ::Guard::Guard
     end
 
     describe '#init' do
+      before :each do
+        @assets = Assets.new
+      end
+
       it "should create @coffeescript_compiler" do
-        subject.instance_variable_get(:@coffeescript_compiler).
+        @assets.instance_variable_get(:@coffeescript_compiler).
           should be_instance_of TechnoGate::Contao::CoffeescriptCompiler
       end
 
       it "should create @javascript_compiler" do
-        subject.instance_variable_get(:@javascript_compiler).
+        @assets.instance_variable_get(:@javascript_compiler).
           should be_instance_of TechnoGate::Contao::JavascriptCompiler
       end
 
       it "should create @stylesheet_compiler" do
-        subject.instance_variable_get(:@stylesheet_compiler).
+        @assets.instance_variable_get(:@stylesheet_compiler).
           should be_instance_of TechnoGate::Contao::StylesheetCompiler
       end
+
+      it "should create @compilers with a specific order with compilers specified" do
+        @assets = Assets.new([], compilers: [:javascript, :coffeescript, :stylesheet])
+        @assets.instance_variable_get(:@compilers).size.should == 3
+        @assets.instance_variable_get(:@compilers).should == [
+          @assets.instance_variable_get(:@stylesheet_compiler),
+          @assets.instance_variable_get(:@coffeescript_compiler),
+          @assets.instance_variable_get(:@javascript_compiler),
+        ]
+      end
+
+      it "should create @compilers with a specific order" do
+        subject.instance_variable_get(:@compilers).size.should == 3
+        subject.instance_variable_get(:@compilers).should == [
+          subject.instance_variable_get(:@stylesheet_compiler),
+          subject.instance_variable_get(:@coffeescript_compiler),
+          subject.instance_variable_get(:@javascript_compiler),
+        ]
+      end
     end
 
     describe "#start" do
@@ -38,20 +74,6 @@ module Guard
     end
 
     describe '#run_all' do
-      before :each do
-        @stylesheet_compiler = mock('stylesheet_compiler', clean: true)
-        @coffeescript_compiler  = mock('coffeescript_compiler', clean: true)
-        @javascript_compiler  = mock('javascript_compiler', clean: true)
-
-        subject.instance_variable_set(:@stylesheet_compiler, @stylesheet_compiler)
-        subject.instance_variable_set(:@coffeescript_compiler, @coffeescript_compiler)
-        subject.instance_variable_set(:@javascript_compiler, @javascript_compiler)
-
-        subject.stub(:compile_stylesheet)
-        subject.stub(:compile_coffeescript)
-        subject.stub(:compile_javascript)
-      end
-
       it {should respond_to :run_all}
 
       it "Should clean assets" do
@@ -63,9 +85,9 @@ module Guard
       end
 
       it "Should recompile assets" do
-        subject.should_receive(:compile_stylesheet).once.ordered
-        subject.should_receive(:compile_coffeescript).once.ordered
-        subject.should_receive(:compile_javascript).once.ordered
+        @stylesheet_compiler.should_receive(:compile).once.ordered
+        @coffeescript_compiler.should_receive(:compile).once.ordered
+        @javascript_compiler.should_receive(:compile).once.ordered
 
         subject.run_all
       end
@@ -99,104 +121,57 @@ module Guard
       end
     end
 
-    describe '#compile_stylesheet' do
-      before :each do
-        @stylesheet_compiler = mock('stylesheet_compiler', clean: true)
-
-        subject.instance_variable_set(:@stylesheet_compiler, @stylesheet_compiler)
-      end
-
-      it {should respond_to :compile_stylesheet}
-
-      it "should call @stylesheet_compiler.compile" do
-        @stylesheet_compiler.should_receive(:compile).once
-
-        subject.send :compile_stylesheet
-      end
-    end
-
-    describe '#compile_coffeescript' do
-      before :each do
-        @coffeescript_compiler  = mock('coffeescript_compiler', clean: true, compile: true)
-
-        subject.instance_variable_set(:@coffeescript_compiler, @coffeescript_compiler)
-
-        subject.stub :compile_javascript
-      end
-
-      it {should respond_to :compile_coffeescript}
-
-      it "should call @coffeescript_compiler.compile" do
-        @coffeescript_compiler.should_receive(:compile).once
-
-        subject.send :compile_coffeescript
-      end
-    end
-
-    describe '#compile_javascript' do
-      before :each do
-        @javascript_compiler  = mock('javascript_compiler', clean: true)
-
-        subject.instance_variable_set(:@javascript_compiler, @javascript_compiler)
-      end
-
-      it {should respond_to :compile_javascript}
-
-      it "should call @javascript_compiler.compile" do
-        @javascript_compiler.should_receive(:compile).once
-
-        subject.send :compile_javascript
-      end
-    end
-
     describe '#compile' do
-      before :each do
-        subject.stub :compile_stylesheet
-        subject.stub :compile_coffeescript
-        subject.stub :compile_javascript
-      end
-
       it "should call compile_stylesheet only if some stylesheet paths has changed" do
-        subject.should_receive(:compile_stylesheet).once
+        @stylesheet_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/stylesheets/file.css"]
       end
 
       it "should call compile_coffeescript only if some coffeescript paths has changed" do
-        subject.should_receive(:compile_coffeescript).once
+        @coffeescript_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/javascripts/file.js.coffee"]
       end
 
       it "should call compile_javascript only if some javascript paths has changed" do
-        subject.should_receive(:compile_javascript).once
+        @javascript_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/javascripts/file.js"]
       end
 
       it "should compile stylesheets only once" do
-        subject.should_receive(:compile_stylesheet).once
+        @stylesheet_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/stylesheets/file.css", "app/assets/stylesheets/file2.css"]
       end
 
       it "should compile coffeescripts only once" do
-        subject.should_receive(:compile_coffeescript).once
+        @coffeescript_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/javascripts/file.js.coffee", "app/assets/javascripts/file2.js.coffee"]
       end
 
       it "should compile javascripts only once" do
-        subject.should_receive(:compile_javascript).once
+        @javascript_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/javascripts/file.js", "app/assets/javascripts/file2.js"]
       end
 
       it "should compile javascript if coffeescript was used" do
-        subject.should_receive(:compile_javascript).once
+        @coffeescript_compiler.should_receive(:compile).once
+        @javascript_compiler.should_receive(:compile).once
 
         subject.send :compile, ["app/assets/javascripts/file.js.coffee"]
       end
+
+      it "should not try to compile javascript if compiler not available even if path is a js" do
+        @compilers = [@stylesheet_compiler, @coffeescript_compiler]
+        subject.instance_variable_set :@compilers, @compilers
+        @javascript_compiler.should_not_receive(:compile)
+
+        subject.send :compile, ["app/assets/javascripts/file.js"]
+      end
     end
 
     describe "#file_in_path?" do

data/spec/support/compiler_shared_examples.rb

@@ -73,6 +73,88 @@ shared_examples_for "Compiler" do
     end
   end
 
+  describe '#input_from_config_path' do
+    it {should respond_to :input_from_config_path}
+  end
+
+  describe '#output_from_config_path' do
+    it {should respond_to :output_from_config_path}
+  end
+
+  describe '#input_from_options' do
+    it {should respond_to :input_from_options}
+  end
+
+  describe '#output_from_options' do
+    it {should respond_to :output_from_options}
+  end
+
+  describe '#input_path' do
+    it {should respond_to :input_path}
+
+    it "should return whatever in input_from_config_path" do
+      mock('input').tap do |path|
+        subject.stub(:input_from_config_path).and_return path
+
+        subject.send(:input_path).should == path
+      end
+    end
+
+    it "should return whatever in input_from_options" do
+      mock('input').tap do |path|
+        subject.stub(:input_from_options).and_return path
+
+        subject.send(:input_path).should == path
+      end
+    end
+
+    it "should prefer options over config" do
+      {options: mock('options'), config: mock('config')}.tap do |mocks|
+        subject.stub(:input_from_config_path).and_return mocks[:config]
+        subject.stub(:input_from_options).and_return mocks[:options]
+
+        subject.send(:input_path).should == mocks[:options]
+      end
+    end
+  end
+
+  describe '#output_path' do
+    it {should respond_to :output_path}
+
+    it "should return whatever in output_from_config_path" do
+      mock('output').tap do |path|
+        subject.stub(:output_from_config_path).and_return path
+
+        subject.send(:output_path).should == path
+      end
+    end
+
+    it "should return whatever in output_from_options" do
+      mock('output').tap do |path|
+        subject.stub(:output_from_options).and_return path
+
+        subject.send(:output_path).should == path
+      end
+    end
+
+    it "should prefer options over config" do
+      {options: mock('options'), config: mock('config')}.tap do |mocks|
+        subject.stub(:output_from_config_path).and_return mocks[:config]
+        subject.stub(:output_from_options).and_return mocks[:options]
+
+        subject.send(:output_path).should == mocks[:options]
+      end
+    end
+  end
+
+  describe "#compiler_name" do
+    it {should respond_to :compiler_name}
+
+    it "should not be empty" do
+      subject.send(:compiler_name).should_not be_empty
+    end
+  end
+
   describe "#prepare_folders", :fakefs do
     it {should respond_to :prepare_folders}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contao
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -281,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2428308955429716338
+      hash: 2585699756949260143
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24