rylwin-acts-as-taggable-on 2.1.1a

data/lib/acts_as_taggable_on/taggable/ownership.rb

@@ -0,0 +1,105 @@
+module ActsAsTaggableOn::Taggable
+  module Ownership
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Ownership::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Ownership::ClassMethods
+     
+      base.class_eval do
+        after_save :save_owned_tags    
+      end
+      
+      base.initialize_acts_as_taggable_on_ownership
+    end
+    
+    module ClassMethods
+      def acts_as_taggable_on(*args)
+        initialize_acts_as_taggable_on_ownership
+        super(*args)
+      end
+      
+      def initialize_acts_as_taggable_on_ownership      
+        tag_types.map(&:to_s).each do |tag_type|
+          class_eval %(
+            def #{tag_type}_from(owner)
+              owner_tag_list_on(owner, '#{tag_type}')
+            end      
+          )
+        end        
+      end
+    end
+    
+    module InstanceMethods
+      def owner_tags_on(owner, context)
+        if owner.nil?
+          base_tags.where([%(#{ActsAsTaggableOn::Tagging.table_name}.context = ?), context.to_s]).all                    
+        else
+          base_tags.where([%(#{ActsAsTaggableOn::Tagging.table_name}.context = ? AND
+                             #{ActsAsTaggableOn::Tagging.table_name}.tagger_id = ? AND
+                             #{ActsAsTaggableOn::Tagging.table_name}.tagger_type = ?), context.to_s, owner.id, owner.class.to_s]).all          
+        end
+      end
+
+      def cached_owned_tag_list_on(context)
+        variable_name = "@owned_#{context}_list"
+        cache = instance_variable_get(variable_name) || instance_variable_set(variable_name, {})
+      end
+      
+      def owner_tag_list_on(owner, context)
+        add_custom_context(context)
+
+        cache = cached_owned_tag_list_on(context)
+        cache.delete_if { |key, value| key.id == owner.id && key.class == owner.class }
+        
+        cache[owner] ||= ActsAsTaggableOn::TagList.new(*owner_tags_on(owner, context).map(&:name))
+      end
+      
+      def set_owner_tag_list_on(owner, context, new_list)
+        add_custom_context(context)
+        
+        cache = cached_owned_tag_list_on(context)
+        cache.delete_if { |key, value| key.id == owner.id && key.class == owner.class }
+
+        cache[owner] = ActsAsTaggableOn::TagList.from(new_list)
+      end
+      
+      def reload(*args)
+        self.class.tag_types.each do |context|
+          instance_variable_set("@owned_#{context}_list", nil)
+        end
+      
+        super(*args)
+      end
+    
+      def save_owned_tags
+        tagging_contexts.each do |context|
+          cached_owned_tag_list_on(context).each do |owner, tag_list|
+            # Find existing tags or create non-existing tags:
+            tag_list = ActsAsTaggableOn::Tag.find_or_create_all_with_like_by_name(tag_list.uniq)            
+
+            owned_tags = owner_tags_on(owner, context)              
+            old_tags   = owned_tags - tag_list
+            new_tags   = tag_list   - owned_tags
+          
+            # Find all taggings that belong to the taggable (self), are owned by the owner, 
+            # have the correct context, and are removed from the list.
+            old_taggings = ActsAsTaggableOn::Tagging.where(:taggable_id => id, :taggable_type => self.class.base_class.to_s,
+                                                           :tagger_type => owner.class.to_s, :tagger_id => owner.id,
+                                                           :tag_id => old_tags, :context => context).all
+          
+            if old_taggings.present?
+              # Destroy old taggings:
+              ActsAsTaggableOn::Tagging.destroy_all(:id => old_taggings.map(&:id))
+            end
+
+            # Create new taggings:
+            new_tags.each do |tag|
+              taggings.create!(:tag_id => tag.id, :context => context.to_s, :tagger => owner, :taggable => self)
+            end
+          end
+        end
+        
+        true
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/taggable/related.rb

@@ -0,0 +1,73 @@
+module ActsAsTaggableOn::Taggable
+  module Related
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Related::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Related::ClassMethods
+      base.initialize_acts_as_taggable_on_related
+    end
+    
+    module ClassMethods
+      def initialize_acts_as_taggable_on_related
+        tag_types.map(&:to_s).each do |tag_type|
+          class_eval %(
+            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
+          )
+        end
+        
+        unless tag_types.empty?
+          class_eval %(
+            def find_matching_contexts(search_context, result_context, options = {})
+              matching_contexts_for(search_context.to_s, result_context.to_s, self.class, options)
+            end
+
+            def find_matching_contexts_for(klass, search_context, result_context, options = {})
+              matching_contexts_for(search_context.to_s, result_context.to_s, klass, options)
+            end
+          )
+        end        
+      end
+      
+      def acts_as_taggable_on(*args)
+        super(*args)
+        initialize_acts_as_taggable_on_related
+      end
+    end
+    
+    module InstanceMethods
+      def matching_contexts_for(search_context, result_context, klass, options = {})
+        tags_to_find = tags_on(search_context).collect { |t| t.name }
+
+        exclude_self = "#{klass.table_name}.#{klass.primary_key} != #{id} AND" if self.class == klass
+        
+        group_columns = ActsAsTaggableOn::Tag.using_postgresql? ? grouped_column_names_for(klass) : "#{klass.table_name}.#{klass.primary_key}"
+        
+        klass.scoped({ :select     => "#{klass.table_name}.*, COUNT(#{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key}) AS count",
+                       :from       => "#{klass.table_name}, #{ActsAsTaggableOn::Tag.table_name}, #{ActsAsTaggableOn::Tagging.table_name}",
+                       :conditions => ["#{exclude_self} #{klass.table_name}.#{klass.primary_key} = #{ActsAsTaggableOn::Tagging.table_name}.taggable_id AND #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = '#{klass.to_s}' AND #{ActsAsTaggableOn::Tagging.table_name}.tag_id = #{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key} AND #{ActsAsTaggableOn::Tag.table_name}.name IN (?) AND #{ActsAsTaggableOn::Tagging.table_name}.context = ?", tags_to_find, result_context],
+                       :group      => group_columns,
+                       :order      => "count DESC" }.update(options))
+      end
+      
+      def related_tags_for(context, klass, options = {})
+        tags_to_find = tags_on(context).collect { |t| t.name }
+
+        exclude_self = "#{klass.table_name}.#{klass.primary_key} != #{id} AND" if self.class == klass
+
+group_columns = ActsAsTaggableOn::Tag.using_postgresql? ? grouped_column_names_for(klass) : "#{klass.table_name}.#{klass.primary_key}"
+
+        klass.scoped({ :select     => "#{klass.table_name}.*, COUNT(#{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key}) AS count",
+                       :from       => "#{klass.table_name}, #{ActsAsTaggableOn::Tag.table_name}, #{ActsAsTaggableOn::Tagging.table_name}",
+                       :conditions => ["#{exclude_self} #{klass.table_name}.#{klass.primary_key} = #{ActsAsTaggableOn::Tagging.table_name}.taggable_id AND #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = '#{klass.to_s}' AND #{ActsAsTaggableOn::Tagging.table_name}.tag_id = #{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key} AND #{ActsAsTaggableOn::Tag.table_name}.name IN (?)", tags_to_find],
+                       :group      => group_columns,
+                       :order      => "count DESC" }.update(options))
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/taggable/tag.rb

@@ -0,0 +1,81 @@
+module ActsAsTaggableOn
+  class Tag < ::ActiveRecord::Base
+    include ActsAsTaggableOn::ActiveRecord::Backports if ::ActiveRecord::VERSION::MAJOR < 3
+    include ActsAsTaggableOn::Utils
+      
+    attr_accessible :name
+
+    ### ASSOCIATIONS:
+
+    has_many :taggings, :dependent => :destroy, :class_name => 'ActsAsTaggableOn::Tagging'
+
+    ### VALIDATIONS:
+
+    validates_presence_of :name
+    validates_uniqueness_of :name
+
+    ### SCOPES:
+    
+    def self.named(name)
+      where(["name #{like_operator} ?", escape_like(name)])
+    end
+  
+    def self.named_any(list)
+      where(list.map { |tag| sanitize_sql(["name #{like_operator} ?", escape_like(tag.to_s)]) }.join(" OR "))
+    end
+  
+    def self.named_like(name)
+      where(["name #{like_operator} ?", "%#{escape_like(name)}%"])
+    end
+
+    def self.named_like_any(list)
+      where(list.map { |tag| sanitize_sql(["name #{like_operator} ?", "%#{escape_like(tag.to_s)}%"]) }.join(" OR "))
+    end
+
+    ### CLASS METHODS:
+
+    def self.find_or_create_with_like_by_name(name)
+      named_like(name).first || create(:name => name)
+    end
+
+    def self.find_or_create_all_with_like_by_name(*list)
+      list = [list].flatten
+
+      return [] if list.empty?
+
+      existing_tags = Tag.named_any(list).all
+      new_tag_names = list.reject do |name| 
+                        name = comparable_name(name)
+                        existing_tags.any? { |tag| comparable_name(tag.name) == name }
+                      end
+      created_tags  = new_tag_names.map { |name| Tag.create(:name => name) }
+
+      existing_tags + created_tags
+    end
+
+    ### INSTANCE METHODS:
+
+    def ==(object)
+      super || (object.is_a?(Tag) && name == object.name)
+    end
+
+    def to_s
+      name
+    end
+
+    def count
+      read_attribute(:count).to_i
+    end
+    
+    def safe_name
+      name.gsub(/[^a-zA-Z0-9]/, '')
+    end
+    
+    class << self
+      private        
+        def comparable_name(str)
+          RUBY_VERSION >= "1.9" ? str.downcase : str.mb_chars.downcase
+        end
+    end
+  end
+end

data/lib/acts_as_taggable_on/taggable/tag_list.rb

@@ -0,0 +1,96 @@
+module ActsAsTaggableOn
+  class TagList < Array
+    cattr_accessor :delimiter
+    self.delimiter = ','
+
+    attr_accessor :owner
+
+    def initialize(*args)
+      add(*args)
+    end
+  
+    ##
+    # Returns a new TagList using the given tag string.
+    #
+    # Example:
+    #   tag_list = TagList.from("One , Two,  Three")
+    #   tag_list # ["One", "Two", "Three"]
+    def self.from(string)
+      glue   = delimiter.ends_with?(" ") ? delimiter : "#{delimiter} "
+      string = string.join(glue) if string.respond_to?(:join)
+
+      new.tap do |tag_list|
+        string = string.to_s.dup
+
+        # Parse the quoted tags
+        string.gsub!(/(\A|#{delimiter})\s*"(.*?)"\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
+        string.gsub!(/(\A|#{delimiter})\s*'(.*?)'\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
+
+        tag_list.add(string.split(delimiter))
+      end
+    end
+
+    ##
+    # Add tags to the tag_list. Duplicate or blank tags will be ignored.
+    # Use the <tt>:parse</tt> option to add an unparsed tag string.
+    #
+    # Example:
+    #   tag_list.add("Fun", "Happy")
+    #   tag_list.add("Fun, Happy", :parse => true)
+    def add(*names)
+      extract_and_apply_options!(names)
+      concat(names)
+      clean!
+      self
+    end
+
+    ##
+    # Remove specific tags from the tag_list.
+    # Use the <tt>:parse</tt> option to add an unparsed tag string.
+    #
+    # Example:
+    #   tag_list.remove("Sad", "Lonely")
+    #   tag_list.remove("Sad, Lonely", :parse => true)
+    def remove(*names)
+      extract_and_apply_options!(names)
+      delete_if { |name| names.include?(name) }
+      self
+    end
+
+    ##
+    # Transform the tag_list into a tag string suitable for edting in a form.
+    # The tags are joined with <tt>TagList.delimiter</tt> and quoted if necessary.
+    #
+    # Example:
+    #   tag_list = TagList.new("Round", "Square,Cube")
+    #   tag_list.to_s # 'Round, "Square,Cube"'
+    def to_s
+      tags = frozen? ? self.dup : self
+      tags.send(:clean!)
+
+      tags.map do |name|
+        name.include?(delimiter) ? "\"#{name}\"" : name
+      end.join(delimiter.ends_with?(" ") ? delimiter : "#{delimiter} ")
+    end
+
+    private
+  
+    # Remove whitespace, duplicates, and blanks.
+    def clean!
+      reject!(&:blank?)
+      map!(&:strip)
+      uniq!
+    end
+
+    def extract_and_apply_options!(args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options.assert_valid_keys :parse
+
+      if options[:parse]
+        args.map! { |a| self.class.from(a) }
+      end
+
+      args.flatten!
+    end
+  end
+end

data/lib/acts_as_taggable_on/taggable/tagging.rb

@@ -0,0 +1,24 @@
+module ActsAsTaggableOn
+  class Tagging < ::ActiveRecord::Base #:nodoc:
+    include ActsAsTaggableOn::ActiveRecord::Backports if ::ActiveRecord::VERSION::MAJOR < 3
+
+    attr_accessible :tag,
+                    :tag_id,
+                    :context,
+                    :taggable,
+                    :taggable_type,
+                    :taggable_id,
+                    :tagger,
+                    :tagger_type,
+                    :tagger_id
+
+    belongs_to :tag, :class_name => 'ActsAsTaggableOn::Tag'
+    belongs_to :taggable, :polymorphic => true
+    belongs_to :tagger,   :polymorphic => true
+
+    validates_presence_of :context
+    validates_presence_of :tag_id
+
+    validates_uniqueness_of :tag_id, :scope => [ :taggable_type, :taggable_id, :context, :tagger_id, :tagger_type ]
+  end
+end

data/lib/acts_as_taggable_on/taggable/tags_helper.rb

@@ -0,0 +1,17 @@
+module ActsAsTaggableOn
+  module TagsHelper
+    # See the README for an example using tag_cloud.
+    def tag_cloud(tags, classes)
+      tags = tags.all if tags.respond_to?(:all)
+
+      return [] if tags.empty?
+
+      max_count = tags.sort_by(&:count).last.count.to_f
+
+      tags.each do |tag|
+        index = ((tag.count / max_count) * (classes.size - 1)).round
+        yield tag, classes[index]
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/taggable/utils.rb

@@ -0,0 +1,31 @@
+module ActsAsTaggableOn
+  module Utils
+    def self.included(base)
+      
+      base.send :include, ActsAsTaggableOn::Utils::OverallMethods
+      base.extend ActsAsTaggableOn::Utils::OverallMethods      
+    end
+
+    module OverallMethods
+      def using_postgresql?
+        ::ActiveRecord::Base.connection && ::ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      end
+      
+      def using_sqlite?
+        ::ActiveRecord::Base.connection && ::ActiveRecord::Base.connection.adapter_name == 'SQLite'
+      end 
+        
+      private
+      def like_operator
+        using_postgresql? ? 'ILIKE' : 'LIKE'
+      end
+      
+      # escape _ and % characters in strings, since these are wildcards in SQL.
+       def escape_like(str)
+         return str if using_sqlite? # skip escaping for SQLite
+         str.to_s.gsub("_", "\\\_").gsub("%", "\\\%")
+       end
+    end
+
+  end
+end

data/lib/acts_as_taggable_on/taggable.rb

@@ -0,0 +1,63 @@
+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?
+        if RAILS_3
+          self.tag_types = (self.tag_types + tag_types).uniq        
+        else
+          write_inheritable_attribute(:tag_types, (self.tag_types + tag_types).uniq)                  
+        end
+      else
+        if RAILS_3
+          class_attribute :tag_types
+          self.tag_types = tag_types
+        else
+          write_inheritable_attribute(:tag_types, tag_types)
+          class_inheritable_reader(:tag_types)
+        end
+        
+        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::Utils        
+          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/tagging.rb

@@ -0,0 +1,24 @@
+module ActsAsTaggableOn
+  class Tagging < ::ActiveRecord::Base #:nodoc:
+    include ActsAsTaggableOn::ActiveRecord::Backports if ::ActiveRecord::VERSION::MAJOR < 3
+
+    attr_accessible :tag,
+                    :tag_id,
+                    :context,
+                    :taggable,
+                    :taggable_type,
+                    :taggable_id,
+                    :tagger,
+                    :tagger_type,
+                    :tagger_id
+
+    belongs_to :tag, :class_name => 'ActsAsTaggableOn::Tag'
+    belongs_to :taggable, :polymorphic => true
+    belongs_to :tagger,   :polymorphic => true
+
+    validates_presence_of :context
+    validates_presence_of :tag_id
+
+    validates_uniqueness_of :tag_id, :scope => [ :taggable_type, :taggable_id, :context, :tagger_id, :tagger_type ]
+  end
+end

data/lib/acts_as_taggable_on/tags_helper.rb

@@ -0,0 +1,17 @@
+module ActsAsTaggableOn
+  module TagsHelper
+    # See the README for an example using tag_cloud.
+    def tag_cloud(tags, classes)
+      tags = tags.all if tags.respond_to?(:all)
+
+      return [] if tags.empty?
+
+      max_count = tags.sort_by(&:count).last.count.to_f
+
+      tags.each do |tag|
+        index = ((tag.count / max_count) * (classes.size - 1)).round
+        yield tag, classes[index]
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/utils.rb

@@ -0,0 +1,31 @@
+module ActsAsTaggableOn
+  module Utils
+    def self.included(base)
+      
+      base.send :include, ActsAsTaggableOn::Utils::OverallMethods
+      base.extend ActsAsTaggableOn::Utils::OverallMethods      
+    end
+
+    module OverallMethods
+      def using_postgresql?
+        ::ActiveRecord::Base.connection && ::ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      end
+      
+      def using_sqlite?
+        ::ActiveRecord::Base.connection && ::ActiveRecord::Base.connection.adapter_name == 'SQLite'
+      end 
+        
+      private
+      def like_operator
+        using_postgresql? ? 'ILIKE' : 'LIKE'
+      end
+      
+      # escape _ and % characters in strings, since these are wildcards in SQL.
+       def escape_like(str)
+         return str if using_sqlite? # skip escaping for SQLite
+         str.to_s.gsub("_", "\\\_").gsub("%", "\\\%")
+       end
+    end
+
+  end
+end

data/lib/generators/acts_as_taggable_on/migration/migration_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ActsAsTaggableOn
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for Tag and Tagging models"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/acts_as_taggable_on_migration'
+      end
+    end
+  end
+end
+

data/lib/generators/acts_as_taggable_on/migration/templates/active_record/migration.rb

@@ -0,0 +1,28 @@
+class ActsAsTaggableOnMigration < ActiveRecord::Migration
+  def self.up
+    create_table :tags do |t|
+      t.string :name
+    end
+
+    create_table :taggings do |t|
+      t.references :tag
+
+      # You should make sure that the column created is
+      # long enough to store the required class names.
+      t.references :taggable, :polymorphic => true
+      t.references :tagger, :polymorphic => true
+
+      t.string :context
+
+      t.datetime :created_at
+    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/rails/init.rb

@@ -0,0 +1 @@
+require 'acts-as-taggable-on'