capistrano-chocopoche 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 104eae3fd531c8505cdc096f0f8f393db8b4baa2
+  data.tar.gz: 57835b9a5b8d2afe3f83c02014a1e18231b76375
+!binary "U0hBNTEy":
+  metadata.gz: f4d70fef6d3fe0b19b478c5c20a8f32cb74b4888076fd33a40c47542d5dc307a6d3a99e5a2cde30a652b770dce19f9e068a723d672a018bb799300d26b09dcea
+  data.tar.gz: 010cadc4fda76d0716b665b98912588d8a1fddcf88c0555b701884e612103f334ca4d682965a9a8870270d4df563c38a24da11ed27d08c359acd053b76139336

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Corentin Merot
+
+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,81 @@
+# Capistrano chopoche's recipes
+
+My capistrano poche contains:
+
+- another railsless-deploy recipe
+- a files utility to rsync directories
+
+## Installation
+
+    $ gem install capistrano-chocopoche
+
+## Example of a Capfile
+
+```ruby
+# Capistrao defaults
+load 'deploy'
+
+# Multistage - to be loaded before the railsless-deploy
+require 'capistrano/ext/multistage'
+
+# Rails inhibition
+require 'capistrano-chocopoche/railsless-deploy'
+
+# Rsync tasks
+require 'capistrano-chocopoche/files'
+
+# Base configuration
+set :application,   "my-project"
+set :repository,    "git@localhost:#{application}.git"
+set :use_sudo,      false
+ssh_options[:forward_agent] = true
+
+# Rsync + symlinks configuration
+set :files_directories,         [ 'public/upload' ]
+set :files_symlinks,            [ 'public/upload' ]
+
+# Server config, won't be here in case of multistage
+server 'localhost', :app, :web, :db, :primary => true
+
+# # default settings
+# set :files_tmp_dir,           'tmp/capistrano-chocopoche/files'
+```
+
+## Railsless-deploy
+
+This script requires the default capistrano tasks to be loaded, then it will:
+
+- delete rails tasks: `migrate`, `migrations`, `cold`
+- empty rails tasks (but keep it for hooks): `finalize_update`
+- delete rails vars: `rails_env`
+- empty rails vars: `shared_children`
+- override the `deploy_to` var to:
+
+    - `/home/#{user}/apps/#{application}.#{stage}`
+    - or `/home/#{user}/apps/#{application}` if the multistage ext is not
+      loaded.
+
+  Therefore the multistage ext must be required before the railsless-deploy.
+
+- override symlinks related tasks to use relative paths: create_symlink,
+  rollback:revision
+
+The last one implements the atomic symlink as suggested in the
+[issue #346](https://github.com/capistrano/capistrano/issues/346).
+
+## Files
+
+The **files:download** task will rsync files from the first web server in
+`shared/your/directory` to a local temporary directory `tmp/capistrano-chocopoche/files/your/directory`.
+
+The **files:upload** task will do the opposite of the **files:download** task.
+
+The **files:create_symlinks** creates symlinks from the shared to the current.
+The equivalent for the Capfile example:
+
+    $ mkdir -p #{current_path}/public
+    $ ln -fs #{shared_path}/public/upload #{current_path}/public
+
+## License
+
+MIT, see the license file.

data/capistrano-chocopoche.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-chocopoche"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Corentin Merot"]
+  spec.email         = ["cmerot@themarqueeblink.com"]
+  spec.description   = %q{Capistrano recipes, with another railsless-deploy and a files utility.}
+  spec.summary       = %q{Chocopoche's Capistrano recipes}
+  spec.homepage      = "https://github.com/chocopoche/capistrano-chocopoche"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+end
+

data/lib/capistrano-chocopoche/common.rb

@@ -0,0 +1,16 @@
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+
+configuration.load do
+
+  _cset :user, Etc.getlogin
+
+  # Used to create relative symlinks in deploy.create_symlink
+  def relative_path(from_str, to_str)
+    require 'pathname'
+    Pathname.new(to_str).relative_path_from(Pathname.new(from_str)).to_s
+  end
+
+end

data/lib/capistrano-chocopoche/files.rb

@@ -0,0 +1,83 @@
+# Capistrano recipe to rsync files up and down.
+#
+# author: Corentin Merot
+# real author: Michael Kessler aka netzpirat, see https://gist.github.com/111597
+
+require 'fileutils'
+require 'capistrano-chocopoche/common'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+  _cset :user,              Etc.getlogin
+  _cset :files_directories, []
+  _cset :files_tmp_dir,     'tmp/capistrano-chocopoche/files'
+
+  namespace :files do
+
+    desc <<-DESC
+      Sync files from the first web server to the local temp directory. \
+      Files on the remote server must be somewhere in the shared directory.
+    DESC
+    task :download, :roles => :web, :only => { :primary => true }, :once => true do
+
+      host, port = host_and_port
+
+      Array(fetch(:files_directories, [])).each do |file_dir|
+        unless File.directory? "#{files_tmp_dir}/#{file_dir}"
+          logger.info "create temporary '#{files_tmp_dir}/#{file_dir}' folder"
+          FileUtils.mkdir_p "#{files_tmp_dir}/#{file_dir}"
+        end
+
+        source = "#{shared_path}/#{file_dir}"
+        dest   = File.dirname("#{files_tmp_dir}/#{file_dir}")
+
+        # Sync directory down
+        system "rsync --verbose --archive --compress --copy-links --delete --stats --rsh='ssh -p #{port}' #{user}@#{host}:#{source} #{dest}"
+        logger.info "sync files from  #{host}:#{source} to #{dest} finished"
+      end
+
+    end
+
+    desc <<-DESC
+      Sync files from the local temp directory to the first web server. \
+      Files on the remote server will be copied in the shared directory.
+    DESC
+    task :upload, :roles => :web, :only => { :primary => true }, :once => true do
+
+      host, port = host_and_port
+      Array(fetch(:files_directories, [])).each do |file_dir|
+        source = "#{files_tmp_dir}/#{file_dir}"
+        dest   = File.dirname("#{shared_path}/#{file_dir}")
+
+        # Sync directory up
+        system "rsync --verbose --archive --compress --keep-dirlinks --delete --stats --rsh='ssh -p #{port}' #{source} #{user}@#{host}:#{dest}"
+        logger.info "sync files from #{source} to #{host}:#{dest} finished"
+      end
+    end
+
+    desc <<-DESC
+      Creates :files_symlinks from the shared folder to the current one on the \
+      web servers
+    DESC
+    task :create_symlinks, :roles => [:web] do
+      symlinks = fetch(:files_symlinks)
+      cmds = symlinks.collect do | l |
+        parent = File.dirname("#{current_path}/#{l}")
+        "mkdir -p #{parent} && ln -fs #{shared_path}/#{l} #{current_path}/#{l}"
+      end
+      run cmds.join(' && ')
+    end
+
+    #
+    # Returns the actual host name to sync and port
+    #
+    def host_and_port
+      return roles[:web].servers.first.host, ssh_options[:port] || roles[:web].servers.first.port || 22
+    end
+
+  end
+end

data/lib/capistrano-chocopoche/railsless-deploy.rb

@@ -0,0 +1,91 @@
+require 'etc'
+require 'capistrano-chocopoche/common'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+
+configuration.load do
+
+  # Remove rails specific tasks
+  deploy.tasks.delete(:migrate)
+  deploy.tasks.delete(:migrations)
+  deploy.tasks.delete(:cold)
+
+  # Remove rails specific vars
+  unset :rails_env
+
+  # Override `deploy to` to a more common path
+  if exists?(:stages)
+    logger.important "YYYYYYYYY"
+    set(:deploy_to) { "/home/#{user}/apps/#{application}.#{stage}" }
+  else
+    logger.important "NOOOOOOOO"
+    set(:deploy_to) { "/home/#{user}/apps/#{application}" }
+  end
+
+  # Remove rails specific shared children
+  # set :shared_children, []
+
+  namespace :deploy do
+
+    desc <<-DESC
+      Updates the symlink to the most recently deployed version. Capistrano works \
+      by putting each new release of your application in its own directory. When \
+      you deploy a new version, this task's job is to update the `current' symlink \
+      to point at the new version. You will rarely need to call this task \
+      directly; instead, use the `deploy' task (which performs a complete \
+      deploy, including `restart') or the 'update' task (which does everything \
+      except `restart').
+    DESC
+    task :create_symlink, :except => { :no_release => true } do
+      on_rollback do
+        if previous_release
+          previous_release_relative = relative_path(deploy_to, previous_release)
+          run "ln -s #{previous_release_relative} #{current_path}.tmp && mv -f #{current_path}.tmp #{current_path}"
+        else
+          logger.important "no previous release to rollback to, rollback of symlink skipped"
+        end
+      end
+      latest_release_relative = relative_path(deploy_to,latest_release)
+      run "ln -s #{latest_release_relative} #{current_path}.tmp && mv -f #{current_path}.tmp #{current_path}"
+    end
+
+    desc <<-DESC
+      [internal] Touches up the released code. This is called by update_code \
+      after the basic deploy finishes. It assumes a Rails project was deployed, \
+      so if you are deploying something else, you may want to override this \
+      task with your own environment's requirements.
+
+      This task will make the release group-writable (if the :group_writable \
+      variable is set to true, which is the default). It will then set up \
+      symlinks to the shared directory for the log, system, and tmp/pids \
+      directories, and will lastly touch all assets in public/images, \
+      public/stylesheets, and public/javascripts so that the times are \
+      consistent (so that asset timestamping works).  This touch process \
+      is only carried out if the :normalize_asset_timestamps variable is \
+      set to true, which is the default The asset directories can be overridden \
+      using the :public_children variable.
+    DESC
+    task :finalize_update, :except => { :no_release => true } do
+    end
+
+  end
+
+  namespace :rollback do
+    desc <<-DESC
+      [internal] Points the current symlink at the previous revision.
+      This is called by the rollback sequence, and should rarely (if
+      ever) need to be called directly.
+    DESC
+    task :revision, :except => { :no_release => true } do
+      if previous_release
+        previous_release_relative = relative_path(deploy_to, previous_release)
+        run "ln -s #{previous_release_relative} #{current_path}.tmp && mv -f #{current_path}.tmp #{current_path}"
+      else
+        abort "could not rollback the code because there is no prior release"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-chocopoche
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Corentin Merot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Capistrano recipes, with another railsless-deploy and a files utility.
+email:
+- cmerot@themarqueeblink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- capistrano-chocopoche.gemspec
+- lib/capistrano-chocopoche/common.rb
+- lib/capistrano-chocopoche/files.rb
+- lib/capistrano-chocopoche/railsless-deploy.rb
+homepage: https://github.com/chocopoche/capistrano-chocopoche
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Chocopoche's Capistrano recipes
+test_files: []
+has_rdoc: