friendly_id 4.0.7 → 4.0.8

data/Changelog.md

@@ -6,6 +6,24 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
+## 4.0.8 (2012-08-01)
+
+* Name internal anonymous class to fix marshall dump/load error (Jess Brown, Philip Arndt and Norman Clarke).
+
+* Avoid using deprecated `update_attribute` (Philip Arndt).
+
+* Added set_friendly_id method to Globalize module (Norman Clarke).
+
+* autoload FriendlyId::Slug; previously this class was not accessible from
+  migrations unless required explicitly, which could cause some queries to
+  unexpectedly fail (Norman Clarke).
+
+* Fix Mocha load order (Mark Turner).
+
+* Minor doc updates (Rob Yurkowski).
+
+* Other miscellaneous refactorings and doc updates.
+
 ## 4.0.7 (2012-06-06)
 
 * to_param just calls super when no friendly_id is present, to keep the model's

data/Guide.rdoc

@@ -480,8 +480,9 @@ languages. If your application only needs to be localized to one or two
 languages, you may wish to consider the {FriendlyId::SimpleI18n SimpleI18n}
 module.
 
-In order to use this module, your model must have a slug column and set the
-field +slug+ as translable with Globalize:
+In order to use this module, your model's table and translation table must both
+have a slug column, and your model must set the +slug+ field as translatable
+with Globalize:
 
     class Post < ActiveRecord::Base
       translates :title, :slug
@@ -549,4 +550,4 @@ For example:
     def move_friendly_id_error_to_name
       errors.messages[:name] = errors.messages.delete(:friendly_id)
     end
-  end
+  end

data/README.md

@@ -128,7 +128,8 @@ should be!
 
 ## License
 
-Copyright (c) 2008-2012 Norman Clarke, released under the MIT license.
+Copyright (c) 2008-2012 Norman Clarke and contributors, 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/friendly_id.gemspec

@@ -6,8 +6,8 @@ require "friendly_id"
 Gem::Specification.new do |s|
   s.name              = "friendly_id"
   s.version           = FriendlyId::VERSION
-  s.authors           = ["Norman Clarke"]
-  s.email             = ["norman@njclarke.com"]
+  s.authors           = ["Norman Clarke", "Philip Arndt"]
+  s.email             = ["norman@njclarke.com", "parndt@gmail.com"]
   s.homepage          = "http://github.com/norman/friendly_id"
   s.summary           = "A comprehensive slugging and pretty-URL plugin."
   s.rubyforge_project = "friendly_id"
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   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 "minitest", "3.2.0"
   s.add_development_dependency "mocha"
   s.add_development_dependency "maruku"
   s.add_development_dependency "yard"

data/gemfiles/Gemfile.rails-3.0.rb

@@ -15,7 +15,7 @@ end
 
 gem 'activerecord', '~> 3.0.0'
 gem 'railties', '~> 3.0.0'
-gem 'minitest'
+gem 'minitest', '3.2.0'
 gem 'mocha'
 gem 'rake'
 gem 'globalize3'

data/gemfiles/Gemfile.rails-3.1.rb

@@ -16,7 +16,7 @@ end
 gem 'activerecord', '~> 3.1.0'
 gem 'railties', '~> 3.1.3'
 gem 'ffaker'
-gem 'minitest'
+gem 'minitest', '3.2.0'
 gem 'mocha'
 gem 'rake'
 gem 'globalize3'

data/gemfiles/Gemfile.rails-3.2.rb

@@ -16,7 +16,7 @@ end
 gem 'ffaker'
 gem 'activerecord', '~> 3.2.0'
 gem 'railties', '~> 3.2.0'
-gem 'minitest'
+gem 'minitest', '3.2.0'
 gem 'mocha'
 gem 'rake'
 gem 'globalize3'

data/lib/friendly_id/base.rb

@@ -199,11 +199,9 @@ often better and easier to use {FriendlyId::Slugged slugs}.
     #   on first access. If you're concerned about thread safety, then be sure
     #   to invoke {#friendly_id} in your class for each model.
     def friendly_id_config
-      @friendly_id_config or begin
-        @friendly_id_config = base_class.friendly_id_config.dup.tap do |config|
-          config.model_class = self
-          @relation_class = base_class.send(:relation_class)
-        end
+      @friendly_id_config ||= base_class.friendly_id_config.dup.tap do |config|
+        config.model_class = self
+        @relation_class = base_class.send(:relation_class)
       end
     end
 
@@ -217,13 +215,13 @@ often better and easier to use {FriendlyId::Slugged slugs}.
       super
     end
 
-    # Gets an anonymous subclass of the model's relation class.
+    # Gets (and if necessary, creates) a subclass of the model's relation class.
     #
     # Rather than including FriendlyId's overridden finder methods in
-    # ActiveRecord::Relation directly, FriendlyId adds them to the anonymous
-    # subclass, and makes #relation return an instance of this class. By doing
-    # this, we ensure that only models that specifically extend FriendlyId have
-    # their finder methods overridden.
+    # ActiveRecord::Relation directly, FriendlyId adds them to a subclass
+    # specific to the AR model, and makes #relation return an instance of this
+    # class. By doing this, we ensure that only models that specifically extend
+    # FriendlyId have their finder methods overridden.
     #
     # Note that this method does not directly subclass ActiveRecord::Relation,
     # but rather whatever class the @relation class instance variable is an
@@ -240,10 +238,16 @@ often better and easier to use {FriendlyId::Slugged slugs}.
     # revert back to the old behavior of simply extending
     # ActiveRecord::Relation.
     def relation_class
-      @relation_class ||= Class.new(relation_without_friendly_id.class) do
-        alias_method :find_one_without_friendly_id, :find_one
-        alias_method :exists_without_friendly_id?, :exists?
-        include FriendlyId::FinderMethods
+      @relation_class or begin
+        @relation_class = Class.new(relation_without_friendly_id.class) do
+          alias_method :find_one_without_friendly_id, :find_one
+          alias_method :exists_without_friendly_id?, :exists?
+          include FriendlyId::FinderMethods
+        end
+        # Set a name so that model instances can be marshalled. Use a
+        # ridiculously long name that will not conflict with anything.
+        # TODO: just use the constant, no need for the @relation_class variable.
+        const_set('FriendlyIdActiveRecordRelation', @relation_class)
       end
     end
   end

data/lib/friendly_id/globalize.rb

@@ -13,8 +13,9 @@ languages. If your application only needs to be localized to one or two
 languages, you may wish to consider the {FriendlyId::SimpleI18n SimpleI18n}
 module.
 
-In order to use this module, your model must have a slug column and set the
-field +slug+ as translable with Globalize:
+In order to use this module, your model's table and translation table must both
+have a slug column, and your model must set the +slug+ field as translatable
+with Globalize:
 
     class Post < ActiveRecord::Base
       translates :title, :slug
@@ -31,12 +32,15 @@ Finds will take the current locale into consideration:
   I18n.locale = :en
   Post.find("star-wars")
 
+Additionally, finds will fall back to the default locale:
+
+  I18n.locale = :it
+  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
+  I18n.with_locale(:it) { Post.find("guerre-stellari") }
 
 === Creating Records
 
@@ -44,12 +48,17 @@ 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 the locale and
-assign a value to the +slug+ field:
+To translate an existing record's friendly_id, use
+{FriendlyId::Globalize::Model#set_friendly_id}. This will ensure that the slug
+you add is properly escaped, transliterated and sequenced:
 
-  I18n.with_locale(:it) do
-    post.slug = "guerre-stellari"
-  end
+  post = Post.create :name => "Star Wars"
+  post.set_friendly_id("Guerre stellari", :it)
+
+If you don't pass in a locale argument, FriendlyId::Globalize will just use the
+current locale:
+
+  I18n.with_locale(:it) { post.set_friendly_id("Guerre stellari") }
 
 =end
   module Globalize
@@ -67,8 +76,10 @@ assign a value to the +slug+ field:
     end
 
     module Model
-      def slug=(text)
-        set_slug(normalize_friendly_id(text))
+      def set_friendly_id(text, locale)
+        I18n.with_locale(locale || I18n.locale) do
+          set_slug(normalize_friendly_id(text))
+        end
       end
     end
 

data/lib/friendly_id/history.rb

@@ -1,5 +1,3 @@
-require "friendly_id/slug"
-
 module FriendlyId
 
 =begin

data/lib/friendly_id/simple_i18n.rb

@@ -65,7 +65,7 @@ If you don't pass in a locale argument, FriendlyId::SimpleI18n will just use the
 current locale:
 
   I18n.with_locale(:es) do
-    post.set_friendly_id("la-guerra-de-las-galaxas")
+    post.set_friendly_id("La guerra de las galaxas")
   end
 =end
   module SimpleI18n

data/lib/friendly_id.rb

@@ -45,11 +45,12 @@ with numeric ids:
 module FriendlyId
 
   # The current version.
-  VERSION = "4.0.7"
+  VERSION = "4.0.8"
 
   @mutex = Mutex.new
 
   autoload :History,    "friendly_id/history"
+  autoload :Slug,       "friendly_id/slug"
   autoload :SimpleI18n, "friendly_id/simple_i18n"
   autoload :Reserved,   "friendly_id/reserved"
   autoload :Scoped,     "friendly_id/scoped"

data/test/core_test.rb

@@ -1,13 +1,14 @@
 require "helper"
 
-class Author < ActiveRecord::Base
+class Book < ActiveRecord::Base
   extend FriendlyId
   friendly_id :name
 end
 
-class Book < ActiveRecord::Base
+class Author < ActiveRecord::Base
   extend FriendlyId
   friendly_id :name
+  has_many :books
 end
 
 class CoreTest < MiniTest::Unit::TestCase
@@ -32,4 +33,16 @@ class CoreTest < MiniTest::Unit::TestCase
   test "instances should have a friendly id" do
     with_instance_of(model_class) {|record| assert record.friendly_id}
   end
+
+  test "instances can be marshaled when a relationship is used" do
+    transaction do
+      author = Author.create :name => 'Philip'
+      author.books.create :name => 'my book'
+      begin
+        assert Marshal.load(Marshal.dump(author))
+      rescue TypeError => e
+        flunk(e.to_s)
+      end
+    end
+  end
 end

data/test/globalize_test.rb

@@ -11,7 +11,11 @@ end
 class GlobalizeTest < MiniTest::Unit::TestCase
   include FriendlyId::Test
 
-  test "friendly_id should find slug in current locale if locale is set, otherwise in default locale" do
+  def setup
+    I18n.locale = :en
+  end
+
+  test "should find slug in current locale if locale is set, otherwise in default locale" do
     transaction do
       I18n.default_locale = :en
       article_en = I18n.with_locale(:en) { TranslatedArticle.create(:title => 'a title') }
@@ -24,6 +28,17 @@ class GlobalizeTest < MiniTest::Unit::TestCase
     end
   end
 
+  test "should set friendly id for locale" do
+    transaction do
+      article = TranslatedArticle.create!(:title => "War and Peace")
+      article.set_friendly_id("Guerra y paz", :es)
+      article.save!
+      article = TranslatedArticle.find('war-and-peace')
+      I18n.with_locale(:es) { assert_equal "guerra-y-paz", article.friendly_id }
+      I18n.with_locale(:en) { assert_equal "war-and-peace", article.friendly_id }
+    end
+  end
+
   # https://github.com/svenfuchs/globalize3/blob/master/test/globalize3/dynamic_finders_test.rb#L101
   # see: https://github.com/svenfuchs/globalize3/issues/100
   test "record returned by friendly_id should have all translations" do

data/test/helper.rb

@@ -1,7 +1,7 @@
 require "rubygems"
 require "bundler/setup"
-require "mocha"
 require "minitest/unit"
+require "mocha"
 require "active_record"
 require 'active_support/core_ext/time/conversions'
 
@@ -84,4 +84,4 @@ end
 require "schema"
 require "shared"
 FriendlyId::Test::Database.connect
-at_exit {ActiveRecord::Base.connection.disconnect!}
+at_exit {ActiveRecord::Base.connection.disconnect!}

data/test/schema.rb

@@ -54,17 +54,20 @@ module FriendlyId
           # This will be used to test globalize translations
           TranslatedArticle.create_translation_table! :slug => :string, :title => :string
 
+          # This will be used to test relationships
+          add_column :books, :author_id, :integer
+
           @done = true
         end
 
         private
 
         def slugged_tables
-          ["journalists", "articles", "novelists", "novels", "manuals", "translated_articles"]
+          %w[journalists articles novelists novels manuals translated_articles]
         end
 
         def simple_tables
-          ["authors", "books", "publishers"]
+          %w[authors books publishers]
         end
 
         def tables

data/test/shared.rb

@@ -55,7 +55,7 @@ module FriendlyId
           my_model_class = Class.new(model_class)
           self.class.const_set("Foo", my_model_class)
           with_instance_of my_model_class do |record|
-            record.update_attribute(my_model_class.friendly_id_config.slug_column, nil)
+            record.update_attributes my_model_class.friendly_id_config.slug_column => nil
             record = my_model_class.find(record.id)
             record.class.validate Proc.new {errors[:name] = "FAIL"}
             record.save

data/test/simple_i18n_test.rb

@@ -8,6 +8,10 @@ class SimpleI18nTest < MiniTest::Unit::TestCase
     friendly_id :name, :use => :simple_i18n
   end
 
+  def setup
+    I18n.locale = :en
+  end
+
   test "friendly_id should return the current locale's slug" do
     journalist = Journalist.new(:name => "John Doe")
     journalist.slug_es = "juan-fulano"

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 4.0.7
+  version: 4.0.8
   prerelease: 
 platform: ruby
 authors:
 - Norman Clarke
+- Philip Arndt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -48,17 +49,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +182,7 @@ description: ! 'FriendlyId is the "Swiss Army bulldozer" of slugging and permali
 '
 email:
 - norman@njclarke.com
+- parndt@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -258,12 +260,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4530033734929849472
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4530033734929849472
 requirements: []
 rubyforge_project: friendly_id
 rubygems_version: 1.8.24