newgem 0.8.1 → 0.9.0

data/History.txt

@@ -0,0 +1,25 @@
++++ 0.9.0 12/4/2007
+
++ 3 major enhancements:
+  + Includes a basic website template, with rake tasks for generation and upload to rubyforge
+  + Generates a History.txt file, and automatically uses it in Hoe task
+  + Generated applications include framework for supporting command line options
++ 3 minor enhancements:
+  + Include History.txt in this gem
+  + test files ordered correctly in generated Manifest.txt
+  + no blank line in Manifest.txt if no bin apps
+
++++ 0.8.1 
+
+  - Generated test file's class name now prefixed with Test, instead of suffixed
+
++++ 0.8.0 
+
+  - Uses hoe itself - less hypocritical
+	- Generated test files use name 'test_<gemname>.rb' instead of '<gemname>_test.rb' to support
+	  ZenTest's autotest expectations of naming. Manifest updated too.
+
++++ 0.7.1 
+
+  - Installed gems now don't require 'hoe' (based on comments at  http://blog.evanweaver.com/articles/2007/01/10/if-you-dont-want-to-hoe-echoe)
+

data/Manifest.txt

@@ -1,4 +1,4 @@
-CHANGELOG
+History.txt
 Manifest.txt
 README
 Rakefile
@@ -6,10 +6,31 @@ bin/newgem
 install.rb
 lib/newgem.rb
 lib/newgem/version.rb
+scripts/txt2html
+scripts/txt2js
 setup.rb
+templates/History.txt
 templates/Manifest.txt
 templates/Rakefile
+templates/app.rb
+templates/scripts/txt2html
 templates/setup.rb
 templates/test.rb
+templates/website/index.txt
+templates/website/javascripts/rounded_corners_lite.inc.js
+templates/website/stylesheets/screen.css
+templates/website/template.rhtml
 test/test_helper.rb
 test/test_newgem.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/rubyforge.html
+website/rubyforge.txt
+website/stylesheets/screen.css
+website/template.js
+website/template.rhtml
+website/version-raw.js
+website/version-raw.txt
+website/version.js
+website/version.txt

data/Rakefile

@@ -18,8 +18,8 @@ RUBYFORGE_PROJECT = "newgem"
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 
 REV = nil #File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
-VERSION = ENV['VERSION'] || (Newgem::VERSION::STRING + (REV ? ".#{REV}" : ""))
-CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+VERS = ENV['VERSION'] || (Newgem::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
 RDOC_OPTS = ['--quiet', '--title', "newgem documentation",
     "--opname", "index.html",
     "--line-numbers", 
@@ -28,7 +28,7 @@ RDOC_OPTS = ['--quiet', '--title', "newgem documentation",
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERSION) do |p|
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.author = AUTHOR 
   p.description = DESCRIPTION
   p.email = EMAIL
@@ -39,8 +39,41 @@ hoe = Hoe.new(GEM_NAME, VERSION) do |p|
   p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
 
   # == Optional
-  #p.changes        - A description of the release's latest changes.
-  p.extra_deps = ['hoe']  #An array of rubygem dependencies.
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [
+    ['hoe', '>=1.2.0'],
+    ['RedCloth','>=3.0.4'],
+    ['syntax','>=1.0.0']
+  ]
   #p.spec_extras    - A hash of extra values to set in the gemspec.
 end
 
+desc 'Generate website files'
+task :website_generate => :load_consts do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+  sh %{ ruby scripts/txt2js website/version.txt > website/version.js }
+  sh %{ ruby scripts/txt2js website/version-raw.txt > website/version-raw.js }
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+task :load_consts do
+  ENV['AUTHOR'] = AUTHOR
+  ENV['EMAIL'] = EMAIL
+  ENV['DESCRIPTION'] = DESCRIPTION
+  ENV['GEM_NAME'] = GEM_NAME
+  ENV['RUBYFORGE_PROJECT'] = RUBYFORGE_PROJECT
+  ENV['HOMEPATH'] = HOMEPATH
+end

data/bin/newgem

@@ -35,6 +35,7 @@ BANNER
   opts.parse!(ARGV)
 end
 OPTIONS[:version] = OPTIONS[:version].to_s.split(/\./)
+version_str       = OPTIONS[:version].join('.')
 
 gem_name = project_name = ARGV[0]
 parser.parse!(["-h"]) unless gem_name
@@ -43,9 +44,11 @@ module_name  = project_name.classify
 lib = project_name + '/lib'
 lib_project_name = project_name + '/lib/' + project_name
 version = project_name + "/lib/" + project_name + "/version.rb"
-rakefile, changelog, readme, setup, manifest, history = 
-  %w(Rakefile CHANGELOG.txt README.txt setup.rb Manifest.txt History.txt).
+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/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"
@@ -53,7 +56,8 @@ test_helper = test + "/test_helper.rb"
 unit_test = test + "/test_" + project_name + ".rb"
 
 examples = project_name + '/examples'
-bin = project_name + '/bin'
+bin      = project_name + '/bin'
+folders  = %w( scripts website website/javascripts website/stylesheets)
 
 # Rakefile variables
 author = ENV['USERNAME'] || ENV['USER'] || 'you'
@@ -63,12 +67,6 @@ FileUtils.rm_rf project_name
 puts "creating: " + project_name
 Dir.mkdir project_name
 
-puts "creating: " + changelog
-FileUtils.touch changelog
-
-puts "creating: " + history
-FileUtils.touch history
-
 puts "creating: " + readme
 File.open(readme, 'w') do |file|
   file << <<-eos
@@ -82,6 +80,12 @@ end
 puts "creating: " + lib
 Dir.mkdir lib
 
+folders.each do |folder|
+  new_folder = project_name + '/' + folder
+  puts "creating: " + new_folder
+  Dir.mkdir new_folder
+end
+
 if OPTIONS[:import_path]
   require 'fileutils'
   OPTIONS[:import_path].chomp! if OPTIONS[:import_path][-1] == 47 # /
@@ -116,13 +120,12 @@ Dir.mkdir bin
 
 if OPTIONS[:bin_name]
   bin_names_list = OPTIONS[:bin_name].split(',')
+  template = File.open(templates + 'app.rb','r') {|f| f.readlines.join}
+  p template
   bin_names_list.each do |bin_name|
     puts "creating: " + bin + '/' + bin_name
     File.open(bin + '/' + bin_name, 'w') do |file|
-      file << <<-eos
-#!/usr/bin/env ruby
-
-eos
+      file << eval('"' + template.gsub(/"/, '\"') + '"')
     end
   end
   bin_names = bin_names_list.join(' ')
@@ -131,19 +134,6 @@ else
   bin_names_list = []
 end
 
-puts "creating: " + rakefile
-template = File.open(templates + 'Rakefile','r') {|f| f.readlines.join}
-File.open(rakefile, 'w') do |file|
-  file << eval('"' + template.gsub(/"/, '\"') + '"')
-end
-
-puts "creating: " + manifest
-template = File.open(templates + 'Manifest.txt','r') {|f| f.readlines.join}
-File.open(manifest, 'w') do |file|
-  file << eval('"' + template.gsub(/"/, '\"') + '"')
-end
-
-
 
 puts "creating: " + test
 Dir.mkdir test
@@ -171,4 +161,26 @@ File.open(setup, 'w') do |file|
   file << template
 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")
+
+template_files.each do |template_file|
+  puts "creating: " + project_name + '/' + template_file
+  template = File.open(templates + template_file,'r') {|f| f.readlines.join}
+  File.open(project_name + '/' + template_file, 'w') do |file|
+    file << eval('"' + template.gsub(/"/, '\"') + '"')
+  end  
+end
+
+copy_files.each do |file|
+  puts "copying: " + project_name + '/' + file
+  template = File.open(templates + file,'r') {|f| f.readlines.join}
+  File.open(project_name + '/' + file, 'w') do |file|
+    file << template
+  end  
+end
+
+
+
 puts "NOW - update #{gem_name}/Rakefile with gem description, etc"

data/lib/newgem/version.rb

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

data/scripts/txt2html

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+require File.dirname(__FILE__) + '/../lib/newgem/version.rb'
+
+version  = Newgem::VERSION::STRING
+download = ENV['HOMEPAGE']
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class=\"syntax\">#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/scripts/txt2js

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require 'active_support'
+require File.dirname(__FILE__) + '/../lib/newgem/version.rb'
+
+version  = Newgem::VERSION::STRING
+download = 'http://rubyforge.org/projects/newgem'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.dirname(__FILE__) + '/../website/template.js'
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.js] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text)
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/templates/History.txt

@@ -0,0 +1,4 @@
++++ #{version_str} #{Date.today}
+
++ 1 major enhancement:
+  + Initial release

data/templates/Manifest.txt

@@ -1,11 +1,14 @@
-CHANGELOG.txt
 History.txt
 Manifest.txt
 README.txt
 Rakefile
-#{bin_names_list.collect {|name| 'bin/' + name }.join('\n')}
-lib/#{project_name}.rb
+#{bin_names_list}lib/#{project_name}.rb
 lib/#{project_name}/version.rb
+scripts/txt2html
 setup.rb
-test/test_helper.rb
-test/test_#{project_name}.rb
+#{test_names_list}
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/templates/Rakefile

@@ -22,7 +22,7 @@ HOMEPATH = "http://\#{RUBYFORGE_PROJECT}.rubyforge.org"
 NAME = "#{gem_name}"
 REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
 VERS = ENV['VERSION'] || (#{module_name}::VERSION::STRING + (REV ? ".\#{REV}" : ""))
-                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
 RDOC_OPTS = ['--quiet', '--title', "#{gem_name} documentation",
     "--opname", "index.html",
     "--line-numbers", 
@@ -44,11 +44,32 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.summary = DESCRIPTION
   p.url = HOMEPATH
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/*_test.rb"]
+  p.test_globs = ["test/**/test_*.rb"]
   p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
   
   # == Optional
-  #p.changes        - A description of the release's latest changes.
-  #p.extra_deps     - An array of rubygem dependencies.
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
 end
+
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html \#{txt} > \#{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "\#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/\#{RUBYFORGE_PROJECT}/"
+  # remote_dir = "/var/www/gforge-projects/\#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av \#{local_dir}/ \#{host}:\#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]