has_many_through_generator 0.4.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 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/README

@@ -0,0 +1,18 @@
+*******************************************************************************************
+** For all documentation see the project website: http://hasmanythrough.rubyforge.org    **
+*******************************************************************************************
+
+Description:
+
+Example:
+    ./script/generate has_many_throuh User Group
+    ./script/generate has_many_throuh User Group Membership
+
+    Both will generate User and Group models and unit tests (if they don't 
+    already exist). It will both also generate a third model representing
+    the many-to-many relationship between the two, called UserGroup (first
+    example and Membership (second example).
+    
+    It will also generate unit tests for the many-to-many class, and all
+    unit tests will test the relationships between the other two classes.
+

data/has_many_through_generator.rb

@@ -0,0 +1,330 @@
+class Hash
+  # lets through the keys in the argument
+  # >> {:one => 1, :two => 2, :three => 3}.pass(:one)
+  # => {:one=>1}
+  def pass(*keys)
+    tmp = self.clone
+    keys = keys[0] if keys[0].is_a? Array
+    tmp.delete_if {|k,v| ! keys.include?(k) }
+    tmp
+  end
+
+	def merge_with_prefix(prefix, hash)
+		merged = clone
+		hash.each {|key, value| merged.merge!("#{prefix}_#{key}" => value)}
+		merged
+	end
+
+	def merge_with_prefix!(prefix, hash)
+		hash.each {|key, value| merge!("#{prefix}_#{key}" => value)}
+	end
+end
+
+class Rails::Generator::Manifest
+	attr_reader :actions
+
+  def copy_actions(manifest)
+		@actions.concat(manifest.actions)
+  end
+end
+
+module Rails::Generator::Commands
+  # Create is the premier generator command.  It copies files, creates
+  # directories, renders templates, and more.
+  class Create < Base
+    # When creating a migration, it knows to find the first available file in db/migrate and use the migration.rb template.
+    def migration_template(relative_source, relative_destination, template_options = {})
+      migration_directory relative_destination
+      migration_file_name = template_options[:migration_file_name] || file_name
+      if not migration_exists?(migration_file_name)
+        template(relative_source, "#{relative_destination}/#{next_migration_string}_#{migration_file_name}.rb", template_options)
+      else
+      	puts "Skipping migration #{migration_file_name}, as already exists: #{existing_migrations(migration_file_name).first}" if migration_exists?(migration_file_name)
+      end
+    end
+  end
+end
+
+module Rails
+  module Generator
+  	class MultiNamedBase < Rails::Generator::Base
+  		attr_reader		:all_attrs,
+  		              :name, :class_name, :singular_name, :plural_name, :table_name,
+  		              :class_path, :file_path, :class_nesting, :class_nesting_depth
+  		alias_method  :file_name,  :singular_name
+      attr_reader		:controller_name,
+                    :controller_class_path,
+                    :controller_file_path,
+                    :controller_class_nesting,
+                    :controller_class_nesting_depth,
+                    :controller_class_name,
+                    :controller_singular_name,
+                    :controller_plural_name
+      alias_method  :controller_file_name,  :controller_singular_name
+      alias_method  :controller_table_name, :controller_plural_name
+      #alias_method  :base_controller_file_path, :controller_file_path
+
+			MODEL_ATTRS = %w(name class_name singular_name plural_name
+						table_name class_path file_path class_nesting
+						class_nesting_depth file_name singular_name)
+			CONTROLLER_ATTRS = %w(controller_name controller_class_path 
+						controller_file_path controller_class_nesting
+						controller_class_nesting_depth controller_class_name 
+						controller_singular_name controller_plural_name)
+
+  		def initialize(runtime_args, runtime_options = {})
+  			super
+
+  			# Name argument is required.
+  			usage if runtime_args.empty? or runtime_args.length < 2
+
+  			@all_attrs = {}
+
+  			runtime_args.each do |base_name|
+  				load_attrs(base_name)
+  				assign_names!(base_name)
+  				store_attrs(base_name)
+  			end
+  		end
+
+		protected
+			def load_attrs(key)
+				all_attrs[key] = {} if not all_attrs[key]
+				MODEL_ATTRS.concat(CONTROLLER_ATTRS).each do |attr|
+					instance_variable_set "@#{attr.to_s}", all_attrs[key][attr]
+				end
+				all_attrs[key]
+			end
+
+			def store_attrs(key)
+				all_attrs[key] = instance_values.pass(MODEL_ATTRS.concat(CONTROLLER_ATTRS))
+			end
+
+			def assign_names!(name)
+				@name = name
+				base_name, @class_path, @file_path, @class_nesting, @class_nesting_depth = extract_modules(@name)
+				@class_name_without_nesting, @singular_name, @plural_name = inflect_names(base_name)
+				@table_name = ActiveRecord::Base.pluralize_table_names ? plural_name : singular_name
+				if @class_nesting.empty?
+					@class_name = @class_name_without_nesting
+				else
+					@class_name = "#{@class_nesting}::#{@class_name_without_nesting}"
+				end
+				
+        @controller_name ||= ActiveRecord::Base.pluralize_table_names ? @name.pluralize : @name
+    
+        base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+        @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
+    
+        if @controller_class_nesting.empty?
+          @controller_class_name = @controller_class_name_without_nesting
+        else
+          @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+        end
+			end
+
+			# Extract modules from filesystem-style or ruby-style path:
+			#   good/fun/stuff
+			#   Good::Fun::Stuff
+			# produce the same results.
+			def extract_modules(name)
+				modules = name.include?('/') ? name.split('/') : name.split('::')
+				name    = modules.pop
+				path    = modules.map { |m| m.underscore }
+				file_path = (path + [name.underscore]).join('/')
+				nesting = modules.map { |m| m.camelize }.join('::')
+				[name, path, file_path, nesting, modules.size]
+			end
+
+			def inflect_names(name)
+				camel  = name.camelize
+				under  = camel.underscore
+				plural = under.pluralize
+				[camel, under, plural]
+			end
+		end
+	end
+end
+
+class HasManyThroughGenerator < Rails::Generator::MultiNamedBase
+  default_options :skip_migration => false
+
+  attr_reader   :models, :manytomany
+
+  def initialize(runtime_args, runtime_options = {})
+  	super
+
+  	@models = runtime_args[0..1].sort
+
+  	if not (@manytomany = runtime_args[2])
+  		@manytomany = "#{models[0]}#{models[1]}"
+			load_attrs(@manytomany)
+			assign_names!(@manytomany)
+			store_attrs(@manytomany)
+		end
+
+		first_attrs_orig = all_attrs[@models.first].clone
+		second_attrs_orig = all_attrs[@models.last].clone
+		manytomany_attrs_orig = all_attrs[@manytomany].clone
+		all_attrs[@manytomany].merge_with_prefix!("first", first_attrs_orig)
+		all_attrs[@manytomany].merge!("first_id_column" => "#{first_attrs_orig['singular_name']}_id")
+		all_attrs[@manytomany].merge_with_prefix!("second", second_attrs_orig)
+		all_attrs[@manytomany].merge!("second_id_column" => "#{second_attrs_orig['singular_name']}_id")
+
+  	all_attrs[@models.first].merge_with_prefix!("other", second_attrs_orig)
+  	all_attrs[@models.last].merge_with_prefix!("other", first_attrs_orig)
+  	@models.each {|model| all_attrs[model].merge_with_prefix!("manytomany", manytomany_attrs_orig)}
+ 
+  end
+
+  def manifest
+    record do |m|
+			load_attrs(@models.first)
+
+
+    	@models.each do |model_name|
+				attrs = load_attrs(model_name)
+
+				# Check for class naming collisions.
+				m.class_collisions class_path, class_name, "#{class_name}Test"
+
+  			# Model, test, and fixture directories.
+  			m.directory File.join('app/models', class_path)
+  			m.directory File.join('test/unit', class_path)
+  			m.directory File.join('test/fixtures', class_path)
+        m.directory File.join('app/controllers', controller_class_path)
+        m.directory File.join('app/helpers', controller_class_path)
+        m.directory File.join('app/views/layouts', controller_class_path)
+        m.directory File.join('app/views', controller_class_path, controller_file_name)
+        m.directory File.join('test/functional', controller_class_path)
+        m.directory File.join('public/stylesheets')
+
+				# Model class, unit test, and fixtures.
+				m.template 'model.rb',      File.join('app/models', class_path, "#{file_name}.rb"), :assigns => attrs
+				m.template 'unit_test.rb',  File.join('test/unit', class_path, "#{file_name}_test.rb"), :assigns => attrs
+				m.template 'fixtures.yml',  File.join('test/fixtures', class_path, "#{table_name}.yml"), :assigns => attrs
+
+				unless options[:skip_migration]
+					m.migration_template 'migration.rb', 'db/migrate', :assigns => attrs.merge({
+						:migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+					}), :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+				end
+				
+        # Controller class, functional test, helper, and views.
+        m.template 'controller.rb',
+                    File.join('app/controllers',
+                              controller_class_path,
+                              "#{controller_file_name}_controller.rb"), 
+                    :assigns => attrs
+  
+        m.template 'functional_test.rb',
+                    File.join('test/functional',
+                              controller_class_path,
+                              "#{controller_file_name}_controller_test.rb"), 
+                    :assigns => attrs
+                    
+        # Scaffolded partials.
+        scaffold_partials.each do |name|
+          m.template "partial_#{name}.rhtml",
+                      File.join('app/views',
+                                controller_class_path,
+                                controller_file_name,
+                                "_#{name}.rhtml"), 
+                      :assigns => attrs
+        end
+    	end
+
+			attrs = load_attrs(@manytomany)
+
+			# Check for class naming collisions.
+			m.class_collisions class_path, class_name, "#{class_name}Test"
+
+			# Model, test, and fixture directories.
+			m.directory File.join('app/models', class_path)
+			m.directory File.join('test/unit', class_path)
+			m.directory File.join('test/fixtures', class_path)
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/helpers', controller_class_path)
+      m.directory File.join('app/views/layouts', controller_class_path)
+      m.directory File.join('app/views', controller_class_path, controller_file_name)
+      m.directory File.join('test/functional', controller_class_path)
+				
+		  # Model class, unit test, and fixtures.
+			m.template 'model_manytomany.rb',      File.join('app/models', class_path, "#{file_name}.rb"), :assigns => attrs
+			m.template 'unit_test_manytomany.rb',  File.join('test/unit', class_path, "#{file_name}_test.rb"), :assigns => attrs
+			m.template 'fixtures_manytomany.yml',  File.join('test/fixtures', class_path, "#{table_name}.yml"), :assigns => attrs
+
+			unless options[:skip_migration]
+        m.migration_template 'migration_manytomany.rb', 'db/migrate', 
+          :assigns => attrs.merge({:migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"}), 
+          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+			end
+
+      # Controller class, functional test, helper, and views.
+      m.template 'controller_manytomany.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb"), 
+                  :assigns => attrs
+      m.template 'functional_test_manytomany.rb',
+                  File.join('test/functional',
+                            controller_class_path,
+                            "#{controller_file_name}_controller_test.rb"), 
+                  :assigns => attrs
+
+      # Common templates for models and many-to-many model
+    	@models.concat([@manytomany]).each do |model_name|
+				attrs = load_attrs(model_name)
+
+        m.template 'helper.rb',
+                    File.join('app/helpers',
+                              controller_class_path,
+                              "#{controller_file_name}_helper.rb"), 
+                    :assigns => attrs
+                    
+        # Scaffolded views.
+        scaffold_views.each do |action|
+          m.template "view_#{action}.rhtml",
+                      File.join('app/views',
+                                controller_class_path,
+                                controller_file_name,
+                                "#{action}.rhtml"),
+                      :assigns => attrs.merge({ :action => action })
+        end
+        # Layout and stylesheet.
+        m.template 'layout.rhtml',
+                    File.join('app/views/layouts', 
+                              controller_class_path, 
+                              "#{controller_file_name}.rhtml"),
+                    :assigns => attrs
+        
+        m.template 'stylesheet.css',
+                    File.join('public/stylesheets', 
+                              controller_class_path, 
+                              "#{controller_file_name}.css"),
+                    :assigns => attrs
+      end
+    end
+  end
+
+protected
+  def banner
+    "Usage: #{$0} has_many_through ModelName1 ModelName2 [ManyToManyModelName]"
+  end
+
+  def scaffold_views
+    %w( index )
+  end
+
+  def scaffold_partials
+    %w( form )
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration",
+           "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+  end
+  
+end

data/templates/controller.rb

@@ -0,0 +1,116 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  
+  def index
+  end
+  
+  def new
+    @<%= singular_name %> = <%= class_name %>.new
+    @successful = true
+
+    respond_to do |type|
+      type.html do
+        if @successful
+          @options = { :action => "create" }
+          render :partial => "form", :layout => true
+        else 
+          redirect_to_main
+        end
+      end
+    end
+  end
+  
+  def create
+    begin
+      @<%= singular_name %> = <%= class_name %>.new(params[:<%= singular_name %>])
+      @successful = @<%= singular_name %>.save
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    flash[:info] = "<%= class_name %> created" if @successful
+    
+    respond_to do |type|
+      type.html do
+        if not @successful
+          @options = { :action => "create" }
+          render :partial => "form", :layout => true
+        else 
+          redirect_to_main
+        end
+      end
+    end
+  end
+
+  def edit
+    begin
+      @<%= singular_name %> = <%= class_name %>.find(params[:id])
+      @successful = !@<%= singular_name %>.nil?
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    respond_to do |type|
+      type.html do
+        if @successful
+          @options = { :action => "update", :id => params[:id] }
+          render :partial => "form", :layout => true
+        else 
+          redirect_to_main
+        end
+      end
+    end
+  end
+
+  def update
+    begin
+      @<%= singular_name %> = <%= class_name %>.find(params[:id])
+      @successful = @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    flash[:info] = "<%= class_name %> updated" if @successful
+    
+    respond_to do |type|
+      type.html do
+        if not @successful
+          @options = { :action => "update", :id => params[:id] }
+          render :partial => "form", :layout => true
+        else 
+          redirect_to_main
+        end
+      end
+    end
+  end
+
+  def destroy
+    begin
+      @successful = <%= class_name %>.find(params[:id]).destroy
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    flash[:info] = "<%= class_name %> deleted" if @successful
+    
+    respond_to do |type|
+      type.html {return redirect_to_main}
+    end
+  end
+  
+  def cancel
+    @successful = true
+    
+    respond_to do |type|
+      type.html {return redirect_to_main}
+    end
+  end
+
+protected
+  def redirect_to_main
+    redirect_to common_redirection
+  end
+  
+  def common_redirection
+    { :action => 'index' }
+  end
+end