cmassimo-friendly_id 3.0.4.2

data/lib/friendly_id/status.rb

@@ -0,0 +1,35 @@
+module FriendlyId
+
+  # FriendlyId::Status presents information about the status of the
+  # id that was used to find the model. This class can be useful for figuring
+  # out when to redirect to a new URL.
+  class Status
+
+    # The id or name used as the finder argument
+    attr_accessor :name
+
+    # The found result, if any
+    attr_accessor :record
+
+    def initialize(options={})
+      options.each {|key, value| self.send("#{key}=".to_sym, value)}
+    end
+
+    # Did the find operation use a friendly id?
+    def friendly?
+      !! name
+    end
+
+    # Did the find operation use a numeric id?
+    def numeric?
+      !friendly?
+    end
+
+    # Did the find operation use the best available id?
+    def best?
+      record.friendly_id ? friendly? : true
+    end
+
+  end
+
+end

data/lib/friendly_id/test.rb

@@ -0,0 +1,291 @@
+Module.send :include, Module.new {
+  def test(name, &block)
+    define_method("test_#{name.gsub(/[^a-z0-9]/i, "_")}".to_sym, &block)
+  end
+  alias :should :test
+}
+
+module FriendlyId
+  module Test
+
+    # Tests for any model that implements FriendlyId. Any test that tests model
+    # features should include this module.
+    module Generic
+
+      def setup
+        klass.send delete_all_method
+      end
+
+      def teardown
+        klass.send delete_all_method
+      end
+
+      def instance
+        raise NotImplementedError
+      end
+
+      def klass
+        raise NotImplementedError
+      end
+
+      def other_class
+        raise NotImplementedError
+      end
+
+      def find_method
+        raise NotImplementedError
+      end
+
+      def create_method
+        raise NotImplementedError
+      end
+
+      def update_method
+        raise NotImplementedError
+      end
+
+      def validation_exceptions
+        return RuntimeError
+      end
+
+      test "models should have a friendly id config" do
+        assert_not_nil klass.friendly_id_config
+      end
+
+      test "instances should have a friendly id by default" do
+        assert_not_nil instance.friendly_id
+      end
+
+      test "instances should have a friendly id status" do
+        assert_not_nil instance.friendly_id_status
+      end
+
+      test "instances should be findable by their friendly id" do
+        assert_equal instance, klass.send(find_method, instance.friendly_id)
+      end
+
+      test "instances should be findable by their numeric id as an integer" do
+        assert_equal instance, klass.send(find_method, instance.id.to_i)
+      end
+
+      test "instances should be findable by their numeric id as a string" do
+        assert_equal instance, klass.send(find_method, instance.id.to_s)
+      end
+
+      test "instances should be findable by a numeric friendly_id" do
+        instance = klass.send(create_method, :name => "206")
+        assert_equal instance, klass.send(find_method, instance.friendly_id)
+      end
+
+      test "creation should raise an error if the friendly_id text is reserved" do
+        assert_raise(*[validation_exceptions].flatten) do
+          klass.send(create_method, :name => "new")
+        end
+      end
+
+      test "creation should raise an error if the friendly_id text is an empty string" do
+        assert_raise(*[validation_exceptions].flatten) do
+          klass.send(create_method, :name => "")
+        end
+      end
+
+      test "creation should raise an error if the friendly_id text is a blank string" do
+        assert_raise(*[validation_exceptions].flatten) do
+          klass.send(create_method, :name => "   ")
+        end
+      end
+
+      test "creation should raise an error if the friendly_id text is nil and allow_nil is false" do
+        assert_raise(*[validation_exceptions].flatten) do
+          klass.send(create_method, :name => nil)
+        end
+      end
+
+      test "creation should succeed if the friendly_id text is nil and allow_nil is true" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        assert klass.send(create_method, :name => nil)
+      end
+
+      test "should allow the same friendly_id across models" do
+        other_instance = other_class.send(create_method, :name => instance.name)
+        assert_equal other_instance.friendly_id, instance.friendly_id
+      end
+
+    end
+
+    module Simple
+
+      test "should allow friendly_id to be nillable if allow_nil is true" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        instance = klass.send(create_method, :name => "hello")
+        assert instance.friendly_id
+        instance.name = nil
+        assert instance.send(save_method)
+      end
+
+    end
+
+    # Tests for any model that implements slugs.
+    module Slugged
+
+      test "should have a slug" do
+        assert_not_nil instance.slug
+      end
+
+      test "should not make a new slug unless the friendly_id method value has changed" do
+        instance.note = instance.note.to_s << " updated"
+        instance.send save_method
+        assert_equal 1, instance.slugs.size
+      end
+
+      test "should make a new slug if the friendly_id method value has changed" do
+        instance.name = "Changed title"
+        instance.send save_method
+        assert_equal 2, instance.slugs.size
+      end
+
+      test "should be able to reuse an old friendly_id without incrementing the sequence" do
+        old_title = instance.name
+        old_friendly_id = instance.friendly_id
+        instance.name = "A changed title"
+        instance.send save_method
+        instance.name = old_title
+        instance.send save_method
+        assert_equal old_friendly_id, instance.friendly_id
+      end
+
+      test "should increment the slug sequence for duplicate friendly ids" do
+        instance2 = klass.send(create_method, :name => instance.name)
+        assert_match(/2\z/, instance2.friendly_id)
+      end
+
+      test "should find instance with a sequenced friendly_id" do
+        instance2 = klass.send(create_method, :name => instance.name)
+        assert_equal instance2, klass.send(find_method, instance2.friendly_id)
+      end
+
+      test "should indicate correct status when found with a sequence" do
+        instance2 = klass.send(create_method, :name => instance.name)
+        instance2 = klass.send(find_method, instance2.friendly_id)
+        assert instance2.friendly_id_status.best?
+      end
+
+      test "should remain findable by previous slugs" do
+        old_friendly_id = instance.friendly_id
+        instance.name = "#{old_friendly_id} updated"
+        instance.send(save_method)
+        assert_not_equal old_friendly_id, instance.friendly_id
+        assert_equal instance, klass.send(find_method, old_friendly_id)
+      end
+
+      test "should not create a slug when allow_nil is true and friendy_id text is blank" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        instance = klass.send(create_method, :name => nil)
+        assert_nil instance.slug
+      end
+
+      test "should not allow friendly_id to be nillable even if allow_nil is true" do
+        klass.friendly_id_config.stubs(:allow_nil?).returns(true)
+        instance = klass.send(create_method, :name => "hello")
+        assert instance.friendly_id
+        instance.name = nil
+        assert_raise(*[validation_exceptions].flatten) do
+          instance.send(save_method)
+        end
+      end
+
+    end
+
+    # Tests for FriendlyId::Status.
+    module Status
+
+      test "should default to not friendly" do
+        assert !status.friendly?
+      end
+
+      test "should default to numeric" do
+        assert status.numeric?
+      end
+
+    end
+
+    # Tests for FriendlyId::Status for a model that uses slugs.
+    module SluggedStatus
+
+      test "should be friendly if slug is set" do
+        status.slug = Slug.new
+        assert status.friendly?
+      end
+
+      test "should be friendly if name is set" do
+        status.name = "name"
+        assert status.friendly?
+      end
+
+      test "should be current if current slug is set" do
+        status.slug = instance.slug
+        assert status.current?
+      end
+
+      test "should not be current if non-current slug is set" do
+        status.slug = Slug.new(:sluggable => instance)
+        assert !status.current?
+      end
+
+      test "should be best if it is current" do
+        status.slug = instance.slug
+        assert status.best?
+      end
+
+      test "should be best if it is numeric, but record has no slug" do
+        instance.slugs = []
+        instance.slug = nil
+        assert status.best?
+      end
+
+      [:record, :name].each do |symbol|
+        test "should have #{symbol} after find using friendly_id" do
+          instance2 = klass.find(instance.friendly_id)
+          assert_not_nil instance2.friendly_id_status.send(symbol)
+        end
+      end
+
+      def status
+        @status ||= instance.friendly_id_status
+      end
+
+      def klass
+        raise NotImplementedError
+      end
+
+      def instance
+        raise NotImplementedError
+      end
+
+    end
+
+    # Tests for models to ensure that they properly implement using the
+    # +normalize_friendly_id+ method to allow developers to hook into the
+    # slug string generation.
+    module CustomNormalizer
+
+      test "should invoke the custom normalizer" do
+        assert_equal "JOE SCHMOE", klass.send(create_method, :name => "Joe Schmoe").friendly_id
+      end
+
+      test "should respect the max_length option" do
+        klass.friendly_id_config.stubs(:max_length).returns(3)
+        assert_equal "JOE", klass.send(create_method, :name => "Joe Schmoe").friendly_id
+      end
+
+      test "should raise an error if the friendly_id text is reserved" do
+        klass.friendly_id_config.stubs(:reserved_words).returns(["JOE"])
+        assert_raise(*[validation_exceptions].flatten) do
+          klass.send(create_method, :name => "Joe")
+        end
+
+      end
+
+    end
+  end
+end

data/lib/friendly_id/version.rb

@@ -0,0 +1,9 @@
+module FriendlyId
+  module Version
+    MAJOR = 3
+    MINOR = 0
+    TINY = 4
+    BUILD = 2
+    STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
+  end
+end

data/lib/generators/friendly_id_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class FriendlyIdGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+
+  MIGRATIONS_FILE = File.join(File.dirname(__FILE__), "..", "..", "generators", "friendly_id", "templates", "create_slugs.rb")
+
+  class_option :"skip-migration", :type => :boolean, :desc => "Don't generate a migration for the slugs table"
+
+  def copy_files(*args)
+    migration_template MIGRATIONS_FILE, "db/migrate/create_slugs.rb" unless options["skip-migration"]
+  end
+
+  # Taken from ActiveRecord's migration generator
+  def self.next_migration_number(dirname) #:nodoc:
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+end

data/lib/tasks/friendly_id.rake

@@ -0,0 +1,19 @@
+namespace :friendly_id do
+  desc "Make slugs for a model."
+  task :make_slugs => :environment do
+    FriendlyId::TaskRunner.new.make_slugs do |record|
+      puts "%s(%d): friendly_id set to '%s'" % [record.class.to_s, record.id, record.slug.name] if record.slug
+    end
+  end
+
+  desc "Regenereate slugs for a model."
+  task :redo_slugs => :environment do
+    FriendlyId::TaskRunner.new.delete_slugs
+    Rake::Task["friendly_id:make_slugs"].invoke
+  end
+
+  desc "Destroy obsolete slugs older than DAYS=45 days."
+  task :remove_old_slugs => :environment do
+    FriendlyId::TaskRunner.new.delete_old_slugs
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require "friendly_id"
+require "friendly_id/active_record"

data/test/active_record_adapter/ar_test_helper.rb

@@ -0,0 +1,119 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+require "active_record"
+require "active_support"
+
+require File.expand_path("../../../lib/friendly_id/active_record", __FILE__)
+require File.expand_path("../../../generators/friendly_id/templates/create_slugs", __FILE__)
+require File.expand_path("../support/models", __FILE__)
+require File.expand_path('../core', __FILE__)
+require File.expand_path('../slugged', __FILE__)
+
+local_db_settings   = File.expand_path("../support/database.yml", __FILE__)
+default_db_settings = File.expand_path("../support/database.sqlite3.yml", __FILE__)
+
+db_settings = File.exists?(local_db_settings) ? local_db_settings : default_db_settings
+ActiveRecord::Base.establish_connection(YAML::load(File.open(db_settings)))
+
+class ActiveRecord::Base
+  def log_protected_attribute_removal(*args) end
+end
+
+ActiveRecord::Base.connection.tables.each do |table|
+  ActiveRecord::Base.connection.drop_table(table)
+end
+ActiveRecord::Migration.verbose = false
+CreateSlugs.up
+CreateSupportModels.up
+
+# A model that uses the automagically configured "cached_slug" column
+class District < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model that specifies a custom cached slug column
+class City < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true, :cache_column => "my_slug"
+end
+
+# A model with a custom slug text normalizer
+class Person < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true
+
+  def normalize_friendly_id(string)
+    string.upcase
+  end
+
+end
+
+# A slugged model that uses a scope
+class Resident < ActiveRecord::Base
+  belongs_to :country
+  has_friendly_id :name, :use_slug => true, :scope => :country
+end
+
+# A slugged model used as a scope
+class Country < ActiveRecord::Base
+  has_many :people
+  has_many :residents
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model that doesn"t use slugs
+class User < ActiveRecord::Base
+  has_friendly_id :name
+  has_many :houses
+end
+
+# Another model that doesn"t use slugs
+class Author < ActiveRecord::Base
+  has_friendly_id :name
+end
+
+
+# A model that uses a non-slugged model for its scope
+class House < ActiveRecord::Base
+  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 < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true
+  send FriendlyId::ActiveRecordAdapter::Compat.scope_method, :published, :conditions => { :published => true }
+end
+
+# Model that uses a custom table name
+class Place < ActiveRecord::Base
+  self.table_name = "legacy_table"
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model that uses a datetime field for its friendly_id
+class Event < ActiveRecord::Base
+  has_friendly_id :event_date, :use_slug => true
+end
+
+# A base model for single table inheritence
+class Book < ActiveRecord::Base ; end
+
+# A model that uses STI
+class Novel < ::Book
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model with no table
+class Question < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model to test polymorphic associations
+class Site < ActiveRecord::Base
+  belongs_to :owner, :polymorphic => true
+  has_friendly_id :name, :use_slug => true
+end
+
+# A model used as a polymorphic owner
+class Company < ActiveRecord::Base
+  has_many :sites, :as => :owner
+end