friendly_id 5.0.5 → 5.1.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e06bb63996e0c196fdc9b046374456806184bec
-  data.tar.gz: 51da9c8b121bd5a6ced25d80ca159c3eb2e993d9
+  metadata.gz: 4f6c2b8454c78ef4f095d0bdc7f1541c59a2a975
+  data.tar.gz: bdd5bc1adf9f8aeb697587994b488bb863323b62
 SHA512:
-  metadata.gz: 71d163c9f61753d7a9333885de13623458e2f41ab00aa0b26d29c772ad796678e50efb27c0026e584300453391302d5eeec6bfe2cb6e3258a4162df02791d70e
-  data.tar.gz: 87b4bccf78201f7c6bf16b596e4ac77f7d34e494e8ebef11e8189f5da13af61b754b8341caff647f528d0f1b5ac7a336284d9f74f47965eb8d05f7797f5c93f0
+  metadata.gz: 5dfeb116b0f1a3dc381fb4ca22c6280f32a3989c3e0b93658b362512ea1670ba2dfc97f27689d8eb2c419da9b07386f1b9ff3297916a2809ef643ba725523a81
+  data.tar.gz: 89d1b972eaa26c8cacae62df4e709a4cba87aebfd3fc19c9a1bd7c3c4c97e179486289294c54209ff63b660db1543d12cba8ed0f304f279c7d6a30f7e2faad3f

data/Changelog.md

@@ -3,7 +3,7 @@
 We would like to think our many {file:Contributors contributors} for
 suggestions, ideas and improvements to FriendlyId.
 
-## 5.1.0 (2015-01-15)
+## 5.1.0 (NOT RELEASED YET)
 
 * FriendlyId will no longer allow blank strings as slugs ([#571](https://github.com/norman/friendly_id/pull/571)).
 * FriendlyId will now try to use the first non-reserved candidate as its
@@ -11,10 +11,6 @@ suggestions, ideas and improvements to FriendlyId.
 * Fix order dependence bug between history and scoped modules ([#588](https://github.com/norman/friendly_id/pull/588)).
 * Fix "friendly" finds on Rails 4.2 ([#607](https://github.com/norman/friendly_id/issues/607)).
 
-## 5.0.5 (2015-01-15)
-
-* Backported bugfixes and Rails 4.2 support from 5.1.0.
-
 ## 5.0.4 (2014-05-29)
 
 * Bug fix for call to removed `primary` method on Edge Rails. ([#557](https://github.com/norman/friendly_id/pull/557)).

data/README.md

@@ -38,6 +38,8 @@ versioning, i18n, scoped slugs, reserved words, and custom slug generators.
 
 ### What Changed in Version 5.1
 
+_NOTE: 5.1 is the latest beta version and will be released soon._
+
 5.1 is a bugfix release, but bumps the minor version because some applications may be dependent
 on the previously buggy behavior. The changes include:
 

data/lib/friendly_id/candidates.rb

@@ -14,12 +14,16 @@ module FriendlyId
     end
 
     # Visits each candidate, calls it, passes it to `normalize_friendly_id` and
-    # yields the wanted slug candidates.
+    # yields any wanted and unreserved slug candidates.
     def each(*args, &block)
-      @candidates.map do |candidate|
-        slug = @object.normalize_friendly_id(candidate.map(&:call).join(' '))
-        yield slug if wanted?(slug)
+      pre_candidates = @candidates.map do |candidate|
+        @object.normalize_friendly_id(candidate.map(&:call).join(' '))
+      end.select {|x| wanted?(x)}
+
+      unless pre_candidates.all? {|x| reserved?(x)}
+        pre_candidates.reject! {|x| reserved?(x)}
       end
+      pre_candidates.each {|x| yield x}
     end
 
     private
@@ -44,7 +48,16 @@ module FriendlyId
     end
 
     def wanted?(slug)
-      !slug.blank?
+      slug.present?
+    end
+
+    private
+
+    def reserved?(slug)
+      config = @object.friendly_id_config
+      return false unless config.uses? ::FriendlyId::Reserved
+      return false unless config.reserved_words
+      config.reserved_words.include?(slug)
     end
   end
 end

data/lib/friendly_id/slugged.rb

@@ -251,9 +251,9 @@ Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
     # Process the given value to make it suitable for use as a slug.
     #
     # This method is not intended to be invoked directly; FriendlyId uses it
-    # internally to process strings into slugs.
+    # internaly to process strings into slugs.
     #
-    # However, if FriendlyId's default slug generation doesn't suit your needs,
+    # However, if FriendlyId's default slug generation doesn't suite your needs,
     # you can override this method in your model class to control exactly how
     # slugs are generated.
     #

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.0.5"
+  VERSION = "5.1.0.beta.1"
 end

data/test/candidates_test.rb

@@ -0,0 +1,117 @@
+require "helper"
+
+class CandidatesTest < Minitest::Test
+
+  include FriendlyId::Test
+
+  class City < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :slug_candidates, use: :slugged
+    alias_attribute :slug_candidates, :name
+  end
+
+  def model_class
+    City
+  end
+
+  def with_instances_of(klass = model_class, &block)
+    transaction do
+      city1 = klass.create! :name => "New York", :code => "JFK"
+      city2 = klass.create! :name => "New York", :code => "EWR"
+      yield city1, city2
+    end
+  end
+  alias_method :with_instances, :with_instances_of
+
+  test "resolves conflict with candidate" do
+    with_instances do |city1, city2|
+      assert_equal "new-york", city1.slug
+      assert_match(/\Anew-york-([a-z0-9]+\-){4}[a-z0-9]+\z/, city2.slug)
+    end
+  end
+
+  test "accepts candidate as symbol" do
+    klass = Class.new model_class do
+      def slug_candidates
+        :name
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_match(/\Anew-york-([a-z0-9]+\-){4}[a-z0-9]+\z/, city.slug)
+    end
+  end
+
+  test "accepts multiple candidates" do
+    klass = Class.new model_class do
+      def slug_candidates
+        [name, code]
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_equal "ewr", city.slug
+    end
+  end
+
+  test "ignores blank candidate" do
+    klass = Class.new model_class do
+      def slug_candidates
+        [name, ""]
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_match(/\Anew-york-([a-z0-9]+\-){4}[a-z0-9]+\z/, city.slug)
+    end
+  end
+
+  test "ignores nil candidate" do
+    klass = Class.new model_class do
+      def slug_candidates
+        [name, nil]
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_match(/\Anew-york-([a-z0-9]+\-){4}[a-z0-9]+\z/, city.slug)
+    end
+  end
+
+  test "accepts candidate with nested array" do
+    klass = Class.new model_class do
+      def slug_candidates
+        [name, [name, code]]
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_equal "new-york-ewr", city.slug
+    end
+  end
+
+  test "accepts candidate with lambda" do
+    klass = Class.new City do
+      def slug_candidates
+        [name, [name, ->{ rand 1000 }]]
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_match(/\Anew-york-\d{,3}\z/, city.friendly_id)
+    end
+  end
+
+  test "accepts candidate with object" do
+    klass = Class.new City do
+      class Airport
+        def initialize(code)
+          @code = code
+        end
+        attr_reader :code
+        alias_method :to_s, :code
+      end
+      def slug_candidates
+        [name, [name, Airport.new(code)]]
+      end
+    end
+    with_instances_of klass do |_, city|
+      assert_equal "new-york-ewr", city.friendly_id
+    end
+  end
+
+end

data/test/reserved_test.rb

@@ -6,13 +6,17 @@ class ReservedTest < Minitest::Test
 
   class Journalist < ActiveRecord::Base
     extend FriendlyId
-    friendly_id :name, :use => [:slugged, :reserved], :reserved_words => %w(new edit)
+    friendly_id :slug_candidates, :use => [:slugged, :reserved], :reserved_words => %w(new edit)
 
     after_validation :move_friendly_id_error_to_name
 
     def move_friendly_id_error_to_name
       errors.add :name, *errors.delete(:friendly_id) if errors[:friendly_id].present?
     end
+
+    def slug_candidates
+      name
+    end
   end
 
   def model_class
@@ -37,4 +41,25 @@ class ReservedTest < Minitest::Test
     end
   end
 
+  test "should reject reserved candidates" do
+    transaction do
+      record = model_class.new(:name => 'new')
+      def record.slug_candidates
+        [:name, "foo"]
+      end
+      record.save!
+      assert_equal "foo", record.friendly_id
+    end
+  end
+
+  test "should be invalid if all candidates are reserved" do
+    transaction do
+      record = model_class.new(:name => 'new')
+      def record.slug_candidates
+        ["edit", "new"]
+      end
+      assert_raises(ActiveRecord::RecordInvalid) {record.save!}
+    end
+  end
+
 end

data/test/schema.rb

@@ -64,13 +64,16 @@ module FriendlyId
           # Used to test :scoped and :history together
           add_column :restaurants, :city_id, :integer
 
+          # Used to test candidates
+          add_column :cities, :code, :string, :limit => 3
+
           @done = true
         end
 
         private
 
         def slugged_tables
-          %w[journalists articles novelists novels manuals]
+          %w[journalists articles novelists novels manuals cities]
         end
 
         def tables_with_uuid_primary_key
@@ -82,7 +85,7 @@ module FriendlyId
         end
 
         def simple_tables
-          %w[authors books publishers cities]
+          %w[authors books publishers]
         end
 
         def tables

data/test/shared.rb

@@ -69,7 +69,6 @@ module FriendlyId
             assert_equal record.to_param, record.friendly_id
           end
         end
-
       end
 
       module Core
@@ -181,4 +180,3 @@ module FriendlyId
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: 5.1.0.beta.1
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -184,6 +184,7 @@ files:
 - lib/friendly_id/version.rb
 - lib/generators/friendly_id_generator.rb
 - test/base_test.rb
+- test/candidates_test.rb
 - test/configuration_test.rb
 - test/core_test.rb
 - test/databases.yml
@@ -214,9 +215,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: friendly_id
 rubygems_version: 2.4.4