forkcms_3_deploy 1.1.0

data/README.md

@@ -0,0 +1,50 @@
+# ForkCMS Deploy gem
+This is a gem that enables you to deploy a ForkCMS 3.x.x install to your server. It was built specific for Fork CMS so your Capfile will be neat and tidy.
+
+## Installation
+The recipe is available in the forkcms_deploy gem, which can be installed via [RubyGems.org](http://rubygems.org)
+	gem install forkcms_3_deploy
+
+## Available recipes
+* forkcms_3_deploy				- ForkCMS specific tasks.
+* forkcms_3_deploy/defaults		- Best practices for each deployment.
+
+## Example recipe
+This recipe will deploy the ForkCMS-instance to your-app.com. 
+
+	load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+
+	# set your application name here
+	set :application, "your-app.com"								# eg.: sumocoders.be
+
+	# set user to use on server
+	set :user, "your-user"											# eg.: sumocoders
+
+	# deploy to path (on server)
+	set :deploy_to, "/home/#{user}/apps/#{application}"				# eg.: /home/sumocoders/apps/sumocoders.be
+
+	# set document_root
+	set :document_root, "/home/#{user}/www.your-app.com"			# eg.: /home/sumocoders/default_www
+	
+	# define roles
+	server "your-app.com", :app, :web, :db, :primary => true		# eg.: crsolutions.be
+
+	# git repo & branch
+	set :repository, "git@your-git.com:your-app.git"				# eg.: git@crsolutions.be:sumocoders.be.git
+	set :branch, "master"
+
+	# set version control type and copy strategy
+	set :scm, :git
+	set :copy_strategy, :checkout
+
+	begin
+		require 'forkcms_3_deploy'
+		require 'forkcms_3_deploy/defaults'							# optional, contains best practices
+	rescue LoadError
+		$stderr.puts <<-INSTALL
+	You need the forkcms_3_deploy gem (which simplifies this Capfile) to deploy this application
+	Install the gem like this:
+		gem install forkcms_deploy
+					INSTALL
+		exit 1
+	end

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gemspec|
+		gemspec.name = "forkcms_3_deploy"
+		gemspec.summary = "Deployment for Fork 3.x.x with Capistrano"
+		gemspec.description = "Deployment for Fork 3.x.x with Capistrano"
+		gemspec.email = "info@sumocoders.be"
+		gemspec.homepage = "https://github.com/sumocoders/forkcms_3_deploy"
+		gemspec.authors = ['Tijs Verkoyen', 'Sam Tubbax']
+		gemspec.add_dependency 'capistrano', '>=2.0.0'
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/forkcms_3_deploy.gemspec

@@ -0,0 +1,45 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "forkcms_3_deploy"
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tijs Verkoyen", "Sam Tubbax"]
+  s.date = "2011-11-12"
+  s.description = "Deployment for Fork 3.x.x with Capistrano"
+  s.email = "info@sumocoders.be"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "forkcms_3_deploy.gemspec",
+    "lib/forkcms_3_deploy.rb",
+    "lib/forkcms_3_deploy/defaults.rb",
+    "lib/forkcms_3_deploy/forkcms.rb",
+    "lib/forkcms_3_deploy/overwrites.rb"
+  ]
+  s.homepage = "https://github.com/sumocoders/forkcms_3_deploy"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Deployment for Fork 3.x.x with Capistrano"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.0.0"])
+  end
+end
+

data/lib/forkcms_3_deploy.rb

@@ -0,0 +1,2 @@
+require 'forkcms_3_deploy/forkcms'
+require 'forkcms_3_deploy/overwrites'

data/lib/forkcms_3_deploy/defaults.rb

@@ -0,0 +1,26 @@
+configuration = Capistrano::Configuration.respond_to?(:instance) ? Capistrano::Configuration.instance(:must_exist) : Capistrano.configuration(:must_exist)
+
+configuration.load do
+	# don't use sudo, on most shared setups we won't have sudo-access
+	set :use_sudo, false
+
+	# we're on a share setup so group_writable isn't allowed
+	set :group_writable, false
+
+	# 3 releases should be enough.
+	set :keep_releases, 3
+
+	# remote caching will keep a local git repo on the server you're deploying to and simply run a fetch from that 
+	# rather than an entire clone. This is probably the best option and will only fetch the differences each deploy
+	set :deploy_via, :remote_cache
+
+	# set the value for pseudo terminals in Capistrano
+	default_run_options[:pty] = true
+
+	# your computer must be running ssh-agent for the git checkout to work from the server to the git server
+	set :ssh_options, { :forward_agent => true }
+	
+  # set version control type and copy strategy
+  set :scm, :git
+  set :copy_strategy, :checkout
+end

data/lib/forkcms_3_deploy/forkcms.rb

@@ -0,0 +1,104 @@
+configuration = Capistrano::Configuration.respond_to?(:instance) ? Capistrano::Configuration.instance(:must_exist) : Capistrano.configuration(:must_exist)
+
+configuration.load do
+	# define some extra folder to create
+	set :shared_children, %w(files config/frontend config/backend config/library)
+
+	# custom events configuration
+	after 'deploy:setup' do
+		forkcms.link_document_root
+	end
+
+	after 'deploy:update_code' do
+		forkcms.link_configs
+		forkcms.link_files
+	end
+
+	# Fork CMS specific tasks
+	namespace :forkcms do
+		desc 'Clear the frontend and backend cache-folders'
+		task :clear_cached do
+			# remove frontend cached data
+			run %{
+				rm -rf #{current_path}/frontend/cache/cached_templates/* &&
+				rm -rf #{current_path}/frontend/cache/locale/* &&
+				rm -rf #{current_path}/frontend/cache/minified_css/* &&
+				rm -rf #{current_path}/frontend/cache/minified_js/* &&
+				rm -rf #{current_path}/frontend/cache/navigation/* &&
+				rm -rf #{current_path}/frontend/cache/statistics/* &&
+				rm -rf #{current_path}/frontend/cache/templates/*
+			}
+
+			# remove backend cached data
+			run %{
+				rm -rf #{current_path}/backend/cache/analytics/* &&
+				rm -rf #{current_path}/backend/cache/cronjobs/* &&
+				rm -rf #{current_path}/backend/cache/locale/* &&
+				rm -rf #{current_path}/backend/cache/mailmotor/* &&
+				rm -rf #{current_path}/backend/cache/templates/*
+			}
+		end
+
+		desc 'Link the config files'
+		task :link_configs do
+			# create config files
+			path_library = <<-CONFIG
+<?php
+	// custom constant used by the init classes
+	define('INIT_PATH_LIBRARY', '#{current_path}/library');
+?>
+			CONFIG
+
+			# upload the files
+			put path_library, "#{shared_path}/config/frontend/config.php"
+			put path_library, "#{shared_path}/config/backend/config.php"
+
+			# change the path to current_path
+			run "if [ -f #{shared_path}/config/library/globals.php ]; then sed -i 's/#{version_dir}\\/[0-9]*/#{current_dir}/' #{shared_path}/config/library/globals.php; fi"
+
+			# create dirs
+			run %{
+				mkdir -p #{release_path}/frontend/cache/config &&
+				mkdir -p #{release_path}/backend/cache/config
+			}
+
+			# symlink the globals
+			run %{		  
+				ln -sf #{shared_path}/config/library/globals_backend.php #{release_path}/library/globals_backend.php &&
+				ln -sf #{shared_path}/config/library/globals_frontend.php #{release_path}/library/globals_frontend.php &&
+				ln -sf #{shared_path}/config/library/globals.php #{release_path}/library/globals.php &&
+				ln -sf #{shared_path}/config/frontend/config.php #{release_path}/frontend/cache/config/config.php &&
+				ln -sf #{shared_path}/config/backend/config.php #{release_path}/backend/cache/config/config.php
+			}
+		end
+
+		desc 'link the document root to the current/default_www-folder'
+		task :link_document_root do
+			# create symlink for document_root if it doesn't exists
+			documentRootExists = capture("if [ ! -e #{document_root} ]; then ln -sf #{current_path} #{document_root}; echo 'no'; fi").chomp
+
+			unless documentRootExists == 'no'
+				warn "Warning: Document root (#{document_root}) already exists"
+				warn 'to link it to the Fork deploy issue the following command:'
+				warn '	ln -sf #{current_path} #{document_root}'
+			end 
+		end	
+
+		desc 'Create needed symlinks'
+		task :link_files do
+			# get the list of folders in /frontend/files
+			folders = capture("ls -1 #{release_path}/frontend/files").split(/\r?\n/)
+
+			# loop the folders
+			folders.each do |folder|
+				# copy them to the shared path, remove them from the release and symlink them
+				run %{
+				  mkdir -p #{shared_path}/files/#{folder} &&
+					cp -r #{release_path}/frontend/files/#{folder} #{shared_path}/files/ &&
+					rm -rf #{release_path}/frontend/files/#{folder} &&
+					ln -s #{shared_path}/files/#{folder} #{release_path}/frontend/files/#{folder}
+				}
+			end
+		end	
+	end
+end

data/lib/forkcms_3_deploy/overwrites.rb

@@ -0,0 +1,31 @@
+configuration = Capistrano::Configuration.respond_to?(:instance) ? Capistrano::Configuration.instance(:must_exist) : Capistrano.configuration(:must_exist)
+
+configuration.load do
+	# Deployment process
+	namespace :deploy do
+		desc 'Prepares the servers for deployment.'
+		task :setup, :except => { :no_release => true } do
+			# this method is overwritten because Fork CMS isn't a Rails-application
+
+			# define folders to create
+			dirs = [deploy_to, releases_path, shared_path]
+			
+			# add folder that aren't standard
+			dirs += shared_children.map { |d| File.join(shared_path, d) }
+
+			# create the dirs
+			run %{
+				#{try_sudo} mkdir -p #{dirs.join(' ')} && 
+				#{try_sudo} chmod g+w #{dirs.join(' ')}
+			}
+		end
+
+		task :finalize_update, :except => { :no_release => true } do
+			# Fork CMS isn't a Rails-application so don't do Rails specific stuff
+			run 'chmod -R g+w #{latest_release}' if fetch(:group_writable, true)
+		end
+
+		# overrule restart	
+		task :restart do; end
+	end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: forkcms_3_deploy
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Tijs Verkoyen
+- Sam Tubbax
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Deployment for Fork 3.x.x with Capistrano
+email: info@sumocoders.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- forkcms_3_deploy.gemspec
+- lib/forkcms_3_deploy.rb
+- lib/forkcms_3_deploy/defaults.rb
+- lib/forkcms_3_deploy/forkcms.rb
+- lib/forkcms_3_deploy/overwrites.rb
+homepage: https://github.com/sumocoders/forkcms_3_deploy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Deployment for Fork 3.x.x with Capistrano
+test_files: []
+