schnecke 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2e509bff01283a06b873a93ce83938d8b1330534f661d5fe13dc8235f764da7
-  data.tar.gz: d2fb750754fa8959baca1ff1236a9ecb83b9e908ca749d3fa25b94b8cc2dab17
+  metadata.gz: 144b6900260d2c6d5d9f293cee58c0ceb25ec663ff00c77bf1d2d72f9d79fc78
+  data.tar.gz: 6332f95d24fcc612fd1be9147f2e816c55a9484c4ac2582e9be21691902272e9
 SHA512:
-  metadata.gz: 9f8280a41d8289520a8a2f99a2fed9c0713c075805d134b16e66b02dbb53121d070f2acf3d7458744d1bf4517eaf5c2eacaf8d880ba73ad0167e3334ef82d2d3
-  data.tar.gz: 8f526df3095aa6e092eb95aee7c52258824ce4dccd8c312ff20660a14cfe1d60251f528b80a0b3ce8c22238f4f96222a525605cf81f899b69338fd50abe87f4b
+  metadata.gz: 906f07f820ffe12443424f5c0e1427a5b942537911a6026f6b9644b3acdd40a817227642f86b7d01123bac0beeaed31eebf522b6e7442206cf3b16c6e4b0444e
+  data.tar.gz: 61f35e4e5322dd7a7fc967c093697150e56d1d2c17b8f15890bf262ffdeec9306ebb7790748e06691b082ec9ac006bd163a427b4e963363fa0affbbdb8ff2e9b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schnecke (0.1.0)
+    schnecke (0.2.0)
       activerecord (> 4.2.0)
       activesupport (> 4.2.0)
 

data/README.md

@@ -53,6 +53,25 @@ end
 
 The above will place the generated slug in `some_other_column`.
 
+### Setting the maximum length of a slug
+
+By default the maxium length of a slug is 32 characters *NOT INCLUDING* any potential sequence numbers added to make it unique (see the "Handling non-unique slugs" section). You can either change the maximum or remove it entirely as follows
+
+
+```ruby
+class A
+  include Schnecke
+  slug :name, limit_length: 15
+end
+```
+
+```ruby
+class A
+  include Schnecke
+  slug :name, limit_length: false
+end
+```
+
 ### Slug Uniquness
 
 By default slugs are unique to the object that defines the slug. For example if we have the 2 objects, `A` and `B` as defined as below, then the slugs will be unique for all slugs for all type `A` objcets and all type `B` objects. 
@@ -75,6 +94,8 @@ This means that the slug `foo` can exists 2 times; once for any object of type `
 
 If a duplicate slug is to be created, a number is automatically appended to the end of the slug. For example, if there is a slug `foo`, the second one would become `foo-2`, the third `foo-3`, and so forth.
 
+It is important to note that the maximum length of a slug does not include the addition of the sequence identifier at the end. By default the maximum length of a slug is 32 characters, but if a sequence number is added, it will be 34 characters when we append the `-2`, `-3`, etc. This was done on purpose so that the base slug always remains constant and does not get truncated.
+
 ### Defining a custom uniqueness scope
 
 There are times when we want slugs not be unique for all objects of type `A`, but rather for a smaller scope. For example, let's say we have a system with multiple `Accounts`, each containing `Record`s. If we want the slug for the `Record` to be unique only within the scope of an `account` we can do by providing the uniqueness scope when setting up the slug.
@@ -82,7 +103,7 @@ There are times when we want slugs not be unique for all objects of type `A`, bu
 ```ruby
 class Record
   include Schnecke
-  slug :name, uniqueness: { scope: :account}
+  slug :name, uniqueness: { scope: :account }
 
   belongs_to :account
 end
@@ -93,7 +114,7 @@ When we do this, this will let us have the same slug 'foo' for multiple `record`
 ```ruby
 class Tag
   include Schnecke
-  slug :name, uniqueness: { scope: [:account, :record]}
+  slug :name, uniqueness: { scope: [:account, :record] }
 
   belongs_to :account
   belongs_to :record

data/lib/schnecke/schnecke.rb

@@ -10,9 +10,11 @@ module Schnecke
 
   DEFAULT_SLUG_COLUMN = :slug
   DEFAULT_SLUG_SEPARATOR = '-'
+  DEFAULT_MAX_LENGTH = 32
   DEFAULT_REQUIRED_FORMAT = /\A[a-z0-9\-_]+\z/
 
   class_methods do
+    # rubocop:disable Metrics/AbcSize
     def slug(source, opts = {})
       class_attribute :schnecke_config
 
@@ -21,6 +23,7 @@ module Schnecke
         slug_source: source,
         slug_column: opts.fetch(:column, DEFAULT_SLUG_COLUMN),
         slug_separator: opts.fetch(:separator, DEFAULT_SLUG_SEPARATOR),
+        limit_length: opts.fetch(:limit_length, DEFAULT_MAX_LENGTH),
         required: opts.fetch(:required, true),
         generate_on_blank: opts.fetch(:generate_on_blank, true),
         require_format: opts.fetch(:require_format, DEFAULT_REQUIRED_FORMAT),
@@ -50,6 +53,7 @@ module Schnecke
       include InstanceMethods
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
   # Instance methods to include
   module InstanceMethods
@@ -74,6 +78,9 @@ module Schnecke
         candidate_slug = slugify_blank
       end
 
+      # Make sure it is not too long
+      candidate_slug = truncate(candidate_slug)
+
       # If there is a duplicate, create a unique one
       if slug_exists?(candidate_slug)
         candidate_slug = slugify_duplicate(candidate_slug)
@@ -178,6 +185,13 @@ module Schnecke
       parts.join(schnecke_config[:slug_separator])
     end
 
+    def truncate(slug)
+      return if slug.blank?
+      return if schnecke_config[:limit_length].blank?
+
+      slug[0, schnecke_config[:limit_length]]
+    end
+
     def slug_exists?(slug)
       slug_scope.exists?(schnecke_config[:slug_column] => slug)
     end

data/lib/schnecke/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schnecke
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schnecke
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick R. Schmid