fpm 0.4.14 → 0.4.15

data/CHANGELIST

@@ -1,3 +1,24 @@
+0.4.15 (September 6, 2012)
+  - pear: support custom channels with --pear-channel <channel> (#207)
+    Example: fpm -s pear -t deb --pear-channel pear.drush.org drush
+  - permit literal '\n' in --description, fpm will replace with a newline
+    character. Example: fpm --description "line one\nline two" (#251)
+  - improve error messaging when trying to output a package to a directory that
+    doesn't exist (#244)
+  - deb: convert '>' and '<' dependency operators to the correct '>>' and '<<'
+    debian version operators (#250, patch by Thomas Meson).
+  - deb: add --deb-priority flag (#232) for setting the debian 'priority'
+    value for your package.
+  - add --template-value. Used to expose arbitrary values to script templates.
+    If you do --template-value hello=world, in your template you can do
+    <%= hello %> to get 'world' to show up in your maintainer scripts.
+  - python: add --python-install-data flag to set the --install-data option to
+    setup.py (#255, patch by Thomas Meson)
+  - Reject bad dependency flags (ones containing commas) and offer alternative.
+    (#257)
+  - Try to copy a file if hardlinking fails with permission problems (#253, 
+    patch by Jacek Lach)
+
 0.4.14 (August 24, 2012)
   - rpm: Replace newlines with space in any license setting. (#252)
 

data/lib/fpm/command.rb

@@ -60,6 +60,7 @@ class FPM::Command < Clamp::Command
     @dependencies ||= []
     @dependencies << val
   end # -d / --depends
+
   option "--provides", "PROVIDES",
     "What this package provides (usually a name). This flag can be "\
     "specified multiple times." do |val|
@@ -80,10 +81,10 @@ class FPM::Command < Clamp::Command
   end # --replaces
   option "--config-files", "CONFIG_FILES",
     "Mark a file in the package as being a config file. This uses 'conffiles'" \
-    " in debs and %config in rpm. You can specify a directory to have it " \
-    "scanned marking all files found as config files. If you have multiple " \
-    "files to mark as configuration files, specify this flag multiple times." \
-    do |val|
+    " in debs and %config in rpm. If you have multiple files to mark as " \
+    "configuration files, specify this flag multiple times." do |val|
+    #You can specify a directory to have it scanned marking all files found as
+    #config files. If you have multiple "
     @config_files ||= []
     @config_files << val
   end # --config-files
@@ -105,8 +106,12 @@ class FPM::Command < Clamp::Command
     @excludes ||= []
     @excludes << val
   end # -x / --exclude
-  option "--description", "DESCRIPTION", "Add a description for this package.",
-    :default => "no description"
+  option "--description", "DESCRIPTION", "Add a description for this package." \
+    " You can include '\n' sequences to indicate newline breaks.",
+    :default => "no description" do |val|
+    # Replace literal "\n" sequences with a newline character.
+    val.gsub("\\n", "\n")
+  end
   option "--url", "URI", "Add a url for this package.",
     :default => "http://example.com/no-uri-given"
   option "--inputs", "INPUTS_PATH",
@@ -157,6 +162,14 @@ class FPM::Command < Clamp::Command
     "see the fpm wiki: " \
     "https://github.com/jordansissel/fpm/wiki/Script-Templates"
 
+  option "--template-value", "KEY=VALUE",
+    "Make 'key' available in script templates, so <%= key %> given will be " \
+    "the provided value. Implies --template-scripts" do |kv|
+    @template_scripts = true
+    @template_values ||= []
+    @template_values << kv.split("=", 2)
+  end
+
   parameter "[ARGS] ...",
     "Inputs to the source package type. For the 'dir' type, this is the files" \
     " and directories you want to include in the package. For others, like " \
@@ -342,6 +355,13 @@ class FPM::Command < Clamp::Command
     # Convert to the output type
     output = input.convert(output_class)
 
+    # Provide any template values as methods on the package.
+    if !@template_values.nil?
+      @template_values.each do |key, value|
+        (class << output; self; end).send(:define_method, key) { value }
+      end
+    end
+
     # Write the output somewhere, package can be nil if no --package is specified, 
     # and that's OK.
     begin
@@ -349,6 +369,9 @@ class FPM::Command < Clamp::Command
     rescue FPM::Package::FileAlreadyExists => e
       @logger.fatal(e.message)
       return 1
+    rescue FPM::Package::ParentDirectoryMissing => e
+      @logger.fatal(e.message)
+      return 1
     end
 
     return 0
@@ -406,6 +429,18 @@ class FPM::Command < Clamp::Command
                   "Expected one of: #{types.join(", ")}")
       end
 
+      with (@command.dependencies) do |dependencies|
+        # Verify dependencies don't include commas (#257)
+        dependencies.each do |dep|
+          next unless dep.include?(",")
+          splitdeps = dep.split(/\s*,\s*/)
+          @messages << "Dependencies should not " \
+            "include commas. If you want to specify multiple dependencies, use " \
+            "the '-d' flag multiple times. Example: " + \
+            splitdeps.map { |d| "-d '#{d}'" }.join(" ")
+        end
+      end
+
       mandatory(@command.args.any?,
                 "No parameters given. You need to pass additional command " \
                 "arguments so that I know what you want to build packages " \

data/lib/fpm/package.rb

@@ -25,6 +25,14 @@ class FPM::Package
     end # def to_s
   end # class FileAlreadyExists
 
+  # This class is raised when you try to output a package to a path
+  # whose containing directory does not exist.
+  class ParentDirectoryMissing < StandardError
+    def to_s
+      return "Parent directory does not exist: #{File.dirname(super)} - cannot write to #{super}"
+    end # def to_s
+  end # class ParentDirectoryMissing
+
   # The name of this package
   attr_accessor :name
 
@@ -311,6 +319,7 @@ class FPM::Package
   end # def template
 
   def to_s(fmt="NAME.TYPE")
+    fmt = "NAME.TYPE" if fmt.nil?
     fullversion = version.to_s
     fullversion += "-#{iteration}" if iteration
     return fmt.gsub("ARCH", architecture.to_s) \
@@ -487,6 +496,12 @@ class FPM::Package
     end
   end # def script
 
+  def output_check(output_path)
+    if !File.directory?(File.dirname(output_path))
+      raise ParentDirectoryMissing.new(output_path)
+    end
+  end # def output_path
+
   # General public API
   public(:type, :initialize, :convert, :input, :output, :to_s, :cleanup, :files,
          :version, :script)

data/lib/fpm/package/deb.rb

@@ -66,6 +66,18 @@ class FPM::Package::Deb < FPM::Package
     value.to_i
   end
 
+  option "--priority", "PRIORITY", 
+    "The debian package 'priority' value.", :default => "extra"
+
+  option "--user", "USER", "The owner of files in this package"
+
+  option "--group", "GROUP", "The group owner of files in this package"
+
+  def initialize(*args)
+    super(*args)
+    attributes[:deb_priority] = "extra"
+  end # def initialize
+
   private
 
   # Return the architecture. This will default to native if not yet set.
@@ -77,7 +89,10 @@ class FPM::Package::Deb < FPM::Package
       # system about.
       if program_in_path?("dpkg")
         @architecture = %x{dpkg --print-architecture 2> /dev/null}.chomp
-        @architecture = %{uname -m}.chomp if $?.exitstatus != 0
+        if $?.exitstatus != 0 or @architecture.empty?
+          # if dpkg fails or emits nothing, revert back to uname -m
+          @architecture = %x{uname -m}.chomp 
+        end
       else
         @architecture = %x{uname -m}.chomp
       end
@@ -98,14 +113,15 @@ class FPM::Package::Deb < FPM::Package
       @logger.warn("Debian tools (dpkg/apt) don't do well with packages " \
         "that use capital letters in the name. In some cases it will " \
         "automatically downcase them, in others it will not. It is confusing." \
-        "Best to not use any capital letters at all.",
+        " Best to not use any capital letters at all. I have downcased the " \
+        "package name for you just to be safe.",
         :oldname => @name, :fixedname => @name.downcase)
       @name = @name.downcase
     end
 
     if @name.include?("_")
-      @logger.info("Package name includes underscores, converting to dashes",
-                   :name => @name)
+      @logger.info("Debian package names cannot include underscores; " \
+                   "automatically converting to dashes", :name => @name)
       @name = @name.gsub(/[_]/, "-")
     end
 
@@ -130,7 +146,8 @@ class FPM::Package::Deb < FPM::Package
         if value.nil?
           return nil
         else
-          value.split(": ",2).last
+          @logger.info("deb field", field => value.split(": ", 2).last)
+          return value.split(": ",2).last
         end
       end
       
@@ -197,7 +214,6 @@ class FPM::Package::Deb < FPM::Package
 
   def extract_files(package)
     # Find out the compression type
-    p `ar t #{package}`
     compression = `ar t #{package}`.split("\n").grep(/data.tar/).first.split(".").last
     case compression
       when "gz"
@@ -221,6 +237,7 @@ class FPM::Package::Deb < FPM::Package
   end # def extract_files
 
   def output(output_path)
+    output_check(output_path)
     # Abort if the target path already exists.
     raise FileAlreadyExists.new(output_path) if File.exists?(output_path)
 
@@ -244,7 +261,14 @@ class FPM::Package::Deb < FPM::Package
         raise FPM::InvalidPackageConfiguration,
           "Unknown compression type '#{self.attributes[:deb_compression]}'"
     end
-    safesystem(tar_cmd, "-C", staging_path, compression, "-cf", datatar, ".")
+    tar_flags = []
+    if !attributes[:deb_user].nil?
+      tar_flags += [ "--owner", attributes[:deb_user] ]
+    end
+    if !attributes[:deb_group].nil?
+      tar_flags += [ "--group", attributes[:deb_group] ]
+    end
+    safesystem(tar_cmd, "-C", staging_path, compression, *tar_flags, "-cf", datatar, ".")
 
     # pack up the .deb, which is just an 'ar' archive with 3 files
     # the 'debian-binary' file has to be first
@@ -270,6 +294,12 @@ class FPM::Package::Deb < FPM::Package
     end.flatten
   end # def converted_from
 
+  def debianize_op(op)
+    # Operators in debian packaging are <<, <=, =, >= and >>
+    # So any operator like < or > must be replaced
+    {:< => "<<", :> => ">>"}[op.to_sym] or op
+  end
+
   def fix_dependency(dep)
     # Deb dependencies are: NAME (OP VERSION), like "zsh (> 3.0)"
     # Convert anything that looks like 'NAME OP VERSION' to this format.
@@ -280,7 +310,7 @@ class FPM::Package::Deb < FPM::Package
       name, op, version = dep.split(/ +/)
       if !version.nil?
         # Convert strings 'foo >= bar' to 'foo (>= bar)'
-        dep = "#{name} (#{op} #{version})"
+        dep = "#{name} (#{debianize_op(op)} #{version})"
       end
     end
 

data/lib/fpm/package/dir.rb

@@ -49,11 +49,13 @@ class FPM::Package::Dir < FPM::Package
   end # def input
 
   # Output this package to the given directory.
-  def output(dir)
-    dir = File.expand_path(dir)
+  def output(output_path)
+    output_check(output_path)
+
+    output_path = File.expand_path(output_path)
     ::Dir.chdir(staging_path) do
       @logger["method"] = "output"
-      clone(".", dir)
+      clone(".", output_path)
     end
   ensure
     @logger.remove("method")
@@ -110,7 +112,7 @@ class FPM::Package::Dir < FPM::Package
       begin
         @logger.debug("Linking", :source => source, :destination => destination)
         File.link(source, destination)
-      rescue Errno::EXDEV
+      rescue Errno::EXDEV, Errno::EPERM
         # Hardlink attempt failed, copy it instead
         @logger.debug("Copying", :source => source, :destination => destination)
         FileUtils.copy_entry(source, destination)

data/lib/fpm/package/pear.rb

@@ -10,6 +10,12 @@ class FPM::Package::PEAR < FPM::Package
   option "--package-name-prefix", "PREFIX",
     "Name prefix for pear package", :default => "php-pear"
 
+  option "--channel", "CHANNEL_URL",
+    "The pear channel url to use instead of the default."
+
+  option "--channel-update", :flag, 
+    "call 'pear channel-update' prior to installation"
+
   # Input a PEAR package.
   #
   # The parameter is a PHP PEAR package name.
@@ -28,18 +34,35 @@ class FPM::Package::PEAR < FPM::Package
     installroot = attributes[:prefix] || "/usr/share"
     safesystem("pear", "config-create", staging_path(installroot), config)
 
-    @logger.info("Fetching package information", :package => input_package)
+    # try channel-discover
+    if !attributes[:pear_channel].nil?
+      @logger.info("Custom channel specified", :channel => attributes[:pear_channel])
+      p ["pear", "-c", config, "channel-discover", attributes[:pear_channel]]
+      safesystem("pear", "-c", config, "channel-discover", attributes[:pear_channel])
+      input_package = "#{attributes[:pear_channel]}/#{input_package}"
+      @logger.info("Prefixing package name with channel", :package => input_package)
+    end
+
+    # do channel-update if requested
+    if attributes[:pear_channel_update?]
+      channel = attributes[:pear_channel] || "pear"
+      @logger.info("Updating the channel", :channel => channel)
+      safesystem("pear", "-c", config, "channel-update", channel)
+    end
+
     pear_cmd = "pear -c #{config} remote-info #{input_package}"
+    @logger.info("Fetching package information", :package => input_package, :command => pear_cmd)
     name = %x{#{pear_cmd} | sed -ne '/^Package\s*/s/^Package\s*//p'}.chomp
     self.name = "#{attributes[:pear_package_name_prefix]}-#{name}"
     self.version = %x{#{pear_cmd} | sed -ne '/^Latest\s*/s/^Latest\s*//p'}.chomp
     self.description  = %x{#{pear_cmd} | sed -ne '/^Summary\s*/s/^Summary\s*//p'}.chomp
+    @logger.debug("Package info", :name => self.name, :version => self.version,
+                  :description => self.description)
 
     @logger.info("Installing pear package", :package => input_package,
                   :directory => staging_path)
     ::Dir.chdir(staging_path) do
-      safesystem("pear", "-c", config, "install", "-n", "-f", "-P", ".",
-                 input_package)
+      safesystem("pear", "-c", config, "install", "-n", "-f", input_package)
     end
  
     # Remove the stuff we don't want

data/lib/fpm/package/python.rb

@@ -47,6 +47,9 @@ class FPM::Package::Python < FPM::Package
     "Want to what your target platform is using? Run this: " \
     "python -c 'from distutils.sysconfig import get_python_lib; " \
     "print get_python_lib()'"
+  option "--install-data", "DATA_PATH", "The path to where data should be." \
+    "installed to. This is equivalent to 'python setup.py --install-data " \
+    "DATA_PATH"
 
   private
 
@@ -188,13 +191,16 @@ class FPM::Package::Python < FPM::Package
       @logger.info("Setting default :python_install_lib attribute",
                    :value => attributes[:python_install_lib])
     end
+    if attributes[:python_install_data].nil?
+      attributes[:python_install_data] = attributes[:python_install_lib]
+    end
     # Some setup.py's assume $PWD == current directory of setup.py, so let's
     # chdir first.
     ::Dir.chdir(project_dir) do
       safesystem(attributes[:python_bin], "setup.py", "install",
                  "--root", staging_path, 
                  "--install-lib", File.join(prefix, attributes[:python_install_lib]),
-                 "--install-data", File.join(prefix, attributes[:python_install_lib]),
+                 "--install-data", File.join(prefix, attributes[:python_install_data]),
                  "--install-scripts", File.join(prefix, attributes[:python_install_bin]))
     end
   end # def install_to_staging

data/lib/fpm/package/rpm.rb

@@ -173,6 +173,8 @@ class FPM::Package::RPM < FPM::Package
   end # def input
 
   def output(output_path)
+    output_check(output_path)
+    raise FileAlreadyExists.new(output_path) if File.exists?(output_path)
     %w(BUILD RPMS SRPMS SOURCES SPECS).each { |d| FileUtils.mkdir_p(build_path(d)) }
     args = ["rpmbuild", "-bb",
       "--define", "buildroot #{build_path}/BUILD",

data/lib/fpm/package/tar.rb

@@ -47,6 +47,8 @@ class FPM::Package::Tar < FPM::Package
   # If the output path ends predictably (like in .tar.gz) it will try to obey
   # the compression type.
   def output(output_path)
+    output_check(output_path)
+    raise FileAlreadyExists.new(output_path) if File.exists?(output_path)
     # Unpack the tarball to the staging path
     args = ["-cf", output_path, "-C", staging_path, "."]
     with(tar_compression_flag(output_path)) do |flag|

data/templates/deb.erb

@@ -6,7 +6,7 @@ Architecture: <%= architecture %>
 Maintainer: <%= maintainer  %>
 Installed-Size: <%= attributes[:deb_installed_size] %>
 <% if !dependencies.empty? -%>
-Depends: <%= dependencies.join(", ") %>
+Depends: <%= dependencies.collect { |d| fix_dependency(d) }.flatten.join(", ") %>
 <% end -%>
 <% if !conflicts.empty? -%>
 Conflicts: <%= conflicts.join(", ") %>
@@ -22,7 +22,7 @@ Provides: <%= provides.join(", ") %>
 Replaces: <%= replaces.join(", ") %>
 <% end -%>
 Section: <%= category %>
-Priority: extra
+Priority: <%= attributes[:deb_priority] %>
 Homepage: <%= url or "http://nourlgiven.example.com/" %>
 <% lines = (description or "no description given").split("\n") -%>
 <% firstline, *remainder = lines -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fpm
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.4.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -149,28 +149,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/fpm/command.rb
+- lib/fpm/namespace.rb
+- lib/fpm/package.rb
 - lib/fpm/errors.rb
-- lib/fpm/package/npm.rb
-- lib/fpm/package/python.rb
-- lib/fpm/package/solaris.rb
-- lib/fpm/package/dir.rb
 - lib/fpm/package/gem.rb
-- lib/fpm/package/pear.rb
-- lib/fpm/package/puppet.rb
-- lib/fpm/package/pyfpm/__init__.py
-- lib/fpm/package/pyfpm/__init__.pyc
-- lib/fpm/package/pyfpm/get_metadata.pyc
+- lib/fpm/package/dir.rb
 - lib/fpm/package/pyfpm/get_metadata.py
-- lib/fpm/package/tar.rb
+- lib/fpm/package/pyfpm/__init__.py
+- lib/fpm/package/npm.rb
+- lib/fpm/package/pear.rb
 - lib/fpm/package/deb.rb
+- lib/fpm/package/python.rb
 - lib/fpm/package/rpm.rb
+- lib/fpm/package/puppet.rb
+- lib/fpm/package/tar.rb
+- lib/fpm/package/solaris.rb
 - lib/fpm/util.rb
-- lib/fpm/package.rb
-- lib/fpm/namespace.rb
-- lib/fpm/command.rb
 - lib/fpm.rb
-- bin/fpm
 - bin/fpm-npm
+- bin/fpm
 - templates/deb.erb
 - templates/rpm.erb
 - templates/solaris.erb