permalink 0.1.1 → 1.0.0

data/README.markdown

@@ -1,35 +1,30 @@
-has_permalink
-=============
+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.
+Add the method call `permalink` to your model. Your model should have a `permalink` attribute.
 
     class Page < ActiveRecord::Base
-      has_permalink :title
+      permalink :title
     end
 
 You can specify the permalink field:
 
     class page < ActiveRecord::Base
-      has_permalink :title, :to => :title_permalink
+      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
+If you don't want to use `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:
+Permalinks are not unique by default. `permalink` overrides `to_param` as following:
 
     def to_param
       "#{id}-#{permalink}"
@@ -38,15 +33,15 @@ Permalinks are not unique by default. `has_permalink` overrides `to_param` as fo
 You can define the `to_param` format:
 
     class Page < ActiveRecord::Base
-      has_permalink :title, :to_param => %w(id permalink page)
+      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`:
+If you want to generate unique permalink, use the `:unique` option:
 
 	class Page < ActiveRecord::Base
-	  has_permalink :title, :unique => true, :to_param => :permalink
+	  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.

data/Rakefile

@@ -4,7 +4,7 @@ require File.dirname(__FILE__) + "/lib/permalink/version"
 desc "Default: run unit tests."
 task :default => :test
 
-desc "Test the i18n-js plugin."
+desc "Run tests"
 Rake::TestTask.new(:test) do |t|
   t.libs << "lib"
   t.libs << "test"
@@ -18,11 +18,11 @@ begin
   JEWEL = Jeweler::Tasks.new do |gem|
     gem.name = "permalink"
     gem.email = "fnando.vieira@gmail.com"
-    gem.homepage = "http://github.com/fnando/has_permalink"
+    gem.homepage = "http://github.com/fnando/permalink"
     gem.authors = ["Nando Vieira"]
-    gem.version = SimplesIdeias::Permalink::Version::STRING
+    gem.version = Permalink::Version::STRING
     gem.summary = "ActiveRecord plugin for automatically converting fields to permalinks."
-    gem.files =  FileList["README.markdown", "init.rb", "{lib,test}/**/*", "Rakefile"]
+    gem.files =  FileList["README.markdown", "{lib,test}/**/*", "Rakefile"]
   end
 
   Jeweler::GemcutterTasks.new

data/lib/permalink.rb

@@ -1,94 +1,92 @@
 require "permalink/string_ext"
 require "active_record"
 
-module SimplesIdeias
-  module Permalink
-    def self.included(base)
-      base.extend ClassMethods
+module Permalink
+  def self.included(base)
+    base.extend ClassMethods
 
-      class << base
-        attr_accessor :has_permalink_options
-      end
+    class << base
+      attr_accessor :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
+  module ClassMethods
+    # permalink :title
+    # permalink :title, :to => :custom_permalink_field
+    # permalink :title, :to => :permalink, :to_param => [:id, :permalink]
+    # permalink :title, :unique => true
+    def permalink(from, options={})
+      options = {
+        :to => :permalink,
+        :to_param => [:id, :permalink],
+        :unique => false
+      }.merge(options)
+
+      self.permalink_options = {
+        :from_column_name => from,
+        :to_column_name => options[:to],
+        :to_param => [options[:to_param]].flatten,
+        :unique => options[:unique]
+      }
+
+      include 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
+  module InstanceMethods
+    def to_param
+      to_param_option = self.class.permalink_options[:to_param]
 
-      private
-      def next_available_permalink(_permalink)
-        the_permalink = _permalink
+      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
 
-        if self.class.has_permalink_options[:unique]
-          suffix = 2
+    private
+    def next_available_permalink(_permalink)
+      the_permalink = _permalink
 
-          while self.class.first(:conditions => {to_permalink_name => the_permalink}, :select => self.class.primary_key)
-            the_permalink = "#{_permalink}-#{suffix}"
-            suffix += 1
-          end
-        end
+      if self.class.permalink_options[:unique]
+        suffix = 2
 
-        the_permalink
+        while self.class.first(:conditions => {to_permalink_name => the_permalink}, :select => self.class.primary_key)
+          the_permalink = "#{_permalink}-#{suffix}"
+          suffix += 1
+        end
       end
 
-      def from_permalink_name
-        self.class.has_permalink_options[:from_column_name]
-      end
+      the_permalink
+    end
 
-      def to_permalink_name
-        self.class.has_permalink_options[:to_column_name]
-      end
+    def from_permalink_name
+      self.class.permalink_options[:from_column_name]
+    end
 
-      def from_permalink_value
-        read_attribute(from_permalink_name)
-      end
+    def to_permalink_name
+      self.class.permalink_options[:to_column_name]
+    end
 
-      def to_permalink_value
-        read_attribute(to_permalink_name)
-      end
+    def from_permalink_value
+      read_attribute(from_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
+    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
 
-ActiveRecord::Base.send(:include, SimplesIdeias::Permalink)
+ActiveRecord::Base.send(:include, Permalink)

data/lib/permalink/version.rb

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

data/test/models/beer.rb

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

data/test/models/donut.rb

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

data/test/models/post.rb

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

data/test/models/user.rb

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

data/test/test_helper.rb

@@ -6,5 +6,5 @@ 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')
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+load("schema.rb")

metadata

@@ -3,10 +3,10 @@ name: permalink
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 1
   - 1
-  version: 0.1.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-09 00:00:00 -03:00
+date: 2010-10-06 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -29,7 +29,6 @@ extra_rdoc_files:
 files: 
 - README.markdown
 - Rakefile
-- init.rb
 - lib/permalink.rb
 - lib/permalink/string_ext.rb
 - lib/permalink/version.rb
@@ -41,7 +40,7 @@ files:
 - test/schema.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/fnando/has_permalink
+homepage: http://github.com/fnando/permalink
 licenses: []
 
 post_install_message: 

data/init.rb

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