newgem 0.9.1 → 0.9.2

data/History.txt

@@ -1,3 +1,10 @@
++++ 0.9.2 18/4/2007
+
++ 1 minor improvement:
+  + Generated apps include a "require 'rubygems' line at the top"
++ 1 website fix
+  + Notes that the index.txt file includes Dr Nic details, not their own.[FIXME!!]
+
 +++ 0.9.1 16/4/2007
 
 + 1 bugfix:

data/bin/newgem

@@ -1,5 +1,11 @@
 #!/usr/bin/env ruby
 
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
 require 'fileutils'
 require 'active_support'
 require 'optparse'

data/lib/newgem/version.rb

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

data/templates/app.rb

@@ -3,6 +3,12 @@
 #  Created by MYNAME on #{(now = Time.now).year}-#{now.month}-#{now.day}.
 #  Copyright (c) #{now.year}. All rights reserved.
 
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
 require 'optparse'
 
 # NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.

data/website/index.html

@@ -247,6 +247,9 @@ NOW - update wizzo/Rakefile with gem description, etc
 	<p>Remember, the Rakefile is yours to extend as you please with more rake tasks, such as the <code>website</code> tasks already added.</p>
 
 
+	<p>For more information about each task, see the <a href="http://seattlerb.rubyforge.org/hoe/">Hoe <span class="caps">README</span></a></p>
+
+
 	<h2>Related articles</h2>
 
 
@@ -279,7 +282,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>, 15th April 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 17th April 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -72,6 +72,8 @@ The final step before releasing your gem to the world is the all-important websi
 
 Run the rake task <code>rake website_generate</code> to convert all your website txt files into html files.
 
+NOTE: Currently, the initial <code>index.txt</code> file includes my details not yours. Currently you need to change this manually.
+
 If you don't want a website, remove the <code>website</code> related files from the Manifest.txt. 
 
 Make sure you've generated the <code>website/index.html</code> file before continuing to package and release your gem (unless you remove it from the Manifest.txt).
@@ -160,6 +162,8 @@ See them all with:
 
 Remember, the Rakefile is yours to extend as you please with more rake tasks, such as the <code>website</code> tasks already added.
 
+For more information about each task, see the "Hoe README":http://seattlerb.rubyforge.org/hoe/
+
 h2. Related articles
 
 * "Original blog article and tutorial":http://drnicwilliams.com/2006/10/11/generating-new-gems/

data/website/rubyforge.html

@@ -130,8 +130,138 @@ $ rubyforge names
 
 
 	<p><a href="index.html#setup_rubyforge">Return to releasing your gem</a></p>
+
+
+	<h2>rubyforge docco</h2>
+
+
+	<p>The best rubyforge command documentation is available via the application itself (see below) and the <a href="http://codeforpeople.rubyforge.org/rubyforge/">RDocs</a></p>
+
+
+<pre>$ rubyforge help
+SYNOPSIS
+
+  rubyforge [options]* mode [mode_args]*
+
+DESCRIPTION
+
+  simplistic script which automates a limited set of rubyforge operations
+
+MODES
+
+  setup()
+    initializes your .rubyforge directory.  you need to run this first before
+    doing anything else.
+
+    example :
+      rubyforge setup
+
+  config([project])
+    Helps you populate your auto-config.yml file by scraping rubyforge and
+    getting your groups, projects, and releases.
+
+    example :
+      rubyforge config
+      rubyforge config myproject
+
+  names()
+    Prints out the names of your configured groups and projects.
+
+    example :
+      rubyforge names
+
+  login()
+    sends username and password from config.yml (or --username/--password
+    options) and stores login cookie in cookie.dat.  this is required for
+    subsquent operations work.
+
+    example :
+      rubyforge login
+      rubyforge login --username zaphod --password 42
+
+  create_package(group_id, package_name)
+    creates the named package under the specified group.
+
+    example :
+      rubyforge create_package 1024 traits
+      rubyforge login &#38;&#38; rubyforge create_package codeforpeople.com traits
+
+  add_release(group_id, package_id, release_name, userfile)
+    release a file as release_name under the specified group_id and
+    package_id.
+
+    example :
+      rubyforge add_release codeforpeople.com traits 0.8.0 traits-0.8.0.gem
+      rubyforge add_release codeforpeople.com traits 0.8.0 traits-0.8.0.tgz
+      rubyforge add_release 1024 1242 0.8.0 traits-0.8.0.gem
+      rubyforge login &#38;&#38; rubyforge add_release 1024 1242 0.8.0 traits-0.8.0.gem
+
+  add_file(group_id, package_id, release_id, userfile)
+    add a file to an existing release under the specified group_id,
+    package_id, and release_id
+
+    example :
+      rubyforge add_file codeforpeople.com traits 0.8.0 traits-0.8.0.gem
+      rubyforge add_file codeforpeople.com traits 0.8.0 traits-0.8.0.tgz
+      rubyforge add_file 1024 1242 0.8.0 traits-0.8.0.gem
+
+  delete_package(group_id, package_name)
+    deletes a package and all its files.
+
+    example :
+      rubyforge delete_package codeforpeople.com traits
+      rubyforge delete_package 1024 traits
+
+NOTES
+
+  - In order to use group_id, package_id, or release_id by name,
+    rather than number, you must edit the rubyforge[group_ids] and
+    rubyforge[package_ids] translation tables in your config.yml. See
+    the config command for more information and help.
+
+  - don't forget to login!  logging in will store a cookie in your
+    .rubyforge directory which expires after a time.  always run the login
+    command before any operation that requires authentication, such as
+    uploading a package.
+
+TODO
+
+  - add error checking.  this requires screen scraping to see of an operation
+    succeeded since 200 is returned from rubyforge even for failed operations
+    and only the html text reveals the status.
+
+OPTIONS
+
+  global :
+    --help            , -h
+      this message
+    --config          , -c
+      specify a config file (default /Users/nicwilliams/.rubyforge/user-config.yml)
+    --username        , -u
+      specify username, taken from config otherwise
+    --password        , -p
+      specify password, taken from config otherwise
+    --cookie_jar      , -C
+      specify cookie storage file (default /Users/nicwilliams/.rubyforge/cookie.dat)
+
+  add_release :
+    --is_private      , -P
+      if true, release is not public
+    --release_date    , -r
+      specify time of release (default 'now')
+    --type_id         , -t
+      specify filetype code (default determined by ext)
+    --processor_id    , -o
+      specify processor (default 'Any')
+    --release_notes   , -n
+      specify release notes as string or file
+    --release_changes , -a
+      specify release changes as string or file
+    --preformatted    , -f
+      specify whether release_notes/changes are preformatted
+</pre>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 13th April 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 17th April 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/rubyforge.txt

@@ -69,4 +69,131 @@ Check that the new package has been successfully added to your local config file
 
 h2. You are now ready to release gems!
 
-"Return to releasing your gem":index.html#setup_rubyforge
+"Return to releasing your gem":index.html#setup_rubyforge
+
+h2. rubyforge docco
+
+The best rubyforge command documentation is available via the application itself (see below) and the "RDocs":http://codeforpeople.rubyforge.org/rubyforge/
+
+<pre>$ rubyforge help
+SYNOPSIS
+
+  rubyforge [options]* mode [mode_args]*
+
+DESCRIPTION
+
+  simplistic script which automates a limited set of rubyforge operations
+
+MODES
+
+  setup()
+    initializes your .rubyforge directory.  you need to run this first before
+    doing anything else.
+
+    example :
+      rubyforge setup
+
+  config([project])
+    Helps you populate your auto-config.yml file by scraping rubyforge and
+    getting your groups, projects, and releases.
+
+    example :
+      rubyforge config
+      rubyforge config myproject
+
+  names()
+    Prints out the names of your configured groups and projects.
+
+    example :
+      rubyforge names
+
+  login()
+    sends username and password from config.yml (or --username/--password
+    options) and stores login cookie in cookie.dat.  this is required for
+    subsquent operations work.
+
+    example :
+      rubyforge login
+      rubyforge login --username zaphod --password 42
+
+  create_package(group_id, package_name)
+    creates the named package under the specified group.
+
+    example :
+      rubyforge create_package 1024 traits
+      rubyforge login && rubyforge create_package codeforpeople.com traits
+
+  add_release(group_id, package_id, release_name, userfile)
+    release a file as release_name under the specified group_id and
+    package_id.
+
+    example :
+      rubyforge add_release codeforpeople.com traits 0.8.0 traits-0.8.0.gem
+      rubyforge add_release codeforpeople.com traits 0.8.0 traits-0.8.0.tgz
+      rubyforge add_release 1024 1242 0.8.0 traits-0.8.0.gem
+      rubyforge login && rubyforge add_release 1024 1242 0.8.0 traits-0.8.0.gem
+
+  add_file(group_id, package_id, release_id, userfile)
+    add a file to an existing release under the specified group_id,
+    package_id, and release_id
+
+    example :
+      rubyforge add_file codeforpeople.com traits 0.8.0 traits-0.8.0.gem
+      rubyforge add_file codeforpeople.com traits 0.8.0 traits-0.8.0.tgz
+      rubyforge add_file 1024 1242 0.8.0 traits-0.8.0.gem
+
+  delete_package(group_id, package_name)
+    deletes a package and all its files.
+
+    example :
+      rubyforge delete_package codeforpeople.com traits
+      rubyforge delete_package 1024 traits
+
+NOTES
+
+  - In order to use group_id, package_id, or release_id by name,
+    rather than number, you must edit the rubyforge[group_ids] and
+    rubyforge[package_ids] translation tables in your config.yml. See
+    the config command for more information and help.
+
+  - don't forget to login!  logging in will store a cookie in your
+    .rubyforge directory which expires after a time.  always run the login
+    command before any operation that requires authentication, such as
+    uploading a package.
+
+TODO
+
+  - add error checking.  this requires screen scraping to see of an operation
+    succeeded since 200 is returned from rubyforge even for failed operations
+    and only the html text reveals the status.
+
+OPTIONS
+
+  global :
+    --help            , -h
+      this message
+    --config          , -c
+      specify a config file (default /Users/nicwilliams/.rubyforge/user-config.yml)
+    --username        , -u
+      specify username, taken from config otherwise
+    --password        , -p
+      specify password, taken from config otherwise
+    --cookie_jar      , -C
+      specify cookie storage file (default /Users/nicwilliams/.rubyforge/cookie.dat)
+
+  add_release :
+    --is_private      , -P
+      if true, release is not public
+    --release_date    , -r
+      specify time of release (default 'now')
+    --type_id         , -t
+      specify filetype code (default determined by ext)
+    --processor_id    , -o
+      specify processor (default 'Any')
+    --release_notes   , -n
+      specify release notes as string or file
+    --release_changes , -a
+      specify release changes as string or file
+    --preformatted    , -f
+      specify whether release_notes/changes are preformatted
+</pre>

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: newgem
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
-date: 2007-04-16 00:00:00 +02:00
+  version: 0.9.2
+date: 2007-04-18 00:00:00 +02:00
 summary: Make your own gems at home
 require_paths: 
 - lib