Contents

module FriendlyId

  module FinderMethods

    # Finds a record using the given id.
    #
    # If the id is "unfriendly", it will call the original find method.
    # If the id is a numeric string like '123' it will first look for a friendly
    # id matching '123' and then fall back to looking for a record with the
    # numeric id '123'.
    #
    # Since FriendlyId 5.0, if the id is a numeric string like '123-foo' it
    # will *only* search by friendly id and not fall back to the regular find
    # method.
    #
    # If you want to search only by the friendly id, use {#find_by_friendly_id}.
    # @raise ActiveRecord::RecordNotFound
    def find(*args)
      id = args.first
      return super if args.count != 1 || id.unfriendly_id?
      first_by_friendly_id(id).tap {|result| return result unless result.nil?}
      return super if potential_primary_key?(id)
      raise ActiveRecord::RecordNotFound
    end

    # Returns true if a record with the given id exists.
    def exists?(conditions = :none)
      return super unless conditions.friendly_id?
      exists_by_friendly_id?(conditions)
    end

    # Finds exclusively by the friendly id, completely bypassing original
    # `find`.
    # @raise ActiveRecord::RecordNotFound
    def find_by_friendly_id(id)
      first_by_friendly_id(id) or raise ActiveRecord::RecordNotFound
    end

    def exists_by_friendly_id?(id)
      where(friendly_id_config.query_field => id).exists?
    end

    private

    def potential_primary_key?(id)
      case primary_key_type
      when :integer
        Integer(id, 10) rescue false
      when :uuid
        id.match /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
      else
        true
      end
    end

    def first_by_friendly_id(id)
      where(friendly_id_config.query_field => id).first
    end

  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
friendly_id-5.0.3	lib/friendly_id/finder_methods.rb
friendly_id-5.0.2	lib/friendly_id/finder_methods.rb
friendly_id-5.0.1	lib/friendly_id/finder_methods.rb
friendly_id-5.0.0	lib/friendly_id/finder_methods.rb
friendly_id-5.0.0.rc3	lib/friendly_id/finder_methods.rb
friendly_id-5.0.0.rc2	lib/friendly_id/finder_methods.rb