newgem 0.11.0 → 0.13.0

data/History.txt

@@ -1,3 +1,45 @@
+== 0.13.0 2007-08-20
+
+* HIGHLIGHT - RubiGen integration - using a Rails-like generator
+  * Now, each RubyGem has script/generate to access Rails-like generators too!!!
+  * newgem can be run ontop of existing RubyGems and all is not destroyed!
+  * Various included generators (application_generator, component_generator)
+  * Website creation is now a generator, and is optionally included via newgem -w
+  * Rspec support is now a generator, and is optionally included via newgem -t rspec
+  * JRuby support is now a generator, and is optionally included via newgem -j
+  * The Rakefile is now <5 lines - all config is in config/hoe.rb
+* Generated gems:
+  * Started to add jruby specific features (-j option)
+    * Gems named xxx-1.2.3-jruby.gem
+    * Includes: require 'java'
+  * Add link to website for Using New Gem on Windows (without cygwin) [thx Jorge Cangas]
+  * index.txt "email me" now refers to forum url as well
+* NewGem
+  * An error message is shown if Hoe gem isn't available when running rake on the gem
+  * Lots of tasks refactored into /tasks folder
+* How To UPGRADE
+  * NOTE: We've never had a "How to Upgrade" before! :)
+  * Copy your Rakefile to Rakefile.old (to retain your configuration)
+  * Run: newgem .
+  * Press 'a' to allow all changes.
+  * Open config/hoe.rb
+  * Replace this with the equivalent lines/details from Rakefile.old
+  * Test all is well with "rake -T" and "rake check_manifest" (the manifest should have
+    been rebuilt by 'newgem .')
+
+== 0.12.0 2007-06-24
+
+* 2 major enhancement
+  * Using Erb for templates [thx http://snippets.dzone.com/posts/show/1723]
+  * RubyGem.tmbundle for TextMate - to install go to gem folder and run "rake bundles:tm"
+* 1 minor enhancement
+  * -V option shows current newgem version [thx Gert Goet]
+  * Hoe#extra_deps permanently changes @extra_deps [thx MIYAMUKO Katsuyuki]
+* Dev improvements
+  * Imports svn_branch for svn rake tasks
+* Minor website changes
+  * Added link to Topfunky's tutorial on Hoe
+
 == 0.11.0
 
 * 1 major enhancement

data/Manifest.txt

@@ -4,31 +4,98 @@ Manifest.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/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/script/destroy
+app_generators/newgem/templates/script/generate
+app_generators/newgem/templates/setup.rb
+app_generators/newgem/templates/spec.opts
+app_generators/newgem/templates/spec.rb
+app_generators/newgem/templates/tasks/deployment.rake
+app_generators/newgem/templates/tasks/environment.rake
+app_generators/newgem/templates/tasks/website.rake
+app_generators/newgem/templates/test.rb
+app_generators/newgem/templates/test_helper.rb
+app_generators/newgem/templates/version.rb
 bin/newgem
+bundles/RubyGem.tmbundle/Snippets/History header trunk.tmSnippet
+bundles/RubyGem.tmbundle/Snippets/History header.tmSnippet
+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
+lib/newgem/tasks.rb
 lib/newgem/version.rb
-scripts/txt2html
-scripts/txt2js
+newgem_generators/install_website/USAGE
+newgem_generators/install_website/install_website_generator.rb
+newgem_generators/install_website/templates/script/txt2html
+newgem_generators/install_website/templates/tasks/website.rake
+newgem_generators/install_website/templates/website/index.html
+newgem_generators/install_website/templates/website/index.txt
+newgem_theme_generators/plain/USAGE
+newgem_theme_generators/plain/plain_generator.rb
+newgem_theme_generators/plain/templates/website/javascripts/rounded_corners_lite.inc.js
+newgem_theme_generators/plain/templates/website/stylesheets/screen.css
+newgem_theme_generators/plain/templates/website/template.rhtml
+rubygems_generators/application_generator/USAGE
+rubygems_generators/application_generator/application_generator_generator.rb
+rubygems_generators/application_generator/templates/bin
+rubygems_generators/application_generator/templates/generator.rb
+rubygems_generators/application_generator/templates/readme
+rubygems_generators/application_generator/templates/test.rb
+rubygems_generators/application_generator/templates/test_generator_helper.rb
+rubygems_generators/application_generator/templates/usage
+rubygems_generators/component_generator/USAGE
+rubygems_generators/component_generator/component_generator_generator.rb
+rubygems_generators/component_generator/templates/generator.rb
+rubygems_generators/component_generator/templates/readme
+rubygems_generators/component_generator/templates/test.rb
+rubygems_generators/component_generator/templates/test_generator_helper.rb
+rubygems_generators/component_generator/templates/usage
+rubygems_generators/executable/executable_generator.rb
+rubygems_generators/executable/templates/app.rb
+rubygems_generators/install_jruby/USAGE
+rubygems_generators/install_jruby/install_jruby_generator.rb
+rubygems_generators/install_jruby/templates/tasks/jruby.rake
+rubygems_generators/install_rspec/USAGE
+rubygems_generators/install_rspec/install_rspec_generator.rb
+rubygems_generators/install_rspec/templates/spec.rb
+rubygems_generators/install_rspec/templates/spec/spec.opts
+rubygems_generators/install_rspec/templates/spec/spec_helper.rb
+rubygems_generators/install_rspec/templates/tasks/rspec.rake
+script/destroy
+script/generate
+script/txt2html
+script/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.opts
-templates/spec.rb
-templates/test.rb
-templates/website/index.html
-templates/website/index.txt
-templates/website/javascripts/rounded_corners_lite.inc.js
-templates/website/stylesheets/screen.css
-templates/website/template.rhtml
+tasks/bundles.rake
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_application_generator_generator.rb
+test/test_executable_generator.rb
+test/test_generate_component_generator.rb
+test/test_generator_helper.rb
 test/test_helper.rb
+test/test_install_jruby_generator.rb
+test/test_install_rspec_generator.rb
+test/test_install_website_generator.rb
 test/test_newgem.rb
+test/test_newgem_generator.rb
+test/test_plain_generator.rb
+website/images/beginning-ruby.jpg
 website/index.html
 website/index.txt
 website/javascripts/rounded_corners_lite.inc.js

data/README.txt

@@ -28,7 +28,7 @@ creating: wizzo
 creating: wizzo/CHANGELOG.txt
 creating: wizzo/README.txt
 creating: wizzo/lib
-creating: wizzo/scripts
+creating: wizzo/script
 creating: wizzo/website
 creating: wizzo/website/javascripts
 creating: wizzo/website/stylesheets
@@ -44,7 +44,8 @@ creating: wizzo/setup.rb
 creating: wizzo/Rakefile
 creating: wizzo/Manifest.txt
 creating: wizzo/History.txt
-creating: wizzo/scripts/txt2html
+creating: wizzo/script/generate
+creating: wizzo/script/txt2html
 creating: wizzo/website/index.txt
 creating: wizzo/website/template.rhtml
 copying: wizzo/website/javascripts/rounded_corners_lite.inc.js

data/Rakefile

@@ -1,113 +1,11 @@
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
 require 'fileutils'
-require 'hoe'
 include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'newgem', 'version')
 
-AUTHOR = "Dr Nic Williams"
-EMAIL = "drnicwilliams@gmail.com"
-DESCRIPTION = "Make your own gems at home"
-GEM_NAME = "newgem" # what ppl will type to install your gem
-config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-RUBYFORGE_USERNAME = config["username"]
-RUBYFORGE_PROJECT = "newgem"
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+$:.unshift 'lib'
+require 'config/hoe' # setup Hoe + all gem configuration
+require 'config/svn_branch' # install svn_branch tasks if gem available
+require 'newgem/tasks' # load /tasks/*.rake
 
-REV = nil #File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
-# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
-VERS = Newgem::VERSION::STRING + (REV ? ".#{REV}" : "")
-CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
-RDOC_OPTS = ['--quiet', '--title', "newgem documentation",
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-# 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|
-  p.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test*.rb"]
-  p.clean_globs |= CLEAN  #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 = [
-    ['hoe', '>=1.2.1'],
-    ['RedCloth','>=3.0.4'],
-    ['syntax','>=1.0.0'],
-    ['activesupport','>=1.4.2']
-  ]
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
-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')
-
-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 -aCv #{local_dir}/ #{host}:#{remote_dir}}
-end
-
-desc 'Generate and upload website files'
-task :website => [:website_generate, :website_upload, :publish_docs]
-
-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
-  ENV['DOWNLOAD_PATH'] = DOWNLOAD_PATH
-end
-
-desc 'Release the website and new gem version'
-task :deploy => [:check_version, :website, :release] do
-  puts "Remember to create SVN tag:"
-  puts "svn copy svn+ssh://#{RUBYFORGE_USERNAME}@rubyforge.org/var/svn/#{PATH}/trunk " +
-    "svn+ssh://#{RUBYFORGE_USERNAME}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
-  puts "Suggested comment:"
-  puts "Tagging release #{CHANGES}"
-end
-
-desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
-task :local_deploy => [:website_generate, :install_gem]
-
-task :check_version do
-  unless ENV['VERSION']
-    puts 'Must pass a VERSION=x.y.z release version'
-    exit
-  end
-  unless ENV['VERSION'] == VERS
-    puts "Please update your version.rb to match the release version, currently #{VERS}"
-    exit
-  end
-end

data/Todo.txt

@@ -1,4 +1,4 @@
 == Todo list
 * 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)
-* provide option to generate <gemname>/trunk,branches,tags structure and insert files into trunk [-s/--svn] 
+* release name generator ("red moom", "flying leopard")

data/app_generators/newgem/newgem_generator.rb

@@ -0,0 +1,172 @@
+require 'rbconfig'
+
+class NewgemGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options   :shebang => DEFAULT_SHEBANG,
+                    :bin_name    => nil,
+                    :email       => nil,
+                    :author      => nil,
+                    :import_path => nil,
+                    :jruby       => nil,
+                    :test_framework => 'test::unit',
+                    :version     => '0.0.1',
+                    :website  => false
+  
+  
+  attr_reader :gem_name, :module_name
+  attr_reader :version, :version_str, :author, :email
+  
+  # extensions/option
+  attr_reader :test_framework
+  attr_reader :bin_names_list
+  attr_reader :website
+  attr_reader :manifest
+  attr_reader :is_jruby
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = args.shift
+    @gem_name     = File.basename(File.expand_path(@destination_root))
+    @module_name  = gem_name.camelize
+    extract_options
+  end
+
+  def manifest
+    # Use /usr/bin/env if no special shebang was specified
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+    dispatcher_options = { :chmod => 0755, :shebang => options[:shebang] }
+    windows            = (RUBY_PLATFORM =~ /dos|win32|cygwin/i) || (RUBY_PLATFORM =~ /(:?mswin|mingw)/)
+
+    record do |m|
+      # Root directory and all subdirectories.
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+      
+      m.directory "lib/#{gem_name}"
+
+      # Root
+      m.template_copy_each %w( History.txt License.txt Rakefile README.txt )
+      m.file_copy_each     %w( setup.rb ) 
+
+      # Default module for app
+      m.template "module.rb",         "lib/#{gem_name}.rb"
+      m.template "version.rb",        "lib/#{gem_name}/version.rb"
+      
+      # Config
+      m.template_copy_each %w( hoe.rb requirements.rb ), "config"
+
+      # Scripts
+      %w( generate destroy ).each do |file|
+        m.template "script/#{file}",        "script/#{file}", script_options
+        m.template "script/win_script.cmd", "script/#{file}.cmd", 
+          :assigns => { :filename => file } if windows
+      end
+      
+      %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"
+      
+      # Selecting a test framework
+      case test_framework
+      when "test::unit"
+        m.template "test_helper.rb",    "test/test_helper.rb"
+        m.template "test.rb",           "test/test_#{gem_name}.rb"
+      when "rspec"
+        m.dependency "install_rspec", [gem_name], :destination => destination_root
+      end 
+        
+      # Website
+      m.dependency "install_website", [gem_name], 
+         :author => author, :email => email, :destination => destination_root if website
+        
+     # JRuby
+     m.dependency "install_jruby", [gem_name], :destination => destination_root if is_jruby
+
+      # Executables
+      for bin_name in bin_names_list
+        m.dependency "executable", [bin_name], :destination => destination_root 
+      end
+      
+      m.write_manifest "Manifest.txt"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Take any library or Rails plugin or command line application,
+gemify it, and easily share it with the Ruby world.
+
+Usage: #{File.basename $0} /path/to/your/app [options]"
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      opts.on("-b", "--bin-name=BIN_NAME[,BIN_NAME2]", String,
+              "Sets up executable scripts in the bin folder.",
+              "Default: none") { |options[:bin_name]| }
+      opts.on("-e", "--email=PATH", String,
+              "Your email to be inserted into generated files.",
+              "Default: ~/.rubyforge/user-config.yml[email]") { |options[:email]| }
+      # TODO --import_path
+      # opts.on("-i", "--import_path=PATH", String,
+      #         "Path where your files could be copied from.",
+      #         "Default: none") { |options[:import_path]| }
+      opts.on("-j", "--jruby",
+              "Use if gem is for jruby.") { |options[:jruby]| }
+      opts.on("-a", "--author=PATH", String,
+              "Your name to be inserted into generated files.",
+              "Default: ~/.rubyforge/user-config.yml[user_name]") { |options[:author]| }
+      opts.on("-r", "--ruby=path", String,
+             "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
+             "Default: #{DEFAULT_SHEBANG}") { |v| options[:shebang] = v }
+      opts.on("-T", "--test-with=TEST_FRAMEWORK", String,
+              "Select your preferred testing framework.",
+              "Options: test::unit (default), rspec.") { |options[:test_framework]| }           
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+      opts.on("-V", "--set-version=YOUR_VERSION", String,
+              "Version of the gem you are creating.",
+              "Default: 0.0.1") { |options[:version]| }
+      opts.on("-w", "--website", 
+              "Includes a website for your RubyGem.") { |options[:website]| }
+    end
+    
+    def extract_options
+      @version           = options[:version].to_s.split(/\./)
+      @version_str       = @version.join('.')
+      @author            = options[:author]
+      @email             = options[:email]
+      unless @author && @email
+        require 'newgem/rubyforge'
+        rubyforge_config = Newgem::Rubyforge.new
+        @author ||= rubyforge_config.full_name
+        @email  ||= rubyforge_config.email
+      end
+      @bin_names_list    = (options[:bin_name] || "").split(',')
+      @website           = options[:website]
+
+      @test_framework    = options[:test_framework] || "test::unit"
+      @is_jruby          = options[:jruby]
+    end
+
+  # Installation skeleton.  Intermediate directories are automatically
+  # created so don't sweat their absence here.
+  BASEDIRS = %w(
+    config
+    doc
+    lib
+    log
+    script
+    tasks
+    test
+    tmp
+  )
+end