nateabbott-nateabbott-friendly_id 2.1.5

data/Rakefile

@@ -0,0 +1,49 @@
+require 'newgem'
+require 'lib/friendly_id/version'
+
+$hoe = Hoe.new("friendly_id", FriendlyId::Version::STRING) do |p|
+  p.rubyforge_name = "friendly-id"
+  p.author = ['Norman Clarke', 'Adrian Mugnolo', 'Emilio Tagua']
+  p.email = ['norman@rubysouth.com', 'adrian@rubysouth.com', 'miloops@gmail.com']
+  p.summary = "A comprehensive slugging and pretty-URL plugin for ActiveRecord."
+  p.description = 'A comprehensive slugging and pretty-URL plugin for ActiveRecord.'
+  p.url = 'http://friendly-id.rubyforge.org/'
+  p.test_globs = ['test/**/*_test.rb']
+  p.extra_deps << ['activerecord', '>= 2.0.0']
+  p.extra_deps << ['activesupport', '>= 2.0.0']
+  p.extra_dev_deps << ['newgem', ">= #{::Newgem::VERSION}"]
+  p.extra_dev_deps << ['sqlite3-ruby']
+  p.remote_rdoc_dir = ""
+end
+
+require 'newgem/tasks'
+
+desc "Run RCov"
+task :rcov do
+  run_coverage Dir["test/**/*_test.rb"]
+end
+
+def run_coverage(files)
+  rm_f "coverage"
+  rm_f "coverage.data"
+  if files.length == 0
+    puts "No files were specified for testing"
+    return
+  end
+  files = files.join(" ")
+  # if RUBY_PLATFORM =~ /darwin/
+  #   exclude = '--exclude "gems/"'
+  # else
+  #   exclude = '--exclude "rubygems"'
+  # end
+  rcov = ENV["RCOV"] ? ENV["RCOV"] : "rcov"
+  sh "#{rcov} -Ilib:test --sort coverage --text-report #{files}"
+end
+
+desc 'Publish RDoc to RubyForge.'
+task :publish_docs => [:clean, :docs] do
+  host = "compay@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/friendly-id"
+  local_dir = 'doc'
+  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
+end

data/config/website.yml

@@ -0,0 +1,2 @@
+host: compay@rubyforge.org
+remote_dir: /var/www/gforge-projects/friendly-id

data/friendly_id.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nateabbott-friendly_id}
+  s.version = "2.1.5"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Norman Clarke", "Adrian Mugnolo", "Emilio Tagua", "Nate Abbott"]
+  s.date = %q{2009-06-03}
+  s.description = %q{A comprehensive slugging and pretty-URL plugin for ActiveRecord.}
+  s.email = ["norman@rubysouth.com", "adrian@rubysouth.com", "miloops@gmail.com", "nate@everlater.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "config/website.yml", "friendly_id.gemspec", "generators/friendly_id/friendly_id_generator.rb", "generators/friendly_id/templates/create_slugs.rb", "generators/friendly_id_20_upgrade/friendly_id_20_upgrade_generator.rb", "generators/friendly_id_20_upgrade/templates/upgrade_friendly_id_to_20.rb", "init.rb", "lib/friendly_id.rb", "lib/friendly_id/helpers.rb", "lib/friendly_id/non_sluggable_class_methods.rb", "lib/friendly_id/non_sluggable_instance_methods.rb", "lib/friendly_id/slug.rb", "lib/friendly_id/sluggable_class_methods.rb", "lib/friendly_id/sluggable_instance_methods.rb", "lib/friendly_id/version.rb", "lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rb", "test/contest.rb", "test/custom_slug_normalizer_test.rb", "test/models/book.rb", "test/models/country.rb", "test/models/event.rb", "test/models/novel.rb", "test/models/person.rb", "test/models/post.rb", "test/models/thing.rb", "test/models/user.rb", "test/non_slugged_test.rb", "test/schema.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/slugged_model_test.rb", "test/sti_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://friendly-id.rubyforge.org/}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nate_friendly-id}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A comprehensive slugging and pretty-URL plugin for ActiveRecord.}
+  s.test_files = ["test/custom_slug_normalizer_test.rb", "test/non_slugged_test.rb", "test/scoped_model_test.rb", "test/slug_test.rb", "test/slugged_model_test.rb", "test/sti_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0.0"])
+      s.add_development_dependency(%q<newgem>, [">= 1.4.1"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+      s.add_dependency(%q<activesupport>, [">= 2.0.0"])
+      s.add_dependency(%q<newgem>, [">= 1.4.1"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+    s.add_dependency(%q<activesupport>, [">= 2.0.0"])
+    s.add_dependency(%q<newgem>, [">= 1.4.1"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/generators/friendly_id/friendly_id_generator.rb

@@ -0,0 +1,12 @@
+class FriendlyIdGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      unless options[:skip_migration]
+        m.migration_template(
+          'create_slugs.rb', 'db/migrate', :migration_file_name => 'create_slugs'
+        )
+        m.file "/../../../lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
+      end
+    end
+  end
+end

data/generators/friendly_id/templates/create_slugs.rb

@@ -0,0 +1,18 @@
+class CreateSlugs < ActiveRecord::Migration
+  def self.up
+    create_table :slugs do |t|
+      t.string :name
+      t.integer :sluggable_id
+      t.integer :sequence, :null => false, :default => 1
+      t.string :sluggable_type, :limit => 40
+      t.string :scope, :limit => 40
+      t.datetime :created_at
+    end
+    add_index :slugs, [:name, :sluggable_type, :scope, :sequence], :unique => true
+    add_index :slugs, :sluggable_id
+  end
+
+  def self.down
+    drop_table :slugs
+  end
+end

data/generators/friendly_id_20_upgrade/friendly_id_20_upgrade_generator.rb

@@ -0,0 +1,11 @@
+class FriendlyId20UpgradeGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      unless options[:skip_migration]
+        m.migration_template(
+          'upgrade_friendly_id_to_20.rb', 'db/migrate', :migration_file_name => 'upgrade_friendly_id_to_20'
+        )
+      end
+    end
+  end
+end

data/generators/friendly_id_20_upgrade/templates/upgrade_friendly_id_to_20.rb

@@ -0,0 +1,19 @@
+class UpgradeFriendlyIdTo20 < ActiveRecord::Migration
+
+  def self.up
+    remove_column :slugs, :updated_at
+    remove_index :slugs, :column => [:name, :sluggable_type]
+    add_column :slugs, :sequence, :integer, :null => false, :default => 1
+    add_column :slugs, :scope, :string, :limit => 40
+    add_index :slugs, [:name, :sluggable_type, :scope, :sequence], :unique => true, :name => "index_slugs_on_n_s_s_and_s"
+  end
+
+  def self.down
+    remove_index :slugs, :name => "index_slugs_on_n_s_s_and_s"
+    remove_column :slugs, :scope
+    remove_column :slugs, :sequence
+    add_column :slugs, :updated_at, :datetime
+    add_index :slugs, [:name, :sluggable_type], :unique => true
+  end
+
+end

data/init.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'friendly_id'

data/lib/friendly_id.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+
+require 'friendly_id/helpers'
+require 'friendly_id/slug'
+
+# FriendlyId is a comprehensize Rails plugin/gem for slugging and permalinks.
+module FriendlyId
+
+  # Default options for has_friendly_id.
+  DEFAULT_FRIENDLY_ID_OPTIONS = {
+    :max_length => 255,
+    :method => nil,
+    :reserved => ["new", "index"],
+    :reserved_message => 'can not be "%s"',
+    :scope => nil,
+    :strip_diacritics => false,
+    :strip_non_ascii => false,
+    :use_slug => false }.freeze
+
+  # Valid keys for has_friendly_id options.
+  VALID_FRIENDLY_ID_KEYS = [
+    :max_length,
+    :reserved,
+    :reserved_message,
+    :scope,
+    :strip_diacritics,
+    :strip_non_ascii,
+    :use_slug ].freeze
+
+  # This error is raised when it's not possible to generate a unique slug.
+  class SlugGenerationError < StandardError ; end
+
+  module ClassMethods
+
+    # Set up an ActiveRecord model to use a friendly_id.
+    #
+    # The column argument can be one of your model's columns, or a method
+    # you use to generate the slug.
+    #
+    # Options:
+    # * <tt>:use_slug</tt> - Defaults to false. Use slugs when you want to use a non-unique text field for friendly ids.
+    # * <tt>:max_length</tt> - Defaults to 255. The maximum allowed length for a slug.
+    # * <tt>:strip_diacritics</tt> - Defaults to false. If true, it will remove accents, umlauts, etc. from western characters.
+    # * <tt>:strip_non_ascii</tt> - Defaults to false. If true, it will all non-ascii ([^a-z0-9]) characters.
+    # * <tt>:reserved</tt> - Array of words that are reserved and can't be used as friendly_id's. For sluggable models, if such a word is used, it will be treated the same as if that slug was already taken (numeric extension will be appended). Defaults to ["new", "index"].
+    # * <tt>:reserved_message</tt> - The validation message that will be shown when a reserved word is used as a frindly_id. Defaults to '"%s" is reserved'.
+    #
+    # You can also optionally pass a block if you want to use your own custom
+    # slugnormalization routines rather than the default ones that come with
+    # friendly_id:
+    #
+    #   require 'stringex'
+    #   class Post < ActiveRecord::Base
+    #     has_friendly_id :title, :use_slug => true do |text|
+    #       # Use stringex to generate the friendly_id rather than the baked-in methods
+    #       text.to_url
+    #     end
+    #   end    
+    def has_friendly_id(column, options = {}, &block)
+      options.assert_valid_keys VALID_FRIENDLY_ID_KEYS
+      options = DEFAULT_FRIENDLY_ID_OPTIONS.merge(options).merge(:column => column)
+      write_inheritable_attribute :friendly_id_options, options
+      class_inheritable_accessor :friendly_id_options
+      class_inheritable_reader :slug_normalizer_block
+
+      if options[:use_slug]
+        has_many :slugs, :order => 'id DESC', :as => :sluggable, :dependent => :destroy
+        require 'friendly_id/sluggable_class_methods'
+        require 'friendly_id/sluggable_instance_methods'
+        extend SluggableClassMethods
+        include SluggableInstanceMethods
+        before_save :set_slug
+        if block_given?
+          write_inheritable_attribute :slug_normalizer_block, block
+        end
+      else
+        require 'friendly_id/non_sluggable_class_methods'
+        require 'friendly_id/non_sluggable_instance_methods'
+        extend NonSluggableClassMethods
+        include NonSluggableInstanceMethods
+        validate :validate_friendly_id
+      end
+    end
+
+  end
+
+  class << self
+
+    # Load FriendlyId if the gem is included in a Rails app.
+    def enable
+      return if ActiveRecord::Base.methods.include? 'has_friendly_id'
+      ActiveRecord::Base.class_eval { extend FriendlyId::ClassMethods }
+    end
+
+  end
+
+end
+
+if defined?(ActiveRecord)
+  FriendlyId::enable
+end

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,42 @@
+# encoding: utf-8
+
+module FriendlyId::NonSluggableClassMethods
+
+  include FriendlyId::Helpers
+
+  def self.extended(base) #:nodoc:#
+    class << base
+      alias_method_chain :find_one, :friendly
+      alias_method_chain :find_some, :friendly
+    end
+  end
+
+  protected
+
+  def find_one_with_friendly(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 = find_one_without_friendly id, options
+    end
+    result
+  end
+
+  def find_some_with_friendly(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,102 @@
+#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. If your
+    # application uses these languages, check {out this
+    # article}[http://link-coming-soon.com] for information on how to get
+    # better urls in your application.
+    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)
+      ActiveSupport::Multibyte.proxy_class.new(string).normalize(:kd).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