friendly_id 3.3.0.rc1 → 3.3.0.rc2

data/Changelog.md

@@ -8,6 +8,7 @@ suggestions, ideas and improvements to FriendlyId.
 
 ## 3.3.0 (NOT_RELEASED_YET)
 
+* Support for Active Record 2.3 dropped
 * Convert blank slugs to nil automatically ([Gabe da Silveira ](https://github.com/dasil003))
 * Compatibility with Active Record 3.1 ([Andrew White](https://github.com/pixeltrix))
 * Gemspec compatibility with RubyGems 1.7 ([Philip Arndt](https://github.com/parndt))

data/Guide.md

@@ -69,48 +69,26 @@ feature. These features are explained in detail {file:Guide.md#features below}.
 
 ## Installation
 
-FriendlyId can be installed as a gem, or as a Rails plugin. It is compatible
-with Rails 2.3.x. and 3.0.
-
-### As a Gem
+### Gem installation
 
     gem install friendly_id
 
-#### Rails 2.3.x
-
-After installing the gem, add an entry in environment.rb:
-
-    config.gem "friendly_id", :version => "~> 3.2.1"
-
-### Rails 3.0
-
 After installing the gem, add an entry in the Gemfile:
 
-    gem "friendly_id", "~> 3.2.1"
+    gem "friendly_id", "~> 3.3.0"
 
-### As a Plugin
+### Roadmap
 
-Plugin installation is simple for all supported versions of Rails:
+FriendlyId 3.3 is now in **long term maintenance mode.** It will continue to be
+supported and maintained indefinitely, but no new features will be added to it.
 
-    ./script/plugin install git://github.com/norman/friendly_id.git
-
-However, installing as a gem offers simpler version control than plugin
-installation. Whenever possible, install as a gem instead. Plugin support may
-eventually be removed in a future version.
-
-### 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 2.3.x will not be
-dropped until a stable release of 3.1 is out, or possibly longer.
+[FriendlyId 4.0](https://github.com/norman/friendly_id/tree/4.0.0) is a
+ground-up rewrite of FriendlyId, and is the project's future, and will be
+released by September, 2011.
 
 ### Setup
 
-After installing either as a gem or plugin, run:
-
-
     rails generate friendly_id
-    # or "./script generate friendly_id" on Rails 2.3
     rake db:migrate
 
 This will install the Rake tasks and slug migration for FriendlyId. If you are
@@ -632,21 +610,6 @@ own solution is unlikely to be any faster than FriendlyId with cached slugs
 enabled. But if it is, then your patches would be very welcome!
 
 
-    activerecord (2.3.8)
-    ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-darwin10.4.0]
-    friendly_id (3.1.4)
-    sqlite3-ruby (1.3.1)
-    sqlite3 3.6.12 in-memory database
-
-                                                       | DEFAULT | NO_SLUG |    SLUG | CACHED_SLUG |
-    ------------------------------------------------------------------------------------------------
-    find model by id                             x1000 |   0.370 |   0.503 |   0.940 |       0.562 |
-    find model using array of ids                x1000 |   0.612 |   0.615 |   1.054 |       0.957 |
-    find model using id, then to_param           x1000 |   0.374 |   0.535 |   1.396 |       0.567 |
-    ================================================================================================
-    Total                                              |   1.356 |   1.653 |   3.390 |       2.086 |
-
-
     activerecord (3.0.0)
     ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-darwin10.4.0]
     friendly_id (3.1.4)

data/README.md

@@ -19,7 +19,20 @@ versioning, scoped slugs, reserved words, custom slug generators, and
 excellent Unicode support. For complete information on using FriendlyId,
 please see the [FriendlyId Guide](http://norman.github.com/friendly_id/file.Guide.html).
 
-FriendlyId is compatible with Active Record **2.3.x** and **3.0**.
+## Compatibility
+
+FriendlyId 3.3.0 is compatible with Active Record 3.0 and 3.1.
+
+If you are still on Rails 2.3, please use FriendlyId 3.2.x.
+
+## Roadmap
+
+FriendlyId 3.3 is now in **long term maintenance mode.** It will continue to be
+supported and maintained indefinitely, but no new features will be added to it.
+
+[FriendlyId 4.0](https://github.com/norman/friendly_id/tree/4.0.0) is a
+ground-up rewrite of FriendlyId, and is the project's future, and will be
+released by September, 2011.
 
 ## Docs, Info and Support
 
@@ -31,9 +44,6 @@ FriendlyId is compatible with Active Record **2.3.x** and **3.0**.
 
 ## Rails Quickstart
 
-Note that the example below uses Rails 3. But don't worry: FriendlyId will
-continue to support 2.3.x until Rails 3.1 is released.
-
     gem install friendly_id
 
     rails new my_app
@@ -41,7 +51,7 @@ continue to support 2.3.x until Rails 3.1 is released.
     cd my_app
 
     # add to Gemfile
-    gem "friendly_id", "~> 3.2.1"
+    gem "friendly_id", "~> 3.3.0"
 
     rails generate friendly_id
     rails generate scaffold user name:string cached_slug:string

data/lib/friendly_id/active_record.rb

@@ -1,22 +1,13 @@
 module FriendlyId
 
-  # Are we running on ActiveRecord 3 or higher?
-  def self.on_ar3?
-    ActiveRecord::VERSION::STRING >= "3"
-  end
-
   module ActiveRecordAdapter
 
     include FriendlyId::Base
 
     def has_friendly_id(method, options = {})
-      if FriendlyId.on_ar3?
-        class_attribute :friendly_id_config
-        self.friendly_id_config = Configuration.new(self, method, options)
-      else
-        class_inheritable_accessor :friendly_id_config
-        write_inheritable_attribute :friendly_id_config, Configuration.new(self, method, options)
-      end
+
+      class_attribute :friendly_id_config
+      self.friendly_id_config = Configuration.new(self, method, options)
 
       if friendly_id_config.use_slug?
         include SluggedModel
@@ -47,7 +38,6 @@ end
 
 require "friendly_id/active_record_adapter/relation"
 require "friendly_id/active_record_adapter/configuration"
-require "friendly_id/active_record_adapter/finders"
 require "friendly_id/active_record_adapter/simple_model"
 require "friendly_id/active_record_adapter/slugged_model"
 require "friendly_id/active_record_adapter/slug"
@@ -56,18 +46,11 @@ require "friendly_id/active_record_adapter/tasks"
 module ActiveRecord
   class Base
     extend FriendlyId::ActiveRecordAdapter
-    unless FriendlyId.on_ar3?
-      class << self
-        VALID_FIND_OPTIONS << :scope
-      end
-    end
   end
 
-  if defined? Relation
-    class Relation
-      alias find_one_without_friendly  find_one
-      alias find_some_without_friendly find_some
-      include FriendlyId::ActiveRecordAdapter::Relation
-    end
+  class Relation
+    alias find_one_without_friendly  find_one
+    alias find_some_without_friendly find_some
+    include FriendlyId::ActiveRecordAdapter::Relation
   end
 end

data/lib/friendly_id/active_record_adapter/simple_model.rb

@@ -10,7 +10,6 @@ module FriendlyId
           validates_presence_of column, :unless => :skip_friendly_id_validations
           validates_length_of column, :maximum => friendly_id_config.max_length, :unless => :skip_friendly_id_validations
           after_update :update_scopes
-          extend FriendlyId::ActiveRecordAdapter::Finders unless FriendlyId.on_ar3?
         end
       end
 

data/lib/friendly_id/active_record_adapter/slug.rb

@@ -2,11 +2,10 @@
 class Slug < ::ActiveRecord::Base
   attr_writer :sluggable
   attr_accessible :name, :scope, :sluggable, :sequence
-  def self.named_scope(*args, &block) scope(*args, &block) end if FriendlyId.on_ar3?
   table_name = "slugs"
   before_save :enable_name_reversion, :set_sequence
   validate :validate_name
-  named_scope :similar_to, lambda {|slug| {:conditions => {
+  scope :similar_to, lambda {|slug| {:conditions => {
         :name           => slug.name,
         :scope          => slug.scope,
         :sluggable_type => slug.sluggable_type

data/lib/friendly_id/active_record_adapter/slugged_model.rb

@@ -11,7 +11,6 @@ module FriendlyId
           after_update :update_scope
           after_update :update_dependent_scopes
           protect_friendly_id_attributes
-          extend FriendlyId::ActiveRecordAdapter::Finders unless FriendlyId.on_ar3?
         end
       end
 

data/lib/friendly_id/version.rb

@@ -3,7 +3,7 @@ module FriendlyId
     MAJOR = 3
     MINOR = 3
     TINY  = 0
-    BUILD = 'rc1'
+    BUILD = 'rc2'
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end
 end

data/test/active_record_adapter/ar_test_helper.rb

@@ -108,8 +108,7 @@ end
 # A model that uses default slug settings and has a named scope
 class Post < ActiveRecord::Base
   has_friendly_id :name, :use_slug => true
-  def self.named_scope(*args) scope(*args) end if FriendlyId.on_ar3?
-  named_scope :published, :conditions => { :published => true }
+  scope :published, :conditions => { :published => true }
 end
 
 # Model that uses a custom table name

metadata

@@ -2,7 +2,7 @@
 name: friendly_id
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 3.3.0.rc1
+  version: 3.3.0.rc2
 platform: ruby
 authors: 
 - Norman Clarke
@@ -12,11 +12,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-12 00:00:00 Z
+date: 2011-07-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: babosa
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -24,10 +23,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.3.0
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -35,10 +34,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "3.0"
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,10 +45,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.9"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: sqlite3
-  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,6 +56,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.3"
   type: :development
+  prerelease: false
   version_requirements: *id004
 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"
 email: 
@@ -72,7 +72,6 @@ extra_rdoc_files: []
 files: 
 - lib/friendly_id/active_record.rb
 - lib/friendly_id/active_record_adapter/configuration.rb
-- lib/friendly_id/active_record_adapter/finders.rb
 - lib/friendly_id/active_record_adapter/relation.rb
 - lib/friendly_id/active_record_adapter/simple_model.rb
 - lib/friendly_id/active_record_adapter/slug.rb
@@ -132,7 +131,7 @@ files:
 homepage: http://norman.github.com/friendly_id
 licenses: []
 
-post_install_message: 
+post_install_message: "    FriendlyId 3.3.x is now in long-term maintanence. For new projects with\n    Rails 3.1.x please consider using 4.0, which is under active development:\n\n    https://github.com/norman/friendly_id/tree/4.0.0\n"
 rdoc_options: []
 
 require_paths: 
@@ -142,6 +141,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -1068692454411674602
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false

data/lib/friendly_id/active_record_adapter/finders.rb

@@ -1,148 +0,0 @@
-module FriendlyId
-  module ActiveRecordAdapter
-    module Finders
-
-      class Find
-        extend Forwardable
-        def_delegators :@klass, :scoped, :friendly_id_config, :quoted_table_name, :table_name, :primary_key,
-          :connection, :name, :sanitize_sql
-        def_delegators :fc, :use_slugs?, :cache_column, :cache_column?
-        alias fc friendly_id_config
-
-        attr :klass
-        attr :id
-        attr :options
-        attr :result
-        attr :friendly_ids
-        attr :unfriendly_ids
-
-        def initialize(klass, id, options)
-          @klass     = klass
-          @id        = id
-          @options   = options
-          if options[:scope]
-            raise "The :scope finder option has been removed from FriendlyId 3.2.0 " +
-              "https://github.com/norman/friendly_id/issues#issue/88"
-          end
-        end
-
-        def find_one
-          return find_one_with_cached_slug if !fc.scope? && cache_column?
-          return find_one_with_slug if use_slugs?
-          @result = scoped(:conditions => ["#{table_name}.#{fc.column} = ?", id]).first(options)
-          assign_status
-        end
-
-        def find_some
-          parse_ids!
-          scope = some_friendly_scope
-          if use_slugs? && @friendly_ids.present?
-            scope = scope.scoped(:joins => :slugs)
-          end
-          options[:readonly] = false unless options[:readonly]
-          @result = scope.all(options).uniq
-          validate_expected_size!
-          @result.each { |record| record.friendly_id_status.name = id }
-        end
-
-        private
-
-        def find_one_with_cached_slug
-          @result = scoped(:conditions => ["#{table_name}.#{cache_column} = ?", id]).first(options)
-          assign_status or find_one_with_slug
-        end
-
-        def find_one_with_slug
-          name, seq = id.to_s.parse_friendly_id
-          scope = scoped(:joins => :slugs, :conditions => {:slugs => {:name => name, :sequence => seq}})
-          options[:readonly] = false unless options[:readonly]
-          @result = scope.first(options)
-          assign_status
-        end
-
-        def parse_ids!
-          @id = id.uniq.map do |member|
-            if member.respond_to?(:friendly_id_config)
-              member.id
-            else
-              member
-            end
-          end
-          @friendly_ids, @unfriendly_ids = @id.partition {|member| member.friendly_id?}
-        end
-
-        def validate_expected_size!
-          expected = expected_size
-          return if @result.size == expected
-          message = "Couldn't find all %s with IDs (%s) AND %s (found %d results, but was looking for %d)" % [
-            name.pluralize,
-            id.join(', '),
-            sanitize_sql(options[:conditions]),
-            result.size,
-            expected
-          ]
-          raise ActiveRecord::RecordNotFound, message
-        end
-
-        def assign_status
-          return unless @result
-          name, seq = @id.to_s.parse_friendly_id
-          @result.friendly_id_status.name = name
-          @result.friendly_id_status.sequence = seq if use_slugs?
-          @result
-        end
-
-        def expected_size
-          if options[:limit] && @id.size > options[:limit]
-            options[:limit]
-          else
-            @id.size
-          end
-        end
-
-        def some_friendly_scope
-          query_slugs = use_slugs? && !cache_column?
-          pkey      = "#{quoted_table_name}.#{primary_key}"
-          column    = "#{table_name}.#{cache_column || fc.column}"
-          if @unfriendly_ids.present?
-            conditions = ["#{pkey} IN (?)", @unfriendly_ids]
-            if @friendly_ids.present?
-              if query_slugs
-                conditions[0] << " OR #{some_slugged_conditions}"
-              else
-                conditions[0] << " OR #{column} IN (?)"
-                conditions << @friendly_ids
-              end
-            end
-          elsif @friendly_ids.present?
-            conditions = query_slugs ? some_slugged_conditions : ["#{column} IN (?)", @friendly_ids]
-          end
-          scoped(:conditions => conditions)
-        end
-
-        def some_slugged_conditions
-          return unless @friendly_ids.present?
-          slug_table = Slug.quoted_table_name
-          fragment = "(#{slug_table}.name = %s AND #{slug_table}.sequence = %d)"
-          @friendly_ids.inject(nil) do |clause, id|
-            name, seq = id.parse_friendly_id
-            string = fragment % [connection.quote(name), seq]
-            clause ? clause + " OR #{string}" : string
-          end
-        end
-      end
-
-      def find_one(id, options)
-        return super if id.blank? || id.unfriendly_id?
-        finder = Find.new(self, id, options)
-        finder.find_one or super
-      end
-
-      def find_some(ids, options)
-        return super if ids.empty?
-        finder = Find.new(self, ids, options)
-        finder.find_some
-      end
-    end
-  end
-end