compages 0.4.0

data/vendor/plugins/acts_as_urlnameable/init.rb

@@ -0,0 +1,3 @@
+require 'acts_as_urlnameable'
+require File.dirname(__FILE__) + '/lib/urlname'
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Urlnameable)

data/vendor/plugins/acts_as_urlnameable/lib/acts_as_urlnameable.rb

@@ -0,0 +1,159 @@
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    module Urlnameable #:nodoc:
+      def self.included(base)
+        base.extend(ClassMethods)  
+      end
+      
+      module ClassMethods
+        def acts_as_urlnameable(attr_name, options = {})
+          
+          write_inheritable_attribute(:acts_as_urlnameable_options,
+          { :type               => ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s,
+            :attr               => attr_name,
+            :mode               => (options[:mode] || :single),
+            :overwrite          => (options[:overwrite] || false),
+            :validate           => (options[:validate] || :class),
+            :owner_association  => (options[:owner_association] || nil),
+            :message    => (options[:message] || 'already exists') } )
+
+          class_inheritable_reader :acts_as_urlnameable_options
+
+          write_inheritable_attribute(:urlname_table, Urlname.table_name)
+          class_inheritable_reader :urlname_table
+
+          has_many    :urlnames, :as => :nameable, :order => 'id DESC', :dependent => true
+          after_save  :update_or_add_urlname
+          validate    :validate_urlname unless acts_as_urlnameable_options[:validate] == false
+
+          include ActiveRecord::Acts::Urlnameable::InstanceMethods
+          extend ActiveRecord::Acts::Urlnameable::SingletonMethods
+        end
+        
+      end
+
+      module SingletonMethods
+        def find_all_by_urlname(name)
+          find_urlnames(name, :all)
+        end
+        
+        def find_by_urlname(name)
+          find_urlnames(name, :first)
+        end
+        
+        def urlnames
+          connection.select_values("SELECT name FROM #{urlname_table}
+                                    WHERE #{urlname_table}.nameable_type = '#{acts_as_urlnameable_options[:type]}'")
+        end
+        
+        private
+        def find_urlnames(name, all_or_first)
+          find( all_or_first,
+                :select => "#{table_name}.*",
+                :joins => "JOIN #{urlname_table} ON #{table_name}.#{primary_key} = #{urlname_table}.nameable_id",
+                :conditions =>
+                ["#{urlname_table}.nameable_type = '#{acts_as_urlnameable_options[:type]}'
+                  AND #{urlname_table}.name = ?", name],
+                :readonly => false)
+        end
+      end
+      
+      module InstanceMethods
+        def urlname
+          urlnames.first ? urlnames.first.name : nil
+        end
+        
+        def past_urlnames
+          (urlnames.size <= 1) ? [] : (urlnames - [urlnames.first]).collect { |u| u.name }
+        end
+        
+        def all_urlnames
+          urlnames.collect { |u| u.name }
+        end
+        
+        def urlnameify(text)
+          t = text.to_s.downcase.strip.gsub(/[^-_\s[:alnum:]]/, '').squeeze(' ').tr(' ', '_')
+          (t.blank?) ? '_' : t
+        end
+        
+        private
+        def attr_to_urlname
+          urlnameify(send(acts_as_urlnameable_options[:attr]))
+        end
+        
+        def update_or_add_urlname
+          recent_name = (urlnames.first || urlnames.build)
+          urlname_string = attr_to_urlname
+
+          case acts_as_urlnameable_options[:mode]
+          when :single
+            if acts_as_urlnameable_options[:overwrite]
+              recent_name.name = urlname_string
+            else
+              recent_name.name = urlname_string if recent_name.new_record?
+            end
+          when :multiple
+            if recent_name.new_record? && !past_urlnames.include?(urlname_string)
+              recent_name.name = urlname_string
+            elsif !recent_name.new_record? && !past_urlnames.include?(urlname_string)
+              unless recent_name.name == urlname_string
+                recent_name = urlnames.build(:name => urlname_string) 
+                # Because it ends up at the end of the association when it should be at the start
+                urlnames.unshift(urlnames.pop)
+              end
+            end
+          end
+
+          recent_name.save
+        end
+        
+        def validate_urlname
+          case acts_as_urlnameable_options[:validate]
+          when :class, :sti_class
+            validate_urlname_against_class
+          else
+            validate_urlname_against_owner
+          end
+        end
+                
+        def validate_urlname_against_class
+          urlname_string = attr_to_urlname
+
+          if past_urlnames.include? urlname_string
+            return true
+          else
+            finder_class = 
+              (acts_as_urlnameable_options[:validate] == :sti_class) ? self.class : acts_as_urlnameable_options[:type].constantize
+            
+            existing_urlname = finder_class.find_by_urlname(urlname_string)
+            
+            if existing_urlname == self || existing_urlname.nil?
+              return true
+            else
+              errors.add(:urlname, acts_as_urlnameable_options[:message])
+            end                             
+          end
+        end
+        
+        def validate_urlname_against_owner
+          owner_reflection = self.class.reflect_on_association(acts_as_urlnameable_options[:validate])
+          unless owner_reflection && owner_reflection.macro == :belongs_to
+            raise ArgumentError, "You can only validate against the class as a whole, or a belongs_to association."
+          end
+
+          unless child_reflection = owner_reflection.klass.reflect_on_association(acts_as_urlnameable_options[:owner_association] || self.class.to_s.tableize.to_sym)
+            raise ArgumentError, "Couldn't figure out owner association via reflection"
+          end
+
+          if obj = send(owner_reflection.name).send(child_reflection.name).find_by_urlname(attr_to_urlname)
+            errors.add(:urlname, acts_as_urlnameable_options[:message]) unless obj == self || obj.nil?
+          else
+            return true
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/vendor/plugins/acts_as_urlnameable/lib/urlname.rb

@@ -0,0 +1,3 @@
+class Urlname < ActiveRecord::Base
+  belongs_to :nameable, :polymorphic => true
+end

data/vendor/plugins/acts_as_urlnameable/test/acts_as_urlnameable_test.rb

@@ -0,0 +1,233 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsUrlnameableTest < Test::Unit::TestCase
+  fixtures :articles, :pages, :people, :sections, :urlnames
+
+  def test_urlname_reader_methods
+    assert_equal 'first_test_article_edit', articles(:first).urlname
+
+    assert_nil articles(:sixth).urlname
+    
+    assert_equal 'seventh_test_article', articles(:seventh).urlname
+    
+    assert_equal 'joe_smith', people(:first).urlname
+    
+    assert_equal 'jane_bloggs', people(:second).urlname
+    
+    assert_equal 2, articles(:first).past_urlnames.size
+    
+    assert articles(:first).past_urlnames.find { |u| u == 'first_test_article' }
+    
+    assert_nil articles(:third).past_urlnames.find { |u| u == 'third_test_article' }
+
+    assert 0, people(:first).past_urlnames.size
+    
+    assert 1, people(:second).past_urlnames.size    
+    
+    assert 2, people(:second).all_urlnames.size    
+  end
+  
+  def test_urlname_association   
+    assert_equal 3, articles(:first).urlnames.size 
+    
+    assert_equal 2, articles(:third).urlnames.size 
+    
+    assert_equal 1, people(:first).urlnames.size
+    
+    assert_equal 3, people(:second).urlnames.size
+  end
+  
+  def test_urlnames_class_method
+    assert_equal Urlname.find_all_by_nameable_type('Article').size, Article.urlnames.size
+    
+    assert_equal Urlname.find_all_by_nameable_type('Person').size, Person.urlnames.size
+  end
+  
+  def test_class_finder_methods
+    assert_equal articles(:first), Article.find_by_urlname('first_test_article_edit')
+    
+    assert_equal articles(:third), Article.find_by_urlname('old_third_test_title')
+    
+    assert_nil Article.find_by_urlname('blah blah non existent')
+    
+    assert_equal 2, Page.find_all_by_urlname('test_for_multiple_finder').size
+
+  end
+  
+  def test_finder_methods_with_association
+    person_one, person_two = people(:first), people(:second)
+    
+    assert_nil person_one.articles.find_by_urlname('blah blah non existent')
+    
+    assert_equal articles(:first), person_one.articles.find_by_urlname('first_test_article_edit')
+    
+    assert_equal articles(:first), person_one.articles.find_by_urlname('first_test_article')
+    
+    assert_equal articles(:fourth), person_two.articles.find_by_urlname('fourth_test_article')
+    
+    assert_nil person_one.articles.find_by_urlname('fourth_test_article')
+    
+    assert_nil person_two.articles.find_by_urlname('first_test_article_edit')
+  end
+
+  def test_urlname_single_saving_without_overwrite
+    page = Page.new(:title => 'Testing New Urlnames - Test', 
+                    :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+    page.save
+    
+    assert_equal page, Page.find_by_urlname('testing_new_urlnames_-_test')
+    
+    page.title = 'This is another test of the urlname saving'
+    
+    page.save
+
+    assert_equal page, Page.find_by_urlname('testing_new_urlnames_-_test')
+    
+    assert_nil Page.find_by_urlname('this_is_another_test_of_the_urlname_saving')
+  end
+
+  def test_urlname_single_saving_with_overwrite
+    section = Section.new(:name => 'Testing Section')
+    
+    section.save
+    
+    assert_equal section, Section.find_by_urlname('testing_section')
+    
+    section.name = 'Renamed this section'
+    
+    section.save
+    
+    assert_nil Section.find_by_urlname('testing_section')
+    
+    assert_equal section, Section.find_by_urlname('renamed_this_section')
+  end
+
+  def test_urlname_multiple_saving
+    article = Article.new(:title => 'Testing New Urlnames - Test Article', 
+                          :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+    article.save
+
+    assert_equal article, Article.find_by_urlname('testing_new_urlnames_-_test_article')
+    
+    assert_equal article.urlname, 'testing_new_urlnames_-_test_article'
+    
+    article.title = 'This is another test of the urlname saving - article'
+    
+    article.save
+    
+    assert_equal article.urlname, 'this_is_another_test_of_the_urlname_saving_-_article'
+
+    assert_equal article, Article.find_by_urlname('this_is_another_test_of_the_urlname_saving_-_article')
+        
+    assert_equal article, Article.find_by_urlname('testing_new_urlnames_-_test_article')
+  end
+  
+  def test_validations_against_class
+    article = Article.new(:title => 'Ninth Test Article', 
+                          :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+                          
+    assert !article.save
+    
+    assert_equal 'already exists', article.errors[:urlname]
+    
+    article = articles(:ninth)
+    
+    assert article.save
+  end
+
+  def test_validations_against_owner
+    page = sections(:ruby).pages.build(:title => 'a test page about rails specifically')
+    
+    assert !page.save
+    
+    assert_equal 'already exists', page.errors[:urlname]
+
+    Page.send(:acts_as_urlnameable, :title, :validate => :section)
+
+    page = sections(:ruby).pages.build(:title => 'a test page about rails specifically')
+
+    assert page.save
+    
+    page = sections(:rails).pages.build(:title => 'a test page about rails specifically')
+    
+    assert !page.save
+  end
+
+  def test_with_single_table_inheritance
+    press_release = PressRelease.new( :title => 'testing single table inheritance',
+                                      :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+                                      
+    assert press_release.save
+    
+    assert_equal press_release, Article.find_by_urlname('testing_single_table_inheritance')
+    
+    assert_nil PressRelease.find_by_urlname('first_test_article_edit')
+    
+    assert_not_nil Article.find_by_urlname('first_test_article_edit')
+
+    press_release = PressRelease.new( :title => 'first test article edit',
+                                      :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+                                      
+    assert !press_release.save
+    
+    PressRelease.send(:acts_as_urlnameable, :title, :mode => :multiple, :validate => :sti_class)
+    
+    assert press_release.save
+
+    assert_equal 1, PressRelease.find_all_by_urlname('first_test_article_edit').size
+    assert_equal 2, Article.find_all_by_urlname('first_test_article_edit').size
+  end
+
+  def test_bad_reflection
+    bad_page = BadPage.new( :title => 'Testing bad association validation', 
+                            :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+    
+    assert_raise(ArgumentError) { bad_page.save }
+    
+    badder_page = BadderPage.new( :title => "Testing bad association validation - can't reflect the has_many or has_one association", 
+                                  :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+                                  
+    assert_raise(ArgumentError) { badder_page.save }
+  end
+
+  def test_custom_owner_association
+    article = people(:first).custom_articles.build( :title => 'Testing custom association validation', 
+                                                    :body => 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Proin adipiscing mi ac neque.')
+                                                    
+    assert article.save
+    
+    assert_not_nil SpecialArticle.find_by_urlname('testing_custom_association_validation')
+    
+    article = people(:first).custom_articles.build( :title => 'Testing custom association validation', 
+                                                    :body => 'This urlname should already exist now')
+    
+    assert !article.save
+
+    assert_equal 'already exists', article.errors[:urlname]
+  end
+
+  def test_finder_scoping
+    assert_equal 2, Page.find_all_by_urlname('test_for_multiple_finder').size
+    
+    Page.with_scope(:find => { :conditions => ['section_id = ?', 2] }) do
+      assert_equal 1, Page.find_all_by_urlname('test_for_multiple_finder').size
+    end 
+  end
+
+  def test_custom_validator
+    person = PersonWithCustomValidation.new(:full_name => 'Hobo Joe')
+    
+    assert !person.save
+    
+    assert_equal "is invalid. You've got it all wrong! I'm not a name, I AM a number!", person.errors[:urlname]
+  end
+  
+  def test_custom_urlnameify
+    writer = Writer.new(:full_name => 'candy', :password => 'password')
+    
+    assert writer.save
+    
+    assert_not_nil Writer.find_by_urlname('writer_candy')
+  end
+  
+end

data/vendor/plugins/acts_as_urlnameable/test/connection.rb

@@ -0,0 +1,8 @@
+print "Using in memory SQLite 3\n"
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/debug.log')
+ActiveRecord::Base.establish_connection(:adapter  => 'sqlite3', :database => ':memory:')
+load File.dirname(__FILE__) + "/fixtures/schema.rb"
+require File.dirname(__FILE__) + '/../db/00x_add_urlnames_table.rb'
+AddUrlnamesTable.up

data/vendor/plugins/acts_as_urlnameable/test/fixtures/article.rb

@@ -0,0 +1,13 @@
+class Article < ActiveRecord::Base
+  belongs_to :person
+  acts_as_urlnameable :title, :mode => :multiple
+  
+end
+
+class PressRelease < Article
+  
+end
+
+class SpecialArticle < Article
+  acts_as_urlnameable :title, :mode => :multiple, :validate => :person, :owner_association => :custom_articles
+end

data/vendor/plugins/acts_as_urlnameable/test/fixtures/articles.yml

@@ -0,0 +1,62 @@
+first:
+  id: 1
+  title: first test article
+  body: this is the first testing article
+  person_id: 1
+  comments_enabled: 1
+  
+second:
+  id: 2
+  title: second test article
+  body: this is the second testing article
+  person_id: 1
+  comments_enabled: 1
+  
+third:
+  id: 3
+  title: third test article
+  body: this is the third testing article
+  person_id: 1
+  comments_enabled: 0
+  
+fourth:
+  id: 4
+  title: fourth test article
+  body: this is the fourth testing article
+  person_id: 2
+  comments_enabled: 1
+  
+fifth:
+  id: 5
+  title: fifth test article
+  body: this is the fifth testing article
+  person_id: 2
+  comments_enabled: 1
+  
+sixth:
+  id: 6
+  title: sixth test article
+  body: this is the sixth testing article
+  person_id: 2
+  comments_enabled: 0
+  
+seventh:
+  id: 7
+  title: seventh test article
+  body: this is the seventh testing article
+  person_id: 1
+  comments_enabled: 1
+  
+eighth:
+  id: 8
+  title: eighth test article
+  body: this is the eighth testing article
+  person_id: 2
+  comments_enabled: 0
+  
+ninth:
+  id: 9
+  title: ninth test article
+  body: this is the ninth testing article
+  person_id: 1
+  comments_enabled: 1