newgem 0.22.2 → 0.23.0

data/History.txt

@@ -1,4 +1,12 @@
-== 0.22.2 2008-04-07 [NOT RELEASED]
+== 0.23.0 2008-04-17
+
+* generated website/index.txt has customised rubyforge/github/gitorious information for git
+* installing newgem now displays a post-install message (from PostInstall.txt)
+* uses github_username value from .rubyforge/user-config.yml
+* moved EXTRA_DEPENDENCIES to top of config/hoe.rb
+* websites/*.txt are processed as ERB templates
+
+== 0.22.2 2008-04-07
 
 * Cleaned up the REV cmd [Sascha Teske]
 * Replaced hardcoded rspec values done in a hurry at RubyFools with parameterised values [Alsak Hellesoy]

data/Manifest.txt

@@ -1,18 +1,19 @@
 History.txt
 License.txt
 Manifest.txt
+PostInstall.txt
 README.txt
 Rakefile
 Todo.txt
 app_generators/newgem/newgem_generator.rb
 app_generators/newgem/templates/History.txt
 app_generators/newgem/templates/License.txt
+app_generators/newgem/templates/PostInstall.txt
 app_generators/newgem/templates/README.txt
 app_generators/newgem/templates/Rakefile
 app_generators/newgem/templates/app.rb
 app_generators/newgem/templates/config/hoe.rb
 app_generators/newgem/templates/config/requirements.rb
-app_generators/newgem/templates/empty_log
 app_generators/newgem/templates/module.rb
 app_generators/newgem/templates/readme
 app_generators/newgem/templates/script/console.erb
@@ -42,7 +43,6 @@ bundles/RubyGem.tmbundle/Syntaxes/Rdoc.tmLanguage
 bundles/RubyGem.tmbundle/info.plist
 config/hoe.rb
 config/svn_branch.rb
-install.rb
 lib/newgem.rb
 lib/newgem/quick_template.rb
 lib/newgem/rubyforge.rb

data/PostInstall.txt

@@ -0,0 +1,27 @@
+
+USAGE: newgem project_name
+HELP/OPTIONS: newgem -h
+
+
+newgem uses config from your ~/.rubyforge/user-config.yml file
+You can add the following key/values to this file:
+  full_name  : Dr Nic Williams
+  email      : drnicwilliams@gmail.com
+  github_username: drnic
+
+To create the ~/.rubyforge/user-config.yml file run:
+  rubyforge setup
+  rubyforge config
+
+Whenever you create a new RubyForge.org project, re-run:
+  rubyforge config
+
+
+Did you know you have script/generate generators?
+  application_generator, component_generator, executable,
+  extconf, install_jruby, install_rspec, install_rspec_stories,
+  install_website, test_unit
+
+Have fun making RubyGems!
+
+

data/app_generators/newgem/newgem_generator.rb

@@ -48,7 +48,7 @@ class NewgemGenerator < RubiGen::Base
       m.directory "lib/#{gem_name}"
 
       # Root
-      m.template_copy_each %w( History.txt License.txt Rakefile README.txt )
+      m.template_copy_each %w( History.txt License.txt Rakefile README.txt PostInstall.txt )
       m.file_copy_each     %w( setup.rb )
 
       # Default module for app
@@ -58,10 +58,6 @@ class NewgemGenerator < RubiGen::Base
       # Config
       m.template_copy_each %w( hoe.rb requirements.rb ), "config"
 
-      %w(debug).each { |file|
-        m.file "empty_log", "log/#{file}.log", :chmod => 0666
-      }
-
       # Tasks
       m.file_copy_each %w( deployment.rake environment.rake website.rake ), "tasks"
 
@@ -168,7 +164,6 @@ EOS
     config
     doc
     lib
-    log
     script
     tasks
     test

data/app_generators/newgem/templates/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on <%= gem_name %>, see http://<%= gem_name %>.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

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

@@ -7,6 +7,9 @@ GEM_NAME = '<%= gem_name %>' # what ppl will type to install your gem
 RUBYFORGE_PROJECT = '<%= gem_name %>' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
 
 @config_file = "~/.rubyforge/user-config.yml"
 @config = nil
@@ -28,21 +31,21 @@ Run 'rubyforge setup' to prepare your env for access to Rubyforge
 end
 
 
-REV = nil 
-# UNCOMMENT IF REQUIRED: 
+REV = nil
+# UNCOMMENT IF REQUIRED:
 # REV = YAML.load(`svn info`)['Revision']
 VERS = <%= module_name %>::VERSION::STRING + (REV ? ".#{REV}" : "")
 RDOC_OPTS = ['--quiet', '--title', '<%= gem_name %> documentation',
     "--opname", "index.html",
-    "--line-numbers", 
+    "--line-numbers",
     "--main", "README",
     "--inline-source"]
 
 class Hoe
-  def extra_deps 
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
     @extra_deps
-  end 
+  end
 end
 
 # Generate all the Rake tasks
@@ -55,19 +58,21 @@ $hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
   p.test_globs = ["test/**/test_*.rb"]
   p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
-  
+
   # == Optional
   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'] ]
-  <% if is_jruby %>
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+  <% if is_jruby -%>
   # JRuby gem created, e.g. <%= gem_name %>-X.Y.Z-jruby.gem
   p.spec_extras = { :platform => 'jruby' }    # A hash of extra values to set in the gemspec.
-  <% else %>
+  <% else -%>
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
-  <% end %>
+  <% end -%>
 end
 
 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.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/hoe.rb

@@ -58,4 +58,5 @@ end
 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.rsync_args = '-av --delete --ignore-errors'
+hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/lib/newgem/rubyforge.rb

@@ -3,13 +3,15 @@ require 'rubyforge'
 
 module Newgem
   class Rubyforge
-    attr_reader :full_name, :email
-    
+    attr_reader :full_name, :email, :github_username
+
     def initialize
       @full_name = rubyforge.userconfig['full_name'] || ENV['NAME']  || 'FIXME full name'
       @email     = rubyforge.userconfig['email']     || ENV['EMAIL'] || 'FIXME email'
+      @github_username =
+        rubyforge.userconfig['github_username'] || ENV['GITHUB_USERNAME'] || 'GITHUB_USERNAME'
     end
-    
+
     def rubyforge
       @rubyforge ||= RubyForge.new(::RubyForge::CONFIG_F)
     end

data/lib/newgem/version.rb

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

data/newgem_generators/install_website/install_website_generator.rb

@@ -81,4 +81,13 @@ EOS
       @email  = options[:email]
       @theme  = options[:theme]
     end
+
+    def github_username
+      @github_username ||= begin
+        require 'newgem/rubyforge'
+        rubyforge_config = Newgem::Rubyforge.new
+        rubyforge_config.github_username
+      end
+    end
+
 end

data/newgem_generators/install_website/templates/script/txt2html

@@ -1,8 +1,12 @@
 #!/usr/bin/env ruby
 
+GEM_NAME = '<%= gem_name %>' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = '<%= gem_name %>'
+
 require 'rubygems'
 begin
   require 'newgem'
+  require 'rubyforge'
 rescue LoadError
   puts "\n\nGenerating the website requires the newgem RubyGem"
   puts "Install: gem install newgem\n\n"
@@ -11,10 +15,14 @@ end
 require 'redcloth'
 require 'syntax/convertors/html'
 require 'erb'
-require File.dirname(__FILE__) + '/../lib/<%= gem_name %>/version.rb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
 
 version  = <%= module_name %>::VERSION::STRING
-download = 'http://rubyforge.org/projects/<%= gem_name %>'
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
 
 class Fixnum
   def ordinal
@@ -43,7 +51,6 @@ end
 if ARGV.length >= 1
   src, template = ARGV
   template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
-  
 else
   puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
   exit!
@@ -55,7 +62,8 @@ title = nil
 body = nil
 File.open(src) do |fsrc|
   title_text = fsrc.readline
-  body_text = fsrc.read
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
   syntax_items = []
   body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
     ident = syntax_items.length

data/newgem_generators/install_website/templates/website/index.txt

@@ -27,8 +27,52 @@ h2. How to submit patches
 
 Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
 
+TODO - pick SVN or Git instructions
+
 The trunk repository is <code>svn://rubyforge.org/var/svn/<%= gem_name %>/trunk</code> for anonymous access.
 
+OOOORRRR
+
+You can fetch the source from either:
+
+<%% if rubyforge_project_id %>
+
+* rubyforge: "http://rubyforge.org/scm/?group_id=<%%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%%= rubyforge_project_id %>
+
+<pre>git clone git://rubyforge.org/<%= gem_name %>.git</pre>
+
+<%% else %>
+
+* rubyforge: MISSING IN ACTION
+
+TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects' id information.
+
+When you do this, this message will magically disappear!
+
+Or you can hack website/index.txt and make it all go away!!
+
+<%% end %>
+
+* github: "http://github.com/<%= github_username %>/<%= gem_name %>/tree/master":http://github.com/<%= github_username %>/<%= gem_name %>/tree/master
+
+<pre>git clone git://github.com/<%= github_username %>/<%= gem_name %>.git</pre>
+
+<% if github_username == 'GITHUB_USERNAME' %>
+TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
+<% end %>
+
+* gitorious: "git://gitorious.org/<%= gem_name %>/mainline.git":git://gitorious.org/<%= gem_name %>/mainline.git
+
+<pre>git clone git://gitorious.org/<%= gem_name %>/mainline.git</pre>
+
+h3. Build and test instructions
+
+<pre>cd <%= gem_name %>
+rake test
+rake install_gem</pre>
+
+
 h2. License
 
 This code is free to use under the terms of the MIT license. 

data/test/test_newgem_generator.rb

@@ -2,17 +2,17 @@ require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
 
 class TestNewgemGenerator < Test::Unit::TestCase
   include RubiGen::GeneratorTestHelper
-  
+
   attr_reader :gem_name
   def setup
     bare_setup
     @gem_name = File.basename(File.expand_path(APP_ROOT))
   end
-  
+
   def teardown
     bare_teardown
   end
-  
+
   def test_newgem
     run_generator('newgem', [APP_ROOT], sources)
 
@@ -21,69 +21,69 @@ class TestNewgemGenerator < Test::Unit::TestCase
     assert_directory_exists "log"
     assert_directory_exists "tasks"
     assert_directory_exists "test"
-    
-    %w[Rakefile README.txt History.txt License.txt Manifest.txt].each do |file|
+
+    %w[Rakefile README.txt History.txt License.txt Manifest.txt PostInstall.txt].each do |file|
       assert_generated_file(file)
     end
-    
+
     %w[hoe.rb requirements.rb].each do |file|
       assert_generated_file("config/#{file}")
     end
-    
+
     assert_generated_file("lib/#{gem_name}.rb")
     assert_generated_file("lib/#{gem_name}/version.rb")
-        
+
     ["test_helper.rb", "test_#{gem_name}.rb"].each do |file|
       assert_generated_file("test/#{file}")
     end
-    
+
     %w[generate destroy console].each do |file|
       assert_generated_file("script/#{file}")
     end
-    
+
     assert_generated_module("lib/#{gem_name}")
-    
+
     %w[deployment environment website].each do |file|
       assert_generated_file("tasks/#{file}.rake")
     end
-    
+
     assert_manifest_complete
   end
 
   def test_newgem_with_website_by_default
     run_generator('newgem', [APP_ROOT], sources)
-    
+
     %w[txt2html].each do |file|
       assert_generated_file("script/#{file}")
     end
-    
+
     %w[index.txt index.html template.html.erb stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
       assert_generated_file("website/#{file}")
     end
-    
+
     assert_manifest_complete
   end
 
   def test_newgem_with_no_website
     run_generator('newgem', [APP_ROOT], sources, {:disable_website => true})
-    
+
     assert !File.exists?("#{APP_ROOT}/script/txt2html"), "No script/txt2html should be generated"
     assert !File.exists?("#{APP_ROOT}/website"), "No website folder should be generated"
-    
+
     assert_manifest_complete
   end
 
   def test_newgem_with_executable
     @executables = ["some_executable", "another"]
     run_generator('newgem', [APP_ROOT], sources, {:bin_name => @executables.join(',')})
-    
+
     @executables.each do |exec|
-      assert_generated_file("bin/#{exec}")      
+      assert_generated_file("bin/#{exec}")
     end
-    
+
     assert_manifest_complete
   end
-  
+
   def test_newgem_with_rspec
     run_generator('newgem', [APP_ROOT], sources, {:test_framework => "rspec"})
 
@@ -92,19 +92,19 @@ class TestNewgemGenerator < Test::Unit::TestCase
     assert_generated_file("spec/#{gem_name}_spec.rb")
     assert_generated_file("spec/spec_helper.rb")
     assert_generated_file("tasks/rspec.rake")
-    
+
     assert_manifest_complete
   end
-  
+
   def test_newgem_with_jruby
     run_generator('newgem', [APP_ROOT], sources, {:jruby => true})
 
     assert_directory_exists("tasks")
     assert_generated_file("tasks/jruby.rake")
-    
+
     assert_manifest_complete
   end
-  
+
   def test_run_in_trunk_path_finds_parent_path_for_gem_name
     expected_gem_name = File.basename(File.expand_path(APP_ROOT))
     app_root = File.join(APP_ROOT, "trunk")
@@ -113,7 +113,7 @@ class TestNewgemGenerator < Test::Unit::TestCase
     generator = run_generator('newgem', [app_root], sources)
     assert_equal(expected_gem_name, generator.gem_name)
   end
-  
+
   private
   def sources
     [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path)),
@@ -122,11 +122,11 @@ class TestNewgemGenerator < Test::Unit::TestCase
       RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "rubygems_generators"))
     ]
   end
-  
+
   def generator_path
     "app_generators"
   end
-  
+
   def assert_manifest_complete
     files = app_root_files.sort
     files.reject! { |file| File.directory?(file) }

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.22.2</a>
+      <a href="" class="numbers">0.23.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.22.2</a>
+      <a href="" class="numbers">0.23.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/version-raw.js

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

data/website/version.js

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: newgem
 version: !ruby/object:Gem::Version 
-  version: 0.22.2
+  version: 0.23.0
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-09 00:00:00 +10:00
+date: 2008-04-17 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,10 +68,12 @@ extra_rdoc_files:
 - History.txt
 - License.txt
 - Manifest.txt
+- PostInstall.txt
 - README.txt
 - Todo.txt
 - app_generators/newgem/templates/History.txt
 - app_generators/newgem/templates/License.txt
+- app_generators/newgem/templates/PostInstall.txt
 - app_generators/newgem/templates/README.txt
 - newgem_generators/install_website/templates/website/index.txt
 - newgem_theme_generators/long_box_theme/templates/website/index.txt
@@ -84,18 +86,19 @@ files:
 - History.txt
 - License.txt
 - Manifest.txt
+- PostInstall.txt
 - README.txt
 - Rakefile
 - Todo.txt
 - app_generators/newgem/newgem_generator.rb
 - app_generators/newgem/templates/History.txt
 - app_generators/newgem/templates/License.txt
+- app_generators/newgem/templates/PostInstall.txt
 - app_generators/newgem/templates/README.txt
 - app_generators/newgem/templates/Rakefile
 - app_generators/newgem/templates/app.rb
 - app_generators/newgem/templates/config/hoe.rb
 - app_generators/newgem/templates/config/requirements.rb
-- app_generators/newgem/templates/empty_log
 - app_generators/newgem/templates/module.rb
 - app_generators/newgem/templates/readme
 - app_generators/newgem/templates/script/console.erb
@@ -125,7 +128,6 @@ files:
 - bundles/RubyGem.tmbundle/info.plist
 - config/hoe.rb
 - config/svn_branch.rb
-- install.rb
 - lib/newgem.rb
 - lib/newgem/quick_template.rb
 - lib/newgem/rubyforge.rb
@@ -212,7 +214,34 @@ files:
 - website/version.txt
 has_rdoc: true
 homepage: http://newgem.rubyforge.org
-post_install_message: 
+post_install_message: |+
+  
+  USAGE: newgem project_name
+  HELP/OPTIONS: newgem -h
+  
+  
+  newgem uses config from your ~/.rubyforge/user-config.yml file
+  You can add the following key/values to this file:
+    full_name  : Dr Nic Williams
+    email      : drnicwilliams@gmail.com
+    github_username: drnic
+  
+  To create the ~/.rubyforge/user-config.yml file run:
+    rubyforge setup
+    rubyforge config
+  
+  Whenever you create a new RubyForge.org project, re-run:
+    rubyforge config
+  
+  
+  Did you know you have script/generate generators?
+    application_generator, component_generator, executable,
+    extconf, install_jruby, install_rspec, install_rspec_stories,
+    install_website, test_unit
+  
+  Have fun making RubyGems!
+  
+  
 rdoc_options: 
 - --main
 - README.txt
@@ -233,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: newgem
-rubygems_version: 1.1.0
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: Make your own gems at home