slug 0.5.7 → 4.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b26d7fca3befe175649b0bdbe3b1e145e775ea77191fbe023f017d907cdfd64c
+  data.tar.gz: '06786f698b25c0e2d061ca77cbafa382e774bb96ded86a7b246c858909e8a1b5'
+SHA512:
+  metadata.gz: 248ca7e65bc8ccc47a9cec02c3843f4c1871aa743078627677078c4a52dbde1666226002033c0d5e4a107b27fdb32feb1f51c3d877c815bdb455cdf8dbe87bbf
+  data.tar.gz: dfab8ccf8d2daf51720cbc7ecfb44b9fb3ad5862f85e5e7a44b236170cbb1ac7caeaff52434764d80ed5f62bd0d11b2e104699a1011fe5ca3349e63db868cc16

data/README.rdoc

@@ -4,21 +4,21 @@ Slug provides simple, straightforward slugging for your ActiveRecord models.
 
 Slug is based on code from Norman Clarke's fantastic {friendly_id}[http://friendly-id.rubyforge.org] project and Nick Zadrozny's {friendly_identifier}[http://code.google.com/p/friendly-identifier/].
 
-Here's what's different:
+What's different:
 
 * Unlike friendly_id, slugs are stored directly in your model's table.  friendly_id stores its data in a separate sluggable table, which enables cool things like slug versioning--but forces yet another join when trying to do complex find_by_slugs.
 * Like friendly_id, diacritics (accented characters) are stripped from slug strings.
-* Most importantly, there are just two options: source column (for example, headline) and an optional slug column (if for some reason you don't want your slugs stored in a column called slug)
+* The number of options is manageable
 
 == INSTALLATION
 
-  sudo gem install slug --source http://gemcutter.org
+Add the gem to your Gemfile
 
-then add
+  gem 'slug'
 
-  config.gem 'slug', :source => 'http://gemcutter.org'
+of your rails project.
 
-to your rails project.
+This is tested with Rails 5.1.4, MRI Ruby 2.4.1
 
 == USAGE
 
@@ -40,11 +40,7 @@ Once your table is migrated, just add
 
 to your ActiveRecord model.  <tt>:source_field</tt> is the column you'd like to base the slug on--for example, it might be <tt>:headline</tt>.
 
-If you want to save the slug in a database column that isn't called <tt>slug</tt>, just pass the <tt>:column</tt> option. For example
-
-  slug :headline, :column => :web_slug
-
-would generate a slug based on <tt>headline</tt> and save it to <tt>web_slug</tt>.
+=== INSTANCE METHOD AS SOURCE COLUMN
 
 The source column isn't limited to just database attributes--you can specify any instance method.  This is handy if you need special formatting on your source column before it's slugged, or if you want to base the slug on several attributes.
 
@@ -57,18 +53,52 @@ For example:
       "#{headline}-#{publication_date.year}-#{publication_date.month}"
     end
   end
-end
 
 would use headline-pub year-pub month as the slug source.
 
 From here, you can work with your slug as if it were a normal column--<tt>find_by_slug</tt> and named scopes will work as they do for any other column.
 
-A few notes:
-* Slug validates presence and uniqueness of the slug column.  If you pass something that isn't sluggable as the source (for example, say you set the headline to '---'), a validation error will be set.
+== OPTIONS
+There are two options:
+- <tt>:column</tt> is the slug_column, if for some reason you don't want
+  your slugs stored in a column called "slug"
+- <tt>:generic_default</tt> is a boolean which, if true, will help you
+  avoid <tt>ActiveRecord::ValidationError</tt> exceptions on the slug column.
+
+=== COLUMN OPTION
+If you want to save the slug in a database column that isn't called
+<tt>slug</tt>, just pass the <tt>:column</tt> option. For example
+
+  slug :headline, :column => :web_slug
+
+would generate a slug based on <tt>headline</tt> and save it to <tt>web_slug</tt>.
+
+=== GENERIC DEFAULT OPTION
+You can avoid <tt>ActiveRecord::ValidationError</tt> exceptions that can
+occur if the source column is empty, blank, or only contains filtered
+characters. Simply set <tt>generic_default: true</tt>. For example
+
+  slug :headline, generic_default: true
+
+will generate a slug based on your model name if the headline is blank.
+
+This is useful if the source column (e.g. headline) is based on user-generated
+input or can be blank (nil or empty).
+
+Some prefer to get the exception in this case. Others want to get a good
+slug and move on.
+
+== NOTES
+* Slug validates presence and uniqueness of the slug column.  If you pass something that isn't sluggable as the source (for example, say you set the headline to '---'), a validation error will be set. (See the <tt>:generic_default</tt> option for avoiding this.
 * Slug doesn't update the slug if the source column changes.  If you really need to regenerate the slug, call <tt>@model.set_slug</tt> before save.
 * If a slug already exists, Slug will automatically append a '-n' suffix to your slug to make it unique.  The second instance of a slug is '-1'.
 * If you don't like the slug formatting or the accented character stripping doesn't work for you, it's easy to override Slug's formatting functions. Check the source for details.
 
 == AUTHOR
 
-Ben Koski, ben.koski@gmail.com
+Ben Koski, ben.koski@gmail.com
+
+with generous contributions from:
+- Derek Willis, @derekwillis
+- others listed in the commit history, which can be found in the
+{GitHub contributor list}[https://github.com/wbreeze/slug/graphs/contributors]

data/Rakefile

@@ -1,23 +1,6 @@
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "slug"
-    s.summary = %Q{Simple, straightforward slugs for your ActiveRecord models.}
-    s.email = "ben.koski@gmail.com"
-    s.homepage = "http://github.com/bkoski/slug"
-    s.description = "Simple, straightforward slugs for your ActiveRecord models."
-    s.add_dependency 'activerecord'
-    s.add_dependency 'activesupport'
-    s.authors = ["Ben Koski"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = 'slug'
@@ -33,15 +16,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |t|
-    t.libs << 'test'
-    t.test_files = FileList['test/**/*_test.rb']
-    t.verbose = true
-  end
-rescue LoadError
-  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-end
-
 task :default => :test

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 7
-:major: 0
-:minor: 5
+:major: 4
+:minor: 0
+:patch: 1

data/lib/slug/slug.rb

@@ -1,6 +1,6 @@
 module Slug
   module ClassMethods
-    
+
     # Call this to set up slug handling on an ActiveRecord model.
     #
     # Params:
@@ -8,37 +8,40 @@ module Slug
     #
     # Options:
     # * <tt>:column</tt> - the column the slug will be saved to (defaults to <tt>:slug</tt>)
-    # * <tt>:validates_uniquness_if</tt> - proc to determine whether uniqueness validation runs, same format as validates_uniquness_of :if
+    # * <tt>:validate_uniquness_if</tt> - proc to determine whether uniqueness validation runs, same format as validates_uniquness_of :if
     #
     # Slug will take care of validating presence and uniqueness of slug.
-    
+
     # Before create, Slug will generate and assign the slug if it wasn't explicitly set.
     # Note that subsequent changes to the source column will have no effect on the slug.
     # If you'd like to update the slug later on, call <tt>@model.set_slug</tt>
     def slug source, opts={}
-      class_inheritable_accessor :slug_source, :slug_column
+      class_attribute :slug_source, :slug_column, :generic_default
       include InstanceMethods
-      
+
       self.slug_source = source
-      
-      self.slug_column = opts.has_key?(:column) ? opts[:column] : :slug
+      self.slug_column = opts.fetch(:column, :slug)
+      self.generic_default = opts.fetch(:generic_default, false)
 
       uniqueness_opts = {}
-      uniqueness_opts.merge!(:if => opts[:validates_uniqueness_if]) if opts[:validates_uniqueness_if].present?
-      
-      validates_presence_of     self.slug_column, :message => "cannot be blank. Is #{self.slug_source} sluggable?"
-      validates_uniqueness_of   self.slug_column, uniqueness_opts
-      validates_format_of       self.slug_column, :with => /^[a-z0-9-]+$/, :message => "contains invalid characters. Only downcase letters, numbers, and '-' are allowed."
-      before_validation_on_create :set_slug 
+      uniqueness_opts.merge!(:if => opts[:validate_uniqueness_if]) if opts[:validate_uniqueness_if].present?
+      validates_uniqueness_of self.slug_column, uniqueness_opts
+
+      validates_presence_of self.slug_column,
+        message: "cannot be blank. Is #{self.slug_source} sluggable?"
+      validates_format_of self.slug_column,
+        with: /\A[a-z0-9-]+\z/,
+        message: "contains invalid characters. Only downcase letters, numbers, and '-' are allowed."
+      before_validation :set_slug, :on => :create
     end
   end
-  
+
   module InstanceMethods
-  
+
     # Sets the slug. Called before create.
     # By default, set_slug won't change slug if one already exists.  Pass :force => true to overwrite.
     def set_slug(opts={})
-      validate_slug_columns      
+      validate_slug_columns
       return unless self[self.slug_column].blank? || opts[:force] == true
 
       original_slug = self[self.slug_column]
@@ -46,23 +49,24 @@ module Slug
 
       strip_diacritics_from_slug
       normalize_slug
+      genericize_slug if generic_default
       assign_slug_sequence unless self[self.slug_column] == original_slug # don't try to increment seq if slug hasn't changed
     end
-  
+
     # Overwrite existing slug based on current contents of source column.
     def reset_slug
       set_slug(:force => true)
     end
-  
+
     # Overrides to_param to return the model's slug.
     def to_param
       self[self.slug_column]
     end
-  
+
     def self.included(klass)
       klass.extend(ClassMethods)
     end
-  
+
     private
     # Validates that source and destination methods exist. Invoked at runtime to allow definition
     # of source/slug methods after <tt>slug</tt> setup in class.
@@ -70,7 +74,7 @@ module Slug
       raise ArgumentError, "Source column '#{self.slug_source}' does not exist!" if !self.respond_to?(self.slug_source)
       raise ArgumentError, "Slug column '#{self.slug_column}' does not exist!"   if !self.respond_to?("#{self.slug_column}=")
     end
-    
+
     # Takes the slug, downcases it and replaces non-word characters with a -.
     # Feel free to override this method if you'd like different slug formatting.
     def normalize_slug
@@ -84,7 +88,13 @@ module Slug
       s.gsub!(/-+/, '-')      # get rid of double-dashes
       self[self.slug_column] = s.to_s
     end
-  
+
+    def genericize_slug
+      if self[self.slug_column].blank?
+        self[self.slug_column] = self.class.to_s.demodulize.underscore.dasherize
+      end
+    end
+
     # Converts accented characters to their ASCII equivalents and removes them if they have no equivalent.
     # Override this with a void function if you don't want accented characters to be stripped.
     def strip_diacritics_from_slug
@@ -102,26 +112,24 @@ module Slug
       s = s.pack('U*')
       self[self.slug_column] = s.to_s
     end
-  
+
     # If a slug of the same name already exists, this will append '-n' to the end of the slug to
     # make it unique. The second instance gets a '-1' suffix.
     def assign_slug_sequence
       return if self[self.slug_column].blank?
-      idx = next_slug_sequence
-      self[self.slug_column] = "#{self[self.slug_column]}-#{idx}" if idx > 0
+      self[self.slug_column] = next_slug_sequence
     end
-  
+
     # Returns the next unique index for a slug.
     def next_slug_sequence
-      last_in_sequence = self.class.find(:first, :conditions => ["#{self.slug_column} LIKE ?", self[self.slug_column] + '%'],
-                                           :order => "CAST(REPLACE(#{self.slug_column},'#{self[self.slug_column]}','') AS UNSIGNED)")
-      if last_in_sequence.nil?
-        return 0
-      else
-        sequence_match = last_in_sequence[self.slug_column].match(/^#{self[self.slug_column]}(-(\d+))?/)
-        current = sequence_match.nil? ? 0 : sequence_match[2].to_i
-        return current + 1
+      assoc = self.class.base_class
+      base_val = slug_val = self[self.slug_column]
+      next_id = 1
+      until assoc.where(self.slug_column => slug_val).first.nil? do
+        slug_val = base_val + "-#{next_id}"
+        next_id = next_id + 1
       end
+      slug_val
     end
   end
-end
+end

data/lib/slug.rb

@@ -3,4 +3,8 @@ require File.join(File.dirname(__FILE__), 'slug', 'ascii_approximations')
 
 if defined?(ActiveRecord)
   ActiveRecord::Base.instance_eval { extend Slug::ClassMethods }
+end
+
+if defined?(Rails) && Rails.version.to_i < 3
+  raise "This version of slug requires Rails 3 or higher"
 end

data/slug.gemspec

@@ -1,61 +1,60 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
+# stub: slug 4.0.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = %q{slug}
-  s.version = "0.5.7"
+  s.name = "slug"
+  s.version = "4.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Ben Koski"]
-  s.date = %q{2010-06-25}
-  s.description = %q{Simple, straightforward slugs for your ActiveRecord models.}
-  s.email = %q{ben.koski@gmail.com}
+  s.date = "2018-11-11"
+  s.description = "Simple, straightforward slugs for your ActiveRecord models."
+  s.email = "ben.koski@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION.yml",
-     "lib/slug.rb",
-     "lib/slug/ascii_approximations.rb",
-     "lib/slug/slug.rb",
-     "slug.gemspec",
-     "test/models.rb",
-     "test/schema.rb",
-     "test/test_helper.rb",
-     "test/test_slug.rb"
-  ]
-  s.homepage = %q{http://github.com/bkoski/slug}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Simple, straightforward slugs for your ActiveRecord models.}
-  s.test_files = [
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "lib/slug.rb",
+    "lib/slug/ascii_approximations.rb",
+    "lib/slug/slug.rb",
+    "slug.gemspec",
     "test/models.rb",
-     "test/schema.rb",
-     "test/test_helper.rb",
-     "test/test_slug.rb"
+    "test/schema.rb",
+    "test/test_helper.rb",
+    "test/slug_test.rb"
   ]
+  s.homepage = "http://github.com/bkoski/slug"
+  s.rubygems_version = "2.2.0"
+  s.summary = "Simple, straightforward slugs for your ActiveRecord models."
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+    s.specification_version = 4
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, ["> 3.0.0"])
+      s.add_runtime_dependency(%q<activesupport>, ["> 3.0.0"])
     else
-      s.add_dependency(%q<activerecord>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["> 3.0.0"])
+      s.add_dependency(%q<activesupport>, ["> 3.0.0"])
     end
   else
-    s.add_dependency(%q<activerecord>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["> 3.0.0"])
+    s.add_dependency(%q<activesupport>, ["> 3.0.0"])
   end
 end
+

data/test/models.rb

@@ -1,6 +1,9 @@
 # Used to test slug behavior in general
 class Article < ActiveRecord::Base
-  slug :headline  
+  slug :headline
+end
+
+class Storyline < Article
 end
 
 # Used to test alternate slug column
@@ -14,14 +17,20 @@ class Company < ActiveRecord::Base
 end
 
 class Post < ActiveRecord::Base
-  slug :headline, :validates_uniqueness_if => Proc.new { false } 
+  slug :headline, :validate_uniqueness_if => Proc.new { false } 
 end
 
 # Used to test slugs based on methods rather than database attributes
 class Event < ActiveRecord::Base
   slug :title_for_slug
-  
+
   def title_for_slug
     "#{title}-#{location}"
   end
-end
+end
+
+# Test generation of generic slugs
+class Generation < ActiveRecord::Base
+  slug :title, generic_default: true
+end
+

data/test/schema.rb

@@ -1,30 +1,35 @@
 ActiveRecord::Schema.define(:version => 1) do
-
   create_table "articles", :force => true do |t|
-    t.column "headline", "string"
+    t.column "headline", "string", null: false
     t.column "section", "string"
-    t.column "slug", "string"
+    t.column "slug", "string", null: false
+    t.column "type", "string"
+    t.index ["slug"], name: "index_articles_on_slug", unique: true
   end
-  
+
   create_table "people", :force => true do |t|
     t.column "name", "string"
     t.column "web_slug", "string"
   end
-  
+
   create_table "companies", :force => true do |t|
     t.column "name", "string"
     t.column "slug", "string"
   end
-  
+
   create_table "posts", :force => true do |t|
     t.column "headline", "string"
     t.column "slug", "string"
   end
-  
+
   create_table "events", :force => true do |t|
     t.column "title", "string"
     t.column "location", "string"
     t.column "slug", "string"
   end
-  
-end
+
+  create_table "generations", :force => true do |t|
+    t.column "title", "string"
+    t.column "slug", "string", null: false
+  end
+end

data/test/slug_test.rb

@@ -0,0 +1,310 @@
+# encoding: utf-8
+require 'test_helper'
+
+describe Slug do
+  before do
+    Article.delete_all
+  end
+
+  describe 'slug' do
+    it "bases slug on specified source column" do
+      article = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline', article.slug
+    end
+
+    it "bases slug on specified source column, even if it is defined as a method rather than database attribute" do
+      article = Event.create!(:title => 'Test Event', :location => 'Portland')
+      assert_equal 'test-event-portland', article.slug
+    end
+
+    describe "slug column" do
+      it "saves slug to 'slug' column by default" do
+        article = Article.create!(:headline => 'Test Headline')
+        assert_equal 'test-headline', article.slug
+      end
+
+      it "saves slug to :column specified in options" do
+        Person.delete_all
+        person = Person.create!(:name => 'Test Person')
+        assert_equal 'test-person', person.web_slug
+      end
+    end
+  end
+
+  describe "column validations" do
+    it "raises ArgumentError if an invalid source column is passed" do
+      Company.slug(:invalid_source_column)
+      assert_raises(ArgumentError) { Company.create! }
+    end
+
+    it "raises an ArgumentError if an invalid slug column is passed" do
+      Company.slug(:name, :column => :bad_slug_column)
+      assert_raises(ArgumentError) { Company.create! }
+    end
+  end
+
+  describe 'generates a generic slug' do
+    before do
+      Generation.delete_all
+    end
+
+    it "if source column is empty" do
+      generation = Generation.create!
+      assert_equal 'generation', generation.slug
+    end
+
+    it "if normalization makes source value empty" do
+      generation = Generation.create!(:title => '$$$')
+      assert_equal 'generation', generation.slug
+    end
+
+    it "if source value contains no Latin characters" do
+      generation = Generation.create!(:title => 'ローマ字がない')
+      assert_equal 'generation', generation.slug
+    end
+  end
+
+  describe 'validation' do
+    it "sets validation error if source column is empty" do
+      article = Article.create
+      assert !article.valid?
+      assert article.errors[:slug]
+    end
+
+    it "sets validation error if normalization makes source value empty" do
+      article = Article.create(:headline => '$$$')
+      assert !article.valid?
+      assert article.errors[:slug]
+    end
+
+    it "validates slug format on save" do
+      article = Article.create!(:headline => 'Test Headline')
+      article.slug = 'A BAD $LUG.'
+
+      assert !article.valid?
+      assert article.errors[:slug].present?
+    end
+
+    it "validates uniqueness of slug by default" do
+      Article.create!(:headline => 'Test Headline')
+      article2 = Article.create!(:headline => 'Test Headline')
+      article2.slug = 'test-headline'
+
+      assert !article2.valid?
+      assert article2.errors[:slug].present?
+    end
+
+    it "uses validate_uniqueness_if proc to decide whether uniqueness validation applies" do
+      Post.create!(:headline => 'Test Headline')
+      article2 = Post.new
+      article2.slug = 'test-headline'
+
+      assert article2.valid?
+    end
+  end
+
+  it "doesn't overwrite slug value on create if it was already specified" do
+    a = Article.create!(:headline => 'Test Headline', :slug => 'slug1')
+    assert_equal 'slug1', a.slug
+  end
+
+  it "doesn't update the slug even if the source column changes" do
+    article = Article.create!(:headline => 'Test Headline')
+    article.update_attributes!(:headline =>  'New Headline')
+    assert_equal 'test-headline', article.slug
+  end
+
+  describe "resetting a slug" do
+    before do
+      @article = Article.create(:headline => 'test headline')
+      @original_slug = @article.slug
+    end
+
+    it "maintains the same slug if slug column hasn't changed" do
+      @article.reset_slug
+      assert_equal @original_slug, @article.slug
+    end
+
+    it "changes slug if slug column has updated" do
+      @article.headline = "donkey"
+      @article.reset_slug
+      refute_equal(@original_slug, @article.slug)
+    end
+
+    it "maintains sequence" do
+      @existing_article = Article.create!(:headline => 'world cup')
+      @article.headline = "world cup"
+      @article.reset_slug
+      assert_equal 'world-cup-1', @article.slug
+    end
+  end
+
+  describe "slug normalization" do
+    before do
+      @article = Article.new
+    end
+
+    it "lowercases strings" do
+      @article.headline = 'AbC'
+      @article.save!
+      assert_equal "abc", @article.slug
+    end
+
+    it "replaces whitespace with dashes" do
+      @article.headline = 'a b'
+      @article.save!
+      assert_equal 'a-b', @article.slug
+    end
+
+    it "replaces 2spaces with 1dash" do
+      @article.headline = 'a  b'
+      @article.save!
+      assert_equal 'a-b', @article.slug
+    end
+
+    it "removes punctuation" do
+      @article.headline = 'abc!@#$%^&*•¶§∞¢££¡¿()><?""\':;][]\.,/'
+      @article.save!
+      assert_match 'abc', @article.slug
+    end
+
+    it "strips trailing space" do
+      @article.headline = 'ab '
+      @article.save!
+      assert_equal 'ab', @article.slug
+    end
+
+    it "strips leading space" do
+      @article.headline = ' ab'
+      @article.save!
+      assert_equal 'ab', @article.slug
+    end
+
+    it "strips trailing dashes" do
+      @article.headline = 'ab-'
+      @article.save!
+      assert_match 'ab', @article.slug
+    end
+
+    it "strips leading dashes" do
+      @article.headline = '-ab'
+      @article.save!
+      assert_match 'ab', @article.slug
+    end
+
+    it "remove double-dashes" do
+      @article.headline = 'a--b--c'
+      @article.save!
+      assert_match 'a-b-c', @article.slug
+    end
+
+    it "doesn't modify valid slug strings" do
+      @article.headline = 'a-b-c-d'
+      @article.save!
+      assert_match 'a-b-c-d', @article.slug
+    end
+
+    it "doesn't insert dashes for periods in acronyms, regardless of where they appear in string" do
+      @article.headline = "N.Y.P.D. vs. N.S.A. vs. F.B.I."
+      @article.save!
+      assert_match 'nypd-vs-nsa-vs-fbi', @article.slug
+    end
+
+    it "doesn't insert dashes for apostrophes" do
+      @article.headline = "Thomas Jefferson's Papers"
+      @article.save!
+      assert_match 'thomas-jeffersons-papers', @article.slug
+    end
+
+    it "preserves numbers in slug" do
+      @article.headline = "2010 Election"
+      @article.save!
+      assert_match '2010-election', @article.slug
+    end
+  end
+
+  describe "diacritics handling" do
+    before do
+      @article = Article.new
+    end
+
+    it "strips diacritics" do
+      @article.headline = "açaí"
+      @article.save!
+      assert_equal "acai", @article.slug
+    end
+
+    it "strips diacritics correctly " do
+      @article.headline  = "ÀÁÂÃÄÅÆÇÈÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ"
+      @article.save!
+      expected = "aaaaaaaeceeeiiiidnoooooouuuuythssaaaaaaaeceeeeiiiidnoooooouuuuythy".split(//)
+      output = @article.slug.split(//)
+      output.each_index do |i|
+        assert_equal expected[i], output[i]
+      end
+    end
+  end
+
+  describe "sequence handling" do
+    it "doesn't add a sequence if saving first instance of slug" do
+      article = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline', article.slug
+    end
+
+    it "assigns a -1 suffix to the second instance of the slug" do
+      Article.create!(:headline => 'Test Headline')
+      article_2 = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline-1', article_2.slug
+    end
+
+    it 'assigns a -2 suffix to the third instance of the slug containing numbers' do
+      2.times { |i| Article.create! :headline => '11111' }
+      article_3 = Article.create! :headline => '11111'
+      assert_equal '11111-2', article_3.slug
+    end
+
+    it "assigns a -12 suffix to the thirteenth instance of the slug" do
+      12.times { |i| Article.create!(:headline => 'Test Headline') }
+      article_13 = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline-12', article_13.slug
+
+      12.times { |i| Article.create!(:headline => 'latest from lybia') }
+      article_13 = Article.create!(:headline => 'latest from lybia')
+      assert_equal 'latest-from-lybia-12', article_13.slug
+    end
+
+    it "ignores partial matches when calculating sequence" do
+      article_1 = Article.create!(:headline => 'Test Headline')
+      assert_equal 'test-headline', article_1.slug
+      article_2 = Article.create!(:headline => 'Test')
+      assert_equal 'test', article_2.slug
+      article_3 = Article.create!(:headline => 'Test')
+      assert_equal 'test-1', article_3.slug
+      article_4 = Article.create!(:headline => 'Test')
+      assert_equal 'test-2', article_4.slug
+    end
+
+    it "knows about single table inheritance" do
+      article = Article.create!(:headline => 'Test Headline')
+      story = Storyline.create!(:headline => article.headline)
+      assert_equal 'test-headline-1', story.slug
+    end
+
+    it "correctly slugs when a slug is a substring of another" do
+      rap_metal = Article.create!(:headline => 'Rap Metal')
+      assert_equal 'rap-metal', rap_metal.slug
+
+      rap = Article.create!(:headline => 'Rap')
+      assert_equal('rap', rap.slug)
+    end
+
+    it "applies sequence logic correctly when the slug is a substring of another" do
+      rap_metal = Article.create!(:headline => 'Rap Metal')
+      assert_equal 'rap-metal', rap_metal.slug
+
+      Article.create!(:headline => 'Rap')
+      second_rap = Article.create!(:headline => 'Rap')
+      assert_equal('rap-1', second_rap.slug)
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,26 +1,21 @@
 require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
-
-class Test::Unit::TestCase
-end
+require 'minitest/autorun'
+require 'minitest/reporters'
 
 # You can use "rake test AR_VERSION=2.0.5" to test against 2.0.5, for example.
 # The default is to use the latest installed ActiveRecord.
 if ENV["AR_VERSION"]
   gem 'activerecord', "#{ENV["AR_VERSION"]}"
-  gem 'activesupport', "#{ENV["AR_VERSION"]}"
 end
 require 'active_record'
-require 'active_support'
+
+# color test output
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => true)]
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'slug'
 
 ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
-silence_stream(STDOUT) do
-  load(File.dirname(__FILE__) + "/schema.rb")
-end
+load(File.dirname(__FILE__) + "/schema.rb")
 
 require 'models'

metadata

@@ -1,48 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: slug
-version: !ruby/object:Gem::Version 
-  version: 0.5.7
+version: !ruby/object:Gem::Version
+  version: 4.0.1
 platform: ruby
-authors: 
+authors:
 - Ben Koski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-25 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
+date: 2018-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
   name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Simple, straightforward slugs for your ActiveRecord models.
 email: ben.koski@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
-- .gitignore
+files:
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -53,38 +98,29 @@ files:
 - slug.gemspec
 - test/models.rb
 - test/schema.rb
+- test/slug_test.rb
 - test/test_helper.rb
-- test/test_slug.rb
-has_rdoc: true
 homepage: http://github.com/bkoski/slug
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple, straightforward slugs for your ActiveRecord models.
-test_files: 
-- test/models.rb
-- test/schema.rb
-- test/test_helper.rb
-- test/test_slug.rb
+test_files: []

data/.gitignore

@@ -1,3 +0,0 @@
-*.sw?
-.DS_Store
-coverage

data/test/test_slug.rb

@@ -1,246 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class TestSlug < Test::Unit::TestCase
-
-  def setup
-    Article.delete_all
-    Person.delete_all
-  end
-
-  should "base slug on specified source column" do
-    article = Article.create!(:headline => 'Test Headline')
-    assert_equal 'test-headline', article.slug
-  end
-
-  should "base slug on specified source column, even if it is defined as a method rather than database attribute" do
-    article = Event.create!(:title => 'Test Event', :location => 'Portland')
-    assert_equal 'test-event-portland', article.slug
-  end
-
-  context "slug column" do
-    should "save slug to 'slug' column by default" do
-      article = Article.create!(:headline => 'Test Headline')
-      assert_equal 'test-headline', article.slug
-    end
-    
-    should "save slug to :column specified in options" do
-      person = Person.create!(:name => 'Test Person')
-      assert_equal 'test-person', person.web_slug
-    end
-  end
-
-  context "column validations" do
-    should "raise ArgumentError if an invalid source column is passed" do
-      Company.slug(:invalid_source_column) 
-      assert_raises(ArgumentError) { Company.create! }
-    end
-
-    should "raise an ArgumentError if an invalid slug column is passed" do
-      Company.slug(:name, :column => :bad_slug_column)
-      assert_raises(ArgumentError) { Company.create! }
-    end
-  end
-  
-  should "set validation error if source column is empty" do
-    article = Article.create
-    assert !article.valid?
-    require 'ruby-debug'
-    assert article.errors.on(:slug)
-  end
-  
-  should "set validation error if normalization makes source value empty" do
-    article = Article.create(:headline => '$$$')
-    assert !article.valid?
-    assert article.errors.on(:slug)
-  end
-  
-  should "not update the slug even if the source column changes" do
-    article = Article.create!(:headline => 'Test Headline')
-    article.update_attributes!(:headline =>  'New Headline')
-    assert_equal 'test-headline', article.slug
-  end
-
-  should "validate slug format on save" do
-    article = Article.create!(:headline => 'Test Headline')
-    article.slug = 'A BAD $LUG.'
-
-    assert !article.valid?
-    assert article.errors[:slug].present?
-  end
-  
-  should "validate uniqueness of slug by default" do
-    article1 = Article.create!(:headline => 'Test Headline')
-    article2 = Article.create!(:headline => 'Test Headline')
-    article2.slug = 'test-headline'
-    
-    assert !article2.valid?
-    assert article2.errors[:slug].present?
-  end
-
-  should "use validate_uniquness_if proc to decide whether uniqueness validation applies" do
-    article1 = Post.create!(:headline => 'Test Headline')
-    article2 = Post.new
-    article2.slug = 'test-headline'
-    
-    assert article2.valid?
-  end
-
-  should "not overwrite slug value on create if it was already specified" do
-    a = Article.create!(:headline => 'Test Headline', :slug => 'slug1')
-    assert_equal 'slug1', a.slug
-  end
-
-  context "resetting a slug" do
-  
-    setup do
-      @article = Article.create(:headline => 'test headline')
-      @original_slug = @article.slug
-    end
-    
-    should "maintain the same slug if slug column hasn't changed" do
-      @article.reset_slug
-      assert_equal @original_slug, @article.slug      
-    end
-    
-    should "change slug if slug column has updated" do
-      @article.headline = "donkey"
-      @article.reset_slug
-      assert_not_equal @original_slug, @article.slug
-    end
-    
-    should "maintain sequence" do
-      @existing_article = Article.create!(:headline => 'world cup')
-      @article.headline = "world cup"
-      @article.reset_slug
-      assert_equal 'world-cup-1', @article.slug
-    end
-  
-  end
-  
-  
-  context "slug normalization" do
-    setup do
-      @article = Article.new
-    end
-
-    should "should lowercase strings" do
-      @article.headline = 'AbC'
-      @article.save!
-      assert_equal "abc", @article.slug
-    end
-  
-    should "should replace whitespace with dashes" do
-      @article.headline = 'a b'
-      @article.save!
-      assert_equal 'a-b', @article.slug
-    end
-
-    should "should replace 2spaces with 1dash" do
-      @article.headline = 'a  b'
-      @article.save!
-      assert_equal 'a-b', @article.slug
-    end
-
-    should "should remove punctuation" do
-      @article.headline = 'abc!@#$%^&*•¶§∞¢££¡¿()><?""\':;][]\.,/'
-      @article.save!
-      assert_match 'abc', @article.slug
-    end
-  
-    should "should strip trailing space" do
-      @article.headline = 'ab '
-      @article.save!
-      assert_equal 'ab', @article.slug
-    end
-
-    should "should strip leading space" do
-      @article.headline = ' ab'
-      @article.save!
-      assert_equal 'ab', @article.slug
-    end
-      
-    should "should strip trailing dashes" do
-      @article.headline = 'ab-'
-      @article.save!
-      assert_match 'ab', @article.slug
-    end
-
-    should "should strip leading dashes" do
-      @article.headline = '-ab'
-      @article.save!
-      assert_match 'ab', @article.slug
-    end
-
-    should "remove double-dashes" do
-      @article.headline = 'a--b--c'
-      @article.save!
-      assert_match 'a-b-c', @article.slug
-    end
-
-    should "should not modify valid slug strings" do
-      @article.headline = 'a-b-c-d'
-      @article.save!
-      assert_match 'a-b-c-d', @article.slug
-    end
-    
-    should "not insert dashes for periods in acronyms, regardless of where they appear in string" do
-      @article.headline = "N.Y.P.D. vs. N.S.A. vs. F.B.I."
-      @article.save!
-      assert_match 'nypd-vs-nsa-vs-fbi', @article.slug
-    end
-    
-    should "not insert dashes for apostrophes" do
-      @article.headline = "Thomas Jefferson's Papers"
-      @article.save!
-      assert_match 'thomas-jeffersons-papers', @article.slug
-    end
-    
-    should "preserve numbers in slug" do
-      @article.headline = "2010 Election"
-      @article.save!
-      assert_match '2010-election', @article.slug
-    end
-  end
-  
-  context "diacritics handling" do
-    setup do
-      @article = Article.new
-    end
-  
-    should "should strip diacritics" do
-      @article.headline = "açaí"
-      @article.save!
-      assert_equal "acai", @article.slug
-    end
-  
-    should "strip diacritics correctly " do
-      @article.headline  = "ÀÁÂÃÄÅÆÇÈÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ"
-      @article.save!
-      expected = "aaaaaaaeceeeiiiidnoooooouuuuythssaaaaaaaeceeeeiiiidnoooooouuuuythy".split(//)
-      output = @article.slug.split(//)
-      output.each_index do |i|
-        assert_equal expected[i], output[i]
-      end
-    end
-  end
-
-  context "sequence handling" do
-    should "not add a sequence if saving first instance of slug" do
-      article = Article.create!(:headline => 'Test Headline')
-      assert_equal 'test-headline', article.slug
-    end
-    
-    should "assign a -1 suffix to the second instance of the slug" do
-      article_1 = Article.create!(:headline => 'Test Headline')
-      article_2 = Article.create!(:headline => 'Test Headline')
-      assert_equal 'test-headline-1', article_2.slug
-    end
-    
-    should "assign a -12 suffix to the thirteenth instance of the slug" do
-      12.times { |i| Article.create!(:headline => 'Test Headline') }
-      article_13 = Article.create!(:headline => 'Test Headline')
-      assert_equal 'test-headline-12', article_13.slug
-    end
-  end
-
-end