friendly_id 3.1.0.pre → 3.1.0

data/Changelog.md

@@ -6,15 +6,16 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
-## 3.1.0 (NOT RELEASED)
+## 3.1.0 (2010-07-29)
 
 * Refactored/simplified Active Record 2 and 3 query code.
 * Better support for Active Record 3 finds and scopes.
 * Extract slug handling code into separate gem, [Babosa](http://github.com/norman/babosa).
-* :max-length option now uses bytes rather than characters.
+* `:max-length` option now uses bytes rather than characters.
 * Fix quoting issue that prevented using a domain- or database-qualified column. (thanks James Cropcho)
 * Support for Active Record 2.2.x dropped; 2.3 or above is now required.
 * Fixed a few small errors on Postgres.
+* Improved porability for Sequel and in-progress DataMapper adapter.
 
 ## 3.0.6 (2010-06-10)
 
@@ -93,7 +94,7 @@ fork, then this upgrade may causes issues.
 **Changes:**
 
 * Sequence separator can now be configured to something other than "--".
-* New option to pass arguments to {FriendlyId::SlugString#approximate_ascii!},
+* New option to pass arguments to `FriendlyId::SlugString#approximate_ascii!`,
   allowing custom approximations specific to German or Spanish.
 * FriendlyId now queries against the cached_slug column, which improves performance.
 * {FriendlyId::SlugString} class added, allowing finer-grained control over

data/Guide.md

@@ -6,7 +6,7 @@
 ## Overview
 
 FriendlyId is a Ruby gem which allows you to work with human-friendly strings
-as if they were numeric ids for ActiveRecord models. This facilitates replacing
+as if they were numeric ids for Active Record models. This facilitates replacing
 "unfriendly" URL's like
 
     http://example.com/states/4323454
@@ -66,13 +66,13 @@ 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.2.x, 2.3.x. and 3.0.
+with Rails 2.3.x. and 3.0.
 
 ### As a Gem
 
     gem install friendly_id
 
-#### Rails 2.2.x - 2.3.x
+#### Rails 2.3.x
 
 After installing the gem, add an entry in environment.rb:
 
@@ -142,9 +142,8 @@ modify the slug text to make it more suitable for use in a URL:
     @city.create :name => "Viña del Mar"
     @city.friendly_id  # will be "viña-del-mar"
 
-By default, the string is {FriendlyId::SlugString#downcase! downcased} and
-{FriendlyId::SlugString#clean! stripped}, {FriendlyId::SlugString#with_dashes! spaces are replaced with dashes},
-and {FriendlyId::SlugString#word_chars! non-word characters are removed}.
+By default, the string is downcased and stripped, spaces are replaced with
+dashes, and non-word characters other than "-" are removed.
 
 ### Replacing Accented Characters
 
@@ -361,8 +360,8 @@ Then, redo the slugs:
 
     rake friendly_id:redo_slugs MODEL=User
 
-FriendlyId will also query against the cache column if it's available, which
-can significantly improve the performance of many queries, particularly when
+FriendlyId will automatically query against the cache column if it's available,
+which significantly improves the performance of many queries, particularly when
 passing an array of friendly ids to #find.
 
 A few warnings when using this feature:
@@ -396,9 +395,13 @@ You can choose to allow `nil` friendly_ids via the `:allow_nil` config option:
 
 This works whether the model uses slugs or not.
 
-For slugged models, if the friendly_id text is `nil`, no slug will be created. This can be useful, for example, to only create slugs for published articles and avoid creating many slugs with sequences.
+For slugged models, if the friendly_id text is `nil`, no slug will be created.
+This can be useful, for example, to only create slugs for published articles
+and avoid creating many slugs with sequences.
 
-For models that don't use slugs, this will make FriendlyId skip all its validations when the friendly_id text is `nil`. This can be useful, for example, if you wish to add the friendly_id value in an `:after_save` callback.
+For models that don't use slugs, this will make FriendlyId skip all its
+validations when the friendly_id text is `nil`. This can be useful, for
+example, if you wish to add the friendly_id value in an `:after_save` callback.
 
 For non-slugged models, if you simply wish to skip friendly_ids's validations
 for some reason, you can override the `skip_friendly_id_validations` method.
@@ -489,6 +492,26 @@ slugs older than 45 days.
 
 # Misc tips
 
+## Default Scopes
+
+Whether you're using FriendlyId or not, a good rule of thumb for default scopes
+is to always use your model's table name. Otherwise any time you do a join, you
+risk having queries fail because of duplicate column names - particularly for a
+default scope like this one:
+
+    default_scope :order => "created_at DESC"
+
+Instead, do this:
+
+    default_scope :order => = "#{quoted_table_name}.created_at DESC"
+
+Or even better, unless you're using a custom primary key:
+
+    default_scope :order => = "#{quoted_table_name}.id DESC"
+
+because sorting by a unique integer column is faster than sorting by a date
+column.
+
 ## MySQL 5.0 or less
 
 Currently, the default FriendlyId migration will not work with MySQL 5.0 or less
@@ -547,4 +570,4 @@ enabled. But if it is, then your patches would be very welcome!
     find model using array of ids                x1000 |   0.708 |   0.722 |   6.483 |       0.782 |
     find model using id, then to_param           x1000 |   0.506 |   0.645 |   2.644 |       0.637 |
     ================================================================================================
-    Total                                              |   1.709 |   1.976 |  10.645 |       2.061 |
+    Total                                              |   1.709 |   1.976 |  10.645 |       2.061 |

data/README.md

@@ -2,7 +2,7 @@
 
 FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
 Ruby on Rails. It allows you to create pretty URL's and work with
-human-friendly strings as if they were numeric ids for ActiveRecord models.
+human-friendly strings as if they were numeric ids for Active Record models.
 
 Using FriendlyId, it's easy to make your application use URL's like:
 
@@ -19,7 +19,7 @@ versioning, scoped slugs, reserved words, custom slug generators, and
 excellent Unicode support. For complete information on using FriendlyId,
 please see the {http://norman.github.com/friendly_id/file.Guide.html FriendlyId Guide}.
 
-FriendlyId is compatible with Rails 2.3.x and 3.0.
+FriendlyId is compatible with Active Record 2.3.x and 3.0.
 
 ## Rails Quickstart
 
@@ -48,6 +48,14 @@ FriendlyId is compatible with Rails 2.3.x and 3.0.
 
     GET http://0.0.0.0:3000/users/joe-schmoe
 
+## Sequel and DataMapper, too
+
+FriendlyId has experimental support for Sequel. Support for Datamapper is
+in progress. To find out more, check out the Github projects:
+
+* [http://github.com/norman/friendly_id_sequel](http://github.com/norman/friendly_id_sequel)
+* [http://github.com/myabc/friendly_id_datamapper](http://github.com/myabc/friendly_id_datamapper)
+
 ## Docs, Info and Support
 
 * [FriendlyId Guide](http://norman.github.com/friendly_id/file.Guide.html)

data/lib/friendly_id.rb

@@ -1,13 +1,5 @@
 require "babosa"
 require "forwardable"
-require "active_support/core_ext/class/attribute_accessors"
-begin
-  require "active_support/core_ext/object/blank"
-rescue MissingSourceFile
-  # support for ActiveSupport < 2.3.5
-  require "active_support/core_ext/blank"
-end
-
 require "friendly_id/slug_string"
 require "friendly_id/configuration"
 require "friendly_id/status"

data/lib/friendly_id/active_record_adapter/tasks.rb

@@ -63,7 +63,5 @@ module FriendlyId
     rescue NoMethodError
       raise "Class '%s' doesn't use FriendlyId" % klass.to_s
     end
-
   end
-
 end

data/lib/friendly_id/configuration.rb

@@ -39,8 +39,8 @@ module FriendlyId
     # Strip diacritics from Western characters.
     attr_accessor :approximate_ascii
 
-    # Locale-type options for ASCII approximations. These can be any of the
-    # values supported by {SlugString#approximate_ascii!}.
+    # Locale-type options for ASCII approximations. These currently be
+    # +:german+ or +:spanish+.
     attr_accessor :ascii_approximation_options
 
     # The class that's using the configuration.
@@ -86,6 +86,11 @@ module FriendlyId
       yield self if block_given?
     end
 
+    # This should be overridden by adapters that implement caching.
+    def cache_column?
+      false
+    end
+
     def reserved_words=(*words)
       @reserved_words = words.flatten.uniq
     end
@@ -110,4 +115,4 @@ module FriendlyId
 
   end
 
-end
+end

data/lib/friendly_id/datamapper.rb

@@ -0,0 +1,5 @@
+begin
+  require 'friendly_id_datamapper'
+rescue LoadError
+  raise "To use FriendlyId's DataMapper adapter, please `gem install friendly_id_datamapper`"
+end

data/lib/friendly_id/railtie.rb

@@ -5,9 +5,11 @@ module FriendlyId
       # Experimental Sequel support. See: http://github.com/norman/friendly_id_sequel
       if app.config.generators.rails[:orm] == :sequel
         require "friendly_id/sequel"
+      # Experimental DataMapper support. See: http://github.com/myabc/friendly_id_datamapper
+      elsif app.config.generators.rails[:orm] == :data_mapper
+        require 'friendly_id/datamapper'
       else
-        # Only Sequel and ActiveRecord are currently supported; AR is the default.
-        # Want Datamapper support? http://github.com/norman/friendly_id/issues#issue/24
+        # AR is the default.
         require "friendly_id/active_record"
       end
     end
@@ -17,4 +19,4 @@ module FriendlyId
     end
 
   end
-end
+end

data/lib/friendly_id/test.rb

@@ -49,6 +49,22 @@ module FriendlyId
         return RuntimeError
       end
 
+      def assert_validation_error
+        if validation_exceptions
+          assert_raise(*[validation_exceptions].flatten) do
+            yield
+          end
+        else  # DataMapper does not raise Validation Errors
+          i = yield
+          if i.kind_of?(TrueClass) || i.kind_of?(FalseClass)
+            assert !i
+          else
+            instance = i
+            assert_not_empty instance.errors
+          end
+        end
+      end
+
       test "models should have a friendly id config" do
         assert_not_nil klass.friendly_id_config
       end
@@ -75,29 +91,29 @@ module FriendlyId
 
       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)
+        assert_equal instance, klass.send(find_method, "206")
       end
 
       test "creation should raise an error if the friendly_id text is reserved" do
-        assert_raise(*[validation_exceptions].flatten) do
+        assert_validation_error 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
+        assert_validation_error 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
+        assert_validation_error 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
+        assert_validation_error do
           klass.send(create_method, :name => nil)
         end
       end
@@ -142,7 +158,12 @@ module FriendlyId
       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(true).size
+        slugs = if instance.slugs.respond_to?(:reload)
+          instance.slugs.reload
+        else
+          instance.slugs(true)
+        end
+        assert_equal 2, slugs.size
       end
 
       test "should be able to reuse an old friendly_id without incrementing the sequence" do
@@ -197,7 +218,7 @@ module FriendlyId
         instance = klass.send(create_method, :name => "hello")
         assert instance.friendly_id
         instance.name = nil
-        assert_raise(*[validation_exceptions].flatten) do
+        assert_validation_error do
           instance.send(save_method)
         end
       end
@@ -300,10 +321,14 @@ module FriendlyId
 
       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")
+        if validation_exceptions
+          assert_raise(*[validation_exceptions].flatten) do
+            klass.send(create_method, :name => "Joe")
+          end
+        else  # DataMapper does not raise Validation Errors
+          instance = klass.send(create_method, :name => "Joe")
+          assert !instance.errors.empty?
         end
-
       end
 
     end

data/lib/friendly_id/version.rb

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

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: friendly_id
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 3
   - 1
   - 0
-  - pre
-  version: 3.1.0.pre
+  version: 3.1.0
 platform: ruby
 authors: 
 - Norman Clarke
@@ -17,27 +16,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 -03:00
+date: 2010-07-29 00:00:00 -03:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: babosa
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -48,7 +33,7 @@ dependencies:
         - 0
         version: 0.1.0
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 description: "    FriendlyId is the \"Swiss Army bulldozer\" of slugging and permalink plugins\n    for Ruby on Rails. It allows you to create pretty URL\xE2\x80\x99s and work with\n    human-friendly strings as if they were numeric ids for ActiveRecord models.\n"
 email: 
 - norman@njclarke.com
@@ -70,6 +55,7 @@ files:
 - lib/friendly_id/active_record_adapter/slugged_model.rb
 - lib/friendly_id/active_record_adapter/tasks.rb
 - lib/friendly_id/configuration.rb
+- lib/friendly_id/datamapper.rb
 - lib/friendly_id/railtie.rb
 - lib/friendly_id/sequel.rb
 - lib/friendly_id/slug_string.rb
@@ -136,13 +122,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: friendly-id