nateabbott-friendly-id 2.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nate Abbott
+
+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.

data/README.rdoc

@@ -0,0 +1,18 @@
+= nateabbott-friendly-id
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Nate Abbott. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "nateabbott-friendly-id"
+    gem.summary = "A comprehensive slugging and pretty-URL plugin for ActiveRecord."
+    gem.description = 'A comprehensive slugging and pretty-URL plugin for ActiveRecord.'
+    gem.email = ['norman@njclarke.com', 'adrian@mugnolo.com', 'miloops@gmail.com']
+    gem.homepage = "http://github.com/nateabbott/nateabbott-friendly-id"
+    gem.authors = ['Norman Clarke', 'Adrian Mugnolo', 'Emilio Tagua']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nateabbott-friendly-id #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+2.2.1

data/lib/friendly_id/helpers.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module FriendlyId
+  
+  module Helpers
+    # Calculate expected result size for find_some_with_friendly (taken from
+    # active_record/base.rb)
+    def expected_size(ids_and_names, options) #:nodoc:#
+      size = options[:offset] ? ids_and_names.size - options[:offset] : ids_and_names.size
+      size = options[:limit] if options[:limit] && size > options[:limit]
+      size
+    end
+  end
+  
+end

data/lib/friendly_id/non_sluggable_class_methods.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module FriendlyId::NonSluggableClassMethods
+
+  include FriendlyId::Helpers
+
+  protected
+
+  def find_one(id, options) #:nodoc:#
+    if id.is_a?(String) && result = send("find_by_#{ friendly_id_options[:column] }", id, options)
+      result.send(:found_using_friendly_id=, true)
+    else
+      result = super id, options
+    end
+    result
+  end
+
+  def find_some(ids_and_names, options) #:nodoc:#
+
+    results = with_scope :find => options do
+      find :all, :conditions => ["#{quoted_table_name}.#{primary_key} IN (?) OR #{friendly_id_options[:column].to_s} IN (?)",
+        ids_and_names, ids_and_names]
+    end
+
+    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
+
+    results.each {|r| r.send(:found_using_friendly_id=, true) if ids_and_names.include?(r.friendly_id)}
+
+    results
+
+  end
+end

data/lib/friendly_id/non_sluggable_instance_methods.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module FriendlyId::NonSluggableInstanceMethods
+
+  attr :found_using_friendly_id
+
+  # Was the record found using one of its friendly ids?
+  def found_using_friendly_id?
+    @found_using_friendly_id
+  end
+
+  # Was the record found using its numeric id?
+  def found_using_numeric_id?
+    !@found_using_friendly_id
+  end
+  alias has_better_id? found_using_numeric_id?
+
+  # Returns the friendly_id.
+  def friendly_id
+    send friendly_id_options[:column]
+  end
+  alias best_id friendly_id
+
+  # Returns the friendly id, or if none is available, the numeric id.
+  def to_param
+    (friendly_id || id).to_s
+  end
+
+  private
+  
+  def validate_friendly_id
+    if self.class.friendly_id_options[:reserved].include? friendly_id
+      self.errors.add(self.class.friendly_id_options[:column],
+        self.class.friendly_id_options[:reserved_message] % friendly_id)
+      return false
+    end
+  end
+
+  def found_using_friendly_id=(value) #:nodoc#
+    @found_using_friendly_id = value
+  end
+
+end

data/lib/friendly_id/slug.rb

@@ -0,0 +1,100 @@
+#encoding: utf-8
+
+# A Slug is a unique, human-friendly identifier for an ActiveRecord.
+class Slug < ActiveRecord::Base
+
+  belongs_to :sluggable, :polymorphic => true
+  before_save :check_for_blank_name, :set_sequence
+
+
+  ASCII_APPROXIMATIONS = {
+    198 => "AE",
+    208 => "D",
+    216 => "O",
+    222 => "Th",
+    223 => "ss",
+    230 => "ae",
+    240 => "d",
+    248 => "o",
+    254 => "th"
+  }.freeze
+
+  class << self
+
+    # Sanitizes and dasherizes string to make it safe for URL's.
+    #
+    # Example:
+    #
+    #   slug.normalize('This... is an example!') # => "this-is-an-example"
+    #
+    # Note that the Unicode handling in ActiveSupport may fail to process some
+    # characters from Polish, Icelandic and other languages.
+    def normalize(slug_text)
+      return "" if slug_text.nil? || slug_text == ""
+      ActiveSupport::Multibyte.proxy_class.new(slug_text.to_s).normalize(:kc).
+        gsub(/[\W]/u, ' ').
+        strip.
+        gsub(/\s+/u, '-').
+        gsub(/-\z/u, '').
+        downcase.
+        to_s
+    end
+
+    def parse(friendly_id)
+      name, sequence = friendly_id.split('--')
+      sequence ||= "1"
+      return name, sequence
+    end
+
+    # Remove diacritics (accents, umlauts, etc.) from the string. Borrowed
+    # from "The Ruby Way."
+    def strip_diacritics(string)
+      a = ActiveSupport::Multibyte.proxy_class.new(string).normalize(:kd) || ""
+      a.unpack('U*').inject([]) { |a, u|
+        if ASCII_APPROXIMATIONS[u]
+          a += ASCII_APPROXIMATIONS[u].unpack('U*')
+        elsif (u < 0x300 || u > 0x036F)
+          a << u
+        end
+        a
+      }.pack('U*')
+    end
+
+
+
+    # Remove non-ascii characters from the string.
+    def strip_non_ascii(string)
+      strip_diacritics(string).gsub(/[^a-z0-9]+/i, ' ')
+    end
+
+    private
+
+  end
+
+  # Whether or not this slug is the most recent of its owner's slugs.
+  def is_most_recent?
+    sluggable.slug == self
+  end
+
+  def to_friendly_id
+    sequence > 1 ? "#{name}--#{sequence}" : name
+  end
+
+  protected
+
+  # Raise a FriendlyId::SlugGenerationError if the slug name is blank.
+  def check_for_blank_name #:nodoc:#
+    if name.blank?
+      raise FriendlyId::SlugGenerationError.new("The slug text is blank.")
+    end
+  end
+
+  def set_sequence
+    return unless new_record?
+    last = Slug.find(:first, :conditions => { :name => name, :scope => scope,
+      :sluggable_type => sluggable_type}, :order => "sequence DESC",
+      :select => 'sequence')
+    self.sequence = last.sequence + 1 if last
+  end
+
+end

data/lib/friendly_id/sluggable_class_methods.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+module FriendlyId::SluggableClassMethods
+
+  include FriendlyId::Helpers
+
+  # Finds a single record using the friendly id, or the record's id.
+  def find_one(id_or_name, options) #:nodoc:#
+
+    scope = options.delete(:scope)
+    return super(id_or_name, options) if id_or_name.is_a?(Integer)
+
+    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
+    elsif id_or_name.to_i.to_s != id_or_name
+      raise ActiveRecord::RecordNotFound
+    else
+      result = super id_or_name, options
+    end
+
+    result
+
+  rescue ActiveRecord::RecordNotFound => e
+
+    if friendly_id_options[:scope]
+      if !scope
+        raise ActiveRecord::RecordNotFound.new("%s; expected scope but got none" % e.message)
+      else
+        raise ActiveRecord::RecordNotFound.new("%s and scope=#{scope}" % e.message)
+      end
+    end
+
+    raise e
+
+  end
+
+  # Finds multiple records using the friendly ids, or the records' ids.
+  def find_some(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(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,132 @@
+# 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_name
+  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?
+    if cache = friendly_id_options[:cache_column]
+      return false if send(cache) == @finder_slug_name
+    end
+    finder_slug.id != slug.id
+  end
+
+  # Was the record found using an old friendly id, or its numeric id?
+  def has_better_id?
+    has_a_slug? and found_using_numeric_id? || found_using_outdated_friendly_id?
+  end
+
+  # Does the record have (at least) one slug?
+  def has_a_slug?
+    @finder_slug_name || slug
+  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(:order => "id DESC")
+  end
+
+  # Returns the friendly id, or if none is available, the numeric id.
+  def to_param
+    if cache = friendly_id_options[:cache_column]
+      return read_attribute(cache) || id.to_s
+    end
+    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.mb_chars.length > friendly_id_options[:max_length]
+      base = base.mb_chars[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 = 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 }
+      slugs.build slug_attributes
+    end
+  end
+
+  def set_slug_cache
+    if friendly_id_options[:cache_column] && send(friendly_id_options[:cache_column]) != slug.name
+      send "#{friendly_id_options[:cache_column]}=", slug.name
+      send :update_without_callbacks
+    end
+  end
+
+end