acts-as-taggable-on 2.0.6 → 2.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd04dd7817f5d465548706b2bb39ed8923bef126
+  data.tar.gz: 371cb9a485f0370ff51074edc74296219d6f1342
+SHA512:
+  metadata.gz: f6dd2e281ec95af2bf1b3779a96522a99c81aa06d09b6e59337805c94060419c9860ef707d378029214b58fae76a9d23ac67d9b94a978c91385fffb2f605d64b
+  data.tar.gz: 843b679f0dd4212e1b814323a3b253d8f8d62942acd30d0f696a64301064c6bc5d6f4b65cfb33d300929b3c2f6f7910c844e98fa9b9fabbd47c5fc03f968cb44

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+script: "cp spec/database.yml.sample spec/database.yml && bundle install && bundle exec rake"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+env:
+  - DB=sqlite3
+  - DB=mysql
+  - DB=postgresql

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## 2011-08-21
+* escape _ and % for mysql and postgres (@tilsammans)
+* Now depends on mysql2 gem
+* tagged_with :any is chainable now (@jeffreyiacono)
+* tagged_with(nil) returns scoped object
+* Case-insensitivity for TaggedModel.tagged_with for PostgreSQL database
+* tagged_with(' ') returns scoped object
+* remove warning for rails 3.1 about class_inheritable_attribute
+* use ActiveRecord migration_number to avoid clashs (@atd)
+
+## 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

@@ -1,10 +1,3 @@
-source :gemcutter
+source 'http://rubygems.org'
+gemspec
 
-# 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 → MIT-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,297 @@
+# ActsAsTaggableOn
+[![Build Status](https://secure.travis-ci.org/mbleigh/acts-as-taggable-on.png)](http://travis-ci.org/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.
+
+## Installation
+
+### Rails 2.x
+
+Not supported any more! It is time for update guys.
+
+### Rails 3.x
+
+To use it, add it to your Gemfile:
+
+```ruby
+gem 'acts-as-taggable-on', '~> 2.3.1'
+```
+
+#### Post Installation
+
+```shell
+rails generate acts_as_taggable_on:migration
+rake db:migrate
+```
+
+## Testing
+
+Acts As Taggable On uses RSpec for its test coverage. Inside the gem
+directory, you can run the specs for RoR 3.x with:
+
+```shell
+rake spec
+```
+
+## 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 = ','
+```
+
+## Changelog
+
+See [CHANGELOG](https://github.com/mbleigh/acts-as-taggable-on/blob/master/CHANGELOG.md).
+
+## Contributors
+
+We have a long list of valued contributors. [Check them all](https://github.com/mbleigh/acts-as-taggable-on/contributors)
+
+## Maintainers
+
+* [Artem Kramarenko](https://github.com/artemk) (artemk)
+* [Joost Baaij](https://github.com/tilsammans)
+
+## Author
+
+* [Michael Bleigh](https://github.com/mbleigh)
+
+Copyright (c) 2007-2011 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/), released under the [MIT license](https://github.com/mbleigh/acts-as-taggable-on/blob/master/MIT-LICENSE.md)

data/Rakefile

@@ -1,59 +1,13 @@
-begin
-  # Rspec 1.3.0
-  require 'spec/rake/spectask'
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :development
 
-  desc 'Default: run specs'
-  task :default => :spec
-  Spec::Rake::SpecTask.new do |t|
-    t.spec_files = FileList["spec/**/*_spec.rb"]
-  end
+desc 'Default: run specs'
+task :default => :spec  
 
-  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
+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,14 @@
+
+** acts-as-taggable-on version 2.4.0
+
+Hello! This version is the first one released by me (@tilsammans),
+a new maintainer on the project. It's been a while since the last
+release and I am not 100% sure if any breaking changes have been
+introduced. Please test your tagging functionality carefully.
+
+From now on things should stabilize. Please check the project's
+milestones and compatibilities stated in the readme. If you have
+any questions, feel free to create an issue on github.
+
+https://github.com/mbleigh/acts-as-taggable-on
+

data/acts-as-taggable-on.gemspec

@@ -0,0 +1,32 @@
+$:.push File.dirname(__FILE__) + '/lib'
+require 'acts-as-taggable-on/version'
+
+Gem::Specification.new do |gem|
+  gem.name = %q{acts-as-taggable-on}
+  gem.authors = ["Michael Bleigh"]
+  gem.date = %q{2012-07-16}
+  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.email = %q{michael@intridea.com}
+  gem.homepage      = ''
+
+  if File.exists?('UPGRADING')
+    gem.post_install_message = File.read("UPGRADING")
+  end
+
+  gem.add_runtime_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'ammeter', '~> 0.1.3'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'mysql2', '~> 0.3.7'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "acts-as-taggable-on"
+  gem.require_paths = ['lib']
+  gem.version       = ActsAsTaggableOn::VERSION
+end

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

@@ -0,0 +1,4 @@
+module ActsAsTaggableOn
+  VERSION = '2.4.0'
+end
+

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

@@ -1,18 +1,49 @@
 require "active_record"
+require "active_record/version"
 require "action_view"
 
+require "digest/sha1"
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require "acts_as_taggable_on/compatibility/active_record_backports" if ActiveRecord::VERSION::MAJOR < 3
+module ActsAsTaggableOn
+  mattr_accessor :delimiter
+  @@delimiter = ','
+
+  mattr_accessor :force_lowercase
+  @@force_lowercase = false
+
+  mattr_accessor :force_parameterize
+  @@force_parameterize = false
+
+  mattr_accessor :strict_case_match
+  @@strict_case_match = false
 
-require "acts_as_taggable_on/acts_as_taggable_on"
+  mattr_accessor :remove_unused_tags
+  self.remove_unused_tags = false
+
+  def self.glue
+    delimiter = @@delimiter.kind_of?(Array) ? @@delimiter[0] : @@delimiter
+    delimiter.ends_with?(" ") ? delimiter : "#{delimiter} "
+  end
+
+  def self.setup
+    yield self
+  end
+end
+
+
+require "acts_as_taggable_on/utils"
+
+require "acts_as_taggable_on/taggable"
 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_taggable_on/dirty"
 
-require "acts_as_taggable_on/acts_as_tagger"
+require "acts_as_taggable_on/tagger"
 require "acts_as_taggable_on/tag"
 require "acts_as_taggable_on/tag_list"
 require "acts_as_taggable_on/tags_helper"
@@ -20,6 +51,7 @@ require "acts_as_taggable_on/tagging"
 
 $LOAD_PATH.shift
 
+
 if defined?(ActiveRecord::Base)
   ActiveRecord::Base.extend ActsAsTaggableOn::Taggable
   ActiveRecord::Base.send :include, ActsAsTaggableOn::Tagger
@@ -27,4 +59,5 @@ end
 
 if defined?(ActionView::Base)
   ActionView::Base.send :include, ActsAsTaggableOn::TagsHelper
-end
+end
+

data/lib/acts_as_taggable_on/acts_as_taggable_on/cache.rb

@@ -11,23 +11,23 @@ module ActsAsTaggableOn::Taggable
         before_save :save_cached_tag_list        
       end
       
-      base.intialize_acts_as_taggable_on_cache
+      base.initialize_acts_as_taggable_on_cache
     end
     
     module ClassMethods
-      def intialize_acts_as_taggable_on_cache      
+      def initialize_acts_as_taggable_on_cache      
         tag_types.map(&:to_s).each do |tag_type|
-          class_eval %(
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def self.caching_#{tag_type.singularize}_list?
               caching_tag_list_on?("#{tag_type}")
             end        
-          )
+          RUBY
         end        
       end
       
       def acts_as_taggable_on(*args)
         super(*args)
-        intialize_acts_as_taggable_on_cache
+        initialize_acts_as_taggable_on_cache
       end
       
       def caching_tag_list_on?(context)
@@ -40,7 +40,7 @@ module ActsAsTaggableOn::Taggable
         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(', ')
+              list = tag_list_cache_on(tag_type).to_a.flatten.compact.join(', ')
               self["cached_#{tag_type.singularize}_list"] = list
             end
           end