sluggi 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96fa3f419d83aa9dd9df2699072fc12c8c3e786b45fcf8d19fe7adca90fd5438
-  data.tar.gz: 853a52b8ff87cb5833a56ca6d889f2cecce7d56763e6d5c9fed2b1a91a806368
+  metadata.gz: 183a80354c5c2961a06f2bfb30c00d2ba041475c66903307b6b3ceb365796cbe
+  data.tar.gz: 215ba9fbe8b604f934c71e5c8114d31e03f143d97dcee1a34424c13151ced084
 SHA512:
-  metadata.gz: 4f135200b99655e4437f10e077355f84bdcbe5b474eb72148644a0b9b72fc43a3d3da38f78b6f45951a98fc41bbdf36d60a6b711c93767763ac4cf91937ad423
-  data.tar.gz: edd20ee1f9d8d63c3e3d6a21e1d51fb229b5bf35510d2b53b6029cdbbc2eedbfcc35cd4d70a25a701db9cdfbf0cd71256602af5d540af54eef5dcfd7944a0f99
+  metadata.gz: 157a8f7ff7f2cba47c84741db578733a5ca1a61474f8a1e9d50b4a42ed9ee2a718fb15b0dcab90a53887bca51fcfe567b599d40a9371d703bab565217f754782
+  data.tar.gz: 6d673e52d9bd68df5d4413e8eb64bf7d8c90db80cec5fe011802ff209efee0b685a56710d25996a48e2b6698955f89397421f69f0da5d0bfe1ed1a4f7e80ffe8

data/README.md

@@ -1,9 +1,9 @@
 # Sluggi
 
-[![Gem Version](http://img.shields.io/gem/v/sluggi.svg)](http://rubygems.org/gems/sluggi)
-[![Build Status](http://img.shields.io/travis/neighborland/sluggi.svg)](https://travis-ci.org/neighborland/sluggi)
+[![Gem Version](https://img.shields.io/gem/v/sluggi.svg)](https://rubygems.org/gems/sluggi)
+[![Build Status](https://github.com/neighborland/sluggi/actions/workflows/ruby.yml/badge.svg)](https://github.com/neighborland/sluggi/actions/workflows/ruby.yml)
 
-Sluggi is a simple [friendly_id](https://github.com/norman/friendly_id)-inspired slugging library for ActiveRecord models.
+Sluggi is a simple [friendly_id](https://github.com/norman/friendly_id)-inspired slugging library for ActiveRecord models. It is faster than `friendly_id` (see below for benchmarks).
 
 It provides basic slugs, slug history, and the ability to define multiple slug candidates.
 
@@ -129,20 +129,23 @@ Cat.find_by_slug('tuxedo-stan')
 
 ### Model with Slug Candidates
 
-Override `#slug_candidates` to define cascading candidate values for slugs. This is useful to avoid
-uniqueness conflicts.
+Override `#slug_candidates` to define cascading candidate values for slugs.
+This is useful to avoid uniqueness conflicts. Do not override `#slug_value` -
+the default implementation in `Model` will call `#slug_candidates` and
+works with or without `History`.
 
 ```ruby
 class Cat < ActiveRecord::Base
   include Sluggi::Slugged
 
-  def name_and_id
-    "#{name}-#{id}"
-  end
-
-  # the first unused value in the list is used
+  # The first unused value in the list is used.
+  # Each item may be a value or a lambda.
+  # Use a lambda to defer expensive unique value calculations.
   def slug_candidates
-    [name, name_and_id]
+    [
+      name,
+      -> { "#{name}-#{Cat.count}" }
+    ]
   end
 
   def slug_value_changed?
@@ -158,11 +161,41 @@ cat.slug
 
 cat_2 = Cat.create(name: 'Tuxedo Stan')
 cat_2.slug
-=> 'tuxedo-stan-2'
-cat_2.id
-=> 2
+=> 'tuxedo-stan-456'
+```
+
+## Performance
+
+Run the benchmark script: `ruby bench.rb`. This script is based on the
+benchmark script from `friendly_id`.
+
+Here are some anecdotal results using ruby 2.5.3:
 
 ```
+                                                  SLUGGI      FRIENDLY_ID
+1) find (id) - direct ActiveRecord                0.092318    0.093049
+2) find (in-table slug)                           0.102773    0.259542
+3) find (in-table slug; using finders module)     0.098183    0.108248
+4) find (external slug)                           0.670229    0.832791
+5) insert (plain AR / no slug)                    0.345077    0.345105
+6) insert (in-table-slug)                         0.666451    0.815505
+7) insert (in-table-slug; using finders module)   0.668737    0.744433
+8) insert (external slug)                         2.480790    2.849761
+```
+
+Notes:
+
+Sluggi is at least 10% faster in every benchmark.
+
+1) Baseline (does not use either gem)
+2) 0.44x
+3) 0.90x
+4) 0.80x
+5) Baseline (does not use either gem)
+6) 0.82x
+7) 0.90x
+8) 0.87x
+
 
 ## Alternatives
 

data/lib/sluggi/history.rb

@@ -39,11 +39,10 @@ module Sluggi
     end
 
     def create_slug
-      value = clean_slug(slug_value)
-      return if value.blank?
-      return if slugs.first&.slug == value
-      self.class.find_slugs(value).delete_all # revert to previous slug & put first
-      slugs.create(slug: value)
+      return if slug.blank?
+      return if slugs.first&.slug == slug
+      self.class.find_slugs(slug).delete_all # revert to previous slug & put first
+      slugs.create(slug: slug)
     end
   end
 end

data/lib/sluggi/model.rb

@@ -11,6 +11,13 @@ module Sluggi
       before_validation :set_slug
     end
 
+    module ClassMethods
+      # Define this so that History can override it.
+      def slug_exists?(name)
+        exists?(slug: name)
+      end
+    end
+
     def to_param
       errors.any? ? slug_was : slug
     end
@@ -31,11 +38,12 @@ module Sluggi
     # these are generally good to override:
 
     def slug_value
-      slug_candidates.each do |value|
+      slug_candidates.each do |item|
+        value = item.respond_to?(:call) ? item.call : item
         next if value.blank?
         candidate = clean_slug(value)
         return candidate if candidate == slug
-        return candidate unless self.class.exists?(slug: candidate)
+        return candidate unless self.class.slug_exists?(candidate)
       end
       nil
     end

data/lib/sluggi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sluggi
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sluggi
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tee Parham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +118,7 @@ homepage: https://github.com/neighborland/sluggi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,16 +126,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Rails Slug Generator
 test_files: []