revolutionhealth-acts_as_seo_friendly 1.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 2008-06-13
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+acts_as_seo_friendly.gemspec
+config/hoe.rb
+config/requirements.rb
+lib/acts_as_seo_friendly.rb
+lib/acts_as_seo_friendly/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/seo_test_model.rb
+test/seo_test_model_conditions.rb
+test/test_acts_as_seo_friendly.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+
+For more information on acts_as_seo_friendly, see http://github.com/revolutionhealth/acts_as_seo_friendly/tree/master
+

data/README.txt

@@ -0,0 +1,86 @@
+= acts_as_seo_friendly
+
+http://revolutiononrails.blogspot.com/
+
+== DESCRIPTION:
+
+Create an SEO friendly field for a model automatically based on a given field.
+
+So if you have a Blogs model, and you would like create an SEO friendly version 
+of the 'title' field, you would just add this to your model and then be able to 
+use the SEO friendly id as the unique id to the resource.  The plugin will only
+append an integer to the SEO id if there is a collision.
+
+== FEATURES/PROBLEMS:
+
+* Only tested on mysql and sqlite3
+
+
+== SYNOPSIS:
+
+
+Create seo column migration:
+
+ class CreateSeoTestModels < ActiveRecord::Migration
+   def self.up
+     create_table :seo_test_models do |t|
+       t.string :name
+       t.timestamps
+     end
+	 SeoTestModel.create_seo_friendly_column()
+   end
+
+   def self.down
+	 SeoTestModel.drop_seo_friendly_column()
+     drop_table :seo_test_models
+   end
+ end
+
+
+Add to model:
+
+ class SeoTestModel < ActiveRecord::Base
+	acts_as_seo_friendly :resource_id => :name, 
+					     :seo_friendly_id_field => :seo_id, # default is :seo_friendly_id
+					     :seo_friendly_id_limit => 100 # default is 50
+ end
+
+
+To lookup the resource in the controllers use:
+
+  SeoTestModel.find_by_seo_id(params[:id])
+
+
+
+== REQUIREMENTS:
+
+
+== INSTALL:
+
+* sudo gem install revolutionhealth-acts_as_seo_friendly -s http://gems.github.com
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Revolution Health Group LLC
+
+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,12 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+task :gemspec  do
+  gemspec_file = File.join(File.dirname(__FILE__), "#{GEM_NAME}.gemspec")
+  `rake debug_gem > #{gemspec_file}`
+  gemspec = File.readlines(gemspec_file)
+  gemspec.delete_at(0)
+  File.open(gemspec_file, "w+") {|f| f <<  gemspec.to_s() }
+end

data/acts_as_seo_friendly.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_seo_friendly}
+  s.version = "1.1.0"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Revolution Health"]
+  s.date = %q{2008-06-16}
+  s.description = %q{provides a seo friendly version of field on a table}
+  s.email = ["opensource@revolutionhealth.com"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "website/index.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "Rakefile", "acts_as_seo_friendly.gemspec", "config/hoe.rb", "config/requirements.rb", "lib/acts_as_seo_friendly.rb", "lib/acts_as_seo_friendly/version.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "tasks/deployment.rake", "tasks/environment.rake", "tasks/website.rake", "test/seo_test_model.rb", "test/seo_test_model_conditions.rb", "test/test_acts_as_seo_friendly.rb", "test/test_helper.rb", "website/index.html", "website/index.txt", "website/javascripts/rounded_corners_lite.inc.js", "website/stylesheets/screen.css", "website/template.html.erb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/revolutionhealth/acts_as_seo_friendly/tree/master}
+  s.post_install_message = %q{
+For more information on acts_as_seo_friendly, see http://github.com/revolutionhealth/acts_as_seo_friendly/tree/master
+
+}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_seo_friendly}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{provides a seo friendly version of field on a table}
+  s.test_files = ["test/test_acts_as_seo_friendly.rb", "test/test_helper.rb"]
+end

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'acts_as_seo_friendly/version'
+
+AUTHOR = 'Revolution Health'  # can also be an array of Authors
+EMAIL = "opensource@revolutionhealth.com"
+DESCRIPTION = "provides a seo friendly version of field on a table"
+GEM_NAME = 'acts_as_seo_friendly' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'acts_as_seo_friendly' # The unix name for your project
+HOMEPATH = "http://github.com/revolutionhealth/acts_as_seo_friendly/tree/master"
+DOWNLOAD_PATH = "http://github.com/revolutionhealth/acts_as_seo_friendly/tree/master"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = ActsAsSeoFriendly::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'acts_as_seo_friendly documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen mocha].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/acts_as_seo_friendly.rb

@@ -0,0 +1,165 @@
+
+module ActiveRecord
+  module Acts #:nodoc:
+    module SeoFriendly #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module MigrationMethods
+        def create_seo_friendly_column()
+          seo_column_name = read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_field].to_s
+          seo_column_limit = read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_limit].to_i
+          self.connection.add_column table_name(), seo_column_name, :string, :null => true, :limit => seo_column_limit
+          self.connection.add_index table_name(), seo_column_name, :unique => true
+        end
+        
+        def drop_seo_friendly_column()
+          seo_column_name = read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_field].to_s
+          self.connection.remove_index table_name(), seo_column_name
+          self.connection.remove_column table_name(), seo_column_name
+        end
+      end
+
+      module ClassMethods
+        #
+        # Use find_by_seo_friendly_id
+        def acts_as_seo_friendly(options = {})
+          options = {:seo_friendly_id_field => :seo_friendly_id, :seo_friendly_id_limit => 50}.merge(options)
+          write_inheritable_attribute(:seo_friendly_options, options)
+          
+          after_save :create_seo_friendly_id
+          to_param_with(read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_field])
+          
+          if !self.included_modules.include?(ActiveRecord::Acts::SeoFriendly::InstanceMethods)
+            include ActiveRecord::Acts::SeoFriendly::InstanceMethods
+          end
+        end
+        
+        include ActiveRecord::Acts::SeoFriendly::MigrationMethods
+        
+        private
+        def to_param_with(attr_sym)
+          return if attr_sym.nil?
+          attr_str = attr_sym.to_s
+          class_eval <<-EOS
+            def to_param
+              (#{attr_str} = self.#{attr_str}) ? #{attr_str} : nil
+            end
+          EOS
+        end
+      end
+      
+      
+      module InstanceMethods
+        private        
+        
+        INITITAL_SEO_UNIQUE_DIGITS = 4         # initially allow for 1000 collisions.. 
+        
+        def create_seo_friendly_id
+          ## return if there are errors
+          return if self.errors.length > 0
+          
+          seo_id_field = self.class.read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_field].to_s
+          count_seo_id_field = "count_#{seo_id_field}"
+          count_seo_id_field_N = "#{count_seo_id_field}_N"
+                    
+          resource_id_field = self.class.read_inheritable_attribute(:seo_friendly_options)[:resource_id].to_s
+          resource_id_value = self[resource_id_field]
+          
+          return if resource_id_value.blank?
+          
+          seo_id_value = create_seo_friendly_str(resource_id_value)
+
+          return if (self[seo_id_field] =~ /^#{seo_id_value}$/) || (self[seo_id_field] =~ /^#{seo_id_value}\-\d+$/)
+
+          self.class.transaction do
+            unique_id = determine_unique_id(seo_id_field, count_seo_id_field, count_seo_id_field_N, seo_id_value)
+            seo_field_value = "#{seo_id_value}" + (unique_id != nil ? "-#{unique_id}" : "")
+            
+            seo_friendly_id_limit = self.class.read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_limit].to_i
+            
+            if seo_field_value.size > seo_friendly_id_limit
+              seo_id_value = create_seo_friendly_str(resource_id_value, INITITAL_SEO_UNIQUE_DIGITS + (seo_field_value.size - seo_friendly_id_limit))
+              unique_id = determine_unique_id(seo_id_field, count_seo_id_field, count_seo_id_field_N, seo_id_value)
+
+              seo_field_value = "#{seo_id_value}" + (unique_id != nil ? "-#{unique_id}" : "")
+              seo_field_value = self['id'] if seo_field_value.size > seo_friendly_id_limit # still doesn't fit..give up, store the id
+            end
+
+            self.class.update_all("#{seo_id_field} = \'#{seo_field_value}\'", ["id = ?", self.id])
+            # set it so that it can be used after this..
+            self[seo_id_field] = seo_field_value
+          end
+          
+          true
+        end
+        
+        
+        def determine_unique_id(seo_id_field, count_seo_id_field, count_seo_id_field_N, seo_id_value)
+          conditions_proc = self.class.read_inheritable_attribute(:seo_friendly_options)[:conditions]
+          conditions_option = execute_block(conditions_proc)
+          conditions = (!conditions_option.blank? ? " AND #{self.class.send(:sanitize_sql, conditions_option)} " : "")
+          
+          counts = self.class.find_by_sql(%Q(
+            select count(#{seo_id_field}) as #{count_seo_id_field}, NULL as #{count_seo_id_field_N} from #{self.class.table_name} where #{seo_id_field} = '#{seo_id_value}' #{conditions}
+            UNION 
+            select NULL as #{count_seo_id_field}, count(#{seo_id_field}) as #{count_seo_id_field_N} from #{self.class.table_name} where #{seo_id_field} like '#{seo_id_value}-%' #{conditions};)
+          )
+
+          # can't guarantee order of results
+          count_seo_id_value = counts[0][count_seo_id_field].to_i
+          if counts[0][count_seo_id_field].nil?
+            count_seo_id_value = counts[1][count_seo_id_field].to_i
+          end
+          
+          count_seo_id_N_value = counts[0][count_seo_id_field_N].to_i
+          if counts[0][count_seo_id_field_N].nil?
+            count_seo_id_N_value = counts[1][count_seo_id_field_N].to_i
+          end
+          
+          result = nil
+          if (count_seo_id_value != 0)
+            last = count_seo_id_N_value
+            result = last + 1
+          end
+          return result
+        end
+        
+        def create_seo_friendly_str(str, digits = INITITAL_SEO_UNIQUE_DIGITS)
+          s = str.dup
+          s.gsub!(/\'/, '')
+          s.gsub!(/\W+/, ' ')
+          s.strip!
+          s.downcase!
+          s.gsub!(/\ +/, '-')
+          s.gsub!(/\-{2}/, '-')
+          limit = self.class.read_inheritable_attribute(:seo_friendly_options)[:seo_friendly_id_limit].to_i - digits
+          # if we are trimming on a word, attempt to pretty it up and trim on a boundary (if available)
+          if s.length > limit && (s[limit, 1] =~ /[^\-]{1}/) != nil && (last_boundary_index = s[0..(limit - 1)].rindex('-')) != nil
+            limit = last_boundary_index
+          end
+          s = s[0..(limit - 1)]
+          ## final check to make sure no trailing -'s
+          s.gsub!(/\-$/,'')
+          return s
+        end
+        
+        # Given a piece of code, this method calls send(code) if code is a symbol, code.call(self) if it is callable
+        # or simply executes it
+        def execute_block(block)
+          case
+            when block.is_a?(Symbol)
+              send(block)
+            when block.respond_to?(:call) && (block.arity == 1 || block.arity == -1)
+              block.call(self)
+            else
+              block
+            end  
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::SeoFriendly)