friendly_id 3.3.3.0 → 4.0.0.beta7

data/.gitignore

@@ -0,0 +1,11 @@
+Gemfile
+Gemfile.lock
+doc
+docs
+pkg
+.DS_Store
+coverage
+.yardoc
+*.gem
+*.sqlite3
+*.rbc

data/.travis.yml

@@ -0,0 +1,24 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - rbx-2.0
+  # Temporarily not testing JRuby in CI because ActiveRecord JDBC does not
+  # support 3.1 well yet. Rest assured I'm testing this and want to target
+  # JRuby, I just don't want to see broken build messages all the time when I
+  # already know what the probelem is.
+  # - jruby
+
+branches:
+  only:
+    - master
+env:
+  - DB=postgres
+  - DB=mysql
+  - DB=sqlite3
+
+gemfile:
+  - gemfiles/Gemfile.rails-3.0.rb
+  - gemfiles/Gemfile.rails-3.1.rb
+
+script: "bundle exec rake db:reset db:up test"

data/.yardopts

@@ -0,0 +1,4 @@
+--files=*.md
+--protected
+--list-undoc
+--exclude lib/friendly_id/migration

data/Changelog.md

@@ -6,19 +6,18 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
-## 3.1.3 (2012-04-28)
+## 4.0.0 (NOT_RELEASED_YET)
 
-* Fix for sequenced scoped slugs ([Louise Crow](https://github.com/crowbot))
+This is a complete rewrite of FriendlyId, and introduces a smaller, faster and
+less ambitious codebase. The primary change is the relegation of external slugs
+to an optional addon, and the adoption of what were formerly "cached slugs"
+as the primary way of handling slugging.
 
-## 3.1.2 (2012-01-24)
+## 3.3.0 (NOT_RELEASED_YET)
 
-* Fix for 3.2 support ([Philip Arndt](https://github.com/parndt))
-
-## 3.1.1 (2011-12-12)
-
-* Fix for "can't modify frozen hash" on 3.1 ([Theo Cushion](https://github.com/theozaurus))
-
-## 3.3.0 (2011-08-31)
+This is a compatiblity branch and will be maintained for apps that can't
+upgrade to 4.0. No new features are planned, only bugfixes. If you're creating
+a new app, please use 4.x.
 
 * Support for Active Record 2.3 dropped
 * Convert blank slugs to nil automatically ([Gabe da Silveira ](https://github.com/dasil003))

data/README.md

@@ -1,8 +1,10 @@
 # FriendlyId
 
+[![Build Status](http://travis-ci.org/norman/friendly_id.png)](http://travis-ci.org/norman/friendly_id)
+
 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 Active Record models.
+Ruby on Rails. It allows you to create pretty URL's and work with human-friendly
+strings as if they were numeric ids for Active Record models.
 
 Using FriendlyId, it's easy to make your application use URL's like:
 
@@ -12,33 +14,18 @@ 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 [FriendlyId Guide](https://github.com/norman/friendly_id/blob/3.x/Guide.md)
-
-## Compatibility
-
-FriendlyId 3.3.0 is compatible with Active Record 3.0, 3.1 and 3.2.
-
-If you are still on Rails 2.3, please use FriendlyId 3.2.x.
-
-## Roadmap
-
-FriendlyId 3.3 is now in **long term maintenance mode.** It will continue to be
-supported and maintained indefinitely, but no new features will be added to it.
+versioning, scoped slugs, reserved words, and custom slug generators.
 
-[FriendlyId 4.0](https://github.com/norman/friendly_id/tree/4.0.0) is a
-ground-up rewrite of FriendlyId, and is the project's future, and will be
-released by September, 2011.
+FriendlyId is compatible with Active Record **3.0** and **3.1**.
 
-## Docs, Info and Support
+## Version 4.x
 
-* [FriendlyId Guide](https://github.com/norman/friendly_id/blob/3.x/Guide.md)
-* [Source Code](http://github.com/norman/friendly_id/)
-* [Issue Tracker](http://github.com/norman/friendly_id/issues)
+FriendlyId 4.x introduces many changes incompatible with 3.x. If you're upgrading,
+please read the docs to see what's new.
 
 ## Rails Quickstart
 
@@ -48,45 +35,49 @@ released by September, 2011.
 
     cd my_app
 
-    # add to Gemfile
-    gem "friendly_id", "~> 3.3.0"
+    gem "friendly_id", "~> 4.0.0.beta7"
 
-    rails generate friendly_id
-    rails generate scaffold user name:string cached_slug:string
+
+    rails generate scaffold user name:string slug:string
+
+    # edit db/migrate/*_create_users.rb
+    add_index :users, :slug, :unique => true
 
     rake db:migrate
 
     # edit app/models/user.rb
     class User < ActiveRecord::Base
-      has_friendly_id :name, :use_slug => true
+      extend FriendlyId
+      friendly_id :name, :use => :slugged
     end
 
     User.create! :name => "Joe Schmoe"
 
     rails server
 
-    GET http://0.0.0.0:3000/users/joe-schmoe
+    GET http://localhost:3000/users/joe-schmoe
+
+## Docs
 
-## Sequel and DataMapper, too
+The current docs can be found
+[here](http://rdoc.info/github/norman/friendly_id/a4128af31d85ee29ad8f/frames).
 
-[Alex Coles](http://github.com/myabc) maintains an implemntation of
-[FriendlyId for DataMapper](http://github.com/myabc/friendly_id_datamapper) that supports almost
-all the features of the Active Record version.
+## Benchmarks
+
+The latest benchmarks for FriendlyId are maintained
+[here](https://gist.github.com/1129745).
 
-Norman Clarke maintains an implementation of
-[FriendlyId forSequel](http://github.com/norman/friendly_id_sequel) with some of the features
-of the Active Record version.
 
 ## Bugs
 
-Please report them on the [Github issue tracker](http://github.com/norman/friendly_id/issues)
-for this project.
+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:
 
 * **Version information for FriendlyId, Rails and Ruby.**
 * Stack trace and error message.
-* Any snippets of relevant model, view or controller code that shows how your
+ * Any snippets of relevant model, view or controller code that shows how you
   are using FriendlyId.
 
 If you are able to, it helps even more if you can fork FriendlyId on Github,
@@ -94,14 +85,14 @@ and add a test that reproduces the error you are experiencing.
 
 ## Credits
 
-FriendlyId was created by Norman Clarke, Adrian Mugnolo, and Emilio Tagua.
-
-If you like FriendlyId, please recommend us on Working With Rails:
-
-* [http://bit.ly/recommend-norman](http://bit.ly/recommend-norman)
-* [http://bit.ly/recommend-emilio](http://bit.ly/recommend-emilio)
-* [http://bit.ly/recommend-adrian](http://bit.ly/recommend-adrian)
+FriendlyId was originally created by Norman Clarke and Adrian Mugnolo, with
+significant help early in its life by Emilio Tagua. I'm deeply gratful for the
+generous contributions over the years from [many
+volunteers](https://github.com/norman/friendly_id/contributors).
 
-Thanks!
+Lastly, FriendlyId uses [Travis](http://travis-ci.org/) for continuous
+integration. It's an excellent, free service created by a whole bunch of [good
+people](https://github.com/travis-ci) - if you're not already using it, you
+should be!
 
-Copyright (c) 2008-2010, released under the MIT license.
+Copyright (c) 2008-2011 Norman Clarke, released under the MIT license.

data/Rakefile

@@ -1,79 +1,77 @@
 require "rubygems"
-require "rake"
 require "rake/testtask"
-require "rubygems/package_task"
-require "rake/clean"
-require "bundler/setup"
 
 task :default => :test
 
-CLEAN << "pkg" << "doc" << "coverage" << ".yardoc"
-
-gemspec = File.expand_path("../friendly_id.gemspec", __FILE__)
-if File.exists? gemspec
-  Gem::PackageTask.new(eval(File.read("friendly_id.gemspec"))) { |pkg| }
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
 end
 
-begin
-  require "yard"
-  YARD::Rake::YardocTask.new do |t|
-    t.options = ["--output-dir=doc"]
-    t.options << "--files" << ["Guide.md", "Contributors.md", "Changelog.md"].join(",")
-  end
-rescue LoadError
+task :clean do
+  %x{rm -rf *.gem doc pkg coverage}
+  %x{rm -f `find . -name '*.rbc'`}
 end
 
-begin
-  require "rcov/rcovtask"
-  Rcov::RcovTask.new do |r|
-    r.test_files = FileList["test/**/*_test.rb"]
-    r.verbose = true
-    r.rcov_opts << "--exclude gems/*"
-  end
-rescue LoadError
+task :gem do
+  %x{gem build friendly_id.gemspec}
 end
 
+task :yard do
+  puts %x{bundle exec yard}
+end
 
-Rake::TestTask.new(:test) { |t| t.pattern = "test/**/*_test.rb" }
+task :bench do
+  require File.expand_path("../bench", __FILE__)
+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_record_adapter/*_test.rb" }
 
-  desc "Test against lots of versions"
-  task :pre_release do
-    ["ree-1.8.7-2010.02", "ruby-1.9.2-p136"].each do |ruby|
-      ["sqlite3", "mysql", "postgres"].each do |driver|
-        [2, 3].each do |ar_version|
-          command = "rake-#{ruby} test AR=#{ar_version} DB=#{driver}"
-          puts command
-          puts `#{command}`
-        end
-      end
+  desc "Run each test class in a separate process"
+  task :isolated do
+    dir = File.expand_path("../test", __FILE__)
+    Dir["#{dir}/*_test.rb"].each do |test|
+      puts "Running #{test}:"
+      puts %x{ruby #{test}}
     end
   end
+end
 
-  namespace :rails do
-    task :plugin do
-      rm_rf "fid"
-      sh "rails --template extras/template-plugin.rb fid"
-      sh "cd fid; rake test"
-    end
+namespace :db do
+
+  desc "Create the database"
+  task :create do
+    require File.expand_path("../test/helper", __FILE__)
+    driver = FriendlyId::Test::Database.driver
+    config = FriendlyId::Test::Database.config[driver]
+    commands = {
+      "mysql"    => "mysql -e 'create database #{config["database"]};' >/dev/null",
+      "postgres" => "psql -c 'create database #{config['database']};' -U #{config['username']} >/dev/null"
+    }
+    %x{#{commands[driver] || true}}
+  end
+
+  desc "Create the database"
+  task :drop do
+    require File.expand_path("../test/helper", __FILE__)
+    driver = FriendlyId::Test::Database.driver
+    config = FriendlyId::Test::Database.config[driver]
+    commands = {
+      "mysql"    => "mysql -e 'drop database #{config["database"]};' >/dev/null",
+      "postgres" => "psql -c 'drop database #{config['database']};' -U #{config['username']} >/dev/null"
+    }
+    %x{#{commands[driver] || true}}
   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"
+  desc "Set up the database schema"
+  task :up do
+    require File.expand_path("../test/helper", __FILE__)
+    FriendlyId::Test::Schema.up
+  end
+
+  desc "Drop and recreate the database schema"
+  task :reset => [:drop, :create]
+
 end
+
+task :doc => :yard

data/WhatsNew.md

@@ -0,0 +1,95 @@
+# What's New in FriendlyId 4?
+
+## Back to basics
+
+FriendlyId is mostly a different codebase from FriendlyId 3. However, this isn't
+the "big rewrite," it's the "small rewrite:"
+
+Adding new features with each release is not sustainable. This release *removes*
+features, but makes it possible to add them back as addons. We can also remove
+some complexity by relying on the better default functionality provided by newer
+versions of Active Support and Active Record.
+
+Here's what's changed:
+
+## New configuration and setup
+
+FriendlyId is no longer added to Active Record by default, you must explicitly
+add it to each model you want to use it in. The method and options have also
+changed:
+
+    # FriendlyId 3
+    class Post < ActiveRecord::Base
+      has_friendly_id :title, :use_slugs => true
+    end
+
+    # FriendlyId 4
+    class Post < ActiveRecord::Base
+      extend FriendlyId
+      friendly_id :title, :use => :slugged
+    end
+
+It also adds a new "defaults" method for configuring all models:
+
+    FriendlyId.defaults do |config|
+      config.use :slugged, :reserved
+      config.base = :name
+    end
+
+## Active Record 3+ only
+
+For 2.3 support, you can use FriendlyId 3.x, which will continue to be maintained
+until people don't want it any more.
+
+## In-table slugs
+
+FriendlyId no longer creates a separate slugs table - it just stores the
+generated slug value in the model table, which is simpler, faster and what most
+want by default. Keeping slug history in a separate table is an
+{FriendlyId::Slugged optional add-on} for FriendlyId 4.
+
+## No more multiple finds
+
+    Person.find "joe-schmoe"               # Supported
+    Person.find ["joe-schmoe", "john-doe"] # No longer supported
+
+If you want find by more than one friendly id, build your own query:
+
+    Person.where(:slug => ["joe-schmoe", "john-doe"])
+
+This lets us do *far* less monkeypatching in Active Record. How much less?
+FriendlyId overrides the base find with a mere 2 lines of code, and otherwise
+changes nothing else. This means more stability and less breakage between Rails
+updates.
+
+## No more finder status
+
+FriendlyId 3 offered finder statuses to help you determine when an outdated
+or non-friendly id was used to find the record, so that you could decide whether
+to permanently redirect to the canonical URL. However, there's a simpler way to
+do that, so this feature has been removed:
+
+    if request.path != person_path(@person)
+      return redirect_to @person, :status => :moved_permanently
+    end
+
+## Bye-bye Babosa
+
+[Babosa](http://github.com/norman/babosa) is FriendlyId 3's slugging library.
+
+FriendlyId 4 doesn't use it by default because the most important pieces of it
+were already accepted into Active Support 3.
+
+However, Babosa is still useful, for example, for idiomatically transliterating
+Cyrillic ([or other
+language](https://github.com/norman/babosa/tree/master/lib/babosa/transliterator))
+strings to ASCII. It's very easy to include - just override
+`#normalize_friendly_id` in your model:
+
+    class MyModel < ActiveRecord::Base
+      ...
+
+      def normalize_friendly_id(text)
+        text.to_slug.normalize! :transliterate => :russian
+      end
+    end