acts-as-taggable-on 0.0.0

data/CHANGELOG

@@ -0,0 +1,25 @@
+== 2010-02-17
+* Converted the plugin to be compatible with Rails3
+
+== 2009-12-02
+
+* PostgreSQL is now supported (via morgoth)
+
+== 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/Gemfile

@@ -0,0 +1,6 @@
+source :gemcutter
+
+# Rails 3.0
+gem 'rails',        '3.0.0.beta'
+gem 'rspec',        '2.0.0.beta.1'
+gem 'sqlite3-ruby', '1.2.5',       :require => 'sqlite3'

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.rdoc

@@ -0,0 +1,212 @@
+= 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
+  
+=== 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.
+
+== Rails 3.0
+
+Acts As Taggable On is now useable in Rails 3.0, thanks to the excellent work of Szymon Nowak
+and Jelle Vandebeeck. Because backwards compatibility is hard to maintain, their work is available
+in the feature/rails3_compatibility branch.
+
+A Rails 3.0 compatible version of the gem is also available: 
+  
+  gem install acts-as-taggable-on -v=2.0.0.pre1
+
+=== 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
+
+
+== Usage
+
+    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)
+
+    #Find a user with matching all tags, not just one
+    User.tagged_with(["awesome", "cool"], :match_all => :true)
+
+=== 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)
+    
+=== 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.
+
+Helper:
+
+  module PostsHelper
+    include TagsHelper
+  end
+
+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
+
+* TomEric (i76) - Maintainer
+* 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
+* sobrinho - fixed tag_cloud helper
+
+Copyright (c) 2007-2009 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/), released under the MIT license

data/Rakefile

@@ -0,0 +1,59 @@
+begin
+  # Rspec 1.3.0
+  require 'spec/rake/spectask'
+
+  desc 'Default: run specs'
+  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
+  
+rescue LoadError
+  # Rspec 2.0
+  require 'rspec/core/rake_task'
+
+  desc 'Default: run specs'
+  task :default => :spec  
+  Rspec::Core::RakeTask.new do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+  
+  Rspec::Core::RakeTask.new('rcov') do |t|
+    t.pattern = "spec/**/*_spec.rb"
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+
+rescue LoadError
+  puts "Rspec not available. Install it with: gem install rspec"  
+end
+
+namespace 'rails2.3' do
+  task :spec do
+    gemfile = File.join(File.dirname(__FILE__), 'lib', 'acts_as_taggable_on', 'compatibility', 'Gemfile')
+    ENV['BUNDLE_GEMFILE'] = gemfile
+    Rake::Task['spec'].invoke    
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "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/mbleigh/acts-as-taggable-on"
+    gemspec.authors = ["Michael Bleigh"]
+    gemspec.files =  FileList["[A-Z]*", "{generators,lib,spec,rails}/**/*"] - FileList["**/*.log"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

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

@@ -0,0 +1,30 @@
+require "active_record"
+require "action_view"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "acts_as_taggable_on/compatibility/active_record_backports" if ActiveRecord::VERSION::MAJOR < 3
+
+require "acts_as_taggable_on/acts_as_taggable_on"
+require "acts_as_taggable_on/acts_as_taggable_on/core"
+require "acts_as_taggable_on/acts_as_taggable_on/collection"
+require "acts_as_taggable_on/acts_as_taggable_on/cache"
+require "acts_as_taggable_on/acts_as_taggable_on/ownership"
+require "acts_as_taggable_on/acts_as_taggable_on/related"
+
+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"
+
+$LOAD_PATH.shift
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ActsAsTaggableOn::Taggable
+  ActiveRecord::Base.send :include, ActsAsTaggableOn::Tagger
+end
+
+if defined?(ActionView::Base)
+  ActionView::Base.send :include, TagsHelper
+end

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -0,0 +1,41 @@
+module ActsAsTaggableOn
+  module Taggable
+    def taggable?
+      false
+    end
+
+    def acts_as_taggable
+      acts_as_taggable_on :tags
+    end
+
+    def acts_as_taggable_on(*tag_types)
+      tag_types = tag_types.to_a.flatten.compact.map(&:to_sym)
+
+      if taggable?
+        write_inheritable_attribute(:tag_types, (self.tag_types + tag_types).uniq)
+      else
+        if ::ActiveRecord::VERSION::MAJOR < 3
+          include ActsAsTaggableOn::ActiveRecord::Backports
+        end
+
+        write_inheritable_attribute(:tag_types, tag_types)
+        class_inheritable_reader(:tag_types)
+        
+        class_eval do
+          has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag
+          has_many :base_tags, :class_name => "Tag", :through => :taggings, :source => :tag
+
+          def self.taggable?
+            true
+          end
+        
+          include ActsAsTaggableOn::Taggable::Core
+          include ActsAsTaggableOn::Taggable::Collection
+          include ActsAsTaggableOn::Taggable::Cache
+          include ActsAsTaggableOn::Taggable::Ownership
+          include ActsAsTaggableOn::Taggable::Related
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_taggable_on/cache.rb

@@ -0,0 +1,56 @@
+module ActsAsTaggableOn::Taggable
+  module Cache
+    def self.included(base)
+      # Skip adding caching capabilities if no cache columns exist
+      return unless base.tag_types.any? { |context| base.column_names.include?("cached_#{context.to_s.singularize}_list") }
+
+      base.send :include, ActsAsTaggableOn::Taggable::Cache::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Cache::ClassMethods
+      
+      base.class_eval do
+        before_save :save_cached_tag_list        
+      end
+      
+      base.intialize_acts_as_taggable_on_cache
+    end
+    
+    module ClassMethods
+      def intialize_acts_as_taggable_on_cache      
+        tag_types.map(&:to_s).each do |tag_type|
+          class_eval %(
+            def self.caching_#{tag_type.singularize}_list?
+              caching_tag_list_on?("#{tag_type}")
+            end        
+          )
+        end        
+      end
+      
+      def acts_as_taggable_on(*args)
+        super(*args)
+        intialize_acts_as_taggable_on_cache
+      end
+      
+      def caching_tag_list_on?(context)
+        column_names.include?("cached_#{context.to_s.singularize}_list")
+      end
+    end
+    
+    module InstanceMethods
+      def tag_list_cache_set_on(context)
+        variable_name = "@#{context.to_s.singularize}_list"
+        !instance_variable_get(variable_name).nil?
+      end
+      
+      def save_cached_tag_list
+        tag_types.map(&:to_s).each do |tag_type|
+          if self.class.send("caching_#{tag_type.singularize}_list?")
+            if tag_list_cache_set_on(tag_type)
+              list = tag_list_cache_on(tag_type.singularize).to_a.flatten.compact.join(', ')
+              self["cached_#{tag_type.singularize}_list"] = list
+            end
+          end
+        end
+      end
+    end
+  end
+end