friendly_id_datamapper 3.1.0.beta1

data/test/cached_slug_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      class CachedSlugTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::Generic
+        include FriendlyId::Test::Slugged
+        include FriendlyId::Test::DataMapperAdapter::Slugged
+        include FriendlyId::Test::DataMapperAdapter::Core
+
+        def klass
+          District
+        end
+
+        def other_class
+          Post
+        end
+
+        def cached_slug
+          instance.send(cache_column)
+        end
+
+        def cache_column
+          klass.friendly_id_config.cache_column
+        end
+
+        test "should have a cached_slug" do
+          assert_equal cached_slug, instance.slug.to_friendly_id
+        end
+
+        test "should protect the cached slug value" do
+          old_value = cached_slug
+          instance.update(cache_column => "Madrid")
+          assert_equal old_value, cached_slug
+        end
+
+        test "should update the cached slug when updating the slug" do
+          instance.update(:name => "new name")
+          assert_equal instance.slug.to_friendly_id, cached_slug
+        end
+
+        test "should not update the cached slug column if it has not changed" do
+          instance.note = "a note"
+          instance.expects("#{cache_column}=".to_sym).never
+          instance.save!
+        end
+
+        test "should cache the incremented sequence for duplicate slug names" do
+          instance_2 = klass.create(:name => instance.name)
+          assert_match(/2\z/, instance_2.send(cache_column))
+        end
+
+        test "#friendly_id should check the cached value by default" do
+          instance.expects(:slug).never
+          instance.friendly_id
+        end
+
+        test "#friendly_id should skip the cache if invoked with true" do
+          instance.expects(:slug)
+          instance.friendly_id(true)
+        end
+
+        test "should not fire callbacks when updating slug cache" do
+          instance.expects(:say_hello).once
+          instance.update(:name => "new name")
+          assert_equal instance.slug.to_friendly_id, cached_slug
+        end
+      end
+    end
+  end
+end

data/test/core.rb

@@ -0,0 +1,72 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module DataMapper
+  module Model
+    def destroy_all!; all.destroy!; end
+  end
+end
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      # Core tests for any datamapper model using FriendlyId.
+      module Core
+
+        def teardown
+          klass.all.destroy!
+          other_class.all.destroy!
+          Slug.all.destroy!
+        end
+
+        def find_method
+          :get
+        end
+
+        def create_method
+          :create
+        end
+
+        def delete_all_method
+          :destroy_all!
+        end
+
+        def save_method
+          :save
+        end
+
+        def unfriendly_class
+          Unfriendly
+        end
+
+        def validation_exceptions
+          nil # DataMapper does not raise Validation Errors
+        end
+
+        test "should return their friendly_id for #to_param" do
+          assert_match(instance.friendly_id, instance.to_param)
+        end
+
+        # This emulates a fairly common issue where id's generated by fixtures are very high.
+        test "should continue to admit very large ids" do
+          klass.repository(:default).adapter.select("INSERT INTO #{klass.storage_name} (id, name) VALUES (2047483647, 'An instance')")
+          assert_nothing_raised do
+            klass.get(2047483647)
+          end
+        end
+
+        test "should not change failure behavior for models not using friendly_id" do
+          assert_raise DataMapper::ObjectNotFoundError do
+            unfriendly_class.get!(-1)
+          end
+        end
+
+        test "failing finds with unfriendly_id should raise errors normally" do
+          assert_raise DataMapper::ObjectNotFoundError do
+            klass.get!(0)
+          end
+        end
+      end
+    end
+  end
+end

data/test/custom_normalizer_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      class CustomNormalizerTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::DataMapperAdapter::Core
+        include FriendlyId::Test::DataMapperAdapter::Slugged
+        include FriendlyId::Test::CustomNormalizer
+
+        def klass
+          Person
+        end
+
+      end
+    end
+  end
+end

data/test/custom_table_name_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      class CustomTableNameTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::Generic
+        include FriendlyId::Test::Slugged
+        include FriendlyId::Test::DataMapperAdapter::Slugged
+        include FriendlyId::Test::DataMapperAdapter::Core
+
+        def klass
+          Place
+        end
+
+      end
+
+    end
+  end
+end

data/test/scoped_model_test.rb

@@ -0,0 +1,120 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+
+    class ScopedModelTest < ::Test::Unit::TestCase
+
+      include FriendlyId::Test::Generic
+      include FriendlyId::Test::Slugged
+      include FriendlyId::Test::DataMapperAdapter::Slugged
+      include FriendlyId::Test::DataMapperAdapter::Core
+
+      def setup
+        @user       = User.create(:name => "john")
+        @house      = House.create(:name => "123 Main", :user => @user)
+        @usa        = Country.create(:name => "USA")
+        @canada     = Country.create(:name => "Canada")
+        @resident   = Resident.create(:name => "John Smith", :country => @usa)
+        @resident2  = Resident.create(:name => "John Smith", :country => @canada)
+        @owner      = Company.create(:name => "Acme Events")
+        @site       = Site.create(:name => "Downtown Venue", :owner => @owner)
+      end
+
+      def teardown
+        Resident.all.destroy!
+        Country.all.destroy!
+        User.all.destroy!
+        House.all.destroy!
+        Slug.all.destroy!
+      end
+
+      test "a slugged model should auto-detect that it is being used as a parent scope" do
+        assert_equal [Resident], Country.friendly_id_config.child_scopes
+      end
+
+      test "a slugged model should update its child model's scopes when its friendly_id changes" do
+        @usa.update(:name => "United States")
+        assert_equal "united-states", @usa.to_param
+        assert_equal "united-states", @resident.slugs.reload.first.scope
+      end
+
+      test "a non-slugged model should auto-detect that it is being used as a parent scope" do
+        assert_equal [House], User.friendly_id_config.child_scopes
+      end
+
+      test "should update the slug when the scope changes" do
+        @resident.update :country => Country.create(:name => "Argentina")
+        assert_equal "argentina", @resident.slugs.reload.first.scope
+      end
+
+      test "updating only the scope should not append sequence to friendly_id" do
+        old_friendly_id = @resident.friendly_id
+        @resident.update :country => Country.create(:name => "Argentina")
+        assert_equal old_friendly_id, @resident.friendly_id
+      end
+
+      test "updating the scope should increment sequence to avoid conflicts" do
+        old_friendly_id = @resident.friendly_id
+        @resident.update :country => @canada
+        assert_equal "#{old_friendly_id}--2", @resident.friendly_id
+        assert_equal "canada", @resident.slugs.reload.first.scope
+      end
+
+      test "a non-slugged model should update its child model's scopes when its friendly_id changes" do
+        @user.update(:name => "jack")
+        assert_equal "jack", @user.to_param
+        assert_equal "jack", @house.slugs.reload.first.scope
+      end
+
+      test "should should not show the scope in the friendly_id" do
+        assert_equal "john-smith", @resident.friendly_id
+        assert_equal "john-smith", @resident2.friendly_id
+      end
+
+=begin
+      test "should find all scoped records without scope" do
+        assert_equal 2, Resident.find(:all, @resident.friendly_id).size
+      end
+=end
+
+      test "should find a single scoped record with a scope as a string" do
+        assert Resident.get(@resident.friendly_id, :scope => @resident.country)
+      end
+
+      test "should find a single scoped record with a scope" do
+        assert Resident.get(@resident.friendly_id, :scope => @resident.country)
+      end
+
+      test "should raise an error when finding a single scoped record with no scope" do
+        assert_raises DataMapper::ObjectNotFoundError do
+          Resident.get!(@resident.friendly_id)
+        end
+      end
+
+      test "should append scope error info when missing scope causes a find to fail" do
+        begin
+          Resident.get!(@resident.friendly_id)
+          fail "The find should not have succeeded"
+        rescue DataMapper::ObjectNotFoundError => e
+          assert_match(/scope expected/i, e.message)
+        end
+      end
+
+      test "should append scope error info when the scope value causes a find to fail" do
+        begin
+          Resident.get!(@resident.friendly_id, :scope => "badscope")
+          fail "The find should not have succeeded"
+        rescue DataMapper::ObjectNotFoundError => e
+          assert_match(/scope \"badscope\"/, e.message)
+        end
+      end
+
+      test "should update the sluggable field when a polymorphic relationship exists" do
+        @site.update(:name => "Uptown Venue")
+        assert_equal "Uptown Venue", @site.name
+      end
+
+    end
+  end
+end

data/test/simple_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      module Simple
+
+        module SimpleTest
+          def klass
+            @klass ||= User
+          end
+
+          def instance
+            @instance ||= User.create! :name => "hello world"
+          end
+
+          def other_class
+            Author
+          end
+        end
+
+        class StatusTest < ::Test::Unit::TestCase
+
+          include SimpleTest
+
+          def setup
+            User.destroy_all!
+          end
+
+          test "should default to not friendly" do
+            assert !status.friendly?
+          end
+
+          test "should default to numeric" do
+            assert status.numeric?
+          end
+
+          test "should be friendly if name is set" do
+            status.name = "name"
+            assert status.friendly?
+          end
+
+          test "should be best if it is numeric, but record has no friendly_id" do
+            instance.send("#{klass.friendly_id_config.column}=", nil)
+            assert status.best?
+          end
+
+          def status
+            @status ||= instance.friendly_id_status
+          end
+
+        end
+
+        class BasicTest < ::Test::Unit::TestCase
+          include FriendlyId::Test::Generic
+          include FriendlyId::Test::Simple
+          include FriendlyId::Test::DataMapperAdapter::Core
+          include SimpleTest
+
+          test "status should be friendly when found using friendly id" do
+            record = klass.send(find_method, instance.friendly_id)
+            assert record.friendly_id_status.friendly?
+          end
+
+          test "status should not be friendly when found using numeric id" do
+            record = klass.send(find_method, instance.id)
+            assert !record.friendly_id_status.friendly?
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/test/slug_test.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+
+    class SlugTest < ::Test::Unit::TestCase
+
+      def teardown
+        Slug.all.destroy!
+        Post.all.destroy!
+      end
+
+      test "should indicate if it is the most recent slug" do
+        post = Post.create(:name => "test title")
+        post.name = "a new title"
+        post.save
+        post.slugs.reload # DM issue: collection must be reloaded for correct ordering by id desc (for #first/#last)
+        assert post.slugs.first.current?
+        assert !post.slugs.last.current?
+      end
+
+      test "should include the sequence if the sequence is greater than 1" do
+        slug = Slug.new(:name => "test", :sluggable => Post.new, :sequence => 2)
+        assert_equal "test--2", slug.to_friendly_id
+      end
+
+      test "should not include the sequence if the sequence is 1" do
+        slug = Slug.new(:name => "test",  :sluggable => Post.new, :sequence => 1)
+        assert_equal "test", slug.to_friendly_id
+      end
+
+    end
+  end
+end

data/test/slugged.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      module Slugged
+
+        def klass
+          Post
+        end
+
+        def other_class
+          District
+        end
+
+        def instance
+          @instance ||= klass.create(:name => 'hello world')
+        end
+
+      end
+    end
+  end
+end

data/test/slugged_status_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      class StatusTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::Status
+        include FriendlyId::Test::SluggedStatus
+
+        def klass
+          Post
+        end
+
+        def instance
+          @instance ||= klass.create :name => "hello world"
+        end
+
+        def find_method
+          :get
+        end
+
+      end
+    end
+  end
+end

data/test/sti_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module FriendlyId
+  module Test
+    module DataMapperAdapter
+
+      class StiTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::Generic
+        include FriendlyId::Test::Slugged
+        include FriendlyId::Test::DataMapperAdapter::Slugged
+        include FriendlyId::Test::DataMapperAdapter::Core
+
+        def klass
+          Novel
+        end
+
+      end
+
+    end
+  end
+end

data/test/support/models.rb

@@ -0,0 +1,185 @@
+# A model that uses the automagically configured "cached_slug" column
+class District
+  include DataMapper::Resource
+  property :id,           Serial
+  property :name,         String
+  property :note,         String
+  property :cached_slug,  String, :index => :unique
+  has_friendly_id :name, :use_slug => true
+  before :save, :say_hello
+
+  private
+
+  def say_hello
+    @said_hello = true
+  end
+end
+
+# A model with optimistic locking enabled
+class Region
+  include DataMapper::Resource
+  property :id,           Serial
+  property :name,         String
+  property :cached_slug,  String, :index => :unique
+  property :note,         String
+  property :lock_version, Integer, :required => true, :default => 0
+
+  has_friendly_id :name, :use_slug => true
+
+  after :create do
+    other_instance = Region.get(self.id)
+    other_instance.update_attributes(:note => name + "!")
+  end
+end
+
+# A model that specifies a custom cached slug column
+class City
+  include DataMapper::Resource
+  property :id,         Serial
+  property :name,       String
+  property :my_slug,    String, :index => :unique
+  property :population, Integer
+  has_friendly_id :name, :use_slug => true, :cache_column => 'my_slug'
+end
+
+# A model with a custom slug text normalizer
+class Person
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  property :note, String
+  belongs_to :country, :required => false # Prevent DataMapper from creating
+                                          # an implicit required association
+  has_friendly_id :name, :use_slug => true
+
+  def normalize_friendly_id(string)
+    string.upcase
+  end
+
+end
+
+# A model that doesn't use FriendlyId
+class Unfriendly
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+end
+
+# A slugged model that uses a scope
+class Resident
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  belongs_to :country
+  has_friendly_id :name, :use_slug => true, :scope => :country
+end
+
+# A slugged model used as a scope
+class Country
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  has n, :people
+  has n, :residents
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model that doesn't use slugs
+class User
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  has_friendly_id :name
+  has n, :houses
+end
+
+# Another model that doesn"t use slugs
+class Author
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  has_friendly_id :name
+end
+
+
+# A model that uses a non-slugged model for its scope
+class House
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  belongs_to :user
+  has_friendly_id :name, :use_slug => true, :scope => :user
+end
+
+# A model that uses default slug settings and has a named scope
+class Post
+  include DataMapper::Resource
+  property :id,         Serial
+  property :name,       String
+  property :published,  Boolean
+  property :note,       String
+  has_friendly_id :name, :use_slug => true
+
+  def self.published
+    all(:published => true)
+  end
+end
+
+# Model that uses a custom table name
+class Place
+  include DataMapper::Resource
+  storage_names[:default] = 'legacy_table'
+  property :id,   Serial
+  property :name, String
+  property :note, String
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model that uses a datetime field for its friendly_id
+class Event
+  include DataMapper::Resource
+  property :id,         Serial
+  property :name,       String
+  property :event_date, DateTime
+  has_friendly_id :event_date, :use_slug => true
+end
+
+# A base model for single table inheritence
+class Book
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  property :type, String
+  property :note, String
+end
+
+# A model that uses STI
+class Novel < ::Book
+  has_friendly_id :name, :use_slug => true
+end
+
+=begin
+# A model with no table
+class Question
+  include DataMapper::Resource
+  has_friendly_id :name, :use_slug => true
+end
+=end
+
+# A model to test polymorphic associations
+class Site
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  belongs_to :owner, 'Company'
+  #belongs_to :owner, :polymorphic => true
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model used as a polymorphic owner
+class Company
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+  #has n, :sites, :as => :owner
+end