acts-as-taggable-on 1.0.12 → 1.0.13

data/README.rdoc

@@ -137,6 +137,39 @@ Tags can have owners:
     @some_user.owned_taggings
     @some_user.owned_tags
     @some_photo.locations_from(@some_user)
+    
+=== Tag cloud calculations
+
+To construct tag clouds, the frequency of each tag needs to be calculated.
+Because we specified +acts_as_taggable_on+ on the <tt>User</tt> class, we can
+get a calculation of all the tag counts by using <tt>User.tag_counts_on(:customs)</tt>. But what if we wanted a tag count for
+an single user's posts? To achieve this we call tag_counts on the association:
+
+  User.find(:first).posts.tag_counts_on(:tags)
+
+A helper is included to assist with generating tag clouds.
+
+Here is an example that generates a tag cloud.
+
+Controller:
+
+  class PostController < ApplicationController
+    def tag_cloud
+      @tags = Post.tag_counts_on(:tags)
+    end
+  end
+
+View:
+  <% tag_cloud @tags, %w(css1 css2 css3 css4) do |tag, css_class| %>
+    <%= link_to tag.name, { :action => :tag, :id => tag.name }, :class => css_class %>
+  <% end %>
+
+CSS:
+
+  .css1 { font-size: 1.0em; }
+  .css2 { font-size: 1.2em; }
+  .css3 { font-size: 1.4em; }
+  .css4 { font-size: 1.6em; }
 
 == Contributors
 

data/Rakefile

@@ -21,3 +21,9 @@ task :default => :spec
 Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList["spec/**/*_spec.rb"]
 end
+
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end

data/VERSION

@@ -1 +1 @@
-1.0.12
+1.0.13

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -65,6 +65,14 @@ module ActiveRecord
                 related_tags_for('#{tag_type}', klass, options)
               end
 
+              def find_matching_contexts(search_context, result_context, options = {})
+                matching_contexts_for(search_context.to_s, result_context.to_s, self.class, options)
+              end
+              
+              def find_matching_contexts_for(klass, search_context, result_context, options = {})
+                matching_contexts_for(search_context.to_s, result_context.to_s, klass, options)
+              end
+
               def top_#{tag_type}(limit = 10)
                 tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
               end
@@ -102,10 +110,6 @@ module ActiveRecord
             alias_method_chain :reload, :tag_list
           end
         end
-
-        def is_taggable?
-          false
-        end
       end
 
       module SingletonMethods
@@ -253,10 +257,6 @@ module ActiveRecord
       module InstanceMethods
         include ActiveRecord::Acts::TaggableOn::GroupHelper
 
-        def tag_types
-          self.class.tag_types
-        end
-
         def custom_contexts
           @custom_contexts ||= []
         end
@@ -322,7 +322,26 @@ module ActiveRecord
             :order      => "count DESC"
           }.update(options)
         end
+        
+        def matching_contexts_for(search_context, result_context, klass, options = {})
+          search_conditions = matching_context_search_options(search_context, result_context, klass, options)
+
+          klass.find(:all, search_conditions)
+        end
+        
+        def matching_context_search_options(search_context, result_context, klass, options = {})
+          tags_to_find = self.tags_on(search_context).collect { |t| t.name }
 
+          exclude_self = "#{klass.table_name}.id != #{self.id} AND" if self.class == klass
+
+          { :select     => "#{klass.table_name}.*, COUNT(#{Tag.table_name}.id) AS count",
+            :from       => "#{klass.table_name}, #{Tag.table_name}, #{Tagging.table_name}",
+            :conditions => ["#{exclude_self} #{klass.table_name}.id = #{Tagging.table_name}.taggable_id AND #{Tagging.table_name}.taggable_type = '#{klass.to_s}' AND #{Tagging.table_name}.tag_id = #{Tag.table_name}.id AND #{Tag.table_name}.name IN (?) AND #{Tagging.table_name}.context = ?", tags_to_find, result_context],
+            :group      => grouped_column_names_for(klass),
+            :order      => "count DESC"
+          }.update(options)
+        end
+        
         def save_cached_tag_list
           self.class.tag_types.map(&:to_s).each do |tag_type|
             if self.class.send("caching_#{tag_type.singularize}_list?")

data/lib/acts_as_taggable_on/tag.rb

@@ -1,9 +1,12 @@
 class Tag < ActiveRecord::Base
-  has_many :taggings
+  has_many :taggings, :dependent => :destroy
   
   validates_presence_of :name
   validates_uniqueness_of :name
   
+  named_scope :named, lambda { |name| { :conditions => ["name = ?", name] } }
+  named_scope :named_like, lambda { |name| { :conditions => ["name LIKE ?", "%#{name}%"] } }
+  
   # LIKE is used for cross-database case-insensitivity
   def self.find_or_create_with_like_by_name(name)
     find(:first, :conditions => ["name LIKE ?", name]) || create(:name => name)

data/lib/acts_as_taggable_on/tagging.rb

@@ -2,5 +2,7 @@ class Tagging < ActiveRecord::Base #:nodoc:
   belongs_to :tag
   belongs_to :taggable, :polymorphic => true
   belongs_to :tagger, :polymorphic => true
+  
   validates_presence_of :context
+  validates_presence_of :tag_id
 end

data/rails/init.rb

@@ -2,5 +2,6 @@ require 'acts-as-taggable-on'
 
 ActiveRecord::Base.send :include, ActiveRecord::Acts::TaggableOn
 ActiveRecord::Base.send :include, ActiveRecord::Acts::Tagger
+ActionView::Base.send :include, TagsHelper if defined?(ActionView::Base)
 
 RAILS_DEFAULT_LOGGER.info "** acts_as_taggable_on: initialized properly."

data/spec/acts_as_taggable_on/acts_as_taggable_on_spec.rb

@@ -18,6 +18,10 @@ describe "Acts As Taggable On" do
     it "should create a class attribute for tag types" do
       @taggable.class.should respond_to(:tag_types)
     end
+    
+    it "should create an instance attribute for tag types" do
+      @taggable.should respond_to(:tag_types)
+    end
 
     it "should generate an association for each tag type" do
       @taggable.should respond_to(:tags, :skills, :languages)
@@ -119,6 +123,58 @@ describe "Acts As Taggable On" do
     end
   end
 
+  describe "Matching Contexts" do
+    it "should find objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+      taggable3 = TaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.offering_list = "one, two"
+      taggable1.save!
+
+      taggable2.need_list = "one, two"
+      taggable2.save!
+
+      taggable3.offering_list = "one, two"
+      taggable3.save!
+
+      taggable1.find_matching_contexts(:offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts(:offerings, :needs).should_not include(taggable3)
+    end
+
+    it "should find other related objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = OtherTaggableModel.create!(:name => "Taggable 2")
+      taggable3 = OtherTaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.offering_list = "one, two"
+      taggable1.save
+
+      taggable2.need_list = "one, two"
+      taggable2.save
+
+      taggable3.offering_list = "one, two"
+      taggable3.save
+
+      taggable1.find_matching_contexts_for(OtherTaggableModel, :offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts_for(OtherTaggableModel, :offerings, :needs).should_not include(taggable3)
+    end
+
+    it "should not include the object itself in the list of related objects" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+
+      taggable1.tag_list = "one"
+      taggable1.save
+
+      taggable2.tag_list = "one, two"
+      taggable2.save
+
+      taggable1.find_related_tags.should include(taggable2)
+      taggable1.find_related_tags.should_not include(taggable1)
+    end
+  end
+
   describe 'Tagging Contexts' do
     before(:all) do
       class Array

data/spec/acts_as_taggable_on/tag_spec.rb

@@ -4,8 +4,30 @@ describe Tag do
   before(:each) do
     @tag = Tag.new
     @user = TaggableModel.create(:name => "Pablo")  
+    Tag.delete_all
   end
   
+  describe "find or create by name" do
+    before(:each) do
+      @tag.name = "awesome"
+      @tag.save
+    end
+    
+    it "should find by name" do
+      Tag.find_or_create_with_like_by_name("awesome").should == @tag
+    end
+    
+    it "should find by name case insensitive" do
+      Tag.find_or_create_with_like_by_name("AWESOME").should == @tag
+    end
+    
+    it "should create by name" do
+      lambda {
+        Tag.find_or_create_with_like_by_name("epic")
+      }.should change(Tag, :count).by(1)
+    end
+  end
+
   it "should require a name" do
     @tag.valid?
     @tag.errors.on(:name).should == "can't be blank"
@@ -24,4 +46,17 @@ describe Tag do
     @tag.name = "cool"
     @tag.to_s.should == "cool"
   end
+  
+  it "have named_scope named(something)" do
+    @tag.name = "cool"
+    @tag.save!
+    Tag.named('cool').should include(@tag)
+  end
+  
+  it "have named_scope named_like(something)" do
+    @tag.name = "cool"
+    @tag.save!
+    @another_tag = Tag.create!(:name => "coolip")
+    Tag.named_like('cool').should include(@tag, @another_tag)
+  end
 end

data/spec/acts_as_taggable_on/taggable_spec.rb

@@ -5,6 +5,21 @@ describe "Taggable" do
     [TaggableModel, Tag, Tagging, TaggableUser].each(&:delete_all)
     @taggable = TaggableModel.new(:name => "Bob Jones")
   end
+
+  it "should have tag types" do
+    TaggableModel.tag_types.should == [:tags, :languages, :skills, :needs, :offerings]
+    @taggable.tag_types.should == TaggableModel.tag_types
+  end
+
+  it "should have tag_counts_on" do
+    TaggableModel.tag_counts_on(:tags).should be_empty
+    
+    @taggable.tag_list = ["awesome", "epic"]
+    @taggable.save
+
+    TaggableModel.tag_counts_on(:tags).count.should == 2
+    @taggable.tag_counts_on(:tags).count.should == 2
+  end
   
   it "should be able to create tags" do
     @taggable.skill_list = "ruby, rails, css"

data/spec/acts_as_taggable_on/tagging_spec.rb

@@ -4,4 +4,13 @@ describe Tagging do
   before(:each) do
     @tagging = Tagging.new
   end
+  
+  it "should not be valid with a invalid tag" do
+    @tagging.taggable = TaggableModel.create(:name => "Bob Jones")
+    @tagging.tag = Tag.new(:name => "")
+    @tagging.context = "tags"
+
+    @tagging.should_not be_valid
+    @tagging.errors.on(:tag_id).should == "can't be blank"
+  end
 end

data/spec/acts_as_taggable_on/tags_helper_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TagsHelper do
+  before(:each) do
+    [TaggableModel, Tag, Tagging].each(&:delete_all)
+    
+    @bob = TaggableModel.create(:name => "Bob Jones",  :language_list => "ruby, php")
+    @tom = TaggableModel.create(:name => "Tom Marley", :language_list => "ruby, java")
+    @eve = TaggableModel.create(:name => "Eve Nodd",   :language_list => "ruby, c++")
+    
+    @helper = class Helper
+      include TagsHelper
+    end.new
+    
+    
+  end
+  
+  it "should yield the proper css classes" do 
+    tags = { }
+    
+    @helper.tag_cloud(TaggableModel.tag_counts_on(:languages), ["sucky", "awesome"]) do |tag, css_class|
+      tags[tag.name] = css_class
+    end
+    
+    tags["ruby"].should == "awesome"
+    tags["java"].should == "sucky"
+    tags["c++"].should == "sucky"
+    tags["php"].should == "sucky"
+  end
+end

data/spec/spec_helper.rb

@@ -22,12 +22,15 @@ $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), '..', 'init')
 
 class TaggableModel < ActiveRecord::Base
-  acts_as_taggable_on :tags, :languages
+  acts_as_taggable
+  acts_as_taggable_on :languages
   acts_as_taggable_on :skills
+  acts_as_taggable_on :needs, :offerings
 end
 
 class OtherTaggableModel < ActiveRecord::Base
   acts_as_taggable_on :tags, :languages
+  acts_as_taggable_on :needs, :offerings
 end
 
 class InheritingTaggableModel < TaggableModel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts-as-taggable-on
 version: !ruby/object:Gem::Version 
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 -05:00
+date: 2009-12-11 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -44,6 +44,7 @@ files:
 - spec/acts_as_taggable_on/taggable_spec.rb
 - spec/acts_as_taggable_on/tagger_spec.rb
 - spec/acts_as_taggable_on/tagging_spec.rb
+- spec/acts_as_taggable_on/tags_helper_spec.rb
 - spec/schema.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -84,5 +85,6 @@ test_files:
 - spec/acts_as_taggable_on/taggable_spec.rb
 - spec/acts_as_taggable_on/tagger_spec.rb
 - spec/acts_as_taggable_on/tagging_spec.rb
+- spec/acts_as_taggable_on/tags_helper_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb