permalink 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f06ab000bf6cd401528119d1204c00ab69bef315
-  data.tar.gz: a5849ef5070c956a7e75c43107beebec5313a631
+SHA256:
+  metadata.gz: 2ba3402f7ea2dc013ff8162130c6cb1753d382eb3cbf875a862a5d70b695434a
+  data.tar.gz: 0b03c85505106a762905f31437ea052f1278d7bb559755eda3e5ca1f7eccb00b
 SHA512:
-  metadata.gz: 669627b51b923cc660c53f0022eeef03b516364beef51f4358366b1df99872a52518255d33699351cae1cd1acd79e120846469b894298b6c63a25e7f8fe49f02
-  data.tar.gz: e15ce00042b5d16d54e4ede403ccb27452f7a6f0e5892d935a38acfc71a2b03d86a42cd02ddf65877e39eb5a72f0f47a143e277974f7dac1ac53de7b1c1e7465
+  metadata.gz: 6f4fb178b99a2884e48c4a08b8e3e6f287eb5072626305aebb0aaf42cacd77945e6b007139a7320a4ff02dea046d2ce7dda5d7ff62205301cf0e37c04525fc64
+  data.tar.gz: 0e40038144ba10a2a757f3cc2684d336b79a9f508a159747071cb27690d69e18aa16a6e67672c51dbabdebd16a53e4f9963ff41a4ee399f97ff844c718a527e9

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+---
+name: test
+
+on:
+  pull_request_target:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  test:
+    name: test
+    runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install Ruby dependencies
+        run: |
+          bundle install
+
+      - name: Run tests
+        run: |
+          bundle exec rake

data/.gitignore

@@ -1,2 +1,3 @@
 pkg
 *.lock
+coverage

data/.rubocop.yml

@@ -0,0 +1,16 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+<!--
+Prefix your message with one of the following:
+
+- [Added] for new features.
+- [Changed] for changes in existing functionality.
+- [Deprecated] for soon-to-be removed features.
+- [Removed] for now removed features.
+- [Fixed] for any bug fixes.
+- [Security] in case of vulnerabilities.
+-->
+
+## 3.0.0 - Apr 22, 2024
+
+- [Changed] Plugin is not activated globally by default anymore; add
+  `Permalink.active_record` to your model or `ApplicationRecord`.
+- [Changed] Required ruby version is now 3.2 or newer.

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

data/LICENSE.txt

@@ -0,0 +1,18 @@
+Copyright (c) 2011-2024 Nando Vieira, released under the MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,9 +1,8 @@
 # Permalink
 
-[![Code Climate](https://codeclimate.com/github/fnando/permalink.png)](https://codeclimate.com/github/fnando/permalink)
-[![Build Status](https://travis-ci.org/fnando/permalink.svg)](https://travis-ci.org/fnando/permalink)
-[![Gem](https://img.shields.io/gem/v/permalink.svg)](https://rubygems.org/permalink)
-[![Gem](https://img.shields.io/gem/dt/permalink.svg)](https://rubygems.org/permalink)
+[![test](https://github.com/fnando/permalink/actions/workflows/test.yml/badge.svg)](https://github.com/fnando/permalink/actions/workflows/test.yml)
+[![Gem](https://img.shields.io/gem/v/permalink.svg)](https://rubygems.org/gems/permalink)
+[![Gem](https://img.shields.io/gem/dt/permalink.svg)](https://rubygems.org/gems/permalink)
 
 ## Installation
 
@@ -11,10 +10,24 @@
 
 ## Usage
 
-Add the method call `permalink` to your model. Your model should have a `permalink` attribute.
+> [!NOTE]
+>
+> To have the method `permalink` available, you need to inject
+> `Permalink.active_record` on each model, or use something like your
+> `ApplicationModel`.
 
 ```ruby
-class Page < ActiveRecord::Base
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+  include Permalink.active_record
+end
+```
+
+Add the method call `permalink` to your model. Your model should have a
+`permalink` attribute.
+
+```ruby
+class Page < ApplicationRecord
   permalink :title
 end
 ```
@@ -22,14 +35,16 @@ end
 You can specify the permalink field:
 
 ```ruby
-class page < ActiveRecord::Base
+class Page < ApplicationRecord
   permalink :title, to: "title_permalink"
 end
 ```
 
-If you don't want to use `permalink`, you can call `Permalink.generate("some text")` string method and manage the permalink process by yourself.
+If you don't want to use `permalink`, you can call `Permalink.call("some text")`
+string method and manage the permalink process by yourself.
 
-Permalinks are not unique by default. `permalink` overrides `to_param` as following:
+Permalinks are not unique by default. `permalink` overrides `to_param` as
+following:
 
 ```ruby
 def to_param
@@ -40,25 +55,28 @@ end
 You can define the `to_param` format:
 
 ```ruby
-class Page < ActiveRecord::Base
+class Page < ApplicationRecord
   permalink :title, to_param: %w(id permalink page)
 end
 ```
 
-The above settings will generate something link `100-some-title-page`. By overriding `to_param` method you don't have to change a thing on your app routes.
+The above settings will generate something link `100-some-title-page`. By
+overriding `to_param` method you don't have to change a thing on your app
+routes.
 
 If you want to generate unique permalink, use the `:unique` option:
 
 ```ruby
-class Page < ActiveRecord::Base
+class Page < ApplicationRecord
   permalink :title, unique: true, to_param: "permalink"
 end
 ```
 
-The permalink can be tied to a given scope. Let's say you want to have unique permalinks by user. Just set the `:scope` option.
+The permalink can be tied to a given scope. Let's say you want to have unique
+permalinks by user. Just set the `:scope` option.
 
 ```ruby
-class Page < ActiveRecord::Base
+class Page < ApplicationRecord
   belongs_to :user
   permalink :title, unique: true, scope: "user_id"
 end
@@ -73,24 +91,39 @@ another_page = another_user.pages.create(title: 'Hello')
 another_page.permalink #=> hello
 ```
 
-The permalink is generated using `ActiveSupport::Multibyte::Chars` class; this means that characters will properly replaced from `áéíó` to `aeio`, for instance.
+The permalink is generated using `ActiveSupport::Multibyte::Chars` class; this
+means that characters will properly replaced from `áéíó` to `aeio`, for
+instance.
 
-The permalink is created when `before_validation` callback is evaluated. This plugin also tries to generate a permalink when `before_save` callback is evaluated and the instance has no permalink set.
+The permalink is created when `before_validation` callback is evaluated. This
+plugin also tries to generate a permalink when `before_save` callback is
+evaluated and the instance has no permalink set.
 
 You can force the permalink generation by setting the `:force` option.
 
 ```ruby
-class Page < ActiveRecord::Base
+class Page < ApplicationRecord
   permalink :title, force: true
 end
 ```
 
 ## License
 
-Copyright (c) 2011-2015 Nando Vieira, released under the MIT license
+Copyright (c) 2011-2024 Nando Vieira, released under the MIT license
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.warning = false
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/permalink/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permalink
   module ActiveRecord
     def self.included(base)
@@ -16,14 +18,14 @@ module Permalink
       def permalink(from_column, options = {})
         include InstanceMethods
 
-        options = options.reverse_merge({
-          to_param: [:id, :permalink],
+        options = options.reverse_merge(
+          to_param: %i[id permalink],
           to: :permalink,
           unique: false,
           force: false,
           separator: "-",
           normalizations: Permalink::DEFAULT_NORMALIZATIONS
-        })
+        )
 
         self.permalink_options = {
           from_column_name: from_column,
@@ -45,14 +47,12 @@ module Permalink
       def to_param
         to_param_option = permalink_options[:to_param]
 
-        to_param_option.compact.map {|name|
+        to_param_option.compact.map do |name|
           respond_to?(name) ? public_send(name).to_s : name.to_s
-        }.reject(&:blank?).join(permalink_options[:separator])
+        end.reject(&:blank?).join(permalink_options[:separator])
       end
 
-      private
-
-      def next_available_permalink(permalink)
+      private def next_available_permalink(permalink)
         unique_permalink = permalink
         scope = build_scope_for_permalink
 
@@ -60,7 +60,9 @@ module Permalink
           suffix = 2
 
           while scope.where(to_permalink_name => unique_permalink).first
-            unique_permalink = [permalink, suffix].join(permalink_options[:separator])
+            unique_permalink =
+              [permalink, suffix].join(permalink_options[:separator])
+
             suffix += 1
           end
         end
@@ -68,42 +70,53 @@ module Permalink
         unique_permalink
       end
 
-      def build_scope_for_permalink
+      private def build_scope_for_permalink
         search_scope = permalink_options[:scope]
         scope = self.class.unscoped
-        scope = scope.where(search_scope => public_send(search_scope)) if search_scope
+
+        if search_scope
+          scope = scope.where(search_scope => public_send(search_scope))
+        end
+
         scope
       end
 
-      def from_permalink_name
+      private def from_permalink_name
         permalink_options[:from_column_name]
       end
 
-      def to_permalink_name
+      private def to_permalink_name
         permalink_options[:to_column_name]
       end
 
-      def from_permalink_value
+      private def from_permalink_value
         read_attribute(from_permalink_name)
       end
 
-      def to_permalink_value
+      private def to_permalink_value
         read_attribute(to_permalink_name)
       end
 
-      def update_permalink?
+      private def update_permalink?
         changes[from_permalink_name] &&
         (permalink_options[:force] || to_permalink_value.blank?)
       end
 
-      def create_permalink
+      private def create_permalink
+        return unless update_permalink?
+
+        permalink = Permalink.call(
+          from_permalink_value.to_s,
+          **permalink_generator_options
+        )
+
         write_attribute(
           to_permalink_name,
-          next_available_permalink(Permalink.generate(from_permalink_value.to_s, permalink_generator_options))
-        ) if update_permalink?
+          next_available_permalink(permalink)
+        )
       end
 
-      def permalink_generator_options
+      private def permalink_generator_options
         {
           separator: permalink_options[:separator],
           normalizations: permalink_options[:normalizations]

data/lib/permalink/normalizations/contraction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permalink
   module Normalizations
     module Contraction

data/lib/permalink/normalizations/downcase.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permalink
   module Normalizations
     module Downcase

data/lib/permalink/normalizations/leading_trailing_dashes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permalink
   module Normalizations
     module LeadingTrailingDashes

data/lib/permalink/normalizations/multiple_dashes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permalink
   module Normalizations
     module MultipleDashes

data/lib/permalink/normalizations/non_alphanumeric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permalink
   module Normalizations
     module NonAlphanumeric

data/lib/permalink/normalizations/transliteration.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Permalink
   module Normalizations
     module Transliteration
       def self.call(input, _options = nil)
-        ActiveSupport::Multibyte::Chars.new(input)
-          .normalize(:kd)
+        input
+          .unicode_normalize(:nfkd)
           .gsub(/[^\x00-\x7F]/, "")
           .to_s
       end

data/lib/permalink/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Permalink
   module Version
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 0
     PATCH = 0
-    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze
   end
 end

data/lib/permalink.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_record"
 require "permalink/active_record"
 require "permalink/normalizations/contraction"
@@ -15,15 +17,25 @@ module Permalink
     Normalizations::NonAlphanumeric,
     Normalizations::MultipleDashes,
     Normalizations::LeadingTrailingDashes
-  ]
+  ].freeze
+
+  DEFAULT_SEPARATOR = "-"
 
   DEFAULT_OPTIONS = {
     normalizations: DEFAULT_NORMALIZATIONS,
-    separator: "-"
-  }
+    separator: DEFAULT_SEPARATOR
+  }.freeze
+
+  def self.active_record
+    ActiveRecord
+  end
 
-  def self.generate(input, options = DEFAULT_OPTIONS)
-    options = DEFAULT_OPTIONS.merge(options)
+  def self.call(
+    input,
+    normalizations: DEFAULT_NORMALIZATIONS,
+    separator: DEFAULT_SEPARATOR
+  )
+    options = DEFAULT_OPTIONS.merge(normalizations:, separator:)
 
     options[:normalizations].each do |normalization|
       input = normalization.call(input, options)
@@ -31,6 +43,8 @@ module Permalink
 
     input
   end
-end
 
-ActiveRecord::Base.send(:include, Permalink::ActiveRecord)
+  class << self
+    alias generate call
+  end
+end

data/permalink.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "./lib/permalink/version"
 
 Gem::Specification.new do |s|
@@ -10,14 +12,20 @@ Gem::Specification.new do |s|
   s.summary     = "Generate permalink attributes on ActiveModel/ActiveRecord"
   s.description = s.summary
   s.license     = "MIT"
+  s.required_ruby_version = Gem::Requirement.new(">= 3.2")
+  s.metadata["rubygems_mfa_required"] = "true"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`
+                    .split("\n")
+                    .map {|f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_dependency "activerecord"
-  s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest-utils"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-fnando"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "sqlite3", "~> 1.4"
 end

data/test/permalink/active_record_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 class ActiveRecordTest < Minitest::Test
@@ -9,7 +11,7 @@ class ActiveRecordTest < Minitest::Test
   end
 
   test "responds to options" do
-    assert model.respond_to?(:permalink_options)
+    assert_respond_to model, :permalink_options
   end
 
   test "uses default options" do
@@ -61,10 +63,10 @@ class ActiveRecordTest < Minitest::Test
     another_user = User.create!
 
     # Create posts for user
-    record = model.create(title: "Some nice post", user: user)
+    record = model.create(title: "Some nice post", user:)
     assert_equal "some-nice-post", record.permalink
 
-    record = model.create(title: "Some nice post", user: user)
+    record = model.create(title: "Some nice post", user:)
     assert_equal "some-nice-post-2", record.permalink
 
     # Create posts for another user
@@ -123,7 +125,7 @@ class ActiveRecordTest < Minitest::Test
     model.permalink :title, force: true
 
     record = model.create(title: "Some nice post")
-    record.update_attributes title: "Awesome post"
+    record.update title: "Awesome post"
 
     assert_equal "awesome-post", record.permalink
   end
@@ -133,7 +135,7 @@ class ActiveRecordTest < Minitest::Test
 
     record = model.create(title: "Some nice post")
 
-    record.update_attributes title: "Awesome post"
+    record.update title: "Awesome post"
     assert_equal "awesome-post", record.permalink
 
     record = model.create(title: "Awesome post")
@@ -144,7 +146,7 @@ class ActiveRecordTest < Minitest::Test
     model.permalink :title, force: true, unique: true
 
     record = model.create(title: "Some nice post")
-    record.update_attributes description: "some description"
+    record.update description: "some description"
 
     assert_equal "some-nice-post", record.permalink
   end
@@ -164,7 +166,8 @@ class ActiveRecordTest < Minitest::Test
   end
 
   test "uses custom normalization" do
-    model.permalink :title, normalizations: [->(input, options) { input.to_s.reverse }]
+    model.permalink :title,
+                    normalizations: [->(input, _options) { input.to_s.reverse }]
     record = model.create(title: "Some nice post")
 
     assert_equal "Some nice post".reverse, record.permalink

data/test/permalink/normalizations_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 class NormalizationsTest < Minitest::Test
@@ -7,7 +9,8 @@ class NormalizationsTest < Minitest::Test
   end
 
   test "applies transliteration" do
-    assert_equal "aeiou", Permalink::Normalizations::Transliteration.call("áéíóú")
+    assert_equal "aeiou",
+                 Permalink::Normalizations::Transliteration.call("áéíóú")
   end
 
   test "applies downcasing" do
@@ -15,22 +18,31 @@ class NormalizationsTest < Minitest::Test
   end
 
   test "applies lead/trailing dashes replacement" do
-    assert_equal "test", Permalink::Normalizations::LeadingTrailingDashes.call("-test-")
+    permalink = Permalink::Normalizations::LeadingTrailingDashes.call("-test-")
+    assert_equal "test", permalink
   end
 
   test "applies multiple dashes replacement" do
-    assert_equal "nice-permalink", Permalink::Normalizations::MultipleDashes.call("nice----permalink")
+    permalink =
+      Permalink::Normalizations::MultipleDashes.call("nice----permalink")
+    assert_equal "nice-permalink", permalink
   end
 
   test "applies multiple dashes replacement with custom separator" do
-    assert_equal "nice_permalink", Permalink::Normalizations::MultipleDashes.call("nice----permalink", separator: "_")
+    permalink = Permalink::Normalizations::MultipleDashes
+                .call("nice----permalink", separator: "_")
+    assert_equal "nice_permalink", permalink
   end
 
   test "applies non-alphanumeric replacement" do
-    assert_equal "nice-permalink-", Permalink::Normalizations::NonAlphanumeric.call("nice-permalink!")
+    permalink =
+      Permalink::Normalizations::NonAlphanumeric.call("nice-permalink!")
+    assert_equal "nice-permalink-", permalink
   end
 
   test "applies non-alphanumeric replacement with custom separator" do
-    assert_equal "nice_permalink_", Permalink::Normalizations::NonAlphanumeric.call("nice-permalink!", separator: "_")
+    permalink = Permalink::Normalizations::NonAlphanumeric
+                .call("nice-permalink!", separator: "_")
+    assert_equal "nice_permalink_", permalink
   end
 end

data/test/permalink/permalink_test.rb

@@ -1,20 +1,26 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 class PermalinkTest < Minitest::Test
   {
-    'This IS a Tripped out title!!.!1  (well/ not really)' => 'this-is-a-tripped-out-title-1-well-not-really',
-    '////// meph1sto r0x ! \\\\\\' => 'meph1sto-r0x',
-    'āčēģīķļņū' => 'acegiklnu',
-    '中文測試 chinese text' => 'chinese-text',
-    'some-)()()-ExtRa!/// .data==?>    to \/\/test' => 'some-extra-data-to-test',
-    'http://simplesideias.com.br/tags/' => 'http-simplesideias-com-br-tags',
-    "Don't Repeat Yourself (DRY)" => 'dont-repeat-yourself-dry',
-    "Text\nwith\nline\n\n\tbreaks" => 'text-with-line-breaks',
+    "This IS a Tripped out title!!.!1  (well/ not really)" => "this-is-a-tripped-out-title-1-well-not-really", # rubocop:disable Layout/LineLength
+    "////// meph1sto r0x ! \\\\\\" => "meph1sto-r0x",
+    "āčēģīķļņū" => "acegiklnu",
+    "中文測試 chinese text" => "chinese-text",
+    'some-)()()-ExtRa!/// .data==?>   to \/\/test' => "some-extra-data-to-test",
+    "http://simplesideias.com.br/tags/" => "http-simplesideias-com-br-tags",
+    "Don't Repeat Yourself (DRY)" => "dont-repeat-yourself-dry",
+    "Text\nwith\nline\n\n\tbreaks" => "text-with-line-breaks",
     "can't do it" => "cant-do-it",
     "i'm a dog" => "im-a-dog"
   }.each do |from, to|
     test "creates permalink for #{from}" do
-      assert_equal to, Permalink.generate(from)
+      assert_equal to, Permalink.call(from)
     end
   end
+
+  test "returns active record module" do
+    assert_equal Permalink::ActiveRecord, Permalink.active_record
+  end
 end

data/test/support/post.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 class Post < ActiveRecord::Base
+  include Permalink.active_record
   belongs_to :user
 end

data/test/support/schema.rb

@@ -1,9 +1,10 @@
-ActiveRecord::Schema.define(:version => 0) do
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define(version: 0) do
   create_table :posts do |t|
     t.string :title, :permalink, :description, :slug
     t.belongs_to :user
   end
 
-  create_table :users do |t|
-  end
+  create_table :users
 end

data/test/support/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class User < ActiveRecord::Base
   has_many :posts
 end

data/test/test_helper.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
 require "bundler/setup"
 require "permalink"
 
@@ -10,4 +15,3 @@ ActiveRecord::Base
 load("support/schema.rb")
 require "support/user"
 require "support/post"
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permalink
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-27 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-utils
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  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: simplecov
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: Generate permalink attributes on ActiveModel/ActiveRecord
 email:
 - fnando.vieira@gmail.com
@@ -73,9 +115,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/permalink.rb
@@ -98,8 +144,9 @@ files:
 homepage: http://rubygems.org/gems/permalink
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,23 +154,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.8
+signing_key:
 specification_version: 4
 summary: Generate permalink attributes on ActiveModel/ActiveRecord
-test_files:
-- test/permalink/active_record_test.rb
-- test/permalink/normalizations_test.rb
-- test/permalink/permalink_test.rb
-- test/support/post.rb
-- test/support/schema.rb
-- test/support/user.rb
-- test/test_helper.rb
+test_files: []

data/.travis.yml

@@ -1,8 +0,0 @@
-cache: bundler
-sudo: false
-rvm:
-  - '2.0'
-  - '2.1'
-  - '2.3.0'
-notifications:
-  email: false