slugged 0.3.3 → 0.4.0

data/README.md

@@ -65,6 +65,7 @@ is\_sluggable accepts the source method name as a symbol, and an optional has of
 * _:slug\_column_ - the column in which to store the slug. Defaults to _:cached\_slug_
 * _:to\_param_ - if true (by default), overrides to_param to use the slug
 * _:use\_cache_ - uses Slugged.cache if available to cache any lookups e.g. in memcache.
+* _:editable_ - if true (false is the default), allow the users to edit _cached\_slug_ column.
 
 Once installed, it provides the following methods:
 

data/lib/slugged/active_record_methods.rb

@@ -1,6 +1,6 @@
 module Slugged
   module ActiveRecordMethods
-    AR_CLASS_ATTRIBUTE_NAMES = %w(cached_slug_column slug_source slug_convertor_proc default_uuid_slug use_slug_history sync_slugs slug_scope use_slug_cache use_slug_to_param).map(&:to_sym)
+    AR_CLASS_ATTRIBUTE_NAMES = %w(cached_slug_column slug_source slug_convertor_proc default_uuid_slug use_slug_history sync_slugs slug_scope use_slug_cache use_slug_to_param editable).map(&:to_sym)
     
     def is_sluggable(source = :name, options = {})
       options.symbolize_keys!
@@ -25,10 +25,9 @@ module Slugged
         cached_value = send cached_slug_column
         cached_value.present? ? cached_value : id.to_s
       end
-      
+
       def generate_slug
-        slug_value = send(self.slug_source)
-        slug_value = self.slug_convertor_proc.call(slug_value) if slug_value.present?
+        slug_value = self.class.slug_value_for(send(self.slug_source))
         if slug_value.present?
           scope = self.class.other_than(self).slug_scope_relation(self)
           slug_value = Slugged.next_value(scope, slug_value)
@@ -39,6 +38,10 @@ module Slugged
           write_attribute self.cached_slug_column, nil
         end
       end
+
+      def convert_cached_slug
+        write_attribute self.cached_slug_column, self.class.slug_value_for(send(self.cached_slug_column))
+      end
       
       def generate_slug!
         generate_slug
@@ -46,11 +49,19 @@ module Slugged
       end
       
       def autogenerate_slug
-        generate_slug if should_generate_slug?
+        if should_convert_cached_slug?
+          convert_cached_slug
+        else
+          generate_slug if should_generate_slug?
+        end
       end
-      
+
+      def should_convert_cached_slug?
+        send(:"#{self.cached_slug_column}_changed?") && !send(self.cached_slug_column).blank? && self.editable?
+      end
+
       def should_generate_slug?
-        send(self.cached_slug_column).blank? || (self.sync_slugs && send(:"#{self.slug_source}_changed?"))
+        send(self.cached_slug_column).blank? || (self.sync_slugs && send(:"#{self.slug_source}_changed?")) && !should_convert_cached_slug?
       end
       
       def has_better_slug?
@@ -77,6 +88,10 @@ module Slugged
         has_slug_scope? ? where(slug_scope => record.send(slug_scope)) : scoped
       end
       
+      def slug_value_for(value)
+        value.present? ? self.slug_convertor_proc.call(value) : value
+      end
+
       protected
       
       def has_slug_scope?
@@ -92,6 +107,7 @@ module Slugged
         self.use_slug_cache     = !!options.fetch(:use_cache, true)
         self.use_slug_to_param  = !!options.fetch(:to_param, true)
         self.use_slug_history   = !!options.fetch(:history, Slugged::Slug.usable?)
+        self.editable           = !!options.fetch(:editable, false)
       end
       
       def set_slug_convertor(convertor)
@@ -107,7 +123,6 @@ module Slugged
           end
         end
       end
-      
     end    
   end
 end

data/lib/slugged/version.rb

@@ -1,8 +1,8 @@
 module Slugged
   module Version
     MAJOR  = 0
-    MINOR  = 3
-    PATCH  = 3
+    MINOR  = 4
+    PATCH  = 0
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end
 end

data/slugged.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{slugged}
-  s.version = "0.3.3"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Darcy Laycock"]
-  s.date = %q{2010-12-30}
+  s.date = %q{2011-01-01}
   s.description = %q{Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history}
   s.email = %q{sutto@sutto.net}
   s.extra_rdoc_files = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
      "metrics/.gitignore",
      "slugged.gemspec",
      "test/caching_test.rb",
+     "test/editable_test.rb",
      "test/helper.rb",
      "test/is_sluggable_test.rb",
      "test/model_definitions.rb",
@@ -55,6 +56,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history}
   s.test_files = [
     "test/caching_test.rb",
+     "test/editable_test.rb",
      "test/helper.rb",
      "test/is_sluggable_test.rb",
      "test/model_definitions.rb",

data/test/editable_test.rb

@@ -0,0 +1,51 @@
+require 'helper'
+require 'digest/md5'
+
+class EditableTest < Test::Unit::TestCase
+  with_tables :slugs, :users do
+    context 'with the editable option' do
+
+      setup { setup_slugs! :editable => true }
+
+      should 'correctly sluggify a value when cached_slug is blank on create' do
+        user = User.create(:name => "Bob")
+        assert_equal "bob", user.cached_slug
+      end
+
+      should 'not sluggify a value when cached_slug is not blank on create' do
+        user = User.create(:name => "Bob", :cached_slug => "Mob")
+        assert_equal "mob", user.cached_slug
+      end
+
+      should 'sluggify a value when cached_slug is not changed && name is changed on update' do
+        user = User.create(:name => "Bob")
+        user.update_attributes(:name => "Noob")
+        assert_equal "noob", user.cached_slug
+      end
+
+      should 'not sluggify a value when cached_slug is changed && name is changed on update' do
+        user = User.create(:name => "Bob")
+        user.update_attributes(:name => "Rob", :cached_slug => "noob")
+        assert_equal "noob", user.cached_slug
+      end
+
+      should 'sluggify a value when cached_slug set blank on update' do
+        user = User.create(:name => "Bob")
+        assert_equal "bob", user.cached_slug
+        user.update_attributes(:cached_slug => '')
+        assert_equal "bob", user.cached_slug
+      end
+
+      should 'sluggify a value when cached_slug set blank && name changed on update' do
+        user = User.create(:name => "Bob")
+        user.update_attributes(:name => "Rob", :cached_slug => '')
+        assert_equal "rob", user.cached_slug
+      end
+
+      should 'parameterize a value of a cached_slug' do
+        user = User.create(:name => "Bob", :cached_slug => "f**ck")
+        assert_equal user.cached_slug, User.slug_value_for("f**ck")
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slugged
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 +08:00
+date: 2011-01-01 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,6 +127,7 @@ files:
 - metrics/.gitignore
 - slugged.gemspec
 - test/caching_test.rb
+- test/editable_test.rb
 - test/helper.rb
 - test/is_sluggable_test.rb
 - test/model_definitions.rb
@@ -168,6 +169,7 @@ specification_version: 3
 summary: Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history
 test_files: 
 - test/caching_test.rb
+- test/editable_test.rb
 - test/helper.rb
 - test/is_sluggable_test.rb
 - test/model_definitions.rb