gembuilder 1.1.0

data/History.txt

@@ -0,0 +1,8 @@
+== 1.1.0 / 2007-05-19
+
+* Cleanup code for release
+
+== 1.0.0 / 2007-05-11
+
+* Initial (very sloppy) gemification
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/gembuilder
+lib/gembuilder.rb
+test/test_gembuilder.rb

data/README.txt

@@ -0,0 +1,51 @@
+gembuilder
+    by Patrick Hurley
+    http://rubyforge.org/projects/gembuilder/
+
+== DESCRIPTION:
+  
+Build a binary gem from an existing gem for your platform.
+
+== FEATURES/PROBLEMS:
+  
+* Would be better if it could gather the gem automatically out of the gem cache.
+* Should also have an option to attempt to cleanup intermediate files (.o/.obj) 
+
+== SYNOPSIS:
+
+Build your gem so that it can be deployed on machines without a build chain  
+
+== REQUIREMENTS:
+
+* GEM and a binary build chain
+
+== INSTALL:
+
+* Install with gem, then just:
+
+  gembuilder <gem_file>
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Patrick Hurley
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/gembuilder.rb'
+
+Hoe.new('gembuilder', GemBuilder::VERSION) do |p|
+  p.rubyforge_name = 'gembuilder'
+  p.author = 'Patrick Hurley'
+  p.email = 'phurley@gmail.com'
+
+  p.summary = 'Create a binary gem, for the current platform.'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/bin/gembuilder

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+require 'gembuilder'
+require 'optparse'
+
+opts = OptionParser.new
+
+conservative = false
+
+opts.banner = "Usage: gembuilder [options] gem_file_name"
+opts.on("-d", "--debug", "Enable debug output") { $DEBUG = 1 }
+opts.on("-c", "--conservative", "Do not try and remove intermediate files") { conservative = true }
+
+opts.on("-h", "--help", "Show this message") do
+  puts opts
+  exit
+end
+
+argv = opts.parse(ARGV)
+
+if argv.empty?
+  puts "You must provide the name of a gem on the command line."
+  exit 1
+end
+
+argv.each do |gem|
+  unless File.exists?(gem)
+    puts "Skipping #{gem}, file not found."
+    next
+  end
+
+  gem_builder = GemBuilder.new(gem)
+
+  puts "Unpacking #{gem}"
+  gem_builder.unpack_gem
+
+  puts "   building extension(s)"
+  gem_builder.build_extensions
+
+  puts "   adjusting gemspec"
+  gem_builder.fix_gemspec(conservative)
+
+  puts "   building binary gem"
+  gem_builder.build_gem
+
+  puts "   cleaning up"
+  gem_builder.cleanup
+end
+

data/lib/gembuilder.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require "rbconfig"
+require "rubygems"
+require "tmpdir"
+require "find"
+require "fileutils"
+Gem.manage_gems
+
+
+class GemBuilder
+  VERSION = '1.1.0'
+  OBJEXT = ".#{Config::CONFIG["OBJEXT"]}"
+
+  # Helper that will do it all
+  def self.[](gem,conservative=false)
+    gem_builder = GemBuilder.new(gem)
+    gem_builder.unpack_gem
+    gem_builder.build_extensions
+    gem_builder.fix_gemspec(conservative)
+    gem_builder.build_gem
+    gem_builder.cleanup
+  end
+  
+  def initialize(gem)
+    @gem_name = gem
+    @installer = Gem::Installer.new(@gem_name)
+    @format = Gem::Format.from_file_by_path(@gem_name)
+  end
+
+  def tmpdir
+    @tmpdir ||= File.join(Dir.tmpdir, "gembuilder")
+  end
+
+  def installer
+    @installer ||= Gem::Installer.new(@gem_name)
+  end
+  
+  def format
+    @format ||= Gem::Format.from_file_by_path(@gem_name)
+  end
+  
+  def spec
+    @spec ||= format.spec
+  end
+  
+  def unpack_gem
+    FileUtils.rm_r(tmpdir) rescue nil
+    FileUtils.mkdir_p(tmpdir) rescue nil
+    installer.unpack(tmpdir)
+  end
+
+  def build_extensions
+    installer.build_extensions(tmpdir, format.spec)
+  end
+
+  def platform
+    # I used to use this to clean up gem names under
+    # darwin, not sure it was a good idea though
+    # Config::CONFIG['arch'].sub(/[\.0-9]*$/, '')
+    Config::CONFIG['arch']
+  end
+  
+  def fix_gemspec(conservative = false)
+    files = []
+    Find.find(tmpdir) do |fname|
+      next if fname == tmpdir
+      next if !conservative && File.extname(fname) == OBJEXT 
+      files << fname.sub(Regexp.quote(tmpdir + "/"), '')
+    end
+
+    spec.extensions = []
+    spec.files += (files - format.spec.files)
+    spec.platform = platform
+  end
+  
+  def build_gem
+    start_dir = Dir.pwd
+    Dir.chdir(tmpdir) do
+      gb = Gem::Builder.new(spec)
+      gb.build
+      FileUtils.mv Dir.glob("*.gem"), start_dir
+    end
+  end
+  
+  def cleanup
+    FileUtils.rm_rf(tmpdir)
+  end
+
+end
+

data/test/test_gembuilder.rb

@@ -0,0 +1,111 @@
+#
+# Calling all interested testers -- how could I write better tests for this
+# type of code? let me know at phurley@gmail.com -- Thanks!!!
+# 
+# Could put all the tests in one methods and test them inline? 
+# this is an optimization, so I am holding off, the test time 
+# is not too bad now that I use a simple project.
+# 
+# Add tests for complex gems (with multiple extensions)
+# 
+# Should probably verify that the gem is installable 
+# as well, but I am not sure how far to go down that
+# road (probably all the way, but it seems so cludgy 
+# already)
+# 
+# And thanks to zenspider for ZenTest -- great stuff
+# 
+require "test/unit"
+require "gembuilder"
+
+class TestGembuilder < Test::Unit::TestCase
+  GEMNAME = 'helloc-1.0.0.gem'
+  
+  def setup
+    # find our test gem file.
+    # Note the nasty reliance on an external file
+    # and our eventual use of your file system 
+    # slowing the tests
+    #
+    Dir.chdir "test" rescue nil 
+    @gb = GemBuilder.new(GEMNAME)
+  end
+  
+  def teardown
+    # how craptacular is this -- I am using the thing I am 
+    # testing to cleanup -- somebody save me from my own
+    # insanity
+    @gb.cleanup
+    File.rm('helloc-1.0.0-*.gem') rescue nil
+  end
+
+  def assert_file_exists(fname, msg = "The file #{fname} should exist and does not.")
+    assert(File.exists?(fname), msg)
+  end
+  
+  def assert_file_exists_in_gem(fname, msg = "The file #{fname} should exist and does not.")
+    assert_file_exists(File.join(@gb.tmpdir, fname), msg)
+  end
+  
+  def assert_files_exist_in_gem(files)
+    files.each { |file| assert_file_exists_in_gem(file) }
+  end
+
+  def test_class_doit_all_method
+    GemBuilder[GEMNAME]
+    
+    assert_file_exists("helloc-1.0.0-#{Config::CONFIG['arch']}.gem")   
+    # not sure how to verify that the temp directory is properly cleaned up
+    # without adding some odd support for returning the temp directory name
+    # that should already be deleted at this point 
+  end
+  
+  def test_tmpdir_does_not_exist
+    assert(!File.exists?(@gb.tmpdir), "Not generating a good temp directory")
+  end
+  
+  def test_we_can_unpack_the_gem
+    @gb.unpack_gem
+    assert(File.exists?(@gb.tmpdir), "Failure message.")
+
+    assert_files_exist_in_gem ["History.txt", "Manifest.txt", "README.txt", 
+      "Rakefile", "ext/helloc/extconf.rb", "ext/helloc/helloc.c"]
+  end
+  
+  def test_we_can_build_the_extensions
+    @gb.unpack_gem
+    @gb.build_extensions
+    assert_files_exist_in_gem [
+      "ext/helloc/helloc.#{Config::CONFIG['OBJEXT']}",
+      "lib/helloc.#{Config::CONFIG['DLEXT']}"
+    ]
+  end
+
+  def test_gemspec_changes
+    @gb.unpack_gem
+    @gb.build_extensions
+    @gb.fix_gemspec
+    
+    assert(@gb.spec.files.include?("lib/helloc.#{Config::CONFIG['DLEXT']}"), "Shared library not found in gemspec")
+    assert(!@gb.spec.files.include?("ext/helloc/helloc.#{Config::CONFIG['OBJEXT']}"), "Intermediate file found in gemspec")
+  end
+  
+  def test_build_gem
+    @gb.unpack_gem
+    @gb.build_extensions
+    @gb.fix_gemspec
+    @gb.build_gem
+    
+    # talk about self referential -- but how else to I make the
+    # tests work on different platforms?
+    assert_file_exists("helloc-1.0.0-#{Config::CONFIG['arch']}.gem")
+  end
+      
+  def test_cleanup
+    @gb.unpack_gem
+    @gb.build_extensions
+    @gb.cleanup
+    assert(!File.exists?(@gb.tmpdir))
+  end
+  
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: gembuilder
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+date: 2007-05-22 00:00:00 -04:00
+summary: Create a binary gem, for the current platform.
+require_paths: 
+- lib
+email: phurley@gmail.com
+homepage: "    by Patrick Hurley"
+rubyforge_project: gembuilder
+description: "== FEATURES/PROBLEMS:  * Would be better if it could gather the gem automatically out of the gem cache. * Should also have an option to attempt to cleanup intermediate files (.o/.obj)   == SYNOPSIS:  Build your gem so that it can be deployed on machines without a build chain    == REQUIREMENTS:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Patrick Hurley
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/gembuilder
+- lib/gembuilder.rb
+- test/test_gembuilder.rb
+test_files: 
+- test/test_gembuilder.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- gembuilder
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: