objectreload-permalinks 0.1.1 → 0.2.1

data/Rakefile

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 require 'rubygems'
 require 'rake'
 
@@ -8,7 +10,9 @@ begin
     gem.summary = "Simple way to create permalinks."
     gem.email = "gems@objectreload.com"
     gem.homepage = "http://github.com/objectreload/permalinks"
-    gem.authors = ["Mateusz Drozdzynski", "Ewa Limanowka"]
+    gem.authors = ["Mateusz Drożdżyński", "Ewa Limanówka", "Jakub Kuźma"]
+    gem.add_dependency "activesupport", ">=2.0"
+    gem.add_development_dependency "test-unit", ">=2.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.1

data/init.rb

@@ -1,2 +1,5 @@
-# Include hook code here
-require File.dirname(__FILE__) + '/lib/permalinks'
+require File.join(File.dirname(__FILE__), "lib", "permalinks")
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend(Permalinks::HasPermalink)
+end

data/lib/permalinks.rb

@@ -1,15 +1,45 @@
+require "iconv"
+require "singleton"
+
+require "active_support/core_ext/object/misc"
+
+require "permalinks/configuration"
+require "permalinks/has_permalink"
+
 module Permalinks
-  def self.included(base)
-    base.extend ClassMethods
-  end
-  
-  module ClassMethods
-    def has_permalink(field = :name)
-      define_method(:to_param) do
-        "#{id}-#{send(field).to_s.strip.downcase.gsub(/[^[:alnum:]]/,'-')}".gsub(/-{2,}/, '-')
+  class << self
+    def to_param(*args)
+      returning(args * "-") do |result|
+        replace_using_table!(result, configuration.substitutions)
+        transliterate!(result, configuration.input_encoding)
+        result.downcase!
+        replace_non_alnum!(result)
+        remove_double_dashes!(result)
+        remove_trailing_dashes!(result)
       end
     end
+
+    private
+
+    def replace_using_table!(str, table)
+      table.each { |from, to| str.gsub!(from, to) }
+    end
+
+    def transliterate!(str, encoding)
+      result = Iconv.iconv("ASCII//TRANSLIT", encoding.to_s, str).first
+      str.replace(result)
+    end
+
+    def replace_non_alnum!(str)
+      str.gsub!(/[^a-z0-9]/, "-")
+    end
+
+    def remove_double_dashes!(str)
+      str.gsub!(/-+/, "-")
+    end
+
+    def remove_trailing_dashes!(str)
+      str.gsub!(/-+\Z/, "")
+    end
   end
 end
-
-ActiveRecord::Base.send(:include, Permalinks)

data/lib/permalinks/configuration.rb

@@ -0,0 +1,19 @@
+module Permalinks
+  class Configuration
+    include Singleton
+
+    attr_writer :substitutions, :input_encoding
+
+    def substitutions
+      @substitutions ||= {}
+    end
+
+    def input_encoding
+      @input_encoding ||= "UTF-8"
+    end
+  end
+
+  def self.configuration
+    returning(Configuration.instance) { |c| yield(c) if block_given? }
+  end
+end

data/lib/permalinks/has_permalink.rb

@@ -0,0 +1,7 @@
+module Permalinks
+  module HasPermalink
+    def has_permalink(field = :name)
+      define_method(:to_param) { Permalinks.to_param(id, send(field)) }
+    end
+  end
+end

data/objectreload-permalinks.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{objectreload-permalinks}
-  s.version = "0.1.1"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Mateusz Drozdzynski", "Ewa Limanowka"]
-  s.date = %q{2009-10-20}
+  s.authors = ["Mateusz Drożdżyński", "Ewa Limanówka", "Jakub Kuźma"]
+  s.date = %q{2010-02-15}
   s.email = %q{gems@objectreload.com}
   s.extra_rdoc_files = [
     "README"
@@ -20,12 +20,13 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "init.rb",
-     "install.rb",
      "lib/permalinks.rb",
+     "lib/permalinks/configuration.rb",
+     "lib/permalinks/has_permalink.rb",
      "objectreload-permalinks.gemspec",
-     "test/permalinks_test.rb",
-     "test/test_helper.rb",
-     "uninstall.rb"
+     "test/country_test.rb",
+     "test/post_test.rb",
+     "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/objectreload/permalinks}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -33,7 +34,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple way to create permalinks.}
   s.test_files = [
-    "test/permalinks_test.rb",
+    "test/country_test.rb",
+     "test/post_test.rb",
      "test/test_helper.rb"
   ]
 
@@ -42,9 +44,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0"])
+      s.add_development_dependency(%q<test-unit>, [">= 2.0"])
     else
+      s.add_dependency(%q<activesupport>, [">= 2.0"])
+      s.add_dependency(%q<test-unit>, [">= 2.0"])
     end
   else
+    s.add_dependency(%q<activesupport>, [">= 2.0"])
+    s.add_dependency(%q<test-unit>, [">= 2.0"])
   end
 end
 

data/test/country_test.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+
+require "test_helper"
+
+class Country
+  extend Permalinks::HasPermalink
+  attr_accessor :name, :id
+  has_permalink
+end
+
+class CountryTest < Test::Unit::TestCase
+  def setup
+    @country = Country.new
+    @country.name = "United Kingdom"
+    @country.id = 1
+  end
+
+  test "country with regular name" do
+    assert_equal "#{@country.id}-united-kingdom", @country.to_param
+  end
+
+  test "country name with a lot of white spaces" do
+    @country.name = "United    Kingdom   "
+    assert_equal "#{@country.id}-united-kingdom", @country.to_param
+  end
+
+  test "country with id equal nil" do
+    @country.name = "2-tratata"
+    @country.id = nil
+    assert_equal "#{@country.id}-2-tratata", @country.to_param
+  end
+
+  test "country name with capital letters" do
+    @country.name = " USA "
+    assert_equal "#{@country.id}-usa", @country.to_param
+  end
+
+  if RUBY_VERSION >= "1.9" # FIXME: iconv doesn't work properly on 1.8.x
+    test "country name in polish" do
+      @country.name = "Wybrzeże Kości Słoniowej"
+      assert_equal "#{@country.id}-wybrzeze-kosci-sloniowej", @country.to_param
+    end
+
+    test "country name in german without custom substitutions" do
+      Permalinks.configuration { |config| config.substitutions = {} }
+      @country.name = "Türkei"
+      assert_equal "#{@country.id}-turkei", @country.to_param
+    end
+  end
+
+  test "country name in german with custom substitutions" do
+    Permalinks.configuration do |config|
+      config.substitutions = {
+        "ä" => "ae",
+        "Ä" => "AE",
+        "ö" => "oe",
+        "Ö" => "OE",
+        "ü" => "ue",
+        "Ü" => "UE"
+      }
+    end
+
+    @country.name = "Türkei"
+    assert_equal "#{@country.id}-tuerkei", @country.to_param
+  end
+end

data/test/post_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+class Post
+  extend Permalinks::HasPermalink
+  attr_accessor :title, :id
+  has_permalink :title
+end
+
+class PostTest < Test::Unit::TestCase
+  def setup
+    @post = Post.new
+    @post.title = "Something cool"
+    @post.id = 1
+  end
+
+  test "regular post title" do
+    assert_equal "#{@post.id}-something-cool", @post.to_param
+  end
+
+  test "post title with a lot of white spaces" do
+    @post.title = " Snow is     cold   "
+    assert_equal "#{@post.id}-snow-is-cold", @post.to_param
+  end
+
+  test "post title with capital letters" do
+    @post.title = " SOMETHING i really like to DO   is sleeping "
+    assert_equal "#{@post.id}-something-i-really-like-to-do-is-sleeping", @post.to_param
+  end
+end

data/test/test_helper.rb

@@ -1,29 +1,6 @@
-require 'rubygems'
-require 'activerecord'
-require File.dirname(__FILE__)+'/../lib/permalinks'
-require 'shoulda'
-require 'logger'
+require "rubygems"
 
-ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
-ActiveRecord::Base.establish_connection('sqlite3')
+gem "test-unit" # for 1.8 compatibility
+require "test/unit"
 
-ActiveRecord::Base.logger = Logger.new(STDERR)
-ActiveRecord::Base.logger.level = Logger::WARN
-
-ActiveRecord::Schema.define(:version => 0) do
-  create_table :countries do |t|
-    t.string  :name, :default => ''
-  end
-
-  create_table :posts do |t|
-    t.string  :title, :default => ''
-  end
-end
-
-class Country < ActiveRecord::Base
-  has_permalink
-end
-
-class Post < ActiveRecord::Base
-  has_permalink :title
-end
+require File.join(File.dirname(__FILE__), "..", "lib", "permalinks")

metadata

@@ -1,19 +1,39 @@
 --- !ruby/object:Gem::Specification 
 name: objectreload-permalinks
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
-- Mateusz Drozdzynski
-- Ewa Limanowka
+- "Mateusz Dro\xC5\xBCd\xC5\xBCy\xC5\x84ski"
+- "Ewa Liman\xC3\xB3wka"
+- "Jakub Ku\xC5\xBAma"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-20 00:00:00 +01:00
+date: 2010-02-15 00:00:00 +00:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
 description: 
 email: gems@objectreload.com
 executables: []
@@ -28,12 +48,13 @@ files:
 - Rakefile
 - VERSION
 - init.rb
-- install.rb
 - lib/permalinks.rb
+- lib/permalinks/configuration.rb
+- lib/permalinks/has_permalink.rb
 - objectreload-permalinks.gemspec
-- test/permalinks_test.rb
+- test/country_test.rb
+- test/post_test.rb
 - test/test_helper.rb
-- uninstall.rb
 has_rdoc: true
 homepage: http://github.com/objectreload/permalinks
 licenses: []
@@ -63,5 +84,6 @@ signing_key:
 specification_version: 3
 summary: Simple way to create permalinks.
 test_files: 
-- test/permalinks_test.rb
+- test/country_test.rb
+- test/post_test.rb
 - test/test_helper.rb

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/test/permalinks_test.rb

@@ -1,74 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class CountryTest < Test::Unit::TestCase
-  context "Country model" do
-    setup do
-      @country = Country.new :name => "United Kingdom"
-      @country.save!
-    end
-    subject { @country }
-
-    context "regular country name" do
-      should "return permalink" do
-        assert_equal "#{@country.id}-united-kingdom", @country.to_param
-      end
-    end
-
-    context "country name with a lot of white spaces" do
-      should "return permalink" do
-        @country.name = "United    Kingdom   "
-        @country.save!
-        assert_equal "#{@country.id}-united-kingdom", @country.to_param
-      end
-    end
-
-    context "country with id equal nil" do
-      should "return permalink" do
-        @country.name = "2-tratata"
-        @country.id = nil
-        @country.save!
-        assert_equal "#{@country.id}-2-tratata", @country.to_param
-      end
-    end
-
-    context "country name with capital letters" do
-      should "return permalink" do
-        @country.name = " USA "
-        @country.save!
-        assert_equal "#{@country.id}-usa", @country.to_param
-      end
-    end
-  end
-end
-
-class PostTest < Test::Unit::TestCase
-  context "Post model" do
-    setup do
-      @post = Post.new :title => "Something cool"
-      @post.save!
-    end
-    subject { @post }
-
-    context "regular post title" do
-      should "return permalink" do
-        assert_equal "#{@post.id}-something-cool", @post.to_param
-      end
-    end
-
-    context "post title with a lot of white spaces" do
-      should "return permalink" do
-        @post.title = " Snow is     cold   "
-        @post.save!
-        assert_equal "#{@post.id}-snow-is-cold", @post.to_param
-      end
-    end
-
-    context "post title with capital letters" do
-      should "return permalink" do
-        @post.title = " SOMETHING i really like to DO   is sleeping "
-        @post.save!
-        assert_equal "#{@post.id}-something-i-really-like-to-do-is-sleeping", @post.to_param
-      end
-    end
-  end
-end

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here