acts-as-taggable-on 2.0.6 → 2.4.0

data/README.rdoc

@@ -1,221 +0,0 @@
-= 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
-
-=== Rails 2.3.x
-
-Acts As Taggable On is tested to work in Rails 2.3.5. 
-
-==== 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:
-
-  script/plugin install git://github.com/mbleigh/acts-as-taggable-on.git
-
-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", :version => '2.0.0.rc1'
-  
-After that, you can run "rake gems:install" to install the gem if you don't already have it.
-
-==== Post Installation
-
-1. script/generate acts_as_taggable_on_migration
-2. rake db:migrate
-
-=== 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.
-
-To use it, add it to your Gemfile:
-  
-  gem 'acts-as-taggable-on'
-
-==== Post Installation
-
-1. rails 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 for RoR 3.0.0 with:
-
-  rake spec
-
-If you want to test the plugin for Rails 2.3.x, use:
-
-  rake rails2.3:spec
-
-If you already have RSpec on your application, the specs will run while using:
-
-rake spec:plugins
-
-
-== Usage
-
-    class User < ActiveRecord::Base
-      # Alias for <tt>acts_as_taggable_on :tags</tt>:
-      acts_as_taggable
-      acts_as_taggable_on :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">]
-
-    @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 named_scopes 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)
-    
-    # Find a user with any of the tags:
-    User.tagged_with(["awesome", "cool"], :any => 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.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 ActsAsTaggableOn::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
-* Szymon Nowak - Rails 3.0 compatibility
-* Jelle Vandebeeck - Rails 3.0 compatibility
-* 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-2010 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/), released under the MIT license

data/VERSION

@@ -1 +0,0 @@
-2.0.6

data/generators/acts_as_taggable_on_migration/acts_as_taggable_on_migration_generator.rb

@@ -1,7 +0,0 @@
-class ActsAsTaggableOnMigrationGenerator < Rails::Generator::Base 
-  def manifest 
-    record do |m| 
-      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "acts_as_taggable_on_migration"
-    end
-  end
-end

data/generators/acts_as_taggable_on_migration/templates/migration.rb

@@ -1,29 +0,0 @@
-class ActsAsTaggableOnMigration < ActiveRecord::Migration
-  def self.up
-    create_table :tags do |t|
-      t.column :name, :string
-    end
-    
-    create_table :taggings do |t|
-      t.column :tag_id, :integer
-      t.column :taggable_id, :integer
-      t.column :tagger_id, :integer
-      t.column :tagger_type, :string
-      
-      # You should make sure that the column created is
-      # long enough to store the required class names.
-      t.column :taggable_type, :string
-      t.column :context, :string
-      
-      t.column :created_at, :datetime
-    end
-    
-    add_index :taggings, :tag_id
-    add_index :taggings, [:taggable_id, :taggable_type, :context]
-  end
-  
-  def self.down
-    drop_table :taggings
-    drop_table :tags
-  end
-end

data/lib/acts_as_taggable_on/acts_as_taggable_on.rb

@@ -1,53 +0,0 @@
-module ActsAsTaggableOn
-  module Taggable
-    def taggable?
-      false
-    end
-
-    ##
-    # This is an alias for calling <tt>acts_as_taggable_on :tags</tt>.
-    #
-    # Example:
-    #   class Book < ActiveRecord::Base
-    #     acts_as_taggable
-    #   end
-    def acts_as_taggable
-      acts_as_taggable_on :tags
-    end
-
-    ##
-    # Make a model taggable on specified contexts.
-    #
-    # @param [Array] tag_types An array of taggable contexts
-    #
-    # Example:
-    #   class User < ActiveRecord::Base
-    #     acts_as_taggable_on :languages, :skills
-    #   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
-        write_inheritable_attribute(:tag_types, tag_types)
-        class_inheritable_reader(:tag_types)
-        
-        class_eval do
-          has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag, :class_name => "ActsAsTaggableOn::Tagging"
-          has_many :base_tags, :through => :taggings, :source => :tag, :class_name => "ActsAsTaggableOn::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/compatibility/Gemfile

@@ -1,8 +0,0 @@
-source :gemcutter
-
-# Rails 2.3
-gem 'rails',        '2.3.5'
-gem 'rspec',        '1.3.0', :require => 'spec'
-gem 'sqlite3-ruby', '1.2.5', :require => 'sqlite3'
-gem 'mysql'
-gem 'pg'

data/lib/acts_as_taggable_on/compatibility/active_record_backports.rb

@@ -1,17 +0,0 @@
-module ActsAsTaggableOn
-  module ActiveRecord
-    module Backports
-      def self.included(base)
-        base.class_eval do
-          named_scope :where,    lambda { |conditions| { :conditions => conditions } }  
-          named_scope :joins,    lambda { |joins|      { :joins => joins } }
-          named_scope :group,    lambda { |group|      { :group => group } }
-          named_scope :order,    lambda { |order|      { :order => order } }
-          named_scope :select,   lambda { |select|     { :select => select } }
-          named_scope :limit,    lambda { |limit|      { :limit => limit } }
-          named_scope :readonly, lambda { |readonly|   { :readonly => readonly } }   
-        end
-      end
-    end
-  end
-end

data/lib/acts_as_taggable_on/compatibility/postgresql.rb

@@ -1,44 +0,0 @@
-module ActsAsTaggableOn
-  module Taggable
-    module PostgreSQL
-      def self.included(base)
-        base.send :include, ActsAsTaggableOn::Taggable::PostgreSQL::InstanceMethods
-        base.extend ActsAsTaggableOn::Taggable::PostgreSQL::ClassMethods
-      
-        ActsAsTaggableOn::Tag.class_eval do
-          def self.named(name)
-            where(["name ILIKE ?", name])
-          end
-
-          def self.named_any(list)
-            where(list.map { |tag| sanitize_sql(["name ILIKE ?", tag.to_s]) }.join(" OR "))
-          end
-
-          def self.named_like(name)
-            where(["name ILIKE ?", "%#{name}%"])
-          end
-
-          def self.named_like_any(list)
-            where(list.map { |tag| sanitize_sql(["name ILIKE ?", "%#{tag.to_s}%"]) }.join(" OR "))
-          end          
-        end
-      end
-      
-      module InstanceMethods
-      end
-      
-      module ClassMethods
-        # all column names are necessary for PostgreSQL group clause
-        def grouped_column_names_for(*objects)
-          object   = objects.shift
-          columns  = object.column_names.map { |column| "#{object.table_name}.#{column}" }
-          columns << objects.map do |object|
-                       "#{object.table_name}.created_at"
-                     end.flatten
-
-          columns.flatten.join(", ")
-        end
-      end
-    end
-  end
-end

data/spec/database.yml

@@ -1,17 +0,0 @@
-sqlite3:
-  adapter: sqlite3
-  database: acts_as_taggable_on.sqlite3
-
-mysql:
-  adapter: mysql
-  hostname: localhost
-  username: root
-  password:
-  database: acts_as_taggable_on
-
-postgresql:
-  adapter: postgresql
-  hostname: localhost
-  username: postgres
-  password:
-  database: acts_as_taggable_on