chinese_permalink 1.0.0

data/.autotest

@@ -0,0 +1,8 @@
+global_autotest_file = File.expand_path('~/.autotest')
+load(global_autotest_file) if File.exists?(global_autotest_file)
+ 
+class Autotest
+  def test_files_for(filename)
+    Dir['test/**/*_test.rb']
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,101 @@
+h1. ChinesePermalink
+
+This plugin adds a capability for ar model to create a seo permalink with your chinese text. It will translate your chinese text to english url based on google translate.
+
+The permalink will be composed of id and the english value translated from chinese text.
+
+For exmpale, title of post is '我是中国人', permalink of post is '1-i-am-a-chinese'
+
+***************************************************************************
+
+h2. Install
+
+* install dependency gem sishen-rtranslate:
+
+<pre><code>sudo gem install sishen-rtranslate --source http://gems.github.com</code></pre>
+
+* install chinese_permalink plugin
+
+<pre><code>script/plugin install git://github.com/flyerhzm/chinese_permalink.git</code></pre>
+
+***************************************************************************
+
+h2. Example
+
+* Define chinese_permalink to model
+
+<pre><code>
+class Post < ActiveRecord::Base
+  # create permalink by chinese title, default permalink column is "permalink"
+  chinese_permalink :title
+end
+</code></pre>
+
+Or
+
+<pre><code>
+class Post < ActiveRecord::Base
+  # create permalink by chinese category and title
+  chinese_permalink [:category, :title]
+end
+</code></pre>
+
+Or
+
+<pre><code>
+class Post < ActiveRecord::Base
+  # create permalink by chinese title, store permalink to column "slug_url"
+  chinese_permalink :title, :permalink_field => :slug_url
+end
+</code></pre>
+
+
+* Generate migration
+
+<pre><code>ruby script/generate chinese_permalink_migration (migration name) (table name) (permalink column name)</code></pre>
+
+For example:
+
+<pre><code>ruby script/generate chinese_permalink_migration add_permalink_to_posts posts</code></pre>
+
+Or
+
+<pre><code>ruby script/generate chinese_permalink_migration add_permalink_to_posts posts slug_url</code></pre>
+
+
+3. Define ar to_param method
+
+<pre><code>
+class Post < ActiveRecord::Base
+  def to_param
+    permalink
+  end
+end
+</code></pre>
+
+**************************************************************************
+
+h2. Advance
+
+You can add before_methods and after_methods to meet your business, for example:
+
+<pre><code>
+class Post < ActiveRecord::Base
+  chinese_permalink :title, :before_methods => :parse_c_sharp
+
+  def parse_c_sharp(permalink)
+    permalink.gsub('C#', 'c-sharp')
+  end
+end
+
+class Post < ActiveRecord::Base
+  chinese_permalink :title, :after_methods => :parse_pg
+
+  def parse_pg(permalink)
+    permalink.gsub('Procter &amp; Gamble', 'pg')
+  end
+end
+</code></pre>
+
+
+Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'jeweler'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the chinese_permalink plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the chinese_permalink plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChinesePermalink'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "chinese_permalink"
+  gemspec.summary = "This plugin adds a capability for AR model to create a seo permalink with your chinese text."
+  gemspec.description = "This plugin adds a capability for AR model to create a seo permalink with your chinese text. It will translate your chinese text to english url based on google translate."
+  gemspec.email = "flyerhzm@gmail.com"
+  gemspec.homepage = "http://github.com/flyerhzm/chinese_permalink"
+  gemspec.authors = ["Richard Huang"]
+  gemspec.add_dependency 'sishen-rtranslate'
+  gemspec.files.exclude '.gitignore'
+  gemspec.files.exclude 'log/*'
+end
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/generators/chinese_permalink_migration/chinese_permalink_migration_generator.rb

@@ -0,0 +1,21 @@
+# user this migration generator
+# ruby script/generate chinese_permalink_migartion (migration name) (table name) [permalink column name]
+# for example:
+# ruby script/generate chinese_permalink_migration add_permalink_to_posts posts
+# ruby script/generate chiense_permalink_migration add_permalink_to_posts posts slug_url
+class ChinesePermalinkMigrationGenerator < Rails::Generator::NamedBase
+  attr_reader :permalink_table_name
+  attr_reader :permalink_field_name
+
+  def initialize(runtime_args, runtime_options = {})
+    @permalink_table_name = runtime_args[1]
+    @permalink_field_name = runtime_args[2] || 'permalink'
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+end

data/generators/chinese_permalink_migration/templates/migration.rb

@@ -0,0 +1,15 @@
+class Add<%= permalink_field_name.capitalize %>To<%= permalink_table_name.capitalize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= permalink_table_name %>, :<%= permalink_field_name %>, :string, :default => nil
+
+    <%= permalink_table_name.classify %>.reset_column_information
+    <%= permalink_table_name.classify %>.all.each do |obj|
+      obj.<%= permalink_field_name %> = nil
+      obj.save
+    end
+  end
+
+  def self.down
+    remove_column :<%= permalink_table_name %>, :<%= permalink_field_name %>
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send :include, ChinesePermalink

data/lib/chinese_permalink.rb

@@ -0,0 +1,76 @@
+begin
+  # rtranslate is a gem that can translate text based on google translate
+  require 'rtranslate'
+rescue Object
+  puts "no rtranslate, you might want to look into it."
+end
+
+module ChinesePermalink
+
+  def self.included(base)
+    base.extend ClassMethods
+    class <<base
+      attr_accessor :permalink_attrs
+      attr_accessor :permalink_field
+      attr_accessor :before_methods
+      attr_accessor :after_methods
+    end
+  end 
+
+  private 
+  def create_permalink
+    if self.permalink.nil?
+      chinese_permalink = self.class.permalink_attrs.collect do |attr_name|
+        chinese_value = self.send(attr_name)
+      end * '-'
+      self.class.before_methods.each do |method|
+        chinese_permalink = self.send(method, chinese_permalink)
+      end
+
+      english_permalink = Translate.t(chinese_permalink, 'CHINESE', 'ENGLISH')
+      self.class.after_methods.each do |method|
+        english_permalink = self.send(method, english_permalink)
+      end
+
+      english_permalink = remove_duplicate_dash(remove_tailing_dash(remove_non_ascii(remove_space(remove_punctuation(english_permalink))))).downcase
+      permalink = id.to_s + '-' + english_permalink
+      self.update_attribute(self.class.permalink_field, permalink)
+    end
+  end
+
+  def remove_tailing_dash(text)
+    text.gsub(/-+$/, '')
+  end
+
+  def remove_non_ascii(text)
+    text.gsub('_', '-').gsub(/[^-a-zA-Z0-9]/, '')
+  end
+
+  def remove_space(text)
+    text.gsub(/\s+/, '-')
+  end
+  
+  def remove_punctuation(text)
+    text.gsub(/&#39;|&amp;|&quot;|&lt;|&gt;|\/|/, '')
+  end
+
+  def remove_duplicate_dash(text)
+    while text.index('--')
+      text.gsub!('--', '-')
+    end
+    text
+  end
+
+  module ClassMethods
+
+    def chinese_permalink(attr_names, options = {})
+      options = {:permalink_field => 'permalink'}.merge(options)
+      self.permalink_attrs = Array(attr_names)
+      self.permalink_field = options[:permalink_field]
+      self.before_methods = Array(options[:before_methods])
+      self.after_methods = Array(options[:after_methods])
+
+      after_save :create_permalink
+    end
+  end
+end

data/test/chines_permalink_test.rb

@@ -0,0 +1,113 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'active_record'
+
+require File.join(File.dirname(__FILE__), '../lib/chinese_permalink')
+require File.join(File.dirname(__FILE__), '../init')
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3', 
+  :database => ':memory:'
+)
+
+def setup_db
+  ActiveRecord::Migration.verbose = false
+  
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts do |t|
+      t.string :title
+      t.string :category
+      t.string :permalink
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Post < ActiveRecord::Base
+  chinese_permalink :title
+end
+
+class CategoryPost < Post
+  chinese_permalink [:category, :title]
+end
+
+class ComplicatedBeforePost < Post
+  chinese_permalink :title, :before_methods => :parse_c_sharp
+
+  def parse_c_sharp(permalink)
+    permalink.gsub('C#', 'c-sharp')
+  end
+end
+
+class ComplicatedAfterPost < Post
+  chinese_permalink :title, :after_methods => :parse_pg
+
+  def parse_pg(permalink)
+    permalink.gsub('Procter &amp; Gamble', 'pg')
+  end
+end
+
+class ChinesePermalinkTest < Test::Unit::TestCase
+  def setup
+    setup_db
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_simple_chinese_title
+    post = Post.create(:title => '中国人')
+    assert_equal "#{post.id}-chinese", post.permalink
+
+    post = Post.create(:title => '我是中国人')
+    assert_equal "#{post.id}-i-am-a-chinese", post.permalink
+  end
+
+  def test_chinese_title_with_dash
+    post = Post.create(:title => '我是中国人——上海')
+    assert_equal "#{post.id}-i-am-a-chinese-shanghai", post.permalink
+
+    post = Post.create(:title => '我是中国人──上海')
+    assert_equal "#{post.id}-i-am-a-chinese-shanghai", post.permalink
+
+    post = Post.create(:title => '上海+中国')
+    assert_equal "#{post.id}-shanghai-china", post.permalink
+
+    post = Post.create(:title => '上海/中国')
+    assert_equal "#{post.id}-shanghai-china", post.permalink
+
+    post = Post.create(:title => '“工作”')
+    assert_equal "#{post.id}-work", post.permalink
+    
+    post = Post.create(:title => '妈妈的礼物')
+    assert_equal "#{post.id}-moms-gift", post.permalink
+
+    post = Post.create(:title => '宝洁')
+    assert_equal "#{post.id}-procter-gamble", post.permalink
+
+    post = Post.create(:title => '自我介绍')
+    assert_equal "#{post.id}-self-introduction", post.permalink
+  end
+
+  def test_chinese_category_and_title
+    post = CategoryPost.create(:title => '我是中国人', :category => '介绍')
+    assert_equal "#{post.id}-introduction-i-am-a-chinese", post.permalink
+  end
+
+  def test_complicated_title_with_before_methods
+    post = ComplicatedBeforePost.create(:title => 'C#语言')
+    assert_equal "#{post.id}-c-sharp-language", post.permalink
+  end
+
+  def test_complicated_title_with_after_methods
+    post = ComplicatedAfterPost.create(:title => '宝洁')
+    assert_equal "#{post.id}-pg", post.permalink
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: chinese_permalink
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-24 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sishen-rtranslate
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This plugin adds a capability for AR model to create a seo permalink with your chinese text. It will translate your chinese text to english url based on google translate.
+email: flyerhzm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .autotest
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- generators/chinese_permalink_migration/chinese_permalink_migration_generator.rb
+- generators/chinese_permalink_migration/templates/migration.rb
+- init.rb
+- lib/chinese_permalink.rb
+- test/chines_permalink_test.rb
+has_rdoc: true
+homepage: http://github.com/flyerhzm/chinese_permalink
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This plugin adds a capability for AR model to create a seo permalink with your chinese text.
+test_files: 
+- test/chines_permalink_test.rb