Merge pull request #35781 from excid3/rich_text-field-generator

Add rich_text field to model generators

8 files changed, 81 insertions, 14 deletions

diff --git a/activerecord/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt b/activerecord/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt
index 5f7201cfe1..562543f981 100644
--- a/activerecord/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt
+++ b/activerecord/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt
@@ -6,7 +6,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Mi
       t.string :password_digest<%= attribute.inject_options %>
 <% elsif attribute.token? -%>
       t.string :<%= attribute.name %><%= attribute.inject_options %>
-<% else -%>
+<% elsif !attribute.virtual? -%>
       t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
 <% end -%>
 <% end -%>
diff --git a/activerecord/lib/rails/generators/active_record/migration/templates/migration.rb.tt b/activerecord/lib/rails/generators/active_record/migration/templates/migration.rb.tt
index 481c70201b..c07380bec9 100644
--- a/activerecord/lib/rails/generators/active_record/migration/templates/migration.rb.tt
+++ b/activerecord/lib/rails/generators/active_record/migration/templates/migration.rb.tt
@@ -7,7 +7,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Mi
   <%- elsif attribute.token? -%>
     add_column :<%= table_name %>, :<%= attribute.name %>, :string<%= attribute.inject_options %>
     add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
-  <%- else -%>
+  <%- elsif !attribute.virtual? -%>
     add_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
     <%- if attribute.has_index? -%>
     add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
@@ -21,7 +21,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Mi
     <%- attributes.each do |attribute| -%>
       <%- if attribute.reference? -%>
       t.references :<%= attribute.name %><%= attribute.inject_options %>
-      <%- else -%>
+      <%- elsif !attribute.virtual? -%>
       <%= '# ' unless attribute.has_index? -%>t.index <%= attribute.index_name %><%= attribute.inject_index_options %>
       <%- end -%>
     <%- end -%>
@@ -37,7 +37,9 @@ class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Mi
     <%- if attribute.has_index? -%>
     remove_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
     <%- end -%>
+    <%- if !attribute.virtual? %>
     remove_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
+    <%- end -%>
   <%- end -%>
 <%- end -%>
 <%- end -%>
diff --git a/activerecord/lib/rails/generators/active_record/model/templates/model.rb.tt b/activerecord/lib/rails/generators/active_record/model/templates/model.rb.tt
index 55dc65c8ad..cdd029735a 100644
--- a/activerecord/lib/rails/generators/active_record/model/templates/model.rb.tt
+++ b/activerecord/lib/rails/generators/active_record/model/templates/model.rb.tt
@@ -3,6 +3,9 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% attributes.select(&:reference?).each do |attribute| -%>
   belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %><%= ', required: true' if attribute.required? %>
 <% end -%>
+<% attributes.select(&:rich_text?).each do |attribute| -%>
+  has_rich_text :<%= attribute.name %>
+<% end -%>
 <% attributes.select(&:token?).each do |attribute| -%>
   has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
 <% end -%>
diff --git a/railties/lib/rails/generators/generated_attribute.rb b/railties/lib/rails/generators/generated_attribute.rb
index a8f7729fd3..e801ab0c90 100644
--- a/railties/lib/rails/generators/generated_attribute.rb
+++ b/railties/lib/rails/generators/generated_attribute.rb
@@ -74,6 +74,7 @@ module Rails
                         when :datetime, :timestamp then :datetime_select
                         when :date                 then :date_select
                         when :text                 then :text_area
+                        when :rich_text            then :rich_text_area
                         when :boolean              then :check_box
                         else
                           :text_field
@@ -82,15 +83,15 @@ module Rails
 
       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 name == "type" ? "" : "MyString"
-                     when :text                        then "MyText"
-                     when :boolean                     then false
-                     when :references, :belongs_to     then nil
+                     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 name == "type" ? "" : "MyString"
+                     when :text                                then "MyText"
+                     when :boolean                             then false
+                     when :references, :belongs_to, :rich_text then nil
                      else
                        ""
         end
@@ -152,6 +153,14 @@ module Rails
         type == :token
       end
 
+      def rich_text?
+        type == :rich_text
+      end
+
+      def virtual?
+        rich_text?
+      end
+
       def inject_options
         (+"").tap { |s| options_for_migration.each { |k, v| s << ", #{k}: #{v.inspect}" } }
       end
diff --git a/railties/lib/rails/generators/test_unit/model/templates/fixtures.yml.tt b/railties/lib/rails/generators/test_unit/model/templates/fixtures.yml.tt
index ee4ae47727..0fd9f305d7 100644
--- a/railties/lib/rails/generators/test_unit/model/templates/fixtures.yml.tt
+++ b/railties/lib/rails/generators/test_unit/model/templates/fixtures.yml.tt
@@ -7,7 +7,7 @@
   password_digest: <%%= BCrypt::Password.create('secret') %>
   <%- elsif attribute.reference? -%>
   <%= yaml_key_value(attribute.column_name.sub(/_id$/, ''), attribute.default || name) %>
-  <%- else -%>
+  <%- elsif !attribute.virtual? -%>
   <%= yaml_key_value(attribute.column_name, attribute.default) %>
   <%- end -%>
   <%- if attribute.polymorphic? -%>
diff --git a/railties/test/generators/generated_attribute_test.rb b/railties/test/generators/generated_attribute_test.rb
index 772b4f6f0d..7a1a2ee96b 100644
--- a/railties/test/generators/generated_attribute_test.rb
+++ b/railties/test/generators/generated_attribute_test.rb
@@ -38,6 +38,10 @@ class GeneratedAttributeTest < Rails::Generators::TestCase
     assert_field_type :boolean, :check_box
   end
 
+  def test_field_type_returns_rich_text_area
+    assert_field_type :rich_text, :rich_text_area
+  end
+
   def test_field_type_with_unknown_type_returns_text_field
     %w(foo bar baz).each do |attribute_type|
       assert_field_type attribute_type, :text_field
@@ -84,7 +88,7 @@ class GeneratedAttributeTest < Rails::Generators::TestCase
   end
 
   def test_default_value_is_nil
-    %w(references belongs_to).each do |attribute_type|
+    %w(references belongs_to rich_text).each do |attribute_type|
       assert_field_default_value attribute_type, nil
     end
   end
diff --git a/railties/test/generators/migration_generator_test.rb b/railties/test/generators/migration_generator_test.rb
index acc5fc3b25..8a66956290 100644
--- a/railties/test/generators/migration_generator_test.rb
+++ b/railties/test/generators/migration_generator_test.rb
@@ -366,6 +366,38 @@ class MigrationGeneratorTest < Rails::Generators::TestCase
     Rails.application.config.paths["db/migrate"] = old_paths
   end
 
+  def test_add_migration_ignores_virtual_attributes
+    migration = "add_rich_text_content_to_messages"
+    run_generator [migration, "content:rich_text"]
+
+    assert_migration "db/migrate/#{migration}.rb" do |content|
+      assert_method :change, content do |change|
+        assert_no_match(/add_column :messages, :content, :rich_text/, change)
+      end
+    end
+  end
+
+  def test_create_table_migration_ignores_virtual_attributes
+    run_generator ["create_messages", "content:rich_text"]
+    assert_migration "db/migrate/create_messages.rb" do |content|
+      assert_method :change, content do |change|
+        assert_match(/create_table :messages/, change)
+        assert_no_match(/  t\.rich_text :content/, change)
+      end
+    end
+  end
+
+  def test_remove_migration_with_virtual_attributes
+    migration = "remove_content_from_messages"
+    run_generator [migration, "content:rich_text"]
+
+    assert_migration "db/migrate/#{migration}.rb" do |content|
+      assert_method :change, content do |change|
+        assert_no_match(/remove_column :messages, :content, :rich_text/, change)
+      end
+    end
+  end
+
   private
 
     def with_singular_table_name
diff --git a/railties/test/generators/model_generator_test.rb b/railties/test/generators/model_generator_test.rb
index bdb430369e..0eb8e9d270 100644
--- a/railties/test/generators/model_generator_test.rb
+++ b/railties/test/generators/model_generator_test.rb
@@ -499,6 +499,23 @@ class ModelGeneratorTest < Rails::Generators::TestCase
     assert_file "app/models/user.rb", expected_file
   end
 
+  def test_model_with_rich_text_attribute_adds_has_rich_text
+    run_generator ["message", "content:rich_text"]
+    expected_file = <<~FILE
+      class Message < ApplicationRecord
+        has_rich_text :content
+      end
+    FILE
+    assert_file "app/models/message.rb", expected_file
+  end
+
+  def test_skip_virtual_fields_in_fixtures
+    run_generator ["message", "content:rich_text"]
+
+    assert_generated_fixture("test/fixtures/messages.yml",
+                             "one" => nil, "two" => nil)
+  end
+
   private
     def assert_generated_fixture(path, parsed_contents)
       fixture_file = File.new File.expand_path(path, destination_root)