Module: FriendlyId::FinderMethods

Included in:
History::FinderMethods
Defined in:
lib/friendly_id/finder_methods.rb

Instance Method Summary collapse

Instance Method Details

#exists?(conditions = :none) ⇒ Boolean

Returns true if a record with the given id exists.

Returns:

  • (Boolean) 


40
41
42
43
44
 
# File 'lib/friendly_id/finder_methods.rb', line 40

def exists?(conditions = :none)
  return super if conditions.unfriendly_id?
  return true if exists_by_friendly_id?(conditions)
  super
end

#exists_by_friendly_id?(id) ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/friendly_id/finder_methods.rb', line 53

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

#find(*args, allow_nil: false) ⇒ Object

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’.

Use allow_nil: true if you’d like the finder to return nil instead of raising ActivRecord::RecordNotFound

### Example

MyModel.friendly.find("bad-slug")
#=> raise ActiveRecord::RecordNotFound

MyModel.friendly.find("bad-slug", allow_nil: true)
#=> nil

Since FriendlyId 5.0, if the id is a nonnumeric 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.

Parameters:

  • allow_nil (Boolean) (defaults to: false) —

    (default: false)

Raises:

  • ActiveRecord::RecordNotFound



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/friendly_id/finder_methods.rb', line 28

def find(*args, allow_nil: false)
  id = args.first
  return super(*args) if args.count != 1 || id.unfriendly_id?
  first_by_friendly_id(id).tap { |result| return result unless result.nil? }
  return super(*args) if potential_primary_key?(id)

  raise_not_found_exception(id) unless allow_nil
rescue ActiveRecord::RecordNotFound => exception
  raise exception unless allow_nil
end

#find_by_friendly_id(id) ⇒ Object

Finds exclusively by the friendly id, completely bypassing original ‘find`.

Raises:

  • ActiveRecord::RecordNotFound



49
50
51
 
# File 'lib/friendly_id/finder_methods.rb', line 49

def find_by_friendly_id(id)
  first_by_friendly_id(id) or raise_not_found_exception(id)
end