speaking_id 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,10 +1,22 @@
 = SpeakingId
 
-Creates simple and secure slugs from a given string or random slugs to hide a model ID.
+Lightweight Ruby on Rails gem to handle slugs for Active Record objects.
 
 == Installation
 
-You can set it up as a gem in your environment.rb file.
+=== Rails 3
+
+Add the gem to your project's Gemfile as follows:
+
+  gem 'speaking_id'
+
+Then install the gem by running:
+
+  bundle install
+
+=== Rails 2
+
+In Rails 2 you can set it up in your environment.rb file.
 
   config.gem "speaking_id"
 
@@ -20,33 +32,33 @@ Alternatively you can install it as a Rails plugin.
 
 In your models:
 
-	class User < ActiveRecord::Base
-		has_slug :name
-	end
-	
-	class Project < ActiveRecord::Base
-		has_random_slug
-	end
+  class User < ActiveRecord::Base
+    has_slug :name
+  end
+  
+  class Project < ActiveRecord::Base
+    has_random_slug
+  end
 
 In your migrations:
 
-	class AddSpeakingIdToUserAndProject < ActiveRecord::Migration
-		def self.up
-			add_column :users, 		:slug, :string
-			add_column :project, 	:slug, :string
-			
-			add_index :users,		:slug, :unique => true
-			add_index :project, :slug, :unique => true
-		end
-		
-		def	self.down
-			remove_column :users, 	:slug
-			remove_column :project, :slug
-		end
-	end
+  class AddSpeakingIdToUserAndProject < ActiveRecord::Migration
+    def self.up
+      add_column :users,    :slug, :string
+      add_column :project,  :slug, :string
+  		
+      add_index :users,   :slug, :unique => true
+      add_index :project, :slug, :unique => true
+    end
+  	
+    def	self.down
+      remove_column :users,   :slug
+      remove_column :project, :slug
+    end
+  end
 
 By default, SpeakingId uses a column called "slug". If you want to use a different column name, just pass the +:column+ option:
 
-	has_slug :title, :column => :column_name
+  has_slug :title, :column => :column_name
 
 This works also with the +has_random_slug+ method.

data/Rakefile

@@ -1,11 +1,10 @@
-require 'rake'
 require 'rake/testtask'
 
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the speaking_id plugin.'
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
 end
-
-task :default => :test

data/lib/speaking_id/ascii_approximations.rb

@@ -0,0 +1,30 @@
+module SpeakingId
+  ASCII_APPROXIMATIONS = {
+    196 => [65,  101], # Ä => Ae
+    214 => [79,  101], # Ö => Oe
+    220 => [85,  101], # Ü => Ue
+    223 => [115, 115], # ß => ss
+    228 => [97,  101], # ä => ae
+    246 => [111, 101], # ö => oe
+    252 => [117, 101]  # ü => ue
+  }.freeze
+
+  class << self
+    def replace_known_special_chars(chars)
+      chars = ActiveSupport::Multibyte.proxy_class.new(chars)
+      chars = chars.normalize(:kc).unpack('U*')
+
+      chars = chars.inject([]) do |result, char|
+        result << approximate_char(char)
+      end.flatten.pack('U*')
+    end
+
+    def approximate_char(char)
+      if ASCII_APPROXIMATIONS.include? char
+        return ASCII_APPROXIMATIONS[char]
+      end
+      char
+    end
+  end
+end
+

data/lib/speaking_id/core_extensions.rb

@@ -0,0 +1,24 @@
+String.class_eval do
+  # Replaces known special characters and removes unknown characters in a string
+  # so that it may be used as part of a 'pretty' URL.
+  def normalize(sep = '-')
+    return if self.blank?
+
+    s = SpeakingId::replace_known_special_chars(self)
+
+    # Remove anything non-ASCII entirely.
+    s = s.gsub(/[^\x00-\x7F]+/, '')
+
+    # Remove non-word characters.
+    s = s.gsub(/[^\w_ \-]+/i, '')
+
+    # Convert whitespaces to separator.
+    s = s.gsub(/[ \-]+/i, sep)
+
+    # Remove leading/trailing separators.
+    s = s.gsub(/^(\_|\-)|(\_|\-)$/i, '')
+
+    s.downcase
+  end
+end
+

data/lib/speaking_id/speaking_id.rb

@@ -1,31 +1,48 @@
 module SpeakingId
-  module ClassMethods
-    def has_slug source, args = {}
-      include InstanceMethods
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module  ClassMethods
+    def has_slug(source, options = {})
+      speaking_id(options)
+
+      class_inheritable_accessor :slug_source
 
-      class_inheritable_accessor :slug_source, :slug_column
-      
       self.slug_source = source
-      self.slug_column = args.has_key?(:column) ? args[:column] : :slug
 
       before_save :create_slug
     end
 
-    def has_random_slug args = {}
-      include InstanceMethods
+    def has_random_slug(options = {})
+      speaking_id(options)
+
+      before_create :create_random_slug
+    end
+
+    def speaking_id(options = {})
+      send :include, InstanceMethods
 
       class_inheritable_accessor :slug_column
-      
-      self.slug_column = args.has_key?(:column) ? args[:column] : :slug
 
-      before_save :create_random_slug
+      self.slug_column = (options[:column] || :slug).to_s
+
+      validates_uniqueness_of self.slug_column
     end
+
+    send :protected, :speaking_id
   end
 
   module InstanceMethods
     def create_slug
+      # Only creates a slug when the Active Record object is unsaved or got changed.
+      return unless self.instance_eval("#{self.slug_source}_changed?")
+
       begin
-        self[self.slug_column] = self[self.slug_source].to_s.parameterize("_")
+        # Normalizes the slug source column or creates a random slug when blank.
+        self[self.slug_column] = self[self.slug_source].normalize
+        return create_random_slug if self[self.slug_column].blank?
+        
         self[self.slug_column] << ((counter ||= 1) == 1 ? nil : counter).to_s
         counter += 1
       end while slug_taken?
@@ -43,12 +60,18 @@ module SpeakingId
 
     private
 
-    def create_random_token limit = 6
+    def create_random_token(limit = 3)
       ActiveSupport::SecureRandom.hex(limit).upcase
     end
-    
+
     def slug_taken?
-      self.class.first :conditions => {self.slug_column.to_sym => self[self.slug_column]}
+      if Rails::VERSION::MAJOR == 2
+        self.class.first :conditions => {self.slug_column.to_sym => self[self.slug_column]}
+      else
+        self.class.where(self.slug_column => self[self.slug_column]).first
+      end
     end
   end
-end
+end
+
+ActiveRecord::Base.send :include, SpeakingId

data/lib/speaking_id.rb

@@ -1,5 +1,4 @@
-require File.dirname(__FILE__) + '/speaking_id/speaking_id'
+require 'speaking_id/ascii_approximations'
+require 'speaking_id/core_extensions'
+require 'speaking_id/speaking_id'
 
-if defined?(ActiveRecord)
-  ActiveRecord::Base.instance_eval {extend SpeakingId::ClassMethods}
-end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'speaking_id'

data/test/core_extensions_test.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+require 'test_helper'
+
+class SpeakingIdTest < ActiveSupport::TestCase
+  test 'should normalize a simple string' do
+    assert_equal 'the-sandals', 'The Sandals'.normalize
+  end
+
+  test 'should normalize special characters' do
+    assert_equal 'oeaeue-oeaeue-ss', '  ÖÄÜ öäü ß %@: .&? ---'.normalize
+  end
+
+  test 'should normalize a string using underscores as separator' do
+    assert_equal 'a_b_c', 'A B C ...'.normalize('_')
+  end
+
+  test 'should normalize and return an empty string' do
+    assert ' &?=... '.normalize.empty?
+  end
+end
+

data/test/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :articles, :force => true do |t|
+    t.string :title
+    t.string :slug
+    t.text :text
+    t.timestamps
+  end
+
+  create_table :users, :force => true do |t|
+    t.string :email
+    t.string :random_slug
+    t.timestamps
+  end
+end
+

data/test/speaking_id_test.rb

@@ -1,8 +1,54 @@
+# encoding: UTF-8
+
 require 'test_helper'
 
+class Article < ActiveRecord::Base
+  has_slug :title
+end
+
+class User < ActiveRecord::Base
+  has_random_slug :column => :random_slug
+end
+
 class SpeakingIdTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
+  load_schema
+  
+  def setup
+    @article = Article.find_or_create_by_title('The Sandals')
   end
-end
+
+  test 'should not change the slug' do
+    assert_equal 'the-sandals', @article.slug
+    @article.text = 'The Sandals make great music.'
+    @article.save
+    assert_equal 'the-sandals', @article.slug
+  end
+  
+  test 'should change the slug' do
+    assert_equal 'the-sandals', @article.slug
+    @article.title = 'Nico & Rushad'
+    @article.save
+    assert_equal 'nico-rushad', @article.slug
+  end
+  
+  test 'should increase the slug' do
+    article = Article.create(:title => 'The Sandals')
+    assert_equal 'the-sandals2', article.slug
+  end
+  
+  test 'should increase the slug another time' do
+    article = Article.create(:title => 'The Sandals')
+    assert_equal 'the-sandals3', article.slug
+  end
+  
+  test 'should generate a random slug' do
+    @article.title = ''
+    @article.save
+    assert_equal 6, @article.slug.length
+  end
+
+  test 'should create an user with a random slug' do
+    user = User.create(:email => 'test@example.com')
+    assert_equal 6, user.random_slug.length
+  end
+end

data/test/test_helper.rb

@@ -1,3 +1,19 @@
 require 'rubygems'
+require 'test/unit'
 require 'active_support'
-require 'active_support/test_case'
+require 'active_record'
+require 'sqlite3'
+
+RAILS_ROOT = File.dirname(__FILE__) + '/../../../..'
+require File.expand_path(File.join(RAILS_ROOT, 'config/environment.rb'))
+
+def load_schema
+  ActiveRecord::Base.establish_connection({
+    'adapter' => 'sqlite3',
+    'database' => File.dirname(__FILE__) + '/speaking_id.sqlite3'
+  })
+
+  load(File.dirname(__FILE__) + '/schema.rb')
+  require File.dirname(__FILE__) + '/../rails/init.rb'
+end
+

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: speaking_id
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Martin Jagusch
@@ -9,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-15 00:00:00 +01:00
+date: 2010-04-06 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Creates simple and secure slugs from a given string or random slugs to hide a model ID.
+description: Creates simple and secure slugs from a given string or random slugs.
 email: m@venlix.net
 executables: []
 
@@ -21,18 +26,20 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- CHANGELOG.rdoc
 - LICENSE
 files: 
-- lib/speaking_id/speaking_id.rb
 - lib/speaking_id.rb
+- lib/speaking_id/speaking_id.rb
+- lib/speaking_id/ascii_approximations.rb
+- lib/speaking_id/core_extensions.rb
+- rails/init.rb
 - test/speaking_id_test.rb
+- test/core_extensions_test.rb
+- test/schema.rb
 - test/test_helper.rb
 - LICENSE
 - README.rdoc
 - Rakefile
-- CHANGELOG.rdoc
-- init.rb
 has_rdoc: true
 homepage: http://github.com/venlix/speaking_id
 licenses: []
@@ -52,20 +59,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Simple slugs for ActiveRecord models.
+summary: Lightweight Ruby on Rails gem to handle slugs for Active Record objects.
 test_files: []
 

data/CHANGELOG.rdoc

@@ -1,3 +0,0 @@
-0.1.0 (Jan 15, 2010)
-
-* initial release

data/init.rb

@@ -1 +0,0 @@
-require 'speaking_id'