friendly_id 5.2.3 → 5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8ecc233dd377f5400a788a6a6fb7d37e2f4b200c
-  data.tar.gz: 9c848d7c0f238d70577cb0737b1f6411e779a6d5
+SHA256:
+  metadata.gz: ba26f9f615f068d0094f6646a6c6a5aceef44b59bde321aa168542b62420402f
+  data.tar.gz: 155666a337c2162adc31c2b3337867a7086b63cba390d6d9c6ca8486b7d663d6
 SHA512:
-  metadata.gz: 4c0a2db2212245e2dcadd50a6f62e3970a10ca72d7230e92cebf31a03da6772c23d2203303e08ff51ed9c9985f234310e01db91f0baa79c663c9756b84181b7a
-  data.tar.gz: cc539ec2396d5736499c3852d0bd967c10d1d6d0ec3afd63b137634e9ac7f6365d7b073895c5297390a42ad74a9cb363064c81c317ad899f3e44f6f15a312f19
+  metadata.gz: bc67ddc3c8940a7b0bcf0c918c0f5f398e1f484d72fde5fa7f1136035d34ac77a25b0db3ac4070fc0abd21abe926e2d15bc9f536e4f57ddb0dcd84c4f787b1b0
+  data.tar.gz: 1e590565fff83c890ee04dede81e518c98912214dc3122690763ee1731559fd337421bd05c4d201224cddd67891416054a81e7d8b0bbc24acfc2e6661e5ebe03

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: parndt

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 84
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github/workflows/test.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+jobs:
+  test:
+    strategy:
+      matrix:
+        architecture: [ x64 ]
+        database: [ mysql, postgresql ]
+        gemfile: [ '6.0', '5.2' ]
+        ruby: [ '2.7.x', '2.6.x', '2.5.x' ]
+      fail-fast: false
+    runs-on: ubuntu-latest
+    name: ${{ matrix.ruby }} ${{ matrix.database }} rails-${{ matrix.gemfile }}
+    steps:
+    - uses: actions/setup-ruby@v1.0.0
+      with:
+        architecture: ${{ matrix.architecture }}
+        ruby-version: ${{ matrix.ruby }}
+        version: ${{ matrix.ruby }}
+    - uses: actions/checkout@v2
+    - run: sudo apt-get update && sudo apt-get install libpq-dev postgresql-client libmysqlclient-dev mysql-client libsqlite3-dev -y
+    - id: cache-bundler
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ matrix.ruby }}-gem-${{ hashFiles(format('gemfiles/Gemfile.rails-{0}.rb', matrix.gemfile)) }}
+    - run: gem install bundler
+    - run: bundle install --path vendor/bundle
+    - run: bundle exec rake db:create db:up
+    - run: bundle exec rake test
+
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_GEMFILE: gemfiles/Gemfile.rails-${{ matrix.gemfile }}.rb
+      BUNDLE_PATH: vendor/bundle
+      CI: true
+      COVERALLS: true
+      DB: ${{ matrix.database }}
+      MYSQL_PASSWORD: root
+      PGHOST: localhost
+      PGPORT: 5432
+      PGUSER: postgres
+      RAILS_ENV: test
+
+    services:
+      postgres:
+        image: postgres:11.5
+        ports: ["5432:5432"]
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      mysql:
+        image: mysql:5.7
+        ports: ["3306:3306"]
+        options: --health-cmd "mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 5
+        env:
+          MYSQL_ROOT_PASSWORD: root

data/Changelog.md

@@ -3,6 +3,48 @@
 We would like to think our many [contributors](https://github.com/norman/friendly_id/graphs/contributors) for
 suggestions, ideas and improvements to FriendlyId.
 
+## Unreleased
+
+## 5.4.1 (2020-11-06)
+
+* Fix unexpected `:slug` error on valid, unpersisted model ([#952](https://github.com/norman/friendly_id/pull/952))
+
+## 5.4.0 (2020-08-14)
+
+* Fix Ruby 2.7 keyword params deprecation warning ([#939](https://github.com/norman/friendly_id/pull/939))
+* Fix Slug Validation in `unset_slug_if_invalid` ([#938](https://github.com/norman/friendly_id/pull/938))
+* Make `first_by_friendly_id` case insensitive using `downcase` ([#787](https://github.com/norman/friendly_id/pull/787))
+* Use `destroy_all` rather than `delete_all` when creating historical slugs ([#924](https://github.com/norman/friendly_id/pull/924))
+* Set required ruby version to `>= 2.1.0` ([#923](https://github.com/norman/friendly_id/pull/923))
+* Avoid using deprecated `update_attributes` ([#922](https://github.com/norman/friendly_id/pull/922))
+
+## 5.3.0 (2019-09-25)
+
+* Record history when scope changes but slug does not ([#916](https://github.com/norman/friendly_id/pull/916))
+* Add support for Rails 6 ([#897](https://github.com/norman/friendly_id/pull/897))
+
+## 5.2.5 (2018-12-30)
+
+* Pass all possible parameters to ActiveRecord::RecordNotFound.new when raising the exception ([#890](https://github.com/norman/friendly_id/pull/890))
+* Use composite index for queries by sluggable ([#882](https://github.com/norman/friendly_id/pull/882))
+* Scoped: generate new slug if scope changed ([#878](https://github.com/norman/friendly_id/pull/878))
+* Fix History + SequentiallySlugged issues ([#877](https://github.com/norman/friendly_id/pull/877))
+* Support scoped with STI ([#745](https://github.com/norman/friendly_id/pull/745))
+* Fix exists? to behave the same as find for numeric slugs ([#875](https://github.com/norman/friendly_id/pull/875))
+* Remove dirty tracking code from to_param ([#867](https://github.com/norman/friendly_id/pull/867))
+
+## 5.2.4 (2018-04-24)
+
+* Fix compatibility with Rails versions 4.0 -> 5.2. ([#863](https://github.com/norman/friendly_id/pull/863)).
+* Refactor `History::FinderMethods` to use base implementation. ([#853](https://github.com/norman/friendly_id/pull/853)).
+* Defer loading of ActiveRecord to avoid config issues. ([#852](https://github.com/norman/friendly_id/pull/852)).
+* Ensure compatibility with paranoid deletion libraries. ([#838](https://github.com/norman/friendly_id/pull/838)).
+* Add treat_reserved_as_conflict option to initializer ([#847](https://github.com/norman/friendly_id/pull/847)).
+
+## 5.2.3 (2017-09-22)
+
+* Added option to treat reserved words as conflicts ([#831](https://github.com/norman/friendly_id/pull/831)).
+
 ## 5.2.2 (2017-09-13)
 
 * Prevent warning on db:migrate in Rails 5.1 ([#826](https://github.com/norman/friendly_id/pull/826)).
@@ -24,7 +66,7 @@ suggestions, ideas and improvements to FriendlyId.
 * Don't calculate all changes just to check if the param field has changed ([#667](https://github.com/norman/friendly_id/pull/667)).
 * Don't set or change slug when unrelated validation failures block the record from being saved ([#642](https://github.com/norman/friendly_id/issues/642)).
 * Fix order dependence bug between history and finders modules ([#718](https://github.com/norman/friendly_id/pull/718))
-* Added ability to conditionally turn off :dependent => :destory on FriendlyId::Slugs([#724](https://github.com/norman/friendly_id/pull/724))
+* Added ability to conditionally turn off `:dependent => :destroy` on FriendlyId::Slugs([#724](https://github.com/norman/friendly_id/pull/724))
 * Add support for Rails 5. ([#728](https://github.com/norman/friendly_id/pull/728))
 * Allow per-model conditional disabling of friendly path generation using a :routes option to friendly_id ([#735](https://github.com/norman/friendly_id/pull/735))
 

data/Gemfile

@@ -2,9 +2,12 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rake'
+
 group :development, :test do
   platforms :ruby do
     gem 'byebug'
+    gem 'pry'
   end
 
   platforms :jruby do

data/README.md

@@ -1,22 +1,10 @@
-[![Build Status](https://travis-ci.org/norman/friendly_id.svg)](https://travis-ci.org/norman/friendly_id)
+[![Build Status](https://github.com/norman/friendly_id/workflows/CI/badge.svg)](https://github.com/norman/friendly_id/actions)
 [![Code Climate](https://codeclimate.com/github/norman/friendly_id.svg)](https://codeclimate.com/github/norman/friendly_id)
-[![Inline docs](http://inch-ci.org/github/norman/friendly_id.svg?branch=master)](http://inch-ci.org/github/norman/friendly_id)
-
-**GETTING HELP**
-
-Please ask questions on [Stack
-Overflow](http://stackoverflow.com/questions/tagged/friendly-id) using the
-"friendly-id" tag. Prior to asking, search and see if your question has
-already been answered.
-
-Please only post issues in Github issues for actual bugs.
-
-I am asking people to do this because the same questions keep getting asked
-over and over and over again in the issues.
+[![Inline docs](https://inch-ci.org/github/norman/friendly_id.svg?branch=master)](https://inch-ci.org/github/norman/friendly_id)
 
 # FriendlyId
 
-**For the most complete, user-friendly documentation, see the [FriendlyId Guide](http://norman.github.io/friendly_id/file.Guide.html).**
+**For the most complete, user-friendly documentation, see the [FriendlyId Guide](https://norman.github.io/friendly_id/file.Guide.html).**
 
 FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
 Active Record. It lets you create pretty URLs and work with human-friendly
@@ -24,197 +12,102 @@ strings as if they were numeric ids.
 
 With FriendlyId, it's easy to make your application use URLs like:
 
-    http://example.com/states/washington
+    https://example.com/states/washington
 
 instead of:
 
-    http://example.com/states/4323454
-
-
-## FriendlyId Features
-
-FriendlyId offers many advanced features, including: slug history and
-versioning, i18n, scoped slugs, reserved words, and custom slug generators.
-
-### What Changed in Version 5.1
-
-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:
-
-* Blank strings can no longer be used as slugs.
-* When the first slug candidate is rejected because it is reserved, additional candidates will
-  now be considered before marking the record as invalid.
-* The `:finders` module is now compatible with Rails 4.2.
-
-### What Changed in Version 5.0
-
-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:
-
-* 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:
-
-  ```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:
-
-  ```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:
-
-  ```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 common global configuration.
-* The Globalize plugin has moved to a [separate gem](https://github.com/norman/friendly_id-globalize) (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.
-
-#### Upgrading from FriendlyId 4.0
-
-Run `rails generate friendly_id --skip-migration` and edit the initializer
-generated in `config/initializers/friendly_id.rb`. This file contains notes
-describing how to restore (or not) some of the defaults from FriendlyId 4.0.
-
-If you want to use the `:history` and `:scoped` addons together, you must add a
-`:scope` column to your friendly_id_slugs table and replace the unique index on
-`:slug` and `:sluggable_type` with a unique index on those two columns, plus
-the new `:scope` column.
-
-A migration like this should be sufficient:
-
-```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
-```
+    https://example.com/states/4323454
 
-## Articles
 
-[Migrating an ad-hoc URL slug system to FriendlyId](http://olivierlacan.com/posts/migrating-an-ad-hoc-url-slug-system-to-friendly-id/)  
-[Pretty URLs with FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid)
+## Getting Help
 
-## Docs
+Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/friendly-id)
+using the "friendly-id" tag, and for bugs have a look at [the bug section](https://github.com/norman/friendly_id#bugs)
 
-The most current docs from the master branch can always be found
-[here](http://norman.github.io/friendly_id).
+## FriendlyId Features
 
-Docs for older versions are also available:
+FriendlyId offers many advanced features, including:
 
-* [5.0](http://norman.github.io/friendly_id/5.0/)
-* [4.0](http://norman.github.io/friendly_id/4.0/)
-* [3.3](http://norman.github.io/friendly_id/3.3/)
-* [2.3](http://norman.github.io/friendly_id/2.3/)
+ * slug history and versioning
+ * i18n
+ * scoped slugs
+ * reserved words
+ * custom slug generators
 
-The best place to start is with the
-[Guide](http://norman.github.io/friendly_id/file.Guide.html),
-which compiles the top-level RDocs into one outlined document.
+## Usage
 
-For a getting started video, you may want to watch [GoRails #9](https://gorails.com/episodes/pretty-urls-with-friendly-id)
+Add this line to your application's Gemfile:
 
-You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid),
-which is now somewhat outdated but still relevant.
+```ruby
+gem 'friendly_id', '~> 5.4.0'
+```
 
+Note: You MUST use 5.0.0 or greater for Rails 4.0+.
 
-## Rails Quickstart
+And then execute:
 
 ```shell
-rails new my_app
-cd my_app
+bundle install
 ```
-```ruby
-# Gemfile
-gem 'friendly_id', '~> 5.1.0' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
+
+Add a `slug` column to the desired table (e.g. `Users`)
+```shell
+rails g migration AddSlugToUsers slug:uniq
 ```
+
+Generate the friendly configuration file and a new migration
+
 ```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]`  
+
+Note: You can delete the `CreateFriendlyIdSlugs` migration if you won't use the slug history feature. ([Read more](https://norman.github.io/friendly_id/FriendlyId/History.html))
+
+Run the migration scripts
+
 ```shell
-rails generate scaffold user name:string slug:string:uniq
-rake db:migrate
+rails db:migrate
 ```
+
+Edit the `app/models/user.rb` file as the following:
+
 ```ruby
-# edit app/models/user.rb
 class User < ApplicationRecord
   extend FriendlyId
   friendly_id :name, use: :slugged
 end
+```
 
-User.create! name: "Joe Schmoe"
+Edit the `app/controllers/users_controller.rb` file and replace `User.find` by `User.friendly.find`
 
-# Change User.find to User.friendly.find in your controller
-User.friendly.find(params[:id])
+```ruby
+class UserController < ApplicationController
+  def show
+    @user = User.friendly.find(params[:id])
+  end
+end
 ```
-```shell
-rails server
 
-GET http://localhost:3000/users/joe-schmoe
-```
+Now when you create a new user like the following:
+
 ```ruby
-# If you're adding FriendlyId to an existing app and need
-# to generate slugs for existing users, do this from the
-# console, runner, or add a Rake task:
-User.find_each(&:save)
+User.create! name: "Joe Schmoe"
 ```
 
-## Benchmarks
+You can then access the user show page using the URL http://localhost:3000/users/joe-schmoe.
 
-The latest benchmarks for FriendlyId are maintained
-[here](http://bit.ly/friendly-id-benchmarks).
 
+If you're adding FriendlyId to an existing app and need to generate slugs for
+existing users, do this from the console, runner, or add a Rake task:
+
+```ruby
+User.find_each(&:save)
+```
 
 ## Bugs
 
 Please report them on the [Github issue
-tracker](http://github.com/norman/friendly_id/issues) for this project.
+tracker](https://github.com/norman/friendly_id/issues) for this project.
 
 If you have a bug to report, please include the following information:
 
@@ -226,8 +119,8 @@ If you have a bug to report, please include the following information:
 If you are able to, it helps even more if you can fork FriendlyId on Github,
 and add a test that reproduces the error you are experiencing.
 
-For more info on how to report bugs, please see [this
-article](http://yourbugreportneedsmore.info/).
+For more inspiration on how to report bugs, please see [this
+article](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
 
 ## Thanks and Credits
 
@@ -240,7 +133,7 @@ volunteers](https://github.com/norman/friendly_id/contributors).
 
 ## License
 
-Copyright (c) 2008-2016 Norman Clarke and contributors, released under the MIT
+Copyright (c) 2008-2020 Norman Clarke and contributors, released under the MIT
 license.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of