permalink 1.2.0 → 2.1.0

data/permalink.gemspec

@@ -1,6 +1,6 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "permalink/version"
+# frozen_string_literal: true
+
+require "./lib/permalink/version"
 
 Gem::Specification.new do |s|
   s.name        = "permalink"
@@ -9,21 +9,23 @@ Gem::Specification.new do |s|
   s.authors     = ["Nando Vieira"]
   s.email       = ["fnando.vieira@gmail.com"]
   s.homepage    = "http://rubygems.org/gems/permalink"
-  s.summary     = "Generate permalink attributes on ActiveRecord"
+  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.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_development_dependency "activerecord"
-  s.add_development_dependency "sqlite3-ruby"
-  s.add_development_dependency "test-unit"
-  s.add_development_dependency "rspec", "~> 2.7"
-  s.add_development_dependency "mongoid", "~> 2.3"
-  s.add_development_dependency "mongo_mapper", "~> 0.9"
-  s.add_development_dependency "bson_ext"
-  s.add_development_dependency "pry"
+  s.add_dependency "activerecord"
+  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"
 end

data/test/permalink/active_record_test.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ActiveRecordTest < Minitest::Test
+  let(:model) { Post }
+
+  setup do
+    model.delete_all
+    model.permalink :title
+  end
+
+  test "responds to options" do
+    assert model.respond_to?(:permalink_options)
+  end
+
+  test "uses default options" do
+    model.permalink :title
+    record = model.create(title: "Some nice post")
+    assert_equal "some-nice-post", record.permalink
+  end
+
+  test "uses custom attribute" do
+    model.permalink :title, to: :slug
+    record = model.create(title: "Some nice post")
+    assert_equal "some-nice-post", record.slug
+  end
+
+  test "sets permalink before_save" do
+    record = model.new(title: "Some nice post")
+    assert_nil record.permalink
+    record.valid?
+    assert_equal "some-nice-post", record.permalink
+  end
+
+  test "creates unique permalinks" do
+    model.permalink :title, unique: true
+
+    record = model.create(title: "Some nice post")
+    assert_equal "some-nice-post", record.permalink
+
+    record = model.create(title: "Some nice post")
+    assert_equal "some-nice-post-2", record.permalink
+
+    record = model.create(title: "Some nice post")
+    assert_equal "some-nice-post-3", record.permalink
+  end
+
+  test "creates unique permalinks with custom separator" do
+    model.permalink :title, unique: true, separator: "_"
+
+    record = model.create(title: "Some nice post")
+    assert_equal "some_nice_post", record.permalink
+
+    record = model.create(title: "Some nice post")
+    assert_equal "some_nice_post_2", record.permalink
+  end
+
+  test "creates unique permalinks based on scope" do
+    model.permalink :title, unique: true, scope: :user_id
+
+    user = User.create!
+    another_user = User.create!
+
+    # Create posts for user
+    record = model.create(title: "Some nice post", user: user)
+    assert_equal "some-nice-post", record.permalink
+
+    record = model.create(title: "Some nice post", user: user)
+    assert_equal "some-nice-post-2", record.permalink
+
+    # Create posts for another user
+    record = model.create(title: "Some nice post", user: another_user)
+    assert_equal "some-nice-post", record.permalink
+
+    record = model.create(title: "Some nice post", user: another_user)
+    assert_equal "some-nice-post-2", record.permalink
+  end
+
+  test "returns param for unique permalink" do
+    model.permalink :title, to_param: :permalink, unique: true
+
+    record = model.create(title: "Ruby")
+    assert_equal "ruby", record.to_param
+
+    record = model.create(title: "Ruby")
+    assert_equal "ruby-2", record.to_param
+  end
+
+  test "overrides to_param with custom fields" do
+    model.permalink :title, to: :slug, to_param: [:slug, :id, "page"]
+
+    record = model.create(title: "Some nice post")
+    assert_equal "some-nice-post-#{record.id}-page", record.to_param
+  end
+
+  test "ignores blank attributes from to_param" do
+    model.permalink :title, to_param: [:id, "    ", nil, "\t", :permalink]
+
+    record = model.create(title: "Some nice post")
+    assert_equal "#{record.id}-some-nice-post", record.to_param
+  end
+
+  test "sets permalink if permalink is blank" do
+    record = model.create(title: "Some nice post", permalink: "  ")
+    assert_equal "some-nice-post", record.permalink
+  end
+
+  test "keeps defined permalink" do
+    record = model.create(title: "Some nice post", permalink: "awesome-post")
+    assert_equal "awesome-post", record.permalink
+  end
+
+  test "creates unique permalinks for number-ended titles" do
+    model.permalink :title, unique: true
+
+    record = model.create(title: "Rails 3")
+    assert_equal "rails-3", record.permalink
+
+    record = model.create(title: "Rails 3")
+    assert_equal "rails-3-2", record.permalink
+  end
+
+  test "forces permalink" do
+    model.permalink :title, force: true
+
+    record = model.create(title: "Some nice post")
+    record.update title: "Awesome post"
+
+    assert_equal "awesome-post", record.permalink
+  end
+
+  test "forces permalink and keep unique" do
+    model.permalink :title, force: true, unique: true
+
+    record = model.create(title: "Some nice post")
+
+    record.update title: "Awesome post"
+    assert_equal "awesome-post", record.permalink
+
+    record = model.create(title: "Awesome post")
+    assert_equal "awesome-post-2", record.permalink
+  end
+
+  test "keeps same permalink when another field changes" do
+    model.permalink :title, force: true, unique: true
+
+    record = model.create(title: "Some nice post")
+    record.update description: "some description"
+
+    assert_equal "some-nice-post", record.permalink
+  end
+
+  test "overrides to_param method" do
+    model.permalink :title
+
+    record = model.create(title: "Some nice post")
+    assert_equal "#{record.id}-some-nice-post", record.to_param
+  end
+
+  test "uses custom separator" do
+    model.permalink :title, separator: "_"
+    record = model.create(title: "Some nice post")
+
+    assert_equal "#{record.id}_some_nice_post", record.to_param
+  end
+
+  test "uses custom normalization" do
+    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
+  end
+end

data/test/permalink/normalizations_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class NormalizationsTest < Minitest::Test
+  test "applies contraction replacement" do
+    assert_equal "its", Permalink::Normalizations::Contraction.call("it's")
+    assert_equal "aint", Permalink::Normalizations::Contraction.call("ain’t")
+  end
+
+  test "applies transliteration" do
+    assert_equal "aeiou",
+                 Permalink::Normalizations::Transliteration.call("áéíóú")
+  end
+
+  test "applies downcasing" do
+    assert_equal "test", Permalink::Normalizations::Downcase.call("TEST")
+  end
+
+  test "applies lead/trailing dashes replacement" do
+    permalink = Permalink::Normalizations::LeadingTrailingDashes.call("-test-")
+    assert_equal "test", permalink
+  end
+
+  test "applies multiple dashes replacement" do
+    permalink =
+      Permalink::Normalizations::MultipleDashes.call("nice----permalink")
+    assert_equal "nice-permalink", permalink
+  end
+
+  test "applies multiple dashes replacement with custom separator" do
+    permalink = Permalink::Normalizations::MultipleDashes
+                .call("nice----permalink", separator: "_")
+    assert_equal "nice_permalink", permalink
+  end
+
+  test "applies non-alphanumeric replacement" do
+    permalink =
+      Permalink::Normalizations::NonAlphanumeric.call("nice-permalink!")
+    assert_equal "nice-permalink-", permalink
+  end
+
+  test "applies non-alphanumeric replacement with custom separator" do
+    permalink = Permalink::Normalizations::NonAlphanumeric
+                .call("nice-permalink!", separator: "_")
+    assert_equal "nice_permalink_", permalink
+  end
+end

data/test/permalink/permalink_test.rb

@@ -0,0 +1,22 @@
+# 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", # 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)
+    end
+  end
+end

data/test/support/post.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

data/test/support/schema.rb

@@ -0,0 +1,11 @@
+# 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
+end

data/test/support/user.rb

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

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
+require "bundler/setup"
+require "permalink"
+
+require "minitest/utils"
+require "minitest/autorun"
+
+ActiveRecord::Base
+  .establish_connection(adapter: "sqlite3", database: ":memory:")
+
+load("support/schema.rb")
+require "support/user"
+require "support/post"

metadata

@@ -1,184 +1,172 @@
 --- !ruby/object:Gem::Specification
 name: permalink
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-21 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70099538008620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *70099538008620
-- !ruby/object:Gem::Dependency
-  name: sqlite3-ruby
-  requirement: &70099537997320 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70099537997320
 - !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: &70099538001440 !ruby/object:Gem::Requirement
-    none: false
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099538001440
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70099537985380 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: *70099537985380
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid
-  requirement: &70099537969500 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099537969500
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongo_mapper
-  requirement: &70099537975840 !ruby/object:Gem::Requirement
-    none: false
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099537975840
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bson_ext
-  requirement: &70099537055460 !ruby/object:Gem::Requirement
-    none: false
+  name: rubocop-fnando
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099537055460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
-  requirement: &70099537034980 !ruby/object:Gem::Requirement
-    none: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099537034980
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70099537034280 !ruby/object:Gem::Requirement
-    none: false
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099537034280
-description: Generate permalink attributes on ActiveRecord
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate permalink attributes on ActiveModel/ActiveRecord
 email:
 - fnando.vieira@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".github/FUNDING.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
-- README.markdown
+- README.md
 - Rakefile
 - lib/permalink.rb
-- lib/permalink/orm/active_record.rb
-- lib/permalink/orm/base.rb
-- lib/permalink/orm/mongo_mapper.rb
-- lib/permalink/orm/mongoid.rb
-- lib/permalink/string_ext.rb
+- lib/permalink/active_record.rb
+- lib/permalink/normalizations/contraction.rb
+- lib/permalink/normalizations/downcase.rb
+- lib/permalink/normalizations/leading_trailing_dashes.rb
+- lib/permalink/normalizations/multiple_dashes.rb
+- lib/permalink/normalizations/non_alphanumeric.rb
+- lib/permalink/normalizations/transliteration.rb
 - lib/permalink/version.rb
 - permalink.gemspec
-- spec/permalink/active_record_spec.rb
-- spec/permalink/mongo_mapper_spec.rb
-- spec/permalink/mongoid_spec.rb
-- spec/permalink/string_spec.rb
-- spec/spec_helper.rb
-- spec/support/article.rb
-- spec/support/page.rb
-- spec/support/post.rb
-- spec/support/schema.rb
-- spec/support/shared.rb
+- 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
 homepage: http://rubygems.org/gems/permalink
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 232250411774848879
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 232250411774848879
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 3
-summary: Generate permalink attributes on ActiveRecord
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Generate permalink attributes on ActiveModel/ActiveRecord
 test_files:
-- spec/permalink/active_record_spec.rb
-- spec/permalink/mongo_mapper_spec.rb
-- spec/permalink/mongoid_spec.rb
-- spec/permalink/string_spec.rb
-- spec/spec_helper.rb
-- spec/support/article.rb
-- spec/support/page.rb
-- spec/support/post.rb
-- spec/support/schema.rb
-- spec/support/shared.rb
+- 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