friendly_id 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41f8cc1c8668551a87b0537b5a30b812ec635755c7b1d0bfda678bc4be23b84c
-  data.tar.gz: 7cc6753a1f56537561558134ceae5c796b2e1296fa5230b0b734ddebd17be789
+  metadata.gz: d8a1f043f2634ba82853c8748c13dacf573cf7de6f99c71ede338d9aecd7f424
+  data.tar.gz: '033259395dcc4b75e595c4a81aedf839815768805c8f3d8bc8a2f1cb51df85ed'
 SHA512:
-  metadata.gz: cbfde34d6b2cd2347ab9837101824e65504fa226d51e4820e87b5cc7f2546c3e55decb2c7d0df4f8d1d899ef517f8177a5f63543a5577194071b7388f10cb5cf
-  data.tar.gz: f13c197800451a77c86092fa15fcd730ae669dca4486856ddf1dce21be7ad6ee8bbed41590f0a3afb1d72d804c343e4b5050f6c906090a7c951fb54b46c1d936
+  metadata.gz: cea6b61fc184a6d8f2c4468282440a7a4499a1af7ff3bb979c3c1659aa401d1459cb5e345e6dd1d56225304a5278b7b93625e619352975735b49385b295ca73f
+  data.tar.gz: fe4b2086cfebce9204cc349c8d0a1b31756fee02da072f2babfb56f87697d1a034be7a568ae78b9ccaf360cc8cf4509c59b9ccac68193dfe52859bb7ed018954

data/lib/friendly_id/version.rb

@@ -1,3 +1,3 @@
 module FriendlyId
-  VERSION = "5.6.0".freeze
+  VERSION = "5.7.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.7.0
 platform: ruby
 authors:
 - Norman Clarke
@@ -146,30 +146,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemtest"
-- ".github/FUNDING.yml"
-- ".github/dependabot.yml"
-- ".github/stale.yml"
-- ".github/workflows/release.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".yardopts"
-- CONTRIBUTING.md
 - Changelog.md
-- Gemfile
 - MIT-LICENSE
 - README.md
-- Rakefile
-- UPGRADING.md
-- bench.rb
-- friendly_id.gemspec
-- gemfiles/Gemfile.rails-6.0.rb
-- gemfiles/Gemfile.rails-6.1.rb
-- gemfiles/Gemfile.rails-7.0.rb
-- gemfiles/Gemfile.rails-7.1.rb
-- gemfiles/Gemfile.rails-7.2.rb
-- gemfiles/Gemfile.rails-8.0.rb
-- guide.rb
 - lib/friendly_id.rb
 - lib/friendly_id/.gitattributes
 - lib/friendly_id/base.rb
@@ -191,27 +170,6 @@ files:
 - lib/friendly_id/slugged.rb
 - lib/friendly_id/version.rb
 - lib/generators/friendly_id_generator.rb
-- test/base_test.rb
-- test/benchmarks/finders.rb
-- test/benchmarks/object_utils.rb
-- test/candidates_test.rb
-- test/configuration_test.rb
-- test/core_test.rb
-- test/databases.yml
-- test/finders_test.rb
-- test/generator_test.rb
-- test/helper.rb
-- test/history_test.rb
-- test/numeric_slug_test.rb
-- test/object_utils_test.rb
-- test/reserved_test.rb
-- test/schema.rb
-- test/scoped_test.rb
-- test/sequentially_slugged_test.rb
-- test/shared.rb
-- test/simple_i18n_test.rb
-- test/slugged_test.rb
-- test/sti_test.rb
 homepage: https://github.com/norman/friendly_id
 licenses:
 - MIT
@@ -230,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A comprehensive slugging and pretty-URL plugin.
 test_files: []

data/.github/FUNDING.yml

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

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"

data/.github/stale.yml

@@ -1,17 +0,0 @@
-# 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/release.yml

@@ -1,29 +0,0 @@
-name: Release to rubygems.org
-
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-
-jobs:
-  push:
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write
-      id-token: write
-
-    environment: release
-
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ruby
-
-      - uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -1,86 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - 'master'
-  pull_request:
-jobs:
-  test:
-    strategy:
-      matrix:
-        database: [ mysql, postgresql ]
-        gemfile: [ '8.0', '7.2', '7.1', '7.0', '6.1', '6.0' ]
-        ruby: [ '2.7', '3.0', '3.1', '3.2', '3.3', '3.4' ]
-        exclude:
-          - gemfile: '6.0'
-            ruby: '3.2'
-          - gemfile: '6.0'
-            ruby: '3.3'
-          - gemfile: '6.0'
-            ruby: '3.4'
-          - gemfile: '6.1'
-            ruby: '3.2'
-          - gemfile: '6.1'
-            ruby: '3.3'
-          - gemfile: '6.1'
-            ruby: '3.4'
-          - gemfile: '7.0'
-            ruby: '3.3'
-          - gemfile: '7.0'
-            ruby: '3.4'
-          - gemfile: '7.1'
-            ruby: '3.3'
-          - gemfile: '7.1'
-            ruby: '3.4'
-          - gemfile: '7.2'
-            ruby: '2.7'
-          - gemfile: '7.2'
-            ruby: '3.0'
-          - gemfile: '8.0'
-            ruby: '2.7'
-          - gemfile: '8.0'
-            ruby: '3.0'
-          - gemfile: '8.0'
-            ruby: '3.1'
-      fail-fast: false
-    runs-on: ubuntu-latest
-
-    env:
-      BUNDLE_GEMFILE: gemfiles/Gemfile.rails-${{ matrix.gemfile }}.rb
-      CI: true
-      COVERALLS: true
-      DB: ${{ matrix.database }}
-      MYSQL_PASSWORD: root
-      PGHOST: localhost
-      PGPASSWORD: runner
-      PGUSER: runner
-      RAILS_ENV: test
-
-    name: ${{ matrix.ruby }} ${{ matrix.database }} rails-${{ matrix.gemfile }}
-    steps:
-    - uses: actions/checkout@v6
-
-    - run: sudo apt-get update && sudo apt-get install libsqlite3-dev -y
-
-    - name: "Set up MySQL using VM's server"
-      if: ${{ env.DB == 'mysql' }}
-      run: |
-        sudo apt-get install libmysqlclient-dev -y
-        sudo systemctl start mysql.service
-
-    - name: "Set up PostgreSQL using VM's server"
-      if: ${{ env.DB == 'postgresql' }}
-      run: |
-        sudo apt-get install libpq-dev -y
-        sudo systemctl start postgresql.service
-        sudo -u postgres psql -c "CREATE USER runner WITH SUPERUSER PASSWORD 'runner'"
-        sudo -u postgres createdb runner
-
-    - uses: ruby/setup-ruby@v1
-      with:
-        bundler-cache: true
-        ruby-version: ${{ matrix.ruby }}
-
-    - run: bundle exec rake db:{create,up}
-    - run: bundle exec rake test

data/.gitignore

@@ -1,14 +0,0 @@
-Gemfile.lock
-doc
-docs
-pkg
-.DS_Store
-coverage
-.yardoc
-*.gem
-*.sqlite3
-*.rbc
-*.lock
-.rbx
-Guide.md
-.friendly_id

data/.yardopts

@@ -1,8 +0,0 @@
--e guide.rb
---files=Changelog.md,Guide.md
---tag guide
---hide-tag guide
---private
---protected
---exclude lib/friendly_id/migration
---markup=markdown

data/CONTRIBUTING.md

@@ -1,11 +0,0 @@
-# FriendlyId
-
-Please ask questions on [Stack
-Overflow](http://stackoverflow.com/questions/tagged/friendly-id) using the
-"friendly_id" or "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.

data/Gemfile

@@ -1,23 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "standard"
-gem "rake"
-
-group :development, :test do
-  platforms :ruby do
-    gem "byebug"
-    gem "pry"
-  end
-
-  platforms :jruby do
-    gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.beta2"
-    gem "kramdown"
-  end
-
-  platforms :ruby, :rbx do
-    gem "sqlite3"
-    gem "redcarpet"
-  end
-end

data/Rakefile

@@ -1,100 +0,0 @@
-require "rubygems"
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-
-task :load_path do
-  %w[lib test].each do |path|
-    $LOAD_PATH.unshift(File.expand_path("../#{path}", __FILE__))
-  end
-end
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/*_test.rb"]
-  t.verbose = true
-end
-
-desc "Remove temporary files"
-task :clean do
-  `rm -rf *.gem doc pkg coverage`
-  %x(rm -f `find . -name '*.rbc'`)
-end
-
-desc "Build YARD documentation"
-task :yard do
-  puts `bundle exec yard`
-end
-
-desc "Run benchmarks"
-task bench: :load_path do
-  require File.expand_path("../bench", __FILE__)
-end
-
-desc "Run benchmarks on finders"
-task bench_finders: :load_path do
-  require File.expand_path("../test/benchmarks/finders", __FILE__)
-end
-
-desc "Run benchmarks on ObjectUtils"
-task bench_object_utils: :load_path do
-  require File.expand_path("../test/benchmarks/object_utils", __FILE__)
-end
-
-desc "Generate Guide.md"
-task :guide do
-  load File.expand_path("../guide.rb", __FILE__)
-end
-
-namespace :test do
-  desc "Run each test class in a separate process"
-  task :isolated do
-    dir = File.expand_path("../test", __FILE__)
-    Dir["#{dir}/*_test.rb"].each do |test|
-      puts "Running #{test}:"
-      puts `ruby -Ilib -Itest #{test}`
-    end
-  end
-end
-
-namespace :db do
-  desc "Create the database"
-  task create: :load_path do
-    require "helper"
-    driver = FriendlyId::Test::Database.driver
-    config = FriendlyId::Test::Database.config[driver]
-    commands = {
-      "mysql" => "mysql -h #{config["host"]} -P #{config["port"]} -u #{config["username"]} --password=#{config["password"]} -e 'create database #{config["database"]};' >/dev/null",
-      "postgres" => "psql -c 'create database #{config["database"]};' -U #{config["username"]} >/dev/null"
-    }
-    `#{commands[driver] || true}`
-  end
-
-  desc "Drop the database"
-  task drop: :load_path do
-    require "helper"
-    driver = FriendlyId::Test::Database.driver
-    config = FriendlyId::Test::Database.config[driver]
-    commands = {
-      "mysql" => "mysql -h #{config["host"]} -P #{config["port"]} -u #{config["username"]} --password=#{config["password"]} -e 'drop database #{config["database"]};' >/dev/null",
-      "postgres" => "psql -c 'drop database #{config["database"]};' -U #{config["username"]} >/dev/null"
-    }
-    `#{commands[driver] || true}`
-  end
-
-  desc "Set up the database schema"
-  task up: :load_path do
-    require "helper"
-    FriendlyId::Test::Schema.up
-  end
-
-  desc "Drop and recreate the database schema"
-  task reset: [:drop, :create]
-end
-
-task doc: :yard
-
-task :docs do
-  sh %(git checkout gh-pages && rake doc && git checkout @{-1})
-end

data/UPGRADING.md

@@ -1,115 +0,0 @@
-## 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)
-
-## Docs
-
-The most current docs from the master branch can always be found
-[here](http://norman.github.io/friendly_id).
-
-Docs for older versions are also available:
-
-* [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/)
-
-## 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
-```

data/bench.rb

@@ -1,84 +0,0 @@
-require File.expand_path("../test/helper", __FILE__)
-require "ffaker"
-
-N = 10000
-
-def transaction
-  ActiveRecord::Base.transaction do
-    yield
-
-    raise ActiveRecord::Rollback
-  end
-end
-
-class Array
-  def rand
-    self[Kernel.rand(length)]
-  end
-end
-
-Book = Class.new ActiveRecord::Base
-
-class Journalist < ActiveRecord::Base
-  extend FriendlyId
-  friendly_id :name, use: :slugged
-end
-
-class Manual < ActiveRecord::Base
-  extend FriendlyId
-  friendly_id :name, use: :history
-end
-
-class Restaurant < ActiveRecord::Base
-  extend FriendlyId
-  friendly_id :name, use: :finders
-end
-
-BOOKS = []
-JOURNALISTS = []
-MANUALS = []
-RESTAURANTS = []
-
-100.times do
-  name = FFaker::Name.name
-  BOOKS << (Book.create! name: name).id
-  JOURNALISTS << (Journalist.create! name: name).friendly_id
-  MANUALS << (Manual.create! name: name).friendly_id
-  RESTAURANTS << (Restaurant.create! name: name).friendly_id
-end
-
-ActiveRecord::Base.connection.execute "UPDATE manuals SET slug = NULL"
-
-Benchmark.bmbm do |x|
-  x.report "find (without FriendlyId)" do
-    N.times { Book.find BOOKS.rand }
-  end
-
-  x.report "find (in-table slug)" do
-    N.times { Journalist.friendly.find JOURNALISTS.rand }
-  end
-
-  x.report "find (in-table slug; using finders module)" do
-    N.times { Restaurant.find RESTAURANTS.rand }
-  end
-
-  x.report "find (external slug)" do
-    N.times { Manual.friendly.find MANUALS.rand }
-  end
-
-  x.report "insert (without FriendlyId)" do
-    N.times { transaction { Book.create name: FFaker::Name.name } }
-  end
-
-  x.report "insert (in-table-slug)" do
-    N.times { transaction { Journalist.create name: FFaker::Name.name } }
-  end
-
-  x.report "insert (in-table-slug; using finders module)" do
-    N.times { transaction { Restaurant.create name: FFaker::Name.name } }
-  end
-
-  x.report "insert (external slug)" do
-    N.times { transaction { Manual.create name: FFaker::Name.name } }
-  end
-end

data/friendly_id.gemspec

@@ -1,31 +0,0 @@
-require File.expand_path("../lib/friendly_id/version", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name = "friendly_id"
-  s.version = FriendlyId::VERSION
-  s.authors = ["Norman Clarke", "Philip Arndt"]
-  s.email = ["norman@njclarke.com", "gems@p.arndt.io"]
-  s.homepage = "https://github.com/norman/friendly_id"
-  s.summary = "A comprehensive slugging and pretty-URL plugin."
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test}/*`.split("\n")
-  s.require_paths = ["lib"]
-  s.license = "MIT"
-
-  s.required_ruby_version = ">= 2.1.0"
-
-  s.add_dependency "activerecord", ">= 4.0.0"
-
-  s.add_development_dependency "coveralls"
-  s.add_development_dependency "railties", ">= 4.0"
-  s.add_development_dependency "minitest", "~> 5.3"
-  s.add_development_dependency "mocha", "~> 2.1"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "i18n"
-  s.add_development_dependency "ffaker"
-  s.add_development_dependency "simplecov"
-
-  s.description = "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 strings as if they were numeric ids."
-end

data/gemfiles/Gemfile.rails-6.0.rb

@@ -1,22 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem "activerecord", "~> 6.0.0"
-gem "railties", "~> 6.0.0"
-
-# Database Configuration
-group :development, :test do
-  platforms :jruby do
-    gem "activerecord-jdbcmysql-adapter", "~> 51.1"
-    gem "activerecord-jdbcpostgresql-adapter", "~> 51.1"
-    gem "kramdown"
-  end
-
-  platforms :ruby, :rbx do
-    gem "sqlite3"
-    gem "mysql2"
-    gem "pg"
-    gem "redcarpet"
-  end
-end

data/gemfiles/Gemfile.rails-6.1.rb

@@ -1,22 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem "activerecord", "~> 6.1.4"
-gem "railties", "~> 6.1.4"
-
-# Database Configuration
-group :development, :test do
-  platforms :jruby do
-    gem "activerecord-jdbcmysql-adapter", "~> 61.0"
-    gem "activerecord-jdbcpostgresql-adapter", "~> 61.0"
-    gem "kramdown"
-  end
-
-  platforms :ruby, :rbx do
-    gem "sqlite3"
-    gem "mysql2"
-    gem "pg"
-    gem "redcarpet"
-  end
-end