RubyInline 3.3.0 → 3.3.1

data/History.txt

@@ -1,3 +1,10 @@
+*** 3.3.1 / 2005-05-03
+
++ 3 bug fixes
+	+ Fixed a bug w/ unit tests involving caching of rootdir.
+	+ Added a minor tweak to the file discovery when called through eval.
+	+ Moved the packaging code into inline.rb in order to get rubygems wrapped scripts to work again (wrapper was breaking due to __FILE__ != $0).
+
 *** 3.3.0 / 2005-04-22
 
 + 2 minor enhancement

data/Makefile

@@ -1,6 +1,7 @@
 RUBY?=/usr/local/bin/ruby
 RDOC?=rdoc18
 RUBYLIB=$(shell $(RUBY) -rrbconfig -e 'include Config; print CONFIG["sitelibdir"]')
+PREFIX?=/usr/local
 
 test:
 	$(RUBY) -I. -w ./test_inline.rb
@@ -29,13 +30,16 @@ bench:
 	@$(RUBY) -I. ./example.rb 2 2> /dev/null
 
 install:
-	echo "installing inline.rb in $(RUBYLIB)"; \
-	cp -f inline.rb $(RUBYLIB);
+	echo "installing inline.rb in $(RUBYLIB)"
+	cp -f inline.rb $(RUBYLIB)
+	cp -f inline_package $(PREFIX)/bin
+	chmod 755 $(PREFIX)/bin/inline_package
 	echo Installed
 
 uninstall:
-	echo "Removing inline.rb from $(RUBYLIB)"; \
-	rm $(RUBYLIB)/inline.rb;
+	echo "Removing inline.rb from $(RUBYLIB)"
+	rm $(RUBYLIB)/inline.rb
+	rm -f $(PREFIX)/bin/inline_package
 	echo Removed
 
 clean:

data/README.txt

@@ -11,6 +11,10 @@ directly. By writing simple builder classes, you can teach how to cope
 with new languages (fortran, perl, whatever). The code is compiled and
 run on the fly when needed.
 
+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)!
+
 ** FEATURES/PROBLEMS:
 
 + Quick and easy inlining of your C or C++ code embedded in your ruby script.
@@ -20,7 +24,8 @@ run on the fly when needed.
 + inline_c_raw exists for when the automatic conversion isn't sufficient.
 + Only recompiles if the inlined code has changed.
 + Pretends to be secure.
-+ Only uses standard ruby libraries, nothing extra to download.
++ Only requires standard ruby libraries, nothing extra to download.
++ Can generate a basic Rakefile and package up built extensions for distribution.
 
 ** SYNOPSYS:
 
@@ -55,6 +60,13 @@ run on the fly when needed.
   t = MyTest.new()
   t.hello(3)
 
+** SYNOPSYS (packaging):
+
+  rm -rf ~/.ruby_inline
+  make test
+  inline_package packagename 1.0.0
+  ls lib/inline
+
 ** (PSEUDO)BENCHMARKS:
 
   > make bench
@@ -86,7 +98,7 @@ run on the fly when needed.
 + POSIX compliant system (ie pretty much any UNIX, or Cygwin on MS platforms).
 + A C/C++ compiler (the same one that compiled your ruby interpreter).
 + test::unit for running tests ( http://testunit.talbott.ws/ ).
-+ rubygems if you'd like.
++ rubygems & rake if you'd like - these are used by inline_package.
 
 ** INSTALL:
 
@@ -97,7 +109,7 @@ run on the fly when needed.
 
 (The MIT License)
 
-Copyright (c) 2001-2002 Ryan Davis, Zen Spider Software
+Copyright (c) 2001-2005 Ryan Davis, Zen Spider Software
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/inline.gemspec

@@ -16,6 +16,10 @@ spec = Gem::Specification.new do |s|
   s.requirements << "A POSIX environment and a compiler for your language."
   s.files = IO.readlines("Manifest.txt").map {|f| f.chomp }
 
+  s.bindir = "."
+  s.executables = ['inline_package']
+  puts "Executables = #{s.executables.join(", ")}"
+
   s.require_path = '.' 
   s.autorequire = 'inline'
 

data/inline.rb

@@ -36,8 +36,9 @@
 # at Module#inline for the required API.
 
 require "rbconfig"
-require "ftools"
 require "digest/md5"
+require 'ftools'
+require 'fileutils'
 
 $TESTING = false unless defined? $TESTING
 
@@ -50,14 +51,15 @@ class CompilationError < RuntimeError; end
 # the current namespace.
 
 module Inline
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 
   $stderr.puts "RubyInline v #{VERSION}" if $DEBUG
 
   protected
 
   def self.rootdir
-    unless defined? @@rootdir and test ?d, @@rootdir then
+    env = ENV['INLINEDIR'] || ENV['HOME']
+    unless defined? @@rootdir and env == @@rootdir and test ?d, @@rootdir then
       rootdir = ENV['INLINEDIR'] || ENV['HOME']
       Dir.mkdir rootdir, 0700 unless test ?d, rootdir
       Dir.assert_secure rootdir
@@ -68,8 +70,8 @@ module Inline
   end
 
   def self.directory
-    unless defined? @@directory and test ?d, @@directory then
-      directory = File.join(rootdir, ".ruby_inline")
+    directory = File.join(rootdir, ".ruby_inline")
+    unless defined? @@directory and directory == @@directory and test ?d, @@directory then
       unless File.directory? directory then
 	$stderr.puts "NOTE: creating #{directory} for RubyInline" if $DEBUG
 	Dir.mkdir directory, 0700
@@ -251,7 +253,10 @@ module Inline
     end
 
     def build
-      rb_file = File.expand_path(caller[1].split(/:/).first) # [MS]
+      real_caller = caller[1]
+      real_caller = caller[4] if real_caller =~ /\(eval\)/
+      real_caller = real_caller.split(/:/).first
+      @rb_file = File.expand_path(real_caller) # [MS]
       so_exists = File.file? @so_name
 
       unless so_exists and File.mtime(@rb_file) < File.mtime(@so_name)
@@ -334,7 +339,7 @@ module Inline
           cmd += " 2> /dev/null" if $TESTING
 	  
 	  $stderr.puts "Building #{@so_name} with '#{cmd}'" if $DEBUG
-	  `#{cmd}`
+          `#{cmd}`
           if $? != 0 then
             bad_src_name = src_name + ".bad"
             File.rename src_name, bad_src_name
@@ -353,7 +358,13 @@ module Inline
       @mod = mod
       if @mod then
         # Figure out which script file defined the C code
-        @rb_file = File.expand_path(caller[2].split(/:/).first) # [MS]
+
+        real_caller = caller[2]
+        real_caller = caller[5] if real_caller =~ /\(eval\)/
+        real_caller = real_caller.split(/:/).first
+
+        @rb_file = File.expand_path(real_caller) # [MS]
+
         # Extract the basename of the script and clean it up to be 
         # a valid C identifier
         rb_script_name = File.basename(@rb_file).gsub(/[^a-zA-Z0-9_]/,'_')
@@ -429,6 +440,78 @@ module Inline
     end
 
   end # class Inline::C
+
+  class Packager
+    attr_accessor :name, :version, :summary, :libs_copied, :inline_dir
+
+    def initialize(name, version, summary = '')
+      @name = name
+      @version = version
+      @summary = summary
+      @libs_copied = false
+      @ext = Config::CONFIG['DLEXT']
+
+      # TODO (maybe) put libs in platform dir
+      @inline_dir = File.join "lib", "inline"
+    end
+
+    def package
+      copy_libs
+      generate_rakefile
+      build_gem
+    end
+
+    def copy_libs
+      unless @libs_copied then
+        FileUtils.mkdir_p @inline_dir
+        built_libs = Dir.glob File.join(Inline.directory, "*.#{@ext}")
+        FileUtils.cp built_libs, @inline_dir
+        @libs_copied = true
+      end
+    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 gem_libs
+      unless defined? @gem_libs then
+        @gem_libs = Dir.glob File.join(@inline_dir, "*.#{@ext}")
+        files = Dir.glob(File.join('lib', '*')).select { |f| test ?f, f }
+        
+        @gem_libs.push(*files)
+        @gem_libs.sort!
+      end
+      @gem_libs
+    end
+
+    RAKEFILE_TEMPLATE = '%[require "rake"\nrequire "rake/gempackagetask"\n\nsummary = #{summary.inspect}\n\nif summary.empty? then\n  STDERR.puts "*************************************"\n  STDERR.puts "*** Summary not filled in, SHAME! ***"\n  STDERR.puts "*************************************"\nend\n\nspec = Gem::Specification.new do |s|\n  s.name = #{name.inspect}\n  s.version = #{version.inspect}\n  s.summary = summary\n\n  s.has_rdoc = false\n  s.files = #{gem_libs.inspect}\n  s.add_dependency "RubyInline", ">= 3.3.0"\n  s.require_path = "lib"\nend\n\ndesc "Builds a gem with #{name} in it"\nRake::GemPackageTask.new spec do |pkg|\n  pkg.need_zip = false\n  pkg.need_tar = false\nend\n]'
+  end # class Packager
 end # module Inline
 
 class Module
@@ -479,7 +562,6 @@ class File
 
     return renamed
   end
-
 end # class File
 
 class Dir

data/inline_package

@@ -1,128 +1,15 @@
 #!/usr/local/bin/ruby -w
 
-require 'rbconfig'
-require 'fileutils'
 require 'inline'
 
-$TESTING ||= false
+name = ARGV.shift
+version = ARGV.shift
+summary = ARGV.shift || ""
 
-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
+if version.nil? then # TODO better usage
+  STDERR.puts "Usage: #{$0} NAME VERSION [SUMMARY]"
+  exit 1
 end
 
+packager = Inline::Packager.new name, version, summary
+packager.package

data/test_inline.rb

@@ -3,26 +3,40 @@
 $TESTING = true
 
 require 'inline'
-load 'inline_package'
 require 'tempfile'
 require 'test/unit'
 
 File.umask(0)
 
-class TestDir < Test::Unit::TestCase
+class InlineTestCase < Test::Unit::TestCase
 
   def setup
-    @dir = "/tmp/#{$$}"
-    @count = 1
-    Dir.mkdir @dir, 0700
+    super
+    @rootdir = "/tmp/#{$$}"
+    Dir.mkdir @rootdir, 0700
+    ENV['INLINEDIR'] = @rootdir
   end
 
   def teardown
-    `rm -rf #{@dir}` unless $DEBUG
+    FileUtils.rm_rf @rootdir unless $DEBUG
+    ENV.delete 'INLINEDIR'
+  end
+
+  def test_stupid
+    #shuts test unit up
+  end
+
+end
+
+class TestDir < InlineTestCase
+
+  def setup
+    super
+    @count = 1
   end
 
   def util_assert_secure(perms, should_pass)
-    path = File.join(@dir, @count.to_s)
+    path = File.join(@rootdir, @count.to_s)
     @count += 1
     Dir.mkdir path, perms unless perms.nil?
     if should_pass then
@@ -48,17 +62,7 @@ class TestDir < Test::Unit::TestCase
   end
 end
 
-class TestInline < Test::Unit::TestCase
-
-  def setup
-    @rootdir = "/tmp/#{$$}"
-    Dir.mkdir @rootdir, 0700
-    ENV['INLINEDIR'] = @rootdir
-  end
-
-  def teardown
-    `rm -rf #{@rootdir}` unless $DEBUG
-  end
+class TestInline < InlineTestCase
 
   def test_rootdir
     assert_equal(@rootdir, Inline.rootdir)
@@ -72,7 +76,7 @@ class TestInline < Test::Unit::TestCase
 end
 
 class TestInline
-class TestC < Test::Unit::TestCase
+class TestC < InlineTestCase
 
   # quick hack to make tests more readable,
   # does nothing I wouldn't otherwise do...
@@ -540,16 +544,7 @@ module Foo
 end
 EOR
 
-class TestModule < Test::Unit::TestCase
-
-  def setup
-    @rootdir = "/tmp/#{$$}"
-    ENV['INLINEDIR'] = @rootdir
-  end
-
-  def teardown
-    `rm -rf #{@rootdir}` unless $DEBUG
-  end
+class TestModule < InlineTestCase
 
   def test_nested
     Object.class_eval $test_module_code
@@ -584,21 +579,17 @@ class TestModule < Test::Unit::TestCase
 
 end
 
-class TestPackager < Test::Unit::TestCase
+class TestInlinePackager < InlineTestCase
 
   def setup
+    super
     @name = "Packager Test"
     @version = "1.0.0"
     @summary = "This is a Packager test gem"
-    @packager = Packager.new @name, @version, @summary
+    @packager = Inline::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
+    @package_dir = @rootdir + "_package"
+    Dir.mkdir @package_dir, 0700 # unless test ?d, @package_dir
     @orig_dir = Dir.pwd
     Dir.chdir @package_dir
 
@@ -606,10 +597,9 @@ class TestPackager < Test::Unit::TestCase
   end
 
   def teardown
+    super
     Dir.chdir @orig_dir
-    return if $DEBUG
-    `rm -rf #{@inline_dir}`
-    `rm -rf #{@package_dir}`
+    FileUtils.rm_rf @package_dir unless $DEBUG
   end
 
   def util_generate_rakefile
@@ -618,7 +608,12 @@ class TestPackager < Test::Unit::TestCase
     version = @version
     gem_libs = []
 
-    eval Packager::RAKEFILE_TEMPLATE
+    eval Inline::Packager::RAKEFILE_TEMPLATE
+  end
+
+  def test_initialize
+    assert_equal "lib/inline", @packager.inline_dir
+    assert_equal false, @packager.libs_copied
   end
 
   def test_package
@@ -628,10 +623,10 @@ class TestPackager < Test::Unit::TestCase
   end
   
   def test_copy_libs
-    assert_equal false, @packager.instance_variable_get("@libs_copied")
+    assert_equal false, @packager.libs_copied
 
     built_lib = "Inline_Test.#{@ext}"
-    dir = "#{@inline_dir}/.ruby_inline"
+    dir = "#{@rootdir}/.ruby_inline"
 
     Dir.mkdir dir, 0700
     Dir.chdir dir do
@@ -643,7 +638,7 @@ class TestPackager < Test::Unit::TestCase
     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")
+    assert_equal true, @packager.libs_copied
   end
 
   def test_generate_rakefile_has_rakefile
@@ -671,24 +666,8 @@ class TestPackager < Test::Unit::TestCase
     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
+    @packager.libs_copied = true
     expected = ["lib/blah.rb", "lib/inline/Inline_Test.#{@ext}"]
 
     FileUtils.mkdir_p "lib/inline"
@@ -696,6 +675,4 @@ class TestPackager < Test::Unit::TestCase
 
     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.3.0
-date: 2005-04-22
+  version: 3.3.1
+date: 2005-05-03
 summary: Multi-language extension coding within ruby.
 require_paths: 
   - "."
@@ -17,7 +17,7 @@ description: "Ruby Inline is an analog to Perl's Inline::C. Out of the box, it a
   whatever). The code is compiled and run on the fly when needed."
 autorequire: inline
 default_executable: 
-bindir: bin
+bindir: "."
 has_rdoc: false
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
@@ -46,7 +46,8 @@ test_files:
   - test_inline.rb
 rdoc_options: []
 extra_rdoc_files: []
-executables: []
+executables: 
+  - inline_package
 extensions: []
 requirements: 
   - A POSIX environment and a compiler for your language.