alpha_omega 0.0.1

data/recipes/alpha_omega/deploy/dependencies.rb

@@ -0,0 +1,44 @@
+require 'alpha_omega/deploy/local_dependency'
+require 'alpha_omega/deploy/remote_dependency'
+
+module Capistrano
+  module Deploy
+    class Dependencies
+      include Enumerable
+
+      attr_reader :configuration
+
+      def initialize(configuration)
+        @configuration = configuration
+        @dependencies = []
+        yield self if block_given?
+      end
+
+      def check
+        yield self
+        self
+      end
+
+      def remote
+        dep = RemoteDependency.new(configuration)
+        @dependencies << dep
+        dep
+      end
+
+      def local
+        dep = LocalDependency.new(configuration)
+        @dependencies << dep
+        dep
+      end
+
+      def each
+        @dependencies.each { |d| yield d }
+        self
+      end
+
+      def pass?
+        all? { |d| d.pass? }
+      end
+    end
+  end
+end

data/recipes/alpha_omega/deploy/local_dependency.rb

@@ -0,0 +1,54 @@
+module Capistrano
+  module Deploy
+    class LocalDependency
+      attr_reader :configuration
+      attr_reader :message
+
+      def initialize(configuration)
+        @configuration = configuration
+        @success = true
+      end
+
+      def command(command)
+        @message ||= "`#{command}' could not be found in the path on the local host"
+        @success = find_in_path(command)
+        self
+      end
+
+      def or(message)
+        @message = message
+        self
+      end
+
+      def pass?
+        @success
+      end
+
+    private
+
+      # Searches the path, looking for the given utility. If an executable
+      # file is found that matches the parameter, this returns true.
+      def find_in_path(utility)
+        path = (ENV['PATH'] || "").split(File::PATH_SEPARATOR)
+        suffixes = self.class.on_windows? ? self.class.windows_executable_extensions : [""]
+
+        path.each do |dir|
+          suffixes.each do |sfx|
+            file = File.join(dir, utility + sfx)
+            return true if File.executable?(file)
+          end
+        end
+
+        false
+      end
+
+      def self.on_windows?
+        RUBY_PLATFORM =~ /mswin|mingw/
+      end
+
+      def self.windows_executable_extensions
+        %w(.exe .bat .com .cmd)
+      end
+    end
+  end
+end

data/recipes/alpha_omega/deploy/remote_dependency.rb

@@ -0,0 +1,111 @@
+require 'capistrano/errors'
+
+module Capistrano
+  module Deploy
+    class RemoteDependency
+      attr_reader :configuration
+      attr_reader :hosts
+
+      def initialize(configuration)
+        @configuration = configuration
+        @success = true
+        @hosts = nil
+      end
+
+      def directory(path, options={})
+        @message ||= "`#{path}' is not a directory"
+        try("test -d #{path}", options)
+        self
+      end
+
+      def file(path, options={})
+        @message ||= "`#{path}' is not a file"
+        try("test -f #{path}", options)
+        self
+      end
+
+      def writable(path, options={})
+        @message ||= "`#{path}' is not writable"
+        try("test -w #{path}", options)
+        self
+      end
+
+      def command(command, options={})
+        @message ||= "`#{command}' could not be found in the path"
+        try("which #{command}", options)
+        self
+      end
+
+      def gem(name, version, options={})
+        @message ||= "gem `#{name}' #{version} could not be found"
+        gem_cmd = configuration.fetch(:gem_command, "gem")
+        try("#{gem_cmd} specification --version '#{version}' #{name} 2>&1 | awk 'BEGIN { s = 0 } /^name:/ { s = 1; exit }; END { if(s == 0) exit 1 }'", options)
+        self
+      end
+
+      def deb(name, version, options={})
+        @message ||= "package `#{name}' #{version} could not be found"
+        try("dpkg -s #{name} | grep '^Version: #{version}'", options)
+        self
+      end
+
+      def match(command, expect, options={})
+        expect = Regexp.new(Regexp.escape(expect.to_s)) unless expect.is_a?(Regexp)
+
+        output_per_server = {} 
+        try("#{command} ", options) do |ch, stream, out| 
+          output_per_server[ch[:server]] ||= '' 
+          output_per_server[ch[:server]] += out 
+        end 
+
+        # It is possible for some of these commands to return a status != 0
+        # (for example, rake --version exits with a 1). For this check we
+        # just care if the output matches, so we reset the success flag.
+        @success = true
+
+        errored_hosts = [] 
+        output_per_server.each_pair do |server, output| 
+          next if output =~ expect
+          errored_hosts << server 
+        end 
+
+        if errored_hosts.any?
+          @hosts = errored_hosts.join(', ')
+          output = output_per_server[errored_hosts.first]
+          @message = "the output #{output.inspect} from #{command.inspect} did not match #{expect.inspect}"
+          @success = false
+        end 
+
+        self 
+      end
+
+      def or(message)
+        @message = message
+        self
+      end
+
+      def pass?
+        @success
+      end
+
+      def message
+        s = @message.dup
+        s << " (#{@hosts})" if @hosts
+        s
+      end
+
+    private
+
+      def try(command, options)
+        return unless @success # short-circuit evaluation
+        configuration.invoke_command(command, options) do |ch,stream,out|
+          warn "#{ch[:server]}: #{out}" if stream == :err
+          yield ch, stream, out if block_given?
+        end
+      rescue Capistrano::CommandError => e
+        @success = false
+        @hosts = e.hosts.join(', ')
+      end
+    end
+  end
+end

data/recipes/alpha_omega/deploy/scm.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  module Deploy
+    module SCM
+      def self.new(scm, config={})
+        scm_file = "alpha_omega/deploy/scm/#{scm}"
+        require(scm_file)
+
+        scm_const = scm.to_s.capitalize.gsub(/_(.)/) { $1.upcase }
+        if const_defined?(scm_const)
+          const_get(scm_const).new(config)
+        else
+          raise Capistrano::Error, "could not find `#{name}::#{scm_const}' in `#{scm_file}'"
+        end
+      rescue LoadError
+        raise Capistrano::Error, "could not find any SCM named `#{scm}'"
+      end
+    end
+  end
+end

data/recipes/alpha_omega/deploy/scm/base.rb

@@ -0,0 +1,178 @@
+module Capistrano
+  module Deploy
+    module SCM
+
+      # The ancestor class for all Capistrano SCM implementations. It provides
+      # minimal infrastructure for subclasses to build upon and override.
+      #
+      # Note that subclasses that implement this abstract class only return
+      # the commands that need to be executed--they do not execute the commands
+      # themselves. In this way, the deployment method may execute the commands
+      # either locally or remotely, as necessary.
+      class Base
+        class << self
+          # If no parameters are given, it returns the current configured
+          # name of the command-line utility of this SCM. If a parameter is
+          # given, the defeault command is set to that value.
+          def default_command(value=nil)
+            if value
+              @default_command = value
+            else
+              @default_command
+            end
+          end
+        end
+
+        # Wraps an SCM instance and forces all messages sent to it to be
+        # relayed to the underlying SCM instance, in "local" mode. See
+        # Base#local.
+        class LocalProxy
+          def initialize(scm)
+            @scm = scm
+          end
+
+          def method_missing(sym, *args, &block)
+            @scm.local { return @scm.send(sym, *args, &block) }
+          end
+        end
+
+        # The options available for this SCM instance to reference. Should be
+        # treated like a hash.
+        attr_reader :configuration
+
+        # Creates a new SCM instance with the given configuration options.
+        def initialize(configuration={})
+          @configuration = configuration
+        end
+
+        # Returns a proxy that wraps the SCM instance and forces it to operate
+        # in "local" mode, which changes how variables are looked up in the
+        # configuration. Normally, if the value of a variable "foo" is needed,
+        # it is queried for in the configuration as "foo". However, in "local"
+        # mode, first "local_foo" would be looked for, and only if it is not
+        # found would "foo" be used. This allows for both (e.g.) "scm_command"
+        # and "local_scm_command" to be set, if the two differ.
+        #
+        # Alternatively, it may be called with a block, and for the duration of
+        # the block, all requests on this configuration object will be
+        # considered local.
+        def local
+          if block_given?
+            begin
+              saved, @local_mode = @local_mode, true
+              yield
+            ensure
+              @local_mode = saved
+            end
+          else
+            LocalProxy.new(self)
+          end
+        end
+
+        # Returns true if running in "local" mode. See #local.
+        def local?
+          @local_mode
+        end
+
+        # Returns the string used to identify the latest revision in the
+        # repository. This will be passed as the "revision" parameter of
+        # the methods below.
+        def head
+          raise NotImplementedError, "`head' is not implemented by #{self.class.name}"
+        end
+
+        # Checkout a copy of the repository, at the given +revision+, to the
+        # given +destination+. The checkout is suitable for doing development
+        # work in, e.g. allowing subsequent commits and updates.
+        def checkout(revision, destination)
+          raise NotImplementedError, "`checkout' is not implemented by #{self.class.name}"
+        end
+
+        # Compute the difference between the two revisions, +from+ and +to+.
+        def diff(from, to=nil)
+          raise NotImplementedError, "`diff' is not implemented by #{self.class.name}"
+        end
+
+        # Return a log of all changes between the two specified revisions,
+        # +from+ and +to+, inclusive.
+        def log(from, to=nil)
+          raise NotImplementedError, "`log' is not implemented by #{self.class.name}"
+        end
+
+        # If the given revision represents a "real" revision, this should
+        # simply return the revision value. If it represends a pseudo-revision
+        # (like Subversions "HEAD" identifier), it should yield a string
+        # containing the commands that, when executed will return a string
+        # that this method can then extract the real revision from.
+        def query_revision(revision)
+          raise NotImplementedError, "`query_revision' is not implemented by #{self.class.name}"
+        end
+
+        # Returns the revision number immediately following revision, if at
+        # all possible. A block should always be passed to this method, which
+        # accepts a command to invoke and returns the result, although a
+        # particular SCM's implementation is not required to invoke the block.
+        #
+        # By default, this method simply returns the revision itself. If a
+        # particular SCM is able to determine a subsequent revision given a
+        # revision identifier, it should override this method.
+        def next_revision(revision)
+          revision
+        end
+
+        # Returns the name of the command-line utility for this SCM. It first
+        # looks at the :scm_command variable, and if it does not exist, it
+        # then falls back to whatever was defined by +default_command+.
+        #
+        # If scm_command is set to :default, the default_command will be
+        # returned.
+        def command
+          command = variable(:scm_command)
+          command = nil if command == :default
+          command || default_command
+        end
+
+        # A helper method that can be used to define SCM commands naturally.
+        # It returns a single string with all arguments joined by spaces,
+        # with the scm command prefixed onto it.
+        def scm(*args)
+          [command, *args].compact.join(" ")
+        end
+
+        private
+
+          # A helper for accessing variable values, which takes into
+          # consideration the current mode ("normal" vs. "local").
+          def variable(name)
+            if local? && configuration.exists?("local_#{name}".to_sym)
+              return configuration["local_#{name}".to_sym]
+            else
+              configuration[name]
+            end
+          end
+
+          # A reference to a Logger instance that the SCM can use to log
+          # activity.
+          def logger
+            @logger ||= variable(:logger) || Capistrano::Logger.new(:output => STDOUT)
+          end
+
+          # A helper for accessing the default command name for this SCM. It
+          # simply delegates to the class' +default_command+ method.
+          def default_command
+            self.class.default_command
+          end
+
+          # A convenience method for accessing the declared repository value.
+          def repository
+            variable(:repository)
+          end
+
+          def arguments
+            variable(:scm_arguments)
+          end
+      end
+
+    end
+  end
+end

data/recipes/alpha_omega/deploy/scm/git.rb

@@ -0,0 +1,124 @@
+require 'alpha_omega/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # An SCM module for using Git as your source control tool with Capistrano
+      # 2.0.
+      #
+      # Assumes you are using a shared Git repository.
+      #
+      # Parts of this plugin borrowed from Scott Chacon's version, which I
+      # found on the Capistrano mailing list but failed to be able to get
+      # working.
+      #
+      # FEATURES:
+      #
+      #   * Very simple, only requiring 2 lines in your deploy.rb.
+      #   * Can deploy different branches, tags, or any SHA1 easily.
+      #   * Supports :scm_command Capistrano directive.
+      #
+      # CONFIGURATION
+      # -------------
+      #
+      # Use this plugin by adding the following line in your config/deploy.rb:
+      #
+      #   set :scm, :git
+      #
+      # Set <tt>:repository</tt> to the path of your Git repo:
+      #
+      #   set :repository, "someuser@somehost:/home/myproject"
+      #
+      # The above two options are required to be set, the ones below are
+      # optional.
+      #
+      # You may set <tt>:branch</tt>, which is the reference to the branch, tag,
+      # or any SHA1 you are deploying, for example:
+      #
+      #   set :branch, "master"
+      #
+      # Otherwise, HEAD is assumed.  I strongly suggest you set this.  HEAD is
+      # not always the best assumption.
+      #
+      # The <tt>:scm_command</tt> configuration variable, if specified, will
+      # be used as the full path to the git executable on the *remote* machine:
+      #
+      #   set :scm_command, "/opt/local/bin/git"
+      #
+      # AUTHORS
+      # -------
+      #
+      # Garry Dolley http://scie.nti.st
+      # Contributions by Geoffrey Grosenbach http://topfunky.com
+      #              Scott Chacon http://jointheconversation.org
+      #                          Alex Arnell http://twologic.com
+      #                                   and Phillip Goldenburg
+
+      class Git < Base
+        # Sets the default command name for this SCM on your *local* machine.
+        # Users may override this by setting the :scm_command variable.
+        default_command "git"
+
+        # When referencing "head", use the branch we want to deploy or, by
+        # default, Git's reference of HEAD (the latest changeset in the default
+        # branch, usually called "master").
+        def head
+          variable(:branch) || 'HEAD'
+        end
+
+        # Performs a clone on the remote machine, then checkout on the branch
+        # you want to deploy.
+        def checkout(revision, destination)
+          git = command
+
+          execute = []
+
+          execute << "[[ -d #{destination}/.git ]] || #{git} clone #{verbose} #{variable(:repository)} #{destination}"
+          execute << "cd #{destination} && #{git} fetch -q && git reset --hard #{revision}"
+
+          execute
+        end
+
+        # Returns a string of diffs between two revisions
+        def diff(from, to=nil)
+          from << "..#{to}" if to
+          scm :diff, from
+        end
+
+        # Returns a log of changes between the two revisions (inclusive).
+        def log(from, to=nil)
+          scm :log, "#{from}..#{to}"
+        end
+
+        # Getting the actual commit id, in case we were passed a tag
+        # or partial sha or something - it will return the sha if you pass a sha, too
+        def query_revision(revision)
+          raise ArgumentError, "Deploying remote branches is no longer supported.  Specify the remote branch as a local branch for the git repository you're deploying from (ie: '#{revision.gsub('origin/', '')}' rather than '#{revision}')." if revision =~ /^origin\//
+          return revision if revision =~ /^[0-9a-f]{40}$/
+          command = scm('ls-remote', repository, revision)
+          result = yield(command)
+          revdata = result.split(/[\t\n]/)
+          newrev = nil
+          revdata.each_slice(2) do |refs|
+            rev, ref = *refs
+            if ref.sub(/refs\/.*?\//, '').strip == revision.to_s
+              newrev = rev
+              break
+            end
+          end
+          raise "Unable to resolve revision for '#{revision}' on repository '#{repository}'." unless newrev =~ /^[0-9a-f]{40}$/
+          return newrev
+        end
+
+        private
+
+          # If verbose output is requested, return nil, otherwise return the
+          # command-line switch for "quiet" ("-q").
+          def verbose
+            variable(:scm_verbose) ? nil : "-q"
+          end
+      end
+    end
+  end
+end