tara 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99f4bc434bfa007f054a82265445cd9846937302
-  data.tar.gz: 270a01f1559d5747ecc0d50834ba1b0b98336a39
+  metadata.gz: b6ef9fe204be70664e2bbbfe3233e05e90a7f937
+  data.tar.gz: 843fe69f1d2c59112dd1c727ee9e5e0aa4ac8bf6
 SHA512:
-  metadata.gz: dc93d8fc594db3d1c1f0a415166f3ac5b9151034b7f7d7fefff32b8f244c882a93c64709878b2f8d392659018592710a160457402efaafdd3b3e6819d2b43192
-  data.tar.gz: 156522d2729c5ca0ffe381d183030add5dd930ccda05eeb07d4efaae8cc4af147969b0397f4788231efdd694e8ec22c97a165adc33eec2a868ff4f0fa131bc8b
+  metadata.gz: 82977fc6aacec266f7ce3a4a525cbe42029a1bdc3ec6c2533aa26406c3e3e27a668b55cb2f1dd4333b425b7d9d62dd8be68c85896d9863c1b09f800efbf8f7bb
+  data.tar.gz: ec39e9ef990d76d91b252db3cfa8186f6a38e3108fe9db65896b9c1c28bd43a028e2f0d645edc370930bdd9a81cd3429fad531365fe1d78ccfbe00392e71bb25

data/lib/tara/archive.rb

@@ -1,13 +1,61 @@
 # encoding: utf-8
 
 module Tara
+  # Packs an application along with a Ruby runtime and dependencies into a TAR archive.
+  #
+  # The archive will include the source code of your project (which is assumed to
+  # be in the `lib` directory), wrapper scripts for each executable (assumed to be
+  # in the `bin` directory), and all gems that aren't in the `test` or `development`
+  # groups in your project's Gemfile.
+  #
+  # @example Creating an archive from a Rake task
+  #   task :archive do
+  #     Tara::Archive.new.create
+  #   end
+  #
+  # @example Configuring the archive to be created
+  #   task :archive do
+  #     archive = Tara::Archive.new(
+  #       target: 'osx',
+  #       traveling_ruby_version: '20150204',
+  #       without_groups: %w[test],
+  #     )
+  #     archive.create
+  #   end
+  #
   class Archive
+    # Create a new instance of `Archive` with the specified configuration.
+    #
+    # Tara attempts to use sane defaults in most of all cases, for example like
+    # assuming that the source code is in the `lib` directory of your project,
+    # that the name of the application is the same as the project directory.
+    #
+    # @param [Hash] config
+    # @option config [String] :app_dir (Dir.pwd) absolute path to the application
+    #   directory.
+    # @option config [String] :app_name (File.basename(@config[:app_dir])) name of
+    #   the application.
+    # @option config [String] :build_dir (File.join(@config[:app_dir], 'build'))
+    #   the directory where the archive will be created.
+    # @option config [String] :download_dir (File.join(@config[:build_dir], 'downloads'))
+    #   the directory where Traveling Ruby artifacts will be downloaded.
+    # @option config [String] :archive_name (@config[:app_name] + '.tgz') name of the archive
+    # @option config [Array<String>] :files (%w[lib/**/*.rb]) list of globs that will be
+    #   expanded when including source files in archive. Should be relative from :app_dir.
+    # @option config [Array<String>] :executables (%w[bin/*]) list of globs that will be
+    #   expanded when including executables in archive. Should be relative from :app_dir.
+    # @option config [String] :target (linux-x86_64) target platform that the archive will
+    #   be created for. Should be one of "linux-x86", "linux-x86_64", or "osx".
+    # @option config [String] :traveling_ruby_version (20150210) release of Traveling Ruby
+    #   that should be used.
+    # @option config [Array<String>] :without_groups (%w[development test]) list of gem
+    #   groups to exclude from the archive.
+    #
     def initialize(config={})
       @config = config
       @config[:app_dir] ||= Dir.pwd
       @config[:app_name] ||= File.basename(@config[:app_dir])
       @config[:build_dir] ||= File.join(@config[:app_dir], 'build')
-      @config[:target_dir] ||= @config[:build_dir]
       @config[:download_dir] ||= File.join(@config[:build_dir], 'downloads')
       @config[:archive_name] ||= @config[:app_name] + '.tgz'
       @config[:files] ||= %w[lib/**/*.rb]
@@ -17,22 +65,31 @@ module Tara
       @config[:without_groups] ||= %w[development test]
     end
 
+    # Short for `Archive.new(config).create`
+    #
+    # @return [String] Path to the archive
+    #
     def self.create(config={})
       new(config).create
     end
 
+
+    # Create an archive using the instance's configuration.
+    #
+    # @return [String] Path to the archive
+    #
     def create
       Dir.mktmpdir do |tmp_dir|
         project_dir = Pathname.new(@config[:app_dir])
         package_dir = Pathname.new(tmp_dir)
-        target_dir = Pathname.new(@config[:target_dir])
+        build_dir = Pathname.new(@config[:build_dir])
         install_dependencies(package_dir, fetcher)
         copy_source(project_dir, package_dir)
         copy_executables(project_dir, package_dir)
         Dir.chdir(tmp_dir) do
-          create_archive(target_dir)
+          create_archive(build_dir)
         end
-        File.join(target_dir, @config[:archive_name])
+        File.join(build_dir, @config[:archive_name])
       end
     end
 
@@ -53,15 +110,16 @@ module Tara
         Pathname.glob(project_dir.join(executable_glob)).each do |executable|
           copy_file(project_dir, package_dir, executable)
           FileUtils.chmod(0755, package_dir.join(executable))
-          create_exec_wrapper(package_dir, executable)
+          relative_executable = executable.relative_path_from(project_dir)
+          create_exec_wrapper(package_dir, relative_executable)
         end
       end
     end
 
-    def create_archive(target_dir)
+    def create_archive(build_dir)
       Shell.exec('tar -czf %s %s' % [@config[:archive_name], Dir['*'].join(' ')])
-      FileUtils.mkdir_p(target_dir)
-      FileUtils.cp(@config[:archive_name], target_dir)
+      FileUtils.mkdir_p(build_dir)
+      FileUtils.cp(@config[:archive_name], build_dir)
     end
 
     def fetcher
@@ -82,7 +140,7 @@ module Tara
 
     def create_exec_wrapper(package_dir, executable)
       wrapper_path = package_dir.join(executable.basename)
-      ex = Executable.new(executable.basename)
+      ex = Executable.new(*executable.split)
       File.open(wrapper_path, 'w') { |f| ex.write(f) }
       FileUtils.chmod(0755, wrapper_path)
     end

data/lib/tara/archiver.rb

@@ -1,25 +1,80 @@
 # encoding: utf-8
 
 module Tara
+  # Jara compatible Archiver class that makes it easy to release artiftacts using
+  # Tara and Jara.
+  #
+  # @example Release an artifact from a Rake task
+  #   task :release do
+  #     archiver = Tara::Archiver.new
+  #     releaser = Jara::Releaser.new('production', 'artifact-bucket', archiver: archiver)
+  #     releaser.release
+  #   end
+  #
   class Archiver
-    def initialize(options={})
-      @options = options
+    # Create a new instance of `Archiver` with the specified configuration.
+    #
+    # The `Archiver` class supports the same configuration as {Archive#initialize}
+    # does, with the addition of a `:metadata` option.
+    #
+    # @param [Hash] config
+    # @option config [String] :app_dir (Dir.pwd) absolute path to the application
+    #   directory.
+    # @option config [String] :app_name (File.basename(@config[:app_dir])) name of
+    #   the application.
+    # @option config [String] :build_dir (File.join(@config[:app_dir], 'build'))
+    #   the directory where the archive will be created.
+    # @option config [String] :download_dir (File.join(@config[:build_dir], 'downloads'))
+    #   the directory where Traveling Ruby artifacts will be downloaded.
+    # @option config [String] :archive_name (@config[:app_name] + '.tgz') name of the archive
+    # @option config [Array<String>] :files (%w[lib/**/*.rb]) list of globs that will be
+    #   expanded when including source files in archive. Should be relative from `:app_dir`.
+    # @option config [Array<String>] :executables (%w[bin/*]) list of globs that will be
+    #   expanded when including executables in archive. Should be relative from `:app_dir`.
+    # @option config [String] :target (linux-x86_64) target platform that the archive will
+    #   be created for. Should be one of "linux-x86", "linux-x86_64", or "osx".
+    # @option config [String] :traveling_ruby_version (20150210) release of Traveling Ruby
+    #   that should be used.
+    # @option config [Array<String>] :without_groups (%w[development test]) list of gem
+    #   groups to exclude from the archive.
+    # @option config [Hash] :metadata ({}) addidtional metadata that the
+    #   published artifact will be tagged with.
+    #
+    def initialize(config={})
+      @config = config
+      @config[:metadata] ||= {}
     end
 
+    # Create a new archive
+    #
+    # @return [String] Path to the created archive
+    #
     def create(options={})
-      Archive.create(@options.merge(options))
+      Archive.create(@config.merge(options))
     end
 
+    # Extension used by this archiver
+    #
+    # @return [String] 'tgz'
+    #
     def extension
-      @options[:extension] || 'tgz'
+      'tgz'
     end
 
+    # Content type used by this archiver
+    #
+    # @return [String] 'application/x-gzip'
+    #
     def content_type
       'application/x-gzip'
     end
 
+    # Metadata that the published artifact will be tagged with.
+    #
+    # @return [Hash] Hash of key-value pairs that will be used as tags.
+    #
     def metadata
-      @options[:metadata] || {}
+      @config[:metadata]
     end
   end
 end

data/lib/tara/cli.rb

@@ -4,6 +4,7 @@ require 'optparse'
 
 
 module Tara
+  # @private
   class Cli
     def initialize(argv=ARGV, io=$stderr)
       @argv = argv

data/lib/tara/executable.rb

@@ -1,25 +1,27 @@
 # encoding: utf-8
 
 module Tara
+  # @private
   class Executable
-    def initialize(name)
+    def initialize(dirpath, name)
+      @dirpath = dirpath
       @name = name
     end
 
     def write(io)
-      io.puts(script(@name))
+      io.puts(script_template)
     end
 
     private
 
-    def script(name)
+    def script_template
       <<-EOH.gsub(/^\s+/, '')
         #!/bin/bash
         set -e
         SELF_DIR=$(dirname "$0")
         export BUNDLE_GEMFILE="$SELF_DIR/lib/vendor/Gemfile"
         unset BUNDLE_IGNORE_CONFIG
-        exec "$SELF_DIR/lib/ruby/bin/ruby" -rbundler/setup "$SELF_DIR/bin/#{name}" "$@"
+        exec "$SELF_DIR/lib/ruby/bin/ruby" -rbundler/setup "$SELF_DIR/#{@dirpath}/#{@name}" "$@"
       EOH
     end
   end

data/lib/tara/fetcher.rb

@@ -4,6 +4,7 @@ require 'net/http'
 
 
 module Tara
+  # @private
   class Fetcher
     def initialize(download_dir, target, tr_version, options={})
       @download_dir = download_dir

data/lib/tara/installer.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Tara
+  # @private
   class Installer
     def initialize(package_dir, fetcher, options={})
       @package_dir = package_dir
@@ -46,9 +47,9 @@ module Tara
           Dir['vendor/ruby/*/extensions/*'].each do |ext_file|
             FileUtils.rm_rf(ext_file)
           end
-          @shell.exec('find vendor/ruby/*/gems -name "*.o" -exec rm {} \; 2>&1 || true')
-          @shell.exec('find vendor/ruby/*/gems -name "*.so" -exec rm {} \; 2>&1 || true')
-          @shell.exec('find vendor/ruby/*/gems -name "*.bundle" -exec rm {} \; 2>&1 || true')
+          @shell.exec('find vendor/ruby/*/gems -name "*.o" -exec rm {} \; 2> /dev/null || true')
+          @shell.exec('find vendor/ruby/*/gems -name "*.so" -exec rm {} \; 2> /dev/null || true')
+          @shell.exec('find vendor/ruby/*/gems -name "*.bundle" -exec rm {} \; 2> /dev/null || true')
           FileUtils.cp_r('vendor', lib_path, preserve: true)
         end
       end
@@ -65,7 +66,7 @@ module Tara
       native_gems = find_native_gems
       native_gems.each do |name, version|
         gem_archive_path = @fetcher.fetch_native_gem(name, version)
-        @shell.exec %(tar -xzf #{gem_archive_path} -C #{ruby_vendor_path})
+        @shell.exec(%(tar -xzf #{gem_archive_path} -C #{ruby_vendor_path}))
       end
     end
 
@@ -106,20 +107,20 @@ module Tara
 
     def strip_leftovers
       %w[c cpp h rl].each do |ext|
-        @shell.exec(%(find #{ruby_vendor_path} -name "*.#{ext}" -exec rm {} \\; 2>&1))
+        @shell.exec(%(find #{ruby_vendor_path} -name "*.#{ext}" -exec rm {} \\; 2> /dev/null))
       end
-      @shell.exec(%(find #{ruby_vendor_path} -name "extconf.rb" -exec rm {} \\;))
-      @shell.exec(%(find #{vendor_gems_glob.join('*', 'ext')} -name "Makefile" -exec rm {} \\; 2>&1))
-      @shell.exec(%(find #{vendor_gems_glob.join('*', 'ext')} -name "tmp" -type d 2>&1 | xargs rm -rf))
+      @shell.exec(%(find #{ruby_vendor_path} -name "extconf.rb" -exec rm {} \\; 2> /dev/null))
+      @shell.exec(%(find #{vendor_gems_glob.join('*', 'ext')} -name "Makefile" -exec rm {} \\; 2> /dev/null))
+      @shell.exec(%(find #{vendor_gems_glob.join('*', 'ext')} -name "tmp" -type d 2> /dev/null | xargs rm -rf))
     end
 
     def strip_java_files
-      @shell.exec(%(find #{vendor_gems_glob} -name "*.java" -exec rm {} \\;))
+      @shell.exec(%(find #{vendor_gems_glob} -name "*.java" -exec rm {} \\; 2> /dev/null))
     end
 
     def strip_git_files
-      @shell.exec(%(find #{vendor_gems_glob} -name ".git" -type d | xargs rm -rf))
-      @shell.exec(%(find #{bundler_gems_glob} -name ".git" -type d | xargs rm -rf))
+      @shell.exec(%(find #{vendor_gems_glob} -name ".git" -type d 2> /dev/null | xargs rm -rf))
+      @shell.exec(%(find #{bundler_gems_glob} -name ".git" -type d 2> /dev/null | xargs rm -rf))
     end
 
     def strip_from_gems(things)

data/lib/tara/shell.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Tara
+  # @private
   class Shell
     def self.exec(command)
       output = %x(#{command})

data/lib/tara/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Tara
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tara
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mathias Söderberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies: []
 description: Tara packs your Ruby app into a standalone archive with gems and a Ruby
   runtime