slug 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b26d7fca3befe175649b0bdbe3b1e145e775ea77191fbe023f017d907cdfd64c
-  data.tar.gz: '06786f698b25c0e2d061ca77cbafa382e774bb96ded86a7b246c858909e8a1b5'
+  metadata.gz: 5d86b48722b18d45cf288be1a320bff1550270cd61a0ab2c03dba7cbb67ab9ef
+  data.tar.gz: 1ffb50fcca8eb72cbedb0f002104ce472fc35abf6aaf9635229605b14cb88580
 SHA512:
-  metadata.gz: 248ca7e65bc8ccc47a9cec02c3843f4c1871aa743078627677078c4a52dbde1666226002033c0d5e4a107b27fdb32feb1f51c3d877c815bdb455cdf8dbe87bbf
-  data.tar.gz: dfab8ccf8d2daf51720cbc7ecfb44b9fb3ad5862f85e5e7a44b236170cbb1ac7caeaff52434764d80ed5f62bd0d11b2e104699a1011fe5ca3349e63db868cc16
+  metadata.gz: 49a6637967aae4804dfe30f1829bbd7cd3dd2d9075337e053d93a23489af88b894275f63787596243b01905eb27b90c7ca0a88ffe60146c780a7eead7aedd451
+  data.tar.gz: 3693e899c785498624a302f92c3bedc6a9432c236c98f3eee924d9aba63c108191b3ab0decb44d1852ecb4093e34c187a5584d5bd082cc9125086c3fec51af8d

data/README.md

@@ -0,0 +1,123 @@
+# slug
+
+Slug provides simple, straightforward slugging for your ActiveRecord models.
+
+Slug is based on code from Norman Clarke's fantastic [friendly_id](https://github.com/norman/friendly_id) project and Nick Zadrozny's [friendly_identifier](http://code.google.com/p/friendly-identifier/).
+
+What's different:
+
+  * Unlike friendly_id's more advanced modes, 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.
+  * The number of options is manageable.
+
+## Installation
+
+Add the gem to your Gemfile
+
+```
+gem 'slug'
+```
+
+of your rails project.
+
+This is tested with Rails 5.1.4, MRI Ruby 2.4.1
+
+## Usage
+
+### Creating the database column
+
+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
+
+```ruby
+add_column :my_table, :slug, :string
+```
+
+in a migration.  You should also add a unque index on the slug field in your migration
+
+```ruby
+add_index :model_name, :slug, unique: true
+```
+
+Though Slug uses `validates_uniqueness_of` to ensue the uniqueness of your slug, two concurrent INSERTs could try to set the same slug.
+
+### Model setup
+
+Once your table is migrated, just add
+
+```ruby
+slug :source_field
+```
+
+to your ActiveRecord model.  `:source_field` is the column you'd like to base the slug on.  For example, it might be `:headline`.
+
+#### Using an instance method as the 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.
+
+For example:
+
+```ruby
+class Article < ActiveRecord::Base
+  slug :title_for_slug
+
+  def title_for_slug
+    "#{headline}-#{publication_date.year}-#{publication_date.month}"
+  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.  `find_by_slug` and named scopes will work as they do for any other column.
+
+### Options
+
+There are two options:
+
+#### Column
+
+If you want to save the slug in a database column that isn't called
+`slug`, just pass the `:column` option. For example:
+
+```
+slug :headline, column: :web_slug
+```
+
+would generate a slug based on `headline` and save it to `web_slug`.
+
+#### Generic Default
+
+If the source column is empty, blank, or only contains filtered
+characters, you can avoid `ActiveRecord::ValidationError` exceptions
+by setting `generic_default: true`. For example:
+
+```ruby
+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. To avoid this, use the `:generic_default` option.
+  * Slug doesn't update the slug if the source column changes.  If you really need to regenerate the slug, call `@model.set_slug` 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.
+
+## Authors
+
+Ben Koski, ben.koski@gmail.com
+
+With generous contributions from:
+ * [Derek Willis](http://thescoop.org/)
+ * [Douglas Lovell](https://github.com/wbreeze)
+ * [Paul Battley](https://github.com/threedaymonk)
+ * [Yura Omelchuk](https://github.com/jurgens)
+ * others listed in the
+[GitHub contributor list](https://github.com/bkoski/slug/graphs/contributors).

data/lib/slug.rb

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

data/lib/slug/slug.rb

@@ -1,5 +1,9 @@
+require 'active_support/concern'
+
 module Slug
-  module ClassMethods
+  extend ActiveSupport::Concern
+
+  class_methods do
 
     # Call this to set up slug handling on an ActiveRecord model.
     #
@@ -17,7 +21,6 @@ module 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, :generic_default
-      include InstanceMethods
 
       self.slug_source = source
       self.slug_column = opts.fetch(:column, :slug)
@@ -36,100 +39,60 @@ module Slug
     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
-      return unless self[self.slug_column].blank? || opts[:force] == true
-
-      original_slug = self[self.slug_column]
-      self[self.slug_column] = self.send(self.slug_source)
-
-      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
+  # 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]
 
-    # Overwrite existing slug based on current contents of source column.
-    def reset_slug
-      set_slug(:force => true)
-    end
+    self[self.slug_column] = normalize_slug(self.send(self.slug_source))
 
-    # Overrides to_param to return the model's slug.
-    def to_param
-      self[self.slug_column]
+    # 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
 
-    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.
-    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
+    assign_slug_sequence if self.changed_attributes.include?(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
-      return if self[self.slug_column].blank?
-      s = ActiveSupport::Multibyte.proxy_class.new(self[self.slug_column]).normalize(:kc)
-      s.downcase!
-      s.strip!
-      s.gsub!(/[^a-z0-9\s-]/, '') # Remove non-word characters
-      s.gsub!(/\s+/, '-')     # Convert whitespaces to dashes
-      s.gsub!(/-\z/, '')      # Remove trailing dashes
-      s.gsub!(/-+/, '-')      # get rid of double-dashes
-      self[self.slug_column] = s.to_s
-    end
+  # Overwrite existing slug based on current contents of source column.
+  def reset_slug
+    set_slug(:force => true)
+  end
 
-    def genericize_slug
-      if self[self.slug_column].blank?
-        self[self.slug_column] = self.class.to_s.demodulize.underscore.dasherize
-      end
-    end
+  # Overrides to_param to return the model's slug.
+  def to_param
+    self[self.slug_column]
+  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
-      return if self[self.slug_column].blank?
-      s = ActiveSupport::Multibyte.proxy_class.new(self[self.slug_column])
-      s = s.normalize(:kd).unpack('U*')
-      s = s.inject([]) do |a,u|
-        if Slug::ASCII_APPROXIMATIONS[u]
-          a += Slug::ASCII_APPROXIMATIONS[u].unpack('U*')
-        elsif (u < 0x300 || u > 0x036F)
-          a << u
-        end
-        a
-      end
-      s = s.pack('U*')
-      self[self.slug_column] = s.to_s
-    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
 
-    # 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?
-      self[self.slug_column] = next_slug_sequence
-    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
 
-    # Returns the next unique index for a slug.
-    def next_slug_sequence
-      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
+  # 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

data/slug.gemspec

@@ -3,25 +3,23 @@
 
 Gem::Specification.new do |s|
   s.name = "slug"
-  s.version = "4.0.1"
+  s.version = "4.1.0"
 
   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 = "2018-11-11"
+  s.date = "2018-11-17"
   s.description = "Simple, straightforward slugs for your ActiveRecord models."
   s.email = "ben.koski@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.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",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slug
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Ben Koski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,14 +86,12 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- 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

data/README.rdoc

@@ -1,104 +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/].
-
-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.
-* The number of options is manageable
-
-== INSTALLATION
-
-Add the gem to your Gemfile
-
-  gem 'slug'
-
-of your rails project.
-
-This is tested with Rails 5.1.4, MRI Ruby 2.4.1
-
-== 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>.
-
-=== 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.
-
-For example:
-
-  class Article < ActiveRecord::Base
-    slug :title_for_slug
-
-    def title_for_slug
-      "#{headline}-#{publication_date.year}-#{publication_date.month}"
-    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.
-
-== 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
-
-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/VERSION.yml

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

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