friendly_id 1.9.9

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
+
+  # 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 : 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 => scope}).each { |s| s.destroy }
+      s = slugs.build slug_attributes
+      s.send(:set_sequence)
+    end
+  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})
+    finder_slug = slug
+  end
+
+end

data/lib/friendly_id/version.rb

@@ -0,0 +1,8 @@
+module FriendlyId #:nodoc:
+  module Version #:nodoc:
+    MAJOR = 1
+    MINOR = 9
+    TINY = 9
+    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.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,19 @@
+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

data/test/fixtures/slugs.yml

@@ -0,0 +1,45 @@
+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,63 @@
+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_to_param_should_return_a_string
+    assert_equal String, users(:joe).to_param.class
+  end
+
+  def test_should_find_users_using_friendly_ids
+    assert_equal 2, User.find([users(:joe).friendly_id, users(:jane).friendly_id]).length
+  end
+
+  def test_should_not_find_users_using_non_existent_friendly_ids
+    assert_raises ActiveRecord::RecordNotFound do
+      User.find(['non-existent-slug', 'yet-another-non-existent-slug'])
+    end
+  end
+
+  def test_finder_options_are_not_ignored
+    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
+    @user = User.new
+    assert !@user.found_using_friendly_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?
+  end
+
+  def test_user_should_indicate_if_it_was_found_using_friendly_id
+    @user = User.find(users(:joe).friendly_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.has_better_id?
+  end
+
+end

data/test/rails/2.x/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!