rubigen 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+== =0.1.0 2007-08-17
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,17 @@
+Copyright (c) 2007 Dr Nic Williams
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,119 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ruby_app
+examples/rails_generators/applications/app/USAGE
+examples/rails_generators/applications/app/app_generator.rb
+examples/rails_generators/components/controller/USAGE
+examples/rails_generators/components/controller/controller_generator.rb
+examples/rails_generators/components/controller/templates/controller.rb
+examples/rails_generators/components/controller/templates/functional_test.rb
+examples/rails_generators/components/controller/templates/helper.rb
+examples/rails_generators/components/controller/templates/view.html.erb
+examples/rails_generators/components/integration_test/USAGE
+examples/rails_generators/components/integration_test/integration_test_generator.rb
+examples/rails_generators/components/integration_test/templates/integration_test.rb
+examples/rails_generators/components/mailer/USAGE
+examples/rails_generators/components/mailer/mailer_generator.rb
+examples/rails_generators/components/mailer/templates/fixture.erb
+examples/rails_generators/components/mailer/templates/fixture.rhtml
+examples/rails_generators/components/mailer/templates/mailer.rb
+examples/rails_generators/components/mailer/templates/unit_test.rb
+examples/rails_generators/components/mailer/templates/view.erb
+examples/rails_generators/components/mailer/templates/view.rhtml
+examples/rails_generators/components/migration/USAGE
+examples/rails_generators/components/migration/migration_generator.rb
+examples/rails_generators/components/migration/templates/migration.rb
+examples/rails_generators/components/model/USAGE
+examples/rails_generators/components/model/model_generator.rb
+examples/rails_generators/components/model/templates/fixtures.yml
+examples/rails_generators/components/model/templates/migration.rb
+examples/rails_generators/components/model/templates/model.rb
+examples/rails_generators/components/model/templates/unit_test.rb
+examples/rails_generators/components/observer/USAGE
+examples/rails_generators/components/observer/observer_generator.rb
+examples/rails_generators/components/observer/templates/observer.rb
+examples/rails_generators/components/observer/templates/unit_test.rb
+examples/rails_generators/components/plugin/USAGE
+examples/rails_generators/components/plugin/plugin_generator.rb
+examples/rails_generators/components/plugin/templates/MIT-LICENSE
+examples/rails_generators/components/plugin/templates/README
+examples/rails_generators/components/plugin/templates/Rakefile
+examples/rails_generators/components/plugin/templates/USAGE
+examples/rails_generators/components/plugin/templates/generator.rb
+examples/rails_generators/components/plugin/templates/init.rb
+examples/rails_generators/components/plugin/templates/install.rb
+examples/rails_generators/components/plugin/templates/plugin.rb
+examples/rails_generators/components/plugin/templates/tasks.rake
+examples/rails_generators/components/plugin/templates/uninstall.rb
+examples/rails_generators/components/plugin/templates/unit_test.rb
+examples/rails_generators/components/resource/USAGE
+examples/rails_generators/components/resource/resource_generator.rb
+examples/rails_generators/components/resource/templates/USAGE
+examples/rails_generators/components/resource/templates/controller.rb
+examples/rails_generators/components/resource/templates/fixtures.yml
+examples/rails_generators/components/resource/templates/functional_test.rb
+examples/rails_generators/components/resource/templates/helper.rb
+examples/rails_generators/components/scaffold/USAGE
+examples/rails_generators/components/scaffold/scaffold_generator.rb
+examples/rails_generators/components/scaffold/templates/controller.rb
+examples/rails_generators/components/scaffold/templates/functional_test.rb
+examples/rails_generators/components/scaffold/templates/helper.rb
+examples/rails_generators/components/scaffold/templates/layout.html.erb
+examples/rails_generators/components/scaffold/templates/style.css
+examples/rails_generators/components/scaffold/templates/view_edit.html.erb
+examples/rails_generators/components/scaffold/templates/view_index.html.erb
+examples/rails_generators/components/scaffold/templates/view_new.html.erb
+examples/rails_generators/components/scaffold/templates/view_show.html.erb
+examples/rails_generators/components/session_migration/USAGE
+examples/rails_generators/components/session_migration/session_migration_generator.rb
+examples/rails_generators/components/session_migration/templates/migration.rb
+examples/rails_generators/components/web_service/USAGE
+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
+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
+lib/rubigen/options.rb
+lib/rubigen/scripts.rb
+lib/rubigen/scripts/destroy.rb
+lib/rubigen/scripts/generate.rb
+lib/rubigen/scripts/update.rb
+lib/rubigen/simple_logger.rb
+lib/rubigen/spec.rb
+lib/rubigen/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+test/examples_from_rails/generator_test_helper.rb
+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_helper.rb
+test/test_lookup.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,204 @@
+= RubiGen - Ruby Generator Framework
+
+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).
+
+== Background
+
+RubiGen is originally extracted from Ruby on Rails (specifically the rails_generator
+from its railties gem).
+
+The rails_generator was hardcoded with Rails-specific dependencies (`RAILS_ROOT`), 
+Rails generators ('app' = Rails application; 'model' = Rails model+tests+migration),
+and generally assumed it was the only generator framework within the Ruby world (it was).
+So, any RubyGem whose name ended with '_generator' was assumed to be a generator for
+a Rails application.
+
+But if you are developing a Merb application, then you may want a different set of generators.
+If you are developing a RubyGem, then you will want a different set of generators.
+
+RubiGen exists to give different development environments their own generator framework.
+
+== Installation
+
+RubiGen is only required at development time, and normally isn't required at deployment time
+(unless your application uses it to generate files etc for its users).
+
+On your development machine:
+
+    gem install rubigen -y
+    
+== Usage
+
+RubiGen will be normally integrated into another RubyGem, such as `newgem` or `merb` or `camping`,
+rather than be used on its own.
+
+These frameworks might use RubiGen for two reasons:
+  
+1. To generate an initial stub for developers, e.g. `rails` generated a stub to write a Rails application.
+   `newgem` generates a stub to write a RubyGem.
+   BTW - RubiGen has a builtin application `ruby_app` which generates a bare-bones Ruby application
+   stub (lib, test, and script folders, plus a Rakefile, and a script/generate script)
+2. To generate components within their development areas, e.g. Rails had its `script/generate`
+   script within each Rails application, which hooked back into the rails_generator to lookup
+   and execute generators.
+
+So, there are two steps to integrating RubiGen into your framework:
+
+1. Use it to generate an initial stub for the developers of your framework. This would create the folders 
+   (`lib/app`, `test`, `script`, `doc`, `log`, etc) and starting files (`Rakefile`, 
+   `README.txt`, `test/test_helper.rb` etc). Importantly, it would generate a `script/generate` file.
+   The `script/generate` file (example below) will allow developers of your framework to 
+   generate components/extensions within the framework.
+   RubiGen allows you to restrict which generators are available. For example, within
+   RubyGem development environment (as generated by `newgem`), the `script/generator`
+   only shows `rubygem`-related generators. Merb could restrict `script/generator`
+   to only show Merb related generators (or perhaps Merb and/or Rails generators)
+2. Your framework RubyGem (e.g. `newgem` or `merb` RubyGems) needs to add `rubigen` as a 
+   dependency, so that users of your RubyGem can access the generator framework.
+   
+= Creating generators
+
+There are two types of generators:
+
+1. Application Generators - used by developers of your framework to get started. 
+   Generally, you will create one Application Generator for your framework.
+   It generates a base stub (such as the `rails` stub for new Rails applications)
+   for your framework users.
+2. Component Generators - used by developers to extend their application.
+   You may include 1+ built-in generators with your framework.
+   Developers can also write generators for your framework, and like Rails' generator
+   install them in various places and have access to their via RubiGen.
+   
+== Creating an Application Generator for your Framework
+
+Without RubiGen, to give your users a head start and create a stub for them, you will 
+copiously use `mkdir_p` and `File.open`. Your script will either be primitive (only
+create the bare folders and very few files) or it will be very long and unreadable
+(ok, perhaps I'm just talking about the `newgem` script, which I am dubiously responsible
+for... :P).
+
+With RubiGen, you can create stubs using powerful, yet simple, syntax. Templates are
+extracted into a `templates` folder, and activating the generator from a script requires
+only a few lines of code.
+
+These are the `newgem` files related to its Application Generator.
+
+    bin/
+      bin/newgem        # Appliction Generator script; Usage: newgem gemname [options]
+    app_generators/
+      app_generators/newgem/
+        app_generators/newgem/newgem_generator.rb
+        app_generators/newgem/USAGE
+        app_generators/newgem/templates/
+          app_generators/newgem/templates/app.rb
+          app_generators/newgem/templates/History.txt
+          app_generators/newgem/templates/... lots and lots of templates
+
+The `bin/newgem` script is very simple, and looks like:
+
+    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!
+    RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'newgem')
+
+You can copy and paste this for your own generator script, and place it in your RubyGem's `bin` folder.
+Change `newgem` to your RubyGem's name in the script above (and in all the folders listed above too)
+
+NOTE: If you leave `newgem` there, then it will execute the `newgem_generator.rb` generator; 
+as the generators are loaded from all RubyGem's having `/app_generators` folders.
+
+So, for your RubyGem, you need to keep the `/app_generators` folder (as you are creating an 
+Application Generator, not a Component Generator), but change `newgem` to `your gem name` in
+all the subfolders and files. ESPECIALLY `newgem_generator.rb` -> `yourgem_generator.rb`,
+as this is how the generator is discovered (via `RubiGen::Base.use_application_sources!`).
+
+All the generator work is performed within `yourgem_generator.rb`. A stub for it will be:
+
+    require 'rbconfig'
+
+    class YourgemGenerator < RubiGen::Base
+      DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                                  Config::CONFIG['ruby_install_name'])
+
+      default_options   :shebang => DEFAULT_SHEBANG,
+                        :an_option => 'some_default'
+  
+      attr_reader :app_name, :module_name
+  
+      def initialize(runtime_args, runtime_options = {})
+        super
+        usage if args.empty?
+        @destination_root = args.shift
+        @app_name     = File.basename(File.expand_path(@destination_root))
+        @module_name  = app_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] }
+        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 }
+      
+          # Root
+          m.template_copy_each %w( Rakefile )
+          m.file_copy_each     %w( README.txt )
+
+          # Test helper
+          m.template   "test_helper.rb",        "test/test_helper.rb"
+
+          # Scripts
+          %w( generate ).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
+
+      protected
+        def banner
+          <<-EOS
+    Create a stub for #{File.basename $0} to get started.
+
+    Usage: #{File.basename $0} /path/to/your/app [options]"
+    EOS
+        end
+
+        def add_options!(opts)
+          opts.separator ''
+          opts.separator "#{File.basename $0} options:"
+          opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+        end
+    
+      # Installation skeleton.  Intermediate directories are automatically
+      # created so don't sweat their absence here.
+      BASEDIRS = %w(
+        doc
+        lib
+        log
+        script
+        test
+        tmp
+      )
+    end
+
+Easy peasy.
+
+== Creating a Component Generator for your Framework
+

data/Rakefile

@@ -0,0 +1,142 @@
+require 'rubygems'
+begin
+  require 'rake'
+rescue LoadError
+  puts 'This script should only be accessed via the "rake" command.'
+  puts 'Installation: gem install rake -y'
+  exit
+end
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+begin
+  require 'hoe'
+rescue LoadError
+  puts 'This Rakefile requires the "hoe" RubyGem.'
+  puts 'Installation: gem install hoe -y'
+  exit
+end
+
+
+
+include FileUtils
+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"
+GEM_NAME = 'rubigen' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+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 ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'rubigen' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "rubigen"
+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 = Rubigen::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+# RDOC_OPTS = ['--quiet', '--title', 'rubigen 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 |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  # An array of rubygem dependencies [name, version], e.g. [ ['activesupport', '>= 1.3.1'] ]
+  p.extra_deps = [['activesupport', '>= 1.3.1']]     
+  
+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 do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  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]
+
+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'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end

data/bin/ruby_app

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../lib/rubigen/version'
+if %w(--version -v).include? ARGV.first
+  puts "Rails #{RubiGen::VERSION::STRING}"
+  exit(0)
+end
+
+app_path = ARGV.first
+
+require File.dirname(__FILE__) + '/../lib/rubigen'
+require 'rubigen/scripts/generate'
+RubiGen::Base.use_application_sources!
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'ruby_app')

data/examples/rails_generators/applications/app/USAGE

@@ -0,0 +1,16 @@
+Description:
+    The 'rails' command creates a new Rails application with a default
+    directory structure and configuration at the path you specify.
+
+Example:
+    rails ~/Code/Ruby/weblog
+
+    This generates a skeletal Rails installation in ~/Code/Ruby/weblog.
+    See the README in the newly created application to get going.
+
+WARNING:
+    Only specify --without-gems if you did not use gems to install Rails.
+    Your application will expect to find activerecord, actionpack, and
+    actionmailer directories in the vendor directory.  A popular way to track
+    the bleeding edge of Rails development is to checkout from source control
+    directly to the vendor directory.  See http://dev.rubyonrails.org/