ismasan-sluggable_finder 2.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-11-03
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.markdown
+Rakefile
+lib/sluggable_finder.rb
+lib/sluggable_finder/finder.rb
+lib/sluggable_finder/orm.rb
+script/console
+script/destroy
+script/generate
+spec/sluggable_finder_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+tasks/db.rake

data/PostInstall.txt

@@ -0,0 +1,4 @@
+
+For more information on sluggable_finder, see http://github.com/ismasan/sluggable-finder or the README file
+
+If you want to contribute don't forget to add your specs!

data/README.markdown

@@ -0,0 +1,117 @@
+## sluggable_finder
+
+Ismael Celis 
+
+http://github.com/ismasan/sluggable_finder
+
+## DESCRIPTION:
+
+This is a variation of acts_as_sluggable, permalink_fu and acts_as_permalink. 
+This plugin allows models to generate a unique "slug" (url-enabled name) from any regular attribute.
+Sluggable models can have a scope parameter so slugs are unique relative to a parent model.
+
+The plugin intercepts ActiveRecord::Base.find to look into the slug field if passed a single string as an argument. It works as normal if you pass an integer or more finder parameters.
+
+The plugin modifies to_param so it's transparent to link_to and url_for view helpers
+
+## FEATURES/PROBLEMS:
+
+Slugs are created when a model is created. Subsequent changes to the source field will not modify the slug unless you specifically change the value of the slug field. This is because permalinks should never change.
+
+Complete specs. To test, make sure you create an empty SQLite database file in spec/db/test.db
+
+Then run the following to load the test schema:
+
+rake db:create
+
+## SYNOPSIS:
+
+### Models
+    class Category < ActiveRecord::Base
+		has_many :posts
+		sluggable_finder :title #slugifies the :title field into the :slug field
+	end
+
+	class Post < ActiveRecord::Base
+		belongs_to :category
+		has_many :comments
+		sluggable_finder :title, :scope => :category_id #Post slugs are unique to the parent category
+	end
+
+	class Comment < ActiveRecord::Base
+		belongs_to :post
+		sluggable_finder :get_slug, :to => :permalink #creates slug from custom attribute and stores it in "permalink" field
+
+		def get_slug #we define the custom attribute
+			"#{post.id}-#{Time.now}"
+		end
+	end
+
+	# Provide a list or reserved slugs you don't want available as permalinks
+	#
+	sluggable_finder :title, :reserved_slugs => %w(admin settings users)
+
+### Controllers
+
+You can do Model.find(slug) just how you would with a single numerical ID. It will also raise a RecordNotFound exception so you can handle that in your application controller.
+The idea is that you keep your controller actions clean and handle Not Found errors elsewhere. You can still use Model.find the regular way.
+
+    class PostsController < ApplicationController
+        # params[:id] is a string, URL-encoded slug
+		def show
+			@post = Post.find( params[:id] ) #raises ActiveRecord::RecordNotFound if not found
+		end  
+	end
+
+### Links
+
+Link generation remains the same, because the plugin overwrites your model's to_param method
+
+    <%= link_to h(@post.title), @post %> # => <a href="/posts/hello-world">Hello world</a>
+
+## REQUIREMENTS:
+
+ActiveRecord, ActiveSupport
+
+## INSTALL:
+
+At the moment this is not available in Github's gem repository, so you'll need to install manually:
+
+    git clone git://github.com/ismasan/sluggable-finder.git
+    cd sluggable_finder
+    gem build sluggable_finder.gemspec
+    sudo gem install sluggable_finder.gem
+
+
+Then, in your Rails app's environment:
+
+    config.gem 'sluggable_finder'
+
+If you wan to unpack the gem to you app's "vendor" directory:
+
+    rake gems:unpack
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Ismael Celis
+
+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,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/sluggable_finder'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('sluggable_finder', SluggableFinder::VERSION) do |p|
+  p.developer('Ismael Celis', 'ismaelct@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/sluggable_finder.rb

@@ -0,0 +1,42 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module SluggableFinder
+  VERSION = '2.0.0'
+  
+  class << self
+    
+    def enable_activerecord
+      ActiveRecord::Base.extend SluggableFinder::Finder
+      ActiveRecord::Base.class_eval{include SluggableFinder::Orm}
+      # support for associations
+      a = ActiveRecord::Associations
+      returning([ a::AssociationCollection ]) { |classes|
+        # detect http://dev.rubyonrails.org/changeset/9230
+        unless a::HasManyThroughAssociation.superclass == a::HasManyAssociation
+          classes << a::HasManyThroughAssociation
+        end
+      }.each do |klass|
+        klass.send :include, SluggableFinder::Finder
+        klass.class_eval { alias_method_chain :find, :slug }
+      end
+      
+    end
+    
+  end
+  
+  def self.encode(str)
+    ActiveSupport::Multibyte::Handlers::UTF8Handler.
+    		normalize(str,:d).split(//u).reject { |e| e.length > 1 }.join.strip.gsub(/[^a-z0-9]+/i, '-').downcase
+  end
+  
+end
+
+require 'rubygems'
+require 'active_record'
+
+Dir.glob('lib/sluggable_finder/*.rb').each do |file|
+  require file
+end
+
+SluggableFinder.enable_activerecord if (defined?(ActiveRecord) && !ActiveRecord::Base.respond_to?(:sluggable_finder))

data/lib/sluggable_finder/finder.rb

@@ -0,0 +1,17 @@
+module SluggableFinder
+  # This module is included by the base class as well as AR asociation collections
+  #
+  module Finder
+    
+    def find_with_slug(*args)
+      if (args.first.is_a?(String) and !(args.first =~ /\A\d+\Z/))#only contain digits
+          options = {:conditions => ["#{ sluggable_finder_options[:to]} = ?", args.first]}
+          first(options) or 
+            raise ActiveRecord::RecordNotFound.new("There is no #{sluggable_finder_options[:sluggable_type]} with #{sluggable_finder_options[:to]} '#{args.first}'")
+      else
+        find_without_slug(*args)
+      end
+    end
+  end
+  
+end

data/lib/sluggable_finder/orm.rb

@@ -0,0 +1,111 @@
+module SluggableFinder
+  module Orm
+    
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval{include InstanceMethods}
+      class << base
+        alias_method_chain :find, :slug
+      end
+    end
+    
+    module ClassMethods
+
+      def sluggable_finder(field = :title, options = {})
+        write_inheritable_attribute(:sluggable_finder_options, {
+          :sluggable_type => ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s,
+          :from		        =>	field,
+        	:scope		      => 	nil,
+        	:to			        =>  :slug,
+        	:reserved_slugs => []
+        }.merge( options ))
+        class_inheritable_reader :sluggable_finder_options
+
+        if sluggable_finder_options[:scope]
+          scope_condition_method = %(
+            def scope_condition
+                "#{sluggable_finder_options[:scope].to_s} = \#{#{sluggable_finder_options[:scope].to_s}}"
+            end
+          )
+        else
+          scope_condition_method = %(
+            def scope_condition 
+              '1 = 1'
+            end
+          )
+        end
+
+        class_eval <<-EOV
+
+          def slugable_class
+            ::#{self.name}
+          end
+
+          def source_column
+            "#{sluggable_finder_options[:from]}"
+          end
+
+          def destination_column
+            "#{sluggable_finder_options[:to]}"
+          end
+
+          def the_scope
+            "#{sluggable_finder_options[:scope]}"
+          end
+
+          def to_param
+          	send("#{sluggable_finder_options[:to]}")
+          end
+
+          #{scope_condition_method}
+
+          after_validation :set_slug
+        EOV
+
+      end
+
+    end
+    
+    module InstanceMethods
+
+
+      def set_slug
+        s = self.create_sluggable_slug
+        write_attribute(destination_column, s)
+      end
+
+      def create_sluggable_slug
+        suffix = ''
+        begin
+        proposed_slug = if self.send(destination_column.to_sym).blank?
+          SluggableFinder.encode self.send(source_column.to_sym)
+        else
+          SluggableFinder.encode self.send(destination_column.to_sym)
+        end
+        rescue Exception => e
+        	raise e
+        end
+        cond = if new_record?
+          ''
+        else
+          "id != #{id} AND "
+        end
+        slugable_class.transaction do
+          #case insensitive
+          existing = slugable_class.find(:first, :conditions => ["#{cond}#{destination_column} LIKE ? and #{scope_condition}",  proposed_slug + suffix])
+          while existing != nil or sluggable_finder_options[:reserved_slugs].include?(proposed_slug + suffix)
+            if suffix.empty?
+              suffix = "-2"
+            else
+              suffix.succ!
+            end
+            existing = slugable_class.find(:first, :conditions => ["#{cond}#{destination_column} = ? and #{scope_condition}",  proposed_slug + suffix])
+          end
+        end # end of transaction         
+        proposed_slug + suffix
+      end
+
+    end
+    
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sluggable_finder.rb'}"
+puts "Loading sluggable_finder gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/sluggable_finder_spec.rb

@@ -0,0 +1,194 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+ActiveRecord::Base.establish_connection(
+  :adapter=>'sqlite3',
+  :dbfile=> File.join(File.dirname(__FILE__),'db','test.db')
+)
+
+LOGGER = Logger.new(File.dirname(__FILE__)+'/log/test.log')
+ActiveRecord::Base.logger = LOGGER
+
+# A test Model according to test schema in db/test.db
+#
+class Item < ActiveRecord::Base
+  named_scope :published, :conditions => {:published => true}
+end
+
+# Simple slug
+#
+class SimpleItem < Item
+  sluggable_finder :title, :reserved_slugs => ['admin','settings'] # defaults :to => :slug
+end
+
+# Slug from virtual attribute
+#
+class VirtualItem < Item
+  sluggable_finder :some_method
+  
+  def some_method
+    "#{self.class.name} #{title}"
+  end
+  
+end
+
+# This one saves slug into 'permalink' field
+#
+class PermalinkItem < Item
+  sluggable_finder :title, :to => :permalink
+end
+
+# A top level object to test scoped slugs
+#
+class Category < ActiveRecord::Base
+  has_many :scoped_items
+end
+
+class ScopedItem < Item
+  belongs_to :category
+  sluggable_finder :title, :scope => :category_id
+end
+
+describe SimpleItem, 'encoding permalinks' do
+  before(:each) do
+    Item.delete_all
+    @item = SimpleItem.create!(:title => 'Hello World')
+    @item2 = SimpleItem.create(:title => 'Hello World')
+    @item3 = SimpleItem.create(:title => 'Admin')
+  end
+  
+  it "should connect to test sqlite db" do
+    Item.count.should == 3
+  end
+  
+  it "should create unique slugs" do
+    @item.slug.should == 'hello-world'
+    @item2.slug.should == 'hello-world-2'
+  end
+  
+  it "should define to_param to return slug" do
+    @item.to_param.should == 'hello-world'
+  end
+  
+  it "should raise ActiveRecord::RecordNotFound" do
+    SimpleItem.create!(:title => 'Hello World')
+    lambda {
+      SimpleItem.find 'non-existing-slug'
+    }.should raise_error(ActiveRecord::RecordNotFound)
+  end
+  
+  it "should find normally by ID" do
+    SimpleItem.find(@item.id).should == @item
+  end
+  
+  it "should by ID even if ID is string" do
+    SimpleItem.find(@item.id.to_s).should == @item
+  end
+  
+  it "should not create reserved slug" do
+    lambda {
+      SimpleItem.find 'admin'
+    }.should raise_error(ActiveRecord::RecordNotFound)
+    SimpleItem.find('admin-2').to_param.should == @item3.to_param
+  end
+  
+  it "should keep original slugs" do
+    @item.title = 'some other title'
+    @item.save
+    @item.to_param.should == 'hello-world'
+  end
+end
+
+describe SimpleItem, "with non-english characters" do
+  before(:each) do
+    @item = SimpleItem.create!(:title => "Un ñandú super ñoño I've seen")
+  end
+  
+  it "should turn them to english characters" do
+    @item.to_param.should == "un-nandu-super-nono-i-ve-seen"
+  end
+end
+
+describe VirtualItem, 'using virtual fields as permalink source' do
+  before(:each) do
+    Item.delete_all
+    @item = VirtualItem.create!(:title => 'prefixed title')
+  end
+  
+  it "should generate slug from a virtual attribute" do
+    @item.to_param.should == 'virtualitem-prefixed-title'
+  end
+  
+  it "should find by slug" do
+    VirtualItem.find('virtualitem-prefixed-title').to_param.should == @item.to_param
+  end
+end
+
+describe PermalinkItem,'writing to custom field' do
+  before(:each) do
+    Item.delete_all
+    @item = PermalinkItem.create! :title => 'Hello World'
+  end
+  
+  it "should create slug in custom field if provided" do
+    
+    @item.permalink.should == 'hello-world'
+    @item.slug.should == nil
+  end
+end
+
+describe ScopedItem,'scoped to parent object' do
+  before(:each) do
+    Item.delete_all
+    @category1 = Category.create!(:name => 'Category one')
+    @category2 = Category.create!(:name => 'Category two')
+    # Lets create 3 items with the same title, two of them in the same category
+    @item1 = @category1.scoped_items.create!(:title => 'A scoped item',:published => true)
+    @item2 = @category1.scoped_items.create!(:title => 'A scoped item', :published => false)
+    @item3 = @category2.scoped_items.create!(:title => 'A scoped item')
+  end
+  
+  it "should scope slugs to parent items" do
+    @item1.to_param.should == 'a-scoped-item'
+    @item2.to_param.should == 'a-scoped-item-2' # because this slug is not available for this category
+    @item3.to_param.should == 'a-scoped-item'
+  end
+  
+  it "should include sluggable methods in collections" do
+    @category1.scoped_items.respond_to?(:find_with_slug).should == true 
+  end
+  
+  it "should find by scoped slug" do
+    item1 = @category1.scoped_items.find('a-scoped-item')
+    item1.to_param.should == @item1.to_param
+  end
+  
+  it "should find published one (named scope)" do
+    @category1.scoped_items.published.find('a-scoped-item').to_param.should == @item1.to_param
+  end
+  
+  it "should not find unpublished one (named scope)" do
+    lambda{
+      @category1.scoped_items.published.find('a-scoped-item-2')
+    }.should raise_error(ActiveRecord::RecordNotFound)
+  end
+end
+
+describe SimpleItem, 'with AR named scopes' do
+  before(:each) do
+    Item.delete_all
+    @published_one  = SimpleItem.create! :title => 'published 1',:published => true
+    @published_two  = SimpleItem.create! :title => 'published 2',:published => true
+    @unpublished    = SimpleItem.create! :title => 'not published',:published => false
+  end
+  
+  it "should find published ones" do
+    SimpleItem.published.find('published-1').to_param.should == @published_one.to_param
+    SimpleItem.published.find('published-2').to_param.should == @published_two.to_param
+  end
+  
+  it "should not find unpublished ones" do
+    lambda {
+      SimpleItem.published.find('not-published')
+    }.should raise_error(ActiveRecord::RecordNotFound)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'sluggable_finder'

data/tasks/db.rake

@@ -0,0 +1,35 @@
+ActiveRecord::Base.establish_connection(
+  :adapter=>'sqlite3',
+  :dbfile=> File.join(File.dirname(__FILE__),'..','spec','db','test.db')
+)
+# define a migration
+class TestSchema < ActiveRecord::Migration
+  def self.up
+    create_table :items do |t|
+      t.string :title
+      t.string :slug
+      t.string :permalink
+      t.boolean :published
+      t.integer :category_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :items
+  end
+end
+
+
+namespace :db do
+  desc "Create test schema"
+  task :create => :destroy do
+    # run the migration
+    TestSchema.migrate(:up)
+  end
+  
+  desc "Destroy test schema"
+  task :destroy do
+    TestSchema.migrate(:down)
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: ismasan-sluggable_finder
+version: !ruby/object:Gem::Version 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Ismael Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: 
+email: 
+- ismaelct@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.markdown
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.markdown
+- Rakefile
+- lib/sluggable_finder.rb
+- lib/sluggable_finder/finder.rb
+- lib/sluggable_finder/orm.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/sluggable_finder_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- tasks/db.rake
+has_rdoc: false
+homepage: 
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: sluggable_finder
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Automatically create SEO friendly, unique permalinks for your ActiveRecord objects. Behaves exactly as ActiveRecord#find
+test_files: []
+