fpm 0.4.3 → 0.4.4

data/CHANGELIST

@@ -1,3 +1,23 @@
+0.4.4 (March 30, 2012)
+  - Fix a bug in gem bin_dir handling (Calen Pennington)
+  - The --config-files flag should work again (Brian Akins)
+  - Fix syntax error when using --deb-pre-depends (Andrew Bennett)
+  - Make --exclude work again (#185, #186) (Calen Pennington)
+  - Fix file listing so that rpm packages don't declare ownership on / and
+    /usr, etc.
+  - make --deb-custom-control to work again (Tor Arne Vestbø)
+  - Add --rpm-digest flag to allow selection of the rpm 'file name' digest
+    algorithm. Default is 'md5' since it works on the most rpm systems.
+  - Reimplement old behavior assuming "." as the input when using '-s dir' and
+    also setting -C (#187)
+  - Set BuildRoot on rpm to work around an rpmbuild bug(?) on CentOS 5 (#191)
+  - Add --rpm-compression flag to allow selection of the rpm payload
+    compression. Default is 'gzip' since it works on the most rpm systems
+  - Specs now pass on ubuntu/32bit systems (found by travis-ci.org's test runner)
+  - Improve default values of iteration and epoch (#190)
+  - Make FPM::Package#files list only 'leaf' nodes (files, empty directories,
+    symlinks, etc).
+
 0.4.3 (March 21, 2012)
   - Fix bug in python packaging when invoked with a relative path to a setup.py
     (Reported by Thomas Meson, https://github.com/jordansissel/fpm/pull/180)

data/lib/fpm/command.rb

@@ -41,11 +41,10 @@ class FPM::Command < Clamp::Command
     :default => 1.0
   option "--iteration", "ITERATION",
     "The iteration to give to the package. RPM calls this the 'release'. " \
-    "FreeBSD calls it 'PORTREVISION'. Debian calls this 'debian_revision'",
-    :default => "1"
+    "FreeBSD calls it 'PORTREVISION'. Debian calls this 'debian_revision'"
   option "--epoch", "EPOCH",
     "The epoch value for this package. RPM and Debian calls this 'epoch'. " \
-    "FreeBSD calls this 'PORTEPOCH'", :default => "1"
+    "FreeBSD calls this 'PORTEPOCH'"
   option "--license", "LICENSE",
     "(optional) license name for this package"
   option "--vendor", "VENDOR",
@@ -95,9 +94,11 @@ class FPM::Command < Clamp::Command
   option ["-e", "--edit"], :flag,
     "Edit the package spec before building.", :default => false
   option ["-x", "--exclude"], "EXCLUDE_PATTERN",
-    "Exclude paths matching pattern (shell wildcard globs valid here)" do |val|
-    @exclude_pattern ||= []
-    @exclude_pattern << val
+    "Exclude paths matching pattern (shell wildcard globs valid here). " \
+    "If you have multiple file patterns to exclude, specify this flag " \
+    "multiple times.", :attribute_name => :excludes do |val|
+    @excludes ||= []
+    @excludes << val
   end # -x / --exclude
   option "--description", "DESCRIPTION", "Add a description for this package.",
     :default => "no description"
@@ -173,6 +174,7 @@ class FPM::Command < Clamp::Command
     @provides = []
     @dependencies = []
     @config_files = []
+    @excludes = []
   end # def initialize
 
   # Execute this command. See Clamp::Command#execute and Clamp's documentation
@@ -181,6 +183,15 @@ class FPM::Command < Clamp::Command
     @logger.subscribe(STDOUT)
     @logger.level = :warn
 
+    # Some older behavior, if you specify:
+    #   'fpm -s dir -t ... -C somepath'
+    # fpm would assume you meant to add '.' to the end of the commandline.
+    # Let's hack that. https://github.com/jordansissel/fpm/issues/187
+    if input_type == "dir" and args.empty? and !chdir.nil?
+      @logger.info("No args, but -s dir and -C are given, assuming '.' as input") 
+      args << "."
+    end
+
     validator = Validator.new(self)
     if !validator.ok?
       validator.messages.each do |message|
@@ -277,7 +288,8 @@ class FPM::Command < Clamp::Command
     input.dependencies += dependencies
     input.provides += provides
     input.replaces += replaces
-
+    input.config_files += config_files
+    
     setscript = proc do |scriptname|
       path = self.send(scriptname)
       # Skip scripts not set
@@ -285,7 +297,7 @@ class FPM::Command < Clamp::Command
 
       # 'self.send(scriptname) == self.before_install == --before-install
       if !File.exists?(path)
-        $stderr.puts("No such file (for #{scriptname.to_s}): #{path.inspect}")
+        @logger.error("No such file (for #{scriptname.to_s}): #{path.inspect}")
         return 1
       end
       input.scripts[scriptname] = File.read(path)
@@ -295,7 +307,14 @@ class FPM::Command < Clamp::Command
     setscript.call(:after_install)
     setscript.call(:before_remove)
     setscript.call(:after_remove)
-    
+
+    # Validate the package
+    if input.name.nil? or input.name.empty?
+      @logger.fatal("No name given for this package (set name with, " \
+                    "for example, '-n packagename')")
+      return 1
+    end
+
     # Convert to the output type
     output = input.convert(output_class)
 

data/lib/fpm/package.rb

@@ -82,6 +82,9 @@ class FPM::Package
   # (Not all packages support this)
   attr_accessor :replaces
 
+  # Array of glob patterns to exclude from this package
+  attr_accessor :excludes
+
   # a summary or description of the package
   attr_accessor :description
 
@@ -170,6 +173,9 @@ class FPM::Package
   # Convert this package to a new package type
   def convert(klass)
     @logger.info("Converting #{self.type} to #{klass.type}")
+
+    exclude
+
     pkg = klass.new
     pkg.cleanup_staging # purge any directories that may have been created by klass.new
 
@@ -266,15 +272,29 @@ class FPM::Package
   #
   # The paths will all be relative to staging_path and will not include that
   # path.
+  # 
+  # This method will emit 'leaf' paths. Files, symlinks, and other file-like
+  # things are emitted. Intermediate directories are ignored, but
+  # empty directories are emitted.
   def files
-    # Find will print the path you're searching first, so skip it and return
-    # the rest. Also trim the leading path such that '#{staging_path}/' is removed
-    # from the path before returning.
+    is_leaf = lambda do |path|
+      # True if this is a file/symlink/etc, but not a plain directory
+      return true if !(File.directory?(path) and !File.symlink?(path))
+      # Empty directories are leafs as well.
+      return true if ::Dir.entries(path).sort == [".", ".."]
+      # False otherwise (non-empty directory, etc)
+      return false
+    end # is_leaf
+
+    # Find all leaf-like paths (files, symlink, empty directories, etc)
+    # Also trim the leading path such that '#{staging_path}/' is removed from
+    # the path before returning.
     #
     # Wrapping Find.find in an Enumerator is required for sane operation in ruby 1.8.7,
     # but requires the 'backports' gem (which is used in other places in fpm)
     return Enumerator.new { |y| Find.find(staging_path) { |path| y << path } } \
       .select { |path| path != staging_path } \
+      .select { |path| is_leaf.call(path) } \
       .collect { |path| path[staging_path.length + 1.. -1] }
   end # def files
  
@@ -311,6 +331,26 @@ class FPM::Package
     end
   end # def edit_file
 
+  # This method removes excluded files from the staging_path. Subclasses can
+  # remove the files during the input phase rather than deleting them here
+  def exclude
+    if @attributes.include?(:prefix)
+      installdir = staging_path(@attributes[:prefix])
+    else
+      installdir = staging_path
+    end
+
+    attributes[:excludes].each do |wildcard|
+      @logger.debug("Checking for things to exclude", :wildcard => wildcard)
+      files.each do |file|
+        if File.fnmatch(wildcard, file)
+          @logger.info("Removing excluded file", :path => file, :matches => wildcard)
+          FileUtils.remove_entry_secure(staging_path(file))
+        end
+      end
+    end
+  end # def exclude
+
 
   class << self
     # This method is invoked when subclass occurs.

data/lib/fpm/package/deb.rb

@@ -25,7 +25,7 @@ class FPM::Package::Deb < FPM::Package
             "version of a package but any iteration is permitted"
 
   option "--pre-depends", "DEPENDENCY",
-    "Add DEPENDENCY as a Pre-Depends" do |val|
+    "Add DEPENDENCY as a Pre-Depends" do |dep|
     @pre_depends ||= []
     @pre_depends << dep
   end
@@ -310,7 +310,7 @@ class FPM::Package::Deb < FPM::Package
       @logger.info("No deb_installed_size set, calculating now.")
       total = 0
       Find.find(staging_path) do |path|
-        stat = File.stat(path)
+        stat = File.lstat(path)
         next if stat.directory?
         total += stat.size
       end
@@ -322,9 +322,9 @@ class FPM::Package::Deb < FPM::Package
 
     # Write the control file
     with(control_path("control")) do |control|
-      if attributes["deb-custom-control"] 
-        @logger.debug("Using '#{attributes["deb-custom-control"]}' template for the control file")
-        control_data = File.read(attributes["deb-custom-control"])
+      if attributes[:deb_custom_control]
+        @logger.debug("Using '#{attributes[:deb_custom_control]}' template for the control file")
+        control_data = File.read(attributes[:deb_custom_control])
       else
         @logger.debug("Using 'deb.erb' template for the control file")
         control_data = template("deb.erb").result(binding)

data/lib/fpm/package/dir.rb

@@ -74,16 +74,16 @@ class FPM::Package::Dir < FPM::Package
   def clone(source, destination)
     # Copy all files from 'path' into staging_path
 
-    Find.find(source) do |file|
-      next if source == file && File.directory?(file) # ignore the directory itself
-      target = File.join(destination, file)
-      copy(file, target)
+    Find.find(source) do |path|
+      target = File.join(destination, path)
+      copy(path, target)
     end
   end # def clone
 
-  # Copy, recursively, from source to destination.
+  # Copy a path.
   #
   # Files will be hardlinked if possible, but copied otherwise.
+  # Symlinks should be copied as symlinks.
   def copy(source, destination)
     directory = File.dirname(destination)
     if !File.directory?(directory)
@@ -93,7 +93,9 @@ class FPM::Package::Dir < FPM::Package
     # Create a directory if this path is a directory
     if File.directory?(source) and !File.symlink?(source)
       @logger.debug("Creating", :directory => destination)
-      FileUtils.mkdir(destination)
+      if !File.directory?(destination)
+        FileUtils.mkdir(destination)
+      end
     else
       # Otherwise try copying the file.
       begin
@@ -102,7 +104,7 @@ class FPM::Package::Dir < FPM::Package
       rescue Errno::EXDEV
         # Hardlink attempt failed, copy it instead
         @logger.debug("Copying", :source => source, :destination => destination)
-        FileUtils.copy(source, destination)
+        FileUtils.copy_entry(source, destination)
       end
     end
   end # def copy

data/lib/fpm/package/gem.rb

@@ -172,6 +172,7 @@ class FPM::Package::Gem < FPM::Package
     if attributes[:gem_bin_path]
       bin_path = File.join(staging_path, attributes[:gem_bin_path])
       args += ["--bindir", bin_path]
+      ::FileUtils.mkdir_p(bin_path)
     end
 
     args << gem_path

data/lib/fpm/package/rpm.rb

@@ -15,14 +15,52 @@ require "arr-pm/file" # gem 'arr-pm'
 # * :rpm_rpmbuild_define - an array of definitions to give to rpmbuild.
 #   These are used, verbatim, each as: --define ITEM
 class FPM::Package::RPM < FPM::Package
+  DIGEST_ALGORITHM_MAP = {
+    "md5" => 1,
+    "sha1" => 2,
+    "sha256" => 8,
+    "sha384" => 9,
+    "sha512" => 10
+  }
+
+  COMPRESSION_MAP = {
+    "xz" => "w2.xzdio",
+    "gzip" => "w9.gzdio",
+    "bzip2" => "w9.bzdio"
+  }
+
+
   option "--rpmbuild-define", "DEFINITION",
     "Pass a --define argument to rpmbuild." do |define|
     attributes[:rpm_rpmbuild_define] ||= []
     attributes[:rpm_rpmbuild_define] << define
   end
 
+  option "--digest", DIGEST_ALGORITHM_MAP.keys.join("|"),
+    "Select a digest algorithm. md5 works on the most platforms.",
+    :default => "md5" do |value|
+    if !DIGEST_ALGORITHM_MAP.include?(value.downcase)
+      raise "Unknown digest algorithm '#{value}'. Valid options " \
+        "include: #{DIGEST_ALGORITHM_MAP.keys.join(", ")}"
+    end
+    value.downcase
+  end
+
+  option "--compression", COMPRESSION_MAP.keys.join("|"),
+    "Select a compression method. gzip works on the most platforms.",
+    :default => "gzip" do |value|
+    if !COMPRESSION_MAP.include?(value.downcase)
+      raise "Unknown compression type '#{value}'. Valid options " \
+        "include: #{COMPRESSION_MAP.keys.join(", ")}"
+    end
+    value.downcase
+  end
+
   private
 
+  # Handle any architecture naming conversions.
+  # For example, debian calls amd64 what redhat calls x86_64, this
+  # method fixes those types of things.
   def architecture
     case @architecture
       when nil
@@ -39,6 +77,11 @@ class FPM::Package::RPM < FPM::Package
     end
   end # def architecture
 
+  # This method ensures a default value for iteration if none is provided.
+  def iteration
+    return @iteration ? @iteration : 1
+  end # def iteration
+
   # See FPM::Package#converted_from
   def converted_from(origin)
     if origin == FPM::Package::Gem
@@ -141,5 +184,14 @@ class FPM::Package::RPM < FPM::Package
     return super(format)
   end # def to_s
 
-  public(:input, :output, :converted_from, :architecture, :to_s)
+  def payload_compression
+    return COMPRESSION_MAP[attributes[:rpm_compression]]
+  end # def payload_compression
+
+  def digest_algorithm
+    return DIGEST_ALGORITHM_MAP[attributes[:rpm_digest]]
+  end # def digest_algorithm
+
+  public(:input, :output, :converted_from, :architecture, :to_s, :iteration,
+         :payload_compression, :digest_algorithm)
 end # class FPM::Package::RPM

data/templates/rpm.erb

@@ -8,6 +8,12 @@
 # Disable checking for unpackaged files ?
 #%undefine __check_files
 
+# Use <%= attributes[:rpm_digest] %> file digest method
+%define _binary_filedigest_algorithm <%= digest_algorithm %>
+
+# Use <%= attributes[:rpm_compression] %> payload compression
+%define _binary_payload <%= payload_compression %> 
+
 Name: <%= name %>
 Version: <%= version %>
 <% if epoch -%>
@@ -18,6 +24,9 @@ Release: <%= iteration or 1 %>
 Summary: <%= description.split("\n").first.empty? ? "_" :  description.split("\n").first %>
 BuildArch: <%= architecture %>
 AutoReqProv: no
+# Seems specifying BuildRoot is required on older rpmbuild (like on CentOS 5)
+# fpm passes '--define buildroot ...' on the commandline, so just reuse that.
+BuildRoot: %buildroot
 
 Group: <%= category %>
 License: <%= license %>
@@ -94,10 +103,11 @@ fi
 <% end -%>
 <%# list only files, not directories? -%>
 <%= 
-  # Reject directories or config files already listed, then prefix files with
-  # "/", then make sure paths with spaces are quoted. I hate rpm so much.
-  files.reject { |f| x = File.join(staging_path, f); File.directory?(x) && !File.symlink?(x) } \
-    .collect { |f| "/#{f}" } \
+  # Reject config files already listed or parent directories, then prefix files
+  # with "/", then make sure paths with spaces are quoted. I hate rpm so much.
+
+  # 'files' here is the method FPM::Package#files.
+  files.collect { |f| "/#{f}" } \
     .reject { |f| config_files.include?(f) } \
     .collect { |f| f[/\s/] and "\"#{f}\"" or f } \
     .join("\n") 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fpm
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000 Z
+date: 2012-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.18
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: fpm - package building and mangling