slugged 0.3.2

data/lib/slugged/version.rb

@@ -0,0 +1,8 @@
+module Slugged
+  module Version
+    MAJOR  = 0
+    MINOR  = 3
+    PATCH  = 2
+    STRING = [MAJOR, MINOR, PATCH].join(".")
+  end
+end

data/test/caching_test.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+class CachingTest < Test::Unit::TestCase
+  with_tables :slugs, :users do
+    
+    setup { Slugged::MemoryCache.reset! }
+    
+    context 'with the default slug setup' do
+      
+      setup { setup_slugs! }
+    
+      should 'store a cache automatically after finding it' do
+        assert_has_no_cache_for  "bob"
+        u = User.create :name => "Bob"
+        assert_has_cache_for     "bob"
+        Slugged::MemoryCache.reset!
+        assert_has_no_cache_for  "bob"
+        assert_same_as_slug u,   "bob"
+        assert_has_cache_for     "bob"
+        assert_same_as_slug u,   "bob"
+      end
+    
+      should 'automatically keep cache entries for history by default' do
+        setup_slugs!
+        assert_has_no_cache_for "bob"
+        assert_has_no_cache_for "red"
+        assert_has_no_cache_for "sam"
+        user = User.create :name => "bob"
+        assert_has_cache_for "bob"
+        assert_has_no_cache_for "red"
+        assert_has_no_cache_for "sam"
+        user.update_attributes :name => "Red"
+        assert_has_cache_for "bob"
+        assert_has_cache_for "red"
+        assert_has_no_cache_for "sam"
+        user.update_attributes :name => "Sam"
+        assert_has_cache_for "bob"
+        assert_has_cache_for "red"
+        assert_has_cache_for "sam"
+      end
+      
+    end
+    
+    should 'remove cache on models without history' do
+      setup_slugs! :history => false
+      u = User.create :name => "Bob"
+      assert_has_cache_for    "bob"
+      assert_has_no_cache_for "red"
+      assert_has_no_cache_for "sam"
+      u.update_attributes :name => "Red"
+      u.update_attributes :name => "Sam"
+      assert_has_no_cache_for "bob"
+      assert_has_no_cache_for "red"
+      assert_has_cache_for    "sam"
+    end
+   
+    should 'allow you to disable caching' do
+      setup_slugs! :use_cache => false
+      assert !User.respond_to?(:has_cache_for_slug?)
+    end
+    
+    # Ensure we destroy the contents of the cache after each test.
+    teardown { Slugged::MemoryCache.reset! }
+    
+  end
+  
+  protected
+  
+  def assert_has_cache_for(key)
+    assert User.has_cache_for_slug?(key), "User should have a cache entry for #{key.inspect}"
+  end
+  
+  def assert_has_no_cache_for(key)
+    assert !User.has_cache_for_slug?(key), "User should not have a cache entry for #{key.inspect}"
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,44 @@
+$KCODE = 'UTF8'
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'test/unit'
+require 'shoulda'
+require 'redgreen' if RUBY_VERSION < '1.9'
+require 'ruby-debug' if ENV['DEBUG']
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'slugged'
+require 'model_definitions'
+
+# Use a memory cache for testing.
+Slugged.cache = Slugged::MemoryCache
+
+class Test::Unit::TestCase
+  extend ReversibleData::ShouldaMacros
+  
+  def setup_slugs!(*args)
+    options = args.extract_options!
+    field   = args.pop || :name
+    User.is_sluggable field, options
+  end
+  
+  def assert_same_as_slug(user, slug, options = {})
+    found_user = User.find_using_slug(slug, options)
+    assert_equal user, found_user, "#{slug.inspect} should return #{user.inspect}, got #{found_user.inspect}"
+  end
+  
+  def assert_different_to_slug(user, slug, options = {})
+    found_user = User.find_using_slug(slug, options)
+    assert_not_equal user, found_user, "#{slug.inspect} should not return #{user.inspect}, got same record."
+  end
+  
+  def assert_none_for_slug(slug)
+    assert User.find_using_slug(slug).blank?, "slug #{slug.inspect} should not return any records."
+  end
+  
+end

data/test/is_sluggable_test.rb

@@ -0,0 +1,155 @@
+require 'helper'
+require 'digest/md5'
+
+class IsSluggableTest < Test::Unit::TestCase
+  with_tables :slugs, :users do
+    
+    class StringWrapper < String
+      def to_url; "my-demo-slug"; end
+    end
+    
+    context 'with the default slug options' do
+      
+      setup { setup_slugs! }
+      
+      should 'correctly sluggify a value' do
+        user = User.create(:name => "Bob")
+        assert_equal "bob", user.to_param
+        assert_equal "bob", user.cached_slug
+      end
+
+      should 'generate a uuid in place of a slug' do
+        user = User.create(:name => '')
+        assert user.cached_slug.present?
+      end
+
+      should 'return need to generate a slug when the cahced slug is blank' do
+        user = User.new(:name => "Ninja Stuff")
+        assert user.cached_slug.blank?
+        assert user.should_generate_slug?
+        user.save
+        assert user.cached_slug.present?
+        assert !user.should_generate_slug?
+        user.name = 'Awesome'
+        assert user.should_generate_slug?
+      end
+      
+      should "let you find a record by it's id as needed" do
+        user = User.create :name => "Bob"
+        assert_equal user, User.find_using_slug(user.id)
+        assert_equal user, User.find_using_slug(user.id.to_i)
+      end
+      
+      should 'return nil for unfound slugs by default' do
+        assert_nil User.find_using_slug("awesome")
+      end
+      
+      should 'let you find slugs and raise an exception' do
+        assert_raises(ActiveRecord::RecordNotFound) do
+          User.find_using_slug!("awesome")
+        end
+      end
+
+      should 'default to generate a uuid' do
+        user = User.create :name => ""
+        assert_match /\A[a-zA-Z0-9]{32}\Z/, user.cached_slug.gsub("-", "")
+        user = User.create
+        assert_match /\A[a-zA-Z0-9]{32}\Z/, user.cached_slug.gsub("-", "")
+      end
+
+      should 'automatically append a sequence to the end of conflicting slugs' do
+        u1 = User.create :name => "ninjas Are awesome"
+        u2 = User.create :name => "Ninjas are awesome"
+        assert_equal "ninjas-are-awesome",    u1.to_slug
+        assert_equal "ninjas-are-awesome--1", u2.to_slug
+      end
+
+      should 'let you find out if there is a better way of finding a slug' do
+        user = User.create :name => "Bob"
+        user.update_attributes! :name => "Ralph"
+        assert !User.find_using_slug("ralph").has_better_slug?
+        assert User.find_using_slug("bob").has_better_slug?
+        assert User.find_using_slug(user.id).has_better_slug?
+      end
+      
+      should 'not keep a users slug when updating themselves' do
+        user = User.create :name => "bob is awesome"
+        assert_equal "bob-is-awesome", user.to_param
+        assert !user.new_record?
+        user.update_attributes :name => "BOB-is-AWESOME"
+        assert_equal "bob-is-awesome", user.to_param
+      end
+
+    end
+    
+    context 'with slug syncing disabled' do
+      setup { setup_slugs! :sync => false }
+      
+      should 'let you disable syncing a slug' do
+        user = User.create(:name => "Ninja User")
+        assert !user.should_generate_slug?
+        user.name = "Another User Name"
+        assert !user.should_generate_slug?
+      end
+      
+      should 'let you force slug generation' do
+        user = User.create(:name => "Ninja User")
+        assert_equal "ninja-user", user.to_slug
+        user.update_attributes :name => "Test User"
+        assert_equal "ninja-user", user.to_slug
+        user.generate_slug!
+        assert_equal "test-user", user.to_slug
+        user.reload
+        assert_equal "test-user", user.to_slug
+      end
+      
+      should 'let you force the update of all slugs' do
+        user_a = User.create(:name => "User A")
+        user_b = User.create(:name => "User B")
+        user_c = User.create(:name => "User C")
+        user_a.update_attributes :name => "User A-1"
+        user_b.update_attributes :name => "User B-1"
+        user_c.update_attributes :name => "User C-1"
+        assert_equal "user-a", user_a.to_slug
+        assert_equal "user-b", user_b.to_slug
+        assert_equal "user-c", user_c.to_slug
+        User.update_all_slugs!
+        user_a.reload
+        user_b.reload
+        user_c.reload
+        assert_equal "user-a-1", user_a.to_slug
+        assert_equal "user-b-1", user_b.to_slug
+        assert_equal "user-c-1", user_c.to_slug
+      end
+      
+    end
+    
+    context 'setting slug convertors' do
+      
+      should 'let you specify a symbol' do
+        setup_slugs! :convertor => :upcase
+        assert_equal "AWESOME USER", User.create(:name => "Awesome User").to_slug
+      end
+      
+      should 'let you specify a proc' do
+        setup_slugs! :convertor => proc { |r| r.reverse.upcase }
+        assert_equal "RESU EMOSEWA", User.create(:name => "Awesome User").to_slug
+      end
+      
+      should 'call to_url if available by default' do
+        setup_slugs!
+        original_value = StringWrapper.new("Awesome User")
+        assert_equal "my-demo-slug", User.create(:name => original_value).to_slug
+      end
+      
+    end
+    
+    should 'set the cached slug to nil if uuid is nil and the source value is blank' do
+      setup_slugs! :uuid => nil
+      record = User.create(:name => "")
+      assert_nil record.cached_slug
+      assert_equal record.id.to_s, record.to_slug
+    end
+    
+  end
+end

data/test/model_definitions.rb

@@ -0,0 +1,19 @@
+require 'reversible_data'
+
+ReversibleData.in_memory!
+
+# Define models here.
+
+ReversibleData.add :slugs do |t|
+  t.string  :scope
+  t.string  :slug
+  t.integer :record_id
+  t.datetime :created_at
+end
+
+ReversibleData.add :users do |u|
+  u.string :name
+  u.string :address
+  u.string :cached_slug
+  u.timestamps
+end

data/test/slug_history_test.rb

@@ -0,0 +1,86 @@
+require 'helper'
+
+class FakedModel
+  attr_reader :id
+  def self.slug_scope_key; "faked_models"; end
+  def initialize(id); @id = id; end
+end
+
+class SlugHistoryTest < Test::Unit::TestCase
+  with_tables :slugs, :users do
+    
+    context 'for arbitrary models' do
+    
+      setup do
+        @record_a = FakedModel.new(12)
+        @record_b = FakedModel.new(4)
+        Slugged.record_slug(@record_a, "awesome")
+        Slugged.record_slug(@record_b, "awesome-1")
+        Slugged.record_slug(@record_a, "ninjas")
+      end
+    
+      should 'let you lookup a given record id easily' do
+        assert Slugged.last_known_slug_id(FakedModel, "felafel").blank?
+        assert Slugged.last_known_slug_id(FakedModel, "ninjas-2").blank?
+        assert_equal 12, Slugged.last_known_slug_id(FakedModel, "awesome")
+        assert_equal 4,  Slugged.last_known_slug_id(FakedModel, "awesome-1")
+        assert_equal 12, Slugged.last_known_slug_id(FakedModel, "ninjas")
+      end
+      
+      should 'let you return slug history for a given record'
+    
+    end
+    
+    context 'on a specific record' do
+      
+      should 'by default record slug history' do
+        setup_slugs!
+        user = User.create :name => "Bob"
+        assert_equal [], user.previous_slugs
+        user.update_attributes! :name => "Sal"
+        user.update_attributes! :name => "Red"
+        user.update_attributes! :name => "Jim"
+        assert_same_as_slug user, "red"
+        assert_same_as_slug user, "sal"
+        assert_same_as_slug user, "bob"
+        assert_same_as_slug user, "jim"  
+      end
+      
+      should 'let you reset history for a slug' do
+        setup_slugs!
+        user = User.create :name => "Bob"
+        user.update_attributes! :name => "Sal"
+        user.update_attributes! :name => "Red"
+        user.update_attributes! :name => "Jim"
+        assert_equal ["red", "sal", "bob"], user.previous_slugs
+        user.remove_slug_history!
+        assert_equal [], user.previous_slugs
+        assert_none_for_slug "red"
+        assert_none_for_slug "sal"
+        assert_none_for_slug "bob"
+      end
+
+      should 'let you disable recording of slug history' do
+        setup_slugs! :history => false
+        user = User.create(:name => "Bob")
+        assert !user.respond_to?(:previous_slugs)
+        user.update_attributes! :name => "Red"
+        assert_same_as_slug      user, "red"
+        assert_different_to_slug user, "bob"
+        assert_none_for_slug "bob"
+      end
+      
+      should 'remove slug history for a record by default on destroy' do
+        setup_slugs!
+        user = User.create :name => "Bob"
+        user.update_attributes! :name => "Sal"
+        user.update_attributes! :name => "Red"
+        user.update_attributes! :name => "Jim"
+        assert_equal ["red", "sal", "bob"], user.previous_slugs
+        user.destroy
+        assert_equal [], user.previous_slugs
+      end
+      
+    end
+  end
+end

data/test/slugged_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class SluggedTest < Test::Unit::TestCase
+  
+  class SlugScopeTest
+    cattr_accessor :slug_scope_key
+    self.slug_scope_key = "my-test-scope"
+  end
+  
+  should 'return the correct counter versions' do
+    assert_equal 'awesome',      Slugged.with_counter('awesome')
+    assert_equal 'awesome',      Slugged.with_counter('awesome', 0)
+    assert_equal 'awesome',      Slugged.with_counter('awesome', -1)
+    assert_equal 'awesome--2',   Slugged.with_counter('awesome', 2)
+    assert_equal 'awesome--100', Slugged.with_counter('awesome', 100)
+  end
+
+  should 'correct allow you to slug scope keys' do
+    assert_equal "my-test-scope", Slugged.key_for_scope(SlugScopeTest)
+    assert_equal "my-test-scope", Slugged.key_for_scope(SlugScopeTest.new)
+    assert_equal "my-test-scope", Slugged.key_for_scope("my-test-scope")
+    assert_equal "",              Slugged.key_for_scope(nil)
+    assert_equal "1",             Slugged.key_for_scope(1)
+    assert_equal "awesome",       Slugged.key_for_scope(:awesome)
+  end
+
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification 
+name: slugged
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 2
+  version: 0.3.2
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activesupport
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: uuid
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: shoulda
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: reversible_data
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+description: Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/slugged/slug_migration/slug_migration_generator.rb
+- lib/generators/slugged/slug_migration/templates/migration.erb
+- lib/generators/slugged/slugs/slugs_generator.rb
+- lib/generators/slugged/slugs/templates/migration.erb
+- lib/slugged.rb
+- lib/slugged/active_record_methods.rb
+- lib/slugged/caching.rb
+- lib/slugged/finders.rb
+- lib/slugged/memory_cache.rb
+- lib/slugged/railtie.rb
+- lib/slugged/scopes.rb
+- lib/slugged/slug.rb
+- lib/slugged/slug_history.rb
+- lib/slugged/version.rb
+- metrics/.gitignore
+- test/caching_test.rb
+- test/helper.rb
+- test/is_sluggable_test.rb
+- test/model_definitions.rb
+- test/slug_history_test.rb
+- test/slugged_test.rb
+has_rdoc: true
+homepage: http://github.com/Sutto/slugged
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history
+test_files: 
+- test/caching_test.rb
+- test/helper.rb
+- test/is_sluggable_test.rb
+- test/model_definitions.rb
+- test/slug_history_test.rb
+- test/slugged_test.rb