friendly_id 5.2.1 → 5.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67c7eb649e6e0fa756ebcfdbae36f276d7bc6adc
-  data.tar.gz: '093984f88a0e674471260a9989673190d48c5b22'
+  metadata.gz: 5e2080c5099215c8dafa04072948b2ac30907bb8
+  data.tar.gz: bee56373516dd5ed394d7de3bc554a08560d5433
 SHA512:
-  metadata.gz: 9039e1625fed0fcc1001b9b0b97cf51f6205aa103211e137ca4db834aa75f18c37a98a54e3030f42d8bb0f83489683d1fec8dce6cc2650d763ee4fb0b5e4c033
-  data.tar.gz: 120aa54db11b436a357122cfd0a53c39bba48c4724d89ce100e5a6dbf8dbec1db6955ebd3c2b118e8c0366505732b8c4e12100e44b40b9fc422904b30a48d29b
+  metadata.gz: 015d359758f15798d9f51ff5cd22462510a48e523fa4b3c0c4a7a8aefd8b370039dce2bc78484a54d05be82e0b7b57284d4763d943eaec35c1418fb5b23cc2ba
+  data.tar.gz: 66ebbb5b6f6345c6beb0d5c4668ba61d5f9e26b2cff24ab8c8591ed36489559584f24fb00ef41b52aefc568ebc5fd121a200d89db8a04948a23a06aa100cb758

data/.travis.yml

@@ -2,10 +2,10 @@ language: ruby
 cache: bundler
 
 rvm:
+  - 2.4.0
   - 2.3.0
   - 2.2.0
   - 2.1.0
-  - 2.0.0
   - jruby-9.0.4.0
 
 env:
@@ -18,20 +18,19 @@ gemfile:
   - gemfiles/Gemfile.rails-4.2.rb
   - gemfiles/Gemfile.rails-5.0.rb
 
+before_install:
+  - gem update bundler
+
 matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-      gemfile: gemfiles/Gemfile.rails-4.2.rb
-      env: DB=postgres
-    - rvm: jruby-9.0.4.0
-      gemfile: gemfiles/Gemfile.rails-5.0.rb
   exclude:
-    - rvm: 2.0.0
-      gemfile: gemfiles/Gemfile.rails-5.0.rb
     - rvm: 2.1.0
       gemfile: gemfiles/Gemfile.rails-5.0.rb
     - rvm: 2.2.0
       gemfile: gemfiles/Gemfile.rails-5.0.rb
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile.rails-4.0.rb
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile.rails-4.1.rb
 
 sudo: false
 

data/Changelog.md

@@ -3,6 +3,12 @@
 We would like to think our many [contributors](https://github.com/norman/friendly_id/graphs/contributors) for
 suggestions, ideas and improvements to FriendlyId.
 
+## 5.2.2 (2017-09-13)
+
+* Prevent warning on db:migrate in Rails 5.1 ([#826](https://github.com/norman/friendly_id/pull/826)).
+* Allow to set size limit for slug ([#809](https://github.com/norman/friendly_id/pull/809)).
+* Update specs and drop support for ruby 2.0.0 ([#824](https://github.com/norman/friendly_id/pull/824)).
+
 ## 5.2.1 (2017-04-09)
 
 * Change ActiveRecord::Base to ApplicationRecord ([#782](https://github.com/norman/friendly_id/pull/782)).

data/README.md

@@ -174,6 +174,11 @@ gem 'friendly_id', '~> 5.1.0' # Note: You MUST use 5.0.0 or greater for Rails 4.
 ```
 ```shell
 rails generate friendly_id
+```
+>Temp solution for Rails 5.1+ : Before running the migration, go into the generated migration file and specify the Rails version:  
+`class CreateFriendlyIdSlugs < ActiveRecord::Migration[5.1]`  
+```
+```shell
 rails generate scaffold user name:string slug:string:uniq
 rake db:migrate
 ```

data/gemfiles/Gemfile.rails-5.0.rb

@@ -9,8 +9,8 @@ gem 'i18n', '~> 0.7.0'
 # Database Configuration
 group :development, :test do
   platforms :jruby do
-    gem 'activerecord-jdbcmysql-adapter', '~> 1.3.14'
-    gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3.14'
+    gem 'activerecord-jdbcmysql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter.git', branch: 'rails-5'
+    gem 'activerecord-jdbcpostgresql-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter.git', branch: 'rails-5'
     gem 'kramdown'
   end
 

data/lib/friendly_id/base.rb

@@ -178,6 +178,9 @@ often better and easier to use {FriendlyId::Slugged slugs}.
     #   Configures the name of the column where FriendlyId will store the slug.
     #   Defaults to `:slug`.
     #
+    # @option options [Integer] :slug_limit Available when using `:slugged`.
+    #   Configures the limit of the slug. This option has no default value.
+    #
     # @option options [Symbol] :slug_generator_class Available when using `:slugged`.
     #   Sets the class used to generate unique slugs. You should not specify this
     #   unless you're doing some extensive hacking on FriendlyId. Defaults to

data/lib/friendly_id/finder_methods.rb

@@ -43,7 +43,10 @@ module FriendlyId
     private
 
     def potential_primary_key?(id)
-      case primary_key_type
+      key_type = primary_key_type
+      # Hook for "ActiveModel::Type::Integer" instance.
+      key_type = key_type.type if key_type.respond_to?(:type)
+      case key_type
       when :integer
         Integer(id, 10) rescue false
       when :uuid

data/lib/friendly_id/initializer.rb

@@ -52,6 +52,10 @@ FriendlyId.defaults do |config|
   #
   # config.slug_column = 'slug'
   #
+  # By default, slug has no size limit, but you can change it if you wish.
+  #
+  # config.slug_limit = 255
+  #
   # When FriendlyId can not generate a unique ID from your base method, it appends
   # a UUID, separated by a single dash. You can configure the character used as the
   # separator. If you're upgrading from FriendlyId 4, you may wish to replace this

data/lib/friendly_id/slugged.rb

@@ -288,7 +288,9 @@ Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
     # @param [#to_s] value The value used as the basis of the slug.
     # @return The candidate slug text, without a sequence.
     def normalize_friendly_id(value)
-      value.to_s.parameterize
+      value = value.to_s.parameterize
+      value = value[0...friendly_id_config.slug_limit] if friendly_id_config.slug_limit
+      value
     end
 
     # Whether to generate a new slug.
@@ -299,10 +301,56 @@ Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
       send(friendly_id_config.slug_column).nil? && !send(friendly_id_config.base).nil?
     end
 
+    # Public: Resolve conflicts.
+    #
+    # This method adds UUID to first candidate and truncates (if `slug_limit` is set).
+    #
+    # Examples:
+    #
+    #   resolve_friendly_id_conflict(['12345'])
+    #   # => '12345-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+    #
+    #   FriendlyId.defaults { |config| config.slug_limit = 40 }
+    #   resolve_friendly_id_conflict(['12345'])
+    #   # => '123-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
+    #
+    # candidates - the Array with candidates.
+    #
+    # Returns the String with new slug.
     def resolve_friendly_id_conflict(candidates)
-      [candidates.first, SecureRandom.uuid].compact.join(friendly_id_config.sequence_separator)
+      uuid = SecureRandom.uuid
+      [
+        apply_slug_limit(candidates.first, uuid),
+        uuid
+      ].compact.join(friendly_id_config.sequence_separator)
     end
 
+    # Private: Apply slug limit to candidate.
+    #
+    # candidate - the String with candidate.
+    # uuid      - the String with UUID.
+    #
+    # Return the String with truncated candidate.
+    def apply_slug_limit(candidate, uuid)
+      return candidate unless candidate && friendly_id_config.slug_limit
+
+      candidate[0...candidate_limit(uuid)]
+    end
+    private :apply_slug_limit
+
+    # Private: Get max length of candidate.
+    #
+    # uuid - the String with UUID.
+    #
+    # Returns the Integer with max length.
+    def candidate_limit(uuid)
+      [
+        friendly_id_config.slug_limit - uuid.size - friendly_id_config.sequence_separator.size,
+        0
+      ].max
+    end
+    private :candidate_limit
+
     # Sets the slug.
     def set_slug(normalized_slug = nil)
       if should_generate_new_friendly_id?
@@ -334,11 +382,11 @@ Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
     end
     private :unset_slug_if_invalid
 
-    # This module adds the `:slug_column`, and `:sequence_separator`, and
-    # `:slug_generator_class` configuration options to
+    # This module adds the `:slug_column`, and `:slug_limit`, and `:sequence_separator`,
+    # and `:slug_generator_class` configuration options to
     # {FriendlyId::Configuration FriendlyId::Configuration}.
     module Configuration
-      attr_writer :slug_column, :sequence_separator
+      attr_writer :slug_column, :slug_limit, :sequence_separator
       attr_accessor :slug_generator_class
 
       # Makes FriendlyId use the slug column for querying.
@@ -361,6 +409,11 @@ Github issue](https://github.com/norman/friendly_id/issues/185) for discussion.
       def slug_column
         @slug_column ||= defaults[:slug_column]
       end
+
+      # The limit that will be used for slug.
+      def slug_limit
+        @slug_limit ||= defaults[:slug_limit]
+      end
     end
   end
 end

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.2.1"
+  VERSION = '5.2.2'.freeze
 end

data/test/schema.rb

@@ -34,7 +34,7 @@ module FriendlyId
 
           slugged_tables.each do |table_name|
             add_column table_name, :slug, :string
-            add_index  table_name, :slug, :unique => true
+            add_index  table_name, :slug, :unique => true if 'novels' != table_name
           end
 
           scoped_tables.each do |table_name|
@@ -44,7 +44,6 @@ module FriendlyId
           # This will be used to test scopes
           add_column :novels, :novelist_id, :integer
           add_column :novels, :publisher_id, :integer
-          remove_index :novels, :slug
           add_index :novels, [:slug, :publisher_id, :novelist_id], :unique => true
 
           # This will be used to test column name quoting

data/test/slugged_test.rb

@@ -271,6 +271,31 @@ class SlugSeparatorTest < TestCaseClass
 
 end
 
+class SlugLimitTest < TestCaseClass
+
+  include FriendlyId::Test
+
+  class Journalist < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :name, :use => :slugged, :slug_limit => 40
+  end
+
+  def model_class
+    Journalist
+  end
+
+  test "should limit slug size" do
+    transaction do
+      m1 = model_class.create! :name => 'a' * 50
+      assert_equal m1.slug, 'a' * 40
+      m2 = model_class.create! :name => m1.name
+      m2.save!
+      # "aaa-<uid>"
+      assert_match(/\Aa{3}\-/, m2.slug)
+    end
+  end
+end
+
 class DefaultScopeTest < TestCaseClass
 
   include FriendlyId::Test
@@ -424,4 +449,4 @@ class ConfigurableRoutesTest < TestCaseClass
       assert_equal novel.id.to_s, novel.to_param
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.2.2
 platform: ruby
 authors:
 - Norman Clarke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: friendly_id
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A comprehensive slugging and pretty-URL plugin.