slug 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d86b48722b18d45cf288be1a320bff1550270cd61a0ab2c03dba7cbb67ab9ef
-  data.tar.gz: 1ffb50fcca8eb72cbedb0f002104ce472fc35abf6aaf9635229605b14cb88580
+  metadata.gz: 65d6b738a1e306b5803f1b92e8328ed20632eb0d7706eb2417a198bd1acf8bfc
+  data.tar.gz: b1833f858513babd75d2f94ef776831fab3cc2e105ed9df33bf2912c9d7feb5c
 SHA512:
-  metadata.gz: 49a6637967aae4804dfe30f1829bbd7cd3dd2d9075337e053d93a23489af88b894275f63787596243b01905eb27b90c7ca0a88ffe60146c780a7eead7aedd451
-  data.tar.gz: 3693e899c785498624a302f92c3bedc6a9432c236c98f3eee924d9aba63c108191b3ab0decb44d1852ecb4093e34c187a5584d5bd082cc9125086c3fec51af8d
+  metadata.gz: 9b46a5b3226a1b4adbdf027fe9c7692d2a33431a5aa0b67ef99edd6297974008789407eee80cd614b8d65a5bfdcbadd6c2112c554e7d79e7198571ccee967a52
+  data.tar.gz: d9e07b0b4b55810ab4eaff7f828755bf0bdf0d5e6744cc8ba866e50e96642db707ee459d0c8b31288ef9978cf82677a386163a646e7eff570662587395996b02

data/README.md

@@ -110,6 +110,10 @@ slug and move on.
   * 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.
 
+## Development
+
+`rake test` will run the included unit tests.
+
 ## Authors
 
 Ben Koski, ben.koski@gmail.com

data/lib/slug/slug.rb

@@ -36,63 +36,66 @@ module Slug
         with: /\A[a-z0-9-]+\z/,
         message: "contains invalid characters. Only downcase letters, numbers, and '-' are allowed."
       before_validation :set_slug, :on => :create
+
+      include SlugInstanceMethods
     end
   end
 
-  # 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
-    return if self[self.slug_column].present? && !opts[:force]
+  module SlugInstanceMethods
+    # 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
+      return if self[self.slug_column].present? && !opts[:force]
 
-    self[self.slug_column] = normalize_slug(self.send(self.slug_source))
+      self[self.slug_column] = normalize_slug(self.send(self.slug_source))
 
-    # if normalize_slug returned a blank string, try the generic_default handling
-    if generic_default && self[self.slug_column].blank?
-      self[self.slug_column] = self.class.to_s.demodulize.underscore.dasherize
-    end
+      # if normalize_slug returned a blank string, try the generic_default handling
+      if generic_default && self[self.slug_column].blank?
+        self[self.slug_column] = self.class.to_s.demodulize.underscore.dasherize
+      end
 
-    assign_slug_sequence if self.changed_attributes.include?(self.slug_column)
-  end
+      assign_slug_sequence if self.changed_attributes.include?(self.slug_column)
+    end
 
-  # Overwrite existing slug based on current contents of source column.
-  def reset_slug
-    set_slug(:force => true)
-  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
+    # Overrides to_param to return the model's slug.
+    def to_param
+      self[self.slug_column]
+    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.
-  def validate_slug_columns
-    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
+    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.
+    def validate_slug_columns
+      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(str)
-    return if str.blank?
-    str.gsub!(/[\p{Pc}\p{Ps}\p{Pe}\p{Pi}\p{Pf}\p{Po}]/, '') # Remove punctuation
-    str.parameterize
-  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(str)
+      return if str.blank?
+      str.gsub!(/[\p{Pc}\p{Ps}\p{Pe}\p{Pi}\p{Pf}\p{Po}]/, '') # Remove punctuation
+      str.parameterize
+    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?
-    assoc = self.class.base_class
-    base_slug = self[self.slug_column]
-    seq = 0
-
-    while assoc.where(self.slug_column => self[self.slug_column]).exists? do
-      seq += 1
-      self[self.slug_column] = "#{base_slug}-#{seq}"
+    # 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?
+      assoc = self.class.base_class
+      base_slug = self[self.slug_column]
+      seq = 0
+
+      while assoc.where(self.slug_column => self[self.slug_column]).exists? do
+        seq += 1
+        self[self.slug_column] = "#{base_slug}-#{seq}"
+      end
     end
   end
-
-end
+end

data/slug.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name = "slug"
-  s.version = "4.1.0"
+  s.version = "4.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

data/test/models.rb

@@ -34,3 +34,6 @@ class Generation < ActiveRecord::Base
   slug :title, generic_default: true
 end
 
+# Test model with no slug column
+class Orphan < ActiveRecord::Base
+end

data/test/schema.rb

@@ -32,4 +32,10 @@ ActiveRecord::Schema.define(:version => 1) do
     t.column "title", "string"
     t.column "slug", "string", null: false
   end
+
+  # table with no slug column
+  create_table "orphans", :force => true do |t|
+    t.column "name", "string"
+    t.column "location", "string"
+  end
 end

data/test/slug_test.rb

@@ -17,6 +17,17 @@ describe Slug do
       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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slug
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Ben Koski