newgem 0.9.4 → 0.10.0

data/History.txt

@@ -1,9 +1,20 @@
-+++ 0.9.4 
++++ 0.10.0 2007-05-19
 
-+ 3 minor enhancement
++ 3 major enhancements
+	+ can generate rspec default tests (or still test::unit tests) using --with-test=rspec [thx Robby Russell]
+  + fetches your full name and email from ~/.rubyforge/user-config.yml (add keys user_name and email)
++ 2 minor enhancements
+  + Generated lib/#{gem_name}.rb includes an empty module
+  + Generated lib/#{gem_name}.rb does not include "require all", instead you do it manually for each included file
+
++++ 0.9.4 2007-05-18
+
++ 5 minor enhancements
+	+ Pass your full name into the generator to be inserted into License.txt, index.txt, Rakefile etc
   + 'Licence' => 'License' (thx Peter Burns)
   + Generates a blank index.html so that 'rake package' works straight away
   + Includes :local_deploy which does tasks :website_generate and :install_gem
+  + License.txt generated + this gem has a License.txt file (MIT license)
 
 +++ 0.9.3 20/4/2007
 

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2007 Dr Nic Williams
+
+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/Manifest.txt

@@ -1,20 +1,25 @@
 History.txt
+License.txt
 Manifest.txt
 README
 Rakefile
+Todo.txt
 bin/newgem
 install.rb
 lib/newgem.rb
+lib/newgem/rubyforge.rb
 lib/newgem/version.rb
 scripts/txt2html
 scripts/txt2js
 setup.rb
 templates/History.txt
+templates/License.txt
 templates/Manifest.txt
 templates/Rakefile
 templates/app.rb
 templates/scripts/txt2html
 templates/setup.rb
+templates/spec.rb
 templates/test.rb
 templates/website/index.html
 templates/website/index.txt

data/Todo.txt

@@ -0,0 +1,2 @@
++ can generate rspec default tests (or still test::unit tests) using --with-test=rspec [thx Robby Russell]
++ website components are now optional (-w/--no-website)

data/bin/newgem

@@ -10,12 +10,17 @@ require 'fileutils'
 require 'active_support'
 require 'optparse'
 
+require 'newgem'
+
 templates = File.dirname(__FILE__) + '/../templates/'
 
 OPTIONS = {
   :import_path => nil,
   :version     => '0.0.1',
-  :bin_name    => nil
+  :full_name   => nil,
+  :email       => nil,
+  :bin_name    => nil,
+  :test_framework => 'test::unit'
 }
 parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
@@ -33,6 +38,15 @@ BANNER
   opts.on("-i", "--import_path=PATH", String,
           "Path where your files could be copied from.",
           "Default: none") { |OPTIONS[:import_path]| }
+  opts.on("-n", "--full_name=PATH", String,
+          "Your name to be inserted into generated files.",
+          "Default: ~/.rubyforge/user-config.yml[user_name]") { |OPTIONS[:full_name]| }
+  opts.on("-e", "--email=PATH", String,
+          "Your email to be inserted into generated files.",
+          "Default: ~/.rubyforge/user-config.yml[email]") { |OPTIONS[:email]| }
+  opts.on("-t", "--test-with=TEST_FRAMEWORK", String,
+          "Your preferred testing framework: Options: test::unit (default), rspec.",
+          "Default: test::unit") { |OPTIONS[:test_framework]| }           
   opts.on("-v", "--version=YOUR_VERSION", String,
           "Version of the gem you are creating.",
           "Default: 0.0.1") { |OPTIONS[:version]| }
@@ -42,6 +56,14 @@ BANNER
 end
 OPTIONS[:version] = OPTIONS[:version].to_s.split(/\./)
 version_str       = OPTIONS[:version].join('.')
+author            = OPTIONS[:full_name]
+email             = OPTIONS[:email]
+unless author && email
+  rubyforge_config = Newgem::Rubyforge.new
+  author ||= rubyforge_config.full_name
+  email  ||= rubyforge_config.email
+end
+test_framework    = OPTIONS[:test_framework]
 
 gem_name = project_name = ARGV[0]
 parser.parse!(["-h"]) unless gem_name
@@ -52,22 +74,15 @@ lib_project_name = project_name + '/lib/' + project_name
 version = project_name + "/lib/" + project_name + "/version.rb"
 readme, setup = %w(README.txt setup.rb).
 	collect {|f| project_name + '/' + f}
-template_files = %w(Rakefile Manifest.txt History.txt scripts/txt2html website/index.txt website/index.html website/template.rhtml)
+template_files = %w(Rakefile History.txt License.txt Manifest.txt scripts/txt2html website/index.txt website/index.html website/template.rhtml)
 copy_files = %w(website/javascripts/rounded_corners_lite.inc.js website/stylesheets/screen.css)
 
-
-test = project_name + "/test"
 main = project_name + "/lib/" + project_name + ".rb"
-test_helper = test + "/test_helper.rb"
-unit_test = test + "/test_" + project_name + ".rb"
 
 examples = project_name + '/examples'
 bin      = project_name + '/bin'
 folders  = %w( scripts website website/javascripts website/stylesheets)
 
-# Rakefile variables
-author = ENV['USERNAME'] || ENV['USER'] || 'you'
-
 FileUtils.rm_rf project_name
 
 puts "creating: " + project_name
@@ -84,12 +99,12 @@ end
 
 
 puts "creating: " + lib
-Dir.mkdir lib
+FileUtils.mkdir_p lib
 
 folders.each do |folder|
   new_folder = project_name + '/' + folder
   puts "creating: " + new_folder
-  Dir.mkdir new_folder
+  FileUtils.mkdir_p new_folder
 end
 
 if OPTIONS[:import_path]
@@ -99,16 +114,21 @@ if OPTIONS[:import_path]
 end
 
 puts "creating: " + lib_project_name
-Dir.mkdir lib_project_name
+FileUtils.mkdir_p lib_project_name
 
 puts "creating: " + main
 File.open(main, 'w') do |file|
-  file << "Dir[File.join(File.dirname(__FILE__), '#{project_name}/**/*.rb')].sort.each { |lib| require lib }"
+  file << <<-EOS 
+module #{module_name}
+end
+
+require '#{module_name}/version'
+  EOS
 end
 
 puts "creating: " + version
 File.open(version, 'w') do |file|
-  file << <<-eos
+  file << <<-EOS
 module #{module_name} #:nodoc:
   module VERSION #:nodoc:
     MAJOR = #{OPTIONS[:version][0] || '0'}
@@ -118,7 +138,7 @@ module #{module_name} #:nodoc:
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end
-eos
+  EOS
 end
 
 puts "creating: " + bin
@@ -139,20 +159,41 @@ else
   bin_names_list = []
 end
 
+# Setup spec/test::unit environments
+# Would like to refactor this...
+if test_framework == 'rspec'
+  test = project_name + "/spec"
+  test_helper = test + "/spec_helper.rb"
+  test_template = 'spec.rb'
+  unit_test = test + "/" + project_name + "_spec.rb"
+  test_file_prefix = 'spec/NAME_spec'
+  unit_test_template = <<-eos
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/#{project_name}'
+eos
+else  
+  test = project_name + "/test"
+  test_helper = test + "/test_helper.rb"
+  test_template = 'test.rb'
+  unit_test = test + "/test_" + project_name + ".rb"
+  test_file_prefix = 'test/test_NAME'
+  unit_test_template = <<-eos
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/#{project_name}'
+eos
+end
 
 puts "creating: " + test
 Dir.mkdir test
 
 puts "creating: " + test_helper
 File.open(test_helper, 'w') do |file|
-  file << <<-eos
-require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/#{project_name}'
-eos
+  file << unit_test_template
 end
 
 puts "creating: " + unit_test
-template = File.open(templates + 'test.rb','r') {|f| f.readlines.join}
+
+template = File.open(templates + test_template,'r') {|f| f.readlines.join}
 File.open(unit_test, 'w') do |file|
   file << eval('"' + template.gsub(/"/, '\"') + '"')
 end
@@ -168,7 +209,7 @@ end
 
 bin_names_list = bin_names_list.collect {|name| 'bin/' + name }.join("\n")
 bin_names_list += "\n" if bin_names_list.size > 0
-test_names_list = ['helper.rb',"#{project_name}.rb"].sort.collect {|name| 'test/test_' + name }.join("\n")
+test_names_list = ['helper.rb',"#{project_name}.rb"].sort.collect {|name| test_file_prefix.gsub('NAME', name) + name }.join("\n")
 
 template_files.each do |template_file|
   puts "creating: " + project_name + '/' + template_file

data/lib/newgem.rb

@@ -1 +1,5 @@
-Dir['newgem/**/*.rb'].each { |lib| require lib }
+module Newgem #:nodoc:
+end
+
+require 'newgem/rubyforge'
+require 'newgem/version'

data/lib/newgem/rubyforge.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rubyforge'
+
+module Newgem
+  class Rubyforge
+    attr_reader :full_name, :email
+    
+    def initialize
+      @full_name = rubyforge.userconfig['full_name'] || ENV['NAME']  || 'FIXME full name'
+      @email     = rubyforge.userconfig['email']     || ENV['EMAIL'] || 'FIXME email'
+    end
+    
+    def rubyforge
+      @rubyforge ||= RubyForge.new(::RubyForge::CONFIG_F)
+    end
+
+  end
+end

data/lib/newgem/version.rb

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

data/templates/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) #{Time.now.year} #{author}
+
+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/templates/Rakefile

@@ -12,7 +12,7 @@ include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', '#{gem_name}', 'version')
 
 AUTHOR = '#{author}'  # can also be an array of Authors
-EMAIL = "your contact email for bug fixes and info"
+EMAIL = "#{email}"
 DESCRIPTION = "description of gem"
 GEM_NAME = '#{gem_name}' # what ppl will type to install your gem
 RUBYFORGE_PROJECT = '#{gem_name}' # The unix name for your project

data/templates/spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.rubyforge.org/

data/templates/website/index.txt

@@ -21,10 +21,12 @@ h2. Forum
 
 "http://groups.google.com/group/#{gem_name}":http://groups.google.com/group/#{gem_name}
 
+TODO - create Google Group - #{gem_name}
+
 h2. License
 
 This code is free to use under the terms of the MIT license. 
 
 h2. Contact
 
-Comments are welcome. Send an email to "Dr Nic Williams":mailto:drnicwilliams@gmail.com.
+Comments are welcome. Send an email to "#{author}":mailto:#{email}.

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>New Gem Generator</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/newgem"; return false'>
       Get Version
-      <a href="http://rubyforge.org/projects/newgem" class="numbers">0.9.4</a>
+      <a href="http://rubyforge.org/projects/newgem" class="numbers">0.10.0</a>
     </div>
     <h1>&#x2192; &#8216;newgem&#8217;</h1>
 
@@ -98,6 +98,9 @@ copying: wizzo/website/stylesheets/screen.css
 NOW - update wizzo/Rakefile with gem description, etc
 </pre>
 
+	<p>As of 0.10.0 &#8211; you can generate test::unit or rspec test stubs via the -t,&#8212;test-with options</p>
+
+
 	<h3>Setup</h3>
 
 
@@ -287,7 +290,7 @@ other stories and things.</p>
 
 	<p>Comments are welcome. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a>.</p>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 10th May 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 19th May 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -52,6 +52,8 @@ copying: wizzo/website/stylesheets/screen.css
 NOW - update wizzo/Rakefile with gem description, etc
 </pre>
 
+As of 0.10.0 - you can generate test::unit or rspec test stubs via the -t, --test-with options
+
 h3. Setup
 
 Now modify the constants at the top of *Rakefile*, with your name, email and the location where you'll host your website for the gem. The defaults are tied to RubyForge for uploading the gems and the website (see below).

data/website/rubyforge.html

@@ -33,7 +33,7 @@
     <h1>New Gem Generator</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/newgem"; return false'>
       Get Version
-      <a href="http://rubyforge.org/projects/newgem" class="numbers">0.9.4</a>
+      <a href="http://rubyforge.org/projects/newgem" class="numbers">0.10.0</a>
     </div>
     <h1>&#x2192; using &#8216;rubyforge&#8217;</h1>
 

data/website/version-raw.js

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

data/website/version.js

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

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: newgem
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
-date: 2007-05-10 00:00:00 +02:00
+  version: 0.10.0
+date: 2007-05-19 00:00:00 -07:00
 summary: Make your own gems at home
 require_paths: 
 - lib
@@ -30,22 +30,27 @@ authors:
 - Dr Nic Williams
 files: 
 - History.txt
+- License.txt
 - Manifest.txt
 - README
 - Rakefile
+- Todo.txt
 - bin/newgem
 - install.rb
 - lib/newgem.rb
+- lib/newgem/rubyforge.rb
 - lib/newgem/version.rb
 - scripts/txt2html
 - scripts/txt2js
 - setup.rb
 - templates/History.txt
+- templates/License.txt
 - templates/Manifest.txt
 - templates/Rakefile
 - templates/app.rb
 - templates/scripts/txt2html
 - templates/setup.rb
+- templates/spec.rb
 - templates/test.rb
 - templates/website/index.html
 - templates/website/index.txt