rubigen 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,10 @@
-== =0.1.0 2007-08-17
+== 1.0.1 2007-08-20
+
+* Moved builtin generators into root folders, away from lib folder, to protected them
+  from ri/rdocs processes (which didn't like ERb <%= %> inside Ruby files)
+* New app: rubigen_install_script
+  * adds script/generate and script/destroy to current folder
+
+== 1.0.0 2007-08-17
 * 1 major enhancement:
   * Initial release

data/Manifest.txt

@@ -3,6 +3,15 @@ License.txt
 Manifest.txt
 README.txt
 Rakefile
+app_generators/ruby_app/USAGE
+app_generators/ruby_app/ruby_app_generator.rb
+app_generators/ruby_app/templates/README.txt
+app_generators/ruby_app/templates/configs/empty.log
+app_generators/ruby_app/templates/fresh_rakefile
+app_generators/ruby_app/templates/module.rb
+app_generators/ruby_app/templates/script/generate
+app_generators/ruby_app/templates/test_helper.rb
+bin/install_rubigen_scripts
 bin/ruby_app
 examples/rails_generators/applications/app/USAGE
 examples/rails_generators/applications/app/app_generator.rb
@@ -75,21 +84,18 @@ examples/rails_generators/components/web_service/templates/api_definition.rb
 examples/rails_generators/components/web_service/templates/controller.rb
 examples/rails_generators/components/web_service/templates/functional_test.rb
 examples/rails_generators/components/web_service/web_service_generator.rb
+generators/install_rubigen_scripts/USAGE
+generators/install_rubigen_scripts/install_rubigen_scripts_generator.rb
+generators/install_rubigen_scripts/templates/script/destroy
+generators/install_rubigen_scripts/templates/script/generate
+generators/install_rubigen_scripts/templates/script/win_script.cmd
+generators/test_unit/USAGE
+generators/test_unit/templates/test.rb
+generators/test_unit/test_unit_generator.rb
 lib/rubigen.rb
 lib/rubigen/base.rb
 lib/rubigen/commands.rb
 lib/rubigen/generated_attribute.rb
-lib/rubigen/generators/applications/ruby_app/USAGE
-lib/rubigen/generators/applications/ruby_app/ruby_app_generator.rb
-lib/rubigen/generators/applications/ruby_app/templates/README.txt
-lib/rubigen/generators/applications/ruby_app/templates/configs/empty.log
-lib/rubigen/generators/applications/ruby_app/templates/fresh_rakefile
-lib/rubigen/generators/applications/ruby_app/templates/module.rb
-lib/rubigen/generators/applications/ruby_app/templates/script/generate
-lib/rubigen/generators/applications/ruby_app/templates/test_helper.rb
-lib/rubigen/generators/components/test_unit/USAGE
-lib/rubigen/generators/components/test_unit/templates/test
-lib/rubigen/generators/components/test_unit/test_unit_generator.rb
 lib/rubigen/helpers/generator_test_helper.rb
 lib/rubigen/lookup.rb
 lib/rubigen/manifest.rb
@@ -110,7 +116,9 @@ test/examples_from_rails/test_rails_resource_generator.rb
 test/examples_from_rails/test_rails_scaffold_generator.rb
 test/test_generate_builtin_application.rb
 test/test_generate_builtin_test_unit.rb
+test/test_generator_helper.rb
 test/test_helper.rb
+test/test_install_rubigen_scripts_generator.rb
 test/test_lookup.rb
 website/index.html
 website/index.txt

data/Rakefile

@@ -28,7 +28,9 @@ require File.join(File.dirname(__FILE__), 'lib', 'rubigen', 'version')
 
 AUTHOR = 'Dr Nic Williams'  # can also be an array of Authors
 EMAIL = "drnicwilliams@gmail.com"
-DESCRIPTION = "description of gem"
+DESCRIPTION = <<-EOS
+A framework to allow Ruby applications to generate file/folder stubs (like the rails command does for Ruby on Rails, and the ‘script/generate’ command within a Rails application during development).
+EOS
 GEM_NAME = 'rubigen' # what ppl will type to install your gem
 
 @config_file = "~/.rubyforge/user-config.yml"

data/{lib/rubigen/generators/applications → app_generators}/ruby_app/ruby_app_generator.rb

@@ -20,7 +20,6 @@ class RubyAppGenerator < RubiGen::Base
   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|
@@ -32,22 +31,17 @@ class RubyAppGenerator < RubiGen::Base
       m.file "fresh_rakefile", "Rakefile"
       m.file "README.txt",     "README.txt"
 
-     # Scripts
-      %w( generate ).each do |file|
-        m.file     "script/#{file}",        "script/#{file}", script_options
-        m.template "script/win_script.cmd", "script/#{file}.cmd", 
-          :assigns => { :filename => file } if windows
-      end
-      
       # Default module for app
-      m.template "module.rb",         "lib/#{app_name}.rb", script_options
+      m.template "module.rb",         "lib/#{app_name}.rb"
       
       # Test helper
-      m.template "test_helper.rb",    "test/test_helper.rb", script_options
+      m.template "test_helper.rb",    "test/test_helper.rb"
 
       %w(debug).each { |file|
         m.file "configs/empty.log", "log/#{file}.log", :chmod => 0666
       }
+      
+      m.dependency "install_rubigen_scripts", [destination_root, "rubygems"], :shebang => options[:shebang]
     end
   end
 

data/bin/install_rubigen_scripts

@@ -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_component_sources!
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'install_rubigen_scripts')

data/generators/install_rubigen_scripts/install_rubigen_scripts_generator.rb

@@ -0,0 +1,65 @@
+class InstallRubigenScriptsGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :shebang => DEFAULT_SHEBANG
+  
+  attr_reader :path, :scopes
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.length < 2 # requires path and at least one scope
+    @path             = args.shift
+    @destination_root = File.expand_path(path)
+    @scopes           = args.map { |scope| scope.to_sym }
+    extract_options
+  end
+
+  def manifest
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+    windows            = (RUBY_PLATFORM =~ /dos|win32|cygwin/i) || (RUBY_PLATFORM =~ /(:?mswin|mingw)/)
+
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory "script"
+
+      %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
+    end
+  end
+  
+  def scopes_str
+    scopes.inspect
+  end
+  
+  protected
+    def banner
+      <<-EOS
+Installs script/generate and script/destroy scripts into current folder
+
+USAGE: #{spec.name} install_path scope[ scope]
+
+For example: #{spec.name} . rails rubygems
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      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("-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/generators/install_rubigen_scripts/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! <%= scopes_str %>
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/generators/install_rubigen_scripts/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! <%= scopes_str %>
+RubiGen::Scripts::Generate.new.run(ARGV)

data/generators/install_rubigen_scripts/templates/script/win_script.cmd

@@ -0,0 +1 @@
+@ruby <%= File.join("script", filename) %> %*

data/{lib/rubigen/generators/components → generators}/test_unit/test_unit_generator.rb

@@ -15,7 +15,7 @@ class TestUnitGenerator < RubiGen::Base
       m.directory 'test'
 
       # Model class, unit test, and fixtures.
-      m.template 'test',  "test/#{test_name}.rb"
+      m.template 'test.rb',  "test/#{test_name}.rb"
     end
   end
 

data/lib/rubigen/helpers/generator_test_helper.rb

@@ -35,8 +35,10 @@ module RubiGen
       logger_original=RubiGen::Base.logger
       myout=StringIO.new
       RubiGen::Base.logger=RubiGen::SimpleLogger.new(myout)
+      # TODO redirect $stdout to myout
       yield if block_given?
       RubiGen::Base.logger=logger_original
+      # TODO fix $stdout again
       myout.string
     end
 

data/lib/rubigen/lookup.rb

@@ -103,7 +103,7 @@ module RubiGen
       def application_sources(filters = [])
         filters.unshift 'app'
         app_sources = []
-        app_sources << PathSource.new(:builtin, "#{File.dirname(__FILE__)}/generators/applications")
+        app_sources << PathSource.new(:builtin, File.join(File.dirname(__FILE__), %w[.. .. app_generators]))
         app_sources << filtered_sources(filters)
         app_sources.flatten
       end
@@ -129,7 +129,7 @@ module RubiGen
           new_sources << PathSource.new(:vendor, "#{::APP_ROOT}/vendor/generators")
           new_sources << PathSource.new(:plugins, "#{::APP_ROOT}/vendor/plugins/*/**/generators")
         end
-        new_sources << PathSource.new(:builtin, "#{File.dirname(__FILE__)}/generators/components")
+        new_sources << PathSource.new(:builtin, File.join(File.dirname(__FILE__), %w[.. .. generators]))
         new_sources << filtered_sources(filters)
         write_inheritable_attribute(:sources, new_sources.flatten)
       end
@@ -240,7 +240,7 @@ module RubiGen
     end
 
     def ==(source)
-      self.class == source.class && path == source.path && filters == source.filters
+      self.class == source.class && path == source.path && filters == source.filters && label == source.label
     end
   end
 

data/lib/rubigen/version.rb

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

data/script/destroy

@@ -5,5 +5,5 @@ require File.join(File.dirname(__FILE__), %w[.. lib rubigen])
 require 'rubigen/scripts/destroy'
 
 ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! :rubygems, :newgem
+RubiGen::Base.use_component_sources! :rubygems, :merb
 RubiGen::Scripts::Destroy.new.run(ARGV)

data/test/test_generate_builtin_application.rb

@@ -1,6 +1,7 @@
-require File.dirname(__FILE__) + "/test_helper"
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
 
 class TestGenerateBuiltinApplication < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
 
   def setup
     bare_setup
@@ -11,14 +12,24 @@ class TestGenerateBuiltinApplication < Test::Unit::TestCase
   end
   
   def test_ruby_app
-    app_name = "myapp"
-    run_generator('ruby_app', ["#{APP_ROOT}/#{app_name}"], :app)
-    assert_generated_file("#{app_name}/Rakefile")
-    assert_generated_file("#{app_name}/README.txt")
-    assert_generated_file("#{app_name}/lib/#{app_name}.rb")
-    assert_generated_file("#{app_name}/test/test_helper.rb")
-    assert_generated_file("#{app_name}/script/generate")
+    run_generator('ruby_app', [APP_ROOT], sources)
+    assert_generated_file("Rakefile")
+    assert_generated_file("README.txt")
+    assert_generated_file("lib/#{PROJECT_NAME}.rb")
+    assert_generated_file("test/test_helper.rb")
+    assert_generated_file("script/generate")
+    assert_generated_file("script/destroy")
     
-    assert_generated_module("#{app_name}/lib/#{app_name}")
+    assert_generated_module("lib/#{PROJECT_NAME}")
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "app_generators"
   end
 end

data/test/test_generate_builtin_test_unit.rb

@@ -1,6 +1,7 @@
-require File.dirname(__FILE__) + "/test_helper"
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
 
 class TestGenerateBuiltinTestUnit < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
 
   def setup
     rubygems_setup

data/test/test_generator_helper.rb

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

data/test/test_helper.rb

@@ -1,17 +1,6 @@
 require 'test/unit'
-
-# 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
-
 require File.dirname(__FILE__) + '/../lib/rubigen'
 require 'rubigen/helpers/generator_test_helper'
-Test::Unit::TestCase.send(:include, RubiGen::GeneratorTestHelper)
 include RubiGen
 
 begin

data/test/test_install_rubigen_scripts_generator.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestInstallRubigenScriptsGenerator < 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_install_rubigen_scripts_should_create_script_generate
+    run_generator('install_rubigen_scripts', [APP_ROOT] + %w(rubygems merb), sources)
+    assert_directory_exists "script"
+    assert_generated_file   "script/generate"
+    assert_generated_file   "script/destroy"
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "app_generators"
+  end
+end

data/test/test_lookup.rb

@@ -1,8 +1,12 @@
-require File.dirname(__FILE__) + "/test_helper"
+require File.dirname(__FILE__) + "/test_generator_helper"
 
 class TestLookup < Test::Unit::TestCase
   include RubiGen
   
+  def setup
+    Base.reset_sources
+  end
+  
   def test_lookup_component
     assert_nothing_raised(GeneratorError, "Could not find test_unit generator") { Base.lookup('test_unit') }
   end
@@ -83,7 +87,7 @@ class TestLookup < Test::Unit::TestCase
   
   def test_use_application_sources
     Base.use_application_sources!
-    expected_path = File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib rubigen generators applications]))
+    expected_path = File.expand_path(File.join(File.dirname(__FILE__), %w[.. app_generators]))
     builtin_source = Base.sources.find { |s| s.path == expected_path if s.respond_to?(:path) }
     assert_not_nil(builtin_source, "Cannot find builtin generators")
     assert_nothing_raised(GeneratorError) do

data/website/index.html

@@ -31,7 +31,7 @@
     <h1>rubigen</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/rubigen"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/rubigen" class="numbers">1.0.0</a>
+      <a href="http://rubyforge.org/projects/rubigen" class="numbers">1.0.1</a>
     </div>
     <h1>Ruby Generator Framework</h1>
 

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4.3
 specification_version: 1
 name: rubigen
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-08-20 00:00:00 +02:00
-summary: description of gem
+  version: 1.0.1
+date: 2007-08-21 00:00:00 +02:00
+summary: "A framework to allow Ruby applications to generate file/folder stubs (like the rails command does for Ruby on Rails, and the \xE2\x80\x98script/generate\xE2\x80\x99 command within a Rails application during development)."
 require_paths: 
 - lib
 email: drnicwilliams@gmail.com
 homepage: http://rubigen.rubyforge.org
 rubyforge_project: rubigen
-description: description of gem
+description: "A framework to allow Ruby applications to generate file/folder stubs (like the rails command does for Ruby on Rails, and the \xE2\x80\x98script/generate\xE2\x80\x99 command within a Rails application during development)."
 autorequire: 
 default_executable: 
 bindir: bin
@@ -34,6 +34,15 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- app_generators/ruby_app/USAGE
+- app_generators/ruby_app/ruby_app_generator.rb
+- app_generators/ruby_app/templates/README.txt
+- app_generators/ruby_app/templates/configs/empty.log
+- app_generators/ruby_app/templates/fresh_rakefile
+- app_generators/ruby_app/templates/module.rb
+- app_generators/ruby_app/templates/script/generate
+- app_generators/ruby_app/templates/test_helper.rb
+- bin/install_rubigen_scripts
 - bin/ruby_app
 - examples/rails_generators/applications/app/USAGE
 - examples/rails_generators/applications/app/app_generator.rb
@@ -106,21 +115,18 @@ files:
 - examples/rails_generators/components/web_service/templates/controller.rb
 - examples/rails_generators/components/web_service/templates/functional_test.rb
 - examples/rails_generators/components/web_service/web_service_generator.rb
+- generators/install_rubigen_scripts/USAGE
+- generators/install_rubigen_scripts/install_rubigen_scripts_generator.rb
+- generators/install_rubigen_scripts/templates/script/destroy
+- generators/install_rubigen_scripts/templates/script/generate
+- generators/install_rubigen_scripts/templates/script/win_script.cmd
+- generators/test_unit/USAGE
+- generators/test_unit/templates/test.rb
+- generators/test_unit/test_unit_generator.rb
 - lib/rubigen.rb
 - lib/rubigen/base.rb
 - lib/rubigen/commands.rb
 - lib/rubigen/generated_attribute.rb
-- lib/rubigen/generators/applications/ruby_app/USAGE
-- lib/rubigen/generators/applications/ruby_app/ruby_app_generator.rb
-- lib/rubigen/generators/applications/ruby_app/templates/README.txt
-- lib/rubigen/generators/applications/ruby_app/templates/configs/empty.log
-- lib/rubigen/generators/applications/ruby_app/templates/fresh_rakefile
-- lib/rubigen/generators/applications/ruby_app/templates/module.rb
-- lib/rubigen/generators/applications/ruby_app/templates/script/generate
-- lib/rubigen/generators/applications/ruby_app/templates/test_helper.rb
-- lib/rubigen/generators/components/test_unit/USAGE
-- lib/rubigen/generators/components/test_unit/templates/test
-- lib/rubigen/generators/components/test_unit/test_unit_generator.rb
 - lib/rubigen/helpers/generator_test_helper.rb
 - lib/rubigen/lookup.rb
 - lib/rubigen/manifest.rb
@@ -141,7 +147,9 @@ files:
 - test/examples_from_rails/test_rails_scaffold_generator.rb
 - test/test_generate_builtin_application.rb
 - test/test_generate_builtin_test_unit.rb
+- test/test_generator_helper.rb
 - test/test_helper.rb
+- test/test_install_rubigen_scripts_generator.rb
 - test/test_lookup.rb
 - website/index.html
 - website/index.txt
@@ -153,7 +161,9 @@ test_files:
 - test/examples_from_rails/test_rails_scaffold_generator.rb
 - test/test_generate_builtin_application.rb
 - test/test_generate_builtin_test_unit.rb
+- test/test_generator_helper.rb
 - test/test_helper.rb
+- test/test_install_rubigen_scripts_generator.rb
 - test/test_lookup.rb
 rdoc_options: 
 - --main
@@ -163,9 +173,10 @@ extra_rdoc_files:
 - License.txt
 - Manifest.txt
 - README.txt
-- lib/rubigen/generators/applications/ruby_app/templates/README.txt
+- app_generators/ruby_app/templates/README.txt
 - website/index.txt
 executables: 
+- install_rubigen_scripts
 - ruby_app
 extensions: []