friendly_id 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 558d42d05561510d3b878d6c55a99eaac461d189
-  data.tar.gz: b56ebd579507441df27d8aa42e0b837d2ce0fc60
+  metadata.gz: 4c3bf1c2fe2200df982e5bad6a9cca5bdaed5c48
+  data.tar.gz: b79c9c881c70320e7281014ca3296888b2387caa
 SHA512:
-  metadata.gz: 0e11d6d309df06e6177eb24c03af2aff0f3119f5c545b15e8088599d19f62242266e71c01aa69beda1ccb2c4b8a113a651fdb25ab10ef54b856a552284bd02dd
-  data.tar.gz: 0eef987342060880f7d713948f8f12e04e90efbe89059e34debda4a78026989170538410ba9b981feaaf5df424fa8e475bfe51492049372dae4a023faad385c9
+  metadata.gz: 38f17a8c8fd139b9a56fae5d76fa7e798775c9b9beb6c7daeb319b28cb10e173c4bfe5f6735ffb8b43fdc3124622bf478d3874630947004be432761df40574d8
+  data.tar.gz: e5cd66308d2e38adccf5797679fa8b35fd47a7ed0cfd076b404fd5d9f2ed137ae108d0b428245b714ebf8b3aaf3b878baa9afb5cfaec210fe339b44eca24914a

data/.travis.yml

@@ -10,4 +10,4 @@ gemfile:
   - gemfiles/Gemfile.rails-stable.rb
 
 before_script: 'bundle exec rake db:create db:up'
-script: 'bundle exec rake test'
+script: 'COVERAGE=true bundle exec rake test'

data/Changelog.md

@@ -3,6 +3,13 @@
 We would like to think our many {file:Contributors contributors} for
 suggestions, ideas and improvements to FriendlyId.
 
+## 5.0.2 (2013-12-10)
+
+* Query performance improvements ([#497](https://github.com/norman/friendly_id/pull/497)).
+* Documentation improvements (thanks [John Bachir](https://github.com/jjb)).
+* Minor refactoring of internals (thanks [Gagan Ahwad](https://github.com/gaganawhad)).
+* Set slug to `nil` on call to `dup` to ensure slug is generated ([#483](https://github.com/norman/friendly_id/pull/483)).
+
 ## 5.0.1 (2013-10-27)
 
 * Fix compatibility with Rails 4.0.1.rc3 (thanks [Herman verschooten](https://github.com/Hermanverschooten)).

data/README.md

@@ -16,13 +16,13 @@ over and over and over again in the issues.
 
 **Rails 4**:
 
-The master branch of this repository contains FriendlyId 5, which is compatible
-with Rails 4. This version is in beta and will be released soon.
+The master branch of this repository contains FriendlyId 5, the current stable version.
+5.x is the only version that is compatible with Rails 4.
 
 **Rails 3**:
 
 If you wish to use this gem with Rails 3.1 or 3.2 you must use FriendlyId 4,
-which is the current stable release. Please see the [4.0-stable
+which is the previous stable release. Please see the [4.0-stable
 branch](https://github.com/norman/friendly_id/tree/4.0-stable).
 
 # FriendlyId
@@ -49,7 +49,7 @@ versioning, i18n, scoped slugs, reserved words, and custom slug generators.
 
 ### What Changed in Version 5.0
 
-As of version 5.0, FriendlyId uses semantic versioning. Therefore, as you might
+As of version 5.0, FriendlyId uses [semantic versioning](http://semver.org/). Therefore, as you might
 infer from the version number, 5.0 introduces changes incompatible with 4.0.
 
 The most important changes are:
@@ -57,66 +57,61 @@ The most important changes are:
 * Finders are no longer overridden by default. If you want to do friendly finds,
   you must do `Model.friendly.find` rather than `Model.find`. You can however
   restore FriendlyId 4-style finders by using the `:finders` addon:
-
-          friendly_id :foo, use: :slugged # you must do MyClass.friendly.find('bar')
-          # or...
-          friendly_id :foo, use: [:slugged, :finders] # you can now do MyClass.find('bar')
-
-
+  ```ruby
+  friendly_id :foo, use: :slugged # you must do MyClass.friendly.find('bar')
+  # or...
+  friendly_id :foo, use: [:slugged, :finders] # you can now do MyClass.find('bar')
+  ```
 * A new "candidates" functionality which makes it easy to set up a list of
   alternate slugs that can be used to uniquely distinguish records, rather than
   appending a sequence. For example:
 
-          class Restaurant < ActiveRecord::Base
-            extend FriendlyId
-            friendly_id :slug_candidates, use: :slugged
-
-            # Try building a slug based on the following fields in
-            # increasing order of specificity.
-            def slug_candidates
-              [
-                :name,
-                [:name, :city],
-                [:name, :street, :city],
-                [:name, :street_number, :street, :city]
-              ]
-            end
-          end
-
+  ```ruby
+  class Restaurant < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :slug_candidates, use: :slugged
+
+    # Try building a slug based on the following fields in
+    # increasing order of specificity.
+    def slug_candidates
+      [
+        :name,
+        [:name, :city],
+        [:name, :street, :city],
+        [:name, :street_number, :street, :city]
+      ]
+    end
+  end
+  ```
 * Now that candidates have been added, FriendlyId no longer uses a numeric
   sequence to differentiate conflicting slug, but rather a UUID (e.g. something
   like `2bc08962-b3dd-4f29-b2e6-244710c86106`). This makes the
   codebase simpler and more reliable when running concurrently, at the expense
   of uglier ids being generated when there are conflicts.
-
 * The default sequence separator has been changed from two dashes to one dash.
-
 * Slugs are no longer regenerated when a record is saved. If you want to regenerate
   a slug, you must explicitly set the slug column to nil:
 
-          restaurant.friendly_id # joes-diner
-          restaurant.name = "The Plaza Diner"
-          restaurant.save!
-          restaurant.friendly_id # joes-diner
-          restaurant.slug = nil
-          restaurant.save!
-          restaurant.friendly_id # the-plaza-diner
+  ```ruby
+  restaurant.friendly_id # joes-diner
+  restaurant.name = "The Plaza Diner"
+  restaurant.save!
+  restaurant.friendly_id # joes-diner
+  restaurant.slug = nil
+  restaurant.save!
+  restaurant.friendly_id # the-plaza-diner
+  ```
 
   You can restore some of the old behavior by overriding the
   `should_generate_new_friendly_id?` method.
-
 * The `friendly_id` Rails generator now generates an initializer showing you
-  how to do some commmon global configuration.
-
+  how to do some common global configuration.
 * The Globalize plugin has moved to a separate gem (currently in alpha).
-
 * The `:reserved` module no longer includes any default reserved words.
   Previously it blocked "edit" and "new" everywhere. The default word list has
   been moved to `config/initializers/friendly_id.rb` and now includes many more
   words.
-
 * The `:history` and `:scoped` addons can now be used together.
-
 * Since it now requires Rails 4, FriendlyId also now requires Ruby 1.9.3 or
   higher.
 
@@ -133,10 +128,12 @@ the new `:scope` column.
 
 A migration like this should be sufficient:
 
-    add_column   :friendly_id_slugs, :scope, :string
-    remove_index :friendly_id_slugs, [:slug, :sluggable_type]
-    add_index    :friendly_id_slugs, [:slug, :sluggable_type]
-    add_index    :friendly_id_slugs, [:slug, :sluggable_type, :scope], unique: true
+```ruby
+add_column   :friendly_id_slugs, :scope, :string
+remove_index :friendly_id_slugs, [:slug, :sluggable_type]
+add_index    :friendly_id_slugs, [:slug, :sluggable_type]
+add_index    :friendly_id_slugs, [:slug, :sluggable_type, :scope], unique: true
+```
 
 ## Docs
 

data/friendly_id.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activerecord', '~> 4.0.0'
 
+  s.add_development_dependency 'coveralls'
   s.add_development_dependency 'railties', '~> 4.0.0'
   s.add_development_dependency 'minitest', '>= 4.4.0'
   s.add_development_dependency 'mocha', '~> 0.13.3'

data/lib/friendly_id/base.rb

@@ -246,5 +246,10 @@ often better and easier to use {FriendlyId::Slugged slugs}.
         friendly_id.presence.to_param || super
       end
     end
+
+    # Clears slug on duplicate records when calling `dup`.
+    def dup
+      super.tap { |duplicate| duplicate.slug = nil }
+    end
   end
 end

data/lib/friendly_id/history.rb

@@ -81,7 +81,7 @@ method.
       include ::FriendlyId::FinderMethods
 
       def exists_by_friendly_id?(id)
-        joins(:slugs).where(arel_table[friendly_id_config.query_field].eq(id).or(slug_history_clause(id))).exists?
+        joins(:slugs).where(arel_table[friendly_id_config.query_field].eq(id)).exists? || joins(:slugs).where(slug_history_clause(id)).exists?
       end
 
       private

data/lib/friendly_id/scoped.rb

@@ -121,7 +121,7 @@ an example of one way to set this up:
       friendly_id_config.scope_columns.sort.map { |column| "#{column}:#{send(column)}" }.join(",")
     end
 
-    def slug_generator
+    def scope_for_slug_generator
       relation = self.class.unscoped.friendly
       friendly_id_config.scope_columns.each do |column|
         relation = relation.where(column => send(column))
@@ -130,7 +130,12 @@ an example of one way to set this up:
         column = self.class.quoted_table_name + '.' + self.class.quoted_primary_key
         relation = relation.where("#{column} <> ?", send(self.class.primary_key))
       end
-      friendly_id_config.slug_generator_class.new(relation)
+      relation
+    end
+    private :scope_for_slug_generator
+    
+    def slug_generator
+      friendly_id_config.slug_generator_class.new(scope_for_slug_generator)
     end
     private :slug_generator
 

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.0.1"
+  VERSION = "5.0.2"
 end

data/test/helper.rb

@@ -1,5 +1,9 @@
-require "rubygems"
 require "bundler/setup"
+if ENV['COVERAGE']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
 require "minitest/unit"
 require "mocha/setup"
 require "active_record"

data/test/shared.rb

@@ -51,6 +51,13 @@ module FriendlyId
           end
         end
 
+        test "should set the slug to nil on dup" do
+          with_instance_of model_class do |record|
+            record2 = record.dup
+            assert_nil record2.slug
+          end
+        end
+
         test "when validations block save, to_param should return friendly_id rather than nil" do
           my_model_class = Class.new(model_class)
           self.class.const_set("Foo", my_model_class)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,6 +25,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement