acts-as-taggable-on-padrino 0.0.1

data/lib/acts_as_taggable_on_padrino/taggable.rb

@@ -0,0 +1,64 @@
+module ActsAsTaggableOn
+  module Taggable
+    def taggable?
+      false
+    end
+
+    ##
+    # This is an alias for calling <tt>acts_as_taggable_on_padrino :tags</tt>.
+    #
+    # Example:
+    #   class Book < ActiveRecord::Base
+    #     acts_as_taggable
+    #   end
+    def acts_as_taggable(opts = {})
+      acts_as_taggable_on :tags, opts
+    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_padrino :languages, :skills
+    #   end
+    def acts_as_taggable_on(*tag_types)
+      opts = tag_types.extract_options!
+      opts.assert_valid_keys :tag, :tagging
+
+      tag_types = tag_types.to_a.flatten.compact.map {|type| type.to_sym }
+
+      if taggable?
+        write_inheritable_attribute(:tag_types, (self.tag_types + tag_types).uniq)
+      else
+        opts.reverse_merge!(:tag => 'Tag', :tagging => 'Tagging')
+        tag_class_name = opts[:tag]
+        tagging_class_name = opts[:tagging]
+        tag = tag_class_name.constantize
+        tagging = tagging_class_name.constantize
+
+        write_inheritable_attribute(:tag_types, tag_types)
+        write_inheritable_attribute(:acts_as_taggable_on_tag_model, tag)
+        write_inheritable_attribute(:acts_as_taggable_on_tagging_model, tagging)
+        class_inheritable_reader(:tag_types, :acts_as_taggable_on_tagging_model, :acts_as_taggable_on_tag_model)
+
+        class_eval do
+          has_many :taggings, :as => :taggable, :dependent => :destroy, :include => :tag, :class_name => tagging_class_name
+          has_many :base_tags, :through => :taggings, :source => :tag, :class_name => tag_class_name
+
+          def self.taggable?
+            true
+          end
+
+          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_padrino/taggable/cache.rb

@@ -0,0 +1,54 @@
+module ActsAsTaggableOn::Taggable
+  module Cache
+    def self.included(base)
+      # Skip adding caching capabilities if table not exists or no cache columns exist
+      return unless base.table_exists? && base.tag_types.any? { |context| base.column_names.include?("cached_#{context.to_s.singularize}_list") }
+
+      base.send :include, ActsAsTaggableOn::Taggable::Cache::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Cache::ClassMethods
+
+      base.class_eval do
+        before_save :save_cached_tag_list
+      end
+
+      base.initialize_acts_as_taggable_on_cache
+    end
+
+    module ClassMethods
+      def initialize_acts_as_taggable_on_cache
+        tag_types.each do |tag_type|
+          class_eval %(
+            def self.caching_#{tag_type.to_s.singularize}_list?
+              caching_tag_list_on?("#{tag_type}")
+            end
+          )
+        end
+      end
+
+      def acts_as_taggable_on(*args)
+        super
+        initialize_acts_as_taggable_on_cache
+      end
+
+      def caching_tag_list_on?(context)
+        column_names.include?("cached_#{context.to_s.singularize}_list")
+      end
+    end
+
+    module InstanceMethods
+      def save_cached_tag_list
+        tag_types.each do |tag_type|
+          tag_type = tag_type.to_s.singularize
+          if self.class.send("caching_#{tag_type}_list?")
+            if tag_list_cache_set_on(tag_type)
+              list = tag_list_cache_on(tag_type).to_a.flatten.compact.join(', ')
+              self["cached_#{tag_type}_list"] = list
+            end
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on_padrino/taggable/collection.rb

@@ -0,0 +1,91 @@
+module ActsAsTaggableOn::Taggable
+  module Collection
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Collection::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Collection::ClassMethods
+      base.initialize_acts_as_taggable_on_collection
+    end
+
+    module ClassMethods
+      def initialize_acts_as_taggable_on_collection
+        tag_types.each do |tag_type|
+          singular_tag_type = tag_type.to_s.singularize
+          class_eval %(
+            def self.#{singular_tag_type}_counts(options={})
+              tag_counts_on('#{tag_type}', options)
+            end
+
+            def #{singular_tag_type}_counts(options = {})
+              tag_counts_on('#{tag_type}', options)
+            end
+
+            def top_#{tag_type}(limit = 10)
+              tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
+            end
+
+            def self.top_#{tag_type}(limit = 10)
+              tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
+            end
+          )
+        end
+      end
+
+      def acts_as_taggable_on(*args)
+        super
+        initialize_acts_as_taggable_on_collection
+      end
+
+      def tag_counts_on(context, options = {})
+        all_tag_counts(options.merge({:on => context.to_s}))
+      end
+
+      ##
+      # Calculate the tag counts for all tags.
+      #
+      # @param [Hash] options Options:
+      #                       * :start_at   - Restrict the tags to those created after a certain time
+      #                       * :end_at     - Restrict the tags to those created before a certain time
+      #                       * :conditions - A piece of SQL conditions to add to the query
+      #                       * :limit      - The maximum number of tags to return
+      #                       * :order      - A piece of SQL to order by. Eg 'tags.count desc' or 'taggings.created_at desc'
+      #                       * :at_least   - Exclude tags with a frequency less than the given value
+      #                       * :at_most    - Exclude tags with a frequency greater than the given value
+      #                       * :on         - Scope the find to only include a certain context
+      def all_tag_counts(options = {})
+        options.assert_valid_keys :start_at, :end_at, :conditions, :at_least, :at_most, :order, :limit, :on, :id
+
+        ## Generate scope:
+        tagging_scope = acts_as_taggable_on_tagging_model.select("#{acts_as_taggable_on_tagging_model.table_name}.tag_id, COUNT(#{acts_as_taggable_on_tagging_model.table_name}.tag_id) AS tags_count").
+            joins("INNER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{acts_as_taggable_on_tagging_model.table_name}.taggable_id").
+            where(:taggable_type => base_class.name)
+        tagging_scope = tagging_scope.where(table_name => {inheritance_column => name}) unless descends_from_active_record? # Current model is STI descendant, so add type checking to the join condition
+        tagging_scope = tagging_scope.where(:taggable_id => options.delete(:id)) if options[:id]
+        tagging_scope = tagging_scope.where(:context => options.delete(:on).to_s) if options[:on]
+        tagging_scope = tagging_scope.where(["#{acts_as_taggable_on_tagging_model.table_name}.created_at >= ?", options.delete(:start_at)]) if options[:start_at]
+        tagging_scope = tagging_scope.where(["#{acts_as_taggable_on_tagging_model.table_name}.created_at <= ?", options.delete(:end_at)]) if options[:end_at]
+
+        tag_scope = acts_as_taggable_on_tag_model.select("#{acts_as_taggable_on_tag_model.table_name}.*, #{acts_as_taggable_on_tagging_model.table_name}.tags_count AS count").order(options[:order]).limit(options[:limit])
+        tag_scope.where(options[:conditions]) if options[:conditions]
+
+        # GROUP BY and HAVING clauses:
+        at_least  = sanitize_sql(['tags_count >= ?', options.delete(:at_least)]) if options[:at_least]
+        at_most   = sanitize_sql(['tags_count <= ?', options.delete(:at_most)]) if options[:at_most]
+        having    = ["COUNT(#{acts_as_taggable_on_tagging_model.table_name}.tag_id) > 0", at_least, at_most].compact.join(' AND ')
+
+        # Append the current scope to the scope, because we can't use scope(:find) in RoR 3.0 anymore:
+        tagging_scope = tagging_scope.where(:taggable_id => select("#{table_name}.#{primary_key}")).
+                                      group("#{acts_as_taggable_on_tagging_model.table_name}.tag_id").
+                                      having(having)
+
+        tag_scope = tag_scope.joins("JOIN (#{tagging_scope.to_sql}) AS taggings ON taggings.tag_id = tags.id")
+        tag_scope
+      end
+    end
+
+    module InstanceMethods
+      def tag_counts_on(context, options={})
+        self.class.tag_counts_on(context, options.merge(:id => id))
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on_padrino/taggable/core.rb

@@ -0,0 +1,244 @@
+module ActsAsTaggableOn::Taggable
+  module Core
+    def self.included(base)
+      base.send :include, ActsAsTaggableOn::Taggable::Core::InstanceMethods
+      base.extend ActsAsTaggableOn::Taggable::Core::ClassMethods
+
+      base.class_eval do
+        attr_writer :custom_contexts
+        after_save :save_tags
+      end
+
+      base.initialize_acts_as_taggable_on_core
+    end
+
+    module ClassMethods
+      def initialize_acts_as_taggable_on_core
+        tag_types.each do |tags_type|
+          tag_type         = tags_type.to_s.singularize
+          context_taggings = "#{tag_type}_taggings".to_sym
+          context_tags     = tags_type.to_sym
+
+          class_eval do
+            has_many context_taggings, :as => :taggable, :dependent => :destroy, :include => :tag, :class_name => acts_as_taggable_on_tagging_model.name,
+            :conditions => ["#{acts_as_taggable_on_tagging_model.table_name}.tag_id = #{acts_as_taggable_on_tag_model.table_name}.id AND #{acts_as_taggable_on_tagging_model.table_name}.context = ?", tags_type]
+            has_many context_tags, :through => context_taggings, :source => :tag, :class_name => acts_as_taggable_on_tag_model.name
+          end
+
+          class_eval %(
+            def #{tag_type}_list
+              tag_list_on('#{tags_type}')
+            end
+
+            def #{tag_type}_list=(new_tags)
+              set_tag_list_on('#{tags_type}', new_tags)
+            end
+
+            def all_#{tags_type}_list
+              all_tags_list_on('#{tags_type}')
+            end
+          )
+        end
+      end
+
+      def acts_as_taggable_on(*args)
+        super
+        initialize_acts_as_taggable_on_core
+      end
+
+      # all column names are necessary for PostgreSQL group clause
+      def grouped_column_names_for(object)
+        if object.connection.adapter_name == 'PostgreSQL'
+          object.column_names.map { |column| "#{object.table_name}.#{column}" }.join(", ")
+        else
+          "#{object.table_name}.#{object.primary_key}"
+        end
+      end
+
+      ##
+      # Return a scope of objects that are tagged with the specified tags.
+      #
+      # @param tags The tags that we want to query for
+      # @param [Hash] options A hash of options to alter you query:
+      #                       * <tt>:exclude</tt> - if set to true, return objects that are *NOT* tagged with the specified tags
+      #                       * <tt>:any</tt> - if set to true, return objects that are tagged with *ANY* of the specified tags
+      #                       * <tt>:match_all</tt> - if set to true, return objects that are *ONLY* tagged with the specified tags
+      #
+      # Example:
+      #   User.tagged_with("awesome", "cool")                     # Users that are tagged with awesome and cool
+      #   User.tagged_with("awesome", "cool", :exclude => true)   # Users that are not tagged with awesome or cool
+      #   User.tagged_with("awesome", "cool", :any => true)       # Users that are tagged with awesome or cool
+      #   User.tagged_with("awesome", "cool", :match_all => true) # Users that are tagged with just awesome and cool
+      def tagged_with(tags, options = {})
+        tag_list = ActsAsTaggableOn::Taggable::TagList.from(tags)
+
+        return {} if tag_list.empty?
+
+        joins = []
+        conditions = []
+
+        context = options.delete(:on)
+
+        if options.delete(:exclude)
+          tags_conditions = tag_list.map { |t| sanitize_sql(["#{acts_as_taggable_on_tag_model.table_name}.name #{ActsAsTaggableOn.like_operator} ?", t]) }.join(" OR ")
+          conditions << "#{table_name}.#{primary_key} NOT IN (SELECT #{acts_as_taggable_on_tagging_model.table_name}.taggable_id FROM #{acts_as_taggable_on_tagging_model.table_name} JOIN #{acts_as_taggable_on_tag_model.table_name} ON #{acts_as_taggable_on_tagging_model.table_name}.tag_id = #{acts_as_taggable_on_tag_model.table_name}.id AND (#{tags_conditions}) WHERE #{acts_as_taggable_on_tagging_model.table_name}.taggable_type = #{quote_value(base_class.name)})"
+
+        elsif options.delete(:any)
+          tags_conditions = tag_list.map { |t| sanitize_sql(["#{acts_as_taggable_on_tag_model.table_name}.name #{ActsAsTaggableOn.like_operator} ?", t]) }.join(" OR ")
+          conditions << "#{table_name}.#{primary_key} IN (SELECT #{acts_as_taggable_on_tagging_model.table_name}.taggable_id FROM #{acts_as_taggable_on_tagging_model.table_name} JOIN #{acts_as_taggable_on_tag_model.table_name} ON #{acts_as_taggable_on_tagging_model.table_name}.tag_id = #{acts_as_taggable_on_tag_model.table_name}.id AND (#{tags_conditions}) WHERE #{acts_as_taggable_on_tagging_model.table_name}.taggable_type = #{quote_value(base_class.name)})"
+
+        else
+          tags = acts_as_taggable_on_tag_model.named_any(tag_list)
+          return where("1 = 0") unless tags.length == tag_list.length
+
+          tags.each do |tag|
+            safe_tag = tag.name.gsub(/[^a-zA-Z0-9]/, '')
+            prefix   = "#{safe_tag}_#{rand(1024)}"
+
+            taggings_alias = "#{undecorated_table_name}_taggings_#{prefix}"
+
+            tagging_join  = "JOIN #{acts_as_taggable_on_tagging_model.table_name} #{taggings_alias}" +
+                            "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
+                            " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}" +
+                            " AND #{taggings_alias}.tag_id = #{tag.id}"
+            tagging_join << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context
+
+            joins << tagging_join
+          end
+        end
+
+        taggings_alias, tags_alias = "#{undecorated_table_name}_taggings_group", "#{undecorated_table_name}_tags_group"
+
+        if options.delete(:match_all)
+          joins << "LEFT OUTER JOIN #{acts_as_taggable_on_tagging_model.table_name} #{taggings_alias}" +
+                   "  ON #{taggings_alias}.taggable_id = #{table_name}.#{primary_key}" +
+                   " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name)}"
+
+          group = "#{grouped_column_names_for(self)} HAVING COUNT(#{taggings_alias}.taggable_id) = #{tags.size}"
+        end
+
+
+        where(conditions.join(" AND ")).
+          joins(joins.join(" ")).
+          group(group).
+          order(options[:order]).
+          readonly(false)
+      end
+
+      def is_taggable?
+        true
+      end
+    end
+
+    module InstanceMethods
+      # all column names are necessary for PostgreSQL group clause
+      def grouped_column_names_for(object)
+        self.class.grouped_column_names_for(object)
+      end
+
+      def custom_contexts
+        @custom_contexts ||= []
+      end
+
+      def is_taggable?
+        self.class.is_taggable?
+      end
+
+      def add_custom_context(value)
+        value = value.to_s
+        custom_contexts << value unless tagging_contexts.include?(value)
+      end
+
+      def cached_tag_list_on(context)
+        self["cached_#{context.to_s.singularize}_list"]
+      end
+
+      def tag_list_cache_set_on(context)
+        variable_name = "@#{context.to_s.singularize}_list"
+        !instance_variable_get(variable_name).nil?
+      end
+
+      def tag_list_cache_on(context)
+        variable_name = "@#{context.to_s.singularize}_list"
+        instance_variable_get(variable_name) || instance_variable_set(variable_name, ActsAsTaggableOn::Taggable::TagList.new(tags_on(context).names))
+      end
+
+      def tag_list_on(context)
+        add_custom_context(context)
+        tag_list_cache_on(context)
+      end
+
+      def all_tags_list_on(context)
+        variable_name = "@all_#{context.to_s.singularize}_list"
+        return instance_variable_get(variable_name) if instance_variable_get(variable_name)
+
+        instance_variable_set(variable_name, ActsAsTaggableOn::Taggable::TagList.new(all_tags_on(context).names).freeze)
+      end
+
+      ##
+      # Returns all tags of a given context
+      def all_tags_on(context)
+        base_tags.where(:taggings => {:context => context.to_s}).
+          group(grouped_column_names_for(acts_as_taggable_on_tag_model)).
+          order("max(#{acts_as_taggable_on_tagging_model.table_name}.created_at)")
+      end
+
+      ##
+      # Returns all tags that are not owned of a given context
+      def tags_on(context)
+        base_tags.where(["#{acts_as_taggable_on_tagging_model.table_name}.context = ? AND #{acts_as_taggable_on_tagging_model.table_name}.tagger_id IS NULL", context.to_s])
+      end
+
+      def set_tag_list_on(context, new_list)
+        add_custom_context(context)
+
+        variable_name = "@#{context.to_s.singularize}_list"
+        instance_variable_set(variable_name, ActsAsTaggableOn::Taggable::TagList.from(new_list))
+      end
+
+      def tagging_contexts
+        custom_contexts + self.class.tag_types.map {|type| type.to_s }
+      end
+
+      def reload(*args)
+        self.class.tag_types.each do |context|
+          instance_variable_set("@#{context.to_s.singularize}_list", nil)
+          instance_variable_set("@all_#{context.to_s.singularize}_list", nil)
+        end
+
+        super
+      end
+
+      def save_tags
+        tagging_contexts.each do |context|
+          next unless tag_list_cache_set_on(context)
+
+          tag_list = tag_list_cache_on(context).uniq
+
+          # Find existing tags or create non-existing tags:
+          tag_list = acts_as_taggable_on_tag_model.find_or_create_all_with_like_by_name(tag_list)
+
+          current_tags = tags_on(context)
+          old_tags     = current_tags - tag_list
+          new_tags     = tag_list     - current_tags
+
+          # Find taggings to remove:
+          old_taggings = taggings.where(:tagger_type => nil, :tagger_id => nil,
+                                        :context => context.to_s, :tag_id => old_tags)
+
+          if old_taggings.present?
+            # Destroy old taggings:
+            acts_as_taggable_on_tagging_model.destroy_all :id => old_taggings.map {|tagging| tagging.id }
+          end
+
+          # Create new taggings:
+          new_tags.each do |tag|
+            taggings.create!(:tag_id => tag.id, :context => context.to_s, :taggable => self)
+          end
+        end
+
+        true
+      end
+    end
+  end
+end