acts-as-taggable-on 2.2.2 → 2.3.0

data/.gitignore

@@ -5,4 +5,6 @@
 .rvmrc
 Gemfile.lock
 spec/database.yml
-tmp
+tmp*.sw?
+*.sw?
+tmp

data/README.rdoc

@@ -16,17 +16,15 @@ was used.
 
 == Installation
 
-=== Rails 2.3.x
+=== Rails 2.x
 
-To use it, add it to your Gemfile:
-
-  gem 'acts-as-taggable-on', '~>2.1.0'
+Not supported any more! It is time for update guys.
 
 === Rails 3.x
 
 To use it, add it to your Gemfile:
 
-  gem 'acts-as-taggable-on', '~>2.2.0'
+  gem 'acts-as-taggable-on', '~> 2.2.2'
 
 ==== Post Installation
 
@@ -61,6 +59,25 @@ directory, you can run the specs for RoR 3.x with:
     User.skill_counts # => [<Tag name="joking" count=2>,<Tag name="clowning" count=1>...]
     @frankie.skill_counts
 
+To preserve the order in which tags are created use acts_as_ordered_taggable:
+
+    class User < ActiveRecord::Base
+      # Alias for <tt>acts_as_ordered_taggable_on :tags</tt>:
+      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 utilizes named_scopes to create an association for tags.
@@ -76,19 +93,19 @@ compatibility with the will_paginate gem:
     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)
+    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
@@ -141,6 +158,21 @@ Tags can have owners:
     @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
+
+    @bobby = User.find_by_name("Bobby")
+    @bobby.skill_list # => ["jogging", "diving"]
+
+    @boddy.skill_list_changed? #=> false
+    @boddy.changes #=> {}
+
+    @bobby.skill_list = "swimming"
+    @bobby.changes.should == {"skill_list"=>["jogging, diving", ["swimming"]]}
+    @boddy.skill_list_changed? #=> true
+
+    @bobby.skill_list_change.should == ["jogging, diving", ["swimming"]]
 
 === Tag cloud calculations
 
@@ -182,14 +214,21 @@ CSS:
   .css3 { font-size: 1.4em; }
   .css4 { font-size: 1.6em; }
 
-== Remove unused tags
+== Configuration
+
+If you would like to remove unused tag objects after removing taggings, add
+
+  ActsAsTaggableOn.remove_unused_tags = true
+
+If you want force tags to be saved downcased:
+
+  ActsAsTaggableOn.force_lowercase = true
+
+If you want tags to be saved parametrized (you can redefine to_param as well):
+
+  ActsAsTaggableOn.force_parameterize = true
+
 
-If you would like to remove unused tag objects after removing taggings, add 
-  
-  ActsAsTaggableOn::Tag.remove_unused = true                  
-  
-to initializer file.
-  
 == Contributors
 
 We have a long list of valued contributors. {Check them all}[https://github.com/mbleigh/acts-as-taggable-on/contributors]

data/acts-as-taggable-on.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = ''
 
   gem.add_runtime_dependency 'rails', '~> 3.0'
-  gem.add_development_dependency 'rspec', '~> 2.5'
+  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'

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

@@ -6,6 +6,29 @@ require "digest/sha1"
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+module ActsAsTaggableOn
+  mattr_accessor :delimiter
+  @@delimiter = ','
+
+  mattr_accessor :force_lowercase
+  @@force_lowercase = false
+
+  mattr_accessor :force_parameterize
+  @@force_parameterize = false
+
+  mattr_accessor :remove_unused_tags
+  self.remove_unused_tags = false
+
+  def self.glue
+    @@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"
@@ -14,6 +37,7 @@ 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/tagger"
 require "acts_as_taggable_on/tag"
@@ -31,4 +55,5 @@ end
 
 if defined?(ActionView::Base)
   ActionView::Base.send :include, ActsAsTaggableOn::TagsHelper
-end
+end
+

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

@@ -1,4 +1,4 @@
 module ActsAsTaggableOn
-  VERSION = '2.2.2'
+  VERSION = '2.3.0'
 end
 

data/lib/acts_as_taggable_on/acts_as_taggable_on/core.rb

@@ -18,11 +18,22 @@ module ActsAsTaggableOn::Taggable
           tag_type         = tags_type.to_s.singularize
           context_taggings = "#{tag_type}_taggings".to_sym
           context_tags     = tags_type.to_sym
-
+          taggings_order   = (preserve_tag_order? ? "#{ActsAsTaggableOn::Tagging.table_name}.id" : nil)
+          
           class_eval do
-                    has_many context_taggings, :as => :taggable, :dependent => :destroy, :include => :tag, :class_name => "ActsAsTaggableOn::Tagging",
-                    :conditions => ["#{ActsAsTaggableOn::Tagging.table_name}.context = ?", tags_type]
-                    has_many context_tags, :through => context_taggings, :source => :tag, :class_name => "ActsAsTaggableOn::Tag"
+            # when preserving tag order, include order option so that for a 'tags' context
+            # the associations tag_taggings & tags are always returned in created order
+            has_many context_taggings, :as => :taggable,
+                                       :dependent => :destroy,
+                                       :include => :tag,
+                                       :class_name => "ActsAsTaggableOn::Tagging",
+                                       :conditions => ["#{ActsAsTaggableOn::Tagging.table_name}.context = ?", tags_type],
+                                       :order => taggings_order
+                                       
+            has_many context_tags, :through => context_taggings,
+                                   :source => :tag,
+                                   :class_name => "ActsAsTaggableOn::Tag",
+                                   :order => taggings_order
           end
 
           class_eval %(
@@ -41,11 +52,11 @@ module ActsAsTaggableOn::Taggable
         end
       end
 
-      def acts_as_taggable_on(*args)
-        super(*args)
+      def taggable_on(preserve_tag_order, *tag_types)
+        super(preserve_tag_order, *tag_types)
         initialize_acts_as_taggable_on_core
       end
-
+      
       # all column names are necessary for PostgreSQL group clause
       def grouped_column_names_for(object)
         object.column_names.map { |column| "#{object.table_name}.#{column}" }.join(", ")
@@ -85,8 +96,8 @@ module ActsAsTaggableOn::Taggable
             tags_conditions = tag_list.map { |t| sanitize_sql(["#{ActsAsTaggableOn::Tag.table_name}.name #{like_operator} ? ESCAPE '!'", "%#{escape_like(t)}%"]) }.join(" OR ")
           else
             tags_conditions = tag_list.map { |t| sanitize_sql(["#{ActsAsTaggableOn::Tag.table_name}.name #{like_operator} ?", t]) }.join(" OR ")
-          end 
-          
+          end
+
           conditions << "#{table_name}.#{primary_key} NOT IN (SELECT #{ActsAsTaggableOn::Tagging.table_name}.taggable_id FROM #{ActsAsTaggableOn::Tagging.table_name} JOIN #{ActsAsTaggableOn::Tag.table_name} ON #{ActsAsTaggableOn::Tagging.table_name}.tag_id = #{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key} AND (#{tags_conditions}) WHERE #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = #{quote_value(base_class.name)})"
 
         elsif options.delete(:any)
@@ -94,16 +105,18 @@ module ActsAsTaggableOn::Taggable
           if options.delete(:wild)
             tags = ActsAsTaggableOn::Tag.named_like_any(tag_list)
           else
-            tags = ActsAsTaggableOn::Tag.named_any(tag_list)            
+            tags = ActsAsTaggableOn::Tag.named_any(tag_list)
           end
-          
+
           return scoped(:conditions => "1 = 0") unless tags.length > 0
 
           # setup taggings alias so we can chain, ex: items_locations_taggings_awesome_cool_123
           # avoid ambiguous column name
           taggings_context = context ? "_#{context}" : ''
 
-          taggings_alias   = "#{alias_base_name[0..4]}#{taggings_context[0..6]}_taggings_#{sha_prefix(tags.map(&:safe_name).join('_'))}"
+          taggings_alias   = adjust_taggings_alias(
+            "#{alias_base_name[0..4]}#{taggings_context[0..6]}_taggings_#{sha_prefix(tags.map(&:name).join('_'))}"
+          )
 
           tagging_join  = "JOIN #{ActsAsTaggableOn::Tagging.table_name} #{taggings_alias}" +
                           "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
@@ -117,12 +130,12 @@ module ActsAsTaggableOn::Taggable
           joins << tagging_join
 
         else
-          tags = ActsAsTaggableOn::Tag.named_any(tag_list)   
-          return empty_result unless tags.length == tag_list.length                     
+          tags = ActsAsTaggableOn::Tag.named_any(tag_list)
+          return empty_result unless tags.length == tag_list.length
 
           tags.each do |tag|
 
-            taggings_alias = "#{alias_base_name[0..11]}_taggings_#{sha_prefix(tag.safe_name)}"
+            taggings_alias = adjust_taggings_alias("#{alias_base_name[0..11]}_taggings_#{sha_prefix(tag.name)}")
 
             tagging_join  = "JOIN #{ActsAsTaggableOn::Tagging.table_name} #{taggings_alias}" +
                             "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
@@ -143,7 +156,7 @@ module ActsAsTaggableOn::Taggable
           end
         end
 
-        taggings_alias, tags_alias = "#{alias_base_name}_taggings_group", "#{alias_base_name}_tags_group"
+        taggings_alias, tags_alias = adjust_taggings_alias("#{alias_base_name}_taggings_group"), "#{alias_base_name}_tags_group"
 
         if options.delete(:match_all)
           joins << "LEFT OUTER JOIN #{ActsAsTaggableOn::Tagging.table_name} #{taggings_alias}" +
@@ -166,6 +179,13 @@ module ActsAsTaggableOn::Taggable
       def is_taggable?
         true
       end
+
+      def adjust_taggings_alias(taggings_alias)
+        if taggings_alias.size > 75
+          taggings_alias = 'taggings_alias_' + Digest::SHA1.hexdigest(taggings_alias)
+        end
+        taggings_alias
+      end
     end
 
     module InstanceMethods
@@ -234,13 +254,19 @@ module ActsAsTaggableOn::Taggable
       ##
       # Returns all tags that are not owned of a given context
       def tags_on(context)
-        base_tags.where(["#{ActsAsTaggableOn::Tagging.table_name}.context = ? AND #{ActsAsTaggableOn::Tagging.table_name}.tagger_id IS NULL", context.to_s]).all
+        scope = base_tags.where(["#{ActsAsTaggableOn::Tagging.table_name}.context = ? AND #{ActsAsTaggableOn::Tagging.table_name}.tagger_id IS NULL", context.to_s])
+        # when preserving tag order, return tags in created order
+        # if we added the order to the association this would always apply
+        scope = scope.order("#{ActsAsTaggableOn::Tagging.table_name}.id") if self.class.preserve_tag_order?
+        scope.all
       end
 
       def set_tag_list_on(context, new_list)
         add_custom_context(context)
 
         variable_name = "@#{context.to_s.singularize}_list"
+        process_dirty_object(context, new_list) unless custom_contexts.include?(context.to_s)
+
         instance_variable_set(variable_name, ActsAsTaggableOn::TagList.from(new_list))
       end
 
@@ -248,6 +274,20 @@ module ActsAsTaggableOn::Taggable
         custom_contexts + self.class.tag_types.map(&:to_s)
       end
 
+      def process_dirty_object(context,new_list)
+        value = new_list.is_a?(Array) ? new_list.join(', ') : new_list
+        attrib = "#{context.to_s.singularize}_list"
+
+        if changed_attributes.include?(attrib)
+          # The attribute already has an unsaved change.
+          old = changed_attributes[attrib]
+          changed_attributes.delete(attrib) if (old.to_s == value.to_s)
+        else
+          old = tag_list_on(context).to_s
+          changed_attributes[attrib] = old if (old.to_s != value.to_s)
+        end
+      end
+
       def reload(*args)
         self.class.tag_types.each do |context|
           instance_variable_set("@#{context.to_s.singularize}_list", nil)
@@ -261,21 +301,38 @@ module ActsAsTaggableOn::Taggable
         tagging_contexts.each do |context|
           next unless tag_list_cache_set_on(context)
 
+          # List of currently assigned tag names
           tag_list = tag_list_cache_on(context).uniq
 
           # Find existing tags or create non-existing tags:
-          tag_list = ActsAsTaggableOn::Tag.find_or_create_all_with_like_by_name(tag_list)
+          tags = ActsAsTaggableOn::Tag.find_or_create_all_with_like_by_name(tag_list)
 
+          # Tag objects for currently assigned tags
           current_tags = tags_on(context)
-          old_tags     = current_tags - tag_list
-          new_tags     = tag_list     - current_tags
+
+          # Tag maintenance based on whether preserving the created order of tags
+          if self.class.preserve_tag_order?
+            # First off order the array of tag objects to match the tag list
+            # rather than existing tags followed by new tags
+            tags = tag_list.map{|l| tags.detect{|t| t.name.downcase == l.downcase}}
+            # To preserve tags in the order in which they were added
+            # delete all current tags and create new tags if the content or order has changed
+            old_tags = (tags == current_tags ? [] : current_tags)
+            new_tags = (tags == current_tags ? [] : tags)
+          else
+            # Delete discarded tags and create new tags
+            old_tags = current_tags - tags
+            new_tags = tags - current_tags
+          end
 
           # Find taggings to remove:
-          old_taggings = taggings.where(:tagger_type => nil, :tagger_id => nil,
-                                        :context => context.to_s, :tag_id => old_tags).all
+          if old_tags.present?
+            old_taggings = taggings.where(:tagger_type => nil, :tagger_id => nil,
+                                          :context => context.to_s, :tag_id => old_tags).all
+          end
 
+          # Destroy old taggings:
           if old_taggings.present?
-            # Destroy old taggings:
             ActsAsTaggableOn::Tagging.destroy_all "#{ActsAsTaggableOn::Tagging.primary_key}".to_sym => old_taggings.map(&:id)
           end
 

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 %(
+            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
+          )
+
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on/acts_as_taggable_on/ownership.rb

@@ -31,12 +31,16 @@ module ActsAsTaggableOn::Taggable
     module InstanceMethods
       def owner_tags_on(owner, context)
         if owner.nil?
-          base_tags.where([%(#{ActsAsTaggableOn::Tagging.table_name}.context = ?), context.to_s]).all                    
+          scope = base_tags.where([%(#{ActsAsTaggableOn::Tagging.table_name}.context = ?), context.to_s])                    
         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          
+          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.to_s])          
         end
+        # when preserving tag order, return tags in created order
+        # if we added the order to the association this would always apply
+        scope = scope.order("#{ActsAsTaggableOn::Tagging.table_name}.id") if self.class.preserve_tag_order?
+        scope.all
       end
 
       def cached_owned_tag_list_on(context)
@@ -73,21 +77,38 @@ module ActsAsTaggableOn::Taggable
       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)            
+            tags = 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
+            # 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?
+              # First off order the array of tag objects to match the tag list
+              # rather than existing tags followed by new tags
+              tags = tag_list.uniq.map{|s| tags.detect{|t| t.name.downcase == s.downcase}}
+              # To preserve tags in the order in which they were added
+              # delete all owned tags and create new tags if the content or order has changed
+              old_tags = (tags == owned_tags ? [] : owned_tags)
+              new_tags = (tags == owned_tags ? [] : tags)
+            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.
-            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_tags.present?
+              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
+            end
           
+            # Destroy old taggings:
             if old_taggings.present?
-              # Destroy old taggings:
               ActsAsTaggableOn::Tagging.destroy_all(:id => old_taggings.map(&:id))
             end