citrusbyte-is_taggable 0.85

data/lib/is_taggable/is_tagger.rb

@@ -0,0 +1,49 @@
+module ActiveRecord
+  module Is
+    module Tagger
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        def is_tagger(opts={})
+          has_many :owned_taggings, opts.merge(:as => :tagger, :dependent => :destroy, :class_name => "Tagging")
+          include ActiveRecord::Is::Tagger::InstanceMethods
+          extend ActiveRecord::Is::Tagger::SingletonMethods       
+        end
+        
+        def is_tagger?
+          false
+        end
+      end
+      
+      module InstanceMethods
+        def self.included(base)
+        end
+        
+        def tag(taggable, opts={})
+          opts.reverse_merge!(:force => true)
+
+          return false unless taggable.respond_to?(:is_taggable?) && taggable.is_taggable?
+          raise "You need to specify a tag context using :on" unless opts.has_key?(:on)
+          raise "You need to specify some tags using :with" unless opts.has_key?(:with)
+          raise "No context :#{opts[:on]} defined in #{taggable.class.to_s}" unless (opts[:force] || taggable.tag_types.include?(opts[:on]))
+
+          taggable.set_tag_list_on(opts[:on].to_s, opts[:with], self)
+          taggable.save
+        end
+        
+        def is_tagger?
+          self.class.is_tagger?
+        end
+      end
+      
+      module SingletonMethods
+        def is_tagger?
+          true
+        end
+      end
+      
+    end
+  end
+end

data/lib/is_taggable/tag_list.rb

@@ -0,0 +1,107 @@
+class TagList < Array
+  cattr_accessor :delimiter
+  self.delimiter = ','
+
+  def initialize(*args)
+    add(*args)
+  end
+
+  attr_accessor :owner
+
+  # Add tags to the tag_list. Duplicate or blank tags will be ignored.
+  #
+  #   tag_list.add("Fun", "Happy")
+  #
+  # Use the <tt>:parse</tt> option to add an unparsed tag string.
+  #
+  #   tag_list.add("Fun, Happy", :parse => true)
+  def add(*names)
+    extract_and_apply_options!(names)
+    concat(names)
+    clean!
+    self
+  end
+
+  # Remove specific tags from the tag_list.
+  #
+  #   tag_list.remove("Sad", "Lonely")
+  #
+  # Like #add, the <tt>:parse</tt> option can be used to remove multiple tags in a string.
+  #
+  #   tag_list.remove("Sad, Lonely", :parse => true)
+  def remove(*names)
+    extract_and_apply_options!(names)
+    delete_if { |name| names.include?(name) }
+    self
+  end
+
+  # Transform the tag_list into a tag string suitable for edting in a form.
+  # The tags are joined with <tt>TagList.delimiter</tt> and quoted if necessary.
+  #
+  #   tag_list = TagList.new("Round", "Square,Cube")
+  #   tag_list.to_s # 'Round, "Square,Cube"'
+  def to_s
+    clean!
+
+    map do |name|
+      name.include?(delimiter) ? "\"#{name}\"" : name
+    end.join(delimiter.ends_with?(" ") ? delimiter : "#{delimiter} ")
+  end
+  
+  def normalized
+    TagList.new(collect{ |tag| self.class.normalize(tag) })
+  end
+  
+ private
+  # Remove whitespace, duplicates, and blanks.
+  def clean!
+    reject!(&:blank?)
+    map!(&:strip)
+    uniq!
+  end
+
+  def extract_and_apply_options!(args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options.assert_valid_keys :parse
+
+    if options[:parse]
+      args.map! { |a| self.class.from(a) }
+    end
+
+    args.flatten!
+  end
+  
+  class << self
+    # Returns a new TagList using the given tag string.
+    #
+    #   tag_list = TagList.from("One , Two,  Three")
+    #   tag_list # ["One", "Two", "Three"]
+    def from(string)
+      returning new do |tag_list|
+        string = string.to_s.dup
+
+        # Parse the quoted tags
+        string.gsub!(/"(.*?)"\s*#{delimiter}?\s*/) { tag_list << $1; "" }
+        string.gsub!(/'(.*?)'\s*#{delimiter}?\s*/) { tag_list << $1; "" }
+
+        tag_list.add(string.split(delimiter))
+      end
+    end
+
+    def from_owner(owner, *tags)
+      returning from(*tags) do |taglist|
+        taglist.owner = owner
+      end
+    end
+
+    def new_from_owner(owner, *tags)
+      returning new(*tags) do |taglist|
+        taglist.owner = owner
+      end
+    end
+    
+    def normalize(tag)
+      tag.gsub(/\s+/, ' ').to_ascii.downcase.gsub(/[^a-z0-9\-\s]/, '')
+    end
+  end
+end

data/lib/is_taggable/tagging.rb

@@ -0,0 +1,31 @@
+class Tagging < ActiveRecord::Base #:nodoc:
+  belongs_to :taggable, :polymorphic => true
+  belongs_to :tagger, :polymorphic => true
+  
+  # these validations are useless since we don't save tags this way...
+  validates_presence_of :context
+  validates_presence_of :tag
+  validates_presence_of :normalized
+  validates_uniqueness_of :normalized, :scope => [ :context, :taggable_type, :taggable_id ]
+  
+  def tag=(tag)
+    self[:tag] = tag
+    self[:normalized] = TagList.normalize(tag)
+  end
+  
+  def context
+    self[:context] ? self[:context].to_sym : nil
+  end
+  
+  def to_s
+    tag
+  end
+  
+  def count
+    read_attribute(:count).to_i
+  end
+  
+  def save
+    raise "Taggings are protected from being created individually, please use the tagging methods on Taggable objects"
+  end
+end

data/lib/is_taggable/tags_helper.rb

@@ -0,0 +1,11 @@
+module TagsHelper
+  # See the README for an example using tag_cloud.
+  def tag_cloud(tags, classes)
+    max_count = tags.sort_by(&:count).last.count.to_f
+    
+    tags.each do |tag|
+      index = ((tag.count / max_count) * (classes.size - 1)).round
+      yield tag, classes[index]
+    end
+  end
+end

data/lib/is_taggable.rb

@@ -0,0 +1,6 @@
+require 'is_taggable/is_taggable'
+require 'is_taggable/is_tagger'
+require 'is_taggable/tag_list'
+require 'is_taggable/tags_helper'
+require 'is_taggable/tagging'
+require 'is_taggable/string'

data/rails/init.rb

@@ -0,0 +1,6 @@
+require 'is_taggable'
+
+ActiveRecord::Base.send :include, ActiveRecord::Is::Taggable
+ActiveRecord::Base.send :include, ActiveRecord::Is::Tagger
+
+RAILS_DEFAULT_LOGGER.info "** is_taggable: initialized properly."

data/spec/is_taggable/is_taggable_spec.rb

@@ -0,0 +1,170 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Is Taggable" do
+  it "should provide a class method 'taggable?' that is false for untaggable models" do
+    UntaggableModel.should_not be_taggable
+  end
+
+  describe "Taggable Method Generation" do
+    before(:each) do
+      [TaggableModel, Tagging, TaggableUser].each(&:delete_all)
+      @taggable = TaggableModel.new(:name => "Bob Jones")
+    end
+
+    it "should respond 'true' to taggable?" do
+      @taggable.class.should be_taggable
+    end
+
+    it "should create a class attribute for tag types" do
+      @taggable.class.should respond_to(:tag_types)
+    end
+
+    it "should generate an association for each tag type" do
+      @taggable.should respond_to(:tags, :skills, :languages)
+    end
+
+    it "should generate a cached column checker for each tag type" do
+     TaggableModel.should respond_to(:caching_tag_list?, :caching_skill_list?, :caching_language_list?)
+    end
+
+    it "should add tagged_with and tag_counts to singleton" do
+      TaggableModel.should respond_to(:find_tagged_with, :tag_counts)
+    end
+
+    it "should add saving of tag lists and cached tag lists to the instance" do
+      @taggable.should respond_to(:save_cached_tag_list)
+      @taggable.should respond_to(:save_tags)
+    end
+
+    it "should generate a tag_list accessor/setter for each tag type" do
+      @taggable.should respond_to(:tag_list, :skill_list, :language_list)
+      @taggable.should respond_to(:tag_list=, :skill_list=, :language_list=)
+    end
+
+    it "should generate a tags accessor/setter for each tag type" do
+      @taggable.should respond_to(:tags, :skills, :languages)
+      @taggable.should respond_to(:tags=, :skills=, :languages=)
+    end
+
+  end
+
+  describe "Single Table Inheritance" do
+    before do
+      @taggable = TaggableModel.new(:name => "taggable")
+      @inherited_same = InheritingTaggableModel.new(:name => "inherited same")
+      @inherited_different = AlteredInheritingTaggableModel.new(:name => "inherited different")
+    end
+
+    it "should pass on tag contexts to STI-inherited models" do
+      @inherited_same.should respond_to(:tag_list, :skill_list, :language_list)
+      @inherited_different.should respond_to(:tag_list, :skill_list, :language_list)
+    end
+
+    it "should have tag contexts added in altered STI models" do
+      @inherited_different.should respond_to(:part_list)
+    end
+  end
+
+  describe "Reloading" do
+    it "should save a model instantiated by Model.find" do
+      taggable = TaggableModel.create!(:name => "Taggable")
+      found_taggable = TaggableModel.find(taggable.id)
+      found_taggable.save
+    end
+  end
+
+  describe "Related Objects" do
+    it "should find related objects based on tag names on context" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+      taggable3 = TaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.tag_list = "one, two"
+      taggable1.save
+
+      taggable2.tag_list = "three, four"
+      taggable2.save
+
+      taggable3.tag_list = "one, four"
+      taggable3.save
+
+      taggable1.find_related_tags.should include(taggable3)
+      taggable1.find_related_tags.should_not include(taggable2)
+    end
+
+    it "should find other related objects based on tag names on context" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = OtherTaggableModel.create!(:name => "Taggable 2")
+      taggable3 = OtherTaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.tag_list = "one, two"
+      taggable1.save
+
+      taggable2.tag_list = "three, four"
+      taggable2.save
+
+      taggable3.tag_list = "one, four"
+      taggable3.save
+
+      taggable1.find_related_tags_for(OtherTaggableModel).should include(taggable3)
+      taggable1.find_related_tags_for(OtherTaggableModel).should_not include(taggable2)
+    end
+  end
+  
+  describe "when setting tags" do
+    before :each do
+      @taggable = TaggableModel.create!(:name => 'foo')
+    end
+    
+    it "should be settable through through tag_list=" do
+      @taggable.tag_list = 'foo, bar, baz'
+      @taggable.save
+      @taggable.reload.tags.should include('foo', 'bar', 'baz')
+    end
+
+    it "should be settable through through tags=" do
+      @taggable.tags = %w(foo bar baz)
+      @taggable.save
+      @taggable.reload.tags.should include('foo', 'bar', 'baz')
+    end
+  end
+  
+  describe 'Tagging Contexts' do
+    before(:all) do
+      class Array
+        def freq
+          k=Hash.new(0)
+          self.each {|e| k[e]+=1}
+          k
+        end
+      end
+    end
+
+    it 'should eliminate duplicate tagging contexts ' do
+      TaggableModel.is_taggable(:skills, :skills)
+      TaggableModel.tag_types.freq[:skills].should_not == 3
+    end
+
+    it "should not contain embedded/nested arrays" do
+      TaggableModel.is_taggable([:array], [:array])
+      TaggableModel.tag_types.freq[[:array]].should == 0
+    end
+
+    it "should _flatten_ the content of arrays" do
+      TaggableModel.is_taggable([:array], [:array])
+      TaggableModel.tag_types.freq[:array].should == 1
+    end
+
+
+    it "should not raise an error when passed [nil]" do
+      lambda {
+        TaggableModel.is_taggable([nil])
+      }.should_not raise_error
+    end
+
+    after(:all) do
+      class Array; remove_method :freq; end
+    end
+  end
+
+end

data/spec/is_taggable/tag_list_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TagList do
+  before(:each) do
+    @tag_list = TagList.new("awesome","radical")
+  end
+  
+  it "should be an array" do
+    @tag_list.is_a?(Array).should be_true
+  end
+  
+  it "should be able to be add a new tag word" do
+    @tag_list.add("cool")
+    @tag_list.include?("cool").should be_true
+  end
+  
+  it "should be able to add delimited lists of words" do
+    @tag_list.add("cool, wicked", :parse => true)
+    @tag_list.include?("cool").should be_true
+    @tag_list.include?("wicked").should be_true
+  end
+  
+  it "should be able to remove words" do
+    @tag_list.remove("awesome")
+    @tag_list.include?("awesome").should be_false
+  end
+  
+  it "should be able to remove delimited lists of words" do
+    @tag_list.remove("awesome, radical", :parse => true)
+    @tag_list.should be_empty
+  end
+  
+  it "should give a delimited list of words when converted to string" do
+    @tag_list.to_s.should == "awesome, radical"
+  end
+  
+  it "should quote escape tags with commas in them" do
+    @tag_list.add("cool","rad,bodacious")
+    @tag_list.to_s.should == "awesome, radical, cool, \"rad,bodacious\""
+  end
+  
+  describe "normalization" do
+    def normalized_tags(tag_list)
+      TagList.from(tag_list).normalized.to_s
+    end
+    
+    it "should lower case all tags" do
+      normalized_tags("COol, BeANs").should eql('cool, beans')
+    end
+        
+    it "should replace accented characters" do
+      normalized_tags("CÕÖl, BÈÄñs").should eql('cool, beans')
+    end
+    
+    it "should compress whitespace" do
+      normalized_tags("        c     o o l,     b     e an      s         ").should eql('c o o l, b e an s')
+    end
+    
+    it "should strip 'special' characters" do
+      normalized_tags('c%!#{*!@\&oo!@l}, #*!#**)#(!@#)bea<>><>}{}:":":ns').should eql('cool, beans')
+    end
+    
+    it "should replace ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöøùúûüýÆæ" do
+      normalized_tags('ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöøùúûüýÆæ').should eql('aaaaaaceeeeiiiidnoooooxouuuuyaaaaaaceeeeiiiinoooooouuuuyaeae')
+    end
+  end
+end

data/spec/is_taggable/taggable_spec.rb

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Taggable" do
+  before(:each) do
+    [TaggableModel, Tagging, TaggableUser].each(&:delete_all)
+    @taggable = TaggableModel.new(:name => "Bob Jones")
+  end
+  
+  it "should be able to create tags" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.instance_variable_get("@skill_list").instance_of?(TagList).should be_true
+    @taggable.save
+
+    Tagging.find(:all).size.should == 3
+  end
+  
+  it "should be able to create tags through the tag list directly" do
+    @taggable.tag_list_on(:test).add("hello")
+    @taggable.save    
+    @taggable.reload
+    @taggable.tag_list_on(:test).should == ["hello"]
+  end
+  
+  it "should differentiate between contexts" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.tag_list = "ruby, bob, charlie"
+    @taggable.save
+    @taggable.reload
+    @taggable.skill_list.include?("ruby").should be_true
+    @taggable.skill_list.include?("bob").should be_false
+  end
+  
+  it "should be able to remove tags through list alone" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.save
+    @taggable.reload
+    @taggable.should have(3).skills
+    @taggable.skill_list = "ruby, rails"
+    @taggable.save
+    @taggable.reload
+    @taggable.should have(2).skills
+  end
+  
+  it "should be able to find by tag" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.save
+    TaggableModel.find_tagged_with("ruby").first.should == @taggable
+  end
+  
+  it "should be able to find by tag with context" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.tag_list = "bob, charlie"
+    @taggable.save
+    TaggableModel.find_tagged_with("ruby").first.should == @taggable
+    TaggableModel.find_tagged_with("bob", :on => :skills).first.should_not == @taggable
+    TaggableModel.find_tagged_with("bob", :on => :tags).first.should == @taggable
+  end
+  
+  it "should be able to use the tagged_with named scope" do
+    @taggable.skill_list = "ruby, rails, css"
+    @taggable.tag_list = "bob, charlie"
+    @taggable.save
+    TaggableModel.tagged_with("ruby", {}).first.should == @taggable
+    TaggableModel.tagged_with("bob", :on => :skills).first.should_not == @taggable
+    TaggableModel.tagged_with("bob", :on => :tags).first.should == @taggable
+  end
+  
+  it "should not care about case" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "Ruby")
+    
+    Tagging.find(:all).size.should == 2
+    TaggableModel.find_tagged_with("ruby").should == TaggableModel.find_tagged_with("Ruby")
+  end
+  
+  it "should be able to get tag counts on model as a whole" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "ruby, rails")
+    charlie = TaggableModel.create(:name => "Charlie", :skill_list => "ruby")
+    TaggableModel.tag_counts.should_not be_empty
+    TaggableModel.skill_counts.should_not be_empty
+  end
+  
+  it "should be able to get tag counts on an association" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "ruby, rails")
+    charlie = TaggableModel.create(:name => "Charlie", :skill_list => "ruby")
+    bob.tag_counts.collect{ |t| t.count }.sort.should eql([1, 2, 2])
+    charlie.skill_counts.collect{ |t| t.count }.sort.should eql([1])
+  end
+  
+  it "should be able to set a custom tag context list" do
+    bob = TaggableModel.create(:name => "Bob")
+    bob.set_tag_list_on(:rotors, "spinning, jumping")
+    bob.tag_list_on(:rotors).should == ["spinning","jumping"]
+    bob.save
+    bob.reload
+    bob.taggings_on(:rotors).should_not be_empty
+  end
+  
+  it "should be able to find tagged on a custom tag context" do
+    bob = TaggableModel.create(:name => "Bob")
+    bob.set_tag_list_on(:rotors, "spinning, jumping")
+    bob.tag_list_on(:rotors).should == ["spinning","jumping"]
+    bob.save
+    TaggableModel.find_tagged_with("spinning", :on => :rotors).should_not be_empty
+  end
+  
+  describe "Single Table Inheritance" do
+    before do
+      [TaggableModel, Tagging, TaggableUser].each(&:delete_all)
+      @taggable = TaggableModel.new(:name => "taggable")
+      @inherited_same = InheritingTaggableModel.new(:name => "inherited same")
+      @inherited_different = AlteredInheritingTaggableModel.new(:name => "inherited different")
+    end
+    
+    it "should be able to save tags for inherited models" do
+      @inherited_same.tag_list = "bob, kelso"
+      @inherited_same.save
+      InheritingTaggableModel.find_tagged_with("bob").first.should == @inherited_same
+    end
+    
+    it "should find STI tagged models on the superclass" do
+      @inherited_same.tag_list = "bob, kelso"
+      @inherited_same.save
+      TaggableModel.find_tagged_with("bob").first.should == @inherited_same
+    end
+    
+    it "should be able to add on contexts only to some subclasses" do
+      @inherited_different.part_list = "fork, spoon"
+      @inherited_different.save
+      InheritingTaggableModel.find_tagged_with("fork", :on => :parts).should be_empty
+      AlteredInheritingTaggableModel.find_tagged_with("fork", :on => :parts).first.should == @inherited_different
+    end
+  end
+end

data/spec/is_taggable/tagger_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Tagger" do
+  before(:each) do
+    [TaggableModel, Tagging, TaggableUser].each(&:delete_all)
+    @user = TaggableUser.new
+    @taggable = TaggableModel.new(:name => "Bob Jones")
+  end
+  
+  it "should have taggings" do
+    @user.tag(@taggable, :with=>'ruby,scheme', :on=>:tags)
+    @user.owned_taggings.size == 2
+  end
+  
+  it "is tagger" do
+    @user.is_tagger?.should(be_true)
+  end  
+end

data/spec/is_taggable/tagging_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Tagging do
+  before(:each) do
+    @tagging = Tagging.new
+  end
+
+  it "should require a tag" do
+    @tagging.valid?
+    @tagging.should have(1).errors_on(:tag)
+  end
+  
+  it "should require a normalized version of the tag" do
+    @tagging.valid?
+    @tagging.should have(1).errors_on(:normalized)
+  end
+  
+  it "should be valid with a tag" do
+    @tagging.tag = "something"
+    @tagging.valid?
+    @tagging.should have(0).errors_on(:tag)
+  end
+  
+  it "should return its name when to_s is called" do
+    @tagging.tag = "cool"
+    @tagging.to_s.should == "cool"
+  end
+  
+  it "should raise if you try to save one even when it's valid" do
+    @tagging.tag = 'foo'
+    lambda { @tagging.save }.should raise_error
+  end
+  
+  it "should raise on create" do
+    lambda { Tagging.create :tag => 'foo' }.should raise_error
+  end
+  
+  it "should raise on update" do
+    @taggable = TaggableModel.create!(:name => "Bob Jones", :tag_list => 'bar')
+    lambda { @taggable.reload.taggings.first.update_attributes(:tag => 'foo') }.should raise_error
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,30 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "taggings", :force => true do |t|
+    t.string   "tag"
+    t.string   "normalized"
+    t.string   "context"
+    t.integer  "taggable_id",   :limit => 11
+    t.string   "taggable_type"
+    t.datetime "created_at"
+    t.integer  "tagger_id",     :limit => 11
+    t.string   "tagger_type"
+  end
+
+  add_index "taggings", ["tag"], :name => "index_taggings_on_tag"
+  add_index "taggings", ["taggable_id", "taggable_type", "context"], :name => "index_taggings_on_taggable_id_and_taggable_type_and_context"
+  add_index "taggings", ["taggable_id", "taggable_type", "context", "normalized"], :name => "index_taggings_on_taggable_and_context_and_normalized", :uniq => true
+  
+  create_table :taggable_models, :force => true do |t|
+    t.column :name, :string
+    t.column :type, :string
+    #t.column :cached_tag_list, :string
+  end
+  create_table :taggable_users, :force => true do |t|
+    t.column :name, :string
+  end
+  create_table :other_taggable_models, :force => true do |t|
+    t.column :name, :string
+    t.column :type, :string
+    #t.column :cached_tag_list, :string
+  end
+end