omg-activerecord 8.0.0.alpha1

data/lib/arel/visitors/visitor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module Visitors
+    class Visitor
+      def initialize
+        @dispatch = get_dispatch_cache
+      end
+
+      def accept(object, collector = nil)
+        visit object, collector
+      end
+
+      private
+        attr_reader :dispatch
+
+        def self.dispatch_cache
+          @dispatch_cache ||= Hash.new do |hash, klass|
+            hash[klass] = :"visit_#{(klass.name || "").gsub("::", "_")}"
+          end.compare_by_identity
+        end
+
+        def get_dispatch_cache
+          self.class.dispatch_cache
+        end
+
+        def visit(object, collector = nil)
+          dispatch_method = dispatch[object.class]
+          if collector
+            send dispatch_method, object, collector
+          else
+            send dispatch_method, object
+          end
+        rescue NoMethodError => e
+          raise e if respond_to?(dispatch_method, true)
+          superklass = object.class.ancestors.find { |klass|
+            respond_to?(dispatch[klass], true)
+          }
+          raise(TypeError, "Cannot visit #{object.class}") unless superklass
+          dispatch[object.class] = dispatch[superklass]
+          retry
+        end
+    end
+  end
+end

data/lib/arel/visitors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "arel/visitors/visitor"
+require "arel/visitors/to_sql"
+require "arel/visitors/sqlite"
+require "arel/visitors/postgresql"
+require "arel/visitors/mysql"
+require "arel/visitors/dot"
+
+module Arel # :nodoc: all
+  module Visitors
+  end
+end

data/lib/arel/window_predications.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Arel # :nodoc: all
+  module WindowPredications
+    def over(expr = nil)
+      Nodes::Over.new(self, expr)
+    end
+  end
+end

data/lib/arel.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "arel/errors"
+
+require "arel/crud"
+require "arel/factory_methods"
+
+require "arel/expressions"
+require "arel/predications"
+require "arel/filter_predications"
+require "arel/window_predications"
+require "arel/math"
+require "arel/alias_predication"
+require "arel/order_predications"
+require "arel/table"
+require "arel/attributes/attribute"
+
+require "arel/visitors"
+require "arel/collectors/sql_string"
+
+require "arel/tree_manager"
+require "arel/insert_manager"
+require "arel/select_manager"
+require "arel/update_manager"
+require "arel/delete_manager"
+require "arel/nodes"
+
+module Arel
+  VERSION = "10.0.0"
+
+  # Wrap a known-safe SQL string for passing to query methods, e.g.
+  #
+  #   Post.order(Arel.sql("REPLACE(title, 'misc', 'zzzz') asc")).pluck(:id)
+  #
+  # Great caution should be taken to avoid SQL injection vulnerabilities.
+  # This method should not be used with unsafe values such as request
+  # parameters or model attributes.
+  #
+  # Take a look at the {security guide}[https://guides.rubyonrails.org/security.html#sql-injection]
+  # for more information.
+  #
+  # To construct a more complex query fragment, including the possible
+  # use of user-provided values, the +sql_string+ may contain <tt>?</tt> and
+  # +:key+ placeholders, corresponding to the additional arguments. Note
+  # that this behavior only applies when bind value parameters are
+  # supplied in the call; without them, the placeholder tokens have no
+  # special meaning, and will be passed through to the query as-is.
+  #
+  # The +:retryable+ option can be used to mark the SQL as safe to retry.
+  # Use this option only if the SQL is idempotent, as it could be executed
+  # more than once.
+  def self.sql(sql_string, *positional_binds, retryable: false, **named_binds)
+    if positional_binds.empty? && named_binds.empty?
+      Arel::Nodes::SqlLiteral.new(sql_string, retryable: retryable)
+    else
+      Arel::Nodes::BoundSqlLiteral.new sql_string, positional_binds, named_binds
+    end
+  end
+
+  def self.star # :nodoc:
+    sql("*", retryable: true)
+  end
+
+  def self.arel_node?(value) # :nodoc:
+    value.is_a?(Arel::Nodes::Node) || value.is_a?(Arel::Attribute) || value.is_a?(Arel::Nodes::SqlLiteral)
+  end
+
+  def self.fetch_attribute(value, &block) # :nodoc:
+    unless String === value
+      value.fetch_attribute(&block)
+    end
+  end
+end

data/lib/rails/generators/active_record/application_record/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates an `ApplicationRecord` base class for other models to inherit from.
+
+Example:
+    `bin/rails generate application_record`
+
+    This generates the base class. A test is not generated because no
+    behaviour is included in `ApplicationRecord` by default.

data/lib/rails/generators/active_record/application_record/application_record_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module ActiveRecord
+  module Generators # :nodoc:
+    class ApplicationRecordGenerator < ::Rails::Generators::Base # :nodoc:
+      source_root File.expand_path("templates", __dir__)
+
+      # FIXME: Change this file to a symlink once RubyGems 2.5.0 is required.
+      def create_application_record
+        template "application_record.rb", application_record_file_name
+      end
+
+      private
+        def application_record_file_name
+          @application_record_file_name ||=
+            if namespaced?
+              "app/models/#{namespaced_path}/application_record.rb"
+            else
+              "app/models/application_record.rb"
+            end
+        end
+    end
+  end
+end

data/lib/rails/generators/active_record/application_record/templates/application_record.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end
+<% end -%>

data/lib/rails/generators/active_record/migration/migration_generator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module ActiveRecord
+  module Generators # :nodoc:
+    class MigrationGenerator < Base # :nodoc:
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+      class_option :timestamps, type: :boolean
+      class_option :primary_key_type, type: :string, desc: "The type for primary key"
+      class_option :database, type: :string, aliases: %i(--db), desc: "The database for your migration. By default, the current environment's primary database is used."
+
+      def create_migration_file
+        set_local_assigns!
+        validate_file_name!
+        migration_template @migration_template, File.join(db_migrate_path, "#{file_name}.rb")
+      end
+
+      private
+        attr_reader :migration_action, :join_tables
+
+        # Sets the default migration template that is being used for the generation of the migration.
+        # Depending on command line arguments, the migration template and the table name instance
+        # variables are set up.
+        def set_local_assigns!
+          @migration_template = "migration.rb"
+          case file_name
+          when /^(add)_.*_to_(.*)/, /^(remove)_.*?_from_(.*)/
+            @migration_action = $1
+            @table_name       = normalize_table_name($2)
+          when /join_table/
+            if attributes.length == 2
+              @migration_action = "join"
+              @join_tables      = pluralize_table_names? ? attributes.map(&:plural_name) : attributes.map(&:singular_name)
+
+              set_index_names
+            end
+          when /^create_(.+)/
+            @table_name = normalize_table_name($1)
+            @migration_template = "create_table_migration.rb"
+          end
+        end
+
+        def set_index_names
+          attributes.each_with_index do |attr, i|
+            attr.index_name = [attr, attributes[i - 1]].map { |a| index_name_for(a) }
+          end
+        end
+
+        def index_name_for(attribute)
+          if attribute.foreign_key?
+            attribute.name
+          else
+            attribute.name.singularize.foreign_key
+          end.to_sym
+        end
+
+        def attributes_with_index
+          attributes.select { |a| !a.reference? && a.has_index? }
+        end
+
+        # A migration file name can only contain underscores (_), lowercase characters,
+        # and numbers 0-9. Any other file name will raise an IllegalMigrationNameError.
+        def validate_file_name!
+          unless /^[_a-z0-9]+$/.match?(file_name)
+            raise IllegalMigrationNameError.new(file_name)
+          end
+        end
+
+        def normalize_table_name(_table_name)
+          pluralize_table_names? ? _table_name.pluralize : _table_name.singularize
+        end
+    end
+  end
+end

data/lib/rails/generators/active_record/migration/templates/create_table_migration.rb.tt

@@ -0,0 +1,29 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<% elsif attribute.token? -%>
+      t.string :<%= attribute.name %><%= attribute.inject_options %>
+<% elsif attribute.reference? -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %><%= foreign_key_type %>
+<% elsif !attribute.virtual? -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+<% unless attributes.empty? -%>
+
+<% end -%>
+<% if options[:timestamps] -%>
+      t.timestamps
+<% end -%>
+    end
+<% attributes.select(&:token?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/rails/generators/active_record/migration/templates/migration.rb.tt

@@ -0,0 +1,48 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+<%- if migration_action == 'add' -%>
+  def change
+<% attributes.each do |attribute| -%>
+  <%- if attribute.reference? -%>
+    add_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %><%= foreign_key_type %>
+  <%- 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
+  <%- 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 %>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>
+  end
+<%- elsif migration_action == 'join' -%>
+  def change
+    create_join_table :<%= join_tables.first %>, :<%= join_tables.second %> do |t|
+    <%- attributes.each do |attribute| -%>
+      <%- if attribute.reference? -%>
+      t.references :<%= attribute.name %><%= attribute.inject_options %><%= foreign_key_type %>
+      <%- elsif !attribute.virtual? -%>
+      <%= '# ' unless attribute.has_index? -%>t.index <%= attribute.index_name %><%= attribute.inject_index_options %>
+      <%- end -%>
+    <%- end -%>
+    end
+  end
+<%- else -%>
+  def change
+<% attributes.each do |attribute| -%>
+<%- if migration_action -%>
+  <%- if attribute.reference? -%>
+    remove_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %><%= foreign_key_type %>
+  <%- else -%>
+    <%- 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 -%>
+  end
+<%- end -%>
+end

data/lib/rails/generators/active_record/migration.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators/migration"
+
+module ActiveRecord
+  module Generators # :nodoc:
+    module Migration
+      extend ActiveSupport::Concern
+      include Rails::Generators::Migration
+
+      module ClassMethods
+        # Implement the required interface for Rails::Generators::Migration.
+        def next_migration_number(dirname)
+          next_migration_number = current_migration_number(dirname) + 1
+          ActiveRecord::Migration.next_migration_number(next_migration_number)
+        end
+      end
+
+      private
+        def primary_key_type
+          key_type = options[:primary_key_type]
+          ", id: :#{key_type}" if key_type
+        end
+
+        def foreign_key_type
+          key_type = options[:primary_key_type]
+          ", type: :#{key_type}" if key_type
+        end
+
+        def db_migrate_path
+          if defined?(Rails.application) && Rails.application
+            configured_migrate_path || default_migrate_path
+          else
+            "db/migrate"
+          end
+        end
+
+        def default_migrate_path
+          Rails.application.config.paths["db/migrate"].to_ary.first
+        end
+
+        def configured_migrate_path
+          return unless database = options[:database]
+
+          config = ActiveRecord::Base.configurations.configs_for(
+            env_name: Rails.env,
+            name: database
+          )
+
+          Array(config&.migrations_paths).first
+        end
+    end
+  end
+end

data/lib/rails/generators/active_record/model/USAGE

@@ -0,0 +1,113 @@
+Description:
+    Generates a new model. Pass the model name, either CamelCased or
+    under_scored, and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are field: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'.
+
+    As a special case, specifying 'password:digest' will generate a
+    password_digest field of string type, and configure your generated model and
+    tests for use with Active Model has_secure_password (assuming the default ORM
+    and test framework are being used).
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the model immediately.
+
+    This generator invokes your configured ORM and test framework, which
+    defaults to Active Record and TestUnit.
+
+    Finally, if --parent option is given, it's used as superclass of the
+    created model. This allows you create Single Table Inheritance models.
+
+    If you pass a namespaced model name (e.g. admin/account or Admin::Account)
+    then the generator will create a module with a table_name_prefix method
+    to prefix the model's table name with the module name (e.g. admin_accounts)
+
+Available field types:
+
+    Just after the field name you can specify a type like text or boolean.
+    It will generate the column with the associated SQL type. For instance:
+
+        `bin/rails generate model post title:string body:text`
+
+    will generate a title column with a varchar type and a body column with a text
+    type. If no type is specified the string type will be used by default.
+    You can use the following types:
+
+        integer
+        primary_key
+        decimal
+        float
+        boolean
+        binary
+        string
+        text
+        date
+        time
+        datetime
+
+    You can also consider `references` as a kind of type. For instance, if you run:
+
+        `bin/rails generate model photo title:string album:references`
+
+    It will generate an `album_id` column. You should generate these kinds of fields when
+    you will use a `belongs_to` association, for instance. `references` also supports
+    polymorphism, you can enable polymorphism like this:
+
+        `bin/rails generate model product supplier:references{polymorphic}`
+
+    For integer, string, text and binary fields, an integer in curly braces will
+    be set as the limit:
+
+        `bin/rails generate model user pseudo:string{30}`
+
+    For decimal, two integers separated by a comma in curly braces will be used
+    for precision and scale:
+
+        `bin/rails generate model product 'price:decimal{10,2}'`
+
+    You can add a `:uniq` or `:index` suffix for unique or standard indexes
+    respectively:
+
+        `bin/rails generate model user pseudo:string:uniq`
+        `bin/rails generate model user pseudo:string:index`
+
+    You can combine any single curly brace option with the index options:
+
+        `bin/rails generate model user username:string{30}:uniq`
+        `bin/rails generate model product supplier:references{polymorphic}:index`
+
+    If you require a `password_digest` string column for use with
+    has_secure_password, you can specify `password:digest`:
+
+        `bin/rails generate model user password:digest`
+
+    If you require a `token` string column for use with
+    has_secure_token, you can specify `auth_token:token`:
+
+        `bin/rails generate model user auth_token:token`
+
+Examples:
+    `bin/rails generate model account`
+
+        For Active Record and TestUnit it creates:
+
+            Model:      app/models/account.rb
+            Test:       test/models/account_test.rb
+            Fixtures:   test/fixtures/accounts.yml
+            Migration:  db/migrate/XXX_create_accounts.rb
+
+    `bin/rails generate model post title:string body:text published:boolean`
+
+        Creates a Post model with a string title, text body, and published flag.
+
+    `bin/rails generate model admin/account`
+
+        For Active Record and TestUnit it creates:
+
+            Module:     app/models/admin.rb
+            Model:      app/models/admin/account.rb
+            Test:       test/models/admin/account_test.rb
+            Fixtures:   test/fixtures/admin/accounts.yml
+            Migration:  db/migrate/XXX_create_admin_accounts.rb

data/lib/rails/generators/active_record/model/model_generator.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module ActiveRecord
+  module Generators # :nodoc:
+    class ModelGenerator < Base # :nodoc:
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+      check_class_collision
+
+      class_option :migration, type: :boolean
+      class_option :timestamps, type: :boolean
+      class_option :parent, type: :string, default: "ApplicationRecord", desc: "The parent class for the generated model"
+      class_option :indexes, type: :boolean, default: true, desc: "Add indexes for references and belongs_to columns"
+      class_option :primary_key_type, type: :string, desc: "The type for primary key"
+      class_option :database, type: :string, aliases: %i(--db), desc: "The database for your model's migration. By default, the current environment's primary database is used."
+
+      Rails::Generators.templates_path.each do |path|
+        source_paths << File.join(path, base_name, "migration")
+      end
+      source_paths << File.expand_path(File.join(base_name, "migration", "templates"), base_root)
+
+      # creates the migration file for the model.
+      def create_migration_file
+        return if skip_migration_creation?
+        attributes.each { |a| a.attr_options.delete(:index) if a.reference? && !a.has_index? } if options[:indexes] == false
+        migration_template "create_table_migration.rb", File.join(db_migrate_path, "create_#{table_name}.rb")
+      end
+
+      def create_model_file
+        generate_abstract_class if database && !custom_parent?
+        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template "module.rb", File.join("app/models", "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      hook_for :test_framework
+
+      private
+        # Skip creating migration file if:
+        #   - options parent is present and database option is not present
+        #   - migrations option is nil or false
+        def skip_migration_creation?
+          custom_parent? && !database || !migration
+        end
+
+        def attributes_with_index
+          attributes.select { |a| !a.reference? && a.has_index? }
+        end
+
+        # Used by the migration template to determine the parent name of the model
+        def parent_class_name
+          if custom_parent?
+            parent
+          elsif database
+            abstract_class_name
+          else
+            parent
+          end
+        end
+
+        def generate_abstract_class
+          path = File.join("app/models", "#{database.underscore}_record.rb")
+          return if File.exist?(path)
+
+          template "abstract_base_class.rb", path
+        end
+
+        def abstract_class_name
+          "#{database.camelize}Record"
+        end
+
+        def database
+          options[:database]
+        end
+
+        def parent
+          options[:parent]
+        end
+
+        def custom_parent?
+          parent != self.class.class_options[:parent].default
+        end
+
+        def migration
+          options[:migration]
+        end
+    end
+  end
+end

data/lib/rails/generators/active_record/model/templates/abstract_base_class.rb.tt

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+class <%= abstract_class_name %> < ApplicationRecord
+  self.abstract_class = true
+
+  connects_to database: { <%= ActiveRecord.writing_role %>: :<%= database -%> }
+end
+<% end -%>

data/lib/rails/generators/active_record/model/templates/model.rb.tt

@@ -0,0 +1,22 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>
+<% end -%>
+<% attributes.select(&:rich_text?).each do |attribute| -%>
+  has_rich_text :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachment?).each do |attribute| -%>
+  has_one_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachments?).each do |attribute| -%>
+  has_many_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+end
+<% end -%>

data/lib/rails/generators/active_record/model/templates/module.rb.tt

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join("::") %>
+  def self.table_name_prefix
+    "<%= namespaced? ? namespaced_class_path.join("_") : class_path.join("_") %>_"
+  end
+end
+<% end -%>

data/lib/rails/generators/active_record/multi_db/multi_db_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module ActiveRecord
+  module Generators # :nodoc:
+    class MultiDbGenerator < ::Rails::Generators::Base # :nodoc:
+      source_root File.expand_path("templates", __dir__)
+
+      def create_multi_db
+        filename = "multi_db.rb"
+        template filename, "config/initializers/#{filename}"
+      end
+    end
+  end
+end