friendly_id 3.1.6 → 3.1.7.pre

data/Changelog.md

@@ -6,6 +6,14 @@ suggestions, ideas and improvements to FriendlyId.
 * Table of Contents
 {:toc}
 
+## 3.1.7 (NOT RELEASED YET)
+
+* Reserved words can now be regular expressions.
+* Fix broken SQL when finding with a nil scope on AR3 (Tony Primerano)
+* Slug#sluggable now works around default scopes (Cyrille Stepanyk)
+* Explicitly make slug attributes accessible (William Melody)
+* Improve abstraction support for DataMapper and Sequel (Alex Coles).
+
 ## 3.1.6 (2010-09-02)
 
 * Fix missing sluggable type in AR3 slug query. This was a fairly major oversight, and if you

data/Contributors.md

@@ -2,6 +2,7 @@ We are grateful for many contributions from the Ruby and Rails
 community, in particular from the following people:
 
 * Adam Cigánek
+* Alex Coles
 * Alexander Gräfe
 * Alistair Holt
 * Andre Duffeck
@@ -11,6 +12,7 @@ community, in particular from the following people:
 * Brian Collins
 * Bruno Michel
 * Chris Nolan
+* Cyrille Stepanyk
 * David Ramalho
 * Diego Carrion
 * Diego R. V.
@@ -38,3 +40,4 @@ community, in particular from the following people:
 * Steve Luscher
 * Steven Noble
 * Tim Kadom
+* William Melody

data/Guide.md

@@ -110,6 +110,7 @@ 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
@@ -128,9 +129,9 @@ FriendlyId is configured in your model using the `has_friendly_id` method:
     class Post < ActiveRecord::Base
       # use the "title" column as the basis of the friendly_id, and use slugs
       has_friendly_id :title, :use_slug => true,
-        # remove accents and other diacritics from Western characters
+        # remove accents and other diacritics from Latin characters
         :approximate_ascii => true,
-        # don't use slugs longer than 50 chars
+        # don't use slugs larger than 50 bytes
         :max_length => 50
     end
 
@@ -193,7 +194,7 @@ Greek, etc:
 
 ### ASCII Slugs
 
-You can also configure FriendlyId using `:strip_non_ascii` to completely delete
+You can also configure FriendlyId using `:strip_non_ascii` to simply delete
 any non-ascii characters:
 
     class Post < ActiveRecord::Base
@@ -244,14 +245,13 @@ order to fine-tune the output:
     end
 
 The normalize_friendly_id method takes a single argument and receives an
-instance of {FriendlyId::SlugString}, a class which wraps a regular Ruby
-string with some additional formatting options inherits Multibyte support from
-ActiveSupport::Multibyte::Chars.
+instance of {FriendlyId::SlugString}, a class which wraps a regular Ruby string
+with additional formatting options.
 
-### Converting non-Western characters to ASCII with Stringex
+### Converting non-Latin characters to ASCII with Stringex
 
 Stringex is a library which provides some interesting options for transliterating
-non-Western strings to ASCII:
+non-Latin strings to ASCII:
 
     "你好".to_url => "ni-hao"
 
@@ -260,13 +260,21 @@ the `stringex` gem, and overriding the `normalize_friendly_id` method in your
 model:
 
     class City < ActiveRecord::Base
-
       def normalize_friendly_id(text)
         text.to_url
       end
-
     end
 
+However, be aware of some limitations of Stringex - it just does a context-free
+character-by-character approximation for Unicode strings without sensitivity to
+the string's language. This means, for example, that the Han characters used by
+Japanese, Mandarin, Cantonese, and other languages are all replaced with the
+same ASCII text. For Han characters, Stringex uses Mandarin, which makes its
+output on Japanese text useless. You can read more about the limitations of
+Stringex in [the documentation for
+Unidecoder](http://search.cpan.org/~sburke/Text-Unidecode-0.04/lib/Text/Unidecode.pm#DESIGN_GOALS_AND_CONSTRAINTS),
+the Perl library upon which Stringex is based.
+
 ## Redirecting to the Current Friendly URL
 
 FriendlyId maintains a history of your record's older slugs, so if your
@@ -316,6 +324,9 @@ You can also override the default used in
 FriendlyId. If you change this value in an existing application, be sure to
 {file:Guide.md#regenerating_slugs regenerate the slugs} afterwards.
 
+For reasons I hope are obvious, you can't change this value to "-". If you try,
+FriendlyId will raise an error.
+
 ## Reserved Words
 
 You can configure a list of strings as reserved so that, for example, you
@@ -331,6 +342,9 @@ Reserved words are configured using the `:reserved_words` option:
       has_friendly_id :name, :use_slug => true, :reserved_words => ["my", "values"]
     end
 
+The reserved words can be specified as an array or (since 3.1.7) as a regular
+expression.
+
 The strings "new" and "index" are reserved by default. When you attempt to
 store a reserved value, FriendlyId raises a
 {FriendlyId::ReservedError}. You can also override the default
@@ -372,9 +386,8 @@ A few warnings when using this feature:
   unless you have already invoked `attr_accessible`. If you wish to use
   `attr_accessible`, you must invoke it BEFORE you invoke `has_friendly_id` in
   your class.
-* FriendlyId can not query against the slug cache when you pass a :scope
-  argument to #find. Try to avoid passing an array of friendly id's and a
-  scope to #find, as this will result in weak performance.
+* Cached slugs [are incompatible with scopes](#scoped_models_and_cached_slugs) and
+  are ignored if your model uses the `:scope option`.
 
 ### Using a custom column name
 
@@ -434,7 +447,7 @@ the slug "joes-diner" if it's located in a different city:
 
     Restaurant.find("joes-diner", :scope => "seattle")  # returns 1 record
     Restaurant.find("joes-diner", :scope => "chicago")  # returns 1 record
-    Restaurant.find("joes-diner")                       # returns both records
+    Restaurant.find(:all, "joes-diner")                 # returns both records
 
 The value for the `:scope` key in your model can be a custom method you
 define, or the name of a relation. If it's the name of a relation, then the
@@ -465,6 +478,15 @@ this up:
     # in controllers
     @restaurant = Restaurant.find(params[:id], :scope => params[:scope])
 
+### Scoped Models and Cached Slugs
+
+Be aware that you can't use cached slugs with scoped models. This is because in
+order to uniquely identify a scoped model, you need to consult two fields rather
+than one. I've considered adding a "cached scope" column as well as one for the
+cached slug, but I'm not convinced this is a good idea. FriendlyId 3.1.6 and
+above included significant performance optimizations for models that don't use
+cached slugs, so in practice this ends up being [less of a performance problem
+than you may imagine](#some_benchmarks).
 
 ## FriendlyId Rake Tasks
 

data/README.md

@@ -31,6 +31,9 @@ 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
@@ -58,11 +61,13 @@ FriendlyId is compatible with Active Record **2.3.x** and **3.0**.
 
 ## 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:
+[Alex Coles](http://github.com/myabc) maintains an implemntation of
+[FriendlyId for DataMapper](http://github.com/myabc/friendly_id_datamapper) that supports almost
+all the features of the Active Record version.
 
-* [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)
+Norman Clarke maintains an implementation of
+[FriendlyId forSequel](http://github.com/norman/friendly_id_sequel) with some of the features
+of the Active Record version.
 
 ## Bugs
 

data/Rakefile

@@ -41,6 +41,18 @@ namespace :test do
   Rake::TestTask.new(:friendly_id) { |t| t.pattern = "test/*_test.rb" }
   Rake::TestTask.new(:ar) { |t| t.pattern = "test/active_record_adapter/*_test.rb" }
 
+  task :pre_release do
+    ["ree-1.8.7-2010.02", "ruby-1.9.2-p0"].each do |ruby|
+      ["sqlite3", "mysql", "postgres"].each do |driver|
+        [2, 3].each do |ar_version|
+          command = "rake-#{ruby} test AR=#{ar_version} DB=#{driver}"
+          puts command
+          puts `#{command}`
+        end
+      end
+    end
+  end
+
   namespace :rails do
     task :plugin do
       rm_rf "fid"
@@ -48,7 +60,6 @@ namespace :test do
       sh "cd fid; rake test"
     end
   end
-
 end
 
 task :pushdocs do

data/lib/friendly_id/active_record_adapter/configuration.rb

@@ -44,7 +44,8 @@ module FriendlyId
       end
 
       def scope_for(record)
-        scope? ? record.send(scope).to_param : nil
+        return nil unless scope?
+        record.send(scope).nil? ? nil : record.send(scope).to_param 
       end
 
       def scopes_over?(klass)

data/lib/friendly_id/active_record_adapter/relation.rb

@@ -106,12 +106,16 @@ module FriendlyId
             clause ? clause + " OR #{string}" : string
           end
           if fc.scope?
-            scope = connection.quote(friendly_id_scope)
-            conditions = "slugs.scope = %s AND (%s)" % [scope, conditions]
+            conditions = if friendly_id_scope
+              scope = connection.quote(friendly_id_scope)
+              "slugs.scope = %s AND (%s)" % [scope, conditions]
+            else
+              "slugs.scope IS NULL AND (%s)" % [conditions]
+            end
           end
           sql = "SELECT sluggable_id FROM slugs WHERE (%s)" % conditions
           connection.select_values sql
-       end
+        end
 
         def validate_expected_size!(ids, result)
           expected_size =

data/lib/friendly_id/active_record_adapter/slug.rb

@@ -1,9 +1,9 @@
 # A Slug is a unique, human-friendly identifier for an ActiveRecord.
 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"
-  belongs_to :sluggable, :polymorphic => true
   before_save :enable_name_reversion, :set_sequence
   validate :validate_name
   named_scope :similar_to, lambda {|slug| {:conditions => {
@@ -15,6 +15,16 @@ class Slug < ::ActiveRecord::Base
     }
   }
 
+  def sluggable
+    sluggable_id && !@sluggable and begin
+      klass = sluggable_type.constantize
+      klass.send(:with_exclusive_scope) do
+        @sluggable = klass.find(sluggable_id.to_i)
+      end
+    end
+    @sluggable
+  end
+
   # Whether this slug is the most recent of its owner's slugs.
   def current?
     sluggable.slug == self

data/lib/friendly_id/configuration.rb

@@ -9,16 +9,16 @@ module FriendlyId
   # attributes below for information on the possible options.
   #
   # @example
-  # has_friendly_id :name,
-  #  :use_slug => true,
-  #  :max_length => 150,
-  #  :approximate_ascii => true,
-  #  :ascii_approximation_options => :german,
-  #  :sequence_separator => ":",
-  #  :reserved_words => ["reserved", "words"],
-  #  :scope => :country,
-  #  :cache_column => :my_cache_column_name
-  #  # etc.
+  #   has_friendly_id :name,
+  #    :use_slug => true,
+  #    :max_length => 150,
+  #    :approximate_ascii => true,
+  #    :ascii_approximation_options => :german,
+  #    :sequence_separator => ":",
+  #    :reserved_words => ["reserved", "words"],
+  #    :scope => :country,
+  #    :cache_column => :my_cache_column_name
+  #    # etc.
   class Configuration
 
     DEFAULTS = {
@@ -98,12 +98,21 @@ module FriendlyId
       false
     end
 
-    def reserved_words=(*words)
-      @reserved_words = words.flatten.uniq
+    def reserved_words=(*args)
+      if args.first.kind_of?(Regexp)
+        @reserved_words = args.first
+      else
+        @reserved_words = args.flatten.uniq
+      end
     end
 
     def reserved?(word)
-      reserved_words.include? word.to_s
+      word = word.to_s
+      if reserved_words.kind_of?(Regexp)
+        reserved_words =~ word
+      else
+        reserved_words.include?(word)
+      end
     end
 
     def reserved_error_message(word)
@@ -136,7 +145,7 @@ module FriendlyId
     end
 
     %w[approximate_ascii scope strip_non_ascii use_slug].each do |method|
-      class_eval(<<-EOM, __FILE__, __LINE__ +1)
+      class_eval(<<-EOM, __FILE__, __LINE__ + 1)
         def #{method}?
           !! #{method}
         end

data/lib/friendly_id/test.rb

@@ -60,7 +60,7 @@ module FriendlyId
             assert !i
           else
             instance = i
-            assert_not_empty instance.errors
+            assert !instance.errors.empty?
           end
         end
       end
@@ -128,6 +128,20 @@ module FriendlyId
         assert_equal other_instance.friendly_id, instance.friendly_id
       end
 
+      test "reserved words can be specified as a regular expression" do
+        klass.friendly_id_config.stubs(:reserved_words).returns(/jo/)
+        assert_validation_error do
+          klass.send(create_method, :name => "joe")
+        end
+      end
+
+      test "should not raise reserved error unless regexp matches" do
+        klass.friendly_id_config.stubs(:reserved_words).returns(/ddsadad/)
+        assert_nothing_raised do
+          klass.send(create_method, :name => "joe")
+        end
+      end
+
     end
 
     module Simple
@@ -286,7 +300,7 @@ module FriendlyId
 
       [:record, :name].each do |symbol|
         test "should have #{symbol} after find using friendly_id" do
-          instance2 = klass.find(instance.friendly_id)
+          instance2 = klass.send(find_method, instance.friendly_id)
           assert_not_nil instance2.friendly_id_status.send(symbol)
         end
       end

data/lib/friendly_id/version.rb

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

data/test/active_record_adapter/ar_test_helper.rb

@@ -3,7 +3,7 @@ require "logger"
 require "active_record"
 begin
   require "active_support/log_subscriber"
-rescue MissingSourceFile
+rescue LoadError
 end
 
 # If you want to see the ActiveRecord log, invoke the tests using `rake test LOG=true`
@@ -15,11 +15,9 @@ 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)))
+driver = (ENV["DB"] or "sqlite3").downcase
+db_yaml = File.expand_path("../support/database.#{driver}.yml", __FILE__)
+ActiveRecord::Base.establish_connection(YAML::load(File.open(db_yaml)))
 
 class ActiveRecord::Base
   def log_protected_attribute_removal(*args) end
@@ -148,3 +146,5 @@ end
 class Company < ActiveRecord::Base
   has_many :sites, :as => :owner
 end
+
+puts "Using: #{RUBY_VERSION}, #{driver}, AR#{ENV["AR"] or 3}"

data/test/active_record_adapter/default_scope_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../ar_test_helper', __FILE__)
+
+ActiveRecord::Migration.create_table :articles do |t|
+  t.string :name
+  t.string :status
+end
+
+class Article < ActiveRecord::Base
+  has_friendly_id :name, :use_slug => true
+  default_scope :conditions => "articles.status = 'published'"
+end
+
+module FriendlyId
+  module Test
+    module ActiveRecordAdapter
+      class DefaultScopeTest < ::Test::Unit::TestCase
+
+        def setup
+          Article.delete_all
+          Slug.delete_all
+        end
+
+        test "slug should load sluggable without default scope" do
+          Article.create!(:name => "hello world", :status => "draft")
+          assert_not_nil Slug.first.sluggable
+        end
+      end
+    end
+  end
+end

data/test/active_record_adapter/scoped_model_test.rb

@@ -86,6 +86,11 @@ module FriendlyId
         assert Resident.find(@resident.friendly_id, :scope => @resident.country)
       end
 
+      test "should find a single scoped record with a nil scope" do
+        nomad  = Resident.create!(:name => "Homer", :country => nil)
+        assert Resident.find(nomad.friendly_id, :scope => nil)
+      end
+
       test "should find a multiple scoped records with a scope" do
         r1 = Resident.create!(:name => "John Smith", :country => @usa)
         r2 = Resident.create!(:name => "Jane Smith", :country => @usa)

data/test/active_record_adapter/slugged_status_test.rb

@@ -18,8 +18,11 @@ module FriendlyId
           @instance ||= klass.create! :name => "hello world"
         end
 
+        def find_method
+          :find
+        end
+
       end
     end
   end
 end
-

metadata

@@ -1,12 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: friendly_id
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 961916000
+  prerelease: true
   segments: 
   - 3
   - 1
-  - 6
-  version: 3.1.6
+  - 7
+  - pre
+  version: 3.1.7.pre
 platform: ruby
 authors: 
 - Norman Clarke
@@ -16,24 +18,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -03:00
+date: 2010-09-14 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   name: babosa
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 2
         - 0
         version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *id001
+  requirement: *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
@@ -81,6 +84,7 @@ files:
 - test/active_record_adapter/core.rb
 - test/active_record_adapter/custom_normalizer_test.rb
 - test/active_record_adapter/custom_table_name_test.rb
+- test/active_record_adapter/default_scope_test.rb
 - test/active_record_adapter/optimistic_locking_test.rb
 - test/active_record_adapter/scoped_model_test.rb
 - test/active_record_adapter/simple_test.rb
@@ -116,19 +120,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -182801105258368267
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: -182801105258368267
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: friendly-id
@@ -141,6 +147,7 @@ test_files:
 - test/active_record_adapter/cached_slug_test.rb
 - test/active_record_adapter/custom_normalizer_test.rb
 - test/active_record_adapter/custom_table_name_test.rb
+- test/active_record_adapter/default_scope_test.rb
 - test/active_record_adapter/optimistic_locking_test.rb
 - test/active_record_adapter/scoped_model_test.rb
 - test/active_record_adapter/simple_test.rb