Roman2K-capistrano-fixes 0.1.2

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2008-2009 Roman Le Négrate
+
+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.mdown

@@ -0,0 +1,31 @@
+# Capistrano fixes
+
+Originally written for making Capistrano behave in a consistent way with `Capfile`'s generated for websites hosted on [Flucti][] VPS's. I figured it might be useful to other people, especially those deploying from Windows machines.
+
+To figure out what sort of improvement this library brings, please read the [source code](http://github.com/Roman2K/capistrano-fixes/tree/master/lib).
+
+## Installation
+
+    $ gem install Roman2K-capistrano-fixes -s http://gems.github.com/
+
+Or:
+
+    $ gem install capistrano-fixes -s http://gems.flucti.com/
+
+## Usage
+
+At the top of the `Capfile` (or `config/deploy.rb`), add:
+
+    require 'capistrano_fixes'
+    Capistrano::Fixes.apply! self
+
+If the assets (images, JavaScript files, stylesheets, etc...) are located at the document root instead of underneath a `public/` folder, add the following call, anywhere inside the `Capfile`:
+
+    root_contains_assets!
+
+## Credits
+
+Written by [Roman Le Négrate](http://roman.flucti.com) ([contact](mailto:roman.lenegrate@gmail.com)). Released under the MIT license: see the `LICENSE` file.
+
+
+[Flucti]: http://www.flucti.com

data/Rakefile

@@ -0,0 +1,11 @@
+require 'echoe'
+
+Echoe.new('capistrano-fixes', '0.1.2') do |p|
+  p.description     = "Fixes for Capistrano default recipes"
+  p.author          = "Roman Le Négrate"
+  p.email           = "roman.lenegrate@gmail.com"
+  p.ignore_pattern  = "*.gemspec"
+  p.dependencies    = ["capistrano ~>2.5", "archive-tar-minitar ~>0.5"]
+  p.development_dependencies = ["mocha"]
+  p.rdoc_options    = %w(--main README.mdown --inline-source --line-numbers --charset UTF-8)
+end

data/capistrano-fixes.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano-fixes}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Le N\303\251grate"]
+  s.date = %q{2009-03-25}
+  s.description = %q{Fixes for Capistrano default recipes}
+  s.email = %q{roman.lenegrate@gmail.com}
+  s.extra_rdoc_files = ["lib/capistrano_fixes/tasks.rb", "lib/capistrano_fixes.rb", "LICENSE", "README.mdown"]
+  s.files = ["lib/capistrano_fixes/tasks.rb", "lib/capistrano_fixes.rb", "LICENSE", "Manifest", "Rakefile", "README.mdown", "test/capistrano_fixes_test.rb", "capistrano-fixes.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.rdoc_options = ["--main", "README.mdown", "--inline-source", "--line-numbers", "--charset", "UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{capistrano-fixes}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Fixes for Capistrano default recipes}
+  s.test_files = ["test/capistrano_fixes_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, ["~> 2.5"])
+      s.add_runtime_dependency(%q<archive-tar-minitar>, ["~> 0.5"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<capistrano>, ["~> 2.5"])
+      s.add_dependency(%q<archive-tar-minitar>, ["~> 0.5"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, ["~> 2.5"])
+    s.add_dependency(%q<archive-tar-minitar>, ["~> 0.5"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/lib/capistrano_fixes/tasks.rb

@@ -0,0 +1,44 @@
+namespace(:deploy) do
+  desc "Symlink shared files and directories."
+  task(:symlink_files) do
+    [:shared_dirs, :shared_files].map { |var| fetch(var, []) }.flatten.each do |path|
+      source      = "#{latest_release}/#{path}"
+      destination = "#{shared_path}/#{path}"
+      
+      d = destination
+      dp = File.dirname(destination)
+      p = previous_release
+      r = path
+      s = source
+      
+      run <<-CMD
+        [ -e #{d} ] || { mkdir -p #{dp} && { if [[ "#{p}" ]] && [ -e #{p}/#{r} ]; then cp -r #{p}/#{r} #{d}; elif [ -e #{s} ]; then cp -r #{s} #{d}; fi } };
+        rm -rf #{source} && ln -nfs #{destination} #{source}
+      CMD
+    end
+  end
+  after('deploy:finalize_update') { symlink_files }
+  
+  task :delete_mac_os_metadata_files do
+    run "cd #{latest_release} && find . | egrep '(^|/)\\._' | xargs rm 2>/dev/null; true"
+  end
+  after('deploy:finalize_update') { delete_mac_os_metadata_files }
+  
+  desc "Download files from the current revision."
+  task :download do
+    (ENV["FILES"] || "").split(",").each do |path|
+      path = path.strip
+      top.download(File.join(current_path, path), path)
+    end
+  end
+end
+
+# Capistrano assumes assets are placed under public/ but static or PHP sites
+# usually don't have such a separate directory for assets, since they're made of
+# such files. Accommodate to its default behaviour by symlinking appropriately.
+def root_contains_assets!
+  after('deploy:finalize_update') do
+    run %w(images stylesheets javascripts).map { |dir| "ln -ns ../#{dir} #{latest_release}/public/#{dir}" }.join('; ')
+    run "ln -ns public/system #{latest_release}/system"
+  end
+end

data/lib/capistrano_fixes.rb

@@ -0,0 +1,147 @@
+module Capistrano::Fixes
+  # Make transfers happen over SCP instead of SFTP by default, in order to
+  # resolve ~ as the home of the logged in user.
+  module SCPAsDefaultTransferProtocol
+    def self.included(target)
+      target.module_eval do
+        alias_method :transfer_without_scp_default, :transfer
+        alias_method :transfer, :transfer_with_scp_default
+      end
+    end
+    
+    def transfer_with_scp_default(direction, from, to, options={}, &block)
+      options = {:via => :scp, :recursive => true}.merge(options)
+      transfer_without_scp_default(direction, from, to, options, &block)
+    end
+  end
+  
+  # Fix Windows-style switches that get screwed up by Capistrano when trying to
+  # normalize paths.
+  #
+  # Note about the implementation: the `system' method is not copied and
+  # re-aliased on purpose. The target class (strategy base class) calls `super'
+  # which forwards the call to ancestor modules, including this one, which in
+  # turn delegates to Kernel.
+  module WindowsCommandSwitchInversion
+  private
+    def system(*cmd)
+      cmd = cmd.join(' ')
+      while cmd.gsub! /([ A-Z])\\([A-Z])\b/, '\1/\2'; end
+      super cmd
+    end
+  end
+  
+  require "capistrano/recipes/deploy/strategy/copy"
+  module CommandlessCompression
+    def self.included(target)
+      target.class_eval do
+        alias_method :compression_without_commandless, :compression
+        alias_method :compression, :compression_with_commandless
+        
+        alias_method :compress_without_commandless, :compress
+        alias_method :compress, :compress_with_commandless
+      end
+    end
+    
+  private
+  
+    def system(*args)
+      args = args.flatten
+      if (proc = args.first).respond_to?(:call)
+        proc.call(*args[1..-1])
+      else
+        super
+      end
+    end
+  
+    def compression_with_commandless
+      orig = compression_without_commandless
+      return orig if Kernel.system("which #{orig.compress_command.first} > /dev/null 2>&1")
+      Capistrano::Deploy::Strategy::Copy::Compression.new \
+        Tarring::EXTENSION,
+        [Tarring.method(:compress)],
+        Tarring::DECOMPRESSION_COMMAND
+    end
+    
+    def compress_with_commandless(*args, &block)
+      compress_without_commandless(*args, &block).extend JoinInhibition
+    end
+    
+    module JoinInhibition
+      def join(*args, &block)
+        self
+      end
+    end
+    
+    require 'archive/tar/minitar'
+    require 'zlib'
+    module Tarring
+      EXTENSION = "tar.gz"
+      DECOMPRESSION_COMMAND = %w(tar zxf)
+      
+      # Does the equivalent of:
+      #
+      #   $ cd #{File.dirname directory} && tar czf #{file} #{File.basename directory}`
+      #
+      # but without invoking any command that would result in an external
+      # dependency. Convenient under Windows where there exists no `tar'
+      # or `zip' command.
+      def self.compress(file, directory)
+        # Note: it's very important to open in binary mode on Windows. Not
+        #       doing so results in invalid tar headers.
+        sgz = Zlib::GzipWriter.new(File.open(file, 'wb'))
+        
+        tar = Archive::Tar::Minitar::Output.new(sgz)
+        begin
+          Dir.chdir(File.dirname(directory)) do
+            Dir.glob("#{File.basename directory}/**/*") do |file|
+              Archive::Tar::Minitar.pack_file(file, tar)
+            end
+          end
+        ensure
+          tar.close   # closes `sgz' which in turn closes `file'
+        end
+      end
+    end
+  end
+  
+  # Tasks like deploy:upload take a list of files or globs from $FILES which is
+  # passed to Dir.glob. The problem is, to that method, the backslash is a
+  # special character. So all instances of said character have to be replaced
+  # with forward slashes under Windows.
+  def self.fix_env!
+    ENV["FILES"] &&= ENV["FILES"].tr('\\', '/')
+  end
+  
+  # On Windows, assume that the private SSH key is located under My Documents.
+  # Works for at least French and English versions of Windows.
+  def self.add_ssh_keys_for_windows!(ssh_options)
+    if profile_dir = ENV["USERPROFILE"] and (ssh_options[:keys] ||= []).empty?
+      glob = "#{profile_dir}/* Documents/{*,**}/*.priv{,.txt}".tr('\\', '/')
+      if first = Dir.glob(glob) { |f| break f }
+        ssh_options[:keys] << first
+      end
+    end
+  end
+  
+  def self.apply!(context)
+    require 'capistrano/configuration/actions/file_transfer'
+    Capistrano::Configuration::Actions::FileTransfer.module_eval do
+      include SCPAsDefaultTransferProtocol
+    end
+
+    require 'capistrano/recipes/deploy/strategy/base'
+    Capistrano::Deploy::Strategy::Base.class_eval do
+      include WindowsCommandSwitchInversion
+    end
+    
+    require 'capistrano/recipes/deploy/strategy/copy'
+    Capistrano::Deploy::Strategy::Copy.class_eval do
+      include CommandlessCompression
+    end
+    
+    fix_env!
+    add_ssh_keys_for_windows!(context.ssh_options)
+    context.load File.dirname(__FILE__) + '/capistrano_fixes/tasks.rb'
+  end
+end

data/test/capistrano_fixes_test.rb

@@ -0,0 +1,104 @@
+require 'test/unit'
+require 'mocha'
+
+require 'capistrano'
+require 'capistrano_fixes'
+
+class Capistrano::Fixes::SCPAsDefaultTransferProtocolTest < Test::Unit::TestCase
+  M = Capistrano::Fixes::SCPAsDefaultTransferProtocol
+  
+  class FileTransfer
+    CALLS = []
+    def transfer(*args)
+      CALLS << args
+    end
+    include M
+  end
+  
+  def test_transfer
+    tr = FileTransfer.new
+    tr.transfer(:up, "from", "to")
+    assert_equal [[:up, "from", "to", {:via => :scp, :recursive => true}]], FileTransfer::CALLS
+  ensure
+    FileTransfer::CALLS.clear
+  end
+end
+
+class Capistrano::Fixes::CommandlessCompressionTest < Test::Unit::TestCase
+  M = Capistrano::Fixes::CommandlessCompression
+  
+  class Strategy
+    Compression = Struct.new(:compress_command)
+    
+    def deploy!
+      system(compress(:file, :directory).join(" "))
+    end
+    
+  private
+  
+    def compression
+      Compression.new(%w(tar czf))
+    end
+    
+    # Copied from Capistrano source code.
+    def compress(file, directory)
+      compression.compress_command + [file, directory]
+    end
+    
+    include M
+  end
+  
+  def test_deploy!
+    strategy = Strategy.new
+    
+    # Fake absence of `tar' to trigger the use of command-less tarring
+    Kernel.stubs(:system).with("which tar > /dev/null 2>&1").returns false
+    
+    # Expect command-less tarring
+    M::Tarring.expects(:compress).with(:file, :directory)
+    
+    strategy.deploy!
+  end
+end
+
+class Capistrano::Fixes::CommandlessCompression::TarringTest < Test::Unit::TestCase
+  M = Capistrano::Fixes::CommandlessCompression::Tarring
+  
+  def setup
+    @tmp = File.dirname(__FILE__) + "/tmp"
+    
+    # Fix for when the test is not run individually:
+    @tmp = File.expand_path(@tmp)
+    
+    teardown
+    FileUtils.mkdir_p(@tmp)
+  end
+  
+  def teardown
+    FileUtils.rm_rf(@tmp)
+  end
+  
+  def test_compress
+    FileUtils.mkdir("#{@tmp}/foo")
+    FileUtils.mkdir("#{@tmp}/foo/bar")
+    FileUtils.touch("#{@tmp}/foo/bar/abc")
+    FileUtils.mkdir("#{@tmp}/foo/baz")
+    
+    # Compress
+    archive = "#{@tmp}/foo.tgz"
+    M.compress(archive, "#{@tmp}/foo")
+    
+    # Uncompress
+    unpack_dir = "#{@tmp}/unpack"
+    FileUtils.mkdir(unpack_dir)
+    Dir.chdir(unpack_dir) do
+      system(*M::DECOMPRESSION_COMMAND + [archive])
+    end
+    
+    expected =  [ "#{unpack_dir}/foo",
+                  "#{unpack_dir}/foo/bar",
+                  "#{unpack_dir}/foo/bar/abc",
+                  "#{unpack_dir}/foo/baz" ]
+    assert_equal expected, Dir["#{unpack_dir}/**/*"]
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: Roman2K-capistrano-fixes
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- "Roman Le N\xC3\xA9grate"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.5"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Fixes for Capistrano default recipes
+email: roman.lenegrate@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/capistrano_fixes/tasks.rb
+- lib/capistrano_fixes.rb
+- LICENSE
+- README.mdown
+files: 
+- lib/capistrano_fixes/tasks.rb
+- lib/capistrano_fixes.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.mdown
+- test/capistrano_fixes_test.rb
+- capistrano-fixes.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --main
+- README.mdown
+- --inline-source
+- --line-numbers
+- --charset
+- UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: capistrano-fixes
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Fixes for Capistrano default recipes
+test_files: 
+- test/capistrano_fixes_test.rb