packtory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27cb2492004a82f696dfd78d5aaab669a9fa9fec7391d84a2fbe5ed049bce612
-  data.tar.gz: fa5db1bab4451e2364cdd98062157355499f33208538cd5807e3ef39bf481fc4
+  metadata.gz: 6a7d98a0c6496136f736656de91783bfaf8d3b3cea65043eb5f326145fecd013
+  data.tar.gz: 9f88ebd4c88dfbbacad221bffa3eb046c19b9035fb5e62d1279e37a2a2b7f7e1
 SHA512:
-  metadata.gz: ec25d2bd6b0c37613e070890493270f79335bb795b13659253bbc0cacb0344db49fc8a10f1e4067cfcb070c0c6dfc11ed0cdcc67ed4bc15453dd4464bd1752e2
-  data.tar.gz: 8b68c017d373c376a648d7668b516aa4ac307e3f4cfd19731f69bcd99a2b30bb28f1c9f44b2bc36b2de3e3bc225c452156db9c457449b0258edba056f6f02d9f
+  metadata.gz: 9402607bf4d7a9aea39301f8c5ecda8fd190e311c7e57bac7180da8d1b3ce643eb00562addbd0162fa6535cd5eb2735c63b62404c5de9bfb563427bdec8f948b
+  data.tar.gz: d57a1818e84972e27f11352b55f58171e29ab9b4c44e8e12007a402a31d51c6cabc4370eb53f11e4503d4f9afccbd09bb6a092a13f2d42eba02388c9372994fa

data/README.md

@@ -1,9 +1,85 @@
-## Overview
+# Overview
 
-This is packtory, an integrated, easy to use packaging tool for your
-Ruby gem, Node module, and Python module.
+This is packtory, an easy to use system packaging tool for your Ruby
+gems. Build package for Debian, RPM, and _soon_ Homebrew, directly
+from your gem repo.
 
-## State
+Support for building native extensions is available, using a post-install step of the target package.
 
-Still a work in progress. Stay tuned for when ready for human
-consumption.
+# How to use
+
+To install,
+
+```
+gem install packtory
+packtory <root_path_to_gem>
+```
+
+By default, this will build a Debian package that is compatible to install in Ubuntu and Debian.
+
+To specify the package output:
+
+```
+env PACKAGE_OUTPUT=rpm packtory
+```
+
+Additional options are available as follows:
+
+```
+; Specify a gemspec file to use
+env GEM_SPECFILE="subpath_to/gemname.gemspec" packtory <root_path_to_gem>
+
+; Specify a Gemfile to use, otherwise, packtory will auto-generate a clean one.
+env BUNDLE_GEMFILE="$build/spec/gemfiles/Gemfile.19" packtory <root_path_to_gem>
+
+; Specify the version of ruby system package
+env PACKAGE_RUBY_VERSION="2.5.1" packtory <root_path_to_gem>
+
+; Specify additional system dependencies of the generated package
+env PACKAGE_DEPENDENCIES="mysql,mysql-dev,libxml++>=2.6" packtory <root_path_to_gem>
+```
+
+# Requirements
+
+This gem depends on `fpm` to build the final system package. You will need to install it manually:
+
+```
+gem install fpm
+```
+
+And if building for RPM, you will need the package that contains the `rpmbuild` binary.
+
+```
+; In Debian/Ubuntu
+apt install rpm
+
+; In Fedora/CentOS
+yum install rpm-build
+
+; In Homebrew
+brew install rpm
+```
+
+# Compatibility
+
+If not specified, this buildpack will detect for a gemspec (\*.gemspec) file at the root path of your repo, then use that to gather the files of your gem and gem dependencies. After which, it vendorized all files to build the target package.
+
+If a gem has native extensions, the extensions are not built at the time of building the package, but rather, a post-install script is included, that builds them right after the target package is installed in the system. If any native extensions requires other system libraries, you may specify additional package dependencies to be installed prior to installing the target package.
+
+As of this version, this buildpack do not support packaging gems without a specific gemspec file.
+
+# Limitations
+
+Note, the build process will not load the code of your gem or the other dependencies. Only the code in the gemspec is loaded using the ruby version of the build environment. Please make sure the gemspec may be loaded properly, and additional code requirements are compatible.
+
+# Contribution and Improvements
+
+Please fork the code, make the changes, and submit a pull request for us to review your contributions.
+
+## Feature requests
+
+If you think it would be nice to have a particular feature that is presently not implemented, we would love to hear that and consider working on it. Just open an issue in Github.
+
+# Questions
+
+Please open a Github Issue if you have any other questions or problems.

data/bin/support/fpm

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+packtory_dir=$(cd "$(dirname $0)/../../"; pwd)
+packtory_bundle_path=$packtory_dir/bundle
+
+if [ -d "$packtory_bundle_path" ]; then
+    export PACKTORY_BUNDLE_PATH="$packtory_bundle_path"
+    fpm_ruby=$(cd "$(dirname $0)"; pwd)/fpm_vendor_ruby
+else
+    fpm_ruby="$(which fpm)"
+
+    if [ -z "$fpm_ruby" ]; then
+        fpm_ruby="fpm"
+    fi
+fi
+
+$fpm_ruby "$@"

data/bin/support/fpm_vendor_ruby

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+bundle_path = ENV['PACKTORY_BUNDLE_PATH']
+require File.join(bundle_path, 'bundler/setup.rb')
+
+require 'fpm'
+require 'fpm/command'
+
+exit(FPM::Command.run || 0)

data/lib/packtory.rb

@@ -16,4 +16,8 @@ module Packtory
   def self.gem_build_extensions_path
     File.expand_path('../../bin/support/gem_build_extensions', __FILE__)
   end
+
+  def self.bin_support_fpm_path
+    File.expand_path('../../bin/support/fpm', __FILE__)
+  end
 end

data/lib/packtory/command.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Packtory
   class Command
     def self.run(argv)
@@ -8,22 +10,22 @@ module Packtory
       if ENV['FPM_EXEC_PATH']
         @fpm_exec_path = File.expand_path(ENV['FPM_EXEC_PATH'])
       else
-        @fpm_exec_path = `which fpm`.strip
+        @fpm_exec_path = Packtory.bin_support_fpm_path
       end
 
       if @fpm_exec_path.nil? || @fpm_exec_path.empty?
-        puts 'ERROR: `fpm` executable is not in path. Perhaps, install fpm first?'
+        say 'ERROR: `fpm` executable is not in path. Perhaps, install fpm first?'
         exit 1
       end
 
       if argv[0].nil? || argv[0].empty?
-        puts 'ERROR: Build path not specified, aborting.'
+        say 'ERROR: Build path not specified, aborting.'
         exit 1
       end
 
       @build_path = File.expand_path(argv[0])
       unless File.exists?(@build_path)
-        puts 'ERROR: Build path %s do not exist, aborting.' % @build_path
+        say 'ERROR: Build path %s do not exist, aborting.' % @build_path
         exit 1
       end
 
@@ -35,6 +37,15 @@ module Packtory
       Packer.config[:fpm_exec_path] = @fpm_exec_path
       Packer.config[:path] = @build_path
 
+      if ENV['FPM_EXEC_VERBOSE'] && ENV['FPM_EXEC_VERBOSE'] == '1'
+        Packer.config[:fpm_exec_verbose] = true
+      end
+
+      if !ENV['FPM_EXEC_LOG'].nil? && !ENV['FPM_EXEC_LOG'].empty?
+        Packer.config[:fpm_exec_verbose] = true
+        Packer.config[:fpm_exec_log] = ENV['FPM_EXEC_LOG']
+      end
+
       self
     end
 
@@ -46,16 +57,16 @@ module Packtory
         end
 
         unless File.exists?(@gemspec_file)
-          puts 'ERROR: Specified gemspec file %s not found, aborting.' % @gemspec_file
+          say 'ERROR: Specified gemspec file %s not found, aborting.' % @gemspec_file
           exit 1
         end
       else
         paths = Dir.glob(File.join(@build_path, '/*.gemspec'))
         if paths.empty?
-          puts 'ERROR: No gemspec file found, aborting.'
+          say 'ERROR: No gemspec file found, aborting.'
           exit 1
         elsif paths.count > 1
-          puts 'ERROR: Multiple gemspec file found, aborting.'
+          say 'ERROR: Multiple gemspec file found, aborting.'
           exit 1
         end
 
@@ -79,14 +90,18 @@ module Packtory
         end
 
         unless File.exists?(@bundle_gemfile)
-          puts 'ERROR: Specified bundle gemfile %s not found, aborting.' % @bundle_gemfile
+          say 'ERROR: Specified bundle gemfile %s not found, aborting.' % @bundle_gemfile
           exit 1
         end
 
-        puts 'Using Gemfile    : %s' % @bundle_gemfile
+        say 'Using Gemfile    : %s' % @bundle_gemfile
         Packer.config[:gemfile] = @bundle_gemfile
       end
 
+      if ENV['BUNDLER_INCLUDE']
+        Packer.config[:bundler_include] = true
+      end
+
       self
     end
 
@@ -95,10 +110,10 @@ module Packtory
 
       if ENV['PACKAGE_RUBY_VERSION'] && !ENV['PACKAGE_RUBY_VERSION'].empty?
         @ruby_version = ENV['PACKAGE_RUBY_VERSION']
-        puts 'Using ruby deps  : %s' % @ruby_version
+        say 'Using ruby deps  : %s' % @ruby_version
       else
         @ruby_version = nil
-        puts 'Using ruby deps  : latest'
+        say 'Using ruby deps  : latest'
       end
 
       Packer.config[:dependencies]['ruby'] = @ruby_version
@@ -132,9 +147,34 @@ module Packtory
         packages << :deb
       end
 
-      puts 'Package output   : %s' % packages.join(', ')
+      say 'Package output   : %s' % packages.join(', ')
       Packer.config[:packages] = packages
 
+      if ENV['PACKAGE_PATH']
+        pkg_path = File.expand_path(ENV['PACKAGE_PATH'])
+
+        say 'Package path     : %s' % pkg_path
+        Packer.config[:pkg_path] = pkg_path
+      end
+
+      self
+    end
+
+    def test_dumpinfo(argv)
+      dump_file = File.expand_path(ENV['TEST_DUMPINFO'])
+
+      info_h = {
+        :version => ::Packtory::VERSION,
+        :fpm_version => `#{@fpm_exec_path} -v`.strip
+      }.merge(Packer.config)
+
+      File.open(dump_file, 'w') do |f|
+        f.write(YAML.dump(info_h))
+      end
+
+      say 'Created dump file: %s' % dump_file
+      say File.read(dump_file)
+
       self
     end
 
@@ -149,10 +189,15 @@ module Packtory
       detect_deps(argv)
       detect_package_output(argv)
 
-      puts '=================='
+      say '=================='
 
       Packer.setup
-      unless ENV['TEST_NOBUILD']
+
+      if ENV['TEST_DUMPINFO']
+        test_dumpinfo(argv)
+      elsif ENV['TEST_NOBUILD']
+        # do nothing
+      else
         Packer.build_package
       end
     end

data/lib/packtory/fpm_exec.rb

@@ -6,9 +6,7 @@ module Packtory
       if !Packer.config[:fpm_exec_path].nil? && !Packer.config[:fpm_exec_path].empty?
         Packer.config[:fpm_exec_path]
       else
-        fep = `which fpm`.strip
-        fep = 'fpm' if fep.empty?
-        fep
+        Packtory.bin_support_fpm_path
       end
     end
 
@@ -24,13 +22,18 @@ module Packtory
       cmd = build_cmd(sfiles_map, pkg_file, opts)
 
       Bundler.ui.info 'CMD: %s' % cmd
-      Bundler.clean_system('%s >/dev/null 2>&1' % cmd)
+
+      if Packer.config[:fpm_exec_verbose]
+        Bundler.clean_system('%s' % cmd)
+      else
+        Bundler.clean_system('%s >/dev/null 2>&1' % cmd)
+      end
 
       pkg_file
     end
 
     def build_cmd(sfiles_map, pkg_file, opts = { })
-      cmd = '%s --log warn -f -s dir' % self.class.fpm_exec_path
+      cmd = '%s --log %s -f -s dir' % [ self.class.fpm_exec_path, Packer.config[:fpm_exec_log] || 'warn' ]
 
       case opts[:type]
       when :rpm

data/lib/packtory/packer.rb

@@ -12,6 +12,7 @@ module Packtory
 
     DEFAULT_CONFIG = {
       :path => nil,
+      :pkg_path => nil,
       :gemspec => nil,
       :gemfile => nil,
       :binstub =>  nil,
@@ -26,8 +27,12 @@ module Packtory
       :bundle_working_path => nil,
 
       :fpm_exec_path => nil,
+      :fpm_exec_verbose => false,
+      :fpm_exec_log => nil,
+
       :bundler_silent => false,
-      :bundler_local => false
+      :bundler_local => false,
+      :bundler_include => false
     }
 
     DEFAULT_PACKAGES = [ :deb, :rpm ]
@@ -230,10 +235,24 @@ module Packtory
         rubygems_dir = Bundler.rubygems.gem_dir
         FileUtils.mkpath(File.join(rubygems_dir, 'specifications'))
 
+        cached_gems = { }
         @bundle_def.specs.each do |spec|
           next unless spec.source.is_a?(Bundler::Source::Rubygems)
+          cached_gems[spec.name] = spec.source.send(:cached_gem, spec)
+        end
+
+        if @opts[:bundler_include]
+          bundler_source = Bundler::Source::Rubygems.new('remotes' => 'https://rubygems.org')
+          @bundler_spec = Bundler::RemoteSpecification.
+                           new('bundler', Bundler::VERSION,
+                               Gem::Platform::RUBY, bundler_source.fetchers.first)
+          @bundler_spec.remote = Bundler::Source::Rubygems::Remote.new(bundler_source.remotes.first)
+
+          bundler_source.send(:fetch_gem, @bundler_spec)
+          cached_gems['bundler'] = bundler_source.send(:cached_gem, @bundler_spec)
+        end
 
-          cached_gem = spec.source.send(:cached_gem, spec)
+        cached_gems.each do |gem_name, cached_gem|
           installer = Gem::Installer.at(cached_gem, :path => rubygems_dir)
           installer.extract_files
           installer.write_spec
@@ -280,7 +299,11 @@ GEMFILE
     end
 
     def pkg_path
-      File.join(root_path, 'pkg')
+      if @opts[:pkg_path].nil?
+        File.join(root_path, 'pkg')
+      else
+        @opts[:pkg_path]
+      end
     end
 
     def working_path
@@ -347,42 +370,50 @@ GEMFILE
       specs = bundler_definition.specs_for([ :default ])
 
       specs.each do |spec|
-        if spec.name != 'bundler' && (gemspec.nil? || spec.name != gemspec.name)
-          orig_spec = spec
-          if spec.is_a?(Bundler::EndpointSpecification)
-            rs = spec.instance_variable_get(:@remote_specification)
-            if rs
-              spec = rs
-            elsif spec._local_specification
-              spec = spec._local_specification
-            end
+        next if gemspec.nil? || spec.name == gemspec.name
+
+        if spec.name == 'bundler'
+          if @opts[:bundler_include]
+            spec = @bundler_spec
+          else
+            next
           end
+        end
+
+        orig_spec = spec
+        if spec.is_a?(Bundler::EndpointSpecification)
+          rs = spec.instance_variable_get(:@remote_specification)
+          if rs
+            spec = rs
+          elsif spec._local_specification
+            spec = spec._local_specification
+          end
+        end
 
-          bhash = { }
+        bhash = { }
 
-          bhash[:orig_spec] = orig_spec
-          bhash[:spec] = spec
-          bhash[:gem_path] = spec.full_gem_path
+        bhash[:orig_spec] = orig_spec
+        bhash[:spec] = spec
+        bhash[:gem_path] = spec.full_gem_path
 
-          bhash[:files] = Dir.glob(File.join(spec.full_gem_path, '**/*')).inject([ ]) { |a, f|
-            unless File.directory?(f)
-              a << f.gsub('%s/' % spec.full_gem_path, '')
-            end
+        bhash[:files] = Dir.glob(File.join(spec.full_gem_path, '**/*')).inject([ ]) { |a, f|
+          unless File.directory?(f)
+            a << f.gsub('%s/' % spec.full_gem_path, '')
+          end
 
-            a
-          }.uniq
+          a
+        }.uniq
 
-          bhash[:require_paths] = spec.full_require_paths.collect { |path|
-            path.include?(bhash[:gem_path]) ?
-              path.gsub(bhash[:gem_path], '') : nil
-          }.compact
+        bhash[:require_paths] = spec.full_require_paths.collect { |path|
+          path.include?(bhash[:gem_path]) ?
+            path.gsub(bhash[:gem_path], '') : nil
+        }.compact.uniq
 
-          bgems[spec.name] = bhash
-        end
+        bgems[spec.name] = bhash
       end
 
       bgems
-  end
+    end
 
     def add_ruby_build_dependencies!
       unless @opts[:dependencies].include?('ruby-dev')

data/lib/packtory/version.rb

@@ -1,3 +1,3 @@
 module Packtory
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packtory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mark John Buenconsejo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,9 +24,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'A packtory
-
-'
+- !ruby/object:Gem::Dependency
+  name: fpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  An easy to use system packaging tool for your Ruby
+  gems. Build package for Debian, RPM, and _soon_ Homebrew, directly
+  from your gem repo.
 email: hello@gemfury.com
 executables:
 - packtory
@@ -36,6 +51,8 @@ files:
 - README.md
 - bin/packtory
 - bin/support/after_install_script
+- bin/support/fpm
+- bin/support/fpm_vendor_ruby
 - bin/support/gem_build_extensions
 - lib/packtory.rb
 - lib/packtory/command.rb
@@ -74,5 +91,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: A packtory
+summary: An easy to use system packaging tool for your Ruby gems.
 test_files: []