RubyInline 3.2.1 → 3.3.0

data/History.txt

@@ -1,6 +1,13 @@
+*** 3.3.0 / 2005-04-22
+
++ 2 minor enhancement
+	+ Added inline_package, which helps you package inlined code into gems.
+	+ inline_package also generates a Rakefile for you if you need it.
+	+ inline.rb now (only) loads packaged code when present.
+
 *** 3.2.1 / 2005-04-19
 
-+ 2 minor enhancements
++ 2 bug fixes
 	+ Added double to typemap. Thanks Phil Tomson!
 	+ Added a minor hack to get cygwin to work right--lemme know pls.
 

data/Manifest.txt

@@ -6,7 +6,7 @@ example.rb
 example2.rb
 inline.gemspec
 inline.rb
-inline-compat.rb
+inline_package
 test_inline.rb
 tutorial/example1.rb
 tutorial/example2.rb

data/inline.rb

@@ -1,7 +1,8 @@
 #!/usr/local/bin/ruby -w
 
+##
 # Ruby Inline is a framework for writing ruby extensions in foreign
-# languages
+# languages.
 #
 # = SYNOPSIS
 #
@@ -26,6 +27,10 @@
 # builds it only when necessary. The extensions are then automatically
 # loaded into the class/module that defines it.
 #
+# Using the package_inline tool Inline now allows you to package up
+# your inlined object code for distribution to systems without a
+# compiler (read: windows)!
+#
 # You can even write extra builders that will allow you to write
 # inlined code in any language. Use Inline::C as a template and look
 # at Module#inline for the required API.
@@ -38,13 +43,14 @@ $TESTING = false unless defined? $TESTING
 
 class CompilationError < RuntimeError; end
 
+##
 # The Inline module is the top-level module used. It is responsible
 # for instantiating the builder for the right language used,
 # compilation/linking when needed, and loading the inlined code into
 # the current namespace.
 
 module Inline
-  VERSION = '3.2.1'
+  VERSION = '3.3.0'
 
   $stderr.puts "RubyInline v #{VERSION}" if $DEBUG
 
@@ -227,6 +233,19 @@ module Inline
 
     public
 
+    def load_cache
+      begin
+        file = File.join("inline", File.basename(@so_name))
+        if require file then
+          dir = Inline.directory
+          warn "WARNING: #{dir} exists but is not being used" if test ?d, dir
+          return true
+        end
+      rescue LoadError
+      end
+      return false
+    end
+
     def load
       require "#{@so_name}" or raise LoadError, "require on #{@so_name} failed"
     end
@@ -432,8 +451,10 @@ class Module
     yield builder
 
     unless testing then
-      builder.build
-      builder.load
+      unless builder.load_cache then
+        builder.build
+        builder.load
+      end
     end
   end
 end

data/inline_package

@@ -0,0 +1,128 @@
+#!/usr/local/bin/ruby -w
+
+require 'rbconfig'
+require 'fileutils'
+require 'inline'
+
+$TESTING ||= false
+
+class Packager
+
+    RAKEFILE_TEMPLATE = <<'EOF'
+%[require 'rake'
+require 'rake/gempackagetask'
+
+summary = #{summary.inspect}
+
+if summary.empty? then
+  STDERR.puts "*************************************"
+  STDERR.puts "*** Summary not filled in, SHAME! ***"
+  STDERR.puts "*************************************"
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = #{name.inspect}
+  s.version = #{version.inspect}
+  s.summary = summary
+
+  s.has_rdoc = false
+  s.files = #{gem_libs.inspect}
+  s.add_dependency 'RubyInline', '>= 3.3.0'
+  s.require_path = 'lib'
+end
+
+desc "Builds a gem with #{name} in it"
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+]
+EOF
+
+  attr_accessor :name, :version, :summary
+
+  def initialize(name, version, summary = '')
+    @name = name
+    @version = version
+    @summary = summary
+
+    @libs_copied = false
+  end
+
+  def package
+    copy_libs
+    generate_rakefile
+    build_gem
+  end
+
+  def copy_libs
+    FileUtils.mkdir_p inline_dir
+    FileUtils.cp built_libs, inline_dir
+    @libs_copied = true
+  end
+
+  def generate_rakefile
+    if File.exists? 'Rakefile' then
+      unless $TESTING then
+        STDERR.puts "Hrm, you already have a Rakefile, so I didn't touch it."
+        STDERR.puts "You might have to add the following files to your gemspec's files list:"
+        STDERR.puts "\t#{gem_libs.join "\n\t"}"
+      end
+      return
+    end
+
+    rakefile = eval RAKEFILE_TEMPLATE 
+
+    STDERR.puts "==> Generating Rakefile" unless $TESTING
+    File.open 'Rakefile', 'w' do |fp|
+      fp.puts rakefile
+    end
+  end
+
+  def build_gem
+    STDERR.puts "==> Running rake" unless $TESTING
+
+    cmd = "rake package"
+    cmd += "> /dev/null 2> /dev/null" if $TESTING
+    system cmd
+
+    STDERR.puts unless $TESTING
+    STDERR.puts "Ok, you now have a gem in ./pkg, enjoy!" unless $TESTING
+  end
+
+  def inline_dir
+    @inline_dir ||= File.join "lib", "inline" # TODO put libs in platform dir
+  end
+
+  def built_libs
+    Dir.glob File.join(Inline.directory, "*.#{Config::CONFIG['DLEXT']}")
+  end
+
+  def gem_libs
+    copy_libs unless @libs_copied
+    unless defined? @gem_libs then
+      @gem_libs = Dir.glob File.join(inline_dir, "*.#{Config::CONFIG['DLEXT']}")
+      files = Dir.glob(File.join('lib', '*')).select { |f| test ?f, f }
+      
+      @gem_libs.push(*files)
+      @gem_libs.sort!
+    end
+    @gem_libs
+  end
+
+end
+
+if __FILE__ == $0 then
+  name = ARGV.shift
+  version = ARGV.shift
+  summary = ARGV.shift || ""
+
+  if version.nil? then # TODO better usage
+    STDERR.puts "Usage: packager NAME VERSION SUMMARY"
+    exit 1
+  end
+
+  packager = Packager.new name, version, summary
+  packager.package
+end
+

data/test_inline.rb

@@ -3,6 +3,7 @@
 $TESTING = true
 
 require 'inline'
+load 'inline_package'
 require 'tempfile'
 require 'test/unit'
 
@@ -475,8 +476,6 @@ puts(s); return rb_str_new2(s)}"
     begin
       Kernel.module_eval { require rb_file }
       yield if block_given?
-    rescue Exception => err
-      raise err
     ensure
       File.unlink rb_file
     end
@@ -584,3 +583,119 @@ class TestModule < Test::Unit::TestCase
   end
 
 end
+
+class TestPackager < Test::Unit::TestCase
+
+  def setup
+    @name = "Packager Test"
+    @version = "1.0.0"
+    @summary = "This is a Packager test gem"
+    @packager = Packager.new @name, @version, @summary
+
+    @inline_dir = "/tmp/#{$$}_inline"
+    @package_dir = "/tmp/#{$$}_package"
+
+    ENV['INLINEDIR'] = @inline_dir
+
+    Dir.mkdir @inline_dir, 0700
+    Dir.mkdir @package_dir, 0700
+    @orig_dir = Dir.pwd
+    Dir.chdir @package_dir
+
+    @ext = Config::CONFIG['DLEXT']
+  end
+
+  def teardown
+    Dir.chdir @orig_dir
+    return if $DEBUG
+    `rm -rf #{@inline_dir}`
+    `rm -rf #{@package_dir}`
+  end
+
+  def util_generate_rakefile
+    summary = @summary
+    name = @name
+    version = @version
+    gem_libs = []
+
+    eval Packager::RAKEFILE_TEMPLATE
+  end
+
+  def test_package
+    assert_nothing_raised do
+      @packager.package
+    end
+  end
+  
+  def test_copy_libs
+    assert_equal false, @packager.instance_variable_get("@libs_copied")
+
+    built_lib = "Inline_Test.#{@ext}"
+    dir = "#{@inline_dir}/.ruby_inline"
+
+    Dir.mkdir dir, 0700
+    Dir.chdir dir do
+      FileUtils.touch built_lib
+    end
+
+    @packager.copy_libs
+
+    assert_equal true, File.directory?("#{@package_dir}/lib/inline")
+    assert_equal true, File.exists?("#{@package_dir}/lib/inline/#{built_lib}")
+
+    assert_equal true, @packager.instance_variable_get("@libs_copied")
+  end
+
+  def test_generate_rakefile_has_rakefile
+    FileUtils.touch 'Rakefile'
+    
+    @packager.generate_rakefile
+
+    assert_equal "", File.read('Rakefile')
+  end
+
+  def test_generate_rakefile_no_rakefile
+    @packager.generate_rakefile
+
+    assert_equal util_generate_rakefile, File.read('Rakefile')
+  end
+
+  def test_build_gem
+    File.open 'Rakefile', 'w' do |fp|
+      fp.puts util_generate_rakefile
+    end
+
+    @packager.build_gem
+    package_name = "pkg/#{@name}-#{@version}.gem"
+    assert_equal true, File.exists?(package_name)
+    assert_equal true, system("gem check #{package_name}")
+  end
+
+  def test_inline_dir
+    assert_equal "lib/inline", @packager.inline_dir
+  end
+  
+  def test_built_libs
+    expected = ["Inline_Test.#{@ext}"]
+
+    dir = "#{@inline_dir}/.ruby_inline"
+    Dir.mkdir dir, 0700
+    Dir.chdir dir
+
+    FileUtils.touch(expected)
+
+    assert_equal expected.map { |f| "#{dir}/#{f}"}, @packager.built_libs
+  end
+
+  def test_gem_libs
+    @packager.instance_variable_set "@libs_copied", true
+    expected = ["lib/blah.rb", "lib/inline/Inline_Test.#{@ext}"]
+
+    FileUtils.mkdir_p "lib/inline"
+    FileUtils.touch(expected)
+
+    assert_equal expected, @packager.gem_libs
+  end
+
+end
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: RubyInline
 version: !ruby/object:Gem::Version 
-  version: 3.2.1
-date: 2005-04-19
+  version: 3.3.0
+date: 2005-04-22
 summary: Multi-language extension coding within ruby.
 require_paths: 
   - "."
@@ -38,7 +38,7 @@ files:
   - example2.rb
   - inline.gemspec
   - inline.rb
-  - inline-compat.rb
+  - inline_package
   - test_inline.rb
   - tutorial/example1.rb
   - tutorial/example2.rb

data/inline-compat.rb

@@ -1,44 +0,0 @@
-#!/usr/local/bin/ruby -w
-
-require "inline"
-
-############################################################
-# DEPRECATED: Remove by version 3.1 or 2003-03-01
-#
-# This file is only provided for those who require backwards compatibility with version 2.x.
-# If you don't need it, don't use it. If you do, please heed the deprecation warnings and
-# migrate to the new system as fast as you can. Thanks...
-
-module Inline
-  class C 
-
-    $INLINE_FLAGS = nil
-    $INLINE_LIBS  = nil
-
-    trace_var(:$INLINE_FLAGS) do |val|
-      $stderr.puts "WARNING: $INLINE_FLAGS is deprecated. Use #add_link_flags. Called from #{caller[1]}."
-    end
-
-    trace_var(:$INLINE_LIBS) do |val|
-      $stderr.puts "WARNING: $INLINE_LIBS is deprecated. Use #add_compile_flags. Called from #{caller[1]}."
-    end
-  end
-end
-
-class Module
-  public
-
-  def inline_c(src)
-    $stderr.puts "WARNING: inline_c is deprecated. Switch to Inline module"
-    inline(:C) do | builder |
-      builder.c src
-    end
-  end
-
-  def inline_c_raw(src)
-    $stderr.puts "WARNING: inline_c_raw is deprecated. Switch to Inline module"
-    inline(:C) do | builder |
-      builder.c_raw src
-    end
-  end
-end