friendly_id4 4.0.0.beta5 → 4.0.0.beta6

data/README.md

@@ -12,6 +12,7 @@ instead of:
 
     http://example.com/states/4323454
 
+
 ## FriendlyId Features
 
 FriendlyId offers many advanced features, including: slug history and
@@ -51,8 +52,12 @@ FriendlyId is compatible with Active Record **3.0** and **3.1**.
 
     GET http://localhost:3000/users/joe-schmoe
 
+## Docs
+
+The current docs can be found
+[here](http://rdoc.info/github/norman/friendly_id/a4128af31d85ee29ad8f/frames).
 
-### Future Compatibility
+## Future Compatibility
 
 FriendlyId will always remain compatible with the current release of Rails, and
 at least one stable release behind. That means that support for 3.0.x will not be

data/Rakefile

@@ -11,7 +11,7 @@ def rubies(&block)
 end
 
 def versions(&block)
-  ["3.1.0.rc4", "3.0.9"].each do |version|
+  ["3.1.0.rc5", "3.0.9"].each do |version|
     old = ENV["AR"]
     ENV["AR"] = version
     yield
@@ -20,9 +20,10 @@ def versions(&block)
 end
 
 def adapters(&block)
-  ["mysql", "postgres", "sqlite3"].each do |adapter|
+  ["mysql", "mysql2", "postgres", "sqlite3"].each do |adapter|
     old = ENV["DB"]
     ENV["DB"] = adapter
+    ENV["DB_VERSION"] = "~> 0.3.6" if adapter == "mysql2" && ENV["AR"] && ENV["AR"][0..2] >= "3.1"
     yield
     ENV["DB"] = old
   end

data/lib/friendly_id.rb

@@ -81,7 +81,7 @@ In general, use slugs by default unless you know for sure you don't need them.
 module FriendlyId
 
   # The current version.
-  VERSION = "4.0.0.beta5"
+  VERSION = "4.0.0.beta6"
 
   @mutex = Mutex.new
 
@@ -125,6 +125,8 @@ module FriendlyId
 
   # Set global defaults for all models using FriendlyId.
   #
+  # The default defaults are to use the +:reserved+ module and nothing else.
+  #
   # @example
   #   FriendlyId.defaults do |config|
   #     config.base = :name
@@ -133,7 +135,7 @@ module FriendlyId
   def self.defaults(&block)
     @mutex.synchronize do
       @defaults = block if block_given?
+      @defaults ||= lambda {|config| config.use :reserved}
     end
-    @defaults
   end
 end

data/lib/friendly_id/base.rb

@@ -13,8 +13,8 @@ module FriendlyId
     # of {FriendlyId::Configuration} to the block before evaluating other
     # arguments, so configuration values set in the block may be overwritten by
     # the arguments. This order was chosen to allow passing the same proc to
-    # multiple models, while being able to override the values it sets. Here
-    # is a contrived example:
+    # multiple models, while being able to override the values it sets. Here is
+    # a contrived example:
     #
     #   $friendly_id_config_proc = Proc.new do |config|
     #     config.base = :name
@@ -52,6 +52,33 @@ module FriendlyId
     # between multiple models that can't be well encapsulated by
     # {FriendlyId.defaults}.
     #
+    # === Order Method Calls in a Block vs Ordering Options
+    #
+    # When calling this method without a block, you may set the hash options in
+    # any order.
+    #
+    # However, when using block-style invocation, be sure to call
+    # FriendlyId::Configuration's {FriendlyId::Configuration#use use} method
+    # *prior* to the associated configuration options, because it will include
+    # modules into your class, and these modules in turn may add required
+    # configuration options to the +@friendly_id_configuraton+'s class:
+    #
+    #   class Person < ActiveRecord::Base
+    #     friendly_id do |config|
+    #       # This will work
+    #       config.use :slugged
+    #       config.sequence_separator = ":"
+    #     end
+    #   end
+    #
+    #   class Person < ActiveRecord::Base
+    #     friendly_id do |config|
+    #       # This will fail
+    #       config.sequence_separator = ":"
+    #       config.use :slugged
+    #     end
+    #   end
+    #
     # @option options [Symbol] :use The name of an addon to use. By default,
     #   FriendlyId provides {FriendlyId::Slugged :slugged},
     #   {FriendlyId::History :history}, {FriendlyId::Reserved :reserved}, and
@@ -94,8 +121,14 @@ module FriendlyId
     end
 
     # Returns the model class's {FriendlyId::Configuration friendly_id_config}.
+    # @note In the case of Single Table Inheritance (STI), this method will
+    #   duplicate the parent class's FriendlyId::Configuration instance 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
+      @friendly_id_config or begin
+       @friendly_id_config = base_class.friendly_id_config.dup
+      end
     end
   end
 end

data/lib/friendly_id/history.rb

@@ -42,7 +42,7 @@ record's friendly_id changes, your URL's won't break.
         has_many :friendly_id_slugs, :as => :sluggable, :dependent => :destroy
         before_save :build_friendly_id_slug, :if => lambda {|r| r.slug_sequencer.slug_changed?}
         scope :with_friendly_id, lambda {|id| includes(:friendly_id_slugs).where("friendly_id_slugs.slug = ?", id)}
-        extend  Finder
+        extend Finder
       end
     end
 

data/test/config/mysql2.yml

@@ -0,0 +1,5 @@
+adapter: mysql2
+database: friendly_id_test
+username: root
+hostname: localhost
+encoding: utf8

data/test/core_test.rb

@@ -10,7 +10,7 @@ end
 class CoreTest < MiniTest::Unit::TestCase
 
   include FriendlyId::Test
-  include FriendlyId::Test::Shared
+  include FriendlyId::Test::Shared::Core
 
   def model_class
     Author

data/test/history_test.rb

@@ -8,7 +8,7 @@ end
 class HistoryTest < MiniTest::Unit::TestCase
 
   include FriendlyId::Test
-  include FriendlyId::Test::Shared
+  include FriendlyId::Test::Shared::Core
 
   def model_class
     Manual

data/test/schema.rb

@@ -32,6 +32,9 @@ module FriendlyId
 
           # This will be used to test column name quoting
           add_column :journalists, "strange name", :string
+
+          # This will be used to test STI
+          add_column :journalists, "type", :string
         end
 
         private

data/test/scoped_test.rb

@@ -14,7 +14,7 @@ end
 class ScopedTest < MiniTest::Unit::TestCase
 
   include FriendlyId::Test
-  include FriendlyId::Test::Shared
+  include FriendlyId::Test::Shared::Core
 
   def model_class
     Novel

data/test/shared.rb

@@ -2,72 +2,114 @@ module FriendlyId
   module Test
     module Shared
 
-      test "finds should respect conditions" do
-        with_instance_of(model_class) do |record|
-          assert_raises(ActiveRecord::RecordNotFound) do
-            model_class.where("1 = 2").find record.friendly_id
+      module Slugged
+        test "configuration should have a sequence_separator" do
+          assert !model_class.friendly_id_config.sequence_separator.empty?
+        end
+
+        test "should make a new slug if the friendly_id method value has changed" do
+          with_instance_of model_class do |record|
+            record.name = "Changed Value"
+            record.save!
+            assert_equal "changed-value", record.slug
           end
         end
-      end
 
-      test "should be findable by friendly id" do
-        with_instance_of(model_class) {|record| assert model_class.find record.friendly_id}
-      end
+        test "should increment the slug sequence for duplicate friendly ids" do
+          with_instance_of model_class do |record|
+            record2 = model_class.create! :name => record.name
+            assert record2.friendly_id.match(/2\z/)
+          end
+        end
 
-      test "should be findable by id as integer" do
-        with_instance_of(model_class) {|record| assert model_class.find record.id.to_i}
-      end
+        test "should not add slug sequence on update after other conflicting slugs were added" do
+          with_instance_of model_class do |record|
+            old = record.friendly_id
+            record2 = model_class.create! :name => record.name
+            record.save!
+            record.reload
+            assert_equal old, record.to_param
+          end
+        end
 
-      test "should be findable by id as string" do
-        with_instance_of(model_class) {|record| assert model_class.find record.id.to_s}
+        test "should not increment sequence on save" do
+          with_instance_of model_class do |record|
+            record2 = model_class.create! :name => record.name
+            record2.active = !record2.active
+            record2.save!
+            assert record2.friendly_id.match(/2\z/)
+          end
+        end
       end
 
-      test "should be findable by numeric friendly_id" do
-        with_instance_of(model_class, :name => "206") {|record| assert model_class.find record.friendly_id}
-      end
+      module Core
+        test "finds should respect conditions" do
+          with_instance_of(model_class) do |record|
+            assert_raises(ActiveRecord::RecordNotFound) do
+              model_class.where("1 = 2").find record.friendly_id
+            end
+          end
+        end
 
-      test "to_param should return the friendly_id" do
-        with_instance_of(model_class) {|record| assert_equal record.friendly_id, record.to_param}
-      end
+        test "should be findable by friendly id" do
+          with_instance_of(model_class) {|record| assert model_class.find record.friendly_id}
+        end
 
-      test "should be findable by themselves" do
-        with_instance_of(model_class) {|record| assert_equal record, model_class.find(record)}
-      end
+        test "should be findable by id as integer" do
+          with_instance_of(model_class) {|record| assert model_class.find record.id.to_i}
+        end
 
-      test "updating record's other values should not change the friendly_id" do
-        with_instance_of model_class do |record|
-          old = record.friendly_id
-          record.update_attributes! :active => false
-          assert model_class.find old
+        test "should be findable by id as string" do
+          with_instance_of(model_class) {|record| assert model_class.find record.id.to_s}
         end
-      end
 
-      test "instances found by a single id should not be read-only" do
-        with_instance_of(model_class) {|record| assert !model_class.find(record.friendly_id).readonly?}
-      end
+        test "should be findable by numeric friendly_id" do
+          with_instance_of(model_class, :name => "206") {|record| assert model_class.find record.friendly_id}
+        end
 
-      test "failing finds with unfriendly_id should raise errors normally" do
-        assert_raises(ActiveRecord::RecordNotFound) {model_class.find 0}
-      end
+        test "to_param should return the friendly_id" do
+          with_instance_of(model_class) {|record| assert_equal record.friendly_id, record.to_param}
+        end
 
-      test "should return numeric id if the friendly_id is nil" do
-        with_instance_of(model_class) do |record|
-          record.expects(:friendly_id).returns(nil)
-          assert_equal record.id.to_s, record.to_param
+        test "should be findable by themselves" do
+          with_instance_of(model_class) {|record| assert_equal record, model_class.find(record)}
         end
-      end
 
-      test "should return numeric id if the friendly_id is an empty string" do
-        with_instance_of(model_class) do |record|
-          record.expects(:friendly_id).returns("")
-          assert_equal record.id.to_s, record.to_param
+        test "updating record's other values should not change the friendly_id" do
+          with_instance_of model_class do |record|
+            old = record.friendly_id
+            record.update_attributes! :active => false
+            assert model_class.find old
+          end
+        end
+
+        test "instances found by a single id should not be read-only" do
+          with_instance_of(model_class) {|record| assert !model_class.find(record.friendly_id).readonly?}
         end
-      end
 
-      test "should return numeric id if the friendly_id is blank" do
-        with_instance_of(model_class) do |record|
-          record.expects(:friendly_id).returns("  ")
-          assert_equal record.id.to_s, record.to_param
+        test "failing finds with unfriendly_id should raise errors normally" do
+          assert_raises(ActiveRecord::RecordNotFound) {model_class.find 0}
+        end
+
+        test "should return numeric id if the friendly_id is nil" do
+          with_instance_of(model_class) do |record|
+            record.expects(:friendly_id).returns(nil)
+            assert_equal record.id.to_s, record.to_param
+          end
+        end
+
+        test "should return numeric id if the friendly_id is an empty string" do
+          with_instance_of(model_class) do |record|
+            record.expects(:friendly_id).returns("")
+            assert_equal record.id.to_s, record.to_param
+          end
+        end
+
+        test "should return numeric id if the friendly_id is blank" do
+          with_instance_of(model_class) do |record|
+            record.expects(:friendly_id).returns("  ")
+            assert_equal record.id.to_s, record.to_param
+          end
         end
       end
     end

data/test/slugged_test.rb

@@ -10,50 +10,12 @@ end
 class SluggedTest < MiniTest::Unit::TestCase
 
   include FriendlyId::Test
-  include FriendlyId::Test::Shared
+  include FriendlyId::Test::Shared::Core
+  include FriendlyId::Test::Shared::Slugged
 
   def model_class
     Journalist
   end
-
-  test "configuration should have a sequence_separator" do
-    assert !model_class.friendly_id_config.sequence_separator.empty?
-  end
-
-  test "should make a new slug if the friendly_id method value has changed" do
-    with_instance_of model_class do |record|
-      record.name = "Changed Value"
-      record.save!
-      assert_equal "changed-value", record.slug
-    end
-  end
-
-  test "should increment the slug sequence for duplicate friendly ids" do
-    with_instance_of model_class do |record|
-      record2 = model_class.create! :name => record.name
-      assert record2.friendly_id.match(/2\z/)
-    end
-  end
-
-  test "should not add slug sequence on update after other conflicting slugs were added" do
-    with_instance_of model_class do |record|
-      old = record.friendly_id
-      record2 = model_class.create! :name => record.name
-      record.save!
-      record.reload
-      assert_equal old, record.to_param
-    end
-  end
-
-  test "should not increment sequence on save" do
-    with_instance_of model_class do |record|
-      record2 = model_class.create! :name => record.name
-      record2.active = !record2.active
-      record2.save!
-      assert record2.friendly_id.match(/2\z/)
-    end
-  end
-
 end
 
 class SlugSequencerTest < MiniTest::Unit::TestCase

data/test/sti_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path("../helper.rb", __FILE__)
+
+class StiTest < MiniTest::Unit::TestCase
+
+  include FriendlyId::Test
+  include FriendlyId::Test::Shared::Core
+  include FriendlyId::Test::Shared::Slugged
+
+  class Journalist < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, :use => :slugged
+  end
+
+  class Editorialist < Journalist
+  end
+
+  def model_class
+    Editorialist
+  end
+
+  test "friendly_id should accept a base and a hash with single table inheritance" do
+    abstract_klass = Class.new(ActiveRecord::Base) do
+      extend FriendlyId
+      friendly_id :foo, :use => :slugged, :slug_column => :bar
+    end
+    klass = Class.new(abstract_klass)
+    assert klass < FriendlyId::Slugged
+    assert_equal :foo, klass.friendly_id_config.base
+    assert_equal :bar, klass.friendly_id_config.slug_column
+  end
+
+
+  test "friendly_id should accept a block with single table inheritance" do
+    abstract_klass = Class.new(ActiveRecord::Base) do
+      extend FriendlyId
+      friendly_id :foo do |config|
+        config.use :slugged
+        config.base = :foo
+        config.slug_column = :bar
+      end
+    end
+    klass = Class.new(abstract_klass)
+    assert klass < FriendlyId::Slugged
+    assert_equal :foo, klass.friendly_id_config.base
+    assert_equal :bar, klass.friendly_id_config.slug_column
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id4
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta5
+  version: 4.0.0.beta6
   prerelease: 6
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-06 00:00:00.000000000 -03:00
+date: 2011-08-11 00:00:00.000000000 -03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70359454075760 !ruby/object:Gem::Requirement
+  requirement: &70168979272700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70359454075760
+  version_requirements: *70168979272700
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70359454075180 !ruby/object:Gem::Requirement
+  requirement: &70168979272160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70359454075180
+  version_requirements: *70168979272160
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &70359454074720 !ruby/object:Gem::Requirement
+  requirement: &70168979271700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.1.2
   type: :development
   prerelease: false
-  version_requirements: *70359454074720
+  version_requirements: *70168979271700
 - !ruby/object:Gem::Dependency
   name: ffaker
-  requirement: &70359454074320 !ruby/object:Gem::Requirement
+  requirement: &70168979271300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359454074320
+  version_requirements: *70168979271300
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70359454073860 !ruby/object:Gem::Requirement
+  requirement: &70168979270840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359454073860
+  version_requirements: *70168979270840
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70359454073420 !ruby/object:Gem::Requirement
+  requirement: &70168979270420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359454073420
+  version_requirements: *70168979270420
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70359454072980 !ruby/object:Gem::Requirement
+  requirement: &70168979270000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359454072980
+  version_requirements: *70168979270000
 description: ! "    FriendlyId is the \"Swiss Army bulldozer\" of slugging and permalink
   plugins\n    for Ruby on Rails. It allows you to create pretty URL's and work with\n
   \   human-friendly strings as if they were numeric ids for ActiveRecord models.\n"
@@ -123,6 +123,7 @@ files:
 - lib/generators/friendly_id_generator.rb
 - test/base_test.rb
 - test/config/mysql.yml
+- test/config/mysql2.yml
 - test/config/postgres.yml
 - test/config/sqlite3.yml
 - test/configuration_test.rb
@@ -135,6 +136,7 @@ files:
 - test/scoped_test.rb
 - test/shared.rb
 - test/slugged_test.rb
+- test/sti_test.rb
 has_rdoc: true
 homepage: http://norman.github.com/friendly_id
 licenses: []