slug 0.5.7 → 4.1.1

data/test/slug_test.rb

@@ -0,0 +1,321 @@
+# 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
+
+    it "bases to_param on slug" do
+      article = Article.create!(:headline => 'Test Headline')
+      assert_equal(article.slug, article.to_param)
+    end
+
+    it "does not impact lookup of model with no slug column" do
+      orphan = Orphan.create!(:name => 'Oliver')
+      query = orphan.to_param
+      assert_equal(orphan.id.to_s, query)
+    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,90 +1,124 @@
---- !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.1.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-17 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
+- README.md
+files:
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION.yml
 - lib/slug.rb
-- lib/slug/ascii_approximations.rb
 - lib/slug/slug.rb
 - 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/README.rdoc

@@ -1,74 +0,0 @@
-= slug
-
-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:
-
-* 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)
-
-== INSTALLATION
-
-  sudo gem install slug --source http://gemcutter.org
-
-then add
-
-  config.gem 'slug', :source => 'http://gemcutter.org'
-
-to your rails project.
-
-== USAGE
-
-It's up to you to set up the appropriate column in your model.  By default, Slug saves the slug to a column called 'slug', so in most cases you'll just want to add
-
-  t.string :slug
-
-to your create migration.
-
-I'd also suggest adding a unique index on the slug field in your migration
-
-  add_index :model_name, :slug, :unique => true
-
-Though Slug uses validates_uniqueness_of to ensue the uniqueness of your slug, two concurrent INSERTs could conceivably try to set the same slug.  Unlikely, but it's worth adding a unique index as a backstop.
-
-Once your table is migrated, just add
-
-  slug :source_field
-
-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>.
-
-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.
-
-For example:
-
-  class Article < ActiveRecord::Base
-    slug :title_for_slug
-
-    def title_for_slug
-      "#{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.
-* 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

data/VERSION.yml

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

data/lib/slug/ascii_approximations.rb

@@ -1,14 +0,0 @@
-module Slug
-  # ASCII approximations for accented characters.
-  ASCII_APPROXIMATIONS = {
-    198 => "AE",
-    208 => "D",
-    216 => "O",
-    222 => "Th",
-    223 => "ss",
-    230 => "ae",
-    240 => "d",
-    248 => "o",
-    254 => "th"
-  }.freeze
-end