slugworth 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 580a1a33372ba7781fca6dae4df6e8ac523e8dfd
-  data.tar.gz: 4d8c73c9c421d5ae254bc5759e4617554e582f03
+  metadata.gz: a77159f292434b785943b273df3105db32acb74c
+  data.tar.gz: 9b5ba418ef641c443d65812907b537ea54c5b11b
 SHA512:
-  metadata.gz: f24f96d281279619fcbd20cb8ef0509c4f38477f0b4c1ca8c9ce3616e63ab3d049c6158f2a01e11b35ca2dd5381ac507fd3d9492bb97ed6fdc4e451316dc2483
-  data.tar.gz: a844d24078f0684af671ba5941ce92173d3bbd4bafae7b54db25178f18cb50fa933f60416bcca06f37b8d290201b9f6322226fa1e8b2b7e2d124f7690e6ddd19
+  metadata.gz: 75f31bc79dc40409230b3350c377ff04f90430d21ec0b0161300a8c3816408f65b715cae1b6d499629a51bfa6a70c9b1f673af7ac4aec2afd91a133cfaa8573d
+  data.tar.gz: bbd860dbb13e3f4abe7a9584d19616334ead8a062226041633536e2090eefdfa4e71fe2161779a7ce3f63d537df0997d16128816d314575088dfccdf125fb28e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.0
+
+- Uniqueness scoping for a slug
+- Auto incrementing of slug
+- Slugs can be monitored for updates
+
 ## 1.1.0
 
 - `#find_by_slug` has been changed to `#find_by_slug` to keep in line with AR

data/README.md

@@ -49,6 +49,52 @@ This provides most of the default slug functionality you would need.
 * `#to_param` has been defined as a paramaterized version of the attribute declared to `slugged_with`.
 * Validations stating that `slug` is present and unique in the database.
 
+### Scoping uniqueness
+
+By default the slug is unique to the entire table, but you can specify the scope of the uniqueness as the following:
+
+```ruby
+class Product < ActiveRecord::Base
+  include Slugworth
+  belongs_to :user
+  slugged_with :name, scope: :user_id
+end
+```
+
+### Updating slugs
+
+Sometimes you want to update the slug if the attribute is changed.
+
+```ruby
+class User < ActiveRecord::Base
+  include Slugworth
+  slugged_with :name, updatable: true
+end
+
+user = User.create(name: 'Jack')
+=> User(id: 1, name: 'Jack', slug: 'jack')
+
+user.update_attribute(:name, 'John')
+=> User(id: 1, name: 'John', slug: 'john')
+```
+
+### Incremental slugs
+
+If another record already exists with the same slug it will generate an uniqueness validation error, but if incremental slugs is enabled, then it will append an incremented number to the slug:
+
+```ruby
+class User < ActiveRecord::Base
+  include Slugworth
+  slugged_with :name, incremental: true
+end
+
+User.create(name: 'Jack')
+=> User(id: 1, name: 'Jack', slug: 'jack')
+
+User.create(name: 'Jack')
+=> User(id: 2, name: 'Jack', slug: 'jack-1')
+```
+
 ## Test Helper
 
 To aid in testing your models that implement the Slugworth functionality, I've added a shared example group that can be added to your test suite. Add this to your `spec_helper.rb`

data/lib/slugworth.rb

@@ -4,14 +4,17 @@ module Slugworth
   extend ActiveSupport::Concern
 
   included do
-    cattr_accessor :slug_attribute
+    cattr_accessor :slug_attribute, :slug_scope, :slug_incremental, :slug_updatable
     before_validation(:add_slug)
-    validates_uniqueness_of :slug
   end
 
   module ClassMethods
-    def slugged_with(slug_attribute)
+    def slugged_with(slug_attribute, opts={})
       self.slug_attribute = slug_attribute
+      self.slug_scope = opts.delete(:scope)
+      self.slug_incremental = opts.delete(:incremental)
+      self.slug_updatable = opts.delete(:updatable)
+      validates_uniqueness_of :slug, scope: slug_scope
     end
 
     def find_by_slug!(slug)
@@ -27,10 +30,41 @@ module Slugworth
 
   private
   def add_slug
-    self.slug = processed_slug unless slug.present?
+    self.slug = processed_slug if generate_slug?
+  end
+
+  def generate_slug?
+    !slug.present? || slug_updatable && changes[slug_attribute].present?
   end
 
   def processed_slug
+    slug_incremental ?  process_incremental_slug : parameterized_slug
+  end
+
+  def parameterized_slug
     public_send(slug_attribute).parameterize
   end
+
+  def process_incremental_slug
+    slugs = matching_slugs
+    if slugs.include?(parameterized_slug)
+      (1..slugs.size).each do |i|
+        incremented_slug = "#{parameterized_slug}-#{i}"
+        return incremented_slug unless slugs.include?(incremented_slug)
+      end
+    else
+      parameterized_slug
+    end
+  end
+
+  def matching_slugs
+    table = self.class.arel_table
+    primary_key = self.class.primary_key
+    query = table[:slug].matches("#{parameterized_slug}%")
+    query = query.and(table[primary_key].not_eq(read_attribute(primary_key))) unless new_record?
+    Array.wrap(slug_scope).each do |scope|
+      query = query.and(table[scope].eq(read_attribute(scope)))
+    end
+    self.class.where(query).pluck(:slug)
+  end
 end

data/lib/slugworth/version.rb

@@ -1,3 +1,3 @@
 module Slugworth
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

data/lib/slugworth_shared_examples.rb

@@ -61,3 +61,134 @@ shared_examples_for :has_slug_functionality do
     end
   end
 end
+
+shared_examples_for :has_updatable_slug_functionality do
+  describe "#slug :updatable" do
+    let!(:existing) { described_class.create(described_class.slug_attribute => 'Name') }
+    context "when attribute is changed" do
+      specify "updates the slug" do
+        existing[described_class.slug_attribute] = 'New Name'
+        expect(existing).to be_valid
+        expect(existing.slug).to eq('new-name')
+      end
+    end
+    context "when attribute is not changed" do
+      specify "does not update the slug" do
+        expect(existing).to be_valid
+        expect(existing.slug).to eq('name')
+      end
+    end
+  end
+end
+
+shared_examples_for :has_incremental_slug_functionality do
+  describe "#slug :incremental" do
+    context "when slug is already taken" do
+      before do
+        existing = described_class.new(slug: 'taken-slug')
+        existing.save(validate: false)
+      end
+
+      specify "increments the slug" do
+        obj = described_class.new(described_class.slug_attribute => 'Taken Slug')
+        expect(obj).to be_valid
+        expect(obj.slug).to eq('taken-slug-1')
+      end
+    end
+    context "when incremented slug is already taken" do
+      before do
+        existing = described_class.new(slug: 'taken-slug')
+        existing.save(validate: false)
+        existing = described_class.new(slug: 'taken-slug-1')
+        existing.save(validate: false)
+      end
+
+      specify "increments the slug" do
+        obj = described_class.new(described_class.slug_attribute => 'Taken Slug')
+        expect(obj).to be_valid
+        expect(obj.slug).to eq('taken-slug-2')
+      end
+    end
+    context "when existing slug is reset" do
+      let!(:existing) { described_class.create(described_class.slug_attribute => 'New Name') }
+
+      specify "does not increment the slug" do
+        existing.slug = nil
+        expect(existing).to be_valid
+        expect(existing.slug).to eq('new-name')
+      end
+    end
+  end
+end
+
+shared_examples_for :has_scoped_slug_functionality do
+  describe "#slug :scope" do
+    context "when slug is already taken on same scope" do
+      before do
+        existing = described_class.new(slug: 'taken-slug', described_class.slug_scope => 1)
+        existing.save(validate: false)
+      end
+
+      specify "object is not valid" do
+        obj = described_class.new(slug: 'taken-slug', described_class.slug_scope => 1)
+        expect(obj).to_not be_valid
+        expect(obj.errors[:slug]).to_not be_empty
+      end
+    end
+
+    context "when slug is already taken on another scope" do
+      before do
+        existing = described_class.new(slug: 'taken-slug', described_class.slug_scope => 1)
+        existing.save(validate: false)
+      end
+
+      specify "object is valid" do
+        obj = described_class.new(slug: 'taken-slug', described_class.slug_scope => 2)
+        expect(obj).to be_valid
+      end
+    end
+  end
+end
+
+shared_examples_for :has_incremental_scoped_slug_functionality do
+  describe "#slug :incremental" do
+    context "when slug is already taken" do
+      before do
+        existing = described_class.new(slug: 'taken-slug', described_class.slug_scope => 1)
+        existing.save(validate: false)
+      end
+
+      specify "increments the slug" do
+        obj = described_class.new(described_class.slug_attribute => 'Taken Slug', described_class.slug_scope => 1)
+        expect(obj).to be_valid
+        expect(obj.slug).to eq('taken-slug-1')
+      end
+    end
+    context "when incremented slug is already taken" do
+      before do
+        existing = described_class.new(slug: 'taken-slug', described_class.slug_scope => 1)
+        existing.save(validate: false)
+        existing = described_class.new(slug: 'taken-slug-1', described_class.slug_scope => 1)
+        existing.save(validate: false)
+      end
+
+      specify "increments the slug" do
+        obj = described_class.new(described_class.slug_attribute => 'Taken Slug', described_class.slug_scope => 1)
+        expect(obj).to be_valid
+        expect(obj.slug).to eq('taken-slug-2')
+      end
+    end
+    context "when slug is already taken in another scope" do
+      before do
+        existing = described_class.new(slug: 'taken-slug', described_class.slug_scope => 1)
+        existing.save(validate: false)
+      end
+
+      specify "does not increment the slug" do
+        obj = described_class.new(described_class.slug_attribute => 'Taken Slug', described_class.slug_scope => 2)
+        expect(obj).to be_valid
+        expect(obj.slug).to eq('taken-slug')
+      end
+    end
+  end
+end

data/spec/sluggle_spec.rb

@@ -3,7 +3,7 @@ require 'slugworth_shared_examples'
 require 'slugworth'
 
 ActiveRecord::Base.connection.execute(
-  %{CREATE TABLE users (id INTEGER PRIMARY KEY, name STRING, slug STRING);}
+  %{CREATE TABLE users (id INTEGER PRIMARY KEY, name STRING, slug STRING, age INTEGER);}
 )
 
 class User < ActiveRecord::Base
@@ -14,3 +14,43 @@ end
 describe User do
   it_behaves_like :has_slug_functionality
 end
+
+class IncrementalUser < ActiveRecord::Base
+  self.table_name = 'users'
+  include Slugworth
+  slugged_with :name, incremental: true
+end
+
+describe IncrementalUser do
+  it_behaves_like :has_incremental_slug_functionality
+end
+
+class UpdatableUser < ActiveRecord::Base
+  self.table_name = 'users'
+  include Slugworth
+  slugged_with :name, updatable: true
+end
+
+describe UpdatableUser do
+  it_behaves_like :has_updatable_slug_functionality
+end
+
+class ScopedUser < ActiveRecord::Base
+  self.table_name = 'users'
+  include Slugworth
+  slugged_with :name, scope: :age
+end
+
+describe ScopedUser do
+  it_behaves_like :has_scoped_slug_functionality
+end
+
+class IncrementalScopedUser < ActiveRecord::Base
+  self.table_name = 'users'
+  include Slugworth
+  slugged_with :name, scope: :age, incremental: true
+end
+
+describe IncrementalScopedUser do
+  it_behaves_like :has_incremental_scoped_slug_functionality
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: slugworth
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matt Polito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   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: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !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'
 description: Easy slug functionality
@@ -115,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -137,17 +137,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy slug functionality