fetty-generators 1.7.1 → 2.0.0

data/lib/generators/fetty/scaffold/USAGE

@@ -1,53 +1,3 @@
 Description:
-    Scaffolds an entire resource, from model and migration to controller and
-    views. The resource is ready to use as a starting point for your restful,
-    resource-oriented application. Tests or specs are also generated depending
-    on if you have a "spec" directory or not.
-
-    IMPORTANT: This generator uses the "title" helper method which is generated
-    by the fetty-layout generator. You may want to run that generator first.
-
-Usage:
-    Pass the name of the model, either CamelCased or under_scored, as the first
-    argument along with an optional list of attribute pairs and controller actions.
-
-    If no controller actions are specified, they will default to index, show,
-    new, create, edit, update, and destroy.
-
-    IMPORTANT: If no attribute pairs are specified, no model will be generated.
-    It will try to determine the attributes from an existing model.
-
-    Attribute pairs are column_name:sql_type arguments specifying the
-    model's attributes. Timestamps are added by default, so you don't have to
-    specify them by hand as 'created_at:datetime updated_at:datetime'.
-
-    For example, `fetty:scaffold post name:string content:text hidden:boolean`
-    gives you a model with those three attributes, a controller that handles
-    the create/show/update/destroy, forms to create and edit your posts, and
-    an index that lists them all, as well as a resources :posts
-    declaration in config/routes.rb.
-
-    Adding an "!" in the mix of arguments will invert the passed controller
-    actions. This will include all 7 controller actitons except the ones
-    mentioned. This option doesn't affect model attributes.
-
-Examples:
-    rails generate fetty:scaffold post
-
-        Will create a controller called "posts" it will contain all seven
-        CRUD actions along with the views. A model will NOT be created,
-        instead it will look for an existing model and use those attributes.
-        this command will also generate the views using simple-form, meta_search
-        and will_paginate in the index.html.erb/haml as a default.
-
-    rails generate fetty:scaffold post name:string content:text index new edit
-
-        Will create a Post model and migration file with the name and content
-        attributes. It will also create a controller with index, new, create,
-        edit, and update actions. Notice the create and update actions are
-        added automatically with new and edit.
-
-    rails generate fetty:scaffold post ! show new
-
-        Creates a posts controller (no model) with index, edit, update, and
-        destroy actions.
+	The fetty:scaffold generator creates a basic scaffolding
+	using many useful gems.

data/lib/generators/fetty/scaffold/scaffold_generator.rb

@@ -1,4 +1,6 @@
 require 'generators/fetty'
+require 'generators/scaffold'
+require 'rails/generators/active_record'
 require 'rails/generators/migration'
 require 'rails/generators/generated_attribute'
 
@@ -6,364 +8,129 @@ module Fetty
   module Generators
     class ScaffoldGenerator < Base
       include Rails::Generators::Migration
-      no_tasks { attr_accessor :scaffold_name, :model_attributes, :controller_actions }
-
+      include Fetty::Generators::Scaffold
+      
       argument :scaffold_name, :type => :string, :required => true, :banner => 'ModelName'
-      argument :args_for_c_m, :type => :array, :default => [], :banner => 'controller_actions and model:attributes'
-
-      class_option :skip_model, :desc => 'Don\'t generate a model or migration file.', :type => :boolean
-      class_option :skip_migration, :desc => 'Dont generate migration file for model.', :type => :boolean
-      class_option :skip_timestamps, :desc => 'Don\'t add timestamps to migration file.', :type => :boolean
-      class_option :skip_controller, :desc => 'Don\'t generate controller, helper, or views.', :type => :boolean
-      class_option :with_cancan_check, :desc => 'Generate your view with CanCan Checking abilities in every actions.', :type => :boolean, :default => true
-      class_option :invert, :desc => 'Generate all controller actions except these mentioned.', :type => :boolean
-      class_option :namespace_model, :desc => 'If the resource is namespaced, include the model in the namespace.', :type => :boolean
-      class_option :haml, :desc => 'Generate HAML views instead of ERB.', :type => :boolean
-	  
-      class_option :testunit, :desc => 'Use test/unit for test files.', :group => 'Test framework', :type => :boolean
-      class_option :rspec, :desc => 'Use RSpec for test files.', :group => 'Test framework', :type => :boolean
-      class_option :shoulda, :desc => 'Use shoulda for test files.', :group => 'Test framework', :type => :boolean
-
-      def initialize(*args, &block)
-        super
-
-        print_usage unless scaffold_name.underscore =~ /^[a-z][a-z0-9_\/]+$/
-
-        @controller_actions = []
-        @model_attributes = []
-        @skip_model = options.skip_model?
-        @namespace_model = options.namespace_model?
-        @invert_actions = options.invert?
-		
-        @paperclip_name = []
-        @tinymce_name = []
+      argument :attributes, :type => :array, :default => [], :banner => 'attribute:type'
+      
+      class_option :controller, :desc => 'Generate controller, helper, or views.', :type => :boolean, :default => true
+      class_option :model, :desc => "Generate a model or migration file.", :type => :boolean, :default => true
+      class_option :migration, :desc => "Generate migration file for model.", :type => :boolean, :default => true
+      class_option :timestamps, :desc => "Add timestamps to migration file.", :type => :boolean, :default => true
+      class_option :test, :desc => "Generate Test files, either test/unit or rspec", :type => :boolean, :default => true
+      
+      class_option :except, :desc => 'Generate all controller actions except these mentioned.', :type => :array, :default => []
+      
+      def generate_scaffold
+        print_usage unless scaffold_name.underscore =~ /^[a-z][a-z0-9_\/]+$/ && !attributes.empty?
+        print_usage unless attributes.drop_while { |arg| arg.include?(':') }.count == 0
         
-        args_for_c_m.each do |arg|
-          if arg == '!'
-            @invert_actions = true
-          elsif arg.include?(':')
-          	if arg.include?(':paperclip')
-          		@paperclip_name << arg.split(':').first
-    			@model_attributes << Rails::Generators::GeneratedAttribute.new("#{arg.split(':').first}_file_name", "string")
-    			@model_attributes << Rails::Generators::GeneratedAttribute.new("#{arg.split(':').first}_content_type", "string")
-    			@model_attributes << Rails::Generators::GeneratedAttribute.new("#{arg.split(':').first}_file_size", "integer")
-    			@model_attributes << Rails::Generators::GeneratedAttribute.new("#{arg.split(':').first}_updated_at", "datetime")
-    		elsif arg.include?(':tinymce')
-          		@tinymce_name << arg.split(':').first
-    			@model_attributes << Rails::Generators::GeneratedAttribute.new(arg.split(':').first, "text")
-      		else
-      			@model_attributes << Rails::Generators::GeneratedAttribute.new(*arg.split(':'))
-      		end
-          else
-            @controller_actions << arg
-            @controller_actions << 'create' if arg == 'new'
-            @controller_actions << 'update' if arg == 'edit'
-          end
-        end
-
-        @controller_actions.uniq!
-        @model_attributes.uniq!
+        @orm = using_mongoid? ? 'mongoid' : 'active_record'
         
-        if @invert_actions || @controller_actions.empty?
-          @controller_actions = all_actions - @controller_actions
-        end
-
-        if @model_attributes.empty?
-          @skip_model = true # skip model if no attributes
-          if model_exists?
-            model_columns_for_attributes.each do |column|
-              @model_attributes << Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+        setting_model_attributes
+        if options[:model]
+           generate_model
+           if options.migration? && !using_mongoid?
+              generate_migration
             end
-          else
-            @model_attributes << Rails::Generators::GeneratedAttribute.new('name', 'string')
-          end
-        end
-      end
-
-	  def create_migration
-        unless @skip_model || options.skip_migration?
-          migration_template 'migration.rb', "db/migrate/create_#{model_path.pluralize.gsub('/', '_')}.rb"
-          delete_paperclip_field_from_model_attributes
         end
-      end
-      
-      def create_model
-        unless @skip_model
-          template 'model.rb', "app/models/#{model_path}.rb"
-          if test_framework == :rspec
-            template "tests/rspec/model.rb", "spec/models/#{model_path}_spec.rb"
-            template 'fixtures.yml', "spec/fixtures/#{model_path.pluralize}.yml"
-          else
-            template "tests/#{test_framework}/model.rb", "test/unit/#{model_path}_test.rb"
-            template 'fixtures.yml', "test/fixtures/#{model_path.pluralize}.yml"
-          end
+        
+        if options.controller?
+           setting_controller_attributes
+           generate_controller
+           generate_helper
+           generate_views
+           generate_routes
         end
-      end
-
-      def create_controller
-        unless options.skip_controller?
-          template 'controller.rb', "app/controllers/#{plural_name}_controller.rb"
-
-          template 'helper.rb', "app/helpers/#{plural_name}_helper.rb"
-
-          controller_actions.each do |action|
-            if %w[index show new edit].include?(action) # Actions with templates
-              template "views/#{view_language}/#{action}.html.#{view_language}", "app/views/#{plural_name}/#{action}.html.#{view_language}"
-              if action == 'index'
-              	template "views/#{view_language}/_table.html.#{view_language}", "app/views/#{plural_name}/_table.html.#{view_language}"
-              	template "views/#{view_language}/index.js.#{view_language}", "app/views/#{plural_name}/index.js.#{view_language}"
-              end 
-            end
-          end
-
-          if form_partial?
-            template "views/#{view_language}/_form.html.#{view_language}", "app/views/#{plural_name}/_form.html.#{view_language}"
-          end
-
-          namespaces = plural_name.split('/')
-          resource = namespaces.pop
-          route namespaces.reverse.inject("resources :#{resource}") { |acc, namespace|
-            "namespace(:#{namespace}){ #{acc} }"
-          }
-
-          if test_framework == :rspec
-            template "tests/#{test_framework}/controller.rb", "spec/controllers/#{plural_name}_controller_spec.rb"
-          else
-            template "tests/#{test_framework}/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
-          end
+        
+        if options.test?
+          generate_test_unit if using_test_unit?
+          generate_specs if using_rspec?
         end
+        
+      rescue Exception => e
+         print_notes(e.message,"error",:red)
       end
-
-private
       
-      def delete_paperclip_field_from_model_attributes
-         unless @paperclip_name.empty?
-            @paperclip_name.each do |name| 
-               @model_attributes.delete_if do |a| 
-                  a.name == "#{name}_content_type" || a.name == "#{name}_updated_at" || a.name == "#{name}_file_size" 
-               end
-               @model_attributes.map do |a|
-                  if a.name == "#{name}_file_name"
-                     a.name = name
-                  end
-               end
-            end
-         end
-      end
-
-      def generate_action_links(action, object, link_text, link_path)
-         out = ""
-         out << "\t<% if can? :#{action}, #{object} %>\n" if options.with_cancan_check?
-         unless action == :destroy
-             out << "\t\t<%= link_to '#{link_text}', #{link_path} %>\n"
-         else
-             out << "\t\t<%= link_to '#{link_text}', #{link_path}, :confirm => 'Are you sure?', :method => :delete %>\n"
-         end
-         out << "\t<% end %>" if options.with_cancan_check?
-         out.html_safe
-      end
-
-      def form_partial?
-        actions? :new, :edit
-      end
-
-      def all_actions
-        %w[index show new create edit update destroy]
-      end
-
-      def action?(name)
-        controller_actions.include? name.to_s
-      end
-
-      def actions?(*names)
-        names.all? { |name| action? name }
-      end
-
-      def singular_table_name
-        scaffold_name.pluralize.singularize
-      end
-
-      def singular_name
-        scaffold_name.underscore
-      end
-
-      def plural_name
-        scaffold_name.underscore.pluralize
-      end
+private 
       
-      def table_name
-        if scaffold_name.include?('::') && @namespace_model
-          plural_name.gsub('/', '_')
-        end
-      end
-
-      def class_name
-        if @namespace_model
-          scaffold_name.camelize
-        else
-          scaffold_name.split('::').last.camelize
+      def generate_model
+        begin
+          template "models/#{@orm}/model.rb", model_name(:path)
+        rescue Exception => e
+          raise e
         end
       end
-
-      def model_path
-        class_name.underscore
-      end
-
-      def plural_class_name
-        plural_name.camelize
-      end
-
-      def instance_name
-        if @namespace_model
-          singular_name.gsub('/','_')
-        else
-          singular_name.split('/').last
+      
+      def generate_migration
+        begin
+          migration_template "models/#{@orm}/migration.rb", migration_name(:path)
+        rescue Exception => e
+          raise e
         end
       end
-
-      def instances_name
-        instance_name.pluralize
-      end
-
-      def controller_methods(dir_name)
-        controller_actions.map do |action|
-          read_template("#{dir_name}/#{action}.rb")
-        end.join("\n").strip
-      end
-
-      def render_form
-        if form_partial?
-          if options.haml?
-            "= render 'form'"
-          else
-            "<%= render 'form' %>"
-          end
-        else
-          read_template("views/#{view_language}/_form.html.#{view_language}")
+      
+      def generate_controller
+        begin
+          template "controllers/#{@orm}/controller.rb", controller_name(:path)
+        rescue Exception => e
+          raise e
         end
       end
-	  
-      def render_table
-         if options.haml?
-           "= render 'table'"
-         else
-           "<%= render 'table' %>"
-         end
-      end
       
-      def item_resource
-        scaffold_name.underscore.gsub('/','_')
-      end
-
-      def items_path
-        if action? :index
-          "#{item_resource.pluralize}_path"
-        else
-          "root_path"
+      def generate_helper
+        begin
+          template 'helpers/helper.rb', helper_name(:path)
+        rescue Exception => e
+          raise e
         end
       end
-
-      def item_path(options = {})
-        if action? :show
-          name = options[:instance_variable] ? "@#{instance_name}" : instance_name
-          if %w(new edit).include? options[:action].to_s
-            "#{options[:action].to_s}_#{item_resource}_path(#{name})"
-          else
-            if scaffold_name.include?('::') && !@namespace_model
-              namespace = singular_name.split('/')[0..-2]
-              "[ :#{namespace.join(', :')}, #{name} ]"
-            else
-              name
+      
+      def generate_views
+        begin
+          controller_actions.each do |action|
+            unless action == 'create' || action == 'update' || action == 'destroy'
+              template "views/#{action}.html.erb", "app/views/#{plural_name}/#{action}.html.erb"
+              if action == 'index'
+                template "views/index.js.erb", "app/views/#{plural_name}/index.js.erb"
+                template "views/_table.html.erb", "app/views/#{plural_name}/_table.html.erb"
+              end
             end
           end
-        else
-          items_path
-        end
-      end
-
-      def item_url
-        if action? :show
-          item_resource + '_url'
-        else
-          items_url
-        end
-      end
-
-      def items_url
-        if action? :index
-          item_resource.pluralize + '_url'
-        else
-          "root_url"
-        end
-      end
-
-      def item_path_for_spec(suffix = 'path')
-        if action? :show
-          "#{item_resource}_#{suffix}(assigns[:#{instance_name}])"
-        else
-          if suffix == 'path'
-            items_path
-          else
-            items_url
-          end
-        end
-      end
-
-      def item_path_for_test(suffix = 'path')
-        if action? :show
-          "#{item_resource}_#{suffix}(assigns(:#{instance_name}))"
-        else
-          if suffix == 'path'
-            items_path
-          else
-            items_url
+          
+          if actions? :new, :edit
+            template "views/_form.html.erb", "app/views/#{plural_name}/_form.html.erb"
           end
+        rescue Exception => e
+          raise e
         end
       end
-
-      def model_columns_for_attributes
-        class_name.constantize.columns.reject do |column|
-          column.name.to_s =~ /^(id|created_at|updated_at)$/
-        end
-      end
-
-      def view_language
-        options.haml? ? 'haml' : 'erb'
-      end
-
-      def test_framework
-        return @test_framework if defined?(@test_framework)
-        if options.testunit?
-          return @test_framework = :testunit
-        elsif options.rspec?
-          return @test_framework = :rspec
-        elsif options.shoulda?
-          return @test_framework = :shoulda
-        else
-          return @test_framework = default_test_framework
-        end
-      end
-
-      def default_test_framework
-        File.exist?(destination_path("spec")) ? :rspec : :testunit
-      end
-
-      def model_exists?
-        File.exist? destination_path("app/models/#{singular_name}.rb")
+      
+      def generate_test_unit
+        template "test/test_unit/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
+        template "test/test_unit/fixtures.yml", "test/fixtures/#{plural_name}.yml"
+        template "test/test_unit/model.rb", "test/unit/#{singular_name}_test.rb"
+        template "test/test_unit/helper.rb", "test/unit/helpers/#{plural_name}_helper_test.rb"
+      rescue Exception => e
+        raise e
       end
-
-      def read_template(relative_path)
-        ERB.new(File.read(find_in_source_paths(relative_path)), nil, '-').result(binding)
+      
+      def generate_specs
+        template "test/rspec/controller.rb", "spec/controllers/#{plural_name}_controller_spec.rb"
+        template "test/rspec/model.rb", "spec/models/#{singular_name}_spec.rb"
+        template "test/rspec/helper.rb", "spec/helpers/#{plural_name}_helper_test.rb"
+        template "test/rspec/request.rb", "spec/requests/#{singular_name}_spec.rb.rb"
+        template "test/rspec/routing.rb", "spec/routing/#{plural_name}_routing_spec.rb"
+        template "test/rspec/factories.rb", "spec/support/#{singular_name}_factories.rb"
+      rescue Exception => e
+        raise e
       end
-
+      
+      
       # FIXME: Should be proxied to ActiveRecord::Generators::Base
       # Implement the required interface for Rails::Generators::Migration.
       def self.next_migration_number(dirname) #:nodoc:
-        if ActiveRecord::Base.timestamped_migrations
-          Time.now.utc.strftime("%Y%m%d%H%M%S")
-        else
-          "%.3d" % (current_migration_number(dirname) + 1)
-        end
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
       end
     end
   end