contao 0.3.1

data/lib/contao.rb

@@ -0,0 +1,66 @@
+require 'contao/version'
+require 'singleton'
+require 'ostruct'
+
+module TechnoGate
+  module Contao
+
+    class RootNotSet < RuntimeError; end
+
+    # Get the currently running environment
+    #
+    # @return [Symbol] Currently running environment
+    def self.env
+      @@env
+    end
+
+    # Set the environment
+    #
+    # @param [Symbol] Environment
+    def self.env=(env)
+      @@env = env
+    end
+
+    # Get the currently running rootironment
+    #
+    # @return [Symbol] Currently running rootironment
+    def self.root
+      @@root
+    end
+
+    # Set the rootironment
+    #
+    # @param [Symbol] rootironment
+    def self.root=(root)
+      @@root = Pathname.new(root).expand_path
+    end
+
+    # Expandify a path
+    #
+    # @param [String] Path
+    # @return [Pathname] Path converted to absolute path
+    # raises RootNotSet
+    def self.expandify(path)
+      raise RootNotSet unless root
+
+      if path.to_s.start_with? "/"
+        Pathname(path).expand_path
+      else
+        root.join(path)
+      end
+    end
+  end
+end
+
+# Contao
+require 'contao/application'
+require 'contao/notifier'
+require 'contao/coffeescript_compiler'
+require 'contao/javascript_compiler'
+require 'contao/stylesheet_compiler'
+
+# Guard
+require 'guard/assets'
+
+# Monkey patches
+require 'monkey_patches'

data/lib/guard/assets.rb

@@ -0,0 +1,98 @@
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class Assets < ::Guard::Guard
+    # Initialize a Guard.
+    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
+    # @param [Hash] options the custom Guard options
+    def initialize(watchers = [], options = {})
+      super
+
+      @coffeescript_compiler = ::TechnoGate::Contao::CoffeescriptCompiler.new
+      @javascript_compiler  = ::TechnoGate::Contao::JavascriptCompiler.new
+      @stylesheet_compiler  = ::TechnoGate::Contao::StylesheetCompiler.new
+    end
+
+    # Call once when Guard starts. Please override initialize method to init stuff.
+    # @raise [:task_has_failed] when start has failed
+    def start
+      run_all
+    end
+
+    # Called when just `enter` is pressed
+    # 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
+    end
+
+    # Called on file(s) modifications that the Guard watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_change(paths)
+      compile(paths)
+    end
+
+    # Called on file(s) deletions that the Guard watches.
+    # @param [Array<String>] paths the deleted files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_deletion(paths)
+      compile(paths)
+    end
+
+    protected
+    def compile(paths)
+      coffeescript = javascript = stylesheet = false
+
+      paths.each do |path|
+        coffeescript = true if !coffeescript && is_coffeescript?(path)
+        javascript = true if !javascript && is_javascript?(path)
+        stylesheet = true if !stylesheet && is_stylesheet?(path)
+      end
+
+      compile_stylesheet if stylesheet
+      compile_coffeescript if coffeescript
+      compile_javascript if coffeescript || javascript
+    end
+
+    def compile_stylesheet
+      @stylesheet_compiler.compile
+    end
+
+    def compile_coffeescript
+      @coffeescript_compiler.compile
+    end
+
+    def compile_javascript
+      @javascript_compiler.compile
+    end
+
+    def is_coffeescript?(path)
+      file_in_path?(path, TechnoGate::Contao::Application.config.javascripts_path) && File.extname(path) == '.coffee'
+    end
+
+    def is_javascript?(path)
+      file_in_path?(path, TechnoGate::Contao::Application.config.javascripts_path) && File.extname(path) == '.js'
+    end
+
+    def is_stylesheet?(path)
+      file_in_path?(path, TechnoGate::Contao::Application.config.stylesheets_path)
+    end
+
+    def file_in_path?(file, paths)
+      paths = [paths] if paths.is_a?(String)
+
+      paths.each do |path|
+        return true if file.start_with?(path)
+      end
+
+      false
+    end
+  end
+end

data/lib/monkey_patches/compass/urls.rb

@@ -0,0 +1,81 @@
+require 'compass'
+
+module Compass::SassExtensions::Functions::Urls
+  module ImageUrl
+    def image_url(path, only_path = Sass::Script::Bool.new(false), cache_buster = Sass::Script::Bool.new(true))
+      path = path.value # get to the string value of the literal.
+
+      if path =~ %r{^#{Regexp.escape(Compass.configuration.http_images_path)}/(.*)}
+        # Treat root relative urls (without a protocol) like normal if they start with
+        # the images path.
+        path = $1
+      elsif absolute_path?(path)
+        # Short curcuit if they have provided an absolute url.
+        return Sass::Script::String.new("url(#{path})")
+      end
+
+      # Compute the path to the image, either root relative or stylesheet relative
+      # or nil if the http_images_path is not set in the configuration.
+      http_images_path = if relative?
+                           compute_relative_path(Compass.configuration.images_path)
+                         elsif Compass.configuration.http_images_path
+                           Compass.configuration.http_images_path
+                         else
+                           Compass.configuration.http_root_relative(Compass.configuration.images_dir)
+                         end
+
+      # Compute the real path to the image on the file stystem if the images_dir is set.
+      real_path = if Compass.configuration.images_dir
+                    File.join(Compass.configuration.project_path, Compass.configuration.images_dir, path)
+                  end
+
+      # Generate the digested image (if production)
+      if ::TechnoGate::Contao.env == :production
+        digested_path = ::TechnoGate::Contao::Compiler.new.send(:create_digest_for_file, real_path)
+        real_path = File.join(Compass.configuration.project_path, Compass.configuration.css_dir, File.dirname(path), File.basename(digested_path))
+        FileUtils.mkdir_p File.dirname(real_path)
+        FileUtils.mv digested_path, real_path
+      else
+        non_digested_path = File.join(Compass.configuration.project_path, Compass.configuration.css_dir, path)
+        FileUtils.mkdir_p File.dirname(non_digested_path)
+        FileUtils.cp real_path, non_digested_path
+
+        real_path = non_digested_path
+      end
+
+      # prepend the path to the image if there's one
+      if http_images_path
+        http_images_path = "#{http_images_path}/" unless http_images_path[-1..-1] == "/"
+        path = "#{http_images_path}#{path}"
+      end
+
+      # Generate the digested image (if production)
+      if ::TechnoGate::Contao.env == :production
+        path = path.gsub(File.basename(path), File.basename(digested_path))
+      end
+
+      # Compute the asset host unless in relative mode.
+      asset_host = if !relative? && Compass.configuration.asset_host
+                     Compass.configuration.asset_host.call(path)
+                   end
+
+      # Compute and append the cache buster if there is one.
+      if cache_buster.to_bool
+        if cache_buster.is_a?(Sass::Script::String)
+          path += "?#{cache_buster.value}"
+        else
+          path = cache_busted_path(path, real_path)
+        end
+      end
+
+      # prepend the asset host if there is one.
+      path = "#{asset_host}#{'/' unless path[0..0] == "/"}#{path}" if asset_host
+
+      if only_path.to_bool
+        Sass::Script::String.new(clean_path(path))
+      else
+        clean_url(path)
+      end
+    end
+  end
+end

data/lib/monkey_patches.rb

@@ -0,0 +1 @@
+require 'monkey_patches/compass/urls'

data/spec/lib/contao/application_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+module TechnoGate
+  module Contao
+    describe Application do
+      subject { Contao::Application.instance }
+      let(:klass) { Contao::Application }
+
+      it_should_behave_like "Singleton"
+
+      it "should be an open struct" do
+        subject.class.superclass.should == OpenStruct
+      end
+
+      it "should have a config as a superclass" do
+        subject.config.class.should == OpenStruct
+      end
+
+      describe "config" do
+        it "should set a configuration variable using a block" do
+          Contao::Application.configure do
+            config.foo = :bar
+          end
+
+          Contao::Application.instance.config.foo.should == :bar
+        end
+
+        it "should be accessible form the class level" do
+          Contao::Application.configure do
+            config.foo = :bar
+          end
+
+          Contao::Application.config.foo.should == :bar
+        end
+
+        describe '#linkify', :fakefs do
+          before :each do
+            stub_filesystem!
+          end
+
+          it "should call #exhaustive_list_of_files_to_link" do
+            subject.should_receive(:exhaustive_list_of_files_to_link).with(
+              Contao.expandify(Application.config.contao_path),
+              Contao.expandify(Application.config.contao_public_path)
+            ).once.and_return []
+
+            subject.linkify
+          end
+
+          it "should actually link the files" do
+            subject.linkify
+
+            File.exists?('/root/public/non_existing_folder').should be_true
+            File.exists?('/root/public/system/modules/some_extension').should be_true
+          end
+
+          it "should be accessible at class level" do
+            subject.should_receive(:linkify).once
+
+            Application.linkify
+          end
+        end
+
+        describe '#exhaustive_list_of_files_to_link', :fakefs do
+          before :each do
+            stub_filesystem!
+          end
+
+          it "should return the correct list of files" do
+            list = subject.send :exhaustive_list_of_files_to_link, '/root/contao', '/root/public'
+            list.should == [
+              ['/root/contao/non_existing_folder', '/root/public/non_existing_folder'],
+              ['/root/contao/system/modules/some_extension', '/root/public/system/modules/some_extension']
+            ]
+          end
+        end
+
+        describe '#name' do
+          it {should respond_to :name}
+
+          it "should return the correct name" do
+            subject.name.should == 'root'
+          end
+
+          it "should be accessible at class level" do
+            Application.name.should == 'root'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/contao/coffeescript_compiler_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module CoffeeScript
+  def self.compile(contents, *args)
+    contents
+  end
+end
+
+module TechnoGate
+  module Contao
+    describe CoffeescriptCompiler do
+      it_should_behave_like "Compiler"
+
+      describe '#compile_assets', :fakefs do
+        before :each do
+          stub_filesystem!
+
+          [
+            '/root/app/assets/javascripts/simple_coffeescript_file.js.coffee',
+            '/root/app/assets/javascripts/simple_javascript_file.js',
+            '/root/app/assets/javascripts/nested/script.js.coffee',
+            '/root/lib/assets/javascripts/simple_coffeescript_file.js.coffee',
+            '/root/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/app/assets/javascripts/', '').
+                gsub('/root/lib/assets/javascripts/', '').
+                gsub('/root/vendor/assets/javascripts/', '')
+            end
+          end
+        end
+
+        it "should compile coffeescripts" do
+          subject.send :compile_assets
+
+          File.exists?('/root/tmp/compiled_javascript/app_assets_javascripts/simple_coffeescript_file.js').should be_true
+          File.exists?('/root/tmp/compiled_javascript/lib_assets_javascripts/simple_coffeescript_file.js').should be_true
+          File.exists?('/root/tmp/compiled_javascript/vendor_assets_javascripts/simple_coffeescript_file.js').should be_true
+          File.exists?('/root/tmp/compiled_javascript/app_assets_javascripts/simple_javascript_file').should be_false
+          File.exists?('/root/tmp/compiled_javascript/app_assets_javascripts/nested/script.js').should be_true
+        end
+      end
+
+      describe "#compute_destination_filename" do
+        it "should be able to compute given a relative file" do
+          subject.send(:compute_destination_filename, "app/js", "app/js/file.js.coffee").should ==
+            "/root/tmp/compiled_javascript/app_js/file.js"
+        end
+
+        it "should be able to compute given an absolute file" do
+          subject.send(:compute_destination_filename, "app/js", "/root/app/js/file.js.coffee").should ==
+            "/root/tmp/compiled_javascript/app_js/file.js"
+        end
+
+        it "should add automaticallty .js extension" do
+          subject.send(:compute_destination_filename, "app/js", "app/js/file.coffee").should ==
+            "/root/tmp/compiled_javascript/app_js/file.js"
+        end
+      end
+
+      describe "#clean", :fakefs do
+        before :each do
+          stub_filesystem!
+
+          FileUtils.mkdir_p '/root/tmp/compiled_javascript'
+        end
+
+        it "should remove the temporary javascript compiled files" do
+          subject.clean
+
+          File.exists?('/root/tmp/compiled_javascript').should be_false
+        end
+      end
+    end
+  end
+end

data/spec/lib/contao/javascript_compiler_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module TechnoGate
+  module Contao
+    describe JavascriptCompiler do
+      it_should_behave_like "Compiler"
+
+      describe "#compile_assets", :fakefs do
+        before :each do
+          Uglifier.any_instance.stub(:compile)
+
+          stub_filesystem!
+
+          @file_path   = "/root/app/assets/javascripts/file.js"
+          @app_js_path = "/root/public/resources/application.js"
+
+          File.open(@file_path, 'w') do |file|
+            file.write("not compiled js")
+          end
+        end
+
+        it "should compile javascripts into #{@app_js_path}" do
+          subject.send :compile_assets
+          File.exists?(@app_js_path).should be_true
+        end
+
+        it "should add the contents of file.js to app.js un-minified if env is development" do
+          subject.send :compile_assets
+          File.read(@app_js_path).should ==
+            "// #{@file_path}\n#{File.read(@file_path)}\n"
+        end
+
+        it "should add the contents of file.js to app.js minified if env is production" do
+          TechnoGate::Contao.env = :production
+          Uglifier.any_instance.should_receive(:compile).once.and_return("compiled js")
+
+          subject.send :compile_assets
+          File.read(@app_js_path).should == "compiled js"
+        end
+      end
+
+      describe "#javascripts_path" do
+        it "should return the configured path as well as the temporary javascript path" do
+          subject.send(:javascripts_path).should ==
+            [
+              'tmp/compiled_javascript/vendor_assets_javascripts',
+              'vendor/assets/javascripts',
+              'tmp/compiled_javascript/lib_assets_javascripts',
+              'lib/assets/javascripts',
+              'tmp/compiled_javascript/app_assets_javascripts',
+              'app/assets/javascripts',
+            ]
+        end
+      end
+
+      describe "#create_hashed_assets", :fakefs do
+        before :each do
+          stub_filesystem!
+
+          @app_js_path = "/root/public/resources/application.js"
+
+          File.open(@app_js_path, 'w') do |file|
+            file.write('compiled js')
+          end
+        end
+
+        it "should call :create_digest_for_file" do
+          subject.should_receive(:create_digest_for_file).with(Pathname.new(@app_js_path)).once
+
+          subject.send :create_hashed_assets
+        end
+      end
+
+      describe "#generate_manifest" do
+        it "should call generate_manifest_for" do
+          subject.should_receive(:generate_manifest_for).with("javascripts", "js").once
+
+          subject.send :generate_manifest
+        end
+      end
+
+      describe "#notify" do
+        it "should call Notifier.notify with the appropriate message" do
+          Notifier.should_receive(:notify).with("Javascript compiler finished successfully.", title: "JavascriptCompiler").once
+
+          subject.send :notify
+        end
+      end
+    end
+  end
+end

data/spec/lib/contao/notifier_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module TechnoGate
+  module Contao
+    describe Notifier do
+      subject { Notifier.instance }
+      let(:klass) { Notifier }
+
+      it_should_behave_like "Singleton"
+
+      describe '#notify' do
+        before :each do
+          @message = "Hello"
+          @output  = "Contao>> #{@message}"
+          @colored_output = "\e[0;34mContao>>\e[0m \e[0;32m#{@message}\e[0m"
+          @options = {title: "Hello, World!"}
+
+          ::Guard::UI.stub(:color_enabled?).and_return(false)
+        end
+
+        it {should respond_to :notify}
+
+        it "should call guard ui" do
+          ::Guard::UI.should_receive(:info).with(@output, {})
+
+          subject.notify(@message)
+        end
+
+        it "should send whatever options passed to the info method" do
+          ::Guard::UI.should_receive(:info).with(@output, @options)
+
+          subject.notify(@message, @options)
+        end
+
+        it "should use colors if enabled" do
+          ::Guard::UI.should_receive(:color_enabled?).once.and_return(true)
+          ::Guard::UI.should_receive(:info).with(@colored_output, @options)
+
+          subject.notify(@message, @options)
+        end
+
+        it "should be accessible at class level" do
+          klass.any_instance.should_receive(:notify).with(@message, @options)
+
+          klass.notify(@message, @options)
+        end
+      end
+    end
+  end
+end

data/spec/lib/contao/stylesheet_compiler_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+module TechnoGate
+  module Contao
+    describe StylesheetCompiler do
+      it_should_behave_like "Compiler"
+
+      describe "#compile_assets" do
+        before :each do
+          @updater = mock('updater')
+          @updater.stub(:execute)
+
+          Compass::Commands::UpdateProject.stub(:new).with(
+            Contao.root,
+            configuration_file: Contao.root.join('config', 'compass.rb')
+          ).and_return(@updater)
+        end
+
+        it "should create a new updater" do
+          Compass::Commands::UpdateProject.should_receive(:new).with(
+            Contao.root,
+            configuration_file: Contao.root.join('config', 'compass.rb')
+          ).once.and_return(@updater)
+
+          subject.send :compile_assets
+        end
+
+        it "should cache the updater" do
+          Compass::Commands::UpdateProject.should_receive(:new).with(
+            Contao.root,
+            configuration_file: Contao.root.join('config', 'compass.rb')
+          ).once.and_return(@updater)
+
+          subject.send :compile_assets
+          subject.send :compile_assets
+        end
+
+        it "should call execute on the updater" do
+          @updater.should_receive(:execute).once
+
+          subject.send :compile_assets
+        end
+      end
+
+      describe "#generate_manifest" do
+        it "should call generate_manifest_for" do
+          subject.should_receive(:generate_manifest_for).with("stylesheets", "css").once
+
+          subject.send :generate_manifest
+        end
+      end
+
+      describe "#clean assets" do
+        before :each do
+          @cleaner = mock('cleaner')
+          @cleaner.stub(:execute)
+
+          Compass::Commands::CleanProject.stub(:new).with(
+            Contao.root,
+            configuration_file: Contao.root.join('config', 'compass.rb')
+          ).and_return(@cleaner)
+        end
+
+        it "should create a new cleaner" do
+          Compass::Commands::CleanProject.should_receive(:new).with(
+            Contao.root,
+            configuration_file: Contao.root.join('config', 'compass.rb')
+          ).once.and_return(@cleaner)
+
+          subject.clean
+        end
+
+        it "should cache the cleaner" do
+          Compass::Commands::CleanProject.should_receive(:new).with(
+            Contao.root,
+            configuration_file: Contao.root.join('config', 'compass.rb')
+          ).once.and_return(@cleaner)
+
+          subject.clean
+          subject.clean
+        end
+
+        it "should call execute on the cleaner" do
+          @cleaner.should_receive(:execute).once
+
+          subject.send :clean
+        end
+      end
+
+      describe 'create_hashed_assets', :fakefs do
+        before :each do
+          stub_filesystem!
+
+          @app_css_path = "/root/public/resources/application.css"
+
+          File.open(@app_css_path, 'w') do |file|
+            file.write('compiled css')
+          end
+        end
+
+        it "should call :create_digest_for_file" do
+          subject.should_receive(:create_digest_for_file).with(Pathname.new(@app_css_path)).once
+
+          subject.send :create_hashed_assets
+        end
+      end
+
+      describe "#notify" do
+        it "should call Notifier.notify with the appropriate message" do
+          Notifier.should_receive(:notify).with("Stylesheet compiler finished successfully.", title: "StylesheetCompiler").once
+
+          subject.send :notify
+        end
+      end
+    end
+  end
+end