newgem 0.19.1 → 0.20.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.20.0 2008-03-30
+
+* extconf generator - for C-extensions
+* Hoe instance stored in $hoe so can be accessed from tasks/*.rake
+
 == 0.19.1 2008-03-27
 
 * rspec "rake spec" supports spec/**/*_spec.rb search now [Steven Parkes]

data/Manifest.txt

@@ -67,6 +67,12 @@ newgem_theme_generators/plain_theme/templates/website/template.rhtml
 rubygems_generators/executable/USAGE
 rubygems_generators/executable/executable_generator.rb
 rubygems_generators/executable/templates/app.rb
+rubygems_generators/extconf/USAGE
+rubygems_generators/extconf/extconf_generator.rb
+rubygems_generators/extconf/templates/ext/c_file.c
+rubygems_generators/extconf/templates/ext/extconf.rb
+rubygems_generators/extconf/templates/tasks/extconf.rake
+rubygems_generators/extconf/templates/tasks/extconf_name.rake
 rubygems_generators/install_jruby/USAGE
 rubygems_generators/install_jruby/install_jruby_generator.rb
 rubygems_generators/install_jruby/templates/tasks/jruby.rake
@@ -88,6 +94,7 @@ tasks/environment.rake
 tasks/generator_report.rake
 tasks/website.rake
 test/test_executable_generator.rb
+test/test_extconf_generator.rb
 test/test_generator_helper.rb
 test/test_helper.rb
 test/test_install_jruby_generator.rb

data/app_generators/newgem/templates/config/hoe.rb

@@ -47,7 +47,7 @@ end
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.developer(AUTHOR, EMAIL)
   p.description = DESCRIPTION
   p.summary = DESCRIPTION
@@ -67,7 +67,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   <% end %>
 end
 
-CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
 PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
-hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
-hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/lib/newgem/version.rb

@@ -1,8 +1,8 @@
 module Newgem #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 19
-    TINY  = 1
+    MINOR = 20
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/rubygems_generators/extconf/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rubygems_generators/extconf/extconf_generator.rb

@@ -0,0 +1,57 @@
+class ExtconfGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory "ext/#{name}"
+      m.directory "tasks/extconf"
+
+      # Create stubs
+      m.template "ext/c_file.c",  "ext/#{name}/#{name}.c"
+      m.template "ext/extconf.rb",  "ext/#{name}/extconf.rb"
+      m.file     "tasks/extconf.rake", "tasks/extconf.rake"
+      m.file     "tasks/extconf_name.rake",  "tasks/extconf/#{name}.rake"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a C-extension via extconf. 
+
+The extension be automatically built before running tests,
+and will be built when the RubyGem is installed by users.
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/rubygems_generators/extconf/templates/ext/c_file.c

@@ -0,0 +1,8 @@
+#include <ruby.h>
+
+void
+Init_<%= name %>()
+{
+  /* nothing here yet */
+  printf("extension <%= name %> got loaded!"); /* TODO: remove me */
+}

data/rubygems_generators/extconf/templates/ext/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+dir_config("<%= name %>")
+
+create_makefile("<%= name %>")

data/rubygems_generators/extconf/templates/tasks/extconf.rake

@@ -0,0 +1,13 @@
+namespace :extconf do
+  desc "Compiles the Ruby extension"
+  task :compile
+end
+
+task :compile => "extconf:compile"
+
+task :test => :compile
+
+BIN = "*.{bundle,jar,so,obj,pdb,lib,def,exp}"
+$hoe.clean_globs |= ["ext/**/#{BIN}", "lib/**/#{BIN}", 'ext/**/Makefile']
+$hoe.spec.require_paths = Dir['{lib,ext/*}']
+$hoe.spec.extensions = FileList["ext/**/extconf.rb"].to_a

data/rubygems_generators/extconf/templates/tasks/extconf_name.rake

@@ -0,0 +1,38 @@
+namespace :extconf do
+  extension = File.basename(__FILE__, '.rake')
+
+  ext = "ext/#{extension}"
+  ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
+  ext_files = FileList[
+    "#{ext}/*.c",
+    "#{ext}/*.h",
+    "#{ext}/*.rl",
+    "#{ext}/extconf.rb",
+    "#{ext}/Makefile",
+    # "lib"
+  ]
+
+
+  task :compile => extension do
+    if Dir.glob("**/#{extension}.*").length == 0
+      STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      STDERR.puts "Gem actually failed to build.  Your system is"
+      STDERR.puts "NOT configured properly to build #{GEM_NAME}."
+      STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      exit(1)
+    end
+  end
+
+  desc "Builds just the #{extension} extension"
+  task extension.to_sym => ["#{ext}/Makefile", ext_so ]
+
+  file "#{ext}/Makefile" => ["#{ext}/extconf.rb"] do
+    Dir.chdir(ext) do ruby "extconf.rb" end
+  end
+
+  file ext_so => ext_files do
+    Dir.chdir(ext) do
+      sh(PLATFORM =~ /win32/ ? 'nmake' : 'make')
+    end
+  end
+end

data/test/test_extconf_generator.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestExtconfGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    name = "myext"
+    run_generator('extconf', [name], sources)
+    assert_directory_exists("ext/myext")
+    assert_directory_exists("tasks/extconf")
+    assert_generated_file("ext/myext/extconf.rb")
+    assert_generated_file("ext/myext/myext.c")
+    assert_generated_file("tasks/extconf.rake")    
+    assert_generated_file("tasks/extconf/myext.rake")
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "rubygems_generators"
+  end
+end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>New Gem Generator</h1>
     <div id="version"> <!--  class="clickable" onclick='document.location = ""; return true' -->
       <p>Get Version</p>
-      <a href="" class="numbers">0.19.1</a>
+      <a href="" class="numbers">0.20.0</a>
       <p>Featured in</p>
       <a  href="http://www.amazon.com/gp/redirect.html?ie=UTF8&location=http%3A%2F%2Fwww.amazon.com%2FBeginning-Ruby-Novice-Professional-Experts%2Fdp%2F1590597664%2F&tag=drnic-20&linkCode=ur2&camp=1789&creative=9325" class="book"><img src="images/beginning-ruby.jpg" /></a>
     </div>

data/website/rubyforge.html

@@ -33,7 +33,7 @@
     <h1>New Gem Generator</h1>
     <div id="version"> <!--  class="clickable" onclick='document.location = ""; return true' -->
       <p>Get Version</p>
-      <a href="" class="numbers">0.19.1</a>
+      <a href="" class="numbers">0.20.0</a>
       <p>Featured in</p>
       <a  href="http://www.amazon.com/gp/redirect.html?ie=UTF8&location=http%3A%2F%2Fwww.amazon.com%2FBeginning-Ruby-Novice-Professional-Experts%2Fdp%2F1590597664%2F&tag=drnic-20&linkCode=ur2&camp=1789&creative=9325" class="book"><img src="images/beginning-ruby.jpg" /></a>
     </div>
@@ -263,7 +263,7 @@ OPTIONS
       specify whether release_notes/changes are preformatted
 </pre>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 5th March 2008<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 4th March 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/version-raw.js

@@ -1,3 +1,3 @@
 // Announcement JS file
-var version = "0.19.1";
+var version = "0.20.0";
 MagicAnnouncement.show('compositekeys', version);

data/website/version.js

@@ -1,4 +1,4 @@
 // Version JS file
-var version = "0.19.1";
+var version = "0.20.0";
 
 document.write(" - " + version);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: newgem
 version: !ruby/object:Gem::Version 
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-27 00:00:00 +10:00
+date: 2008-03-29 23:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -158,6 +158,12 @@ files:
 - rubygems_generators/executable/USAGE
 - rubygems_generators/executable/executable_generator.rb
 - rubygems_generators/executable/templates/app.rb
+- rubygems_generators/extconf/USAGE
+- rubygems_generators/extconf/extconf_generator.rb
+- rubygems_generators/extconf/templates/ext/c_file.c
+- rubygems_generators/extconf/templates/ext/extconf.rb
+- rubygems_generators/extconf/templates/tasks/extconf.rake
+- rubygems_generators/extconf/templates/tasks/extconf_name.rake
 - rubygems_generators/install_jruby/USAGE
 - rubygems_generators/install_jruby/install_jruby_generator.rb
 - rubygems_generators/install_jruby/templates/tasks/jruby.rake
@@ -179,6 +185,7 @@ files:
 - tasks/generator_report.rake
 - tasks/website.rake
 - test/test_executable_generator.rb
+- test/test_extconf_generator.rb
 - test/test_generator_helper.rb
 - test/test_helper.rb
 - test/test_install_jruby_generator.rb
@@ -223,12 +230,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: newgem
-rubygems_version: 1.0.1
+rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
 summary: Make your own gems at home
 test_files: 
 - test/test_executable_generator.rb
+- test/test_extconf_generator.rb
 - test/test_generator_helper.rb
 - test/test_helper.rb
 - test/test_install_jruby_generator.rb