acts-as-taggable-on 2.0.6 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b46e80f19a5c7de71ec448bd0700ef672ea9639
+  data.tar.gz: d7c19bc3aec73a2b5d1ff08ad18cb9c85e61225c
+SHA512:
+  metadata.gz: 4ac4317c1fa00caa6f048d4958d830da83bae5a48d8fd2f4018918319069e9e0311b99318cfe337fcd8d23f9c37055484e1c40c1ab0ecda2c256d361315b0848
+  data.tar.gz: 7e29cf71dfce65f2ac65d0a10972c6b26344398278c53b088b9069ec728955e697389f496b25a8f57fd521b6349aaa2ef827caab78bf8a00c7416c9be43c21e5

data/.gitignore

@@ -0,0 +1,11 @@
+*.log
+*.sqlite3
+/pkg/*
+.bundle
+.ruby-version
+spec/database.yml
+tmp*.sw?
+*.sw?
+tmp
+*.gem
+*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/.travis.yml

@@ -0,0 +1,18 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+env:
+  - DB=sqlite3
+  - DB=mysql
+  - DB=postgresql
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+cache: bundler
+script: bundle exec rake
+before_install:
+  - gem install bundler
+bundler_args: '--without local_development'
+matrix:
+  fast_finish: true

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-3.2" do
+  gem "rails", "~> 3.2"
+end
+
+appraise "rails-4.0" do
+  gem "rails", "~> 4.0"
+end
+
+appraise "rails-4.1" do
+  gem "rails", "~> 4.1.0.beta1"
+end

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+Changes are below categorized as `Features, Fixes, or Misc`.
+
+Each change should fall into categories that would affect whether the release is major (breaking changes), minor (new behavior), or patch (bug fix). See [semver](http://semver.org/) and [pessimistic versioning](http://guides.rubygems.org/patterns/#pessimistic_version_constraint)
+
+As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.  And _misc_ is either minor or patch, the difference being kind of fuzzy for the purposes of history.  Adding tests would be patch level.
+
+### Master [changes](https://github.com/mbleigh/acts-as-taggable-on/compare/v3.0.0...master)
+
+* Breaking Changes
+* Features
+* Fixes
+* Misc
+
+### [3.0.0 / 2014-01-01](https://github.com/mbleigh/acts-as-taggable-on/compare/v2.4.1...v3.0.0)
+
+* Breaking Changes
+  * No longer supports Ruby 1.8.
+* Features
+  * Supports Rails 4.1.
+* Misc (TODO: expand)
+  * [zquest #359](https://github.com/mbleigh/acts-as-taggable-on/pull/359)
+  * [rsl #367](https://github.com/mbleigh/acts-as-taggable-on/pull/367)
+  * [ktdreyer #383](https://github.com/mbleigh/acts-as-taggable-on/pull/383)
+  * [cwoodcox #346](https://github.com/mbleigh/acts-as-taggable-on/pull/346)
+  * [mrb #421](https://github.com/mbleigh/acts-as-taggable-on/pull/421)
+  * [bf4 #430](https://github.com/mbleigh/acts-as-taggable-on/pull/430)
+  * [sanemat #368](https://github.com/mbleigh/acts-as-taggable-on/pull/368)
+  * [bf4 #343](https://github.com/mbleigh/acts-as-taggable-on/pull/343)
+  * [marclennox #429](https://github.com/mbleigh/acts-as-taggable-on/pull/429)
+  * [shekibobo #403](https://github.com/mbleigh/acts-as-taggable-on/pull/403)
+  * [ches ktdreyer #410](https://github.com/mbleigh/acts-as-taggable-on/pull/410)
+  * [makaroni4 #371](https://github.com/mbleigh/acts-as-taggable-on/pull/371)
+  * [kenzai dstosik awt #431](https://github.com/mbleigh/acts-as-taggable-on/pull/431)
+  * [bf4 joelcogen shekibobo aaronchi #438](https://github.com/mbleigh/acts-as-taggable-on/pull/438)
+  * [seuros #442](https://github.com/mbleigh/acts-as-taggable-on/pull/442)
+  * [bf4 #445](https://github.com/mbleigh/acts-as-taggable-on/pull/445)
+  * [eaglemt #446](https://github.com/mbleigh/acts-as-taggable-on/pull/446)
+
+### 3.0.0.rc2 [changes](https://github.com/mbleigh/acts-as-taggable-on/compare/fork-v3.0.0.rc1...fork-v3.0.0.rc2)
+
+### 3.0.0.rc1 [changes](https://github.com/mbleigh/acts-as-taggable-on/compare/v2.4.1...fork-v3.0.0.rc1)
+
+### [2.4.1 / 2013-05-07](https://github.com/mbleigh/acts-as-taggable-on/compare/v2.4.0...v2.4.1)
+
+* Features
+* Fixes
+* Misc

data/Gemfile

@@ -1,10 +1,11 @@
-source :gemcutter
+source 'https://rubygems.org'
+
+gemspec
+
+group :local_development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'appraisal'
+  gem 'rake'
+end
 
-# Rails 3.0
-gem 'rails',        '3.0.0.beta3'
-gem 'rspec',        '2.0.0.beta.8'
-gem 'sqlite3-ruby', :require => 'sqlite3'
-gem 'mysql'
-gem 'pg'
-gem 'jeweler'
-gem 'rcov'

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/{MIT-LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Michael Bleigh and Intridea Inc.
+__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

data/README.md

@@ -0,0 +1,313 @@
+# ActsAsTaggableOn
+[![Build Status](https://secure.travis-ci.org/mbleigh/acts-as-taggable-on.png)](http://travis-ci.org/mbleigh/acts-as-taggable-on)
+[![Code Climate](https://codeclimate.com/github/mbleigh/acts-as-taggable-on.png)](https://codeclimate.com/github/mbleigh/acts-as-taggable-on)
+
+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.
+
+## Compatibility
+
+Versions 2.x are compatible with Ruby 1.8.7+ and Rails 3.
+
+Versions 2.4.1 and up are compatible with Rails 4 too (thanks to arabonradar and cwoodcox).
+
+Versions 3.x (currently unreleased) are compatible with Ruby 1.9.3+ and Rails 3 and 4.  There is a [release candidate you may try](http://rubygems.org/gems/acts_as_taggable_on).
+
+For an up-to-date roadmap, see https://github.com/mbleigh/acts-as-taggable-on/issues/milestones
+
+## Installation
+
+To use it, add it to your Gemfile:
+
+```ruby
+gem 'acts-as-taggable-on'
+```
+
+and bundle:
+
+```ruby
+bundle
+```
+
+#### Post Installation
+
+```shell
+# For the latest versions
+rake railties:install:migrations FROM=acts_as_taggable_on_engine db:migrate
+
+# For versions 2.4.1 and earlier
+rails generate acts_as_taggable_on:migration
+rake db:migrate
+```
+
+#### Upgrading
+
+see [UPGRADING](UPGRADING)
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+  # Alias for acts_as_taggable_on :tags
+  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.tags                                    # => [<Tag name:"awesome">,<Tag name:"slick">,<Tag name:"hefty">]
+@user.skills                                  # => [<Tag name:"joking">,<Tag name:"clowning">,<Tag name:"boxing">]
+@user.skill_list                              # => ["joking","clowning","boxing"] as TagList
+
+@user.tag_list.remove("awesome")              # remove a single tag
+@user.tag_list.remove("awesome, slick")       # works with arrays too
+@user.tag_list.add("awesomer")                # add a single tag. alias for <<
+@user.tag_list.add("awesomer, slicker")       # also works with arrays
+
+User.skill_counts                             # => [<Tag name="joking" count=2>,<Tag name="clowning" count=1>...]
+```
+
+To preserve the order in which tags are created use `acts_as_ordered_taggable`:
+
+```ruby
+class User < ActiveRecord::Base
+  # Alias for acts_as_ordered_taggable_on :tags
+  acts_as_ordered_taggable
+  acts_as_ordered_taggable_on :skills, :interests
+end
+
+@user = User.new(:name => "Bobby")
+@user.tag_list = "east, south"
+@user.save
+
+@user.tag_list = "north, east, south, west"
+@user.save
+
+@user.reload
+@user.tag_list # => ["north", "east", "south", "west"]
+```
+
+### Finding Tagged Objects
+
+Acts As Taggable On uses scopes to create an association for tags.
+This way you can mix and match to filter down your results.
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_taggable_on :tags, :skills
+  scope :by_join_date, order("created_at DESC")
+end
+
+User.tagged_with("awesome").by_join_date
+User.tagged_with("awesome").by_join_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)
+
+# Find a user that not tags with awesome or cool:
+User.tagged_with(["awesome", "cool"], :exclude => true)
+
+# Find a user with any of tags based on context:
+User.tagged_with(['awesome, cool'], :on => :tags, :any => true).tagged_with(['smart', 'shy'], :on => :skills, :any => true)
+```
+
+You can also use `:wild => true` option along with `:any` or `:exclude` option. It will looking for `%awesome%` and `%cool%` in sql.
+
+__Tip:__ `User.tagged_with([])` or '' will return `[]`, but not all records.
+
+### 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.
+
+```ruby
+@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!)
+
+```ruby
+@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:
+
+```ruby
+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
+Photo.tagged_with("paris", :on => :locations, :owned_by => @some_user)
+@some_photo.locations_from(@some_user) # => ["paris", "normandy"]
+@some_photo.owner_tags_on(@some_user, :locations) # => [#<ActsAsTaggableOn::Tag id: 1, name: "paris">...]
+@some_photo.owner_tags_on(nil, :locations) # => Ownerships equivalent to saying @some_photo.locations
+@some_user.tag(@some_photo, :with => "paris, normandy", :on => :locations, :skip_save => true) #won't save @some_photo object
+```
+
+### Dirty objects
+
+```ruby
+@bobby = User.find_by_name("Bobby")
+@bobby.skill_list # => ["jogging", "diving"]
+
+@bobby.skill_list_changed? #=> false
+@bobby.changes #=> {}
+
+@bobby.skill_list = "swimming"
+@bobby.changes.should == {"skill_list"=>["jogging, diving", ["swimming"]]}
+@bobby.skill_list_changed? #=> true
+
+@bobby.skill_list_change.should == ["jogging, diving", ["swimming"]]
+```
+
+### 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 `User` class, we can
+get a calculation of all the tag counts by using `User.tag_counts_on(:customs)`. But what if we wanted a tag count for
+an single user's posts? To achieve this we call tag_counts on the association:
+
+```ruby
+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:
+
+```ruby
+module PostsHelper
+  include ActsAsTaggableOn::TagsHelper
+end
+```
+
+Controller:
+
+```ruby
+class PostController < ApplicationController
+  def tag_cloud
+    @tags = Post.tag_counts_on(:tags)
+  end
+end
+```
+
+View:
+
+```erb
+<% 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:
+
+```css
+.css1 { font-size: 1.0em; }
+.css2 { font-size: 1.2em; }
+.css3 { font-size: 1.4em; }
+.css4 { font-size: 1.6em; }
+```
+
+## Configuration
+
+If you would like to remove unused tag objects after removing taggings, add:
+
+```ruby
+ActsAsTaggableOn.remove_unused_tags = true
+```
+
+If you want force tags to be saved downcased:
+
+```ruby
+ActsAsTaggableOn.force_lowercase = true
+```
+
+If you want tags to be saved parametrized (you can redefine to_param as well):
+
+```ruby
+ActsAsTaggableOn.force_parameterize = true
+```
+
+If you would like tags to be case-sensitive and not use LIKE queries for creation:
+
+```ruby
+ActsAsTaggableOn.strict_case_match = true
+```
+
+If you want to change the default delimiter (it defaults to ','). You can also pass in an array of delimiters such as ([',', '|']):
+
+```ruby
+ActsAsTaggableOn.delimiter = ','
+```
+
+## Contributors
+
+We have a long list of valued contributors. [Check them all](https://github.com/mbleigh/acts-as-taggable-on/contributors)
+
+## Maintainer
+
+* [Joost Baaij](https://github.com/tilsammans)
+
+## Testing
+
+Acts As Taggable On uses RSpec for its test coverage. Inside the gem
+directory, you can run the specs with:
+
+```shell
+bundle
+rake spec
+```
+
+You can run all the tests across all the Rails versions by running `rake appraise`.  If you'd also like to [run the tests across all rubies and databases as configured for Travis CI, install and run `wwtd`](https://github.com/grosser/wwtd).
+
+
+## License
+
+See [LICENSE](https://github.com/mbleigh/acts-as-taggable-on/blob/master/LICENSE.md)

data/Rakefile

@@ -1,59 +1,31 @@
+require 'rubygems'
 begin
-  # Rspec 1.3.0
-  require 'spec/rake/spectask'
+  require 'bundler/setup'
+rescue LoadError
+  STDERR.puts "Bundler not loaded"
+end
 
-  desc 'Default: run specs'
-  task :default => :spec
-  Spec::Rake::SpecTask.new do |t|
-    t.spec_files = FileList["spec/**/*_spec.rb"]
-  end
+desc 'Copy sample spec database.yml over if not exists'
+task :copy_db_config do
+  cp 'spec/database.yml.sample', 'spec/database.yml'
+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'
+task :spec => [:copy_db_config]
 
-  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
+desc 'Default: run specs'
+task :default => :spec
 
+begin
+  require 'appraisal'
+  desc 'Run tests across gemfiles specified in Appraisals'
+  task :appraise => ['appraisal:cleanup', 'appraisal:install', 'appraisal']
 rescue LoadError
-  puts "Rspec not available. Install it with: gem install rspec"  
+  puts "appraisal tasks not available"
 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
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
 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
+Bundler::GemHelper.install_tasks

data/UPGRADING

@@ -0,0 +1,7 @@
+When upgrading
+
+Re-run the migrations generator
+
+    rake railties:install:migrations FROM=acts_as_taggable_on_engine db:migrate
+
+It will create any new migrations and skip existing ones

data/acts-as-taggable-on.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_taggable_on/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "acts-as-taggable-on"
+  gem.version       = ActsAsTaggableOn::VERSION
+  gem.authors       = ["Michael Bleigh", "Joost Baaij"]
+  gem.email         = ["michael@intridea.com", "joost@spacebabies.nl"]
+  gem.description   = %q{With ActsAsTaggableOn, you can tag a single model on several contexts, such as skills, interests, and awards. It also provides other advanced functionality.}
+  gem.summary       = "Advanced tagging for Rails."
+  gem.homepage      = 'https://github.com/mbleigh/acts-as-taggable-on'
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  if File.exists?('UPGRADING')
+    gem.post_install_message = File.read('UPGRADING')
+  end
+
+  gem.add_runtime_dependency 'rails', ['>= 3', '< 5']
+
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'mysql2', '~> 0.3.7'
+  gem.add_development_dependency 'pg'
+
+  gem.add_development_dependency 'rspec-rails', '2.13.0' # 2.13.1 is broken
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'ammeter'
+
+end

data/{lib/generators/acts_as_taggable_on/migration/templates/active_record/migration.rb → db/migrate/1_acts_as_taggable_on_migration.rb}

@@ -12,7 +12,9 @@ class ActsAsTaggableOnMigration < ActiveRecord::Migration
       t.references :taggable, :polymorphic => true
       t.references :tagger, :polymorphic => true
 
-      t.string :context
+      # Limit is created to prevent MySQL error on index
+      # length for MyISAM table type: http://bit.ly/vgW2Ql
+      t.string :context, :limit => 128
 
       t.datetime :created_at
     end

data/db/migrate/2_add_missing_unique_indices.rb

@@ -0,0 +1,21 @@
+class AddMissingUniqueIndices < ActiveRecord::Migration
+
+  def self.up
+    add_index :tags, :name, unique: true
+
+    remove_index :taggings, :tag_id
+    remove_index :taggings, [:taggable_id, :taggable_type, :context]
+    add_index :taggings,
+      [:tag_id, :taggable_id, :taggable_type, :context, :tagger_id, :tagger_type],
+      unique: true, name: 'taggings_idx'
+   end
+
+  def self.down
+    remove_index :tags, :name
+
+    remove_index :taggings, name: 'tagging_idx'
+    add_index :taggings, :tag_id
+    add_index :taggings, [:taggable_id, :taggable_type, :context]
+  end
+
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2"
+
+gemspec :path=>"../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0.beta1"
+
+gemspec :path=>"../"