dm-is-slug 1.0.1 → 1.1.0

data/Gemfile

@@ -82,6 +82,7 @@ group :runtime do # Runtime dependencies (as in the gemspec)
   end
 
   gem 'dm-core',         DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+  gem 'dm-validations',  DM_VERSION, :git => "#{DATAMAPPER}/dm-validations.git"
 
   gem 'unidecode',         '~> 1.0.0'
 

data/README.rdoc

@@ -42,9 +42,23 @@ DataMapper plugin for creating and slugs(permalinks).
     is :slug, :source => :slug_for_email, :size => 255
   end
 
+=== Scoped slugs
+
+  class Post
+    include DataMapper::Resource
+
+    property :id, Serial
+    property :title, String
+    property :content, String
+    property :category, String
+
+    # Same as above but slugs will be unique only within their category.
+    is :slug, :source => :title, :slug => :category
+  end
+
 === Finding objects by slug
 
- post = Post.first(:slug => "your_slug")
+  post = Post.first(:slug => "your_slug")
 
 == Development
 

data/Rakefile

@@ -21,6 +21,7 @@ begin
     gem.authors = ['Aaron Qian', 'James Herdman', 'Nik Radford', 'Paul', 'Mike Frawley', 'Alexander Mankuta']
 
     gem.add_dependency "dm-core", "~> 1.0.2"
+    gem.add_dependency "dm-validations", "~> 1.0.2"
     gem.add_dependency "unidecode", "~> 1.0.0"
 
     gem.add_development_dependency 'rspec', '~> 1.3'

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/dm-is-slug.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-is-slug}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian", "James Herdman", "Nik Radford", "Paul", "Mike Frawley", "Alexander Mankuta"]
-  s.date = %q{2010-10-17}
+  s.date = %q{2010-10-28}
   s.description = %q{DataMapper plugin that generates unique slugs}
   s.email = ["aq1018@gmail.com", "james.herdman@gmail.com", "nik [a] terminaldischarge [d] net", "maverick.stoklosa@gmail.com", "frawl021@gmail.com", "cheba+github@pointlessone.org"]
   s.extra_rdoc_files = [
@@ -55,15 +55,18 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<dm-core>, ["~> 1.0.2"])
+      s.add_runtime_dependency(%q<dm-validations>, ["~> 1.0.2"])
       s.add_runtime_dependency(%q<unidecode>, ["~> 1.0.0"])
       s.add_development_dependency(%q<rspec>, ["~> 1.3"])
     else
       s.add_dependency(%q<dm-core>, ["~> 1.0.2"])
+      s.add_dependency(%q<dm-validations>, ["~> 1.0.2"])
       s.add_dependency(%q<unidecode>, ["~> 1.0.0"])
       s.add_dependency(%q<rspec>, ["~> 1.3"])
     end
   else
     s.add_dependency(%q<dm-core>, ["~> 1.0.2"])
+    s.add_dependency(%q<dm-validations>, ["~> 1.0.2"])
     s.add_dependency(%q<unidecode>, ["~> 1.0.0"])
     s.add_dependency(%q<rspec>, ["~> 1.3"])
   end

data/lib/dm-is-slug/is/slug.rb

@@ -1,6 +1,7 @@
 require 'unidecode'
 require 'dm-core'
 require 'dm-core/support/chainable'
+require 'dm-validations'
 
 module DataMapper
   module Is
@@ -66,6 +67,12 @@ module DataMapper
         @slug_options[:permanent_slug] = options.delete(:permanent_slug)
         @slug_options[:permanent_slug] = true if @slug_options[:permanent_slug].nil?
 
+        if options.has_key? :scope
+          @slug_options[:scope] = [options.delete(:scope)].flatten
+        end
+
+        @slug_options[:unique] = options.delete(:unique) || false
+
         @slug_options[:source] = options.delete(:source)
         raise InvalidSlugSourceError, 'You must specify a :source to generate slug.' unless slug_source
 
@@ -74,10 +81,16 @@ module DataMapper
         if slug_property && slug_property.class >= DataMapper::Property::String
             options.merge! slug_property.options
         end
-        property :slug, String, options.merge(:unique => true)
+        property :slug, String, options
 
-        before respond_to?(:valid?) ? :valid? : :save, :generate_slug
-        before :save, :generate_slug
+        if @slug_options[:unique]
+          scope_options = @slug_options[:scope] && @slug_options[:scope].any? ?
+            {:scope => @slug_options[:scope]} : {}
+
+          validates_uniqueness_of :slug, scope_options
+        end
+
+        before :valid?, :generate_slug
       end
 
       module ClassMethods
@@ -139,8 +152,15 @@ module DataMapper
         # The slug is not stale if
         # 1. the slug is permanent, and slug column has something valid in it
         # 2. the slug source value is nil or empty
+        # 3. scope is not changed
         def stale_slug?
-          !((permanent_slug? && !slug.blank?) || slug_source_value.blank?)
+          !(
+            (permanent_slug? && !slug.blank?) ||
+            slug_source_value.blank?
+          ) ||
+          !(!new? && (dirty_attributes.keys.map(&:name) &
+                      (self.class.slug_options[:scope] || [])).compact.blank?
+          )
         end
 
         private
@@ -176,15 +196,22 @@ module DataMapper
             end
           end
 
+          scope_conditions = {}
+          if self.class.slug_options[:scope]
+            self.class.slug_options[:scope].each do |subject|
+              scope_conditions[subject] = self.__send__(subject)
+            end
+          end
+
           max_index = slugs.map do |s|
-            self.class.all(not_self_conditions.merge :slug.like => "#{s}-%")
+            self.class.all(not_self_conditions.merge(scope_conditions).merge :slug.like => "#{s}-%")
           end.flatten.map do |r|
             index = r.slug.gsub /^(#{slugs.join '|'})-/, ''
             index =~ /\d+/ ? index.to_i : nil
           end.compact.max
 
           new_index = if max_index.nil?
-            self.class.first(not_self_conditions.merge :slug => base_slug).present? ? 2 : 1
+            self.class.first(not_self_conditions.merge(scope_conditions).merge :slug => base_slug).present? ? 2 : 1
           else
             max_index + 1
           end

data/spec/integration/slug_spec.rb

@@ -41,6 +41,16 @@ describe DataMapper::Is::Slug do
       belongs_to :user
     end
 
+    class ::Task
+      include DataMapper::Resource
+      property :id, Serial
+      property :title, String
+      property :description, String
+      property :category, String
+
+      is :slug, :source => :title, :scope => :category
+    end
+
     class ::SlugKey
       include DataMapper::Resource
       property :title, String
@@ -63,6 +73,9 @@ describe DataMapper::Is::Slug do
 
     before :all do
       DataMapper.repository do
+        puts ">>> #{DataMapper.repository.adapter.inspect}"
+        DataMapper.logger.set_log STDOUT, :debug, ' ~ ', true
+        DataMapper.logger << 'boo!'
         @u1 = User.create(:email => "john@ekohe.com")
         @p1 = Post.create(:user => @u1, :title => "My first shinny blog post")
         @p2 = Post.create(:user => @u1, :title => "My second shinny blog post")
@@ -96,10 +109,10 @@ describe DataMapper::Is::Slug do
           property :id, Serial
 
           is :slug, {}
-        end        
+        end
       }.should raise_error(DataMapper::Is::Slug::InvalidSlugSourceError)
     end
-    
+
     it "should display obsolete warning if :size option is used" do
       module M
         class Thingy
@@ -222,11 +235,11 @@ describe DataMapper::Is::Slug do
     it 'should unidecode latin characters from the slug' do
       @p6.slug.should == 'a-fancy-cafe'
     end
-    
+
     it 'should unidecode chinese characters from the slug' do
       @p7.slug.should == 'ni-hao'
     end
-    
+
     it 'should have slug_property on instance' do
       @p1.slug_property.should == @p1.class.properties.detect{|p| p.name == :slug}
     end
@@ -271,5 +284,51 @@ describe DataMapper::Is::Slug do
         post.slug.should == 'the-other-post'
       end
     end
+
+    describe 'scoping' do
+      before :each do
+        Task.all.destroy!
+      end
+
+      it 'should allow duplicate slugs within different scopes' do
+        t1 = Task.create :category => 'programming', :title => 'fix'
+        t1.slug.should == 'fix'
+
+        t2 = Task.create :category => 'plumbing', :title => 'fix'
+        t2.slug.should == 'fix'
+      end
+
+      it 'should not allow dupliate slugs within same scope' do
+        t1 = Task.create :category => 'programming', :title => 'fix'
+        t1.slug.should == 'fix'
+
+        t2 = Task.create :category => 'programming', :title => 'fix'
+        t2.slug.should == 'fix-2'
+      end
+
+      it 'should recalculate slug upon change of scope' do
+        t1 = Task.create :category => 'programming', :title => 'fix'
+        t1.slug.should == 'fix'
+
+        t2 = Task.create :category => 'plumbing', :title => 'fix'
+        t2.slug.should == 'fix'
+
+        t2.category = 'programming'
+        t2.save
+        t2.slug.should == 'fix-2'
+      end
+
+      it 'should keep slug if scope did not change' do
+        t1 = Task.create :category => 'programming', :title => 'fix'
+        t1.slug.should == 'fix'
+
+        t2 = Task.create :category => 'plumbing', :title => 'fix'
+        t2.slug.should == 'fix'
+
+        t2.description = 'copper pipes are good'
+        t2.save
+        t2.slug.should == 'fix'
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: dm-is-slug
 version: !ruby/object:Gem::Version 
-  hash: 21
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Aaron Qian
@@ -20,7 +19,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-17 00:00:00 -07:00
+date: 2010-10-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,7 +30,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 1
         - 0
@@ -40,36 +38,49 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: unidecode
+  name: dm-validations
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: unidecode
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 1
         - 3
         version: "1.3"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: DataMapper plugin that generates unique slugs
 email: 
 - aq1018@gmail.com
@@ -121,7 +132,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -130,7 +140,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"