friendly_id 4.0.0 → 4.0.1

data/README.md

@@ -3,10 +3,10 @@
 [![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
+Ruby on Rails. It allows you to create pretty URLs 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:
+Using FriendlyId, it's easy to make your application use URLs like:
 
     http://example.com/states/washington
 
@@ -18,9 +18,10 @@ instead of:
 ## FriendlyId Features
 
 FriendlyId offers many advanced features, including: slug history and
-versioning, i18n, scoped slugs, reserved words, and custom slug generators.
+versioning, i18n, Globalize support, scoped slugs, reserved words, and custom
+slug generators.
 
-FriendlyId is compatible with Active Record **3.0**, **3.1** and **3.2**
+FriendlyId is compatible with Active Record **3.0** and higher.
 
 ## Version 4.x
 
@@ -38,6 +39,8 @@ The best place to start is with the
 [Guide](http://rubydoc.info/github/norman/friendly_id/master/file/Guide.rdoc),
 which compiles the top-level RDocs into one outlined document.
 
+You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid).
+
 ## Rails Quickstart
 
     gem install friendly_id
@@ -46,22 +49,22 @@ which compiles the top-level RDocs into one outlined document.
 
     cd my_app
 
-    gem "friendly_id", "~> 4.0.0"
+    gem "friendly_id", "~> 4.0.1"
 
     rails generate scaffold user name:string slug:string
 
     # edit db/migrate/*_create_users.rb
-    add_index :users, :slug, :unique => true
+    add_index :users, :slug, unique: true
 
     rake db:migrate
 
     # edit app/models/user.rb
     class User < ActiveRecord::Base
       extend FriendlyId
-      friendly_id :name, :use => :slugged
+      friendly_id :name, use: :slugged
     end
 
-    User.create! :name => "Joe Schmoe"
+    User.create! name: "Joe Schmoe"
 
     rails server
 
@@ -87,13 +90,16 @@ 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.
+* Full stack trace and error message (if you have them).
 * 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,
 and add a test that reproduces the error you are experiencing.
 
+For more info on how to report bugs, please see [this
+article](http://yourbugreportneedsmore.info/).
+
 ## Thanks and Credits
 
 FriendlyId was originally created by Norman Clarke and Adrian Mugnolo, with
@@ -105,7 +111,7 @@ Part of the inspiration to rework FriendlyId came from Darcy Laycock's library
 [Slugged](https://github.com/Sutto/slugged), which he was inspired to create
 because of frustrations he experienced while using FriendlyId 3.x. Seeing a
 smart programmer become frustrated with my code was enough of a kick in the
-butt to make me want to improve this library significantly.
+butt to make me want to significantly improve this library.
 
 Many thanks to him for providing valid, real criticism while still being a cool
 about it. I definitely recommend you check out his library if for some reason
@@ -122,7 +128,7 @@ should be!
 
 ## License
 
-Copyright (c) 2008-2011 Norman Clarke, released under the MIT license.
+Copyright (c) 2008-2012 Norman Clarke, released under the MIT license.
 
 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

data/Rakefile

@@ -68,7 +68,7 @@ namespace :db do
     driver = FriendlyId::Test::Database.driver
     config = FriendlyId::Test::Database.config[driver]
     commands = {
-      "mysql"    => "mysql -e 'create database #{config["database"]};' >/dev/null",
+      "mysql"    => "mysql -u #{config['username']} -e 'create database #{config["database"]};' >/dev/null",
       "postgres" => "psql -c 'create database #{config['database']};' -U #{config['username']} >/dev/null"
     }
     %x{#{commands[driver] || true}}
@@ -80,7 +80,7 @@ namespace :db do
     driver = FriendlyId::Test::Database.driver
     config = FriendlyId::Test::Database.config[driver]
     commands = {
-      "mysql"    => "mysql -e 'drop database #{config["database"]};' >/dev/null",
+      "mysql"    => "mysql -u #{config['username']} -e 'drop database #{config["database"]};' >/dev/null",
       "postgres" => "psql -c 'drop database #{config['database']};' -U #{config['username']} >/dev/null"
     }
     %x{#{commands[driver] || true}}

data/friendly_id.gemspec

@@ -8,28 +8,27 @@ Gem::Specification.new do |s|
   s.version           = FriendlyId::VERSION
   s.authors           = ["Norman Clarke"]
   s.email             = ["norman@njclarke.com"]
-  s.homepage          = "http://norman.github.com/friendly_id"
+  s.homepage          = "http://github.com/norman/friendly_id"
   s.summary           = "A comprehensive slugging and pretty-URL plugin."
   s.rubyforge_project = "friendly_id"
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files -- {test}/*`.split("\n")
   s.require_paths     = ["lib"]
 
-  s.add_development_dependency "railties", "~> 3.1.0"
-  s.add_development_dependency "activerecord", "~> 3.1.0"
-  s.add_development_dependency "sqlite3", "~> 1.3.4"
-  s.add_development_dependency "minitest", "~> 2.4.0"
-  s.add_development_dependency "mocha", "~> 0.9.12"
-  s.add_development_dependency "ffaker", "~> 1.8.0"
-  s.add_development_dependency "maruku", "~> 0.6.0"
-  s.add_development_dependency "yard", "~> 0.7.2"
-  s.add_development_dependency "i18n", "~> 0.6.0"
+  s.add_development_dependency "railties", "~> 3.2.0"
+  s.add_development_dependency "activerecord", "~> 3.2.0"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "maruku"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "i18n"
+  s.add_development_dependency "ffaker"
   s.add_development_dependency "simplecov"
 
   s.description = <<-EOM
 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.
+Ruby on Rails. It allows you to create pretty URLs and work with human-friendly
+strings as if they were numeric ids for Active Record models.
 EOM
 
   s.post_install_message = <<-EOM

data/gemfiles/Gemfile.rails-3.0.rb

@@ -1,19 +1,20 @@
 source :rubygems
 
-# platform :jruby do
-#   gem "activerecord-jdbcmysql-adapter"
-#   gem "activerecord-jdbcpostgresql-adapter"
-#   gem "activerecord-jdbcsqlite3-adapter"
-# end
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+  gem 'jruby-openssl'
+end
 
-platform :ruby do
-  gem "mysql2", "~> 0.2.0"
-  gem "pg", "~> 0.11.0"
-  gem "sqlite3", "~> 1.3.4"
+platforms :ruby do
+  gem 'sqlite3'
+  gem 'mysql2', '~> 0.2.0'
+  gem 'pg'
 end
 
-gem "activerecord", "~> 3.0.10"
-gem "minitest", "~> 2.4.0"
-gem "mocha", "~> 0.9.12"
-gem "railties", "~> 3.0.10"
-gem "rake"
+gem 'activerecord', '~> 3.0.0'
+gem 'railties', '~> 3.0.0'
+gem 'minitest'
+gem 'mocha'
+gem 'rake'

data/gemfiles/Gemfile.rails-3.1.rb

@@ -1,21 +1,21 @@
 source :rubygems
 
-# platform :jruby do
-#   gem "activerecord-jdbc-adapter", :git => "https://github.com/nicksieger/activerecord-jdbc-adapter.git"
-#   gem "activerecord-jdbcmysql-adapter"
-#   gem "activerecord-jdbcpostgresql-adapter"
-#   gem "activerecord-jdbcsqlite3-adapter"
-# end
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+  gem 'jruby-openssl'
+end
 
-platform :ruby do
-  gem "mysql2", "~> 0.3.6"
-  gem "pg", "~> 0.11.0"
-  gem "sqlite3", "~> 1.3.4"
+platforms :ruby do
+  gem 'sqlite3'
+  gem 'mysql2'
+  gem 'pg'
 end
 
-gem "ffaker"
-gem "activerecord", "~> 3.1.3"
-gem "minitest", "~> 2.4.0"
-gem "mocha", "~> 0.9.12"
-gem "railties", "~> 3.1.3"
-gem "rake"
+gem 'activerecord', '~> 3.1.0'
+gem 'railties', '~> 3.1.3'
+gem 'ffaker'
+gem 'minitest'
+gem 'mocha'
+gem 'rake'

data/gemfiles/Gemfile.rails-3.2.rb

@@ -1,21 +1,21 @@
 source :rubygems
 
-# platform :jruby do
-#   gem "activerecord-jdbc-adapter", :git => "https://github.com/nicksieger/activerecord-jdbc-adapter.git"
-#   gem "activerecord-jdbcmysql-adapter"
-#   gem "activerecord-jdbcpostgresql-adapter"
-#   gem "activerecord-jdbcsqlite3-adapter"
-# end
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+  gem 'jruby-openssl'
+end
 
-platform :ruby do
-  gem "mysql2", "~> 0.3.6"
-  gem "pg", "~> 0.11.0"
-  gem "sqlite3", "~> 1.3.4"
+platforms :ruby do
+  gem 'sqlite3'
+  gem 'mysql2'
+  gem 'pg'
 end
 
-gem "ffaker"
-gem "activerecord", "~> 3.2.0.rc1"
-gem "minitest", "~> 2.4.0"
-gem "mocha", "~> 0.9.12"
-gem "railties", "~> 3.2.0.rc1"
-gem "rake"
+gem 'ffaker'
+gem 'activerecord', '~> 3.2.0'
+gem 'railties', '~> 3.2.0'
+gem 'minitest'
+gem 'mocha'
+gem 'rake'

data/lib/friendly_id.rb

@@ -45,7 +45,7 @@ with numeric ids:
 module FriendlyId
 
   # The current version.
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 
   @mutex = Mutex.new
 
@@ -54,6 +54,7 @@ module FriendlyId
   autoload :Reserved,   "friendly_id/reserved"
   autoload :Scoped,     "friendly_id/scoped"
   autoload :Slugged,    "friendly_id/slugged"
+  autoload :Globalize,  "friendly_id/globalize"
 
   # FriendlyId takes advantage of `extended` to do basic model setup, primarily
   # extending {FriendlyId::Base} to add {FriendlyId::Base#friendly_id

data/lib/friendly_id/base.rb

@@ -9,7 +9,7 @@ method to configure your desired options:
 
     class Foo < ActiveRecord::Base
       extend FriendlyId
-      friendly_id bar, :use => [:slugged, :simple_i18n]
+      friendly_id :bar, :use => [:slugged, :simple_i18n]
     end
 
 The most important option is `:use`, which you use to tell FriendlyId which

data/lib/friendly_id/globalize.rb

@@ -0,0 +1,102 @@
+require 'i18n'
+
+module FriendlyId
+
+=begin
+
+== Translate slug db column using Globalize
+
+The {FriendlyId::Globalize Globalize} module allow to use
+Globalize (https://github.com/svenfuchs/globalize3) to translate slugs.
+
+In order to use this module, your model must have a slug column and set the
+field +slug+ translable with Globalize:
+
+    class Post < ActiveRecord::Base
+      translates :title, :slug
+      extend FriendlyId
+      friendly_id :title, :use => :globalize
+    end
+
+=== Finds
+
+Finds will take into consideration the current locale:
+
+  I18n.locale = :it
+  Post.find("guerre-stellari")
+  I18n.locale = :en
+  Post.find("star-wars")
+
+To find a slug by an explicit locale, perform the find inside a block
+passed to I18n's +with_locale+ method:
+
+  I18n.with_locale(:it) do
+    Post.find("guerre-stellari")
+  end
+
+=== Creating Records
+
+When new records are created, the slug is generated for the current locale only.
+
+=== Translating Slugs
+
+To translate an existing record's friendly_id, simply change locale and assign
++slug+ field:
+
+  I18n.with_locale(:it) do
+    post.slug = "guerre-stellari"
+  end
+
+=end
+  module Globalize
+
+    def self.included(model_class)
+      model_class.instance_eval do
+        friendly_id_config.use :slugged
+        relation_class.send :include, FinderMethods
+        include Model
+        # Check if slug field is enabled to be translated with Globalize
+        if table_exists?
+          if columns.map(&:name).exclude?(friendly_id_config.query_field)
+            puts "\n[FriendlyId] Missing field '#{friendly_id_config.query_field}' in DB table '#{table_name}'. This is required for FriendlyId to properly function with the :globalize option.\n\n"
+          end
+          unless respond_to?('translated_attribute_names') || translated_attribute_names.exclude?(friendly_id_config.query_field.to_sym)
+            puts "\n[FriendlyId] You need to translate '#{friendly_id_config.query_field}' field with Globalize (add 'translates :#{friendly_id_config.query_field}' in your model '#{self.class.name}')\n\n"
+          end
+        end
+      end
+    end
+
+    module Model
+      def slug=(text)
+        set_slug(normalize_friendly_id(text))
+      end
+    end
+
+    module FinderMethods
+      # FriendlyId overrides this method to make it possible to use friendly id's
+      # identically to numeric ids in finders.
+      #
+      # @example
+      #  person = Person.find(123)
+      #  person = Person.find("joe")
+      #
+      # @see FriendlyId::ObjectUtils
+      def find_one(id)
+        return super if id.unfriendly_id?
+        where(@klass.friendly_id_config.query_field => id).first or
+        joins(:translations).
+          where(translation_class.arel_table[:locale].eq(I18n.locale)).
+          where(translation_class.arel_table[@klass.friendly_id_config.query_field].eq(id)).first or
+        # if locale is not translated fallback to default locale
+        joins(:translations).
+          where(translation_class.arel_table[:locale].eq(I18n.default_locale)).
+          where(translation_class.arel_table[@klass.friendly_id_config.query_field].eq(id)).first or
+        super
+      end
+
+      protected :find_one
+
+    end
+  end
+end

data/lib/friendly_id/history.rb

@@ -65,20 +65,21 @@ method.
         @friendly_id_config.use :slugged
         has_many :slugs, :as => :sluggable, :dependent => :destroy,
           :class_name => Slug.to_s, :order => "#{Slug.quoted_table_name}.id DESC"
-        before_save :build_slug
+        after_save :create_slug
         relation_class.send :include, FinderMethods
+        friendly_id_config.slug_generator_class.send :include, SlugGenerator
       end
     end
 
     private
 
-    def build_slug
-      return unless should_generate_new_friendly_id?
+    def create_slug
+      return if slugs.first.try(:slug) == friendly_id
       # Allow reversion back to a previously used slug
       relation = slugs.where(:slug => friendly_id)
       result = relation.select("id").lock(true).all
       relation.delete_all unless result.empty?
-      slugs.build :slug => friendly_id
+      slugs.create! :slug => friendly_id
     end
 
     # Adds a finder that explictly uses slugs from the slug table.
@@ -110,5 +111,24 @@ method.
         yield sluggable_id if sluggable_id
       end
     end
+
+    # This module overrides {FriendlyId::SlugGenerator#conflicts} to consider
+    # all historic slugs for that model.
+    module SlugGenerator
+
+      private
+
+      def conflicts
+        sluggable_class = friendly_id_config.model_class
+        pkey            = sluggable_class.primary_key
+        value           = sluggable.send pkey
+        # TODO this is a bit of a performance drain right now; optimize before next release.
+        scope = sluggable_class.unscoped.includes(:slugs).where("#{Slug.quoted_table_name}.slug = ? OR #{Slug.quoted_table_name}.slug LIKE ?", normalized, wildcard)
+        scope = scope.where(Slug.table_name => {:sluggable_type => sluggable_class.name})
+        scope = scope.where("#{sluggable_class.table_name}.#{pkey} <> ?", value) unless sluggable.new_record?
+        scope.order("LENGTH(#{Slug.quoted_table_name}.slug) DESC, #{Slug.quoted_table_name}.slug DESC")
+      end
+
+    end
   end
 end