friendly_id 2.2.7 → 2.3.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Norman Clarke, Adrian Mugnolo and Emilio Tagua.
+Copyright (c) 2008-2010 Norman Clarke, Adrian Mugnolo and Emilio Tagua.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,76 @@
+# FriendlyId
+
+FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
+Ruby on Rails. It allows you to create pretty URL's and work with
+human-friendly strings as if they were numeric ids for ActiveRecord models.
+
+Using FriendlyId, it's easy to make your application use URL's like:
+
+    http://example.com/states/washington
+
+instead of:
+
+    http://example.com/states/4323454
+
+## FriendlyId Features
+
+FriendlyId offers many advanced features, including: slug history and
+versioning, scoped slugs, reserved words, custom slug generators, and
+excellent Unicode support. For complete information on using FriendlyId,
+please see the {file:GUIDE.md FriendlyId Guide}.
+
+## Rails Quickstart
+
+    gem install friendly_id
+
+    rails my_app
+
+    cd my_app
+
+    # add to config/environment.rb
+    config.gem "friendly_id", :version => ">= 2.3.0"
+
+    ./script/generate friendly_id
+    ./script/generate scaffold user name:string cached_slug:string
+
+    rake db:migrate
+
+    # edit app/models/user.rb
+    class User < ActiveRecord::Base
+      has_friendly_id :name, :use_slug => true
+    end
+
+    User.create! :name => "Joe Schmoe"
+
+    ./script/server
+
+    GET http://0.0.0.0:3000/users/joe-schmoe
+
+## Docs, Info and Support
+
+* [FriendlyId Guide](http://norman.github.com/friendly_id/file.Guide.html)
+* [API Docs](http://norman.github.com/friendly_id)
+* [Google Group](http://groups.google.com/group/friendly_id)
+* [Source Code](http://github.com/norman/friendly_id/)
+* [Issue Tracker](http://github.com/norman/friendly_id/issues)
+
+## Bugs:
+
+Please report them on the [Github issue tracker](http://github.com/norman/friendly_id/issues)
+for this project.
+
+If you have a bug to report, please include the following information:
+
+* Stack trace and error message.
+* Version information for FriendlyId, Rails and Ruby.
+* Any snippets of relevant model, view or controller code that shows how your
+  are using FriendlyId.
+
+If you are able to, it helps even more if you can fork FriendlyId on Github,
+and add a test that reproduces the error you are experiencing.
+
+## Credits:
+
+FriendlyId was created by Norman Clarke, Adrian Mugnolo, and Emilio Tagua.
+
+Copyright (c) 2008-2010, released under the MIT license.

data/Rakefile

@@ -1,35 +1,68 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/clean'
+require "rake"
+require "rake/testtask"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+require "rake/clean"
 
-CLEAN	<< "pkg" << "docs" << "coverage"
+CLEAN << "pkg" << "doc" << "coverage" << ".yardoc"
 
-task :default => :test
-
-Rake::TestTask.new(:test) { |t| t.pattern = 'test/**/*_test.rb' }
 Rake::GemPackageTask.new(eval(File.read("friendly_id.gemspec"))) { |pkg| }
 Rake::RDocTask.new do |r|
-	r.rdoc_dir = "docs"
-	r.main = "README.rdoc"
-	r.rdoc_files.include "README.rdoc", "History.txt", "lib/**/*.rb"
+  r.rdoc_dir = "doc"
+  r.rdoc_files.include "lib/**/*.rb"
 end
 
 begin
   require "yard"
   YARD::Rake::YardocTask.new do |t|
-    t.options = ["--output-dir=docs"]
+    t.options = ["--output-dir=doc"]
+    t.options << "--files" << ["Guide.md", "Contributors.md", "Changelog.md"].join(",")
   end
 rescue LoadError
 end
 
 begin
-  require 'rcov/rcovtask'
+  require "rcov/rcovtask"
   Rcov::RcovTask.new do |r|
-    r.test_files = FileList['test/*_test.rb']
+    r.test_files = FileList["test/**/*_test.rb"]
     r.verbose = true
     r.rcov_opts << "--exclude gems/*"
   end
 rescue LoadError
 end
+
+
+task :test do
+  Rake::Task["test:friendly_id"].invoke
+  Rake::Task["test:ar"].invoke
+end
+
+namespace :test do
+  task :rails do
+    rm_rf "fid"
+    sh "rails --template extras/template-gem.rb fid"
+    sh "cd fid; rake test"
+  end
+  Rake::TestTask.new(:friendly_id) { |t| t.pattern = "test/*_test.rb" }
+  Rake::TestTask.new(:ar) { |t| t.pattern = "test/active_record2/*_test.rb" }
+  
+  namespace :rails do
+    task :plugin do
+      rm_rf "fid"
+      sh "rails --template extras/template-plugin.rb fid"
+      sh "cd fid; rake test"
+    end
+  end
+
+end
+
+task :pushdocs do
+  branch = `git branch | grep "*"`.chomp.gsub("* ", "")
+  sh "git stash"
+  sh "git checkout gh-pages"
+  sh "cp -rp doc/* ."
+  sh 'git commit -a -m "Regenerated docs"'
+  sh "git push origin gh-pages"
+  sh "git checkout #{branch}"
+  sh "git stash apply"
+end

data/extras/bench.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby -KU
+require File.dirname(__FILE__) + '/extras'
+require 'rbench'
+FACTOR = 100
+RBench.run(TIMES) do
+
+  column :times
+  column :ar
+
+  report 'find model using id', (TIMES * FACTOR).ceil do
+    ar { User.find(get_id) }
+  end
+
+  report 'find model using array of ids', (TIMES * FACTOR).ceil do
+    ar { User.find([get_id, get_id]) }
+  end
+
+  report 'find unslugged model using friendly id', (TIMES * FACTOR).ceil do
+    ar { User.find(USERS.rand) }
+  end
+
+  report 'find unslugged model using array of friendly ids', (TIMES * FACTOR).ceil do
+    ar { User.find([USERS.rand, USERS.rand]) }
+  end
+
+  report 'find slugged model using friendly id', (TIMES * FACTOR).ceil do
+    ar { Post.find(POSTS.rand) }
+  end
+
+  report 'find slugged model using array of friendly ids', (TIMES * FACTOR).ceil do
+    ar { Post.find([POSTS.rand, POSTS.rand]) }
+  end
+
+  report 'find cached slugged model using friendly id', (TIMES * FACTOR).ceil do
+    ar { District.find(DISTRICTS.rand) }
+  end
+
+  report 'find cached slugged model using array of friendly ids', (TIMES * FACTOR).ceil do
+    ar { District.find([DISTRICTS.rand, DISTRICTS.rand]) }
+  end
+
+  report 'find model using id, then to_param', (TIMES * FACTOR).ceil do
+    ar { User.find(get_id).to_param }
+  end
+
+  report 'find unslugged model using friendly id, then to_param', (TIMES * FACTOR).ceil do
+    ar { User.find(USERS.rand).to_param }
+  end
+
+  report 'find slugged model using friendly id, then to_param', (TIMES * FACTOR).ceil do
+    ar { Post.find(POSTS.rand).to_param }
+  end
+
+  report 'find cached slugged model using friendly id, then to_param', (TIMES * FACTOR).ceil do
+    ar { District.find(DISTRICTS.rand).to_param }
+   end
+
+  summary 'Total'
+end

data/extras/extras.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby -KU
+require File.dirname(__FILE__) + '/../test/test_helper'
+require File.dirname(__FILE__) + '/../test/active_record2/test_helper'
+require 'ffaker'
+
+TIMES = (ENV['N'] || 100).to_i
+POSTS     = []
+DISTRICTS = []
+USERS     = []
+
+User.delete_all
+Post.delete_all
+District.delete_all
+(Slug or Slug).delete_all
+
+100.times do
+  name = Faker::Name.name
+  USERS     << (User.create!     :name => name).friendly_id
+  POSTS     << (Post.create!     :name => name).friendly_id
+  DISTRICTS << (District.create! :name => name).friendly_id
+end
+
+def get_id
+  rand(99) + 1
+end
+
+class Array
+  def rand
+    self[Kernel.rand(length)]
+  end
+end

data/extras/prof.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby -KU
+require File.dirname(__FILE__) + '/extras'
+require 'ruby-prof'
+
+# RubyProf.measure_mode = RubyProf::MEMORY
+GC.disable
+RubyProf.start
+100.times do
+  Post.find(slug = POSTS.rand)
+end
+result = RubyProf.stop
+GC.enable
+printer = RubyProf::CallTreePrinter.new(result)
+printer.print(File.new("prof.txt", "w"))

data/extras/template-gem.rb

@@ -21,6 +21,6 @@ one:
 
 two:
   name: mystring
-  sequence: 2
+  sequence: 1
   sluggable: two (Post)
 }

data/extras/template-plugin.rb

@@ -1,6 +1,6 @@
 run "rm public/index.html"
 inside 'vendor/plugins' do
-  run "git clone ../../../../ friendly_id"
+  run "git clone ../../../ friendly_id"
 end
 gem "haml"
 gem "will_paginate"

data/generators/friendly_id/friendly_id_generator.rb

@@ -7,7 +7,7 @@ class FriendlyIdGenerator < Rails::Generator::Base
       end
       unless options[:skip_tasks]
         m.directory "lib/tasks"
-        m.file "/../../../lib/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
+        m.file "/../../../lib/friendly_id/active_record2/tasks/friendly_id.rake", "lib/tasks/friendly_id.rake"
       end
     end
   end

data/generators/friendly_id/templates/create_slugs.rb

@@ -5,11 +5,11 @@ class CreateSlugs < ActiveRecord::Migration
       t.integer :sluggable_id
       t.integer :sequence, :null => false, :default => 1
       t.string :sluggable_type, :limit => 40
-      t.string :scope, :limit => 40
+      t.string :scope
       t.datetime :created_at
     end
-    add_index :slugs, [:name, :sluggable_type, :scope, :sequence], :name => "index_slugs_on_n_s_s_and_s", :unique => true
     add_index :slugs, :sluggable_id
+    add_index :slugs, [:name, :sluggable_type, :sequence, :scope], :name => "index_slugs_on_n_s_s_and_s", :unique => true
   end
 
   def self.down

data/lib/friendly_id.rb

@@ -1,75 +1,66 @@
-require "friendly_id/helpers"
-require "friendly_id/slug"
-require "friendly_id/sluggable_class_methods"
-require "friendly_id/sluggable_instance_methods"
-require "friendly_id/non_sluggable_class_methods"
-require "friendly_id/non_sluggable_instance_methods"
+require File.join(File.dirname(__FILE__), "friendly_id", "slug_string")
+require File.join(File.dirname(__FILE__), "friendly_id", "configuration")
+require File.join(File.dirname(__FILE__), "friendly_id", "status")
+require File.join(File.dirname(__FILE__), "friendly_id", "finders")
+require File.join(File.dirname(__FILE__), "friendly_id", "slugged")
 
 # FriendlyId is a comprehensive Ruby library for slugging and permalinks with
 # ActiveRecord.
+# @author Norman Clarke
+# @author Emilio Tagua
+# @author Adrian Mugnolo
 module FriendlyId
 
-  # Default options for has_friendly_id.
-  DEFAULT_OPTIONS = {
-    :max_length       => 255,
-    :reserved         => ["new", "index"],
-    :reserved_message => 'can not be "%s"'
-  }.freeze
+  # An error based on this class is raised when slug generation fails
+  class SlugGenerationError < StandardError ; end
 
-  # The names of all valid configuration options.
-  VALID_OPTIONS = (DEFAULT_OPTIONS.keys + [
-    :cache_column,
-    :scope,
-    :strip_diacritics,
-    :strip_non_ascii,
-    :use_slug
-  ]).freeze
+  # Raised when the slug text is blank.
+  class BlankError < SlugGenerationError ; end
 
-  # This error is raised when it's not possible to generate a unique slug.
-  class SlugGenerationError < StandardError ; end
+  # Raised when the slug text is reserved.
+  class ReservedError < SlugGenerationError ; end
+
+  module Base
+    # Set up a model to use a friendly_id. This method accepts a hash with
+    # {FriendlyId::Configuration several possible options}.
+    #
+    # @param [#to_sym] method The column or method that should be used as the
+    #   basis of the friendly_id string.
+    #
+    # @param [Hash] options For valid configuration options, see
+    #   {FriendlyId::Configuration}.
+    #
+    # @param [block] block An optional block through which to filter the
+    #   friendly_id text; see {FriendlyId::Configuration#normalizer}. Note that
+    #   passing a block parameter is now deprecated and will be removed
+    #   from FriendlyId 3.0.
+    #
+    # @example
+    #
+    #   class User < ActiveRecord::Base
+    #     has_friendly_id :user_name
+    #   end
+    #
+    #   class Post < ActiveRecord::Base
+    #     has_friendly_id :title, :use_slug => true, :approximate_ascii => true
+    #   end
+    #
+    # @see FriendlyId::Configuration
+    def has_friendly_id(method, options = {}, &block)
+      raise NotImplementedError
+    end
 
-  # 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 nil. 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>:cache_column</tt> - Defaults to nil. Use this column as a cache for generating to_param (experimental) Note that if you use this option, any calls to +attr_accessible+ must be made BEFORE any calls to has_friendly_id in your class.
-  # * <tt>:strip_diacritics</tt> - Defaults to nil. If true, it will remove accents, umlauts, etc. from western characters.
-  # * <tt>:strip_non_ascii</tt> - Defaults to nil. If true, it will remove all non-ASCII 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 raise a FriendlyId::SlugGenerationError. 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
-  # slug normalization 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(method, options = {}, &block)
-    options.assert_valid_keys VALID_OPTIONS
-    options = DEFAULT_OPTIONS.merge(options).merge(:method => method)
-    write_inheritable_attribute :friendly_id_options, options
-    class_inheritable_accessor :friendly_id_options
-    class_inheritable_reader :slug_normalizer_block
-    write_inheritable_attribute(:slug_normalizer_block, block) if block_given?
-    if friendly_id_options[:use_slug]
-      extend SluggableClassMethods
-      include SluggableInstanceMethods
-    else
-      extend NonSluggableClassMethods
-      include NonSluggableInstanceMethods
+    # Does the model class use the FriendlyId plugin?
+    def uses_friendly_id?
+      respond_to? :friendly_id_config
     end
   end
-end
 
-class ActiveRecord::Base #:nodoc:#
-  extend FriendlyId #:nodoc:#
 end
+
+class String
+  def parse_friendly_id(separator = nil)
+    name, sequence = split(separator || FriendlyId::Configuration::DEFAULTS[:sequence_separator])
+    return name, sequence ||= "1"
+  end
+end