Merge https://github.com/ambit-contacts/slug into ambit-connects

There are several improvements in this branch from @ambit-contacts which
we incorporate here:
- add a generic default option vs. throwing an exception when source column
generates an empty slug (we made this optional; some might prefer to get
the exception)
- additional test for partial matches

In addition:
- reduce number of gem dependencies
- dry-up some of the test setup
- use explicit vs. implicit validation methods
- a tiny bit of trailing whitespace cleanup

Author: wbreeze

Gemfile

@@ -3,9 +3,7 @@ source 'https://rubygems.org'
 group :development, :test do
   gem 'minitest'
   gem 'minitest-reporters'
-  gem 'minitest-focus'
-  gem 'minitest-spec-rails'
-  gem 'rails'
+  gem 'activerecord'
   gem 'rake'
   gem 'sqlite3'
 end

Gemfile.lock

@@ -1,32 +1,6 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.4)
-      actionpack (= 5.1.4)
-      nio4r (~> 2.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.1.4)
-      actionview (= 5.1.4)
-      activesupport (= 5.1.4)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.4)
-      activesupport (= 5.1.4)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.4)
-      activesupport (= 5.1.4)
-      globalid (>= 0.3.6)
     activemodel (5.1.4)
       activesupport (= 5.1.4)
     activerecord (5.1.4)
@@ -42,87 +16,28 @@ GEM
     arel (8.0.0)
     builder (3.2.3)
     concurrent-ruby (1.0.5)
-    crass (1.0.4)
-    erubi (1.7.0)
-    globalid (0.4.1)
-      activesupport (>= 4.2.0)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.0)
-      mini_mime (>= 0.1.1)
-    method_source (0.9.0)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
     minitest (5.10.3)
-    minitest-focus (1.1.2)
-      minitest (>= 4, < 6)
     minitest-reporters (1.1.19)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    minitest-spec-rails (5.4.0)
-      minitest (~> 5.0)
-      rails (>= 4.1)
-    nio4r (2.1.0)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.5)
-    rack-test (0.8.2)
-      rack (>= 1.0, < 3)
-    rails (5.1.4)
-      actioncable (= 5.1.4)
-      actionmailer (= 5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
-      activemodel (= 5.1.4)
-      activerecord (= 5.1.4)
-      activesupport (= 5.1.4)
-      bundler (>= 1.3.0)
-      railties (= 5.1.4)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.1.4)
-      actionpack (= 5.1.4)
-      activesupport (= 5.1.4)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
     rake (12.3.0)
     ruby-progressbar (1.9.0)
-    sprockets (3.7.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
     sqlite3 (1.3.13)
-    thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.4)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   minitest
-  minitest-focus
   minitest-reporters
-  minitest-spec-rails
-  rails
   rake
   sqlite3
 

lib/slug/slug.rb

@@ -16,19 +16,22 @@ module ClassMethods
     # 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_attribute :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[:validate_uniqueness_if]) if opts[:validate_uniqueness_if].present?
+      validates_uniqueness_of self.slug_column, uniqueness_opts
 
-      validates                 self.slug_column, :presence => :true, :message => "cannot be blank. Is #{self.slug_source} sluggable?"
-      validates                 self.slug_column, :uniqueness => :true, uniqueness_opts
-      validates                 self.slug_column, :format => :with => /\A[a-z0-9-]+\z/, :message => "contains invalid characters. Only downcase letters, numbers, and '-' are allowed."
+      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
@@ -46,6 +49,7 @@ def set_slug(opts={})
 
       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
 
@@ -85,6 +89,12 @@ def normalize_slug
       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

test/models.rb

@@ -1,6 +1,6 @@
 # Used to test slug behavior in general
 class Article < ActiveRecord::Base
-  slug :headline  
+  slug :headline
 end
 
 class Storyline < Article
@@ -23,8 +23,14 @@ class Post < ActiveRecord::Base
 # 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
+

test/schema.rb

@@ -27,4 +27,9 @@
     t.column "location", "string"
     t.column "slug", "string"
   end
+
+  create_table "generations", :force => true do |t|
+    t.column "title", "string"
+    t.column "slug", "string", null: false
+  end
 end

test/slug_test.rb

@@ -1,24 +1,24 @@
 # encoding: utf-8
+require 'test_helper'
 
-require File.dirname(__FILE__) + '/test_helper'
+describe Slug do
+  before do
+    Article.delete_all
+  end
 
-class SlugTest < ActiveSupport::TestCase
   describe 'slug' do
     it "bases slug on specified source column" do
-      Article.delete_all
       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.delete_all
       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.delete_all
         article = Article.create!(:headline => 'Test Headline')
         assert_equal 'test-headline', article.slug
       end
@@ -43,30 +43,41 @@ class SlugTest < ActiveSupport::TestCase
     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.delete_all
       article = Article.create
       assert !article.valid?
       assert article.errors[:slug]
     end
 
     it "sets validation error if normalization makes source value empty" do
-      Article.delete_all
       article = Article.create(:headline => '$$$')
       assert !article.valid?
       assert article.errors[:slug]
     end
 
-    it "doesn't update the slug even if the source column changes" do
-      Article.delete_all
-      article = Article.create!(:headline => 'Test Headline')
-      article.update_attributes!(:headline =>  'New Headline')
-      assert_equal 'test-headline', article.slug
-    end
-
     it "validates slug format on save" do
-      Article.delete_all
       article = Article.create!(:headline => 'Test Headline')
       article.slug = 'A BAD $LUG.'
 
@@ -75,7 +86,6 @@ class SlugTest < ActiveSupport::TestCase
     end
 
     it "validates uniqueness of slug by default" do
-      Article.delete_all
       Article.create!(:headline => 'Test Headline')
       article2 = Article.create!(:headline => 'Test Headline')
       article2.slug = 'test-headline'
@@ -91,17 +101,21 @@ class SlugTest < ActiveSupport::TestCase
 
       assert article2.valid?
     end
+  end
 
-    it "doesn't overwrite slug value on create if it was already specified" do
-      Article.delete_all
-      a = Article.create!(:headline => 'Test Headline', :slug => 'slug1')
-      assert_equal 'slug1', a.slug
-    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.delete_all
       @article = Article.create(:headline => 'test headline')
       @original_slug = @article.slug
     end
@@ -126,123 +140,101 @@ class SlugTest < ActiveSupport::TestCase
   end
 
   describe "slug normalization" do
-    it "lowercases strings" do
-      Article.delete_all
+    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.delete_all
-      @article = Article.new
       @article.headline = 'a b'
       @article.save!
       assert_equal 'a-b', @article.slug
     end
 
     it "replaces 2spaces with 1dash" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = 'a  b'
       @article.save!
       assert_equal 'a-b', @article.slug
     end
 
     it "removes punctuation" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = 'abc!@#$%^&*•¶§∞¢££¡¿()><?""\':;][]\.,/'
       @article.save!
       assert_match 'abc', @article.slug
     end
 
     it "strips trailing space" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = 'ab '
       @article.save!
       assert_equal 'ab', @article.slug
     end
 
     it "strips leading space" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = ' ab'
       @article.save!
       assert_equal 'ab', @article.slug
     end
 
     it "strips trailing dashes" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = 'ab-'
       @article.save!
       assert_match 'ab', @article.slug
     end
 
     it "strips leading dashes" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = '-ab'
       @article.save!
       assert_match 'ab', @article.slug
     end
 
     it "remove double-dashes" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = 'a--b--c'
       @article.save!
       assert_match 'a-b-c', @article.slug
     end
 
     it "doesn't modify valid slug strings" do
-      Article.delete_all
-      @article = Article.new
       @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.delete_all
-      @article = Article.new
       @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.delete_all
-      @article = Article.new
       @article.headline = "Thomas Jefferson's Papers"
       @article.save!
       assert_match 'thomas-jeffersons-papers', @article.slug
     end
 
     it "preserves numbers in slug" do
-      Article.delete_all
-      @article = Article.new
       @article.headline = "2010 Election"
       @article.save!
       assert_match '2010-election', @article.slug
     end
   end
 
   describe "diacritics handling" do
-    it "strips diacritics" do
-      Article.delete_all
+    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.delete_all
-      @article = Article.new
       @article.headline  = "ÀÁÂÃÄÅÆÇÈÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ"
       @article.save!
       expected = "aaaaaaaeceeeiiiidnoooooouuuuythssaaaaaaaeceeeeiiiidnoooooouuuuythy".split(//)
@@ -255,57 +247,55 @@ class SlugTest < ActiveSupport::TestCase
 
   describe "sequence handling" do
     it "doesn't add a sequence if saving first instance of slug" do
-      Article.delete_all
       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.delete_all
       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 suffux to the third instance of the slug containing numbers' do
-      Article.delete_all
       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.delete_all
       article = Article.create!(:headline => 'Test Headline')
       story = Storyline.create!(:headline => article.headline)
       assert_equal 'test-headline-1', story.slug
     end
 
     it "correctly slugs for partial matches" do
-      Article.delete_all
       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 "assigns a -12 suffix to the thirteenth instance of the slug" do
-      Article.delete_all
-      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 'assigns a -2 suffux to the third instance of the slug containing numbers' do
-      Article.delete_all
-      2.times { |i| Article.create! :headline => '11111' }
-      article_3 = Article.create! :headline => '11111'
-      assert_equal '11111-2', article_3.slug
-    end
   end
 end

test/test_helper.rb

@@ -1,16 +1,13 @@
 require 'rubygems'
+require 'minitest/autorun'
 require 'minitest/reporters'
-require 'minitest/focus'
-require 'minitest-spec-rails'
 
 # 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)]