has_permalink 0.0.7 → 0.0.8

data/lib/has_permalink.rb

@@ -1,7 +1,7 @@
 require 'friendly_url'
 
 module HasPermalink
-  require 'railtie' if defined?(Rails)
+  require 'railtie' if defined?(Rails) && Rails.version >= "3"
 
   def has_permalink(generate_from = :title)
     unless included_modules.include? InstanceMethods
@@ -15,6 +15,12 @@ module HasPermalink
   end
 
   module ClassMethods
+
+    # Makes it possible to generate permalinks for
+    # all instances of self:
+    #
+    #   Product.generate_permalinks
+    #
     def generate_permalinks
       self.all.each do |item|
         item.generate_permalink
@@ -25,14 +31,18 @@ module HasPermalink
 
   module InstanceMethods
     include FriendlyUrl
+
+    # Generate permalink for the instance if the permalink is empty or nil.
     def generate_permalink
       self.permalink = normalize(self.send(generate_from)) if permalink.blank?
     end
 
+    # Generate permalink for the instance and overwrite any existing value.
     def generate_permalink!
       self.permalink = normalize(self.send(generate_from))
     end
 
+    # Override to send permalink as params[:id]
     def to_param
       permalink
     end

data/lib/railtie.rb

@@ -3,6 +3,8 @@ require 'rails'
 
 module HasPermalink
   class Railtie < Rails::Railtie
+
+    # Include the rake tasks to the application with the gem installed
     rake_tasks do
       load 'tasks/has_permalink.rake'
     end

data/lib/tasks/has_permalink.rake

@@ -12,6 +12,7 @@ namespace :has_permalink do
   end
 end
 
+# Calls the class method 'generate_permalinks' on given model
 def generate_permalinks(model_name)
   begin
     if Kernel.const_get(model_name)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_permalink
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Ola Karlsson
@@ -15,27 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-01 00:00:00 +01:00
+date: 2011-03-12 00:00:00 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 62196427
-        segments: 
-        - 3
-        - 0
-        - 0
-        - beta
-        - 4
-        version: 3.0.0.beta4
-  type: :runtime
-  version_requirements: *id001
+dependencies: []
+
 description: 
 email: olkarls@gmail.com
 executables: []
@@ -54,7 +37,7 @@ files:
 - lib/tasks/has_permalink.rake
 - rails/init.rb
 has_rdoc: true
-homepage: 
+homepage: http://haspermalink.org
 licenses: []
 
 post_install_message: 
@@ -83,9 +66,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Generating url-safe permalink from any other attribute in the same ActiveRecord model.
+summary: SEO Permalink Plugin for Ruby on Rails.
 test_files: []