lwe-acts-as-taggable-on 1.0.7.lwe

data/CHANGELOG

@@ -0,0 +1,18 @@
+== 2008-07-17
+
+* Can now use a named_scope to find tags!
+
+== 2008-06-23
+
+* Can now find related objects of another class (tristanzdunn)
+* Removed extraneous down migration cruft (azabaj)
+
+== 2008-06-09
+ 
+ * Added support for Single Table Inheritance
+ * Adding gemspec and rails/init.rb for gemified plugin
+ 
+== 2007-12-12
+
+ * Added ability to use dynamic tag contexts
+ * Fixed missing migration generator

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Michael Bleigh and Intridea Inc.
+
+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/README

@@ -0,0 +1,194 @@
+ActsAsTaggableOn
+================
+
+This plugin was originally based on Acts as Taggable on Steroids by Jonathan Viney.
+It has evolved substantially since that point, but all credit goes to him for the
+initial tagging functionality that so many people have used.
+
+For instance, in a social network, a user might have tags that are called skills,
+interests, sports, and more. There is no real way to differentiate between tags and
+so an implementation of this type is not possible with acts as taggable on steroids.
+
+Enter Acts as Taggable On. Rather than tying functionality to a specific keyword
+(namely "tags"), acts as taggable on allows you to specify an arbitrary number of
+tag "contexts" that can be used locally or in combination in the same way steroids
+was used.
+
+Installation
+============
+
+Plugin
+------
+
+Acts As Taggable On is available both as a gem and as a traditional plugin. For the
+traditional plugin you can install like so (Rails 2.1 or later):
+
+  script/plugin install git://github.com/mbleigh/acts-as-taggable-on.git
+  
+For earlier versions:
+
+  git clone git://github.com/mbleigh/acts-as-taggable-on.git vendor/plugins/acts-as-taggable-on
+  
+GemPlugin
+---------
+
+Acts As Taggable On is also available as a gem plugin using Rails 2.1's gem dependencies.
+To install the gem, add this to your config/environment.rb:
+  
+  config.gem "acts-as-taggable-on", :source => "http://gemcutter.org"
+  
+After that, you can run "rake gems:install" to install the gem if you don't already have it.
+
+** NOTE **
+Some issues have been experienced with "rake gems:install". If that doesn't work to install the gem,
+try just installing it as a normal gem:
+
+  gem install acts-as-taggable-on --source http://gemcutter.org
+
+Post Installation (Rails)
+-------------------------
+1. script/generate acts_as_taggable_on_migration
+2. rake db:migrate
+
+Testing
+=======
+
+Acts As Taggable On uses RSpec for its test coverage. Inside the plugin
+directory, you can run the specs with:
+
+rake spec
+
+
+If you already have RSpec on your application, the specs will run while using:
+
+rake spec:plugins
+
+
+Example
+=======
+
+class User < ActiveRecord::Base
+  acts_as_taggable_on :tags, :skills, :interests
+end
+
+@user = User.new(:name => "Bobby")
+@user.tag_list = "awesome, slick, hefty"      # this should be familiar
+@user.skill_list = "joking, clowning, boxing" # but you can do it for any context!
+@user.skill_list # => ["joking","clowning","boxing"] as TagList
+@user.save
+
+@user.tags # => [<Tag name:"awesome">,<Tag name:"slick">,<Tag name:"hefty">]
+@user.skills # => [<Tag name:"joking">,<Tag name:"clowning">,<Tag name:"boxing">]
+
+# The old way
+User.find_tagged_with("awesome", :on => :tags) # => [@user]
+User.find_tagged_with("awesome", :on => :skills) # => []
+
+# The better way (utilizes named_scope)
+User.tagged_with("awesome", :on => :tags) # => [@user]
+User.tagged_with("awesome", :on => :skills) # => []
+
+@frankie = User.create(:name => "Frankie", :skill_list => "joking, flying, eating")
+User.skill_counts # => [<Tag name="joking" count=2>,<Tag name="clowning" count=1>...]
+@frankie.skill_counts
+
+Finding Tagged Objects
+======================
+
+Acts As Taggable On utilizes Rails 2.1's named_scope to create an association
+for tags. This way you can mix and match to filter down your results, and it
+also improves compatibility with the will_paginate gem:
+
+class User < ActiveRecord::Base
+  acts_as_taggable_on :tags
+  named_scope :by_join_date, :order => "created_at DESC"
+end
+
+User.tagged_with("awesome").by_date
+User.tagged_with("awesome").by_date.paginate(:page => params[:page], :per_page => 20)
+
+Relationships
+=============
+
+You can find objects of the same type based on similar tags on certain contexts.
+Also, objects will be returned in descending order based on the total number of 
+matched tags.
+
+@bobby = User.find_by_name("Bobby")
+@bobby.skill_list # => ["jogging", "diving"]
+
+@frankie = User.find_by_name("Frankie")
+@frankie.skill_list # => ["hacking"]
+
+@tom = User.find_by_name("Tom")
+@tom.skill_list # => ["hacking", "jogging", "diving"]
+
+@tom.find_related_skills # => [<User name="Bobby">,<User name="Frankie">]
+@bobby.find_related_skills # => [<User name="Tom">] 
+@frankie.find_related_skills # => [<User name="Tom">] 
+
+
+Dynamic Tag Contexts
+====================
+
+In addition to the generated tag contexts in the definition, it is also possible
+to allow for dynamic tag contexts (this could be user generated tag contexts!)
+
+@user = User.new(:name => "Bobby")
+@user.set_tag_list_on(:customs, "same, as, tag, list")
+@user.tag_list_on(:customs) # => ["same","as","tag","list"]
+@user.save
+@user.tags_on(:customs) # => [<Tag name='same'>,...]
+@user.tag_counts_on(:customs)
+User.find_tagged_with("same", :on => :customs) # => [@user]
+
+Tag Ownership
+=============
+
+Tags can have owners:
+
+class User < ActiveRecord::Base
+  acts_as_tagger
+end
+
+class Photo < ActiveRecord::Base
+  acts_as_taggable_on :locations
+end
+
+@some_user.tag(@some_photo, :with => "paris, normandy", :on => :locations)
+@some_user.owned_taggings
+@some_user.owned_tags
+@some_photo.locations_from(@some_user)
+
+Caveats, Uncharted Waters
+=========================
+
+This plugin is still under active development. Tag caching has not 
+been thoroughly (or even casually) tested and may not work as expected.
+
+Contributors
+============
+
+* Michael Bleigh - Original Author
+* Brendan Lim - Related Objects
+* Pradeep Elankumaran - Taggers
+* Sinclair Bain - Patch King
+
+Patch Contributors
+------------------
+
+* tristanzdunn - Related objects of other classes
+* azabaj - Fixed migrate down
+* Peter Cooper - named_scope fix
+* slainer68 - STI fix
+* harrylove - migration instructions and fix-ups
+* lawrencepit - cached tag work
+
+Resources
+=========
+
+* Acts As Community - http://www.actsascommunity.com/projects/acts-as-taggable-on
+* GitHub - http://github.com/mbleigh/acts-as-taggable-on
+* Lighthouse - http://mbleigh.lighthouseapp.com/projects/10116-acts-as-taggable-on
+
+Copyright (c) 2007 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/), released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "lwe-acts-as-taggable-on"
+    gemspec.summary = "ActsAsTaggableOn is a tagging plugin for Rails that provides multiple tagging contexts on a single model."
+    gemspec.description = "With ActsAsTaggableOn, you could tag a single model on several contexts, such as skills, interests, and awards. It also provides other advanced functionality."
+    gemspec.email = "michael@intridea.com"
+    gemspec.homepage = "http://github.com/lwe/acts-as-taggable-on"
+    gemspec.authors = ["Michael Bleigh"]
+    gemspec.files =  FileList["[A-Z]*", "{lib,spec,rails}/**/*"] - FileList["**/*.log"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Default: run specs'
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.7.lwe

data/lib/acts-as-taggable-on.rb

@@ -0,0 +1,6 @@
+require 'acts_as_taggable_on/acts_as_taggable_on'
+require 'acts_as_taggable_on/acts_as_tagger'
+require 'acts_as_taggable_on/tag'
+require 'acts_as_taggable_on/tag_list'
+require 'acts_as_taggable_on/tags_helper'
+require 'acts_as_taggable_on/tagging'

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -0,0 +1,339 @@
+module ActiveRecord
+  module Acts
+    module TaggableOn
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        def taggable?
+          false
+        end
+        
+        def acts_as_taggable
+          acts_as_taggable_on :tags
+        end
+        
+        def acts_as_taggable_on(*args)
+          args.flatten! if args
+          args.compact! if args
+          for tag_type in args
+            tag_type = tag_type.to_s
+            # use aliased_join_table_name for context condition so that sphix can join multiple
+            # tag references from same model without getting an ambiguous column error
+            self.class_eval do
+              has_many "#{tag_type.singularize}_taggings".to_sym, :as => :taggable, :dependent => :destroy, 
+                :include => :tag, :conditions => ['#{aliased_join_table_name rescue "taggings"}.context = ?',tag_type], :class_name => "Tagging"
+              has_many "#{tag_type}".to_sym, :through => "#{tag_type.singularize}_taggings".to_sym, :source => :tag, :order => "`tags`.name"
+            end
+            
+            self.class_eval <<-RUBY
+              def self.taggable?
+                true
+              end
+              
+              def self.caching_#{tag_type.singularize}_list?
+                caching_tag_list_on?("#{tag_type}")
+              end
+              
+              def self.#{tag_type.singularize}_counts(options={})
+                tag_counts_on('#{tag_type}',options)
+              end
+        
+              def #{tag_type.singularize}_list
+                tag_list_on('#{tag_type}')
+              end
+            
+              def #{tag_type.singularize}_list=(new_tags)
+                set_tag_list_on('#{tag_type}',new_tags)
+              end
+            
+              def #{tag_type.singularize}_counts(options = {})
+                tag_counts_on('#{tag_type}',options)
+              end
+              
+              def #{tag_type}_from(owner)
+                tag_list_on('#{tag_type}', owner)
+              end
+              
+              def find_related_#{tag_type}(options = {})
+                related_tags_for('#{tag_type}', self.class, options)
+              end
+              alias_method :find_related_on_#{tag_type}, :find_related_#{tag_type}
+
+              def find_related_#{tag_type}_for(klass, options = {})
+                related_tags_for('#{tag_type}', klass, options)
+              end
+              
+              def top_#{tag_type}(limit = 10)
+                tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
+              end
+              
+              def self.top_#{tag_type}(limit = 10)
+                tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
+              end
+            RUBY
+          end      
+          
+          if respond_to?(:tag_types)
+            write_inheritable_attribute( :tag_types, (tag_types + args).uniq )
+          else
+            self.class_eval do
+              write_inheritable_attribute(:tag_types, args.uniq)
+              class_inheritable_reader :tag_types
+            
+              has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
+              has_many :base_tags, :class_name => "Tag", :through => :taggings, :source => :tag
+            
+              attr_writer :custom_contexts
+            
+              before_save :save_cached_tag_list
+              after_save :save_tags
+              
+              if respond_to?(:named_scope)
+                named_scope :tagged_with, lambda{ |*args|
+                  find_options_for_find_tagged_with(*args)
+                }
+              end
+            end
+            
+            include ActiveRecord::Acts::TaggableOn::InstanceMethods
+            extend ActiveRecord::Acts::TaggableOn::SingletonMethods                
+            alias_method_chain :reload, :tag_list
+          end
+        end
+        
+        def is_taggable?
+          false
+        end
+      end
+      
+      module SingletonMethods
+        # Pass either a tag string, or an array of strings or tags
+        # 
+        # Options:
+        #   :exclude - Find models that are not tagged with the given tags
+        #   :match_all - Find models that match all of the given tags, not just one
+        #   :conditions - A piece of SQL conditions to add to the query
+        #   :on - scopes the find to a context
+        def find_tagged_with(*args)
+          options = find_options_for_find_tagged_with(*args)
+          options.blank? ? [] : find(:all,options)
+        end
+        
+        def caching_tag_list_on?(context)
+          column_names.include?("cached_#{context.to_s.singularize}_list")
+        end     
+        
+        def tag_counts_on(context, options = {})
+          Tag.find(:all, find_options_for_tag_counts(options.merge({:on => context.to_s})))
+        end           
+        
+        def find_options_for_find_tagged_with(tags, options = {})
+          tags = tags.is_a?(Array) ? TagList.new(tags.map(&:to_s)) : TagList.from(tags)
+
+          return {} if tags.empty?
+
+          conditions = []
+          conditions << sanitize_sql(options.delete(:conditions)) if options[:conditions]
+          
+          unless (on = options.delete(:on)).nil?
+            conditions << sanitize_sql(["context = ?",on.to_s])
+          end
+
+          taggings_alias, tags_alias = "#{table_name}_taggings", "#{table_name}_tags"
+
+          if options.delete(:exclude)
+            tags_conditions = tags.map { |t| sanitize_sql(["#{Tag.table_name}.name LIKE ?", t]) }.join(" OR ")
+            conditions << sanitize_sql(["#{table_name}.id NOT IN (SELECT #{Tagging.table_name}.taggable_id FROM #{Tagging.table_name} LEFT OUTER JOIN #{Tag.table_name} ON #{Tagging.table_name}.tag_id = #{Tag.table_name}.id WHERE (#{tags_conditions}) AND #{Tagging.table_name}.taggable_type = #{quote_value(base_class.name)})", tags])
+          else
+            conditions << tags.map { |t| sanitize_sql(["#{tags_alias}.name LIKE ?", t]) }.join(" OR ")
+
+            if options.delete(:match_all)
+              group = "#{taggings_alias}.taggable_id HAVING COUNT(#{taggings_alias}.taggable_id) = #{tags.size}"
+            end
+          end
+          
+          { :select => "DISTINCT #{table_name}.*",
+            :joins => "LEFT OUTER JOIN #{Tagging.table_name} #{taggings_alias} ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key} AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)} " +
+                      "LEFT OUTER JOIN #{Tag.table_name} #{tags_alias} ON #{tags_alias}.id = #{taggings_alias}.tag_id",
+            :conditions => conditions.join(" AND "),
+            :group      => group
+          }.update(options)
+        end    
+        
+        # Calculate the tag counts for all tags.
+        # 
+        # Options:
+        #  :start_at - Restrict the tags to those created after a certain time
+        #  :end_at - Restrict the tags to those created before a certain time
+        #  :conditions - A piece of SQL conditions to add to the query
+        #  :limit - The maximum number of tags to return
+        #  :order - A piece of SQL to order by. Eg 'tags.count desc' or 'taggings.created_at desc'
+        #  :at_least - Exclude tags with a frequency less than the given value
+        #  :at_most - Exclude tags with a frequency greater than the given value
+        #  :on - Scope the find to only include a certain context
+        def find_options_for_tag_counts(options = {})
+          options.assert_valid_keys :start_at, :end_at, :conditions, :at_least, :at_most, :order, :limit, :on, :id
+          
+          scope = scope(:find)
+          start_at = sanitize_sql(["#{Tagging.table_name}.created_at >= ?", options.delete(:start_at)]) if options[:start_at]
+          end_at = sanitize_sql(["#{Tagging.table_name}.created_at <= ?", options.delete(:end_at)]) if options[:end_at]
+
+          taggable_type = sanitize_sql(["#{Tagging.table_name}.taggable_type = ?", base_class.name])
+          taggable_id = sanitize_sql(["#{Tagging.table_name}.taggable_id = ?", options.delete(:id)]) if options[:id]
+          options[:conditions] = sanitize_sql(options[:conditions]) if options[:conditions]
+          
+          conditions = [
+            taggable_type,
+            taggable_id,
+            options[:conditions],
+            start_at,
+            end_at
+          ]
+
+          conditions = conditions.compact.join(' AND ')
+          conditions = merge_conditions(conditions, scope[:conditions]) if scope
+
+          joins = ["LEFT OUTER JOIN #{Tagging.table_name} ON #{Tag.table_name}.id = #{Tagging.table_name}.tag_id"]
+          joins << sanitize_sql(["AND #{Tagging.table_name}.context = ?",options.delete(:on).to_s]) unless options[:on].nil?
+          
+          joins << " INNER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{Tagging.table_name}.taggable_id"
+          unless self.descends_from_active_record?
+            # Current model is STI descendant, so add type checking to the join condition
+            joins << " AND #{table_name}.#{self.inheritance_column} = '#{self.name}'"
+          end
+          
+          joins << scope[:joins] if scope && scope[:joins]
+
+          at_least  = sanitize_sql(['COUNT(*) >= ?', options.delete(:at_least)]) if options[:at_least]
+          at_most   = sanitize_sql(['COUNT(*) <= ?', options.delete(:at_most)]) if options[:at_most]
+          having    = [at_least, at_most].compact.join(' AND ')
+          group_by  = "#{Tag.table_name}.id, #{Tag.table_name}.name HAVING COUNT(*) > 0"
+          group_by << " AND #{having}" unless having.blank?
+
+          { :select     => "#{Tag.table_name}.id, #{Tag.table_name}.name, COUNT(*) AS count", 
+            :joins      => joins.join(" "),
+            :conditions => conditions,
+            :group      => group_by,
+            :limit      => options[:limit],
+            :order      => options[:order]
+          }
+        end    
+        
+        def is_taggable?
+          true
+        end                
+      end
+    
+      module InstanceMethods
+        
+        def tag_types
+          self.class.tag_types
+        end
+        
+        def custom_contexts
+          @custom_contexts ||= []
+        end
+        
+        def is_taggable?
+          self.class.is_taggable?
+        end
+        
+        def add_custom_context(value)
+          custom_contexts << value.to_s unless custom_contexts.include?(value.to_s) or self.class.tag_types.map(&:to_s).include?(value.to_s)
+        end
+        
+        def tag_list_on(context, owner=nil)
+          var_name = context.to_s.singularize + "_list"
+          add_custom_context(context)
+          return instance_variable_get("@#{var_name}") unless instance_variable_get("@#{var_name}").nil?
+        
+          if !owner && self.class.caching_tag_list_on?(context) and !(cached_value = cached_tag_list_on(context)).nil?
+            instance_variable_set("@#{var_name}", TagList.from(self["cached_#{var_name}"]))
+          else
+            instance_variable_set("@#{var_name}", TagList.new(*tags_on(context, owner).map(&:name)))
+          end
+        end
+        
+        def tags_on(context, owner=nil)
+          if owner
+            opts = {:conditions => ["context = ? AND tagger_id = ? AND tagger_type = ?",
+                                    context.to_s, owner.id, owner.class.to_s]}
+          else
+            opts = {:conditions => ["context = ?", context.to_s]}
+          end
+          base_tags.find(:all, opts)
+        end
+        
+        def cached_tag_list_on(context)
+          self["cached_#{context.to_s.singularize}_list"]
+        end
+        
+        def set_tag_list_on(context,new_list, tagger=nil)
+          instance_variable_set("@#{context.to_s.singularize}_list", TagList.from_owner(tagger, new_list))
+          add_custom_context(context)
+        end
+        
+        def tag_counts_on(context, options={})
+          self.class.tag_counts_on(context, options.merge(:id => self.id))
+        end
+
+        def related_tags_for(context, klass, options = {})
+          search_conditions = related_search_options(context, klass, options)
+
+          klass.find(:all, search_conditions)
+        end
+
+        def related_search_options(context, klass, options = {})
+          tags_to_find = self.tags_on(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 (?)", tags_to_find],
+            :group      => "#{klass.table_name}.id",
+            :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?")
+              self["cached_#{tag_type.singularize}_list"] = send("#{tag_type.singularize}_list").to_s
+            end
+          end
+        end
+        
+        def save_tags
+          (custom_contexts + self.class.tag_types.map(&:to_s)).each do |tag_type|
+            next unless instance_variable_get("@#{tag_type.singularize}_list")
+            owner = instance_variable_get("@#{tag_type.singularize}_list").owner
+            new_tag_names = instance_variable_get("@#{tag_type.singularize}_list") - tags_on(tag_type).map(&:name)
+            old_tags = tags_on(tag_type, owner).reject { |tag| instance_variable_get("@#{tag_type.singularize}_list").include?(tag.name) }
+          
+            self.class.transaction do
+              base_tags.delete(*old_tags) if old_tags.any?
+              new_tag_names.each do |new_tag_name|
+                new_tag = Tag.find_or_create_with_like_by_name(new_tag_name)
+                Tagging.create(:tag_id => new_tag.id, :context => tag_type, 
+                               :taggable => self, :tagger => owner)
+              end
+            end
+          end
+          
+          true
+        end
+        
+        def reload_with_tag_list(*args)
+          self.class.tag_types.each do |tag_type|
+            self.instance_variable_set("@#{tag_type.to_s.singularize}_list", nil)
+          end
+          
+          reload_without_tag_list(*args)
+        end
+      end
+    end
+  end
+end