i76-has_slug 0.1.5 → 0.1.6

data/lib/has_slug.rb

@@ -14,10 +14,10 @@ module HasSlug
   module ClassMethods 
 
     # Valid options for the has_slug method
-    VALID_HAS_SLUG_OPTIONS = [:scope, :slug_column].freeze
+    VALID_HAS_SLUG_OPTIONS = [:scope, :slug_column, :preserve].freeze
     
     # Default options for the has_slug method
-    DEFAULT_HAS_SLUG_OPTIONS = { :scope => nil, :slug_column => 'slug' }.freeze
+    DEFAULT_HAS_SLUG_OPTIONS = { :scope => nil, :slug_column => 'slug', :preserve => '' }.freeze
 
     # Set up an ActiveRecord model to use a slug.
     #

data/lib/has_slug/not_sluggable_instance_methods.rb

@@ -15,7 +15,7 @@ module HasSlug::NotSluggableInstanceMethods
   
   def slug
     id   = self.send(self.class.primary_key)
-    slug = self.sluggable.to_slug
+    slug = self.sluggable.to_slug(:preserve => has_slug_options[:preserve])
     
     "#{id}-#{slug}"
   end

data/lib/has_slug/slug.rb

@@ -1,37 +1,37 @@
 class String
   # convert strings to slugs that are lowercase an only contain alphanumeric
   # characters, dashes and sometimes dots
-  def to_slug
+  def to_slug(options = {})
     slug = self
     
+    preserve    = options.delete(:preserve).to_s.split
+    acceptable  = preserve + ["-", "_"]
+    
     # Transliterate
     slug = Unicode.normalize_KD(slug).gsub(/[^\x00-\x7F]/n,'')
 
     # Convert to lowercase
     slug.downcase!
     
-    # Change seperators (like spaces) to dashes
-    slug.gsub!(/[+_',\/|;; ]/, '-')
+    # Change all characters that are not to be preserved to dashes
+    slug.gsub!(Regexp.new("[^a-z0-9#{Regexp.escape(preserve.join)}]"), '-')
   
-    # Dot's should be saved only when they have letter or number on both sides
-    # (this preserves file extensions)
-    slug.gsub!(/[^\w\d]\.+/, '-')
-    slug.gsub!(/\.+[^\w\d]/, '-')    
-    
-    # Replace everything that is not letter, number, dash or dot with a dash
-    slug.gsub!(/[^\w\d.-]/, '-')
-    
-    # Strip dots from begining and end
-    slug.gsub!(/^\.+/, '')
-    slug.gsub!(/\.+$/, '')
+    # Preservable chars should be saved only when they have letter or number on 
+    # both sides (this preserves file extensions in case of :preserve => '.')
+    preserve.each do |char|      
+      slug.gsub!(Regexp.new("([^a-z0-9])#{Regexp.escape(char)}+"), '\\1-')
+      slug.gsub!(Regexp.new("#{Regexp.escape(char)}+([^a-z0-9])"), '-\\1')
+      slug.gsub!(Regexp.new("^#{Regexp.escape(char)}+"), '')
+      slug.gsub!(Regexp.new("#{Regexp.escape(char)}+$"), '')
+    end
     
     # Strip dashes from begining and end
     slug.gsub!(/^-(.+)+/, '\1')
     slug.gsub!(/(.+)-+$/, '\1')
 
-    # Change multiple succesive dashes to single dashe.
+    # Change multiple succesive dashes to single dash.
     slug.gsub!(/-+/, '-')
     
     slug
   end
-end
+end

data/lib/has_slug/sluggable_instance_methods.rb

@@ -40,12 +40,12 @@ module HasSlug::SluggableInstanceMethods
   private
   
   def set_slug
-    self.slug = self.sluggable.to_slug
+    self.slug = self.sluggable.to_slug(:preserve => has_slug_options[:preserve])
     
     while existing = self.class.find_one_with_same_slug(self)
       index ||= 2
       
-      self.slug = "#{self.sluggable.to_slug}_#{index}"
+      self.slug = "#{self.sluggable.to_slug(:preserve => has_slug_options[:preserve])}_#{index}"
       
       index += 1
     end

data/test/models/restaurant.rb

@@ -1,6 +1,7 @@
 class Restaurant < ActiveRecord::Base
   has_slug :name,
-           :scope => :city
+           :scope => :city,
+           :preserve => '.'
   
   belongs_to :city
   

data/test/test_helper.rb

@@ -9,13 +9,15 @@ HAS_SLUG_ROOT = File.dirname(__FILE__) + "/.."
 $:.unshift("#{HAS_SLUG_ROOT}/lib")
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
-                                        :dbfile  => ":memory:")
+                                        :dbfile  => "#{HAS_SLUG_ROOT}/test/test.db")
 require 'has_slug'
 require "#{HAS_SLUG_ROOT}/test/schema.rb"
 
 Dir["#{HAS_SLUG_ROOT}/test/models/*"].each { |f| require f }
 Dir["#{HAS_SLUG_ROOT}/test/factories/*"].each { |f| require f }
 
+[City, Restaurant, Kitchen].each { |c| c.reset_column_information }
+
 class Test::Unit::TestCase
   def reset_database!
     City.destroy_all

data/test/unit/has_slug_test.rb

@@ -80,6 +80,16 @@ class HasSlugTest < Test::Unit::TestCase
         end
       end
       
+      context 'and characters to preserve' do
+        setup do
+          @restaurant_2_0 = Factory(:restaurant, :name => 'Restaurant 2.0')
+        end
+        
+        should 'preserve the .' do
+          assert_equal 'restaurant-2.0', @restaurant_2_0.slug
+        end
+      end
+      
       context 'and a scope' do
         setup do
           @da_marco = Factory(:restaurant, :name => 'Da Marco',
@@ -95,7 +105,8 @@ class HasSlugTest < Test::Unit::TestCase
         
         should 'not create duplicate slugs' do
           @da_marco_2 = Factory(:restaurant, :name => 'Da Marco',
-                                             :city => @new_york)          
+                                             :city => @new_york)
+         
           assert_not_equal @da_marco_2.slug, @da_marco.slug
           
           @da_marco_2.update_attributes(:city => @san_fransisco)          

data/test/unit/slug_test.rb

@@ -20,12 +20,18 @@ class SlugTest < Test::Unit::TestCase
       assert_equal 'internationalization', "Iñtërnâtiônàlizâtiôn".to_slug 
     end
     
-    should 'preserve dots that have numbers or letters on both sides' do
-      assert_equal 'filename.1',   "filename.1".to_slug
-      assert_equal 'filename.txt', "filename.txt".to_slug
+    should 'preserve specified characters if they have numbers or letters on both sides' do
+      assert_equal 'filename-1',   "filename.1".to_slug
+      assert_equal 'filename.1',   "filename.1".to_slug(:preserve => '.')
+
+      assert_equal 'filename-txt', "filename.txt".to_slug
+      assert_equal 'filename.txt', "filename.txt".to_slug(:preserve => '.')
       
       assert_equal 'a-sentence', "A sentence.".to_slug
+      assert_equal 'a-sentence', "A sentence.".to_slug(:preserve => '.')
+      
       assert_equal 'a-sentence-a-new-sentence', "A sentence. A new sentence.".to_slug
+      assert_equal 'a-sentence-a-new-sentence', "A sentence. A new sentence.".to_slug(:preserve => '.')
     end
     
     should 'not have trailing dashes' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: i76-has_slug
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Tom-Eric Gerritsen
@@ -14,6 +14,7 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: unicode
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -43,6 +44,7 @@ files:
 - tasks/has_slug_tasks.rake
 has_rdoc: true
 homepage: http://www.i76.nl/
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: A slugging plugin for Ruby on Rails