contao 0.4.0 → 0.4.1

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode     # We have some failing specs we need to take care of
+    - rvm: jruby-19mode   # This is more complicated as we need the oily_ong gem but it doesn't work for Jruby
+notifications:
+  recipients:
+    - wael.nasreddine@gmail.com

data/README.md

@@ -1,24 +1,113 @@
 # Contao
 
-TODO: Write a gem description
+Welcome to Contao!
+[![Build
+Status](https://secure.travis-ci.org/TechnoGate/contao.png?branch=master)](http://travis-ci.org/TechnoGate/contao)
+[![Gemnasium](https://gemnasium.com/TechnoGate/contao.png)](https://gemnasium.com/TechnoGate/contao)
 
-## Installation
+This gem will help you to quickly generate an application using [Contao
+CMS](http://www.contao.org/en/) which has pre-built support for Sass,
+Compass, CoffeeScript, Jasmine and Capistrano.
+
+It also feature hashed assets served by the [Contao Assets
+extension](https://github.com/TechnoGate/contao_assets), which allows you
+to have an md5 appended to each of your assets URL on the production
+site.
+
+The integration with Capistrano allows you to quickly deploy, copy
+assets, import database and even upload media such as images and PDFs
+all from the command line using Capistrano.
+
+## Pre-requisites
+
+Before installing the gem, you need to make you are running on a Ruby
+version 1.9.2 or greater as this Gem and most of it's dependencies do
+not support Ruby 1.8, to check the version you are running, uee the
+following command:
 
-Add this line to your application's Gemfile:
+```bash
+ruby --version
+```
 
-    gem 'contao'
+If you're running a ruby version below 1.9, please install a 1.9 version
+by following the guide at the [Rbenv
+Installer](https://github.com/fesplugas/rbenv-installer) project.
 
-And then execute:
+## Installation
 
-    $ bundle
+Install contao with the following command
 
-Or install it yourself as:
+```ruby
+gem install contao
+```
 
-    $ gem install contao
+Don't forget to run `rbenv rehash` if you are using
+**[rbenv](https://github.com/sstephenson/rbenv)** as this gem provides
+an executable.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Generating a config file
+
+To start using contao, you need to generate a config file, issue the
+command
+
+```bash
+contao generate config
+```
+
+and follow the on-screen instructions.
+
+### Generate a new project
+
+Generating a new project is very easy, just use the following command:
+
+```bash
+contao new /path/to/my_project
+```
+
+This command will generate an application called `my\_project` in the
+folder `/path/to`, the application name is very important as it defaults
+to the name of your database, check the [Database name](#database-name)
+section below for more information.
+
+### Initialising the project
+
+Once the project generator has completed, cd into the newsly created
+project and bootstrap contao by running
+
+```bash
+bundle exec rake contao:bootstrap
+```
+
+Now visit `/contao/install.php` or just visit the website and you should
+be redirected to the Installation script, from here on it is the usual
+Contao installation procedure, please check [Contao's user
+guide](http://www.contao.org/en/installing-contao.html#install-tool) for
+detailed information
+
+### Work on the project
+
+To be able to develop with this version of Contao, you first need to
+understand how it actually works.
+
+TODO: Continue this section
+
+## Database name
+
+Locally, the database name is the same as the application name, so if
+you named your project is named **my_project**, the database name will be
+named **my_project**.
+
+On the server, Capistrano will append the environment on which the
+deployment occured (check the deployment section below for more
+information) to the application name, so if your project is named
+**my_project** and you are deployment to the staging environment, the
+database name would default to **my_project_staging**
+
+## Deploying
+
+TODO: Write this section
 
 ## Contributing
 
@@ -27,3 +116,44 @@ TODO: Write usage instructions here
 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
+
+Or
+
+[![Click here to lend your support to: Open Source Projects and make a donation at www.pledgie.com!](http://pledgie.com/campaigns/16123.png?skin_name=chrome)](http://www.pledgie.com/campaigns/16123)
+
+## Contact
+
+For bugs and feature request, please use __Github issues__, for other
+requests, you may use:
+
+- [Google Groups](http://groups.google.com/group/janus-vimius)
+- [Github private message](https://github.com/inbox/new/eMxyzptlk)
+- Email: [contact@technogate.fr](mailto:contact@technogate.fr)
+
+Don't forget to follow me on [Github](https://github.com/eMxyzptlk) and
+[Twitter](https://twitter.com/eMxyzptlk) for news and updates.
+
+## License
+
+### This code is free to use under the terms of the MIT license.
+
+Copyright (c) 2011 TechnoGate <support@technogate.fr>
+
+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/contao.gemspec

@@ -2,19 +2,33 @@
 require File.expand_path('../lib/contao/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Wael Nasreddine"]
-  gem.email         = ["wael.nasreddine@gmail.com"]
+  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.summary       = <<-EOS
+This gem will help you to quickly generate an application using Contao
+CMS which has pre-built support for Sass, Compass, CoffeeScript, Jasmine
+and Capistrano.
+
+It also feature hashed assets served by the Contao Assets extension,
+which allows you to have an md5 appended to each of your assets URL on
+the production site.
+
+The integration with Capistrano allows you to quickly deploy, copy
+assets, import database and even upload media such as images and PDFs
+all from the command line using Capistrano.
+  EOS
   gem.homepage      = ""
+  gem.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
 
   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.name          = 'contao'
+  gem.require_paths = ['lib']
   gem.version       = Contao::VERSION
 
+
   # Runtime dependencies
   gem.add_dependency 'rake'
   gem.add_dependency 'compass'

data/lib/contao.rb

@@ -1,5 +1,5 @@
 require 'contao/version'
-require 'core_ext/object'
+require 'contao/core_ext/object'
 require 'singleton'
 require 'ostruct'
 

data/lib/contao/application.rb

@@ -1,4 +1,7 @@
 require 'yaml'
+require 'ostruct'
+require 'singleton'
+require 'contao/core_ext/object'
 
 module TechnoGate
   module Contao
@@ -49,7 +52,7 @@ module TechnoGate
         {
           'install_password' => '',
           'encryption_key'   => '',
-          'admin_email'      => 'wael@technogate.fr',
+          'admin_email'      => 'admin@example.com',
           'time_zone'        => 'Europe/Paris',
           'mysql'            => {
             'host'           => 'localhost',

data/lib/contao/commands/application.rb

@@ -9,6 +9,20 @@ case ARGV[0]
 when 'new'
   require 'contao/generators/application'
   TechnoGate::Contao::Generators::Application.new(path: ARGV[1]).generate
+when 'generate'
+  case ARGV[1]
+  when 'config'
+    require 'contao/generators/config'
+    begin
+      TechnoGate::Contao::Generators::Config.new.generate
+    rescue TechnoGate::Contao::Generators::Config::AlreadyExists
+      require 'contao/notifier'
+      TechnoGate::Contao::Notifier.error "The configuration file exists and cannot be overwritten", title: "Config Generator"
+    end
+  else
+    require 'contao/commands/help'
+    print_help
+  end
 else
   require 'contao/commands/help'
   print_help

data/lib/contao/commands/help.rb

@@ -2,16 +2,21 @@ def print_help
   puts <<-EOH.gsub(/ [ ]+/, ' ')
     Welcome to Contao!
 
-    This gem will help you to quickly generate an application using contao
-    that has pre-built support for Sass, Compass, CoffeeScript, Jasmine and
-    Capistrano.
+    This gem will help you to quickly generate an application using Contao
+    CMS which has pre-built support for Sass, Compass, CoffeeScript, Jasmine
+    and Capistrano.
 
-    It also feature hashed assets served by the Contao Assets extension, this
-    allows you to have an md5 appended to each of your assets file name
+    It also feature hashed assets served by the Contao Assets extension,
+    which allows you to have an md5 appended to each of your assets URL on
+    the production site.
+
+    The integration with Capistrano allows you to quickly deploy, copy
+    assets, import database and even upload media such as images and PDFs
+    all from the command line using Capistrano.
 
     To generate a new project, use the following command:
 
-      $ contao new /path/to/application
+    	$ contao new /path/to/application
 
     The generated application will be created at /path/to/application and the
     application name would be set to the last component in the path, in this

data/lib/contao/generators/config.rb

@@ -0,0 +1,33 @@
+require 'contao/generators/base'
+require 'contao/application'
+require 'contao/notifier'
+require 'fileutils'
+
+module TechnoGate
+  module Contao
+    module Generators
+      class Config < Base
+        class AlreadyExists < RuntimeError; end
+
+        def generate
+          raise AlreadyExists if File.exists?(global_config_path)
+
+          FileUtils.mkdir_p File.dirname(global_config_path)
+          File.open global_config_path, 'w' do |config|
+            config.write YAML.dump(Contao::Application.default_global_config)
+          end
+
+          message = <<-EOS.gsub(/ [ ]+/, '').gsub("\n", ' ').chop
+          The configuration file has been created at ~/.contao/config.yml,
+          you need to edit this file before working with contao
+          EOS
+          Notifier.notify message, title: 'Config Generator'
+        end
+
+        def global_config_path
+          Contao::Application.instance.global_config_path
+        end
+      end
+    end
+  end
+end

data/lib/contao/notifier.rb

@@ -1,38 +1,35 @@
-require 'singleton'
 require 'guard'
 
 module TechnoGate
   module Contao
-    class Notifier
-      include Singleton
+    module Notifier
+      extend self
 
       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
+        say(message, options.merge(color: 32))
+      end
 
-        ::Guard::UI.info(message, options)
+      def warn(message, options = {})
+        say(message, options.merge(color: 33))
       end
 
-      def self.notify(*args, &block)
-        instance.notify(*args, &block)
+      def error(message, options = {})
+        say(message, options.merge(color: 31))
       end
 
-      def warn(message, options = {})
+      protected
+
+      def say(message, options = {})
+        color = options.delete(:color)
+
         if ::Guard::UI.send(:color_enabled?)
-          message = "\e[0;34mContao>>\e[0m \e[0;33m#{message}\e[0m"
+          message = "\e[0;34mContao>>\e[0m \e[0;#{color}m#{message}\e[0m"
         else
           message = "Contao>> #{message}"
         end
 
         ::Guard::UI.info(message, options)
       end
-
-      def self.warn(*args, &block)
-        instance.warn(*args, &block)
-      end
     end
   end
 end

data/lib/contao/tasks/contao.rake

@@ -27,11 +27,11 @@ namespace :contao do
     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['contao:apply_patches'].invoke
     Rake::Task['assets:precompile'].invoke
+    Rake::Task['contao:fix_permissions'].invoke
 
     TechnoGate::Contao::Notifier.notify("The contao folder has been bootstraped, Good Luck.", title: "Contao Bootstrap")
   end
@@ -64,10 +64,13 @@ namespace :contao do
       'system/scripts',
       'system/tmp',
       'system/cache',
+      'system/config',
     ].map {|p| public.join p}.reject {|p| !File.exists? p}
 
     FileUtils.chmod 0777, paths
 
+    FileUtils.chmod 0666, Dir["#{public}/system/config/**/*.php"]
+
     Dir["#{public}/system/modules/efg/**/*"].each do |f|
       if File.directory?(f)
         FileUtils.chmod 0777, f

data/lib/contao/version.rb

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

data/spec/lib/contao/generators/config_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'contao/generators/config'
+
+module TechnoGate
+  module Contao
+    module Generators
+      describe Config do
+        let(:klass) { Config }
+        subject {
+          Config.new path: @path
+        }
+
+        before :each do
+          @path = '/root/my_awesome_project'
+          @config_path = "#{ENV['HOME']}/.contao/config.yml"
+          Notifier.stub :notify
+        end
+
+        it_should_behave_like "Generator"
+
+        describe '#generate', :fakefs do
+          before :each do
+            stub_filesystem!
+            FileUtils.rm_rf File.dirname(@config_path)
+          end
+
+          it "should create ~/.contao" do
+            subject.generate
+
+            File.exists?(File.dirname(@config_path)).should be_true
+          end
+
+          it "the config file should exists" do
+            subject.generate
+
+            File.exists?(@config_path).should be_true
+          end
+
+          it "should generate the config file" do
+            subject.generate
+
+            File.read("#{ENV['HOME']}/.contao/config.yml").should ==
+              YAML.dump(Contao::Application.default_global_config)
+          end
+
+          it "should call the Notifier" do
+            message = <<-EOS.gsub(/ [ ]+/, '').gsub("\n", ' ').chop
+            The configuration file has been created at ~/.contao/config.yml,
+            you need to edit this file before working with contao
+            EOS
+            Notifier.should_receive(:notify).with(message, title: 'Config Generator').once
+
+            subject.generate
+          end
+
+          it "should raise ConfigAlreadyExists if the config already exists" do
+            subject.generate
+
+            expect do
+              subject.generate
+            end.to raise_error(Config::AlreadyExists)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/contao/notifier_spec.rb

@@ -3,11 +3,6 @@ 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"
@@ -40,9 +35,9 @@ module TechnoGate
         end
 
         it "should be accessible at class level" do
-          klass.any_instance.should_receive(:notify).with(@message, @options)
+          subject.should_receive(:notify).with(@message, @options)
 
-          klass.notify(@message, @options)
+          subject.notify(@message, @options)
         end
       end
 
@@ -78,9 +73,47 @@ module TechnoGate
         end
 
         it "should be accessible at class level" do
-          klass.any_instance.should_receive(:warn).with(@message, @options)
+          subject.should_receive(:warn).with(@message, @options)
+
+          subject.warn(@message, @options)
+        end
+      end
+
+      describe '#error' do
+        before :each do
+          @message = "Hello"
+          @output  = "Contao>> #{@message}"
+          @colored_output = "\e[0;34mContao>>\e[0m \e[0;31m#{@message}\e[0m"
+          @options = {title: "Hello, World!"}
+
+          ::Guard::UI.stub(:color_enabled?).and_return(false)
+        end
+
+        it {should respond_to :error}
+
+        it "should call guard ui" do
+          ::Guard::UI.should_receive(:info).with(@output, {})
+
+          subject.error(@message)
+        end
+
+        it "should send whatever options passed to the info method" do
+          ::Guard::UI.should_receive(:info).with(@output, @options)
+
+          subject.error(@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.error(@message, @options)
+        end
+
+        it "should be accessible at class level" do
+          subject.should_receive(:error).with(@message, @options)
 
-          klass.warn(@message, @options)
+          subject.error(@message, @options)
         end
       end
     end

data/spec/lib/contao_spec.rb

@@ -33,10 +33,8 @@ module TechnoGate
       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
+        subject.root = '~/Desktop'
+        subject.class_variable_get(:@@root).should == Pathname.new('~/Desktop').expand_path
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contao
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -214,6 +214,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -227,8 +228,10 @@ files:
 - lib/contao/commands/application.rb
 - lib/contao/commands/help.rb
 - lib/contao/compiler.rb
+- lib/contao/core_ext/object.rb
 - lib/contao/generators/application.rb
 - lib/contao/generators/base.rb
+- lib/contao/generators/config.rb
 - lib/contao/javascript_compiler.rb
 - lib/contao/notifier.rb
 - lib/contao/stylesheet_compiler.rb
@@ -239,7 +242,6 @@ files:
 - lib/contao/tasks/whitespace.rake
 - lib/contao/version.rb
 - lib/contao_patches/development/development_htaccess.patch
-- lib/core_ext/object.rb
 - lib/guard/assets.rb
 - lib/monkey_patches.rb
 - lib/monkey_patches/compass/urls.rb
@@ -247,6 +249,7 @@ files:
 - spec/lib/contao/coffeescript_compiler_spec.rb
 - spec/lib/contao/generators/application_spec.rb
 - spec/lib/contao/generators/base_spec.rb
+- spec/lib/contao/generators/config_spec.rb
 - spec/lib/contao/javascript_compiler_spec.rb
 - spec/lib/contao/notifier_spec.rb
 - spec/lib/contao/stylesheet_compiler_spec.rb
@@ -269,10 +272,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 4578868734635956444
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -281,19 +281,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4578868734635956444
+      hash: -2428308955429716338
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Contao Integration with Compass, Sass, Coffee-script, Rake, Guard with asset
-  pre-compiler and asset-manifest generator
+summary: This gem will help you to quickly generate an application using Contao CMS
+  which has pre-built support for Sass, Compass, CoffeeScript, Jasmine and Capistrano.  It
+  also feature hashed assets served by the Contao Assets extension, which allows you
+  to have an md5 appended to each of your assets URL on the production site.  The
+  integration with Capistrano allows you to quickly deploy, copy assets, import database
+  and even upload media such as images and PDFs all from the command line using Capistrano.
 test_files:
 - spec/lib/contao/application_spec.rb
 - spec/lib/contao/coffeescript_compiler_spec.rb
 - spec/lib/contao/generators/application_spec.rb
 - spec/lib/contao/generators/base_spec.rb
+- spec/lib/contao/generators/config_spec.rb
 - spec/lib/contao/javascript_compiler_spec.rb
 - spec/lib/contao/notifier_spec.rb
 - spec/lib/contao/stylesheet_compiler_spec.rb