gem_repackager 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gem_repackager.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Nordman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Gem::Repackager
+
+Have you ever been without internet and needed a gem but it's in the wrong RVM gemset?
+How about attempting to correct a problem with a production environment and need to
+clone the exact gems available?  Perhaps you are attempting a full app stack backup
+for compliance purposes?
+
+Gem::Repackager packages one or more of your installed gems back into .gem files for
+easy transportation.  Gem::Repackager comes with a command-line utility to facilitate,
+with easy extensibility in the code as well.
+
+## Installation
+
+It's a gem, so install it. `gem install gem_repackager` or add it to bundler.
+
+## Usage
+
+The command-line utility is as follows:
+
+`gem_repackager DIRECTORY [options]`
+
+This will repackage all gems in `DIRECTORY` and place the resulting .gem files in 
+`DIRECTORY`. `DIRECTORY` refers to the location of your installed directories. Note 
+that this is the directory that contains `specifications`, `bin`, `gems`, etc,
+and not the `gems` directory itself. In RVM, this is usually along the lines of
+`~/.rvm/gems/GEMSET` or simply `$GEM_HOME`.
+
+By default, `gem_repackager` places the packaged gems into `DIRECTORY`. To change
+this, pass the `--destination DIR` parameter and the resulting gems will be moved
+there.
+
+### Options
+
+* `--gems gem-version[,gem-version,...]` - A comma-separated list of gems in "GEM-VERSION"
+* `--destination DIR` - Location to store the packaged .gem files to. If this is not
+passed, it will default to `DIRECTORY`
+* `--[no]-verbose` - Toggle verbose mode. This includes Gem::Specification warnings,
+so this could get noisy.
+
+Here's an example of packaging all gems in my current RVM gemset to a custom directory:
+
+`gem_repackager $GEM_HOME --destination=~/gem_export`
+
+And here is how you would package all of the rspec 2.11.0 gems to the default directory:
+
+`gem_repackager $GEM_HOME --gems rspec-2.11.0,rspec-core-2.11.0,rspec-expectations-2.11.2,rspec-mocks-2.11-1`
+
+## Contributing
+
+Pull requests welcome, preferably with tests because I am lazy and do not want to run
+every command to make sure changes did not break anything.
+
+## Author
+
+Written by [Andrew 'Cad' Nordman](https://github.com/cadwallion) thanks to not having
+any internet access for a week and needing to get things done.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)

data/bin/gem_repackager

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'gem_repackager'
+
+options = {
+  verbose: false
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: gem_repackager DIRECTORY [options]"
+
+  opts.on("--destination N", String, "Set custom directory for gems to be sent") do |v|
+    options[:destination] = v
+  end
+
+  opts.on('--gems x,y,z', Array, 'Comma-separated list of gem-version') do |list|
+    options[:gems] = list
+  end
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts Gem::Repackager::VERSION
+    exit
+  end
+end.parse!
+
+directory = ARGV[0]
+options[:destination] ||= directory
+
+if directory
+  packager = Gem::Repackager.new directory
+  packager.silence_warnings unless options[:verbose]
+
+  if options[:gems]
+    options[:gems].each do |gem|
+      name, version = gem.split '-'
+      spec = packager.load_spec name: name, version: version
+      filename = packager.package_gem spec
+
+      if filename
+        FileUtils.mv filename, options[:destination]
+        puts "#{gem} created at #{options[:destination]}"
+      else
+        puts "#{gem} could not be repackaged."
+      end
+    end
+  else
+    packager.package_all options[:destination]
+    puts "Gems repackaged: #{packager.gems_built.size}. Gems failed: #{packager.gems_failed.size}."
+  end
+else
+  puts "Usage: gem_repackager DIRECTORY [options]"
+end

data/gem_repackager.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/gem_repackager/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Nordman"]
+  gem.email         = ["cadwallion@gmail.com"]
+  gem.description   = %q{Repackage your installed gems}
+  gem.summary       = %q{Repackage installed gems into .gem files}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gem_repackager"
+  gem.require_paths = ["lib"]
+  gem.version       = Gem::Repackager::VERSION
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/gem_repackager.rb

@@ -0,0 +1,131 @@
+require 'gem_repackager/version'
+
+module Gem
+  module UserInteraction
+    def silent_alert_warning(*) ; end
+  end
+
+  # Repackages one or more installed gems back into a .gem file
+  #
+  # When a gem is installed, the file is split into multiple directories. The
+  # gemspec is placed in the specifications directory, the executables are
+  # placed in the bin directory, and the rest of the code is placed in a named
+  # directory within the gems directory.
+  #
+  # Gem::Repackager repackages gems back into .gem file(s), either individually
+  # or a directory at a time.
+  #
+  #   packager = Gem::Repackager.new '/opt/ruby/gems'
+  #   packager.package_all '~/gems'
+  #
+  #   spec = packager.load_spec 'activemodel', '3.2.8'
+  #   packager.package_gem spec
+  # 
+  # Gem::Repackager requires a path to the gems directory of the desired Ruby
+  # installation in order to detect specs and properly recombine all the parts
+  # of a gem.  It defaults to the current working directory.
+  class Repackager
+    attr_reader :gems_built, :gems_failed, :gem_dir
+
+    def initialize gem_dir = '.'
+      @gem_dir = gem_dir
+    end
+
+    # Builds all gems and moves to determined directory
+    #
+    # @param [String] Destination of built gems. Defaults to gem directory
+    # @return [Array] List of all gems built successfully
+    def package_all destination = gem_dir
+      @gems_built = []
+      @gems_failed = []
+
+      Dir["#{@gem_dir}/specifications/*.gemspec"].each do |spec_filename|
+        spec = load_spec filename: spec_filename
+        gem = package_gem spec
+
+        if gem
+          @gems_built.push gem
+          FileUtils.mv gem, destination
+        else
+          @gems_failed.push spec_filename
+        end
+      end
+
+      @gems_built
+    end
+
+    # Packages gem from Gem::Specification. If successful, returns the
+    # filename of the gem packaged. If unsuccessul, returns nil.
+    #
+    # @param [Gem::Specification] Gemspec to build
+    # @return [String,nil] Filename of gem built, or nil
+    def package_gem spec
+      enter_gem_directory spec.file_name.sub(/\.gem/,'')
+      symlink_bin
+      Gem::Builder.new(spec).build
+    rescue Gem::InvalidSpecificationException
+      return nil
+    ensure
+      unlink_bin
+    end
+
+    # Enters gems directory and loads the .gemspec
+    #
+    # @param [String] filename (.gemspec) of gem
+    # @return [Gem::Specification] parsed .gemspec
+    def load_spec options = {}
+      if options[:filename]
+        filename = options[:filename]
+      elsif options[:name] && options[:version]
+        filename = "#{@gem_dir}/specifications/#{options[:name]}-#{options[:version]}.gemspec"
+      end
+
+      Gem::Specification.load filename
+    end
+
+    # Enters specific gem's directory within gems dir
+    #
+    # @param [String] name of the gem
+    def enter_gem_directory gem
+      FileUtils.cd "#{@gem_dir}/gems/#{gem}"
+    end
+
+    # Symlink the bin directory to the gem directory. This is due
+    # to the decomposed nature of installed gems compared to the
+    # original conjoined structure of the gem before packaging.
+    #
+    # @see Gem::Repackager
+    def symlink_bin
+      FileUtils.ln_sf('../../bin', 'bin')
+    end
+
+    # Removes the symlink to the bin directory.
+    #
+    # @see #symlink_bin
+    def unlink_bin
+      FileUtils.rm_f('bin')
+    end
+
+    # Silences warning generated by validating and packaging gems
+    #
+    # When validating a gemspec before building, a slew of warnings and
+    # success notifications are spewed into the console without an easy
+    # way to silence the verbosity.  This shuts off the warnings and 
+    # build success output in a reversible fashion
+    def silence_warnings
+      @verbose = Gem.configuration.verbose
+      Gem.configuration.verbose = false # SILENCE
+      Gem::UserInteraction.send :alias_method, :loud_alert_warning, :alert_warning
+      Gem::UserInteraction.send :alias_method, :alert_warning, :silent_alert_warning
+    end
+
+    # Resets warnings to before their silenced state
+    #
+    # @see #silence_warnings
+    def reset_warnings
+      Gem.configuration.verbose = @verbose
+      Gem::UserInteraction.send :alias_method, :silent_alert_warning, :alert_warning
+      Gem::UserInteraction.send :alias_method, :alert_warning, :loud_alert_warning
+    end
+  end
+end

data/lib/gem_repackager/version.rb

@@ -0,0 +1,5 @@
+module Gem
+  class Repackager
+    VERSION = '0.1.0'
+  end
+end

data/spec/packager_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe Gem::Repackager do
+  let(:gem_dir) { 
+    File.expand_path File.dirname(__FILE__) + '/../support'
+  }
+  let(:destination_dir) {
+    File.expand_path File.dirname(__FILE__) + '/../support/built'
+  }
+  subject { Gem::Repackager.new gem_dir }
+  let(:packager) { subject }
+
+  its(:gem_dir) { should == gem_dir }
+
+  before do
+    packager.silence_warnings
+  end
+
+  describe '#package_all' do
+    it 'detects all specs in the spec dir' do
+      packager.stub(:package_gem) { false }
+      packager.should_receive(:load_spec).exactly(5).times
+      packager.package_all
+    end
+
+    it 'calls package_gem for each spec loaded' do
+      packager.should_receive(:package_gem).exactly(5).times
+      packager.package_all
+    end
+
+    it 'adds the gem to gems_built if successfully packaged' do
+      packager.should_receive(:package_gem).exactly(5).times { "gem" }
+      FileUtils.stub(:mv)
+      packager.package_all
+      packager.gems_built.should have(5).gems
+    end
+
+    it 'should move the gem to the default directory' do
+      packager.should_receive(:package_gem).exactly(5).times { "gem" }
+      FileUtils.should_receive(:mv).with("gem", packager.gem_dir).exactly(5).times
+      packager.package_all
+    end
+
+    it 'should move the gem to a custom directory if passed' do
+      packager.should_receive(:package_gem).exactly(5).times { "gem" }
+      FileUtils.should_receive(:mv).with("gem", destination_dir).exactly(5).times
+      packager.package_all destination_dir
+    end
+  end
+
+  describe '#package_gem' do
+    let(:spec_file) { gem_dir + "/specifications/rspec-2.11.0.gemspec" }
+    let(:spec) { Gem::Specification.load spec_file }
+
+    it 'returns the gem filename if packaging was successful' do
+      result = packager.package_gem spec
+      result.should == 'rspec-2.11.0.gem'
+      FileUtils.rm_rf('rspec-2.11.0.gem')
+    end
+
+    it 'returns nil if packaging was unsuccessful' do
+      Gem::Builder.any_instance.should_receive(:build) { nil }
+      result = packager.package_gem spec
+      result.should be_nil
+    end
+
+    it 'changes to the gem directory' do
+      Gem::Builder.any_instance.should_receive(:build) { nil }
+      packager.should_receive(:enter_gem_directory).with('rspec-2.11.0')
+      packager.package_gem spec
+    end
+
+    it 'symlinks the bin directory' do
+      Gem::Builder.any_instance.should_receive(:build) { nil }
+      packager.should_receive(:symlink_bin)
+      packager.package_gem spec
+    end
+
+    it 'removes the bin directory after building' do
+      Gem::Builder.any_instance.should_receive(:build) { nil }
+      packager.should_receive(:unlink_bin)
+      packager.package_gem spec
+    end
+  end
+
+  describe '#load_spec' do
+    let(:spec_file) { gem_dir + "/specifications/rspec-2.11.0.gemspec" }
+
+    context 'passing gem name and version' do
+      it 'converts name and version to gemspec filename' do
+        Gem::Specification.should_receive(:load).with(spec_file)
+        spec = packager.load_spec name: 'rspec', version: '2.11.0'
+      end
+
+      it 'returns a Gem::Specification' do
+        spec = packager.load_spec name: 'rspec', version: '2.11.0'
+        spec.should be_instance_of Gem::Specification
+        spec.file_name.should == 'rspec-2.11.0.gem'
+      end
+    end
+
+    context 'passing gemspec filename' do
+      it 'returns a Gem::Specification' do
+        spec = packager.load_spec filename: spec_file
+        spec.should be_instance_of Gem::Specification
+        spec.file_name.should == 'rspec-2.11.0.gem'
+      end
+    end
+  end
+
+  describe '#enter_gem_directory' do
+    it 'should change directory to gem directory' do
+      FileUtils.should_receive(:cd).with("#{gem_dir}/gems/rspec-2.11.0")
+      packager.enter_gem_directory 'rspec-2.11.0'
+    end
+  end
+
+  describe '#symlink_bin' do
+    it 'should create a symlink to the bin directory inside the gem directory' do
+      FileUtils.should_receive(:ln_sf).with('../../bin', 'bin')
+      packager.symlink_bin
+    end
+  end
+
+  describe '#unlink_bin' do
+    it 'should remove the symlink to the bin dir' do
+      FileUtils.should_receive(:rm_f).with('bin')
+      packager.unlink_bin
+    end
+  end
+end