Skip to content
This repository
tree: f81c6bc040
Fetching contributors…

Cannot retrieve contributors at this time

file 60 lines (52 sloc) 1.893 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
module ActiveRecord
  module AttributeMethods
    module PrimaryKey
      extend ActiveSupport::Concern

      module ClassMethods
        # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
        # primary_key_prefix_type setting, though.
        def primary_key
          reset_primary_key
        end

        def reset_primary_key #:nodoc:
          key = get_primary_key(base_class.name)
          set_primary_key(key)
          key
        end

        def get_primary_key(base_name) #:nodoc:
          key = 'id'
          case primary_key_prefix_type
            when :table_name
              key = base_name.to_s.foreign_key(false)
            when :table_name_with_underscore
              key = base_name.to_s.foreign_key
          end
          key
        end

        # Sets the name of the primary key column to use to the given value,
        # or (if the value is nil or false) to the value returned by the given
        # block.
        #
        # class Project < ActiveRecord::Base
        # set_primary_key "sysid"
        # end
        def set_primary_key(value = nil, &block)
          define_attr_method :primary_key, value, &block
        end
        alias :primary_key= :set_primary_key
      end

      module InstanceMethods

        # Returns this record's primary key value wrapped in an Array
        # or nil if the record is a new_record?
        # This is done to comply with the AMo interface that expects
        # every AMo compliant object to respond_to?(:to_key) and return
        # an Enumerable object from that call, or nil if new_record?
        # This method also takes custom primary keys specified via
        # the +set_primary_key+ into account.
        def to_key
          new_record? ? nil : [ self.send(self.class.primary_key) ]
        end

      end

    end
  end
end
Something went wrong with that request. Please try again.