newgem 0.11.0 → 0.13.0

data/{templates → app_generators/newgem/templates}/History.txt

@@ -1,4 +1,4 @@
-== #{version_str} #{Date.today}
+== <%= version_str %> <%= Date.today %>
 
 * 1 major enhancement:
   * Initial release

data/{templates → app_generators/newgem/templates}/License.txt

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

data/app_generators/newgem/templates/README.txt

@@ -0,0 +1 @@
+README

data/app_generators/newgem/templates/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/{templates → app_generators/newgem/templates}/app.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
-#  Created by MYNAME on #{(now = Time.now).year}-#{now.month}-#{now.day}.
-#  Copyright (c) #{now.year}. All rights reserved.
+#  Created by <%= author %> on <%= (now = Time.now).year %>-<%= now.month %>-<%= now.day %>.
+#  Copyright (c) <%= now.year %>. All rights reserved.
 
 begin
   require 'rubygems'
@@ -22,7 +22,7 @@ parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
 This application is wonderful because...
 
-Usage: \#{File.basename($0)} [options]
+Usage: #{File.basename($0)} [options]
 
 Options are:
 BANNER

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

@@ -0,0 +1,73 @@
+require '<%= gem_name %>/version'
+
+AUTHOR = '<%= author %>'  # can also be an array of Authors
+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
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = <%= module_name %>::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', '<%= gem_name %> documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# 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 |= ['**/.*.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 %>
+  # 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 %>
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  <% 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')

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

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require '<%= gem_name %>'

data/app_generators/newgem/templates/module.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
+module <%= module_name %>
+  
+end

data/app_generators/newgem/templates/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! :rubygems
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/app_generators/newgem/templates/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! :rubygems, :newgem
+RubiGen::Scripts::Generate.new.run(ARGV)

data/app_generators/newgem/templates/tasks/deployment.rake

@@ -0,0 +1,27 @@
+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
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end

data/app_generators/newgem/templates/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/app_generators/newgem/templates/tasks/website.rake

@@ -0,0 +1,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

data/{templates → app_generators/newgem/templates}/test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class Test#{module_name} < Test::Unit::TestCase
+class Test<%= module_name %> < Test::Unit::TestCase
 
   def setup
   end

data/app_generators/newgem/templates/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/<%= gem_name %>'

data/app_generators/newgem/templates/version.rb

@@ -0,0 +1,9 @@
+module <%= module_name %> #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = <%= version[0] || '0' %>
+    MINOR = <%= version[1] || '0' %>
+    TINY  = <%= version[2] || '0' %>
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/bin/newgem

@@ -1,276 +1,13 @@
-#!/usr/bin/env ruby
+require 'rubygems'
+require 'rubigen'
 
-begin
-  require 'rubygems'
-rescue LoadError
-  # no rubygems to load, so we fail silently
+if %w(-v --version).include? ARGV.first
+  require 'newgem/version'
+  puts "#{File.basename($0)} #{Newgem::VERSION::STRING}"
+  exit(0)
 end
 
-require 'fileutils'
-require 'active_support'
-require 'optparse'
 
-require 'newgem'
-
-templates = File.dirname(__FILE__) + '/../templates/'
-
-OPTIONS = {
-  :import_path => nil,
-  :version     => '0.0.1',
-  :full_name   => nil,
-  :email       => nil,
-  :bin_name    => nil,
-  :svn_struct  => nil,
-  :test_framework => 'test::unit'
-}
-parser = OptionParser.new do |opts|
-  opts.banner = <<BANNER
-Take any library or Rails plugin or command line application,
-gemify it, and easily share it with the Ruby world.
-
-Usage: #{File.basename($0)} [options] <gemname>
-
-Options are:
-BANNER
-  opts.separator ""
-  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("-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("-s", "--svn",
-          "Creates trunk/branches/tags folders beneath <gemname> folder.",
-          "Generated gem placed in trunk folder.") { |OPTIONS[:svn_struct]| }
-  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=YOUR_VERSION", String,
-          "Version of the gem you are creating.",
-          "Default: 0.0.1") { |OPTIONS[:version]| }
-  opts.on("-h", "--help",
-          "Show this help message.") { puts opts; exit }
-  opts.parse!(ARGV)
-end
-OPTIONS[:version] = OPTIONS[:version].to_s.split(/\./)
-version_str       = OPTIONS[:version].join('.')
-author            = OPTIONS[:full_name]
-email             = OPTIONS[:email]
-svn_struct        = OPTIONS[:svn_struct]
-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
-
-module_name  = project_name.classify
-root = project_name + (svn_struct ? '/trunk' : '')
-lib = root + '/lib'
-lib_project_name = root + '/lib/' + project_name
-version = root + "/lib/" + project_name + "/version.rb"
-readme, setup = %w(README.txt setup.rb).
-	collect {|f| root + '/' + f}
-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)
-
-main = root + "/lib/" + project_name + ".rb"
-
-examples = root + '/examples'
-bin      = root + '/bin'
-folders  = %w( scripts website website/javascripts website/stylesheets)
-
-FileUtils.rm_rf project_name
-
-puts "creating: " + project_name
-Dir.mkdir project_name
-
-if svn_struct
-  %w[trunk branches tags].each do |folder|
-    folder_path = File.join(project_name, folder)
-    puts "creating: " + folder_path
-    Dir.mkdir folder_path
-  end
-end
-
-puts "creating: " + readme
-File.open(readme, 'w') do |file|
-  file << <<-eos
-README for #{project_name}
-===========#{'=' * project_name.length}
-
-eos
-end
-
-
-puts "creating: " + lib
-FileUtils.mkdir_p lib
-
-folders.each do |folder|
-  new_folder = root + '/' + folder
-  puts "creating: " + new_folder
-  FileUtils.mkdir_p new_folder
-end
-
-if OPTIONS[:import_path]
-  require 'fileutils'
-  OPTIONS[:import_path].chomp! if OPTIONS[:import_path][-1] == 47 # /
-  FileUtils.cp_r OPTIONS[:import_path] + '/.', lib, :preserve => true
-end
-
-puts "creating: " + lib_project_name
-FileUtils.mkdir_p lib_project_name
-
-puts "creating: " + main
-File.open(main, 'w') do |file|
-  file << <<-EOS 
-module #{module_name}
-end
-
-require '#{project_name}/version'
-  EOS
-end
-
-puts "creating: " + version
-File.open(version, 'w') do |file|
-  file << <<-EOS
-module #{module_name} #:nodoc:
-  module VERSION #:nodoc:
-    MAJOR = #{OPTIONS[:version][0] || '0'}
-    MINOR = #{OPTIONS[:version][1] || '0'}
-    TINY  = #{OPTIONS[:version][2] || '0'}
-
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
-end
-  EOS
-end
-
-puts "creating: " + bin
-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}
-  bin_names_list.each do |bin_name|
-    puts "creating: " + bin + '/' + bin_name
-    File.open(bin + '/' + bin_name, 'w') do |file|
-      file << eval('"' + template.gsub(/"/, '\"') + '"')
-    end
-  end
-  bin_names = bin_names_list.join(' ')
-else
-  bin_names = ''
-  bin_names_list = []
-end
-
-# Setup spec/test::unit environments
-# Would like to refactor this...
-if test_framework == 'rspec'
-  test = root + "/spec"
-  test_helper = test + "/spec_helper.rb"
-  test_template = 'spec.rb'
-  unit_test = test + "/" + project_name + "_spec.rb"
-  test_file_prefix = 'spec/NAME_spec'
-  spec_opts = 'spec.opts'
-  unit_test_template = <<-eos
-require 'spec'
-eos
-  requirements = <<-eos
-begin
-  require 'spec/rake/spectask'
-rescue LoadError
-  puts 'To use rspec for testing you must install rspec gem:'
-  puts '$ sudo gem install rspec'
-  exit
-end
-  eos
-  test_task = <<-eos
-desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/*_spec.rb']
-end
-
-desc "Default task is to run specs"
-task :default => :spec
-  eos
-else  
-  test = root + "/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
-  requirements = ''
-  test_task = ''
-end
-
-puts "creating: " + test
-Dir.mkdir test
-
-puts "creating: " + test_helper
-File.open(test_helper, 'w') do |file|
-  file << unit_test_template
-end
-
-puts "creating: " + unit_test
-
-template = File.open(templates + test_template,'r') {|f| f.readlines.join}
-File.open(unit_test, 'w') do |file|
-  file << eval('"' + template.gsub(/"/, '\"') + '"')
-end
-
-if test_framework == 'rspec'
-  spec_opts_file = test + "/" + spec_opts
-  puts "creating: " + spec_opts_file
-  template = File.open(templates + spec_opts, 'r') { |f| f.readlines.join }  
-  File.open(spec_opts_file, 'w') do |file|
-    file << eval('"' + template.gsub(/"/, '\""') + '"')
-  end  
-end
-
-puts "creating: " + examples
-Dir.mkdir examples
-
-puts "creating: " + setup
-template = File.open(templates + 'setup.rb','r') {|f| f.readlines.join}
-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_file_prefix.gsub('NAME', name) }.join("\n")
-
-template_files.each do |template_file|
-  puts "creating: " + root + '/' + template_file
-  template = File.open(templates + template_file,'r') {|f| f.readlines.join}
-  File.open(root + '/' + template_file, 'w') do |file|
-    file << eval('"' + template.gsub(/"/, '\"') + '"')
-  end  
-end
-
-copy_files.each do |file|
-  puts "copying: " + root + '/' + file
-  template = File.open(templates + file,'r') {|f| f.readlines.join}
-  File.open(root + '/' + file, 'w') do |file|
-    file << template
-  end  
-end
-
-
-
-puts "NOW - update #{gem_name}/Rakefile with gem description, etc"
+require 'rubigen/scripts/generate'
+RubiGen::Base.use_application_sources! :rubygems, :newgem, :newgem_theme
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'newgem')