capistrano-contao 0.0.1 → 0.0.2

data/capistrano-contao.gemspec

@@ -1,10 +1,9 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capistrano-contao/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Wael M. Nasreddine"]
-  gem.email         = ["wael.nasreddine@gmail.com"]
-  gem.description   = 'Capistrano receipts for Contao deployment'
+  gem.authors       = ['Wael M. Nasreddine']
+  gem.email         = ['wael.nasreddine@gmail.com']
+  gem.description   = 'Capistrano recipes for Contao deployment'
   gem.summary       = gem.summary
   gem.homepage      = 'http://technogate.github.com/contao'
   gem.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
@@ -12,15 +11,14 @@ Gem::Specification.new do |gem|
   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          = "capistrano-contao"
-  gem.require_paths = ["lib"]
-  gem.version       = TechnoGate::Capistrano::Contao::VERSION
+  gem.name          = 'capistrano-contao'
+  gem.require_paths = ['lib']
+  gem.version       = '0.0.2'
 
   # Runtime dependencies
   gem.add_dependency 'rake'
   gem.add_dependency 'activesupport'
-
-  # Development dependencies
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'fakefs'
+  gem.add_dependency 'capistrano-database'
+  gem.add_dependency 'capistrano-utils'
+  gem.add_dependency 'capistrano-server'
 end

data/lib/capistrano/ext/contao.rb

@@ -0,0 +1,117 @@
+require 'active_support/core_ext/object/blank'
+require 'capistrano/monkey_patches/fix_capture_conflict'
+require 'capistrano/ext/helpers'
+require 'capistrano/ext/git'
+require 'capistrano/ext/custom_colors'
+require 'capistrano/ext/decouple_from_rails'
+require 'capistrano/ext/contao_assets'
+require 'capistrano/ext/database'
+require 'capistrano/ext/server'
+require 'capistrano/ext/deploy'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/contao requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :contao do
+    desc '[internal] Setup contao'
+    task :setup, :roles => :app, :except => { :no_release => true } do
+      # Empty task, the rest should hook to it
+    end
+
+    desc '[internal] Setup contao shared contents'
+    task :setup_shared_folder, :roles => :app, :except => { :no_release => true } do
+      shared_path = fetch :shared_path
+      run <<-CMD
+        #{try_sudo} mkdir -p #{shared_path}/logs &&
+        #{try_sudo} mkdir -p #{shared_path}/config
+      CMD
+
+      # TODO: The deny access should follow denied_access config
+      deny_htaccess = "order deny,allow\n"
+      deny_htaccess << "deny from all"
+
+      put deny_htaccess, "#{shared_path}/logs/.htaccess"
+    end
+
+    desc '[internal] Setup contao localconfig'
+    task :setup_localconfig, :roles => :app, :except => { :no_release => true } do
+      localconfig_php_config_path = "#{fetch :shared_path}/config/public_system_config_localconfig.php"
+      on_rollback { run "rm -f #{localconfig_php_config_path}" }
+      db_credentials = fetch :db_credentials
+
+      localconfig = File.read('config/examples/localconfig.php.erb')
+
+      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!(/^ /, '')
+        logger.important message if logger
+        abort 'Required configurations are not set'
+      else
+        config = config.clone
+        config.application_name = TechnoGate::Contao::Application.name
+        config.db_server_app = fetch :db_server_app
+        config.db_database   = fetch :db_database_name
+
+        [:hostname, :port, :username, :password].each do |item|
+          if db_credentials[item].present?
+            config.send "db_#{item}=", db_credentials[item]
+          end
+        end
+
+        write ERB.new(localconfig).result(binding), localconfig_php_config_path
+      end
+    end
+
+    desc '[internal] Link files from contao to inside public folder'
+    task :link_contao_files, :roles => :app, :except => { :no_release => true } do
+      files = exhaustive_list_of_files_to_link("#{fetch :latest_release}/contao", "#{fetch :latest_release}/public")
+      commands = files.map do |list|
+        "#{try_sudo} ln -nsf #{list[0]} #{list[1]}"
+      end
+
+      begin
+        run commands.join(';')
+      rescue Capistrano::CommandError
+        abort 'Unable to create to link contao files'
+      end
+    end
+
+    desc '[internal] Fix contao symlinks to the shared path'
+    task :fix_links, :roles => :app, :except => { :no_release => true } do
+      latest_release = fetch :latest_release
+      shared_path = fetch :shared_path
+
+      # Remove files
+      run <<-CMD
+        #{try_sudo} rm -rf #{latest_release}/public/system/logs
+      CMD
+
+      # Create symlinks
+      run <<-CMD
+        #{try_sudo} ln -nsf #{shared_path}/logs #{latest_release}/public/system/logs
+      CMD
+    end
+  end
+
+  # Dependencies
+  after 'deploy:setup', 'contao:setup'
+  after 'contao:setup', 'contao:setup_shared_folder'
+  after 'contao:setup', 'contao:setup_localconfig'
+  after 'deploy:finalize_update', 'contao:link_contao_files'
+  after 'contao:link_contao_files', 'contao:fix_links'
+
+  # Assets
+  after 'contao:link_contao_files', 'contao:assets:deploy'
+
+  # Database credentions
+  before 'contao:setup_localconfig', 'db:credentials'
+  before 'contao:setup_db', 'db:credentials'
+end

data/lib/capistrano/ext/contao_assets.rb

@@ -0,0 +1,28 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/contao requires Capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :contao do
+    namespace :assets do
+      desc '[internal] Upload contao assets'
+      task :deploy, :roles => :app, :except => { :no_release => true } do
+        path = File.join 'public', Rails.application.config.assets.prefix
+        upload(path, "#{fetch :latest_release}/#{path}", :via => :scp, :recursive => true)
+      end
+
+      desc '[internal] Generate assets'
+      task :precompile, :roles => :app, :except => { :no_release => true } do
+        run_locally 'bundle exec rake assets:precompile'
+      end
+
+      desc '[internal] Clean assets'
+      task :clean, :roles => :app, :except => { :no_release => true } do
+        run_locally 'bundle exec rake assets:clean'
+      end
+    end
+  end
+
+  before 'contao:assets:deploy', 'contao:assets:precompile'
+  after  'contao:assets:deploy', 'contao:assets:clean'
+end

data/lib/capistrano/ext/custom_colors.rb

@@ -0,0 +1,23 @@
+if Capistrano::Logger.respond_to? :add_color_matcher
+  Capistrano::Logger.add_color_matcher({
+    :match => /adapter:|hostname:|username:|password:/,
+    :color => :red,
+    :level => Capistrano::Logger::TRACE,
+    :prio => -20,
+    :attribute => :blink
+  })
+
+  Capistrano::Logger.add_color_matcher({
+    :match => /WARNING:/,
+    :color => :yellow,
+    :level => Capistrano::Logger::INFO,
+    :prio => -20
+  })
+
+  Capistrano::Logger.add_color_matcher({
+    :match => /ERROR:/,
+    :color => :red,
+    :level => Capistrano::Logger::IMPORTANT,
+    :prio => -20
+  })
+end

data/lib/capistrano/ext/decouple_from_rails.rb

@@ -0,0 +1,15 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/decouple_from_rails requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  # Prevent capistrano from creating log, system and pids folders.
+  set :shared_children, Array.new
+
+  namespace :deploy do
+    desc "Empty task, overriden by #{__FILE__}:#{__LINE__}"
+    task :finalize_update do
+      # Empty task, we do not want to delete the system folder.
+    end
+  end
+end

data/lib/capistrano/ext/deploy.rb

@@ -0,0 +1,74 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort 'capistrano/ext/contao requires capistrano 2'
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :deploy do
+    desc 'Check if the remote is ready, should we run cap deploy:setup?'
+    task :check_if_remote_ready, :roles => :app do
+      unless remote_file_exists?(shared_path)
+        logger.important 'ERROR: The project is not ready for deployment.'
+        logger.important 'please run `cap deploy:setup'
+        abort
+      end
+    end
+
+    desc 'Fix permissions'
+    task :fix_permissions, :roles => :app do
+      if exists?(:app_owner) or exists?(:app_group)
+        run <<-CMD
+          #{try_sudo} chown -R \
+            #{fetch :app_owner, 'www-data'}:#{fetch :app_group, 'www-data'} \
+            #{fetch :deploy_to}/releases \
+            #{fetch :deploy_to}/shared
+        CMD
+      end
+
+      run "chmod -R g+w #{fetch :latest_release}" if fetch(:group_writable, true)
+    end
+
+    desc '[internal] create the required folders.'
+    task :folders, :roles => :app do
+      backup_path = fetch :backup_path, "#{fetch :deploy_to}/backups"
+
+      run <<-CMD
+        #{try_sudo} mkdir -p \
+          #{fetch :deploy_to} \
+          #{backup_path} \
+          #{fetch :shared_path}/{items,__system__,config} \
+          #{fetch :logs_path, ''}
+      CMD
+    end
+
+    desc '[internal] Setup if needed'
+    task :setup_if_needed, :roles => :app do
+      setup unless main_task == 'deploy:setup'
+    end
+
+    desc '[internal] Symlink public folder'
+    task :symlink_public_folders, :roles => :web, :except => { :no_release => true } do
+      deploy_to = fetch :deploy_to
+
+      ['htdocs', 'httpdocs', 'www'].each do |folder|
+        if remote_file_exists?("#{deploy_to}/#{folder}")
+          begin
+            run <<-CMD
+              #{try_sudo} mkdir -p #{deploy_to}/old &&
+              #{try_sudo} mv #{deploy_to}/#{folder} #{deploy_to}/old/#{folder} &&
+              #{try_sudo} ln -nsf #{fetch :public_path} #{deploy_to}/#{folder}
+            CMD
+          rescue Capistrano::CommandError
+            logger.info "WARNING: I could not replace the #{folder}  please do so manually"
+          end
+          logger.info "The #{folder} folder has been moved to the #{deploy_to}/old/#{folder}"
+        end
+      end
+    end
+  end
+
+  # Dependencies
+  before 'deploy',         'deploy:check_if_remote_ready'
+  after  'deploy:restart', 'deploy:fix_permissions'
+  before 'deploy:setup',   'deploy:folders'
+  after  'deploy:setup',   'deploy:symlink_public_folders'
+end

data/lib/capistrano/monkey_patches/fix_capture_conflict.rb

@@ -0,0 +1,7 @@
+# https://github.com/capistrano/capistrano/issues/168#issuecomment-4144687
+# XXX: Remove once https://github.com/capistrano/capistrano/pull/175 has been released
+Capistrano::Configuration::Namespaces::Namespace.class_eval do
+  def capture(*args)
+    parent.capture *args
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-contao
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: capistrano-database
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -60,14 +60,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakefs
+  name: capistrano-utils
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-server
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -75,7 +91,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Capistrano receipts for Contao deployment
+description: Capistrano recipes for Contao deployment
 email:
 - wael.nasreddine@gmail.com
 executables: []
@@ -88,8 +104,12 @@ files:
 - README.md
 - Rakefile
 - capistrano-contao.gemspec
-- lib/capistrano-contao.rb
-- lib/capistrano-contao/version.rb
+- lib/capistrano/ext/contao.rb
+- lib/capistrano/ext/contao_assets.rb
+- lib/capistrano/ext/custom_colors.rb
+- lib/capistrano/ext/decouple_from_rails.rb
+- lib/capistrano/ext/deploy.rb
+- lib/capistrano/monkey_patches/fix_capture_conflict.rb
 homepage: http://technogate.github.com/contao
 licenses: []
 post_install_message: 
@@ -110,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3501654877264623199
+      hash: 3411963624336550606
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/lib/capistrano-contao/version.rb

@@ -1,7 +0,0 @@
-module TechnoGate
-  module Capistrano
-    module Contao
-      VERSION = "0.0.1"
-    end
-  end
-end

data/lib/capistrano-contao.rb

@@ -1,9 +0,0 @@
-require "capistrano-contao/version"
-
-module TechnoGate
-  module Capistrano
-    module Contao
-      # Your code goes here...
-    end
-  end
-end