alancse-friendly_id 2.0.1

data/lib/friendly_id/sluggable_class_methods.rb

@@ -0,0 +1,103 @@
+module FriendlyId::SluggableClassMethods
+  
+  include FriendlyId::Helpers
+
+  def self.extended(base) #:nodoc:#
+
+    class << base
+      alias_method_chain :find_one, :friendly
+      alias_method_chain :find_some, :friendly
+      alias_method_chain :validate_find_options, :friendly
+    end
+
+  end
+
+  # Finds a single record using the friendly id, or the record's id.
+  def find_one_with_friendly(id_or_name, options) #:nodoc:#
+
+    scope = options.delete(:scope)
+    return find_one_without_friendly(id_or_name, options) if id_or_name.is_a?(Fixnum)
+
+    find_options = {:select => "#{self.table_name}.*"}
+    find_options[:joins] = :slugs unless options[:include] && [*options[:include]].flatten.include?(:slugs)
+
+    name, sequence = Slug.parse(id_or_name)
+
+    find_options[:conditions] = {
+      "#{Slug.table_name}.name"     => name,
+      "#{Slug.table_name}.scope"    => scope,
+      "#{Slug.table_name}.sequence" => sequence
+    }
+
+    result = with_scope(:find => find_options) { find_initial(options) }
+
+    if result
+      result.finder_slug_name = id_or_name
+    else
+      result = find_one_without_friendly id_or_name, options
+    end
+
+    result
+
+  end
+
+  # Finds multiple records using the friendly ids, or the records' ids.
+  def find_some_with_friendly(ids_and_names, options) #:nodoc:#
+
+    slugs, ids = get_slugs_and_ids(ids_and_names, options)
+    results = []
+
+    find_options = {:select => "#{self.table_name}.*"}
+    find_options[:joins] = :slugs unless options[:include] && [*options[:include]].flatten.include?(:slugs)
+    find_options[:conditions] = "#{quoted_table_name}.#{primary_key} IN (#{ids.empty? ? 'NULL' : ids.join(',')}) "
+    find_options[:conditions] << "OR slugs.id IN (#{slugs.to_s(:db)})"
+
+    results = with_scope(:find => find_options) { find_every(options) }
+
+    expected = expected_size(ids_and_names, options)
+    if results.size != expected
+      raise ActiveRecord::RecordNotFound, "Couldn't find all #{ name.pluralize } with IDs (#{ ids_and_names * ', ' }) AND #{ sanitize_sql options[:conditions] } (found #{ results.size } results, but was looking for #{ expected })"
+    end
+
+    assign_finder_slugs(slugs, results)
+
+    results
+  end
+
+  def validate_find_options_with_friendly(options) #:nodoc:#
+    options.assert_valid_keys([:conditions, :include, :joins, :limit, :offset,
+      :order, :select, :readonly, :group, :from, :lock, :having, :scope])
+  end
+
+  private
+
+  # Assign finder slugs for the results found in find_some_with_friendly
+  def assign_finder_slugs(slugs, results) #:nodoc:#
+    slugs.each do |slug|
+      results.select { |r| r.id == slug.sluggable_id }.each do |result|
+        result.send(:finder_slug=, slug)
+      end
+    end
+  end
+
+  # Build arrays of slugs and ids, for the find_some_with_friendly method.
+  def get_slugs_and_ids(ids_and_names, options) #:nodoc:#
+    scope = options.delete(:scope)
+    slugs = []
+    ids = []
+    ids_and_names.each do |id_or_name|
+      name, sequence = Slug.parse id_or_name
+      slug = Slug.find(:first, :readonly => true, :conditions => {
+        :name           => name,
+        :scope          => scope,
+        :sequence       => sequence,
+        :sluggable_type => base_class.name
+      })
+      # If the slug was found, add it to the array for later use. If not, and
+      # the id_or_name is a number, assume that it is a regular record id.
+      slug ? slugs << slug : (ids << id_or_name if id_or_name =~ /\A\d*\z/)
+    end
+    return slugs, ids
+  end
+
+end

data/lib/friendly_id/sluggable_instance_methods.rb

@@ -0,0 +1,105 @@
+module FriendlyId::SluggableInstanceMethods
+
+  NUM_CHARS_RESERVED_FOR_FRIENDLY_ID_EXTENSION = 2
+
+  attr :finder_slug
+  attr_accessor :finder_slug_name
+
+  def finder_slug
+    @finder_slug ||= init_finder_slug
+  end
+
+  # Was the record found using one of its friendly ids?
+  def found_using_friendly_id?
+    finder_slug
+  end
+
+  # Was the record found using its numeric id?
+  def found_using_numeric_id?
+    !found_using_friendly_id?
+  end
+
+  # Was the record found using an old friendly id?
+  def found_using_outdated_friendly_id?
+    finder_slug.id != slug.id
+  end
+
+  # Was the record found using an old friendly id, or its numeric id?
+  def has_better_id?
+    slug and found_using_numeric_id? || found_using_outdated_friendly_id?
+  end
+
+  # Returns the friendly id.
+  def friendly_id
+    slug(true).to_friendly_id
+  end
+  alias best_id friendly_id
+
+  # Has the basis of our friendly id changed, requiring the generation of a
+  # new slug?
+  def new_slug_needed?
+    !slug || slug_text != slug.name
+  end
+
+  # Returns the most recent slug, which is used to determine the friendly
+  # id.
+  def slug(reload = false)
+    @most_recent_slug = nil if reload
+    @most_recent_slug ||= slugs.first
+  end
+
+  # Returns the friendly id, or if none is available, the numeric id.
+  def to_param
+    slug ? slug.to_friendly_id : id.to_s
+  end
+
+  # Get the processed string used as the basis of the friendly id.
+  def slug_text
+    base = send friendly_id_options[:column]
+    if self.friendly_id_options[:strip_diacritics]
+      base = Slug::normalize(Slug::strip_diacritics(base))
+    else
+      base = Slug::normalize(base)
+    end
+    if base.length > friendly_id_options[:max_length]
+      base = base[0...friendly_id_options[:max_length]]
+    end
+    if friendly_id_options[:reserved].include?(base)
+      raise FriendlyId::SlugGenerationError.new("The slug text is a reserved value")
+    end
+    return base
+  end
+
+  private
+
+  def finder_slug=(finder_slug)
+    @finder_slug_name = finder_slug.name
+    slug = finder_slug
+    slug.sluggable = self
+    slug
+  end
+
+  def init_finder_slug
+    return false if !@finder_slug_name
+    slug = Slug.find(:first, :conditions => {:sluggable_id => id, :name => @finder_slug_name, :sluggable_type => self.class.name })
+    finder_slug = slug
+  end
+
+  # Set the slug using the generated friendly id.
+  def set_slug
+    if self.class.friendly_id_options[:use_slug] && new_slug_needed?
+      @most_recent_slug = nil
+      slug_attributes = {:name => slug_text}
+      if friendly_id_options[:scope]
+        scope = send(friendly_id_options[:scope])
+        slug_attributes[:scope] = scope.respond_to?(:to_param) ? scope.to_param.to_s : scope.to_s
+      end
+      # If we're renaming back to a previously used friendly_id, delete the
+      # slug so that we can recycle the name without having to use a sequence.
+      slugs.find(:all, :conditions => {:name => slug_text, :scope => slug_attributes[:scope]}).each { |s| s.destroy }
+      slug = slugs.build slug_attributes
+      slug
+    end
+  end
+
+end

data/lib/friendly_id/version.rb

@@ -0,0 +1,8 @@
+module FriendlyId #:nodoc:
+  module Version #:nodoc:
+    MAJOR = 2
+    MINOR = 0
+    TINY = 0
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/tasks/friendly_id.rake

@@ -0,0 +1,48 @@
+namespace :friendly_id do
+  desc "Make slugs for a model."
+  task :make_slugs => :environment do
+    raise 'USAGE: rake friendly_id:make_slugs MODEL=MyModelName' if ENV["MODEL"].nil?
+    if !sluggable_class.friendly_id_options[:use_slug]
+      raise "Class \"#{sluggable_class.to_s}\" doesn't appear to be using slugs"
+    end
+    while records = sluggable_class.find(:all, :include => :slugs, :conditions => "slugs.id IS NULL", :limit => 1000) do
+      break if records.size == 0
+      records.each do |r|
+        r.send(:set_slug)
+        r.save!
+        puts "#{sluggable_class.to_s}(#{r.id}) friendly_id set to \"#{r.slug.name}\""
+      end
+    end
+  end
+
+  desc "Regenereate slugs for a model."
+  task :redo_slugs => :environment do
+    raise 'USAGE: rake friendly_id:redo_slugs MODEL=MyModelName' if ENV["MODEL"].nil?
+    if !sluggable_class.friendly_id_options[:use_slug]
+      raise "Class \"#{sluggable_class.to_s}\" doesn't appear to be using slugs"
+    end
+    Slug.destroy_all(["sluggable_type = ?", sluggable_class.to_s])
+    Rake::Task["friendly_id:make_slugs"].invoke
+  end
+
+  desc "Kill obsolete slugs older than 45 days."
+  task :remove_old_slugs => :environment do
+    if ENV["DAYS"].nil?
+      @days = 45
+    else
+      @days = ENV["DAYS"].to_i
+    end
+    slugs = Slug.find(:all, :conditions => ["created_at < ?", DateTime.now - @days.days])
+    slugs.each do |s|
+      s.destroy if !s.is_most_recent?
+    end
+  end
+end
+
+def sluggable_class
+  if (ENV["MODEL"].split('::').size > 1)
+    ENV["MODEL"].split('::').inject(Kernel) {|scope, const_name| scope.const_get(const_name)}
+  else
+    Object.const_get(ENV["MODEL"])
+  end
+end

data/lib/tasks/friendly_id.rb

@@ -0,0 +1 @@
+load 'tasks/friendly_id.rake'

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: ":memory:"

data/test/fixtures/countries.yml

@@ -0,0 +1,4 @@
+argentina:
+  name: Argentina
+usa:
+  name: USA

data/test/fixtures/country.rb

@@ -0,0 +1,4 @@
+class Country < ActiveRecord::Base
+  has_many :people
+  has_friendly_id :name, :use_slug => true
+end

data/test/fixtures/people.yml

@@ -0,0 +1,7 @@
+john_smith:
+  name: John Smith
+  country: argentina
+
+john_smith2:
+  name: John Smith
+  country: usa

data/test/fixtures/person.rb

@@ -0,0 +1,6 @@
+class Person < ActiveRecord::Base
+
+  belongs_to :country
+  has_friendly_id :name, :use_slug => true, :scope => :country
+
+end

data/test/fixtures/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true, :reserved => ['new', 'edit']
+end

data/test/fixtures/posts.yml

@@ -0,0 +1,23 @@
+without_slug:
+  name: Without a slug
+  content: Content without a slug
+
+with_one_slug:
+  name: With one slug
+  content: Content with one slug
+
+with_two_slugs:
+  name: With two slugs
+  content: Content with two slugs
+
+common_title:
+  name: Common Title
+  content: A post with a very common title
+
+common_title2:
+  name: Common Title
+  content: A second post with a very common title
+
+john_smith:
+  name: John Smith
+  content: Should allow for identical slug names between sluggable types

data/test/fixtures/slugs.yml

@@ -0,0 +1,53 @@
+post_with_same_friendly_id_as_person:
+  name: john-smith
+  sluggable: john_smith (Post)
+
+person_with_same_friendly_id_as_post:
+  name: john-smith
+  sluggable: john_smith (Person)
+
+one:
+  name: with-one-slug
+  sluggable: with_one_slug
+  sluggable_type: Post
+  sequence: 1
+
+two_old:
+  name: with-two-slugs
+  sluggable: with_two_slugs (Post)
+  sequence: 1
+  
+two_new:
+  name: with-two-slugs-new
+  sluggable: with_two_slugs (Post)
+  sequence: 1
+
+common_title:
+  name: common-title
+  sluggable: common_title (Post)
+  sequence: 1
+
+common_title2:
+  name: common-title
+  sluggable: common_title2 (Post)
+  sequence: 2
+
+john_smith:
+  name: john-smith
+  sluggable: john_smith (Person)
+  sequence: 1
+  scope: argentina
+
+john_smith2:
+  name: john-smith
+  sluggable: john_smith2 (Person)
+  sequence: 1
+  scope: usa
+
+argentina:
+  name: argentina
+  sluggable: argentina (Country)
+    
+usa:
+  name: usa
+  sluggable: usa (Country)

data/test/fixtures/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_friendly_id :login
+end

data/test/fixtures/users.yml

@@ -0,0 +1,7 @@
+joe:
+  login: joe
+  email: joe@example.org
+
+jane:
+  login: jane
+  email: jane@example.org

data/test/non_slugged_test.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class NonSluggedTest < Test::Unit::TestCase
+
+  fixtures :users
+
+  def setup
+  end
+
+  def test_should_find_user_using_friendly_id
+    assert User.find(users(:joe).friendly_id)
+  end
+
+  def test_should_find_users_using_friendly_id
+    assert User.find([users(:joe).friendly_id])
+  end
+
+  def test_to_param_should_return_a_string
+    assert_equal String, users(:joe).to_param.class
+  end
+
+  def test_should_not_find_users_using_non_existent_friendly_ids
+    assert_raises ActiveRecord::RecordNotFound do
+      User.find(['bad', 'bad2'])
+    end
+  end
+  
+  def test_finding_by_array_with_friendly_and_non_friendly_id_for_same_record_raises_error
+    assert_raises ActiveRecord::RecordNotFound do
+      User.find([users(:joe).id, "joe"]).size
+    end
+  end
+
+  def test_finding_with_mixed_array_should_indicate_whether_found_by_numeric_or_friendly
+    @users = User.find([users(:jane).id, "joe"], :order => "login ASC")
+    assert @users[0].found_using_numeric_id?
+    assert @users[1].found_using_friendly_id?
+  end
+
+  def test_finder_options_are_not_ignored
+    assert_raises ActiveRecord::RecordNotFound do
+       User.find(users(:joe).friendly_id, :conditions => "1 = 2")
+    end
+    assert_raises ActiveRecord::RecordNotFound do
+       User.find([users(:joe).friendly_id], :conditions => "1 = 2")
+    end
+  end
+
+  def test_user_should_have_friendly_id_options
+    assert_not_nil User.friendly_id_options
+  end
+
+  def test_user_should_not_be_found_using_friendly_id_unless_it_really_was
+    assert !User.find(users(:joe).id).found_using_friendly_id?
+  end
+
+  def test_users_should_not_be_found_using_friendly_id_unless_they_really_were
+    @users = User.find([users(:jane).id])
+    assert @users[0].found_using_numeric_id?
+  end
+
+  def test_user_should_be_considered_found_by_numeric_id_as_default
+    @user = User.new
+    assert @user.found_using_numeric_id?
+  end
+
+  def test_user_should_indicate_if_it_was_found_using_numeric_id
+    @user = User.find(users(:joe).id)
+    assert @user.found_using_numeric_id?
+    assert !@user.found_using_friendly_id?
+  end
+
+  def test_user_should_indicate_if_it_was_found_using_friendly_id
+    @user = User.find(users(:joe).friendly_id)
+    assert !@user.found_using_numeric_id?
+    assert @user.found_using_friendly_id?
+  end
+
+  def test_should_indicate_there_is_a_better_id_if_found_by_numeric_id
+    @user = User.find(users(:joe).id)
+    assert @user.found_using_numeric_id?
+    assert @user.has_better_id?
+  end
+
+end