newgem 0.11.0 → 0.13.0

data/rubygems_generators/component_generator/templates/readme

@@ -0,0 +1,28 @@
+How to create an Application Generator
+======================================
+
+1. DONE - Create a new RubyGem (using newgem or hoe) or you can use an existing one.
+2. DONE - Run the generator: script/generate application_generator foobar
+3. Using the generated test class, assert what directories, files, classes etc should
+   be generated.
+4. Add these files into the app_genearators/foobar/templates folder. Your files can use
+   ERb (that is, <%= ... %>).
+5. Specify who the files in /templates are copied/templated at generation time within app_generators/foobar/foobar_generators.rb 's #manifest method.
+   Use m.file for files to copy over.
+   Use m.template for files containing ERb. Create attr_reader accessors for any variables your
+   templates need access to.
+6. Run unit tests.
+7. If your application generator uses other generators (m.dependency "gen-name", [arg1, arg2], :option1 => 'value')
+   then you must add this into the generated bin/foobar file.
+   For example, if you wanted to use a rubygems and/or merb generator, then replace the use_application_sources! 
+   call in bin/foobar:
+
+      RubiGen::Base.use_application_sources! :rubygems, :merb
+
+   Without this, RubiGen will not be able to find your dependent generators.
+8. Update your Manifest.txt with the new files (if you are using Hoe; using newgem? it uses Hoe; so you need to do this)
+9. Build and install your RubyGem locally. Run: rake install_gem
+10. Test your foobar application to ensure that it connects to the generator correctly and generates files.
+11. Done.
+
+See this message again using the -h/--help option.

data/rubygems_generators/component_generator/templates/test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class Test<%= class_name %> < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    name = "myapp"
+    run_generator('<%= name %>', [name], sources)
+    assert_generated_file("some_file")
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "<%= generator_path %>"
+  end
+end

data/rubygems_generators/component_generator/templates/test_generator_helper.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+app_root = File.join(TMP_ROOT, "myproject")
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/rubygems_generators/component_generator/templates/usage

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rubygems_generators/executable/executable_generator.rb

@@ -0,0 +1,53 @@
+class ExecutableGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :shebang => DEFAULT_SHEBANG,
+                  :author => nil
+  
+  attr_reader :bin_name, :author
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @bin_name     = args.shift
+    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|
+      # Ensure bin folder exists
+      m.directory "bin"
+
+      # App stub
+      m.template "app.rb",         "bin/#{bin_name}"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Create an executable Ruby script that is deployed
+with this RubyGem.
+
+USAGE: #{$0} generate bin_name"
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      opts.on("-a", "--author=\"Your Name\"", String,
+              "Generated app file will include your name.",
+              "Default: none") { |options[:author]| }
+    end
+    
+    def extract_options
+      @author = options[:author]
+    end
+end

data/rubygems_generators/executable/templates/app.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+#
+#  Created <%= "by #{author} " if author %>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.
+
+OPTIONS = {
+  :path     => '~'
+}
+MANDATORY_OPTIONS = %w(  )
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+This application is wonderful because...
+
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on("-p", "--path=PATH", String,
+          "The root path for selecting files",
+          "Default: ~") { |OPTIONS[:path]| }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+path = OPTIONS[:path]
+
+# do stuff

data/rubygems_generators/install_jruby/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rubygems_generators/install_jruby/install_jruby_generator.rb

@@ -0,0 +1,48 @@
+class InstallJrubyGenerator < RubiGen::Base
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'tasks'
+
+      m.file_copy_each %w( jruby.rake ), "tasks"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/rubygems_generators/install_jruby/templates/tasks/jruby.rake

@@ -0,0 +1,7 @@
+if RUBY_PLATFORM =~ /java/
+  require 'java'
+else
+  puts "Java RubyGem only! You are not running within jruby."
+  puts "Try: jruby -S rake #{ARGV.join(' ')}"
+  exit(1)
+end

data/rubygems_generators/install_rspec/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rubygems_generators/install_rspec/install_rspec_generator.rb

@@ -0,0 +1,55 @@
+class InstallRspecGenerator < RubiGen::Base
+  
+  default_options :author => nil
+  
+  attr_reader :gem_name, :module_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @gem_name     = File.basename(File.expand_path(destination_root))
+    @module_name  = @gem_name.camelcase
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'spec'
+      m.directory 'tasks'
+
+      m.template           'spec.rb', "spec/#{gem_name}_spec.rb"
+      
+      m.template_copy_each %w( spec.opts spec_helper.rb ), 'spec'
+      m.file_copy_each     %w( rspec.rake ), 'tasks'
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Install rspec BDD testing support. 
+
+Includes a rake task (tasks/rspec.rake) to be loaded by the root Rakefile,
+which provides a "spec" task.
+
+USAGE: #{$0} [options]"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/rubygems_generators/install_rspec/templates/spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.rubyforge.org/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/rubygems_generators/install_rspec/templates/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/rubygems_generators/install_rspec/templates/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end

data/rubygems_generators/install_rspec/templates/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+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

data/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/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/{scripts → script}/txt2html

@@ -29,14 +29,14 @@ 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'
+require File.join(File.dirname(__FILE__), '/../lib/newgem/version.rb')
 
 version  = Newgem::VERSION::STRING
 download = ENV['DOWNLOAD_PATH']
 
 if ARGV.length >= 1
   src, template = ARGV
-  template ||= File.dirname(__FILE__) + '/../website/template.rhtml'
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
   
 else
   puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
@@ -54,7 +54,7 @@ File.open(src) do |fsrc|
   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_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
     "syntax-temp-#{ident}"
   }
   title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip

data/tasks/bundles.rake

@@ -0,0 +1,12 @@
+namespace :bundles do
+
+  desc 'Install TextMate bundles for RubyGems'
+  task :tm do
+    require 'tmpdir'
+    bundle = "RubyGem.tmbundle"
+    bundle_dir = File.join(File.dirname(__FILE__), 'bundles/', bundle)
+    `cp -R #{bundle_dir} #{Dir.tmpdir}`
+    `open "#{File.join(Dir.tmpdir, bundle)}"`
+  end
+end
+