nateabbott-nateabbott-friendly_id 2.1.5

data/lib/friendly_id/sluggable_class_methods.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+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
+  rescue ActiveRecord::RecordNotFound => e
+
+    if friendly_id_options[:scope]
+      if !scope
+        e.message << "; expected scope but got none"
+      else
+        e.message << " and scope=#{scope}"
+      end
+    end
+
+    raise e
+
+  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) }.uniq
+
+    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.to_s
+      slug = Slug.find(:first, :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.to_s =~ /\A\d*\z/)
+    end
+    return slugs, ids
+  end
+
+end

data/lib/friendly_id/sluggable_instance_methods.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+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 or nil
+  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.slug_normalizer_block
+      base = self.slug_normalizer_block.call(base)
+    else
+      if self.friendly_id_options[:strip_diacritics]
+        base = Slug::strip_diacritics(base)
+      end
+      if self.friendly_id_options[:strip_non_ascii]
+        base = Slug::strip_non_ascii(base)
+      end
+      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
+    name, sequence = Slug.parse(@finder_slug_name)
+    slug = Slug.find(:first, :conditions => {:sluggable_id => id, :name => name, :sequence => sequence, :sluggable_type => self.class.base_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 = self.class.friendly_id_options[:scope] # originally: 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.
+      #  ORIG: slugs.find(:all, :conditions => {:name => slug_text, :scope => scope}).each { |s| s.destroy }
+      slugs.find(:all, :conditions => {:name => slug_text, :scope => slug_attributes[:scope]}).each
+      slug = slugs.build slug_attributes
+      slug
+    end
+  end
+
+end

data/lib/friendly_id/version.rb

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

data/lib/tasks/friendly_id.rake

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+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/contest.rb

@@ -0,0 +1,94 @@
+# License
+# -------
+# 
+# Contest is copyright (c) 2009 Damian Janowski and Michel Martens for
+# Citrusbyte
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+require "test/unit"
+
+# Test::Unit loads a default test if the suite is empty, whose purpose is to
+# fail. Since having empty contexts is a common practice, we decided to
+# overwrite TestSuite#empty? in order to allow them. Having a failure when no
+# tests have been defined seems counter-intuitive.
+class Test::Unit::TestSuite
+  def empty?
+    false
+  end
+end
+
+# Contest adds +teardown+, +test+ and +context+ as class methods, and the
+# instance methods +setup+ and +teardown+ now iterate on the corresponding
+# blocks. Note that all setup and teardown blocks must be defined with the
+# block syntax. Adding setup or teardown instance methods defeats the purpose
+# of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    define_method :setup do
+      super(&block)
+      instance_eval(&block)
+    end
+  end
+
+  def self.teardown(&block)
+    define_method :teardown do
+      instance_eval(&block)
+      super(&block)
+    end
+  end
+
+  def self.context(name, &block)
+    subclass = Class.new(self)
+    remove_tests(subclass)
+    subclass.class_eval(&block)
+    const_set(context_name(name), subclass)
+  end
+
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+
+private
+
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+
+  def self.remove_tests(subclass)
+    subclass.public_instance_methods.grep(/^test_/).each do |meth|
+      subclass.send(:undef_method, meth.to_sym)
+    end
+  end
+end

data/test/custom_slug_normalizer_test.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class CustomSlugNormalizerTest < Test::Unit::TestCase
+
+  context "A slugged model using a custom slug generator" do
+
+    setup do
+      Thing.friendly_id_options = FriendlyId::DEFAULT_FRIENDLY_ID_OPTIONS.merge(:column => :name, :use_slug => true)
+      Thing.delete_all
+      Slug.delete_all
+    end
+
+    should "invoke the block code" do
+      @thing = Thing.create!(:name => "test")
+      assert_equal "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", @thing.friendly_id
+    end
+
+    should "respect the max_length option" do
+      Thing.friendly_id_options = Thing.friendly_id_options.merge(:max_length => 10)
+      @thing = Thing.create!(:name => "test")
+      assert_equal "a94a8fe5cc", @thing.friendly_id
+    end
+
+    should "respect the reserved option" do
+      Thing.friendly_id_options = Thing.friendly_id_options.merge(:reserved => ["a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"])
+      assert_raises FriendlyId::SlugGenerationError do
+        Thing.create!(:name => "test")
+      end
+    end
+  
+  end
+
+end

data/test/models/book.rb

@@ -0,0 +1,2 @@
+class Book < ActiveRecord::Base
+end

data/test/models/country.rb

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

data/test/models/event.rb

@@ -0,0 +1,3 @@
+class Event < ActiveRecord::Base
+  has_friendly_id :event_date, :use_slug => true
+end