drupid 1.0.0

data/lib/drupid/drush.rb

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2012 Lifepillar
+# 
+# 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.
+
+module Drupid
+
+  # A wrapper around drush.
+  module Drush extend Drupid::Utils
+
+    DRUSH = `which drush`.strip
+
+    def self.drush *args
+      runBabyRun DRUSH, args
+    end
+
+    # Executes 'drush core-status' at the given path and
+    # returns the output of the command.
+    def self.status path, options = {}
+      output = nil
+      FileUtils.cd(path) do
+        output = drush 'core-status', '--pipe'
+      end
+      output
+    end
+
+    # Executes 'drush pm-releases --all' for the given project and
+    # returns the output of the command.
+    def self.pm_releases project_name, options = {}
+      drush 'pm-releases', '--all', project_name
+    end
+
+    # Parses the output of 'drush pm-releases' and returns
+    # the version of the latest recommended release, or nil
+    # if no such release exists.
+    def self.recommended_release pm_releases_output
+      pm_releases_output.each_line do |l|
+        return $~[1] if (l.match(/^\s*([^\s]+).*Recommended/))
+      end
+      nil
+    end
+
+    # Parses the output of 'drush pm-releases' and returns
+    # the version of the latest supported release, or nil
+    # if no such release exists.
+    def self.supported_release pm_releases_output
+      pm_releases_output.each_line do |l|
+        return $~[1] if (l.match(/^\s*([^\s]+).*Supported/))
+      end
+      nil
+    end
+
+    # Executes 'drush pm-download <project_name>' and
+    # returns the output of the command.
+    # If :working_dir is set to an existing directory, move into that directory before
+    # executing the command.
+    #
+    # Options: source, destination, working_dir
+    def self.pm_download project_name, options = {}
+      args = ['pm-download', '-y']
+      args << "--source=#{options[:source]}" if options[:source]
+      args << "--destination\=#{options[:destination]}" if options[:destination]
+      args << "--variant=profile-only"
+      args << "--verbose" if $VERBOSE
+      args << project_name
+      if options[:working_dir] and File.directory?(options[:working_dir])
+        wd = options[:working_dir]
+      else
+        wd = FileUtils.pwd
+      end
+      output = nil
+      FileUtils.cd(wd) do
+        output = runBabyRun DRUSH, args, :redirect_stderr_to_stdout => true
+      end
+      output
+    end
+
+    # Parses the output of 'drush pm-download' and returns
+    # the path to the downloaded project, or nil
+    # if the path cannot be determined.
+    def self.download_path pm_download_output
+      pm_download_output.match(/^\s*Project.+downloaded to *(.\[.+[\n\r])?\s*(.+)\./)
+      return File.expand_path($~[2]) if $~
+      return nil
+    end
+
+    # Parses the output of 'drush pm-download' and returns
+    # the version of the downloaded project, or nil
+    # if the version cannot be determined.
+    def self.downloaded_version pm_download_output
+      pm_download_output.match(/^\s*Project.+\((.+)\) +downloaded +to/)
+      return $~[1] if $~
+      return nil
+    end
+
+    # Executes 'drush pm-info' at the given path and with an
+    # optional list of projects.
+    # Returns the output of the command.
+    def self.pm_info path, projects = [], options = {}
+      output = nil
+      args = Array.new
+      args << 'pm-info'
+      args << projects.join(' ') unless nil != projects and projects.empty?
+      FileUtils.cd(path) do
+        output = runBabyRun DRUSH, args, :redirect_stderr_to_stdout => true
+      end
+      output
+    end
+
+    # Returns the version of Drupal (e.g., '7.12')
+    # if the given path contains Drupal;
+    # returns nil otherwise.
+    def self.drupal_version path, options = {}
+      st = self.status(path, options)
+      return nil unless st.match(/drupal_version=(\d+\.\d+)/)
+      return $~[1]
+    end
+
+    # Returns true if a Drupal's site is bootstrapped at the given path;
+    # returns false otherwise.
+    def self.bootstrapped?(path, options = {})
+      st = self.status(path, options)
+      st.match(/drupal_bootstrap=Successful/) ? true : false
+    end
+
+    # Returns true if the project at the given path is an enabled theme
+    # or an installed (enabled or disabled) module in the given site;
+    # returns false otherwise. The project's path must be relative
+    # to the Drupal installation (e.g., 'sites/all/modules').
+    # Note that the project path is necessary because, in general,
+    # there may be several copies of the same modules at different locations
+    # within a platform (in 'sites/all', in 'profiles/' and in site-specific locations).
+    #
+    # Options: verbose
+    def self.installed?(site_path, project_name, project_path, options = {})
+      st = ''
+      begin
+        st = self.pm_info(site_path, [project_name], options)
+      rescue # site not fully bootstrapped
+        return false
+      end
+      return false unless st.match(/Path +: +#{project_path}/)
+      return false unless st.match(/Type +: +([^\s]+)/)
+      type = $~[1]
+      return false unless st.match(/Status +: +(.+)$/)
+      project_status = $~[1]
+      ('module' == type and project_status !~ /not installed/) or
+      ('theme'  == type and project_status =~ /^enabled/)
+    end
+
+    # Executes 'drush make' and returns the output of the command.
+    #
+    # Options: contrib_path, nocore, dry, verbose
+    def self.make(makefile, target, options = {})
+      args = Array.new
+      args << 'make'
+      args << '-y'
+      args << '--no-core' if options[:nocore]
+      args << "--contrib-destination=#{options[:contrib_path]}" if options[:contrib_path]
+      args << "--no-patch-txt"
+      args << makefile
+      args << target
+      drush(*args)
+    end
+
+  end # module Drush
+
+end # Drupid

data/lib/drupid/extend/pathname.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2012 Lifepillar
+# 
+# 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.
+
+# Portions Copyright 2009-2011 Max Howell and other contributors.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+#  1. Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#  2. Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'pathname'
+
+# Code borrowed from Homebrew ;)
+class Pathname
+  def compression_type
+    return nil if self.directory?
+    # Don't treat jars or wars as compressed
+    return nil if self.extname == '.jar'
+    return nil if self.extname == '.war'
+  
+    # OS X installer package
+    return :pkg if self.extname == '.pkg'
+  
+    # Get enough of the file to detect common file types
+    # POSIX tar magic has a 257 byte offset
+    magic_bytes = nil
+    File.open(self) { |f| magic_bytes = f.read(262) }
+  
+    # magic numbers stolen from /usr/share/file/magic/
+    case magic_bytes
+    when /^PK\003\004/   then :zip
+    when /^\037\213/     then :gzip
+    when /^BZh/          then :bzip2
+    when /^\037\235/     then :compress
+    when /^.{257}ustar/  then :tar
+    when /^\xFD7zXZ\x00/ then :xz
+    when /^Rar!/         then :rar
+    else
+      # Assume it is not an archive
+      nil
+    end
+  end
+
+  def cd
+    Dir.chdir(self) { yield }
+  end
+
+  # Copies a file to another location or
+  # the content of a directory into the specified directory.
+  def ditto dst
+    d = Pathname.new(dst)
+    if file?
+      FileUtils.cp to_s, d.to_s, :verbose => $DEBUG
+      return (d.directory?) ? d+basename : d
+    else
+      d.mkpath
+      FileUtils.cp_r to_s + '/.', d.to_s, :verbose => $DEBUG
+      return d
+    end
+  end
+
+  # extended to support common double extensions
+  alias extname_old extname
+  def extname
+    /(\.(tar|cpio)\.(gz|bz2|xz|Z))$/.match to_s
+    return $1 if $1
+    return File.extname(to_s)
+  end
+
+  # Pathname in Ruby 1.8.x does not define #sub_ext.
+  unless self.method_defined? :sub_ext
+    # Return a pathname which the extension of the basename is substituted by
+    # <i>repl</i>.
+    #
+    # If self has no extension part, <i>repl</i> is appended.
+    def sub_ext(repl)
+      ext = File.extname(@path)
+      self.class.new(@path.chomp(ext) + repl)
+    end
+  end
+end # Pathname

data/lib/drupid/library.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2012 Lifepillar
+# 
+# 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.
+
+module Drupid
+  class Library < Component
+
+    def initialize name
+      super
+      self.download_type = 'file' # Default download type
+      @destination = nil
+    end
+
+    def destination
+      return Pathname.new('libraries') unless @destination
+      return Pathname.new(@destination)
+    end
+
+    def destination=(d)
+      @destination = d
+    end
+
+    # Returns the relative path where this library should be installed
+    # within a platform. This is 'libraries/#name' by default.
+    def target_path
+      return destination + subdir + directory_name
+    end
+
+    def fetch
+      cached_location.rmtree if cached_location.exist?
+      super
+    end
+  end # Library
+end # Drupid