rubigen 1.0.0

data/examples/rails_generators/components/scaffold/templates/style.css

@@ -0,0 +1,74 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#errorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+div.uploadStatus {
+  margin: 5px;
+}
+
+div.progressBar {
+  margin: 5px;
+}
+
+div.progressBar div.border {
+  background-color: #fff;
+  border: 1px solid grey;
+  width: 100%;
+}
+
+div.progressBar div.background {
+  background-color: #333;
+  height: 18px;
+  width: 0%;
+}
+

data/examples/rails_generators/components/scaffold/templates/view_edit.html.erb

@@ -0,0 +1,19 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%%= error_messages_for :<%= singular_name %> %>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+<% for attribute in attributes -%>
+  <p>
+    <b><%= attribute.column.human_name %></b><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+
+<% end -%>
+  <p>
+    <%%= f.submit "Update" %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Show', @<%= singular_name %> %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/examples/rails_generators/components/scaffold/templates/view_index.html.erb

@@ -0,0 +1,24 @@
+<h1>Listing <%= plural_name %></h1>
+
+<table>
+  <tr>
+<% for attribute in attributes -%>
+    <th><%= attribute.column.human_name %></th>
+<% end -%>
+  </tr>
+
+<%% for <%= singular_name %> in @<%= plural_name %> %>
+  <tr>
+<% for attribute in attributes -%>
+    <td><%%=h <%= singular_name %>.<%= attribute.name %> %></td>
+<% end -%>
+    <td><%%= link_to 'Show', <%= singular_name %> %></td>
+    <td><%%= link_to 'Edit', edit_<%= singular_name %>_path(<%= singular_name %>) %></td>
+    <td><%%= link_to 'Destroy', <%= singular_name %>, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<%% end %>
+</table>
+
+<br />
+
+<%%= link_to 'New <%= singular_name %>', new_<%= singular_name %>_path %>

data/examples/rails_generators/components/scaffold/templates/view_new.html.erb

@@ -0,0 +1,18 @@
+<h1>New <%= singular_name %></h1>
+
+<%%= error_messages_for :<%= singular_name %> %>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+<% for attribute in attributes -%>
+  <p>
+    <b><%= attribute.column.human_name %></b><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+
+<% end -%>
+  <p>
+    <%%= f.submit "Create" %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/examples/rails_generators/components/scaffold/templates/view_show.html.erb

@@ -0,0 +1,10 @@
+<% for attribute in attributes -%>
+<p>
+  <b><%= attribute.column.human_name %>:</b>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<%%= link_to 'Edit', edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/examples/rails_generators/components/session_migration/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates a migration to add the sessions table used by the Active Record
+    session store. Pass the migration name, either CamelCased or under_scored,
+    as an argument.
+
+Example:
+    `./script/generate session_migration CreateSessionTable`
+
+    With 4 existing migrations, this creates the AddSessionTable migration
+    in db/migrate/005_add_session_table.rb

data/examples/rails_generators/components/session_migration/session_migration_generator.rb

@@ -0,0 +1,18 @@
+class SessionMigrationGenerator < RubiGen::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args << 'add_session_table' if runtime_args.empty?
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate',
+        :assigns => { :session_table_name => default_session_table_name }
+    end
+  end
+
+  protected
+    def default_session_table_name
+      ActiveRecord::Base.pluralize_table_names ? 'session'.pluralize : 'session'
+    end
+end

data/examples/rails_generators/components/session_migration/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= session_table_name %> do |t|
+      t.string :session_id, :null => false
+      t.text :data
+      t.timestamps
+    end
+
+    add_index :<%= session_table_name %>, :session_id
+    add_index :<%= session_table_name %>, :updated_at
+  end
+
+  def self.down
+    drop_table :<%= session_table_name %>
+  end
+end

data/examples/rails_generators/components/web_service/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Stubs out the controller and API for a new web service using the deprecated
+    Action Web Service framework. Pass the web service name, either CamelCased
+    or under_scored, and a list of API methods as arguments. To create a web
+    service within a module, use a path like 'module_name/web_service_name'.
+
+    This generates a controller in app/controllers, an API definition
+    in app/apis, and functional tests in test/functional.
+
+Example:
+    `./script/generate web_service User add edit list remove`
+
+    creates the User controller, API, and functional test:
+        Controller: app/controllers/user_controller.rb
+        API:        app/apis/user_api.rb
+        Test:       test/functional/user_api_test.rb
+
+Modules Example:
+    `./script/generate web_service 'api/registration' register renew`
+
+    creates the Registration controller, API, and functional test:
+        Controller: app/controllers/api/registration_controller.rb
+        API:        app/apis/api/registration_api.rb
+        Test:       test/functional/api/registration_api_test.rb

data/examples/rails_generators/components/web_service/templates/api_definition.rb

@@ -0,0 +1,5 @@
+class <%= class_name %>Api < ActionWebService::API::Base
+<% for method_name in args -%>
+  api_method :<%= method_name %>
+<% end -%>
+end

data/examples/rails_generators/components/web_service/templates/controller.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Controller < ApplicationController
+  wsdl_service_name '<%= class_name %>'
+<% for method_name in args -%>
+
+  def <%= method_name %>
+  end
+<% end -%>
+end

data/examples/rails_generators/components/web_service/templates/functional_test.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+require '<%= file_path %>_controller'
+
+class <%= class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= class_name %>ControllerApiTest < Test::Unit::TestCase
+  def setup
+    @controller = <%= class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+<% for method_name in args -%>
+
+  def test_<%= method_name %>
+    result = invoke :<%= method_name %>
+    assert_equal nil, result
+  end
+<% end -%>
+end

data/examples/rails_generators/components/web_service/web_service_generator.rb

@@ -0,0 +1,29 @@
+class WebServiceGenerator < RubiGen::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Api", "#{class_name}Controller", "#{class_name}ApiTest"
+
+      # API and test directories.
+      m.directory File.join('app/apis', class_path)
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('test/functional', class_path)
+
+      # API definition, controller, and functional test.
+      m.template 'api_definition.rb',
+                  File.join('app/apis',
+                            class_path,
+                            "#{file_name}_api.rb")
+
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            class_path,
+                            "#{file_name}_controller.rb")
+
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            class_path,
+                            "#{file_name}_api_test.rb")
+    end
+  end
+end

data/lib/rubigen/base.rb

@@ -0,0 +1,168 @@
+require File.dirname(__FILE__) + '/options'
+require File.dirname(__FILE__) + '/manifest'
+require File.dirname(__FILE__) + '/spec'
+require File.dirname(__FILE__) + '/generated_attribute'
+
+# RubiGen is a code generation platform Ruby frameworks.  
+# Generators are easily invoked within Ruby framework instances
+# to add and remove components such as library and test files.
+#
+# New generators are easy to create and may be distributed within RubyGems,
+# user home directory, or within each Ruby framework that uses RubiGen.
+#
+# For example, newgem uses RubiGen to generate new RubyGems. Those 
+# generated RubyGems can then use RubiGen (via a generated script/generate 
+# application) to generate tests and executable apps, etc, for the RubyGem.
+#
+# Generators may subclass other generators to provide variations that
+# require little or no new logic but replace the template files.
+#
+# For a RubyGem, put your generator classes and templates within subfolders
+# of the +generators+ directory. 
+#
+# The layout of generator files can be seen in the built-in 
+# +test_unit+ generator:
+#   
+#   generators/
+#     test_unit/
+#       test_unit_generator.rb
+#       templates/
+#         test_unit.rb
+#
+# The directory name (+test_unit+) matches the name of the generator file
+# (test_unit_generator.rb) and class (+TestUnitGenerator+). The files
+# that will be copied or used as templates are stored in the +templates+
+# directory.
+#
+# The filenames of the templates don't matter, but choose something that
+# will be self-explatatory since you will be referencing these in the 
+# +manifest+ method inside your generator subclass.
+#
+# 
+module RubiGen
+  class GeneratorError < StandardError; end
+  class UsageError < GeneratorError; end
+
+
+  # The base code generator is bare-bones.  It sets up the source and
+  # destination paths and tells the logger whether to keep its trap shut.
+  #
+  # It's useful for copying files such as stylesheets, images, or 
+  # javascripts.
+  #
+  # For more comprehensive template-based passive code generation with
+  # arguments, you'll want RubiGen::NamedBase. 
+  #
+  # Generators create a manifest of the actions they perform then hand
+  # the manifest to a command which replays the actions to do the heavy
+  # lifting (such as checking for existing files or creating directories
+  # if needed). Create, destroy, and list commands are included.  Since a
+  # single manifest may be used by any command, creating new generators is
+  # as simple as writing some code templates and declaring what you'd like
+  # to do with them.
+  #
+  # The manifest method must be implemented by subclasses, returning a
+  # RubiGen::Manifest.  The +record+ method is provided as a
+  # convenience for manifest creation.  Example:
+  #
+  #   class StylesheetGenerator < RubiGen::Base
+  #     def manifest
+  #       record do |m|
+  #         m.directory('public/stylesheets')
+  #         m.file('application.css', 'public/stylesheets/application.css')
+  #       end
+  #     end
+  #   end
+  #
+  # See RubiGen::Commands::Create for a list of methods available
+  # to the manifest.
+  class Base
+    include Options
+
+    # Declare default options for the generator.  These options
+    # are inherited to subclasses.
+    default_options :collision => :ask, :quiet => false
+
+    # A logger instance available everywhere in the generator.
+    cattr_accessor :logger
+
+    # Every generator that is dynamically looked up is tagged with a
+    # Spec describing where it was found.
+    class_inheritable_accessor :spec
+
+    attr_reader :source_root, :destination_root, :args
+
+    def initialize(runtime_args, runtime_options = {})
+      @args = runtime_args
+      parse!(@args, runtime_options)
+
+      # Derive source and destination paths.
+      @source_root = options[:source] || File.join(spec.path, 'templates')
+      if options[:destination]
+        @destination_root = options[:destination]
+      elsif defined? ::APP_ROOT
+        @destination_root = ::APP_ROOT
+      end
+
+      # Silence the logger if requested.
+      logger.quiet = options[:quiet]
+
+      # Raise usage error if help is requested.
+      usage if options[:help]
+    end
+
+    # Generators must provide a manifest.  Use the +record+ method to create
+    # a new manifest and record your generator's actions.
+    def manifest
+      raise NotImplementedError, "No manifest for '#{spec.name}' generator."
+    end
+
+    # Return the full path from the source root for the given path.
+    # Example for source_root = '/source':
+    #   source_path('some/path.rb') == '/source/some/path.rb'
+    #
+    # The given path may include a colon ':' character to indicate that
+    # the file belongs to another generator.  This notation allows any
+    # generator to borrow files from another.  Example:
+    #   source_path('model:fixture.yml') = '/model/source/path/fixture.yml'
+    def source_path(relative_source)
+      # Check whether we're referring to another generator's file.
+      name, path = relative_source.split(':', 2)
+
+      # If not, return the full path to our source file.
+      if path.nil?
+        File.join(source_root, name)
+
+      # Otherwise, ask our referral for the file.
+      else
+        # FIXME: this is broken, though almost always true.  Others'
+        # source_root are not necessarily the templates dir.
+        File.join(self.class.lookup(name).path, 'templates', path)
+      end
+    end
+
+    # Return the full path from the destination root for the given path.
+    # Example for destination_root = '/dest':
+    #   destination_path('some/path.rb') == '/dest/some/path.rb'
+    def destination_path(relative_destination)
+      File.join(destination_root, relative_destination)
+    end
+
+    protected
+      # Convenience method for generator subclasses to record a manifest.
+      def record
+        RubiGen::Manifest.new(self) { |m| yield m }
+      end
+
+      # Override with your own usage banner.
+      def banner
+        "Usage: #{$0} #{spec.name} [options]"
+      end
+
+      # Read USAGE from file in generator base path.
+      def usage_message
+        File.read(File.join(spec.path, 'USAGE')) rescue ''
+      end
+  end
+
+end