pseudocephalopod 0.3.1 → 0.3.2

data/lib/pseudocephalopod/scopes.rb

@@ -1,13 +0,0 @@
-module Pseudocephalopod
-  module Scopes
-    
-    def with_cached_slug(slug)
-      where(self.cached_slug_column => slug.to_s)
-    end
-    
-    def other_than(record)
-      record.new_record? ? scoped : where("#{quoted_table_name}.#{connection.quote_column_name(:id)} != ?", record.id)
-    end
-    
-  end
-end

data/lib/pseudocephalopod/slug.rb

@@ -1,36 +0,0 @@
-module Pseudocephalopod
-  class Slug < ActiveRecord::Base
-    set_table_name "slugs"
-  
-    validates_presence_of :record_id, :slug, :scope
-  
-    scope :ordered,    order('created_at DESC')
-    scope :only_slug,  select(:slug)
-    scope :for_record, lambda { |r| where(:record_id => r.id, :scope => Pseudocephalopod.key_for_scope(r)) }
-    scope :for_slug,   lambda { |scope, slug| where(:scope=> scope.to_s, :slug => slug.to_s)}
-  
-    def self.id_for(scope, slug)
-      ordered.for_slug(scope, slug).first.try(:record_id)
-    end
-    
-    def self.record_slug(record, slug)
-      scope = Pseudocephalopod.key_for_scope(record)
-      # Clear slug history in this scope before recording the new slug
-      for_slug(scope, slug).delete_all
-      create :scope => scope, :record_id => record.id, :slug => slug.to_s
-    end
-    
-    def self.previous_for(record)
-      ordered.only_slug.for_record(record).all.map(&:slug)
-    end
-    
-    def self.remove_history_for(record)
-      for_record(record).delete_all
-    end
-  
-    def self.usable?
-      table_exists? rescue false
-    end
-  
-  end
-end

data/lib/pseudocephalopod/slug_history.rb

@@ -1,41 +0,0 @@
-module Pseudocephalopod
-  module SlugHistory
-    extend ActiveSupport::Concern
-    
-    included do
-      after_save :record_slug_changes
-      after_destroy :remove_slug_history!
-    end
-   
-    module InstanceMethods
-      
-      def previous_slugs
-        Pseudocephalopod.previous_slugs_for(self)
-      end
-      
-      def remove_slug_history!
-        Pseudocephalopod.remove_slug_history_for(self)
-      end
-      
-      protected
-      
-      def record_slug_changes
-        slug_column = self.cached_slug_column
-        return unless send(:"#{slug_column}_changed?")
-        value = send(:"#{slug_column}_was")
-        Pseudocephalopod.record_slug(self, value) if value.present?
-      end
-      
-    end
-    
-    module ClassMethods
-      
-      def find_using_slug_history(slug, options = {})
-        id = Pseudocephalopod.last_known_slug_id(self, slug)
-        id.present? ? find_by_id(id, options) : nil
-      end
-      
-    end
-    
-  end
-end

data/lib/pseudocephalopod/version.rb

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

data/pseudocephalopod.gemspec

@@ -1,90 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{pseudocephalopod}
-  s.version = "0.3.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Darcy Laycock"]
-  s.date = %q{2010-09-19}
-  s.description = %q{Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history}
-  s.email = %q{sutto@sutto.net}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     ".rvmrc",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "lib/generators/pseudocephalopod/slug_migration/slug_migration_generator.rb",
-     "lib/generators/pseudocephalopod/slug_migration/templates/migration.erb",
-     "lib/generators/pseudocephalopod/slugs/slugs_generator.rb",
-     "lib/generators/pseudocephalopod/slugs/templates/migration.erb",
-     "lib/pseudocephalopod.rb",
-     "lib/pseudocephalopod/active_record_methods.rb",
-     "lib/pseudocephalopod/caching.rb",
-     "lib/pseudocephalopod/finders.rb",
-     "lib/pseudocephalopod/memory_cache.rb",
-     "lib/pseudocephalopod/railtie.rb",
-     "lib/pseudocephalopod/scopes.rb",
-     "lib/pseudocephalopod/slug.rb",
-     "lib/pseudocephalopod/slug_history.rb",
-     "lib/pseudocephalopod/version.rb",
-     "metrics/.gitignore",
-     "pseudocephalopod.gemspec",
-     "test/caching_test.rb",
-     "test/helper.rb",
-     "test/is_sluggable_test.rb",
-     "test/model_definitions.rb",
-     "test/pseudocephalopod_test.rb",
-     "test/slug_history_test.rb"
-  ]
-  s.homepage = %q{http://github.com/Sutto/pseudocephalopod}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history}
-  s.test_files = [
-    "test/caching_test.rb",
-     "test/helper.rb",
-     "test/is_sluggable_test.rb",
-     "test/model_definitions.rb",
-     "test/pseudocephalopod_test.rb",
-     "test/slug_history_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.0"])
-      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
-      s.add_runtime_dependency(%q<uuid>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<reversible_data>, [">= 0"])
-    else
-      s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
-      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
-      s.add_dependency(%q<uuid>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<reversible_data>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activerecord>, ["~> 3.0.0"])
-    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
-    s.add_dependency(%q<uuid>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<reversible_data>, [">= 0"])
-  end
-end
-

data/test/caching_test.rb

@@ -1,77 +0,0 @@
-require 'helper'
-
-class CachingTest < Test::Unit::TestCase
-  with_tables :slugs, :users do
-    
-    setup { Pseudocephalopod::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"
-        Pseudocephalopod::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 { Pseudocephalopod::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

@@ -1,44 +0,0 @@
-$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 'pseudocephalopod'
-require 'model_definitions'
-
-# Use a memory cache for testing.
-Pseudocephalopod.cache = Pseudocephalopod::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

@@ -1,155 +0,0 @@
-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