RubyGems - newgem - Versions diffs - 0.11.0 → 0.13.0 - Mend

newgem 0.11.0 → 0.13.0

Files changed (102) hide show

data/History.txt +42 -0
data/Manifest.txt +84 -17
data/README.txt +3 -2
data/Rakefile +4 -106
data/Todo.txt +1 -1
data/app_generators/newgem/newgem_generator.rb +172 -0
data/{templates → app_generators/newgem/templates}/History.txt +1 -1
data/{templates → app_generators/newgem/templates}/License.txt +1 -1
data/app_generators/newgem/templates/README.txt +1 -0
data/app_generators/newgem/templates/Rakefile +4 -0
data/{templates → app_generators/newgem/templates}/app.rb +3 -3
data/app_generators/newgem/templates/config/hoe.rb +73 -0
data/app_generators/newgem/templates/config/requirements.rb +17 -0
data/app_generators/newgem/templates/empty.log +0 -0
data/app_generators/newgem/templates/module.rb +5 -0
data/app_generators/newgem/templates/script/destroy +14 -0
data/app_generators/newgem/templates/script/generate +14 -0
data/{templates → app_generators/newgem/templates}/setup.rb +0 -0
data/{templates → app_generators/newgem/templates}/spec.opts +0 -0
data/{templates → app_generators/newgem/templates}/spec.rb +0 -0
data/app_generators/newgem/templates/tasks/deployment.rake +27 -0
data/app_generators/newgem/templates/tasks/environment.rake +7 -0
data/app_generators/newgem/templates/tasks/website.rake +9 -0
data/{templates → app_generators/newgem/templates}/test.rb +1 -1
data/app_generators/newgem/templates/test_helper.rb +2 -0
data/app_generators/newgem/templates/version.rb +9 -0
data/bin/newgem +9 -272
data/bundles/RubyGem.tmbundle/Snippets/History header trunk.tmSnippet +18 -0
data/bundles/RubyGem.tmbundle/Snippets/History header.tmSnippet +18 -0
data/bundles/RubyGem.tmbundle/Syntaxes/Rdoc.tmLanguage +70 -0
data/bundles/RubyGem.tmbundle/info.plist +16 -0
data/config/hoe.rb +48 -0
data/config/svn_branch.rb +15 -0
data/lib/newgem.rb +2 -3
data/lib/newgem/quick_template.rb +28 -0
data/lib/newgem/tasks.rb +1 -0
data/lib/newgem/version.rb +1 -1
data/newgem_generators/install_website/USAGE +5 -0
data/newgem_generators/install_website/install_website_generator.rb +76 -0
data/{templates/scripts → newgem_generators/install_website/templates/script}/txt2html +15 -8
data/newgem_generators/install_website/templates/tasks/website.rake +17 -0
data/{templates → newgem_generators/install_website/templates}/website/index.html +2 -2
data/newgem_generators/install_website/templates/website/index.txt +39 -0
data/newgem_theme_generators/plain/USAGE +5 -0
data/newgem_theme_generators/plain/plain_generator.rb +54 -0
data/{templates → newgem_theme_generators/plain/templates}/website/javascripts/rounded_corners_lite.inc.js +0 -0
data/{templates → newgem_theme_generators/plain/templates}/website/stylesheets/screen.css +0 -0
data/{templates → newgem_theme_generators/plain/templates}/website/template.rhtml +6 -6
data/rubygems_generators/application_generator/USAGE +28 -0
data/rubygems_generators/application_generator/application_generator_generator.rb +58 -0
data/rubygems_generators/application_generator/templates/bin +12 -0
data/rubygems_generators/application_generator/templates/generator.rb +51 -0
data/rubygems_generators/application_generator/templates/readme +24 -0
data/rubygems_generators/application_generator/templates/test.rb +43 -0
data/rubygems_generators/application_generator/templates/test_generator_helper.rb +19 -0
data/rubygems_generators/application_generator/templates/usage +5 -0
data/rubygems_generators/component_generator/USAGE +29 -0
data/rubygems_generators/component_generator/component_generator_generator.rb +52 -0
data/rubygems_generators/component_generator/templates/generator.rb +51 -0
data/rubygems_generators/component_generator/templates/readme +28 -0
data/rubygems_generators/component_generator/templates/test.rb +43 -0
data/rubygems_generators/component_generator/templates/test_generator_helper.rb +19 -0
data/rubygems_generators/component_generator/templates/usage +5 -0
data/rubygems_generators/executable/executable_generator.rb +53 -0
data/rubygems_generators/executable/templates/app.rb +44 -0
data/rubygems_generators/install_jruby/USAGE +5 -0
data/rubygems_generators/install_jruby/install_jruby_generator.rb +48 -0
data/rubygems_generators/install_jruby/templates/tasks/jruby.rake +7 -0
data/rubygems_generators/install_rspec/USAGE +5 -0
data/rubygems_generators/install_rspec/install_rspec_generator.rb +55 -0
data/rubygems_generators/install_rspec/templates/spec.rb +11 -0
data/rubygems_generators/install_rspec/templates/spec/spec.opts +1 -0
data/rubygems_generators/install_rspec/templates/spec/spec_helper.rb +7 -0
data/rubygems_generators/install_rspec/templates/tasks/rspec.rake +21 -0
data/script/destroy +14 -0
data/script/generate +14 -0
data/{scripts → script}/txt2html +3 -3
data/{scripts → script}/txt2js +0 -0
data/tasks/bundles.rake +12 -0
data/tasks/deployment.rake +27 -0
data/tasks/environment.rake +7 -0
data/tasks/website.rake +19 -0
data/test/test_application_generator_generator.rb +60 -0
data/test/test_executable_generator.rb +28 -0
data/test/test_generate_component_generator.rb +67 -0
data/test/test_generator_helper.rb +19 -0
data/test/test_install_jruby_generator.rb +29 -0
data/test/test_install_rspec_generator.rb +33 -0
data/test/test_install_website_generator.rb +50 -0
data/test/test_newgem_generator.rb +120 -0
data/test/test_plain_generator.rb +37 -0
data/website/images/beginning-ruby.jpg +0 -0
data/website/index.html +8 -6
data/website/index.txt +4 -2
data/website/rubyforge.html +3 -3
data/website/version-raw.js +1 -1
data/website/version.js +1 -1
metadata +111 -27
data/templates/Manifest.txt +0 -15
data/templates/Rakefile +0 -123
data/templates/website/index.txt +0 -38
data/test/test_svn.rb +0 -13

data/newgem_theme_generators/plain/USAGE ADDED Viewed

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

data/newgem_theme_generators/plain/plain_generator.rb ADDED Viewed

@@ -0,0 +1,54 @@
+class PlainGenerator < RubiGen::Base
+  default_options :author  => "TODO",
+                  :email   => "todo@todo.com"
+  attr_reader :author, :email
+  def initialize(runtime_args, runtime_options = {})
+    super
+    extract_options
+  end
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'website/javascripts'
+      m.directory 'website/stylesheets'
+      # Website
+      m.template_copy_each %w( template.rhtml ), "website"
+      m.file_copy_each     %w( stylesheets/screen.css javascripts/rounded_corners_lite.inc.js ), "website"
+    end
+  end
+  protected
+    def banner
+      <<-EOS
+Installs the plain blue-ish website theme for newgem's website framework.
+USAGE: #{$0} #{spec.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,
+              "You. The author of this RubyGem. You name goes in in the website.",
+              "Default: 'TODO'") { |options[:author]| }
+      opts.on("-e", "--email=your@email.com", String,
+              "Your email for people to contact you.",
+              "Default: nil") { |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]
+      @email  = options[:email]
+    end
+end

data/{templates → newgem_theme_generators/plain/templates}/website/javascripts/rounded_corners_lite.inc.js RENAMED Viewed

File without changes

data/{templates → newgem_theme_generators/plain/templates}/website/stylesheets/screen.css RENAMED Viewed

File without changes

data/{templates → newgem_theme_generators/plain/templates}/website/template.rhtml RENAMED Viewed

@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>
-      <%= title %>
+      <%%= title %>
   </title>
   <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
 <style>
@@ -30,14 +30,14 @@
 <body>
 <div id="main">
-    <h1><%= title %></h1>
-    <div id="version" class="clickable" onclick='document.location = "<%= download %>"; return false'>
+    <h1><%%= title %></h1>
+    <div id="version" class="clickable" onclick='document.location = "<%%= download %>"; return false'>
       <p>Get Version</p>
-      <a href="<%= download %>" class="numbers"><%= version %></a>
+      <a href="<%%= download %>" class="numbers"><%%= version %></a>
     </div>
-    <%= body %>
+    <%%= body %>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, <%= modified.pretty %><br>
+      <a href="<%= email %>"><%= author %></a>, <%%= modified.pretty %><br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/rubygems_generators/application_generator/USAGE ADDED Viewed

@@ -0,0 +1,28 @@
+How to create an Application Generator
+======================================
+1. Create a new RubyGem (using newgem or hoe) or you can use an existing one.
+2. 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.
+You will see this message again after running the generator and by using the -h/--help option.

data/rubygems_generators/application_generator/application_generator_generator.rb ADDED Viewed

@@ -0,0 +1,58 @@
+class ApplicationGeneratorGenerator < RubiGen::Base
+  default_options
+  attr_reader :name, :class_name, :generator_path
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name           = args.shift
+    @class_name     = "#{name}_generator".camelize
+    @generator_path = "app_generators"
+    extract_options
+  end
+  def manifest
+    path = "#{generator_path}/#{name}"
+    record do |m|
+      # Ensure appropriate generators folder exists
+      m.directory "#{path}/templates"
+      m.directory "bin"
+      m.directory "test"
+      # Generator stub
+      m.template "generator.rb",              "#{path}/#{name}_generator.rb"
+      m.template "test.rb",                   "test/test_#{name}_generator.rb"
+      m.file     "test_generator_helper.rb",  "test/test_generator_helper.rb"
+      m.file     "usage",                     "#{path}/USAGE"
+      m.template "bin",                       "bin/#{name}"
+      m.readme   'readme'
+    end
+  end
+  protected
+    def banner
+      <<-EOS
+Creates a application generator stub within your RubyGem.
+Application Generators are used to create new applications
+from scratch, and create the default scaffolding for
+an application (directories) plus any starter files
+that are useful to developers.
+USAGE: #{$0} #{spec.name} 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
+    end
+end

data/rubygems_generators/application_generator/templates/bin ADDED Viewed

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rubigen'
+if %w(-v --version).include? ARGV.first
+  require 'newgem/version'
+  puts "#{File.basename($0)} #{Newgem::VERSION::STRING}"
+  exit(0)
+end
+require 'rubigen/scripts/generate'
+RubiGen::Base.use_application_sources! <%= name.to_sym.inspect %>
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => '<%= name %>')

data/rubygems_generators/application_generator/templates/generator.rb ADDED Viewed

@@ -0,0 +1,51 @@
+class <%= class_name %> < 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 'some_folder'
+      # Create stubs
+      # m.template "template.rb",  "some_file_after_erb.rb"
+      # m.file     "file",         "some_file_copied"
+    end
+  end
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+USAGE: #{spec.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]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    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/application_generator/templates/readme ADDED Viewed

@@ -0,0 +1,24 @@
+How to create a Generator (aka Component Generator)
+======================================
+1. DONE - Run the generator: script/generate component_generator foobar rubygems
+2. Using the generated test class, assert what directories, files, classes etc should
+   be generated.
+3. Add these files into the rubygems_genearators/foobar/templates folder. Your files can use
+   ERb (that is, <%= ... %>).
+4. Specify who the files in /templates are copied/templated at generation time within rubygems_genearators/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.
+5. Run unit tests.
+6. If your generator uses other generators (m.dependency "gen-name", [arg1, arg2], :option1 => 'value')
+   it should only use generates from the same scope ('rubygems' in this example),
+   otherwise RubiGen may not be able to find the dependent generators.
+7. Update your Manifest.txt with the new files (if you are using Hoe; using newgem? it uses Hoe; so you need to do this)
+8. Build and install your RubyGem locally. Run: rake install_gem
+9. Go to a work area whose script/generate is scoped to 'rubygems' (e.g. a RubyGem scaffold created by newgem has a script/generate that can use rubygems, newgem, and newgem_template scoped generators)
+10. Run "script/generate" and your generator should appear in the list of available generators.
+11. Run "script/generate foobar" to see the options and usage information for your generator.
+12. Run "script/generator foobar arguments" to execute the generator.
+See this message again using the -h/--help option.

data/rubygems_generators/application_generator/templates/test.rb ADDED Viewed

@@ -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/application_generator/templates/test_generator_helper.rb ADDED Viewed

@@ -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/application_generator/templates/usage ADDED Viewed

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

data/rubygems_generators/component_generator/USAGE ADDED Viewed

@@ -0,0 +1,29 @@
+How to create a Generator (aka Component Generator)
+======================================
+1. Run this generator: script/generate component_generator foobar rubygems
+   Where "foobar" is the name of the generator, and "rubygems" is the optional (but recommended)
+   scope. A scope of "rubygems" means this generator will only be available to RubyGems
+   developers. A scope of "merb" means the generator is only available to Merb applications, etc.
+   If you use "rails", then your generator WILL be accessible by Rails applications
+   for Edge Rails or Rails releases after 1.2.3 (due to patch in Rails' own generator system)
+2. Using the generated test class, assert what directories, files, classes etc should
+   be generated.
+3. Add these files into the rubygems_genearators/foobar/templates folder. Your files can use
+   ERb (that is, <%= ... %>).
+4. Specify who the files in /templates are copied/templated at generation time within rubygems_genearators/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.
+5. Run unit tests.
+6. If your generator uses other generators (m.dependency "gen-name", [arg1, arg2], :option1 => 'value')
+   it should only use generates from the same scope ('rubygems' in this example),
+   otherwise RubiGen may not be able to find the dependent generators.
+7. Update your Manifest.txt with the new files (if you are using Hoe; using newgem? it uses Hoe; so you need to do this)
+8. Build and install your RubyGem locally. Run: rake install_gem
+9. Go to a work area whose script/generate is scoped to 'rubygems' (e.g. a RubyGem scaffold created by newgem has a script/generate that can use rubygems, newgem, and newgem_template scoped generators)
+10. Run "script/generate" and your generator should appear in the list of available generators.
+11. Run "script/generate foobar" to see the options and usage information for your generator.
+12. Run "script/generator foobar arguments" to execute the generator.
+You will see this message again when you run the generator and by using the -h/--help option.

data/rubygems_generators/component_generator/component_generator_generator.rb ADDED Viewed

@@ -0,0 +1,52 @@
+class ComponentGeneratorGenerator < RubiGen::Base
+  default_options
+  attr_reader :name, :class_name, :generator_type, :generator_path
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name           = args.shift
+    @class_name     = "#{name}_generator".camelize
+    @generator_type = args.shift # optional
+    @generator_path = @generator_type ? "#{generator_type}_generators" : "generators"
+    extract_options
+  end
+  def manifest
+    path = "#{generator_path}/#{name}"
+    record do |m|
+      # Ensure appropriate generators folder exists
+      m.directory "#{path}/templates"
+      m.directory "test"
+      # Generator stub
+      m.template "generator.rb",              "#{path}/#{name}_generator.rb"
+      m.template "test.rb",                   "test/test_#{name}_generator.rb"
+      m.file     "test_generator_helper.rb",  "test/test_generator_helper.rb"
+      m.file     "usage",                     "#{path}/USAGE"
+      m.readme   'readme'
+    end
+  end
+  protected
+    def banner
+      <<-EOS
+Creates a generator stub within your RubyGem.
+USAGE: #{$0} #{spec.name} name [generator_type]
+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
+    end
+end

data/rubygems_generators/component_generator/templates/generator.rb ADDED Viewed

@@ -0,0 +1,51 @@
+class <%= class_name %> < 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 'some_folder'
+      # Create stubs
+      # m.template "template.rb",  "some_file_after_erb.rb"
+      # m.file     "file",         "some_file_copied"
+    end
+  end
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+USAGE: #{$0} #{spec.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]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    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