acts_as_permalink 0.3.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,51 @@
+# Acts As Permalink
+
+Manages permalink field on an ActiveRecord model to be used in place of the id field in Rails.
+
+Written by Kevin McPhillips (kimos) in 2009.
+
+Last updated March 2012.
+
+[http://github.com/kimos/acts_as_permalink](http://github.com/kimos/acts_as_permalink)
+
+[github@kevinmcphillips.ca](mailto:github@kevinmcphillips.ca)
+
+
+## Usage
+
+The gem is on RubyGems:
+
+    gem 'acts_as_permalink'
+
+And then just call it in your model:
+
+    class Post < ActiveRecord::Base
+      acts_as_permalink
+    end
+
+That's about it. 
+The plugin expects string fields to be used to save the permalink on the model and to use as a source for the permalink. It defaults to use the fields named "title" and "permalink" which can be overridden by options:
+
+    :from        =>  :title       # Name of the active record column or function used to generate the permalink
+    :to          =>  :permalink   # Name of the column where the permalink will be stored
+    :max_length  =>  60           # Maximum number of characters the permalink will be
+
+So, for example you have want to store your permalink in a column called "path_name" and you want to generate your permalink using first and last name, and you want to restrict it to 40 characters, your model would look like:
+
+    class User < ActiveRecord::Base
+      acts_as_permalink :from => :full_name, :to => :path, :max_length => 40
+
+      def full_name
+        first_name + last_name
+      end
+    end
+
+
+## History
+
+* May 3, 2012 -- 0.3.1 -- Finally got it gemified.
+
+* March 19, 2012  --  Updated to work with Rails 3.2
+
+* Feb 13, 2010*  --  Fixed collision problem with single table inheritance models. Removed dependency on andand gem.
+

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Acts::Permalink'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/acts_as_permalink/version.rb

@@ -0,0 +1,5 @@
+module Acts
+  module Permalink
+    VERSION = "0.3.1"
+  end
+end

data/lib/acts_as_permalink.rb

@@ -0,0 +1,87 @@
+# ActsAsPermalink
+module Acts #:nodoc:
+  module Permalink #:nodoc:
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_permalink(options={})
+        # Read and scrub option for the column which will save the permalink    
+        @permalink_column_name = options[:to].try(:to_sym) || :permalink
+
+        # Read and scrub the option for the column or function which will generate the permalink 
+        @permalink_source = (options[:from].try(:to_sym) || :title)
+
+        # Read and validate the maximum length of the permalink
+        max_length = options[:max_length].to_i rescue 0
+        max_length = 60 unless max_length && max_length > 0
+        @permalink_length = max_length
+
+        if Rails.version >= "3"
+          before_validation :update_permalink, :on => :create
+        else
+          before_validation_on_create :update_permalink
+        end
+
+        validates_uniqueness_of @permalink_column_name
+        attr_readonly @permalink_column_name
+        
+        include Acts::Permalink::InstanceMethods
+        extend Acts::Permalink::SingletonMethods
+      end
+      
+      # Returns the unique permalink string for the passed in object.
+      def generate_permalink_for(obj)
+
+        # Find the source for the permalink
+        text = obj.send(obj.class.instance_variable_get('@permalink_source'))
+        
+        # If it is blank then generate a random link
+        if text.blank?
+          text = obj.class.to_s.downcase + rand(10000).to_s
+
+        # If it is not blank, scrub
+        else
+          text = text.downcase.strip                  # make the string lowercase and scrub white space on either side
+          text = text.gsub(/[^a-z0-9\w]/, "_")        # make any character that is not nupermic or alphabetic into an underscore
+          text = text.sub(/_+$/, "").sub(/^_+/, "")   # remove underscores on either end, caused by non-simplified characters
+          text = text[0...obj.class.instance_variable_get('@permalink_length')]        # trim to length
+        end
+        
+        # Attempt to find the object by the permalink
+        if obj.class.base_class.send("find_by_#{obj.class.instance_variable_get('@permalink_column_name')}", text)
+          num = 1
+
+          # If we find the object we know there is a collision, so just add a number to the end until there is no collision
+          while obj.class.base_class.send("find_by_#{obj.class.instance_variable_get('@permalink_column_name')}", text + num.to_s)
+            num += 1
+          end
+
+          text = text + num.to_s
+        end
+        text
+      end
+    end
+  
+    module SingletonMethods
+    end
+    
+    module InstanceMethods
+
+      # Override this method so that find searches by permalink and not by id
+      def to_param
+        self.send(self.class.instance_variable_get('@permalink_column_name'))
+      end
+      
+      # Generate the permalink and assign it directly via callback
+      def update_permalink
+        self.send("#{self.class.instance_variable_get('@permalink_column_name')}=", self.class.generate_permalink_for(self))
+        true
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Acts::Permalink)

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_permalink
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin McPhillips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70310709515380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310709515380
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70310709514580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310709514580
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70310709530460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310709530460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70310709530040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70310709530040
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70310709529480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70310709529480
+description: Manages permalink columns in active record models. Strips special charactes
+  and spaces, creates before validation, assures uniqueness. That kind of thing.
+email:
+- github@kevinmcphillips.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_permalink/version.rb
+- lib/acts_as_permalink.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+homepage: http://github.com/kimos/acts_as_permalink
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3998614899780643219
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3998614899780643219
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Automatically manage permalink fields for ActiveRecord models in Rails.
+test_files: []