drupid 1.0.0

data/lib/drupid/platform.rb

@@ -0,0 +1,234 @@
+# -*- 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 Platform
+    include Drupid::Utils
+
+    # The absolute path to this platform.
+    attr :local_path
+    # A Drupid::Platform::Project object with information about Drupal core,
+    # or nil if this platform does not contain Drupal core.
+    attr :drupal_project
+    # The path for contrib modules and themes (e.g., 'sites/all'),
+    # relative to #path.
+    attr_accessor :contrib_path
+    # The path to the sites directory (default: 'sites'), relative
+    # relative to #path.
+    attr :sites_dir
+
+    # Creates a new platform object for the Drupal installation at the
+    # specified path.
+    def initialize(pathname)
+      @local_path     = Pathname.new(pathname).realpath # must exist
+      @sites_dir      = Pathname.new('sites')
+      @contrib_path   = @sites_dir + 'all'
+      @drupal_project = nil       # Project
+      @projects       = Hash.new  # String -> PlatformProject
+      @libraries      = Hash.new  # String -> Library
+    end
+
+    # Returns the version of Drupal core in this platform, or
+    # nil if the version cannot be determined.
+    def version
+      if @drupal_project and @drupal_project.has_version?
+        return @drupal_project.version
+      end
+      return nil
+    end
+
+    # Returns the full path to the sites directory in this platform, e.g.,
+    # '/path/to/drupal/sites', as obtained by joining #local_path and #sites_dir.
+    def sites_path
+      @local_path + @sites_dir
+    end
+
+    # Returns the (possibly empty) list of sites in this platform.
+    def site_names
+      return [] unless sites_path.exist?
+      Pathname.glob(sites_path + '*/').map { |s| s.basename.to_s }.reject { |s| s =~ /^all$/ }
+    end
+
+    # Returns the full path to the libraries folder.
+    def libraries_path
+      @local_path + @contrib_path + 'libraries'
+    end
+
+
+    # Returns the relative path where the given component should be placed
+    # in this platform.
+    def dest_path(component)
+      if component.instance_of?(String) # assume it is the name of a platform project
+        c = get_project(component)
+        raise "No project called #{component} exists in this platform" if c.nil?
+      else
+        c = component
+      end
+      if c.core_project? or c.profile?
+        return c.target_path
+      else
+        return contrib_path + c.target_path
+      end
+    end
+
+    # Returns a list of the names of the profiles that exist in this platform.
+    # For profiles to be found, they must be located inside
+    # the subdirectory of #local_path named 'profiles'.
+    def profiles
+      Pathname.glob(local_path + 'profiles/*/*.profile').map { |p| p.basename('.profile').to_s }
+    end
+
+    # Returns the Drupid::PlatformProject object with the specified name,
+    # or nil if this platform does not contain a project with the given name.
+    def get_project(project_name)
+      return @drupal_project if @drupal_project and project_name == @drupal_project.name
+      return @projects[project_name]
+    end
+
+    # Returns true if this platform contains a project with the specified name.
+    def has_project?(project_name)
+      @projects.has_key?(project_name) or (@drupal_project and project_name == @drupal_project.name)
+    end
+
+    # Returns true if the specified site in this platform is bootstrapped.
+    # If no site is specified, returns true if the platform contains at least
+    # one bootstrapped site. Returns false otherwise. Example:
+    #   platform.bootstrapped?('default')
+    def bootstrapped?(site = nil)
+      sites_list = (site) ? [site] : site_names
+      sites_list.each do |s|
+        p = sites_path + s
+        next unless p.exist?
+        return true if Drupid::Drush.bootstrapped?(p)
+      end
+      return false
+    end
+
+    # Analyzes this platform.
+    def analyze
+      blah "Analyzing #{local_path}"
+      analyze_drupal_core
+      analyze_projects
+      analyze_libraries
+      return self
+    end
+
+    # Retrieves information about Drupal core in this platform.
+    def analyze_drupal_core
+      @drupal_project = nil
+      vers = Drupid::Drush.drupal_version(local_path)
+      if vers
+        core = vers.match(/(\d+)\./)[1].to_i
+        @drupal_project = Drupid::Project.new('drupal', core, vers)
+        @drupal_project.local_path = self.local_path
+      end   
+    end
+
+    # Extracts information about the projects in this platform.
+    # This method is invoked automatically by Drupid::Platform.analyze.
+    # In general, it does not need to be called by the user.
+    def analyze_projects
+      @projects = Hash.new
+      count = 0
+      search_paths = Array.new
+      search_paths << local_path+'modules/**/*.info'
+      search_paths << local_path+'themes/**/*.info'
+      search_paths << local_path+'profiles/*/*.info'
+      search_paths << local_path+contrib_path+'modules/**/*.info'
+      search_paths << local_path+contrib_path+'themes/**/*.info'
+      search_paths.uniq! # contrib_path may be ''
+      search_paths.each do |sp|
+        Dir[sp].each do |p|
+          pp = Drupid::PlatformProject.new(self, p)
+          @projects[pp.name] = pp
+          count += 1
+        end
+      end
+      count
+    end
+
+    # TODO: implement method
+    def analyze_libraries
+    end
+
+    # TODO: implement or throw away?
+    def to_makefile()
+    end
+
+    # Returns a list of the names of all contrib projects in this platform.
+    def project_names
+      @projects.values.reject { |p| p.core_project? }.map { |p| p.name }
+    end
+
+    # Returns a list of the names of all core projects.
+    def core_project_names
+      @projects.values.select { |p| p.core_project? }.map { |p| p.name }
+    end
+
+    # Iterates over all contrib projects in this platform.
+    def each_project
+      @projects.values.reject { |p| p.core_project? }.each { |p| yield p }
+    end
+
+    # Iterates over all core projects in this platform.
+    def each_core_project
+      @projects.values.select { |p| p.core_project? }.each { |p| yield p }
+    end
+
+    # Creates a PNG image depicting the relationships
+    # among the projects in this platform.
+    def dependency_graph
+      silence_warnings do
+        begin
+          require 'rgl/adjacency'
+          require 'rgl/dot'
+        rescue LoadError
+          odie "Please install the RGL gem with 'gem install rgl'"
+        end
+      end
+      if `which dot 2>/dev/null`.chomp.empty?
+        owarn "The 'dot' program is required to get an SVG image."
+        owarn "Without it you will only get a .dot file."
+      end
+      analyze
+      # We use this instead of a dag, because there may be circular dependencies...
+      graph = ::RGL::DirectedAdjacencyGraph.new
+      each_project do |p|
+        graph.add_vertex(p.name)
+        p.dependencies(:subprojects => false).each do |depname|
+          graph.add_vertex(depname) # does nothing if depname already exists
+          graph.add_edge(p.name, depname)
+        end
+      end
+      each_core_project do |p|
+        next if p.name.match(/test/) # Skip test modules
+        graph.add_vertex('node' == p.name ? '"node"' : p.name) # 'node' is a Dot keyword
+        p.dependencies.each do |depname|
+          graph.add_vertex(depname)
+          graph.add_edge(p.name, depname)
+        end
+      end
+      graph.write_to_graphic_file('svg')
+    end
+
+  end # Platform
+end # Drupid

data/lib/drupid/platform_project.rb

@@ -0,0 +1,91 @@
+# -*- 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 PlatformProject < Project
+    attr :platform
+
+    def initialize proj_platform, project_or_info_path
+      pi = ProjectInfo.new(project_or_info_path)
+      super(pi.project_name, pi.project_core)
+      @info_file = pi.info_file
+      @local_path = pi.project_dir
+      @version = pi.project_version if pi.project_version
+      @proj_type = pi.project_type
+      @core_project = pi.core_project?
+      @platform = proj_platform
+    end
+
+    # Returns the path of this project relative to the path of the containing
+    # platform.
+    def relative_path
+      @local_path.relative_path_from(@platform.local_path)
+    end
+
+    # A subdirectory where this project is installed.
+    # For example, for 'sites/all/modules/specialmodules/mymodule',
+    # this method returns 'specialmodules';
+    # for 'profiles/custom_profiles/myprofile', this method returns 'custom_profiles';
+    # for 'modules/node/tests/', returns 'node'.
+    def subdir
+      if core_project? or 'profile' == proj_type
+        return @local_path.parent.relative_path_from(@platform.local_path + (proj_type + 's'))
+      else
+        return @local_path.parent.relative_path_from(@platform.local_path + @platform.contrib_path + (proj_type + 's'))
+      end
+    end
+
+    # Returns true if this is an enabled theme
+    # or an installed (enabled or disabled) module in the specified site,
+    # or in at least one site in the platform if no site is specified;
+    # returns false otherwise.
+    # Note that the project's path must be defined, because this method uses
+    # the path to determine whether the project is installed in a site.
+    # Consider, for example, a Drupal platform that
+    # contains two distinct copies of a module called Foo, one
+    # in ./sites/www.mysite.org/modules/foo
+    # and another in ./profiles/fooprofile/modules/foo. Suppose that the former is used by
+    # the site www.mysite.org, and the latter is used by another site, say
+    # www.othersite.org, installed using the fooprofile installation profile.
+    # If p is a Drupid::PlatformProject object associated to ./sites/www.mysite.org/modules/foo
+    # and q is another Drupid::PlatformProject object associated to
+    # ./profiles/fooprofile/modules/foo and both modules are installed in their
+    # respective sites,
+    # then the result of invoking this method will be as follows:
+    #   p.installed?('www.mysite.org')     # true
+    #   p.installed?('www.othersite.org')  # false
+    #   q.installed?('www.mysite.org')     # false
+    #   q.installed?('www.othersite.org')  # true
+    #   p.installed?                       # true
+    #   q.installed?                       # true
+    def installed? site = nil
+      site_list = (site) ? [site] : platform.site_names
+      site_list.each do |s|
+        site_path = platform.sites_path + s
+        next unless site_path.exist?
+        return true if Drush.installed?(site_path, name, relative_path)
+      end
+      return false
+    end
+
+  end # Project
+end # Drupid