contao 0.3.1

data/spec/lib/contao_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module TechnoGate
+  describe Contao do
+    describe "#env" do
+      it {should respond_to :env}
+      it {should respond_to :env=}
+
+      it "should return @@env" do
+        mock("env").tap do |env|
+          subject.class_variable_set(:@@env, env)
+          subject.env.should == env
+        end
+      end
+
+      it "should set the @@env" do
+        mock("env").tap do |env|
+          subject.env = env
+          subject.class_variable_get(:@@env).should == env
+        end
+      end
+    end
+
+    describe '#root' do
+      it {should respond_to :root}
+      it {should respond_to :root=}
+
+      it "should return @@root" do
+        mock("root").tap do |root|
+          subject.class_variable_set(:@@root, root)
+          subject.root.should == root
+        end
+      end
+
+      it "should set the @@root" do
+        mock("root").tap do |root|
+          subject.root = root
+          subject.class_variable_get(:@@root).should == Pathname.new(root).expand_path
+        end
+      end
+    end
+
+    describe '#expandify' do
+      before :each do
+        subject.root = '/root'
+      end
+
+      it {should respond_to :expandify}
+
+      it "should expand the path if it's relative" do
+        subject.expandify('app').to_s.should == '/root/app'
+      end
+
+      it "should not expand an expanded path" do
+        subject.expandify('/test').to_s.should == '/test'
+      end
+
+      it "always return a Pathname" do
+        subject.expandify('app').should be_instance_of Pathname
+        subject.expandify('/app').should be_instance_of Pathname
+      end
+    end
+  end
+end

data/spec/lib/guard/assets_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+module Guard
+  describe Assets do
+    it "should inherit from Guard" do
+      subject.class.superclass.should == ::Guard::Guard
+    end
+
+    describe '#init' do
+      it "should create @coffeescript_compiler" do
+        subject.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).
+          should be_instance_of TechnoGate::Contao::JavascriptCompiler
+      end
+
+      it "should create @stylesheet_compiler" do
+        subject.instance_variable_get(:@stylesheet_compiler).
+          should be_instance_of TechnoGate::Contao::StylesheetCompiler
+      end
+    end
+
+    describe "#start" do
+      before :each do
+        subject.stub(:run_all)
+      end
+
+      it {should respond_to :start}
+
+      it "should call :run_all" do
+        subject.should_receive(:run_all).once
+
+        subject.start
+      end
+    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
+        @stylesheet_compiler.should_receive(:clean).once.ordered
+        @coffeescript_compiler.should_receive(:clean).once.ordered
+        @javascript_compiler.should_receive(:clean).once.ordered
+
+        subject.run_all
+      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
+
+        subject.run_all
+      end
+    end
+
+    describe '#run_on_change' do
+      before :each do
+        @paths = mock('paths').as_null_object
+      end
+
+      it {should respond_to :run_on_change}
+
+      it "should call #compile" do
+        subject.should_receive(:compile).with(@paths).once
+
+        subject.send(:run_on_change, @paths)
+      end
+    end
+
+    describe '#run_on_deletion' do
+      before :each do
+        @paths = mock('paths').as_null_object
+      end
+
+      it {should respond_to :run_on_deletion}
+
+      it "should call #compile" do
+        subject.should_receive(:compile).with(@paths).once
+
+        subject.send(:run_on_deletion, @paths)
+      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
+
+        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
+
+        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
+
+        subject.send :compile, ["app/assets/javascripts/file.js"]
+      end
+
+      it "should compile stylesheets only once" do
+        subject.should_receive(:compile_stylesheet).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
+
+        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
+
+        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
+
+        subject.send :compile, ["app/assets/javascripts/file.js.coffee"]
+      end
+    end
+
+    describe "#file_in_path?" do
+      it "should return true" do
+        subject.send(:file_in_path?, "app/file.js", "app").should be_true
+        subject.send(:file_in_path?, "app/file.js", ["app"]).should be_true
+      end
+
+      it "should return false" do
+        subject.send(:file_in_path?, "app/file.js", "lib").should_not be_true
+        subject.send(:file_in_path?, "app/file.js", ["lib"]).should_not be_true
+      end
+    end
+
+    describe "#is_stylesheet?" do
+      it "should return true for stylesheet file" do
+        subject.send(:is_stylesheet?, "app/assets/stylesheets/file.css").should be_true
+      end
+
+      it "should return false for non-stylesheet files" do
+        subject.send(:is_stylesheet?, "app/assets/javascripts/file.css").should_not be_true
+      end
+    end
+
+    describe "#is_coffeescript?" do
+      it "should return true for coffeescript file" do
+        subject.send(:is_coffeescript?, "app/assets/javascripts/file.js.coffee").should be_true
+      end
+
+      it "should return false for non-coffeescript files" do
+        subject.send(:is_coffeescript?, "app/assets/stylesheets/file.css").should_not be_true
+        subject.send(:is_coffeescript?, "app/assets/stylesheets/file.js").should_not be_true
+      end
+    end
+
+    describe "#is_javascript?" do
+      it "should return true for javascript file" do
+        subject.send(:is_javascript?, "app/assets/javascripts/file.js").should be_true
+      end
+
+      it "should return false for non-coffeescript files" do
+        subject.send(:is_javascript?, "app/assets/stylesheets/file.css").should_not be_true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$: << File.expand_path('../../lib/contao.rb', __FILE__)
+
+require 'active_support/core_ext/kernel/reporting'
+require 'contao'
+require 'fakefs/spec_helpers'
+
+Dir["#{File.expand_path('../support', __FILE__)}/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.run_all_when_everything_filtered = true
+  c.filter_run :focus
+
+  c.include FakeFS::SpecHelpers, :fakefs
+
+  c.before :each do
+    ::TechnoGate::Contao.env  = @env  = :development
+    ::TechnoGate::Contao.root = @root = "/root"
+    ::TechnoGate::Contao::Application.configure do
+      config.javascripts_path   = ['vendor/assets/javascripts', 'lib/assets/javascripts', 'app/assets/javascripts']
+      config.stylesheets_path   = 'app/assets/stylesheets'
+      config.images_path        = 'app/assets/images'
+      config.contao_path        = 'contao'
+      config.contao_public_path = 'public'
+      config.assets_public_path = 'public/resources'
+    end
+
+    silence_warnings do
+      ::Compass::Commands::UpdateProject = stub("Compass Update Project").as_null_object
+      ::Compass::Commands::CleanProject = stub("Compass Clea Project").as_null_object
+      ::Uglifier = stub("Uglifier").as_null_object
+      ::Guard::UI = stub('Guard UI').as_null_object
+    end
+  end
+end

data/spec/support/compiler_shared_examples.rb

@@ -0,0 +1,210 @@
+shared_examples_for "Compiler" do
+  describe "attributes" do
+    it "should have :options as attr_accessor" do
+      subject.should respond_to(:options)
+      subject.should respond_to(:options=)
+    end
+  end
+
+  describe "init" do
+    it "should set options" do
+      subject.class.new(foo: :bar).options[:foo].should == :bar
+    end
+
+    it "should set the manifest_path as an instance variable" do
+      subject.instance_variable_get(:@manifest_path).should ==
+        Pathname('/root/public/resources/manifest.json')
+    end
+  end
+
+  describe "#compile" do
+    before :each do
+      subject.class.any_instance.stub(:prepare_folders)
+      subject.class.any_instance.stub(:compile_assets)
+      subject.class.any_instance.stub(:create_hashed_assets)
+      subject.class.any_instance.stub(:generate_manifest)
+      subject.class.any_instance.stub(:notify)
+    end
+
+    it {should respond_to :compile}
+
+    it "should be accessible at class level" do
+      subject.class.any_instance.should_receive(:compile).once
+      subject.class.compile
+    end
+
+    it "should return self" do
+      subject.compile.should == subject
+    end
+
+    it "should have the following call stack for development" do
+      subject.should_receive(:prepare_folders).once.ordered
+      subject.should_receive(:compile_assets).once.ordered
+      subject.should_receive(:generate_manifest).once.ordered
+      subject.should_receive(:notify).once.ordered
+
+      subject.compile
+    end
+
+    it "should have the following call stack for production" do
+      TechnoGate::Contao.env = :production
+      subject.should_receive(:prepare_folders).once.ordered
+      subject.should_receive(:compile_assets).once.ordered
+      subject.should_receive(:create_hashed_assets).once.ordered
+      subject.should_receive(:notify).once.ordered
+
+      subject.compile
+    end
+  end
+
+  describe "#clean", :fakefs do
+    it {should respond_to :clean}
+
+    it "should be accessible at class level" do
+      subject.class.any_instance.should_receive(:clean).once
+      subject.class.clean
+    end
+
+    it "should remove the entire assets_public_path" do
+      stub_filesystem!
+      File.directory?("/root/public/resources").should be_true
+      subject.clean
+      File.directory?("/root/public/resources").should be_false
+    end
+  end
+
+  describe "#prepare_folders", :fakefs do
+    it {should respond_to :prepare_folders}
+
+    it "should create the js_path" do
+      subject.send :prepare_folders
+      File.directory?("/root/public/resources")
+    end
+  end
+
+  describe "#compile_assets" do
+    it {should respond_to :compile_assets}
+  end
+
+  describe "#create_hashed_assets" do
+    it {should respond_to :create_hashed_assets}
+  end
+
+  describe '#create_digest_for_file', :fakefs do
+    before :each do
+      stub_filesystem!
+
+      @file_path = '/root/file.something.extension'
+      File.open(@file_path, 'w') do |f|
+        f.write('some data')
+      end
+
+      @digest = Digest::MD5.hexdigest('some data')
+      @digested_file_path = "/root/file.something-#{@digest}.extension"
+    end
+
+    it "should be able to create a hashed file" do
+      subject.send(:create_digest_for_file, @file_path)
+      File.exists?(@digested_file_path).should be_true
+    end
+
+    it "should have exactly the same content (a copy of the file)" do
+      subject.send(:create_digest_for_file, @file_path)
+      File.read(@digested_file_path).should == File.read(@file_path)
+    end
+  end
+
+  describe '#generate_manifest_for', :fakefs do
+    before :each do
+      stub_filesystem!
+
+      @files = [
+        '/root/public/resources/application.js',
+        '/root/public/resources/application-d41d8cd98f00b204e9800998ecf8427e.js',
+        '/root/public/resources/application.css',
+        '/root/public/resources/application-982436e5fe99465e0540d0cf38e7aff4.css',
+      ].each {|f| File.open(f, 'w') {|fh| fh.write ""}}
+
+      @manifest_path = '/root/public/resources/manifest.json'
+    end
+
+    describe "stylesheets" do
+      it "should a create a JSON manifest" do
+        subject.send(:generate_manifest_for, "stylesheets", "css")
+
+        File.exists?(@manifest_path).should be_true
+      end
+
+      it "should create a JSON manifest with only non-digested files if the env is development" do
+        subject.send(:generate_manifest_for, "stylesheets", "css")
+
+        manifest = JSON.parse(File.read(@manifest_path))
+        manifest.should have_key('stylesheets')
+        manifest['stylesheets'].should include('application.css')
+        manifest['stylesheets'].should_not include('application-982436e5fe99465e0540d0cf38e7aff4.css')
+      end
+
+      it "should create a JSON manifest with only the digested file if the env is production" do
+        TechnoGate::Contao.env = :production
+        subject.send(:generate_manifest_for, "stylesheets", "css")
+
+        manifest = JSON.parse(File.read(@manifest_path))
+        manifest.should have_key('stylesheets')
+        manifest['stylesheets'].should include('application-982436e5fe99465e0540d0cf38e7aff4.css')
+        manifest['stylesheets'].should_not include('application.css')
+      end
+
+      it "should not touch anything present in the manifest" do
+        File.open(@manifest_path, 'w') do |manifest|
+          manifest.write({"javascripts" => [1, 2, 3]}.to_json)
+        end
+
+        subject.send(:generate_manifest_for, "stylesheets", "css")
+
+        manifest = JSON.parse(File.read(@manifest_path))
+        manifest.should have_key('javascripts')
+        manifest["javascripts"].should == [1, 2, 3]
+      end
+    end
+
+    describe "javascripts" do
+
+      it "should a create a JSON manifest" do
+        subject.send(:generate_manifest_for, "javascripts", "js")
+
+        File.exists?(@manifest_path).should be_true
+      end
+
+      it "should create a JSON manifest with only non-digested files if the env is development" do
+        subject.send(:generate_manifest_for, "javascripts", "js")
+
+        manifest = JSON.parse(File.read(@manifest_path))
+        manifest.should have_key('javascripts')
+        manifest['javascripts'].should include('application.js')
+        manifest['javascripts'].should_not include('application-d41d8cd98f00b204e9800998ecf8427e.js')
+      end
+
+      it "should create a JSON manifest with only the digested file if the env is production" do
+        TechnoGate::Contao.env = :production
+        subject.send(:generate_manifest_for, "javascripts", "js")
+
+        manifest = JSON.parse(File.read(@manifest_path))
+        manifest.should have_key('javascripts')
+        manifest['javascripts'].should include('application-d41d8cd98f00b204e9800998ecf8427e.js')
+        manifest['javascripts'].should_not include('application.js')
+      end
+
+      it "should not touch anything present in the manifest" do
+        File.open(@manifest_path, 'w') do |manifest|
+          manifest.write({"stylesheets" => [1, 2, 3]}.to_json)
+        end
+
+        subject.send(:generate_manifest_for, "javascripts", "js")
+
+        manifest = JSON.parse(File.read(@manifest_path))
+        manifest.should have_key('stylesheets')
+        manifest["stylesheets"].should == [1, 2, 3]
+      end
+    end
+  end
+end

data/spec/support/filesystem_mock.rb

@@ -0,0 +1,20 @@
+def stub_filesystem!
+  [
+
+    '/root/app/assets/javascripts',
+    '/root/app/assets/stylesheets',
+    '/root/app/assets/images',
+    '/root/contao/non_existing_folder',
+    '/root/contao/system/modules/some_extension',
+    '/root/public/resources',
+    '/root/public/system/modules/frontend',
+    '/root/vendor/assets/javascripts',
+    '/tmp',
+
+  ].each do |folder|
+    FileUtils.mkdir_p folder
+    File.open("#{folder}/file.stub", 'w') do |f|
+      f.write "Stub file"
+    end
+  end
+end

data/spec/support/singleton_shared_example.rb

@@ -0,0 +1,17 @@
+shared_examples_for "Singleton" do
+  it "should respond to :instance" do
+    klass.should respond_to :instance
+  end
+
+  it "should return an instance of the class" do
+    klass.instance.should be_instance_of klass
+  end
+
+  it "should raise an error trying to instantiate the class" do
+    expect { klass.new }.to raise_error NoMethodError
+  end
+
+  it "should be a singleton class" do
+    klass.instance.object_id.should == klass.instance.object_id
+  end
+end