permalink 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b59f20670f6bcfbd6b204ad5e23aefcce7abf477b6b574d165d87e892e9b6afc
-  data.tar.gz: dfdee1e9df89d3d11e9d9240811c00a4307abf1a22accc6346e992b092326225
+  metadata.gz: 2ba3402f7ea2dc013ff8162130c6cb1753d382eb3cbf875a862a5d70b695434a
+  data.tar.gz: 0b03c85505106a762905f31437ea052f1278d7bb559755eda3e5ca1f7eccb00b
 SHA512:
-  metadata.gz: 79d9f75edc2fd001ffe2cc4544ba5bd0fbc38a7a842641f5d656136961233aa926a72e9ad2e5d387641e354d5b4dd919f92567289d84a137644ed7edab782857
-  data.tar.gz: '080cb2da608b09403a9e4aae8d42f1465a0cb33b3902aadf2f4747c50c72bd21bd361f91dc1abce55503df7d5488d5332099e20cc9755938ae54f8a5045cd9a3'
+  metadata.gz: 6f4fb178b99a2884e48c4a08b8e3e6f287eb5072626305aebb0aaf42cacd77945e6b007139a7320a4ff02dea046d2ce7dda5d7ff62205301cf0e37c04525fc64
+  data.tar.gz: 0e40038144ba10a2a757f3cc2684d336b79a9f508a159747071cb27690d69e18aa16a6e67672c51dbabdebd16a53e4f9963ff41a4ee399f97ff844c718a527e9

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/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   NewCops: enable
 
 Metrics/MethodLength:
@@ -11,3 +11,6 @@ Metrics/MethodLength:
 
 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/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,7 +1,6 @@
 # Permalink
 
-[![Code Climate](https://codeclimate.com/github/fnando/permalink.svg)](https://codeclimate.com/github/fnando/permalink)
-[![Build Status](https://travis-ci.org/fnando/permalink.svg)](https://travis-ci.org/fnando/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)
 
@@ -11,11 +10,24 @@
 
 ## Usage
 
+> [!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 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 < ActiveRecord::Base
+class Page < ApplicationRecord
   permalink :title
 end
 ```
@@ -23,14 +35,13 @@ 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:
@@ -44,7 +55,7 @@ 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
 ```
@@ -56,7 +67,7 @@ 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
 ```
@@ -65,7 +76,7 @@ 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
@@ -91,14 +102,14 @@ 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

data/lib/permalink/active_record.rb

@@ -105,9 +105,9 @@ module Permalink
       private def create_permalink
         return unless update_permalink?
 
-        permalink = Permalink.generate(
+        permalink = Permalink.call(
           from_permalink_value.to_s,
-          permalink_generator_options
+          **permalink_generator_options
         )
 
         write_attribute(

data/lib/permalink/version.rb

@@ -2,9 +2,9 @@
 
 module Permalink
   module Version
-    MAJOR = 2
-    MINOR = 1
+    MAJOR = 3
+    MINOR = 0
     PATCH = 0
-    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze
   end
 end

data/lib/permalink.rb

@@ -19,13 +19,23 @@ module Permalink
     Normalizations::LeadingTrailingDashes
   ].freeze
 
+  DEFAULT_SEPARATOR = "-"
+
   DEFAULT_OPTIONS = {
     normalizations: DEFAULT_NORMALIZATIONS,
-    separator: "-"
+    separator: DEFAULT_SEPARATOR
   }.freeze
 
-  def self.generate(input, options = DEFAULT_OPTIONS)
-    options = DEFAULT_OPTIONS.merge(options)
+  def self.active_record
+    ActiveRecord
+  end
+
+  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)
@@ -33,6 +43,8 @@ module Permalink
 
     input
   end
-end
 
-ActiveRecord::Base.include Permalink::ActiveRecord
+  class << self
+    alias generate call
+  end
+end

data/permalink.gemspec

@@ -12,10 +12,10 @@ 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(">= 2.5.0")
+  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) }
@@ -27,5 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop"
   s.add_development_dependency "rubocop-fnando"
   s.add_development_dependency "simplecov"
-  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sqlite3", "~> 1.4"
 end

data/test/permalink/active_record_test.rb

@@ -11,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
@@ -63,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

data/test/permalink/permalink_test.rb

@@ -5,7 +5,7 @@ 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", # rubocop:disable Layout/LineLength
-    '////// meph1sto r0x ! \\\\\\' => "meph1sto-r0x",
+    "////// meph1sto r0x ! \\\\\\" => "meph1sto-r0x",
     "āčēģīķļņū" => "acegiklnu",
     "中文測試 chinese text" => "chinese-text",
     'some-)()()-ExtRa!/// .data==?>   to \/\/test' => "some-extra-data-to-test",
@@ -16,7 +16,11 @@ class PermalinkTest < Minitest::Test
     "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,5 +1,6 @@
 # frozen_string_literal: true
 
 class Post < ActiveRecord::Base
+  include Permalink.active_record
   belongs_to :user
 end

data/test/support/schema.rb

@@ -6,6 +6,5 @@ ActiveRecord::Schema.define(version: 0) do
     t.belongs_to :user
   end
 
-  create_table :users do |t|
-  end
+  create_table :users
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permalink
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -98,16 +98,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: Generate permalink attributes on ActiveModel/ActiveRecord
 email:
 - fnando.vieira@gmail.com
@@ -116,10 +116,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/permalink.rb
@@ -142,7 +144,8 @@ files:
 homepage: http://rubygems.org/gems/permalink
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -151,22 +154,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+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,7 +0,0 @@
-cache: bundler
-sudo: false
-rvm:
-  - "2.7.1"
-  - "2.6.5"
-notifications:
-  email: false