Class: FPM::Package::CPAN

Inherits:

FPM::Package

• Object
• FPM::Package
• FPM::Package::CPAN

Defined in:

lib/fpm/package/cpan.rb

Instance Attribute Summary

Attributes inherited from FPM::Package

#architecture, #attributes, #attrs, #category, #config_files, #conflicts, #dependencies, #description, #directories, #epoch, #iteration, #license, #maintainer, #name, #provides, #replaces, #scripts, #url, #vendor, #version

Instance Method Summary

• #input(package) ⇒ Object

Methods inherited from FPM::Package

apply_options, #build_path, #cleanup, #cleanup_build, #cleanup_staging, #convert, #converted_from, default_attributes, #edit_file, #files, inherited, #initialize, option, #output, #script, #staging_path, #to_s, #type, type, types

Methods included from Util

#ar_cmd, #ar_cmd_deterministic?, #copied_entries, #copy_entry, #copy_metadata, #default_shell, #erbnew, #execmd, #expand_pessimistic_constraints, #logger, #program_exists?, #program_in_path?, #safesystem, #safesystemout, #tar_cmd, #tar_cmd_supports_sort_names_and_set_mtime?

Constructor Details

This class inherits a constructor from FPM::Package

Instance Method Details

#input(package) ⇒ Object

# File 'lib/fpm/package/cpan.rb', line 41

def input(package)
  #if RUBY_VERSION =~ /^1\.8/
    #raise FPM::Package::InvalidArgument,
      #"Sorry, CPAN support requires ruby 1.9 or higher. You have " \
      #"#{RUBY_VERSION}. If this negatively impacts you, please let " \
      #"me know by filing an issue: " \
      #"https://github.com/jordansissel/fpm/issues"
  #end
  #require "ftw" # for http access
  require "net/http"
  require "json"

  if File.exist?(package)
    moduledir = package
    result = {}
  else
    result = search(package)
    tarball = download(result, version)
    moduledir = unpack(tarball)
  end

  # Read package metadata (name, version, etc)
  if File.exist?(File.join(moduledir, "META.json"))
    local_metadata = JSON.parse(File.read(File.join(moduledir, ("META.json"))))
  elsif File.exist?(File.join(moduledir, ("META.yml")))
    require "yaml"
    local_metadata = YAML.load_file(File.join(moduledir, ("META.yml")))
  elsif File.exist?(File.join(moduledir, "MYMETA.json"))
    local_metadata = JSON.parse(File.read(File.join(moduledir, ("MYMETA.json"))))
  elsif File.exist?(File.join(moduledir, ("MYMETA.yml")))
    require "yaml"
    local_metadata = YAML.load_file(File.join(moduledir, ("MYMETA.yml")))
  end

  # Merge the MetaCPAN query result and the metadata pulled from the local
  # META file(s).  The local data overwrites the query data for all keys the
  # two hashes have in common.  Merge with an empty hash if there was no
  # local META file.
  metadata = result.merge(local_metadata || {})

  if metadata.empty?
    raise FPM::InvalidPackageConfiguration,
      "Could not find package metadata. Checked for META.json, META.yml, and MetaCPAN API data"
  end

  self.version = metadata["version"]
  self.description = metadata["abstract"]

  self.license = case metadata["license"]
    when Array; metadata["license"].first
    when nil; "unknown"
    else; metadata["license"]
  end

  unless metadata["distribution"].nil?
    logger.info("Setting package name from 'distribution'",
                 :distribution => metadata["distribution"])
    self.name = fix_name(metadata["distribution"])
  else
    logger.info("Setting package name from 'name'",
                 :name => metadata["name"])
    self.name = fix_name(metadata["name"])
  end

  unless metadata["module"].nil?
    metadata["module"].each do |m|
      self.provides << cap_name(m["name"]) + " = #{self.version}"
    end
  end

  # author is not always set or it may be a string instead of an array
  self.vendor = case metadata["author"]
    when String; metadata["author"]
    when Array; metadata["author"].join(", ")
    when NilClass; "No Vendor Or Author Provided"
    else
      raise FPM::InvalidPackageConfiguration, "Unexpected CPAN 'author' field type: #{metadata["author"].class}. This is a bug."
  end if metadata.include?("author")

  self.url = metadata["resources"]["homepage"] rescue "unknown"

  # TODO(sissel): figure out if this perl module compiles anything
  # and set the architecture appropriately.
  self.architecture = "all"

  # Install any build/configure dependencies with cpanm.
  # We'll install to a temporary directory.
  logger.info("Installing any build or configure dependencies")

  if attributes[:cpan_sandbox_non_core?]
    cpanm_flags = ["-L", build_path("cpan"), moduledir]
  else
    cpanm_flags = ["-l", build_path("cpan"), moduledir]
  end

  # This flag causes cpanm to ONLY download dependencies, skipping the target
  # module itself.  This is fine, because the target module has already been
  # downloaded, and there's no need to download twice, test twice, etc.
  cpanm_flags += ["--installdeps"]
  cpanm_flags += ["-n"] if !attributes[:cpan_test?]
  cpanm_flags += ["--mirror", "#{attributes[:cpan_mirror]}"] if !attributes[:cpan_mirror].nil?
  cpanm_flags += ["--mirror-only"] if attributes[:cpan_mirror_only?] && !attributes[:cpan_mirror].nil?
  cpanm_flags += ["--force"] if attributes[:cpan_cpanm_force?]
  cpanm_flags += ["--verbose"] if attributes[:cpan_verbose?]

  safesystem(attributes[:cpan_cpanm_bin], *cpanm_flags)

  if !attributes[:no_auto_depends?]
   found_dependencies = {}
   if metadata["requires"]
     found_dependencies.merge!(metadata["requires"])
   end
   if metadata["prereqs"]
     if metadata["prereqs"]["runtime"]
       if metadata["prereqs"]["runtime"]["requires"]
         found_dependencies.merge!(metadata["prereqs"]["runtime"]["requires"])
       end
     end
   end
   unless found_dependencies.empty?
     found_dependencies.each do |dep_name, version|
        # Special case for representing perl core as a version.
        if dep_name == "perl"
          m = version.to_s.match(/^(\d)\.(\d{3})(\d{3})$/)
          if m
             version = m[1] + '.' + m[2].sub(/^0*/, '') + '.' + m[3].sub(/^0*/, '')
          end
          self.dependencies << "#{dep_name} >= #{version}"
          next
        end
        dep = search(dep_name)

        name = cap_name(dep_name)

        if version.to_s == "0"
          # Assume 'Foo = 0' means any version?
          self.dependencies << "#{name}"
        else
          # The 'version' string can be something complex like:
          #   ">= 0, != 1.0, != 1.2"
          # If it is not specified explicitly, require the given
          # version or newer, as that is all CPAN itself enforces
          if version.is_a?(String)
            version.split(/\s*,\s*/).each do |v|
              if v =~ /\s*[><=]/
                self.dependencies << "#{name} #{v}"
              else
                self.dependencies << "#{name} >= #{v}"
              end
            end
          else
            self.dependencies << "#{name} >= #{version}"
          end
        end
      end
    end
  end #no_auto_depends

  ::Dir.chdir(moduledir) do
    # TODO(sissel): install build and config dependencies to resolve
    # build/configure requirements.
    # META.yml calls it 'configure_requires' and 'build_requires'
    # META.json calls it prereqs/build and prereqs/configure

    prefix = attributes[:prefix] || "/usr/local"
    # TODO(sissel): Set default INSTALL path?

    # Try Makefile.PL, Build.PL
    #
    if File.exist?("Build.PL")
      # Module::Build is in use here; different actions required.
      safesystem(attributes[:cpan_perl_bin],
                 "-Mlocal::lib=#{build_path("cpan")}",
                 "Build.PL")
      safesystem(attributes[:cpan_perl_bin],
                 "-Mlocal::lib=#{build_path("cpan")}",
                 "./Build")

      if attributes[:cpan_test?]
        safesystem(attributes[:cpan_perl_bin],
                 "-Mlocal::lib=#{build_path("cpan")}",
                 "./Build", "test")
      end
      if attributes[:cpan_perl_lib_path]
        perl_lib_path = attributes[:cpan_perl_lib_path]
        safesystem("./Build install --install_path lib=#{perl_lib_path} \
                   --destdir #{staging_path} --prefix #{prefix} --destdir #{staging_path}")
      else
         safesystem("./Build", "install",
                   "--prefix", prefix, "--destdir", staging_path,
                   # Empty install_base to avoid local::lib being used.
                   "--install_base", "")
      end
    elsif File.exist?("Makefile.PL")
      if attributes[:cpan_perl_lib_path]
        perl_lib_path = attributes[:cpan_perl_lib_path]
        safesystem(attributes[:cpan_perl_bin],
                   "-Mlocal::lib=#{build_path("cpan")}",
                   "Makefile.PL", "PREFIX=#{prefix}", "LIB=#{perl_lib_path}",
                   # Empty install_base to avoid local::lib being used.
                   "INSTALL_BASE=")
      else
        safesystem(attributes[:cpan_perl_bin],
                   "-Mlocal::lib=#{build_path("cpan")}",
                   "Makefile.PL", "PREFIX=#{prefix}",
                   # Empty install_base to avoid local::lib being used.
                   "INSTALL_BASE=")
      end
      make = [ "env", "PERL5LIB=#{build_path("cpan/lib/perl5")}", "make" ]
      safesystem(*make)
      safesystem(*(make + ["test"])) if attributes[:cpan_test?]
      safesystem(*(make + ["DESTDIR=#{staging_path}", "install"]))


    else
      raise FPM::InvalidPackageConfiguration,
        "I don't know how to build #{name}. No Makefile.PL nor " \
        "Build.PL found"
    end

    # Fix any files likely to cause conflicts that are duplicated
    # across packages.
    # https://github.com/jordansissel/fpm/issues/443
    # https://github.com/jordansissel/fpm/issues/510
    glob_prefix = attributes[:cpan_perl_lib_path] || prefix
    ::Dir.glob(File.join(staging_path, glob_prefix, "**/perllocal.pod")).each do |path|
      logger.debug("Removing useless file.",
                    :path => path.gsub(staging_path, ""))
      File.unlink(path)
    end

    # Remove useless .packlist files and their empty parent folders
    # https://github.com/jordansissel/fpm/issues/1179
    ::Dir.glob(File.join(staging_path, glob_prefix, "**/.packlist")).each do |path|
      logger.debug("Removing useless file.",
                    :path => path.gsub(staging_path, ""))
      File.unlink(path)
      Pathname.new(path).parent.ascend do |parent|
        if ::Dir.entries(parent).sort == ['.', '..'].sort
          FileUtils.rmdir parent
        else
          break
        end
      end
    end
  end


  # TODO(sissel): figure out if this perl module compiles anything
  # and set the architecture appropriately.
  self.architecture = "all"

  # Find any shared objects in the staging directory to set architecture as
  # native if found; otherwise keep the 'all' default.
  Find.find(staging_path) do |path|
    if path =~ /\.so$/
      logger.info("Found shared library, setting architecture=native",
                   :path => path)
      self.architecture = "native"
    end
  end
end