contao 0.5.2 → 0.6.0

data/lib/contao/generators/config.rb

@@ -14,7 +14,7 @@ module TechnoGate
 
           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)
+            config.write YAML.dump(default_global_config)
           end
 
           message = <<-EOS.gsub(/ [ ]+/, '').gsub("\n", ' ').chop
@@ -25,7 +25,11 @@ module TechnoGate
         end
 
         def global_config_path
-          Contao::Application.instance.global_config_path
+          Contao::Application.global_config_path
+        end
+
+        def default_global_config(options = {})
+          Contao::Application.send(:default_global_config, options)
         end
       end
     end

data/lib/contao/generators/contao_initializer.rb

@@ -0,0 +1,54 @@
+require 'contao/generators/base'
+
+module TechnoGate
+  module Contao
+    module Generators
+      class ContaoInitializer < Base
+
+        TEMPLATE = File.expand_path '../../templates/contao_initializer.rb.erb', __FILE__
+
+        def generate
+          config = build_config
+          File.open initializer_path, 'w' do |f|
+            f.write ERB.new(File.read TEMPLATE).result(binding)
+          end
+        end
+
+        protected
+
+        def initializer_path
+          "#{project_path}/config/initializers/contao.rb"
+        end
+
+        def build_config
+          config = ActiveSupport::OrderedOptions.new
+
+          config.install_password = install_password
+          config.encryption_key   = encryption_key
+          config.admin_email      = global.admin_email
+          config.time_zone        = global.time_zone
+          config.smtp_enabled     = global.smtp.enabled
+          config.smtp_host        = global.smtp.host
+          config.smtp_user        = global.smtp.user
+          config.smtp_pass        = global.smtp.pass
+          config.smtp_ssl         = global.smtp.ssl
+          config.smtp_port        = global.smtp.port
+
+          config
+        end
+
+        def global
+          Contao::Application.config.contao.global
+        end
+
+        def install_password
+          Password.create(global.install_password).to_s
+        end
+
+        def encryption_key
+          SecureRandom.hex 16
+        end
+      end
+    end
+  end
+end

data/lib/contao/password.rb

@@ -0,0 +1,40 @@
+require 'digest/sha1'
+require 'securerandom'
+
+module TechnoGate
+  module Contao
+    class Password
+      SALT_SIZE = 23
+
+      def initialize(password_hash)
+        password_hash.split(':').tap do |p|
+          @password_hash = p[0]
+          @salt          = p[1]
+        end
+      end
+
+      def self.create(password)
+        salt = generate_salt
+        new "#{hash_password(password, salt)}:#{salt}"
+      end
+
+      def to_s
+        "#{@password_hash}:#{@salt}"
+      end
+
+      protected
+
+      def self.hash_password(password, salt)
+        Digest::SHA1.hexdigest "#{salt}#{password}"
+      end
+
+      def self.generate_salt
+        random[0...SALT_SIZE]
+      end
+
+      def self.random(length = 64)
+        SecureRandom.hex length
+      end
+    end
+  end
+end

data/lib/contao/railties.rb

@@ -0,0 +1,32 @@
+require 'rails/railtie'
+
+module TechnoGate
+  module Contao
+    class Railtie < Rails::Railtie
+      railtie_name :contao
+
+      rake_tasks do
+        Dir["#{File.expand_path '../../tasks', __FILE__}/**/*.rake"].each {|f| load f}
+      end
+
+      initializer 'load_contao_configurations' do
+        TechnoGate::Contao::Application.load_global_config!
+      end
+    end
+  end
+end
+
+class Rails::Railtie::Configuration
+  def contao
+    @contao_configuration ||= default_contao_configuration
+  end
+
+  private
+
+  def default_contao_configuration
+    cc = ActiveSupport::OrderedOptions.new
+    cc.smtp = ActiveSupport::OrderedOptions.new
+    cc.smtp.enabled = false
+    cc
+  end
+end

data/lib/contao/templates/contao_initializer.rb.erb

@@ -0,0 +1,41 @@
+# This initializer is used by Rake and Capistrano to help generating the
+# localconfig.php file, it stores basically the encrypted install password,
+# the encryption_key and the SMTP credentials if SMTP is enabled
+
+module ContaoTemplate
+  class Application < Rails::Application
+    # The install password is used by /contao/install.php page
+    config.contao.install_password = '<%= config.install_password %>'
+
+    # The encryption key is used by extensions
+    config.contao.encryption_key = '<%= config.encryption_key %>'
+
+    # The admin email
+    config.admin_email = '<%= config.admin_email %>'
+
+    # The time zone
+    config.time_zone = '<%= config.time_zone %>'
+
+    # SMTP Configuration
+    # Configure contao to use an SMTP server
+
+    # Enable SMTP ?
+    config.contao.smtp.enabled = <%= config.smtp_enabled %>
+    <% if config.smtp_enabled %>
+    # SMTP Host
+    config.contao.smtp.host = '<%= config.smtp_host %>'
+
+    # SMTP User
+    config.contao.smtp.user = '<%= config.smtp_user %>'
+
+    # SMTP Pass
+    config.contao.smtp.pass = '<%= config.smtp_pass %>'
+
+    # SMTP SSL
+    config.contao.smtp.ssl = <%= config.smtp_ssl %>
+
+    # SMTP Port
+    config.contao.smtp.port = <%= config.smtp_port %>
+    <% end %>
+  end
+end

data/lib/contao/version.rb

@@ -1,3 +1,3 @@
 module Contao
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/lib/contao.rb

@@ -3,12 +3,10 @@ require 'contao/core_ext/object'
 require 'singleton'
 require 'ostruct'
 
-module TechnoGate
-  module Contao
-  end
-end
+# Utilities
+require 'contao/password'
 
 # Contao
 require 'contao/application'
 require 'contao/notifier'
-require 'contao/railtie' if defined?(Rails)
+require 'contao/railties' if defined?(::Rails)

data/lib/tasks/contao.rake

@@ -12,7 +12,7 @@ def ask(what, options = {})
     q.validate = validate
     q.responses[:not_valid] = what
     unless echo
-      q.echo = "*"
+      q.echo = '*'
     end
   end
 end
@@ -22,7 +22,7 @@ def public_path
 end
 
 namespace :contao do
-  desc "Link all contao files"
+  desc 'Link all contao files'
   task :bootstrap do
     TechnoGate::Contao::Application.linkify
 
@@ -35,22 +35,22 @@ namespace :contao do
     Rake::Task['assets:precompile'].invoke if Rails.env.production?
     Rake::Task['contao:fix_permissions'].invoke
 
-    TechnoGate::Contao::Notifier.notify("The contao folder has been bootstraped, Good Luck.", title: "Contao Bootstrap")
+    TechnoGate::Contao::Notifier.notify 'The contao folder has been bootstraped, Good Luck.'
   end
 
   desc 'Apply Patches'
   task :apply_patches do
     path = File.expand_path "../../../contao_patches/#{Rails.env}", __FILE__
     Dir["#{path}/**/*.patch"].each do |patch|
-      TechnoGate::Contao::Notifier.notify("Applying patch #{File.basename patch}", title: "Contao Bootstrap")
+      TechnoGate::Contao::Notifier.notify("Applying patch #{File.basename patch}")
       result = system <<-CMD
         cd #{public_path}
         patch -Nfp1 -i #{patch} --no-backup-if-mismatch
       CMD
 
       if !result
-        TechnoGate::Contao::Notifier.notify("Patch #{File.basename patch} failed to apply", title: "Contao Bootstrap")
-        abort "Please fix patches before bootstrapping"
+        TechnoGate::Contao::Notifier.notify("Patch #{File.basename patch} failed to apply")
+        abort 'Please fix patches before bootstrapping'
       end
     end
   end
@@ -82,47 +82,43 @@ namespace :contao do
 
     FileUtils.chmod 0666, public_path.join('sitemap.xml')
 
-    TechnoGate::Contao::Notifier.notify("The contao folder's permissions has been fixed.", title: "Contao Bootstrap")
+    TechnoGate::Contao::Notifier.notify 'The permissions of the contao folder has been fixed'
+  end
+
+  desc 'Generate an initializer'
+  task :generate_initializer do
+    require 'contao/generators/contao_initializer'
+
+    TechnoGate::Contao::Generators::ContaoInitializer.new(path: Rails.root).generate
+
+    TechnoGate::Contao::Notifier.notify 'The contao initializer has been generated'
   end
 
   desc "Generate the localconfig.php"
-  task :generate_localconfig do
+  task :generate_localconfig => :environment do
     require 'active_support/core_ext/object/blank'
-    config = TechnoGate::Contao::Application.config.contao_global_config
-
-    if !config || config.install_password.blank? || config.encryption_key.blank?
-      message = <<-EOS
-        You did not set the install password, and the encryption key in your
-        #{ENV['HOME']}/.contao/config.yml, I cannot generate a localconfig
-        since the required configuration keys are missing.
-      EOS
-      message.gsub!(/ [ ]+/, ' ').gsub!(/\n/, '').gsub!(/^ /, '')
-      TechnoGate::Contao::Notifier.warn(message, title: "Contao Bootstrap")
-    else
-      config = config.clone
-      config.application_name = TechnoGate::Contao::Application.name
-
-      config.db_server_app = 'mysql'
-      config.db_hostname   = config.mysql.host
-      config.db_port       = config.mysql.port
-      config.db_username   = config.mysql.user
-      config.db_password   = config.mysql.pass
-      config.db_database   = TechnoGate::Contao::Application.name
-
-      localconfig_template = Rails.root.join 'config/examples/localconfig.php.erb'
-      localconfig_path = public_path.join 'system/config/localconfig.php'
-
-      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
+    config = Rails.application.config.contao.dup
+
+    config.db_server_app = 'mysql'
+    config.db_hostname   = config.global.mysql.host
+    config.db_port       = config.global.mysql.port
+    config.db_username   = config.global.mysql.user
+    config.db_password   = config.global.mysql.pass
+    config.db_database   = config.application_name
+
+    localconfig_template = Rails.root.join 'config/examples/localconfig.php.erb'
+    localconfig_path = public_path.join 'system/config/localconfig.php'
+
+    localconfig = ERB.new(File.read(localconfig_template), nil, '-').result(binding)
+    File.open(localconfig_path, 'w') {|f| f.write localconfig }
+
+    TechnoGate::Contao::Notifier.notify 'The configuration file localconfig.php was generated successfully.'
   end
 
   desc "Generate the htaccess file"
   task :generate_htaccess do
     FileUtils.cp public_path.join('.htaccess.default'), public_path.join('.htaccess')
 
-    TechnoGate::Contao::Notifier.notify("The .htaccess was successfully generated.", title: "Contao Bootstrap")
+    TechnoGate::Contao::Notifier.notify 'The .htaccess was successfully generated'
   end
 end

data/spec/lib/contao/application_spec.rb

@@ -3,29 +3,29 @@ require 'spec_helper'
 module TechnoGate
   module Contao
     describe Application, :fakefs do
-      subject { Contao::Application.instance }
+      subject { Contao::Application }
       let(:klass) { Contao::Application }
 
       before :each do
         stub_filesystem!(:global_config => {'install_password' => 'some install password'})
-        subject.send :parse_global_config
+        subject.load_global_config!
       end
 
       describe "Global Config" do
 
         it "should parse the global config file if the file exists" do
-          subject.config.contao_global_config.should_not be_empty
+          subject.config.contao.global.should_not be_empty
         end
 
         it "should correctly parse the global config" do
-          subject.config.contao_global_config.install_password.should == 'some install password'
+          subject.config.contao.global.install_password.should == 'some install password'
         end
       end
 
       describe '#linkify' do
         it "should call #exhaustive_list_of_files_to_link" do
           subject.should_receive(:exhaustive_list_of_files_to_link).with(
-            Rails.root.join(Rails.application.config.contao_path),
+            Rails.root.join(Rails.application.config.contao.path),
             Rails.public_path
           ).once.and_return []
 
@@ -62,7 +62,7 @@ module TechnoGate
         describe "without it being set in the configuration" do
           before :each do
             Rails.config.tap do |config|
-              config.application_name = nil
+              config.contao.application_name = nil
             end
           end
 
@@ -78,7 +78,7 @@ module TechnoGate
         describe "with it being set in the configuration" do
           before :each do
             Rails.config.tap do |config|
-              config.application_name = 'my_super_awesome_project'
+              config.contao.application_name = 'my_super_awesome_project'
             end
           end
 

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

@@ -6,8 +6,9 @@ module TechnoGate
     module Generators
       describe Application do
         let(:klass) { Application }
+
         subject {
-          Application.new path: @path
+          klass.new path: @path
         }
 
         before :each do
@@ -64,7 +65,7 @@ module TechnoGate
             subject.send :rename_project
 
             File.read('/root/my_awesome_project/config/application.rb').should =~
-              /config\.application_name\s+=\s+'my_awesome_project'/
+              /config\.contao\.application_name\s+=\s+'my_awesome_project'/
           end
         end
 

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

@@ -40,7 +40,7 @@ module TechnoGate
             subject.generate
 
             File.read("#{ENV['HOME']}/.contao/config.yml").should ==
-              YAML.dump(Contao::Application.default_global_config)
+              YAML.dump(subject.send :default_global_config)
           end
 
           it "should call the Notifier" do

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

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'contao/generators/contao_initializer.rb'
+
+module TechnoGate
+  module Contao
+    module Generators
+      describe ContaoInitializer, :fakefs => true do
+        let(:klass) { ContaoInitializer }
+
+        subject {
+          klass.new path: @path
+        }
+
+        before :each do
+          @path = '/root/my_awesome_project'
+
+          stub_filesystem! :global_config => {
+            'admin_email' => 'test@example.com',
+            'time_zone'   => 'Europe/Paris',
+            'smtp' => {
+              'enabled' => true,
+              'host'    => 'localhost',
+              'user'    => 'myuser',
+              'pass'    => 'mypass',
+              'ssl'     => true,
+              'port'    => 465,
+            },
+          }
+
+          Contao::Application.send :load_global_config!
+        end
+
+        it_should_behave_like "Generator"
+
+        describe '#generate' do
+          before :each do
+            FakeFS.deactivate!
+            template = File.read ContaoInitializer::TEMPLATE
+            FakeFS.activate!
+            FileUtils.mkdir_p File.dirname(ContaoInitializer::TEMPLATE)
+            File.open ContaoInitializer::TEMPLATE, 'w' do |f|
+              f.write template
+            end
+          end
+
+          it 'should generate an initializer file' do
+            subject.generate
+            File.exists?('/root/my_awesome_project/config/initializers/contao.rb').should be_true
+          end
+        end
+
+        describe '#build_config' do
+          it 'should build a config variable for the template' do
+            Password.any_instance.stub(:to_s).and_return 'encrypted_password'
+            SecureRandom.stub(:hex).and_return 'e626cd6b8fd219b3e1803dc59620d972'
+
+            config = subject.send :build_config
+            config.install_password.should     == 'encrypted_password'
+            config.encryption_key.should       == 'e626cd6b8fd219b3e1803dc59620d972'
+            config.admin_email.should          == 'test@example.com'
+            config.time_zone.should            == 'Europe/Paris'
+            config.smtp_host.should            == 'localhost'
+            config.smtp_user.should            == 'myuser'
+            config.smtp_pass.should            == 'mypass'
+            config.smtp_port.should            == 465
+            config.smtp_enabled.should         be_true
+            config.smtp_ssl.should             be_true
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/contao/password_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+module TechnoGate
+  module Contao
+    describe Password do
+      let(:clear_password) { 'password' }
+      let(:password)       { '52c938dedcdc146d0a3f5fef834e9881be343d6c' }
+      let(:salt)           { '537a4e714483674274a2b07' }
+      let(:password_hash)  { "#{password}:#{salt}" }
+
+      describe 'class methods' do
+        subject { Password }
+
+        describe '#create' do
+
+          it { should respond_to :create }
+
+          it 'should return an instance of Password' do
+            subject.create(clear_password).should be_instance_of Password
+          end
+
+          it 'should return an instance with @password_hash and @salt set' do
+            p = subject.create clear_password
+            p.instance_variable_get(:@password_hash).should_not be_nil
+            p.instance_variable_get(:@salt).should_not be_nil
+          end
+
+          it 'should split the password_hash into instance variables' do
+            Password.should_receive(:generate_salt).and_return salt
+
+            p = subject.create clear_password
+            p.instance_variable_get(:@password_hash).should == password
+            p.instance_variable_get(:@salt).should == salt
+          end
+        end
+
+        describe '#generate_salt' do
+          it { should respond_to :generate_salt }
+
+          it 'should return a salt' do
+            subject.send(:generate_salt).should_not be_nil
+          end
+
+          it 'should be of the size of SALT_SIZE' do
+            subject.send(:generate_salt).size.should == Password::SALT_SIZE
+          end
+        end
+
+        describe '#random' do
+          it {should respond_to :random}
+
+          it 'should return a random string' do
+            subject.send(:random).should_not be_nil
+          end
+
+          it 'should honor the requested length' do
+            subject.send(:random, 14).size.should == 28
+          end
+
+          it 'should be 128 chars by default' do
+            subject.send(:random).size.should == 128
+          end
+
+          it 'should be a string' do
+            subject.send(:random).should be_instance_of String
+          end
+        end
+      end
+
+      describe 'initialization' do
+        subject { Password.new password_hash }
+
+        it 'should split the password_hash into instance variables' do
+          subject.instance_variable_get(:@password_hash).should == password
+          subject.instance_variable_get(:@salt).should == salt
+        end
+      end
+
+      describe 'instance methods' do
+        subject { Password.new password_hash }
+
+        describe 'to_s' do
+          it 'should return the password_hash' do
+            subject.to_s.should == password_hash
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -21,15 +21,15 @@ RSpec.configure do |c|
   c.include FakeFS::SpecHelpers, :fakefs
 
   c.before :each do
-    Rails.env = 'development'
-    Rails.root = @root = '/root/my_awesome_project'
+    Rails.env  = 'development'
+    Rails.root = '/root/my_awesome_project'
 
-    Rails.config.tap do |config|
-      config.contao_path = 'contao'
+    Rails.application.config.tap do |config|
+      config.contao.path = 'contao'
     end
 
     silence_warnings do
-      TechnoGate::Contao::UI = stub('Guard UI').as_null_object
+      TechnoGate::Contao::UI = stub('UI').as_null_object
     end
   end
 end

data/spec/support/filesystem_mock.rb

@@ -2,6 +2,7 @@ def stub_filesystem!(options = {})
   [
 
     '/root/my_awesome_project/config',
+    '/root/my_awesome_project/config/initializers',
     '/root/my_awesome_project/app/assets/javascripts',
     '/root/my_awesome_project/app/assets/stylesheets',
     '/root/my_awesome_project/app/assets/images',
@@ -24,12 +25,11 @@ def stub_filesystem!(options = {})
 end
 
 def stub_global_config_file!(config = {})
-  config = TechnoGate::Contao::Application.default_global_config(
-    'install_password' => 'f0fb33dcebe5753f053b882bb49faefe7384f22e:7305d1f250f3481bac35f2839a2a4fd6',
-    'encryption_key'   => 'e626cd6b8fd219b3e1803dc59620d972'
+  condig = TechnoGate::Contao::Application.send(:default_global_config,
+    'install_password' => 'password'
   ).merge(config)
 
-  config_file = TechnoGate::Contao::Application.instance.global_config_path
+  config_file = "#{ENV['HOME']}/.contao/config.yml"
 
   FileUtils.mkdir_p File.dirname(config_file)
   File.open(config_file, 'w') do |file|
@@ -59,7 +59,7 @@ module ContaoTemplate
     # -- all .rb files in that directory are automatically loaded.
 
     # The application name
-    config.application_name = '#{application_name}'
+    config.contao.application_name = '#{application_name}'
 
     # Custom directories with classes and modules you want to be autoloadable.
     # config.autoload_paths += %W(\#{config.root}/extras)
@@ -80,7 +80,7 @@ module ContaoTemplate
     config.assets.version = '1.0'
 
     # Contao configurations
-    config.contao_path = 'contao'
+    config.contao.path = 'contao'
   end
 end
     EOS

data/spec/support/pry.rb

@@ -0,0 +1,18 @@
+require 'pry'
+
+begin
+  require 'binding_of_caller'
+rescue LoadError
+end
+
+def pry_it
+  FakeFS.deactivate! if example.metadata[:fakefs]
+
+  if binding.respond_to? :of_caller
+    binding.of_caller(1).pry
+  else
+    binding.pry
+  end
+
+  FakeFS.activate!   if example.metadata[:fakefs]
+end