acts_as_taggable_on 3.0.0.rc1

data/lib/acts_as_taggable_on/acts_as_taggable_on/dirty.rb

@@ -0,0 +1,37 @@
+module ActsAsTaggableOn::Taggable
+  module Dirty
+    def self.included(base)
+      base.extend ActsAsTaggableOn::Taggable::Dirty::ClassMethods
+
+      base.initialize_acts_as_taggable_on_dirty
+    end
+
+    module ClassMethods
+      def initialize_acts_as_taggable_on_dirty
+        tag_types.map(&:to_s).each do |tags_type|
+          tag_type         = tags_type.to_s.singularize
+          context_tags     = tags_type.to_sym
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{tag_type}_list_changed?
+              changed_attributes.include?("#{tag_type}_list")
+            end
+
+            def #{tag_type}_list_was
+              changed_attributes.include?("#{tag_type}_list") ? changed_attributes["#{tag_type}_list"] : __send__("#{tag_type}_list")
+            end
+
+            def #{tag_type}_list_change
+              [changed_attributes['#{tag_type}_list'], __send__('#{tag_type}_list')] if changed_attributes.include?("#{tag_type}_list")
+            end
+
+            def #{tag_type}_list_changes
+              [changed_attributes['#{tag_type}_list'], __send__('#{tag_type}_list')] if changed_attributes.include?("#{tag_type}_list")
+            end
+          RUBY
+
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_taggable_on/ownership.rb

@@ -0,0 +1,135 @@
+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 <<-RUBY, __FILE__, __LINE__ + 1
+            def #{tag_type}_from(owner)
+              owner_tag_list_on(owner, '#{tag_type}')
+            end      
+          RUBY
+        end        
+      end
+    end
+    
+    module InstanceMethods
+      def owner_tags_on(owner, context)
+        if owner.nil?
+          scope = base_tags.where([%(#{ActsAsTaggableOn::Tagging.table_name}.context = ?), context.to_s])                    
+        else
+          scope = 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.base_class.to_s])          
+        end
+
+        # when preserving tag order, return tags in created order
+        # if we added the order to the association this would always apply
+        if self.class.preserve_tag_order?
+          scope.order("#{ActsAsTaggableOn::Tagging.table_name}.id")
+        else 
+          scope
+        end
+      end
+
+      def cached_owned_tag_list_on(context)
+        variable_name = "@owned_#{context}_list"
+        cache = (instance_variable_defined?(variable_name) && 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[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[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:
+            tags = ActsAsTaggableOn::Tag.find_or_create_all_with_like_by_name(tag_list.uniq)            
+
+            # Tag objects for owned tags
+            owned_tags = owner_tags_on(owner, context)
+               
+            # Tag maintenance based on whether preserving the created order of tags
+            if self.class.preserve_tag_order?
+              old_tags, new_tags = owned_tags - tags, tags - owned_tags
+
+              shared_tags = owned_tags & tags
+
+              if shared_tags.any? && tags[0...shared_tags.size] != shared_tags
+                index = shared_tags.each_with_index { |_, i| break i unless shared_tags[i] == tags[i] }
+
+                # Update arrays of tag objects
+                old_tags |= owned_tags.from(index)
+                new_tags |= owned_tags.from(index) & shared_tags
+
+                # Order the array of tag objects to match the tag list
+                new_tags = tags.map { |t| new_tags.find { |n| n.name.downcase == t.name.downcase } }.compact
+              end
+            else
+              # Delete discarded tags and create new tags
+              old_tags = owned_tags - tags
+              new_tags = tags - owned_tags
+            end
+          
+            # Find all taggings that belong to the taggable (self), are owned by the owner, 
+            # have the correct context, and are removed from the list.
+            if old_tags.present?
+              old_taggings = ActsAsTaggableOn::Tagging.where(:taggable_id => id, :taggable_type => self.class.base_class.to_s,
+                                                             :tagger_type => owner.class.base_class.to_s, :tagger_id => owner.id,
+                                                             :tag_id => old_tags, :context => context)
+            end
+          
+            # Destroy old taggings:
+            if old_taggings.present?
+              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/acts_as_taggable_on/related.rb

@@ -0,0 +1,84 @@
+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 <<-RUBY, __FILE__, __LINE__ + 1
+            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
+          RUBY
+        end
+
+        unless tag_types.empty?
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            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
+          RUBY
+        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 }
+
+        klass.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}") \
+             .where(["#{exclude_self(klass, id)} #{klass.table_name}.#{klass.primary_key} = #{ActsAsTaggableOn::Tagging.table_name}.taggable_id AND #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = '#{klass.base_class.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(klass)) \
+             .order("count DESC")
+      end
+
+      def related_tags_for(context, klass, options = {})
+				tags_to_ignore = Array.wrap(options.delete(:ignore)).map(&:to_s) || []
+        tags_to_find = tags_on(context).collect { |t| t.name }.reject { |t| tags_to_ignore.include? t }
+
+        klass.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}") \
+             .where(["#{exclude_self(klass, id)} #{klass.table_name}.#{klass.primary_key} = #{ActsAsTaggableOn::Tagging.table_name}.taggable_id AND #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = '#{klass.base_class.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(klass)) \
+             .order("count DESC")
+      end
+
+      private
+      
+      def exclude_self(klass, id)
+        if [self.class.base_class, self.class].include? klass
+          "#{klass.table_name}.#{klass.primary_key} != #{id} AND" 
+        else
+          nil
+        end
+      end
+
+      def group_columns(klass)
+        if ActsAsTaggableOn::Tag.using_postgresql? 
+          grouped_column_names_for(klass)
+        else
+          "#{klass.table_name}.#{klass.primary_key}"
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/engine'
+module ActsAsTaggableOn
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/acts_as_taggable_on/tag.rb

@@ -0,0 +1,119 @@
+# coding: utf-8
+module ActsAsTaggableOn
+  class Tag < ::ActiveRecord::Base
+    include ActsAsTaggableOn::Utils
+
+    attr_accessible :name if defined?(ActiveModel::MassAssignmentSecurity)
+
+    ### ASSOCIATIONS:
+
+    has_many :taggings, :dependent => :destroy, :class_name => 'ActsAsTaggableOn::Tagging'
+
+    ### VALIDATIONS:
+
+    validates_presence_of :name
+    validates_uniqueness_of :name, :if => :validates_name_uniqueness?
+    validates_length_of :name, :maximum => 255
+
+    # monkey patch this method if don't need name uniqueness validation
+    def validates_name_uniqueness?
+      true
+    end
+
+    ### SCOPES:
+
+    def self.named(name)
+      if ActsAsTaggableOn.strict_case_match
+        where(["name = #{binary}?", name])
+      else
+        where(["lower(name) = ?", name.downcase])
+      end
+    end
+
+    def self.named_any(list)
+      if ActsAsTaggableOn.strict_case_match
+        clause = list.map { |tag|
+          sanitize_sql(["name = #{binary}?", as_8bit_ascii(tag)])
+        }.join(" OR ")
+        where(clause)
+      else
+        clause = list.map { |tag|
+          lowercase_ascii_tag = as_8bit_ascii(tag).downcase
+          sanitize_sql(["lower(name) = ?", lowercase_ascii_tag])
+        }.join(" OR ")
+        where(clause)
+      end
+    end
+
+    def self.named_like(name)
+      clause = ["name #{like_operator} ? ESCAPE '!'", "%#{escape_like(name)}%"]
+      where(clause)
+    end
+
+    def self.named_like_any(list)
+      clause = list.map { |tag|
+        sanitize_sql(["name #{like_operator} ? ESCAPE '!'", "%#{escape_like(tag.to_s)}%"])
+      }.join(" OR ")
+      where(clause)
+    end
+
+    ### CLASS METHODS:
+
+    def self.find_or_create_with_like_by_name(name)
+      if (ActsAsTaggableOn.strict_case_match)
+        self.find_or_create_all_with_like_by_name([name]).first
+      else
+        named_like(name).first || create(:name => name)
+      end
+    end
+
+    def self.find_or_create_all_with_like_by_name(*list)
+      list = Array(list).flatten
+
+      return [] if list.empty?
+
+      existing_tags = Tag.named_any(list)
+
+      list.map do |tag_name|
+        comparable_tag_name = comparable_name(tag_name)
+        existing_tag = existing_tags.detect { |tag| comparable_name(tag.name) == comparable_tag_name }
+
+        existing_tag || Tag.create(:name => tag_name)
+      end
+    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
+
+    class << self
+      private
+
+      def comparable_name(str)
+        as_8bit_ascii(str).downcase
+      end
+
+      def binary
+        /mysql/ === ActiveRecord::Base.connection_config[:adapter] ? "BINARY " : nil
+      end
+
+      def as_8bit_ascii(string)
+        if defined?(Encoding)
+          string.to_s.force_encoding('BINARY')
+        else
+          string.to_s.mb_chars
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/tag_list.rb

@@ -0,0 +1,101 @@
+require 'active_support/core_ext/module/delegation'
+
+module ActsAsTaggableOn
+  class TagList < Array
+    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)
+      string = string.join(ActsAsTaggableOn.glue) if string.respond_to?(:join)
+
+      new.tap do |tag_list|
+        string = string.to_s.dup
+
+        # Parse the quoted tags
+        d = ActsAsTaggableOn.delimiter
+        d = d.join("|") if d.kind_of?(Array) 
+        string.gsub!(/(\A|#{d})\s*"(.*?)"\s*(#{d}\s*|\z)/) { tag_list << $2; $3 }
+        string.gsub!(/(\A|#{d})\s*'(.*?)'\s*(#{d}\s*|\z)/) { tag_list << $2; $3 }
+
+        tag_list.add(string.split(Regexp.new d))
+      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 editing 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|
+        d = ActsAsTaggableOn.delimiter
+        d = Regexp.new d.join("|") if d.kind_of? Array
+        name.index(d) ? "\"#{name}\"" : name
+      end.join(ActsAsTaggableOn.glue)
+    end
+
+    private
+
+    # Remove whitespace, duplicates, and blanks.
+    def clean!
+      reject!(&:blank?)
+      map!(&:strip)
+      map!{ |tag| tag.mb_chars.downcase.to_s } if ActsAsTaggableOn.force_lowercase
+      map!(&:parameterize) if ActsAsTaggableOn.force_parameterize
+
+      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