railties 3.0.0.beta

data/lib/rails/generators/generated_attribute.rb

@@ -0,0 +1,48 @@
+module Rails
+  module Generators
+    class GeneratedAttribute
+      attr_accessor :name, :type
+
+      def initialize(name, type)
+        @name, @type = name, type.to_sym
+      end
+
+      def field_type
+        @field_type ||= case type
+          when :integer, :float, :decimal   then :text_field
+          when :datetime, :timestamp, :time then :datetime_select
+          when :date                        then :date_select
+          when :string                      then :text_field
+          when :text                        then :text_area
+          when :boolean                     then :check_box
+          else
+            :text_field
+        end
+      end
+
+      def default
+        @default ||= case type
+          when :integer                     then 1
+          when :float                       then 1.5
+          when :decimal                     then "9.99"
+          when :datetime, :timestamp, :time then Time.now.to_s(:db)
+          when :date                        then Date.today.to_s(:db)
+          when :string                      then "MyString"
+          when :text                        then "MyText"
+          when :boolean                     then false
+          when :references, :belongs_to     then nil
+          else
+            ""
+        end
+      end
+
+      def human_name
+        name.to_s.humanize
+      end
+
+      def reference?
+        [ :references, :belongs_to ].include?(self.type)
+      end
+    end
+  end
+end

data/lib/rails/generators/migration.rb

@@ -0,0 +1,64 @@
+module Rails
+  module Generators
+    # Holds common methods for migrations. It assumes that migrations has the
+    # [0-9]*_name format and can be used by another frameworks (like Sequel)
+    # just by implementing the next migration number method.
+    #
+    module Migration
+      attr_reader :migration_number, :migration_file_name, :migration_class_name
+
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def migration_lookup_at(dirname) #:nodoc:
+          Dir.glob("#{dirname}/[0-9]*_*.rb")
+        end
+
+        def migration_exists?(dirname, file_name) #:nodoc:
+          migration_lookup_at(dirname).grep(/\d+_#{file_name}.rb$/).first
+        end
+
+        def current_migration_number(dirname) #:nodoc:
+          migration_lookup_at(dirname).collect do |file|
+            File.basename(file).split("_").first.to_i
+          end.max.to_i
+        end
+
+        def next_migration_number(dirname) #:nodoc:
+          raise NotImplementedError
+        end
+      end
+
+      # Creates a migration template at the given destination. The difference
+      # to the default template method is that the migration number is appended
+      # to the destination file name.
+      #
+      # The migration number, migration file name, migration class name are
+      # available as instance variables in the template to be rendered.
+      #
+      # ==== Examples
+      #
+      #   migration_template "migration.rb", "db/migrate/add_foo_to_bar.rb"
+      #
+      def migration_template(source, destination=nil, config={})
+        destination = File.expand_path(destination || source, self.destination_root)
+
+        migration_dir = File.dirname(destination)
+        @migration_number     = self.class.next_migration_number(migration_dir)
+        @migration_file_name  = File.basename(destination).sub(/\.rb$/, '')
+        @migration_class_name = @migration_file_name.camelize
+
+        destination = self.class.migration_exists?(migration_dir, @migration_file_name)
+
+        if behavior == :invoke
+          raise Error, "Another migration is already named #{@migration_file_name}: #{destination}" if destination
+          destination = File.join(migration_dir, "#{@migration_number}_#{@migration_file_name}.rb")
+        end
+
+        template(source, destination, config)
+      end
+    end
+  end
+end

data/lib/rails/generators/named_base.rb

@@ -0,0 +1,95 @@
+require 'rails/generators/base'
+require 'rails/generators/generated_attribute'
+
+module Rails
+  module Generators
+    class NamedBase < Base
+      argument :name, :type => :string
+
+      def initialize(args, *options) #:nodoc:
+        # Unfreeze name in case it's given as a frozen string
+        args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
+        super
+        assign_names!(self.name)
+        parse_attributes! if respond_to?(:attributes)
+      end
+
+      protected
+
+        attr_reader :class_path, :file_name
+        alias :singular_name :file_name
+
+        def file_path
+          @file_path ||= (class_path + [file_name]).join('/')
+        end
+
+        def class_name
+          @class_name ||= (class_path + [file_name]).map!{ |m| m.camelize }.join('::')
+        end
+
+        def plural_name
+          @plural_name ||= singular_name.pluralize
+        end
+
+        def i18n_scope
+          @i18n_scope ||= file_path.gsub('/', '.')
+        end
+
+        def table_name
+          @table_name ||= begin
+            base = pluralize_table_names? ? plural_name : singular_name
+            (class_path + [base]).join('_')
+          end
+        end
+
+        # Tries to retrieve the application name or simple return application.
+        def application_name
+          if defined?(Rails) && Rails.application
+            Rails.application.class.name.split('::').first.underscore
+          else
+            "application"
+          end
+        end
+
+        def assign_names!(name) #:nodoc:
+          @class_path = name.include?('/') ? name.split('/') : name.split('::')
+          @class_path.map! { |m| m.underscore }
+          @file_name = @class_path.pop
+        end
+
+        # Convert attributes array into GeneratedAttribute objects.
+        def parse_attributes! #:nodoc:
+          self.attributes = (attributes || []).map do |key_value|
+            name, type = key_value.split(':')
+            Rails::Generators::GeneratedAttribute.new(name, type)
+          end
+        end
+
+        def pluralize_table_names?
+          !defined?(ActiveRecord::Base) || ActiveRecord::Base.pluralize_table_names
+        end
+
+        # Add a class collisions name to be checked on class initialization. You
+        # can supply a hash with a :prefix or :suffix to be tested.
+        #
+        # ==== Examples
+        #
+        #   check_class_collision :suffix => "Observer"
+        #
+        # If the generator is invoked with class name Admin, it will check for
+        # the presence of "AdminObserver".
+        #
+        def self.check_class_collision(options={})
+          define_method :check_class_collision do
+            name = if self.respond_to?(:controller_class_name) # for ScaffoldBase
+              controller_class_name
+            else
+              class_name
+            end
+
+            class_collisions "#{options[:prefix]}#{name}#{options[:suffix]}"
+          end
+        end
+    end
+  end
+end

data/lib/rails/generators/resource_helpers.rb

@@ -0,0 +1,80 @@
+require 'rails/generators/active_model'
+
+module Rails
+  module Generators
+    # Deal with controller names on scaffold and add some helpers to deal with
+    # ActiveModel.
+    #
+    module ResourceHelpers
+      mattr_accessor :skip_warn
+
+      def self.included(base) #:nodoc:
+        base.class_option :force_plural, :type => :boolean, :desc => "Forces the use of a plural ModelName"
+      end
+
+      # Set controller variables on initialization.
+      #
+      def initialize(*args) #:nodoc:
+        super
+
+        if name == name.pluralize && !options[:force_plural]
+          unless ResourceHelpers.skip_warn
+            say "Plural version of the model detected, using singularized version. Override with --force-plural."
+            ResourceHelpers.skip_warn = true
+          end
+          name.replace name.singularize
+          assign_names!(name)
+        end
+
+        @controller_name = name.pluralize
+      end
+
+      protected
+
+        attr_reader :controller_name
+
+        def controller_class_path
+          @class_path
+        end
+
+        def controller_file_name
+          @controller_file_name ||= file_name.pluralize
+        end
+
+        def controller_file_path
+          @controller_file_path ||= (controller_class_path + [controller_file_name]).join('/')
+        end
+
+        def controller_class_name
+          @controller_class_name ||= (controller_class_path + [controller_file_name]).map!{ |m| m.camelize }.join('::')
+        end
+
+        def controller_i18n_scope
+          @controller_i18n_scope ||= controller_file_path.gsub('/', '.')
+        end
+
+        # Loads the ORM::Generators::ActiveModel class. This class is responsable
+        # to tell scaffold entities how to generate an specific method for the
+        # ORM. Check Rails::Generators::ActiveModel for more information.
+        def orm_class
+          @orm_class ||= begin
+            # Raise an error if the class_option :orm was not defined.
+            unless self.class.class_options[:orm]
+              raise "You need to have :orm as class option to invoke orm_class and orm_instance"
+            end
+
+            begin
+              "#{options[:orm].to_s.classify}::Generators::ActiveModel".constantize
+            rescue NameError => e
+              Rails::Generators::ActiveModel
+            end
+          end
+        end
+
+        # Initialize ORM::Generators::ActiveModel to access instance methods.
+        def orm_instance(name=file_name)
+          @orm_instance ||= @orm_class.new(name)
+        end
+    end
+  end
+end

data/lib/rails/generators/test_case.rb

@@ -0,0 +1,239 @@
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'rails/generators'
+require 'fileutils'
+
+module Rails
+  module Generators
+    # Disable color in output. Easier to debug.
+    no_color!
+
+    # This class provides a TestCase for testing generators. To setup, you need
+    # just to configure the destination and set which generator is being tested:
+    #
+    #   class AppGeneratorTest < Rails::Generators::TestCase
+    #     tests AppGenerator
+    #     destination File.expand_path("../tmp", File.dirname(__FILE__))
+    #   end
+    #
+    # If you want to ensure your destination root is clean before running each test,
+    # you can set a setup callback:
+    #
+    #   class AppGeneratorTest < Rails::Generators::TestCase
+    #     tests AppGenerator
+    #     destination File.expand_path("../tmp", File.dirname(__FILE__))
+    #     setup :prepare_destination
+    #   end
+    #
+    class TestCase < ActiveSupport::TestCase
+      include FileUtils
+
+      class_attribute :destination_root, :current_path, :generator_class, :default_arguments
+      delegate :destination_root, :current_path, :generator_class, :default_arguments, :to => :'self.class'
+
+      # Generators frequently change the current path using +FileUtils.cd+.
+      # So we need to store the path at file load and revert back to it after each test.
+      self.current_path = File.expand_path(Dir.pwd)
+      self.default_arguments = []
+
+      setup :destination_root_is_set?, :ensure_current_path
+      teardown :ensure_current_path
+
+      # Sets which generator should be tested:
+      #
+      #   tests AppGenerator
+      #
+      def self.tests(klass)
+        self.generator_class = klass
+      end
+
+      # Sets default arguments on generator invocation. This can be overwritten when
+      # invoking it.
+      #
+      #   arguments %w(app_name --skip-activerecord)
+      #
+      def self.arguments(array)
+        self.default_arguments = array
+      end
+
+      # Sets the destination of generator files:
+      #
+      #   destination File.expand_path("../tmp", File.dirname(__FILE__))
+      #
+      def self.destination(path)
+        self.destination_root = path
+      end
+
+      # Captures the given stream and returns it:
+      #
+      #   stream = capture(:stdout){ puts "Cool" }
+      #   stream #=> "Cool\n"
+      #
+      def capture(stream)
+        begin
+          stream = stream.to_s
+          eval "$#{stream} = StringIO.new"
+          yield
+          result = eval("$#{stream}").string
+        ensure
+          eval("$#{stream} = #{stream.upcase}")
+        end
+
+        result
+      end
+      alias :silence :capture
+
+      # Asserts a given file exists. You need to supply an absolute path or a path relative
+      # to the configured destination:
+      #
+      #   assert_file "config/environment.rb"
+      #
+      # You can also give extra arguments. If the argument is a regexp, it will check if the
+      # regular expression matches the given file content. If it's a string, it compares the
+      # file with the given string:
+      #
+      #   assert_file "config/environment.rb", /initialize/
+      #
+      # Finally, when a block is given, it yields the file content:
+      #
+      #   assert_file "app/controller/products_controller.rb" do |controller|
+      #     assert_instance_method :index, content do |index|
+      #       assert_match /Product\.all/, index
+      #     end
+      #   end
+      #
+      def assert_file(relative, *contents)
+        absolute = File.expand_path(relative, destination_root)
+        assert File.exists?(absolute), "Expected file #{relative.inspect} to exist, but does not"
+
+        read = File.read(absolute) if block_given? || !contents.empty?
+        yield read if block_given?
+
+        contents.each do |content|
+          case content
+            when String
+              assert_equal content, read
+            when Regexp
+              assert_match content, read
+          end
+        end
+      end
+      alias :assert_directory :assert_file
+
+      # Asserts a given file does not exist. You need to supply an absolute path or a
+      # path relative to the configured destination:
+      #
+      #   assert_no_file "config/random.rb"
+      #
+      def assert_no_file(relative)
+        absolute = File.expand_path(relative, destination_root)
+        assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does"
+      end
+      alias :assert_no_directory :assert_no_file
+
+      # Asserts a given file does not exist. You need to supply an absolute path or a
+      # path relative to the configured destination:
+      #
+      #   assert_migration "db/migrate/create_products.rb"
+      #
+      # This method manipulates the given path and tries to find any migration which
+      # matches the migration name. For example, the call above is converted to:
+      #
+      #   assert_file "db/migrate/003_create_products.rb"
+      #
+      # Consequently, assert_migration accepts the same arguments has assert_file.
+      #
+      def assert_migration(relative, *contents, &block)
+        file_name = migration_file_name(relative)
+        assert file_name, "Expected migration #{relative} to exist, but was not found"
+        assert_file file_name, *contents, &block
+      end
+
+      # Asserts a given migration does not exist. You need to supply an absolute path or a
+      # path relative to the configured destination:
+      #
+      #   assert_no_file "config/random.rb"
+      #
+      def assert_no_migration(relative)
+        file_name = migration_file_name(relative)
+        assert_nil file_name, "Expected migration #{relative} to not exist, but found #{file_name}"
+      end
+
+      # Asserts the given class method exists in the given content. This method does not detect
+      # class methods inside (class << self), only class methods which starts with "self.".
+      # When a block is given, it yields the content of the method.
+      #
+      #   assert_migration "db/migrate/create_products.rb" do |migration|
+      #     assert_class_method :up, migration do |up|
+      #       assert_match /create_table/, up
+      #     end
+      #   end
+      #
+      def assert_class_method(method, content, &block)
+        assert_instance_method "self.#{method}", content, &block
+      end
+
+      # Asserts the given method exists in the given content. When a block is given,
+      # it yields the content of the method.
+      #
+      #   assert_file "app/controller/products_controller.rb" do |controller|
+      #     assert_instance_method :index, content do |index|
+      #       assert_match /Product\.all/, index
+      #     end
+      #   end
+      #
+      def assert_instance_method(method, content)
+        assert content =~ /def #{method}(\(.+\))?(.*?)\n  end/m, "Expected to have method #{method}"
+        yield $2.strip if block_given?
+      end
+      alias :assert_method :assert_instance_method
+
+      # Runs the generator configured for this class. The first argument is an array like
+      # command line arguments:
+      #
+      #   class AppGeneratorTest < Rails::Generators::TestCase
+      #     tests AppGenerator
+      #     destination File.expand_path("../tmp", File.dirname(__FILE__))
+      #     teardown :cleanup_destination_root
+      #
+      #     test "database.yml is not created when skipping activerecord" do
+      #       run_generator %w(myapp --skip-activerecord)
+      #       assert_no_file "config/database.yml"
+      #     end
+      #   end
+      #
+      # You can provide a configuration hash as second argument. This method returns the output
+      # printed by the generator.
+      def run_generator(args=self.default_arguments, config={})
+        capture(:stdout) { self.generator_class.start(args, config.reverse_merge(:destination_root => destination_root)) }
+      end
+
+      # Instantiate the generator.
+      def generator(args=self.default_arguments, options={}, config={})
+        @generator ||= self.generator_class.new(args, options, config.reverse_merge(:destination_root => destination_root))
+      end
+
+      protected
+
+        def destination_root_is_set? #:nodoc:
+          raise "You need to configure your Rails::Generators::TestCase destination root." unless destination_root
+        end
+
+        def ensure_current_path #:nodoc:
+          cd current_path
+        end
+
+        def prepare_destination
+          rm_rf(destination_root)
+          mkdir_p(destination_root)
+        end
+
+        def migration_file_name(relative) #:nodoc:
+          absolute = File.expand_path(relative, destination_root)
+          dirname, file_name = File.dirname(absolute), File.basename(absolute).sub(/\.rb$/, '')
+          Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
+        end
+    end
+  end
+end