permalink 0.1.0

data/README.markdown

@@ -0,0 +1,78 @@
+has_permalink
+=============
+
+Instalation
+-----------
+
+You can use I18n-JS as plugin and gem. Choose what's best for you!
+
+	script/plugin install git://github.com/fnando/has_permalink.git
+
+or
+	gem install permalink
+
+Usage
+-----
+
+Add the method call `has_permalink` to your model. Your model should have a `permalink` attribute.
+
+    class Page < ActiveRecord::Base
+      has_permalink :title
+    end
+
+You can specify the permalink field:
+
+    class page < ActiveRecord::Base
+      has_permalink :title, :to => :title_permalink
+    end
+
+If you don't want to use `has_permalink`, you can call `'some text'.to_permalink` string method and
+manage the permalink process by yourself.
+
+Permalinks are not unique by default. `has_permalink` overrides `to_param` as following:
+
+    def to_param
+      "#{id}-#{permalink}"
+    end
+
+You can define the `to_param` format:
+
+    class Page < ActiveRecord::Base
+      has_permalink :title, :to_param => %w(id permalink page)
+    end
+
+The above settings will generate something link `100-some-title-page`. By overriding `to_param` method you don't have to change a thing on your app routes.
+
+If you want to generate unique permalink, use the option `:unique`:
+
+	class Page < ActiveRecord::Base
+	  has_permalink :title, :unique => true, :to_param => :permalink
+	end
+
+The permalink is generated using `ActiveSupport::Multibyte::Chars` class; this means that characters will properly replaced from `áéíó` to `aeio`, for instance.
+
+The permalink is created when `before_validation` callback is evaluated. This plugin also tries
+to generate a permalink when `before_save` callback is evaluated and the instance has no permalink set.
+
+## License
+
+Copyright (c) 2008 Nando Vieira, released under the MIT license
+
+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/Rakefile

@@ -0,0 +1,31 @@
+require 'rake/testtask'
+require 'lib/permalink/version'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the i18n-js plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "permalink"
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/has_permalink"
+    gem.authors = ["Nando Vieira"]
+    gem.version = SimplesIdeias::Permalink::Version::STRING
+    gem.summary = "ActiveRecord plugin for automatically converting fields to permalinks."
+    gem.files =  FileList["README.markdown", "init.rb", "{lib,test}/**/*", "Rakefile"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "[JEWELER] You can't build a gem until you install jeweler with `gem install jeweler`"
+end

data/init.rb

@@ -0,0 +1 @@
+require "permalink"

data/lib/permalink.rb

@@ -0,0 +1,93 @@
+require "permalink/string_ext"
+
+module SimplesIdeias
+  module Permalink
+    def self.included(base)
+      base.extend ClassMethods
+
+      class << base
+        attr_accessor :has_permalink_options
+      end
+    end
+
+    module ClassMethods
+      # has_permalink :title
+      # has_permalink :title, :to => :custom_permalink_field
+      # has_permalink :title, :to => :permalink, :to_param => [:id, :permalink]
+      # has_permalink :title, :unique => true
+      def has_permalink(from, options={})
+        options = {
+          :to => :permalink,
+          :to_param => [:id, :permalink],
+          :unique => false
+        }.merge(options)
+
+        self.has_permalink_options = {
+          :from_column_name => from,
+          :to_column_name => options[:to],
+          :to_param => [options[:to_param]].flatten,
+          :unique => options[:unique]
+        }
+
+        include SimplesIdeias::Permalink::InstanceMethods
+
+        before_validation :create_permalink
+        before_save :create_permalink
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        to_param_option = self.class.has_permalink_options[:to_param]
+
+        to_param_option.compact.collect do |name|
+          if respond_to?(name)
+            send(name).to_s
+          else
+            name.to_s
+          end
+        end.reject(&:blank?).join('-')
+      end
+
+      private
+      def next_available_permalink(_permalink)
+        the_permalink = _permalink
+
+        if self.class.has_permalink_options[:unique]
+          suffix = 2
+
+          while self.class.first(:conditions => {to_permalink_name => the_permalink}, :select => self.class.primary_key)
+            the_permalink = "#{_permalink}-#{suffix}"
+            suffix += 1
+          end
+        end
+
+        the_permalink
+      end
+
+      def from_permalink_name
+        self.class.has_permalink_options[:from_column_name]
+      end
+
+      def to_permalink_name
+        self.class.has_permalink_options[:to_column_name]
+      end
+
+      def from_permalink_value
+        read_attribute(from_permalink_name)
+      end
+
+      def to_permalink_value
+        read_attribute(to_permalink_name)
+      end
+
+      def create_permalink
+        unless from_permalink_value.blank? || !to_permalink_value.blank?
+          write_attribute(to_permalink_name, next_available_permalink(from_permalink_value.to_s.to_permalink))
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, SimplesIdeias::Permalink)

data/lib/permalink/string_ext.rb

@@ -0,0 +1,11 @@
+class String
+  def to_permalink
+    str = ActiveSupport::Multibyte::Chars.new(self)
+    str = str.normalize(:kd).gsub(/[^\x00-\x7F]/,'').to_s
+    str.gsub!(/[^-\w\d]+/sim, "-")
+    str.gsub!(/-+/sm, "-")
+    str.gsub!(/^-?(.*?)-?$/, '\1')
+    str.downcase!
+    str
+  end
+end

data/lib/permalink/version.rb

@@ -0,0 +1,10 @@
+module SimplesIdeias
+  module Permalink
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/test/models/beer.rb

@@ -0,0 +1,3 @@
+class Beer < ActiveRecord::Base
+  has_permalink :name
+end

data/test/models/donut.rb

@@ -0,0 +1,3 @@
+class Donut < ActiveRecord::Base
+  has_permalink :flavor, :to => :slug, :to_param => [:slug, :id, 'permalink']
+end

data/test/models/post.rb

@@ -0,0 +1,5 @@
+class Post < ActiveRecord::Base
+  has_permalink :title, :unique => true, :to_param => :permalink
+  
+  validates_uniqueness_of :permalink
+end

data/test/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_permalink :name, :to => :permalink, :to_param => [:id, "    ", nil, "\t", :permalink]
+end

data/test/permalink_test.rb

@@ -0,0 +1,110 @@
+# encoding: utf-8
+require "test_helper"
+
+class PermalinkTest < ActiveSupport::TestCase
+  SAMPLES = {
+    'This IS a Tripped out title!!.!1  (well/ not really)' => 'this-is-a-tripped-out-title-1-well-not-really',
+    '////// meph1sto r0x ! \\\\\\' => 'meph1sto-r0x',
+    'āčēģīķļņū' => 'acegiklnu',
+    '中文測試 chinese text' => 'chinese-text',
+    'some-)()()-ExtRa!/// .data==?>    to \/\/test' => 'some-extra-data-to-test',
+    'http://simplesideias.com.br/tags/' => 'http-simplesideias-com-br-tags',
+    "Don't Repeat Yourself (DRY)" => 'don-t-repeat-yourself-dry',
+    "Text\nwith\nline\n\n\tbreaks" => 'text-with-line-breaks'
+  }
+
+  test "should create permalink using to_permalink" do
+    SAMPLES.each do |from, to|
+      assert_equal to, from.to_permalink
+    end
+  end
+
+  test "should create permalink" do
+    beer = create_beer
+    assert_equal 'duff', beer.permalink
+  end
+
+  test "should create permalink for custom field" do
+    donut = create_donut
+    assert_equal 'cream', donut.slug
+  end
+
+  test "should add permalink before_save" do
+    beer = Beer.new
+    assert_nil beer.permalink
+    beer.update_attribute(:name, 'Duff Premium')
+    beer.reload
+    assert_equal 'duff-premium', beer.permalink
+  end
+
+  test "should create unique permalinks" do
+    post1 = create_post(:title => 'Ruby is a beautiful language')
+    assert_equal "ruby-is-a-beautiful-language", post1.permalink
+
+    post2 = create_post(:title => 'Ruby is a beautiful language')
+    assert_equal "ruby-is-a-beautiful-language-2", post2.permalink
+
+    post3 = create_post(:title => 'Ruby is a beautiful language')
+    assert_equal "ruby-is-a-beautiful-language-3", post3.permalink
+  end
+
+  test "return to_param for unique permalink" do
+    post1 = create_post(:title => 'Ruby')
+    assert_equal post1.to_param, 'ruby'
+
+    post2 = create_post(:title => 'Ruby')
+    assert_equal post2.to_param, 'ruby-2'
+  end
+
+  test "should override to_param method" do
+    beer = create_beer
+    assert_equal "#{beer.id}-#{beer.permalink}", beer.to_param
+  end
+
+  test "should override to_param with custom fields" do
+    donut = create_donut
+    assert_equal "#{donut.slug}-#{donut.id}-permalink", donut.to_param
+  end
+
+  test "should ignore blank attributes from to_param" do
+    user = create_user
+    assert_equal "1-john-doe", user.to_param
+  end
+
+  test "should set permalink if permalink is blank" do
+    user = create_user(:permalink => " ")
+    user.reload
+    assert_equal "john-doe", user.permalink
+  end
+
+  test "should keep defined permalink" do
+    user = create_beer(:permalink => "jdoe")
+    user.reload
+    assert_equal "jdoe", user.permalink
+  end
+
+  test "should create unique permalinks for number-ended titles" do
+    post1 = create_post(:title => "Rails 3")
+    assert_equal "rails-3", post1.permalink
+
+    post2 = create_post(:title => "Rails 3")
+    assert_equal "rails-3-2", post2.permalink
+  end
+
+  private
+  def create_beer(options={})
+    Beer.create({:name => 'Duff'}.merge(options))
+  end
+
+  def create_donut(options={})
+    Donut.create({:flavor => 'Cream'}.merge(options))
+  end
+
+  def create_user(options={})
+    User.create({:name => 'John Doe'}.merge(options))
+  end
+
+  def create_post(options={})
+    Post.create({:title => 'Some nice post!'}.merge(options))
+  end
+end

data/test/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :beers do |t|
+    t.string :name, :permalink
+  end
+  
+  create_table :users do |t|
+    t.string :name, :permalink
+  end
+  
+  create_table :donuts do |t|
+    t.string :flavor, :slug
+  end
+  
+  create_table :posts do |t|
+    t.string :title
+    t.string :permalink, :unique => true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "test/unit"
+require "active_record"
+require "active_support/test_case"
+require "permalink"
+
+Dir.glob(File.dirname(__FILE__) + "/models/*.rb").each {|r| require r }
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+load('schema.rb')

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: permalink
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- init.rb
+- lib/permalink.rb
+- lib/permalink/string_ext.rb
+- lib/permalink/version.rb
+- test/models/beer.rb
+- test/models/donut.rb
+- test/models/post.rb
+- test/models/user.rb
+- test/permalink_test.rb
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fnando/has_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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ActiveRecord plugin for automatically converting fields to permalinks.
+test_files: 
+- test/models/beer.rb
+- test/models/donut.rb
+- test/models/post.rb
+- test/models/user.rb
+- test/permalink_test.rb
+- test/schema.rb
+- test/test_helper.rb