contao 0.3.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in contao.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Wael Nasreddine
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Contao
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contao'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contao
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+
+# Require RSpec tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# The default task is tests
+task :default => :spec

data/contao.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/contao/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Wael Nasreddine"]
+  gem.email         = ["wael.nasreddine@gmail.com"]
+  gem.description   = %q{Contao Integration with Compass, Sass, Coffee-script, Rake, Guard with asset pre-compiler and asset-manifest generator}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "contao"
+  gem.require_paths = ["lib"]
+  gem.version       = Contao::VERSION
+
+  # Runtime dependencies
+  gem.add_dependency 'rake'
+  gem.add_dependency 'compass'
+  gem.add_dependency 'oily_png'
+  gem.add_dependency 'uglifier'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'guard'
+  gem.add_dependency 'json'
+  gem.add_dependency 'parseconfig'
+  gem.add_dependency 'highline'
+  gem.add_dependency 'coffee-script'
+
+  # Development dependencies
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'fakefs'
+end

data/lib/contao/application.rb

@@ -0,0 +1,66 @@
+module TechnoGate
+  module Contao
+    class Application < OpenStruct
+      include Singleton
+
+      def initialize
+        super
+        self.config = OpenStruct.new
+      end
+
+      def self.configure(&block)
+        instance.instance_eval(&block)
+      end
+
+      def self.config
+        instance.config
+      end
+
+      def linkify
+        exhaustive_list_of_files_to_link(
+          Contao.expandify(Application.config.contao_path),
+          Contao.expandify(Application.config.contao_public_path)
+        ).each do |list|
+          FileUtils.ln_s list[0], list[1]
+        end
+      end
+
+      def self.linkify
+        instance.linkify
+      end
+
+      def self.load_tasks
+        Dir["#{File.expand_path '../tasks', __FILE__}/**/*.rake"].each {|f| load f}
+      end
+
+      def name
+        File.basename TechnoGate::Contao.root
+      end
+
+      def self.name
+        instance.name
+      end
+
+      protected
+
+      # Return an array of arrays of files to link
+      #
+      # @param [String] Absolute path to folder from which to link
+      # @param [String] Absolute path to folder to which to link
+      # @return [Array]
+      def exhaustive_list_of_files_to_link(from, to)
+        files = []
+        Dir["#{from}/*"].each do |f|
+          file = "#{to}/#{File.basename f}"
+          if File.exists? file
+            exhaustive_list_of_files_to_link(f, file).each { |f| files << f }
+          else
+            files << [f, file]
+          end
+        end
+
+        files
+      end
+    end
+  end
+end

data/lib/contao/coffeescript_compiler.rb

@@ -0,0 +1,50 @@
+require 'coffee_script'
+require 'contao/compiler'
+require 'fileutils'
+
+module TechnoGate
+  module Contao
+    class CoffeescriptCompiler < Compiler
+
+      def initialize(options = {})
+        super
+      end
+
+      def clean
+        FileUtils.rm_rf compiled_javascript_path.to_s if File.exists?(compiled_javascript_path)
+
+        super
+      end
+
+      protected
+
+      # 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|
+          Dir["#{Contao.expandify(src_path)}/**/*.coffee"].sort.each do |file|
+            dest = compute_destination_filename(src_path, file)
+            FileUtils.mkdir_p File.dirname(dest)
+            File.open(dest, 'w') do |f|
+              f.write ::CoffeeScript.compile(File.read(file))
+            end
+          end
+        end
+      end
+
+      def compute_destination_filename(src_path, file)
+        dest = "#{compiled_javascript_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

@@ -0,0 +1,104 @@
+require 'active_support/core_ext/string/inflections'
+require 'json'
+
+module TechnoGate
+  module Contao
+    class Compiler
+      attr_accessor :options
+
+      def initialize(options = {})
+        @options = options
+        @manifest_path = assets_public_path.join('manifest.json')
+      end
+
+      # Compile assets
+      def compile
+        prepare_folders
+        compile_assets
+        create_hashed_assets if Contao.env == :production
+        generate_manifest
+        notify
+
+        self
+      end
+
+      def self.compile
+        new.compile
+      end
+
+      def clean
+        FileUtils.rm_rf Contao.expandify(Application.config.assets_public_path)
+      end
+
+      def self.clean
+        new.clean
+      end
+
+      protected
+      def assets_public_path
+        Contao.expandify(Contao::Application.config.assets_public_path)
+      end
+
+      # Prepare folders
+      def prepare_folders
+        FileUtils.mkdir_p assets_public_path
+      end
+
+      def compile_assets
+      end
+
+      def create_hashed_assets
+      end
+
+      def notify
+        klass_name = self.class.to_s.split('::').last
+
+        Notifier.notify("#{klass_name.underscore.humanize} finished successfully.", title: klass_name)
+      end
+
+      # Create a diges for a given file
+      #
+      # This method creates a digested file for a given file path
+      #
+      # @param [Pathname | String] file_path
+      def create_digest_for_file(file_path)
+        digest = Digest::MD5.hexdigest File.read(file_path)
+        digested_file_path = "#{file_path.to_s.chomp(File.extname(file_path))}-#{digest}#{File.extname(file_path)}"
+        FileUtils.cp file_path, digested_file_path
+
+        digested_file_path
+      end
+
+      # This method generates a manifest of all generated files
+      # so it can be parsed and processed by the PHP application
+      #
+      # This method is expected to be overridden
+      def generate_manifest
+      end
+
+      def generate_manifest_for(key, extension)
+        manifest = JSON.parse(File.read(@manifest_path)) rescue {}
+        manifest[key] = []
+
+        all_files      = Dir["#{assets_public_path}/**/*.#{extension}"]
+        digested_files = all_files.select {|f| f =~ /^.+-[0-9a-f]{32}\.#{extension}$/}
+        non_digested_files = all_files - digested_files
+
+        if Contao.env == :production
+          files = digested_files
+        else
+          files = non_digested_files
+        end
+
+        files.each do |file|
+          file.slice! "#{assets_public_path}/"
+          manifest[key] << file
+        end
+
+        File.open(@manifest_path, 'w') do |f|
+          f.write(manifest.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/contao/javascript_compiler.rb

@@ -0,0 +1,62 @@
+require 'contao/compiler'
+require 'fileutils'
+require 'uglifier'
+
+module TechnoGate
+  module Contao
+    class JavascriptCompiler < Compiler
+
+      def initialize(options = {})
+        super
+      end
+
+      protected
+
+      # Compile assets
+      #
+      # This method compiles javascripts from
+      # Application.config.javascripts_path into
+      # Application.config.assets_public_path/application.js and it uglifies
+      # only if the environment is equal to :production
+      def compile_assets
+        tmp_app_js = Contao.root.join('tmp/application.js')
+        FileUtils.mkdir_p File.dirname(tmp_app_js)
+
+        File.open(tmp_app_js, 'w') do |compressed|
+          javascripts_path.each do |src_path|
+            Dir["#{Contao.expandify(src_path)}/**/*.js"].sort.each do |f|
+              if TechnoGate::Contao.env == :production
+                compressed.write(Uglifier.new.compile(File.read(f)))
+              else
+                compressed.write("// #{f}\n")
+                compressed.write(File.read(f))
+                compressed.write("\n")
+              end
+            end
+          end
+        end
+
+        FileUtils.mv tmp_app_js, application_js_path
+      end
+
+      def javascripts_path
+        Application.config.javascripts_path.map do |path|
+          ["tmp/compiled_javascript/#{path.gsub('/', '_')}", path]
+        end.flatten
+      end
+
+      # This function creates a hashed version of the assets
+      def create_hashed_assets
+        create_digest_for_file(Contao.expandify(Contao::Application.config.assets_public_path).join("application.js"))
+      end
+
+      def application_js_path
+        Contao.expandify(Application.config.assets_public_path).join("application.js")
+      end
+
+      def generate_manifest
+        generate_manifest_for("javascripts", "js")
+      end
+    end
+  end
+end

data/lib/contao/notifier.rb

@@ -0,0 +1,24 @@
+require 'singleton'
+require 'guard'
+
+module TechnoGate
+  module Contao
+    class Notifier
+      include Singleton
+
+      def notify(message, options = {})
+        if ::Guard::UI.send(:color_enabled?)
+          message = "\e[0;34mContao>>\e[0m \e[0;32m#{message}\e[0m"
+        else
+          message = "Contao>> #{message}"
+        end
+
+        ::Guard::UI.info(message, options)
+      end
+
+      def self.notify(*args, &block)
+        instance.notify(*args, &block)
+      end
+    end
+  end
+end

data/lib/contao/stylesheet_compiler.rb

@@ -0,0 +1,45 @@
+require 'contao/compiler'
+require 'compass'
+require 'compass/commands'
+
+module TechnoGate
+  module Contao
+    class StylesheetCompiler < Compiler
+
+      def initialize(options = {})
+        super
+      end
+
+      def clean
+        @cleaner ||= Compass::Commands::CleanProject.new(
+          Contao.root,
+          configuration_file: Contao.root.join('config', 'compass.rb')
+        )
+
+        @cleaner.execute
+
+        super
+      end
+
+      protected
+      def compile_assets
+        @updater ||= Compass::Commands::UpdateProject.new(
+          Contao.root,
+          configuration_file: Contao.root.join('config', 'compass.rb')
+        )
+
+        @updater.execute
+      end
+
+      def create_hashed_assets
+        Dir["#{Contao.expandify(Contao::Application.config.assets_public_path)}/**/*.css"].each do |file|
+          create_digest_for_file Pathname(file).expand_path
+        end
+      end
+
+      def generate_manifest
+        generate_manifest_for("stylesheets", "css")
+      end
+    end
+  end
+end

data/lib/contao/tasks/assets.rake

@@ -0,0 +1,23 @@
+namespace :assets do
+  desc "Compile javascript"
+  task :javascript do
+    TechnoGate::Contao::CoffeescriptCompiler.compile
+    TechnoGate::Contao::CoffeescriptCompiler.compile
+    TechnoGate::Contao::JavascriptCompiler.compile
+  end
+
+  desc "Compile stylesheet"
+  task :stylesheet do
+    TechnoGate::Contao::StylesheetCompiler.compile
+  end
+
+  desc "Clean assets"
+  task :clean do
+    TechnoGate::Contao::StylesheetCompiler.clean
+    TechnoGate::Contao::CoffeescriptCompiler.clean
+    TechnoGate::Contao::JavascriptCompiler.clean
+  end
+
+  desc "Precompile assets"
+  task :precompile => [:clean, :stylesheet, :javascript]
+end

data/lib/contao/tasks/contao.rake

@@ -0,0 +1,101 @@
+require 'highline'
+
+def ask(what, options = {})
+  default = options[:default]
+  validate = options[:validate] || /(y(es)?)|(no?)|(a(bort)?|\n)/i
+  echo = (options[:echo].nil?) ? true : options[:echo]
+
+  ui = HighLine.new
+  ui.ask("#{what}?  ") do |q|
+    q.overwrite = false
+    q.default = default
+    q.validate = validate
+    q.responses[:not_valid] = what
+    unless echo
+      q.echo = "*"
+    end
+  end
+end
+
+namespace :contao do
+  desc "Link all contao files"
+  task :bootstrap do
+    public = TechnoGate::Contao.expandify(TechnoGate::Contao::Application.config.contao_public_path)
+
+    TechnoGate::Contao::Application.linkify
+
+    FileUtils.mkdir_p public.join('system/logs')
+    File.open(public.join('sitemap.xml'), 'w') {|f| f.write ''}
+
+    Rake::Task['contao:fix_permissions'].invoke
+    Rake::Task['contao:generate_localconfig'].invoke
+    Rake::Task['contao:generate_htaccess'].invoke
+    Rake::Task['assets:precompile'].invoke
+
+    TechnoGate::Contao::Notifier.notify("The contao folder has been bootstraped, Good Luck.", title: "Contao Bootstrap")
+  end
+
+  desc "Fix permissions"
+  task :fix_permissions do
+    require 'fileutils'
+
+    public = TechnoGate::Contao.expandify(TechnoGate::Contao::Application.config.contao_public_path)
+    paths = [
+      'system/html',
+      'system/logs',
+      'system/scripts',
+      'system/tmp',
+      'system/cache',
+    ].map {|p| public.join p}.reject {|p| !File.exists? p}
+
+    FileUtils.chmod 0777, paths
+
+    Dir["#{public}/system/modules/efg/**/*"].each do |f|
+      if File.directory?(f)
+        FileUtils.chmod 0777, f
+      else
+        FileUtils.chmod 0666, f
+      end
+    end
+
+    FileUtils.chmod 0666, public.join('sitemap.xml')
+
+    TechnoGate::Contao::Notifier.notify("The contao folder's permissions has been fixed.", title: "Contao Bootstrap")
+  end
+
+  desc "Generate the localconfig.php"
+  task :generate_localconfig do
+    require 'parseconfig'
+
+    my_cnf_path = File.expand_path("#{ENV['HOME']}/.my.cnf")
+    localconfig_template = TechnoGate::Contao.expandify('config/examples/localconfig.php.erb')
+    localconfig_path = TechnoGate::Contao.expandify(TechnoGate::Contao::Application.config.contao_public_path).join('system/config/localconfig.php')
+
+    if File.exists?(my_cnf_path)
+      my_cnf = ParseConfig.new(my_cnf_path)
+      mysql_host = my_cnf.params['client']['host']
+      mysql_user = my_cnf.params['client']['user']
+      mysql_password = my_cnf.params['client']['password']
+    else
+      puts "Please add these details to #{my_cnf_path}"
+      mysql_host = ask("What host is mysql running on", default: 'localhost', validate: /.+/)
+      mysql_user = ask("What user to use with mysql", validate: /.+/)
+      mysql_password = ask("What is the user's password", validate: /.+/, echo: false)
+    end
+    mysql_database = TechnoGate::Contao::Application.name
+    contao_env = TechnoGate::Contao.env
+
+    localconfig = ERB.new(File.read(localconfig_template)).result(binding)
+    File.open(localconfig_path, 'w') {|f| f.write localconfig }
+
+    TechnoGate::Contao::Notifier.notify("The configuration file localconfig.php was generated successfully.", title: "Contao Bootstrap")
+  end
+
+  desc "Generate the htaccess file"
+  task :generate_htaccess do
+    public = TechnoGate::Contao.expandify(TechnoGate::Contao::Application.config.contao_public_path)
+    FileUtils.cp public.join('.htaccess.default'), public.join('.htaccess')
+
+    TechnoGate::Contao::Notifier.notify("The .htaccess was successfully generated.", title: "Contao Bootstrap")
+  end
+end

data/lib/contao/tasks/jasmine.rake

@@ -0,0 +1,8 @@
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/lib/contao/tasks/whitespace.rake

@@ -0,0 +1,13 @@
+# Taken from RefineryCMD
+# https://github.com/resolve/refinerycms/blob/master/core/lib/tasks/refinery.rake
+desc 'Removes trailing whitespace across the entire application.'
+task :whitespace do
+  require 'rbconfig'
+  if RbConfig::CONFIG['host_os'] =~ /linux/
+    sh %{find . -name '*.*rb' -o -name '*.*php' -o -name '*.*coffee' -o -name '*.*sass' -exec sed -i 's/\t/ /g' {} \\; -exec sed -i 's/ *$//g' {} \\; }
+  elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+    sh %{find . -name '*.*rb' -o -name '*.*php' -o -name '*.*coffee' -o -name '*.*sass' -exec sed -i '' 's/\t/ /g' {} \\; -exec sed -i '' 's/ *$//g' {} \\; }
+  else
+    puts "This doesn't work on systems other than OSX or Linux. Please use a custom whitespace tool for your platform '#{RbConfig::CONFIG["host_os"]}'."
+  end
+end

data/lib/contao/version.rb

@@ -0,0 +1,3 @@
+module Contao
+  VERSION = '0.3.1'
+end