mongoid_taggable_with_context 0.5.0 → 0.6.0

data/README.rdoc

@@ -1,6 +1,6 @@
 == Mongoid Taggable With Context
 
-A tagging plugin for Mongoid that allows for custom tagging along dynamic contexts. This plugin was originally based on Mongoid Taggable by Wilker Lúcio and Ches Martin. It has evolved substantially since that point, but all credit goes to them for the initial tagging functionality.
+A tagging lib for Mongoid that allows for custom tagging along dynamic contexts. This lib was originally based on Mongoid Taggable by Wilker Lúcio and Ches Martin. It has evolved substantially since that point, but all credit goes to them for the initial tagging functionality.
 
 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 Mongoid Taggable.
 
@@ -8,7 +8,7 @@ Another example, aggregation such as counting tag occurrences was achieved by ma
 
 Enter Mongoid Taggable With Context. Rather than tying functionality to a specific keyword (namely "tags"), Mongoid Taggable With Context allows you to specify an arbitrary number of tag "contexts" that can be used locally or in combination in the same way Mongoid Taggable was used.
 
-Mongoid Taggable With Context implements tag aggregation without map-reduce, instead it quickly adjusts the aggregation collection whenever tags are inserted or removed with $inc operator. So performance won't be impacted as the number of tags and documents grow.
+Mongoid Taggable With Context also provides flexibility on aggregation strategy. In addition to the map-reduce strategy, Mongoid Taggable With Context also comes with real-time strategy. By using real-time strategy, your document can quickly adjusts the aggregation collection whenever tags are inserted or removed with $inc operator. So performance won't be impacted as the number of tags and documents grow.
 
 == Installation
 
@@ -80,9 +80,45 @@ Then in your form, for example:
   <% end %>
 
 
-== Tag Aggregation with Counts
+== Aggregation Strategies
 
-This lib can automatically create aggregate collections of contexts and their counts for you. Each aggregate collection is scoped to the document collection type and context.
+By including an aggregation strategy in your document, tag aggregations will be automatically available to you.
+This lib presents the following aggregation strategies:
+
+* MapReduce
+* RealTime
+
+The following document will automatically aggregate counts on all tag contexts.
+
+  class Post
+    include Mongoid::Document
+    include Mongoid::TaggableWithContext
+    
+    # automatically adds real time aggregations to all tag contexts
+    include Mongoid::TaggableWithContext::AggregationStrategy::RealTime
+
+    # alternatively for map-reduce
+    # include Mongoid::TaggableWithContext::AggregationStrategy::MapReduce
+
+    field :title
+    field :content
+
+    taggable
+    taggable :interests
+    taggable :skills, :separator => ','
+  end
+
+When you include an aggregation strategy, your document also gains a few extra methods to retrieve aggregation data.
+In the case of previous example the following methods are included:
+
+  Post.tags
+  Post.tags_with_weight
+  Post.interests
+  Post.interests_with_weight
+  Post.skills
+  Post.skills_with_weight
+  
+Here is how to use these methods in more detail:
 
   Post.create!(:tags => "food,ant,bee")
   Post.create!(:tags => "juice,food,bee,zip")
@@ -131,3 +167,8 @@ To see the test coverage, you need to be on ruby 1.8.7 (since latest rcov doesn'
 and run the following command:
 
   rake rcov
+  
+== Next Up
+
+* More documentation.
+* More Strategies. ( Let me know what kind of strategies you want, or contribute your own. )

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/init.rb

@@ -1 +1 @@
-require 'mongoid/taggable_with_context'
+require 'mongoid_taggable_with_context'

data/lib/mongoid/taggable_with_context.rb

@@ -0,0 +1,162 @@
+# Copyright (c) 2010 Wilker Lúcio <wilkerlucio@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongoid::TaggableWithContext
+  extend ActiveSupport::Concern
+  
+  class AggregationStrategyMissing < Exception; end
+
+  included do
+    class_inheritable_reader :taggable_with_context_options
+    write_inheritable_attribute(:taggable_with_context_options, {})
+    delegate "convert_string_to_array",     :to => 'self.class'
+    delegate "convert_array_to_string",     :to => 'self.class'
+    delegate "get_tag_separator_for",       :to => 'self.class'
+    delegate "tag_contexts",                :to => 'self.class'
+    delegate "tag_options_for",             :to => 'self.class'
+  end
+
+  module ClassMethods
+    # Macro to declare a document class as taggable, specify field name
+    # for tags, and set options for tagging behavior.
+    #
+    # @example Define a taggable document.
+    #
+    #   class Article
+    #     include Mongoid::Document
+    #     include Mongoid::Taggable
+    #     taggable :keywords, :separator => ' ', :aggregation => true, :default_type => "seo"
+    #   end
+    #
+    # @param [ Symbol ] field The name of the field for tags.
+    # @param [ Hash ] options Options for taggable behavior.
+    #
+    # @option options [ String ] :separator The tag separator to
+    #   convert from; defaults to ','
+    # @option options [ true, false ] :aggregation Whether or not to
+    #   aggregate counts of tags within the document collection using
+    #   map/reduce; defaults to false
+    # @option options [ String ] :default_type The default type of the tag.
+    #   Each tag can optionally have a tag type. The default type is nil
+    def taggable(*args)
+      # init variables
+      options = args.extract_options!
+      tags_field = (args.blank? ? :tags : args.shift).to_sym
+      options.reverse_merge!(
+        :separator => ' ',
+        :array_field => "#{tags_field}_array".to_sym
+      )
+      tags_array_field = options[:array_field]
+      
+      # register / update settings
+      class_options = taggable_with_context_options || {}
+      class_options[tags_field] = options
+      write_inheritable_attribute(:taggable_with_context_options, class_options)
+      
+      # setup fields & indexes
+      field tags_field, :default => ""
+      field tags_array_field, :type => Array, :default => []
+      index tags_array_field      
+      
+      # singleton methods
+      class_eval <<-END
+        class << self
+          def #{tags_field}
+            tags_for(:"#{tags_field}")
+          end
+      
+          def #{tags_field}_with_weight
+            tags_with_weight_for(:"#{tags_field}")
+          end
+      
+          def #{tags_field}_separator
+            get_tag_separator_for(:"#{tags_field}")
+          end
+          
+          def #{tags_field}_separator=(value)
+            set_tag_separator_for(:"#{tags_field}", value)
+          end
+                  
+          def #{tags_field}_tagged_with(tags)
+            tagged_with(:"#{tags_field}", tags)
+          end
+        end
+      END
+      
+      # instance methods
+      class_eval <<-END
+        def #{tags_field}=(s)
+          super
+          write_attribute(:#{tags_array_field}, convert_string_to_array(s, get_tag_separator_for(:"#{tags_field}")))
+        end
+        
+        def #{tags_array_field}=(a)
+          super
+          write_attribute(:#{tags_field}, convert_array_to_string(a, get_tag_separator_for(:"#{tags_field}")))
+        end
+      END
+    end
+    
+    def tag_contexts
+      taggable_with_context_options.keys
+    end
+    
+    def tag_options_for(context)
+      taggable_with_context_options[context]
+    end
+
+    def tags_for(context, conditions={})
+      raise AggregationStrategyMissing
+    end
+    
+    def tags_with_weight_for(context, conditions={})
+      raise AggregationStrategyMissing
+    end
+  
+    def get_tag_separator_for(context)
+      taggable_with_context_options[context][:separator]
+    end
+
+    def set_tag_separator_for(context, value)
+      taggable_with_context_options[context][:separator] = value.nil? ? " " : value.to_s
+    end
+            
+    # Find documents tagged with all tags passed as a parameter, given
+    # as an Array or a String using the configured separator.
+    #
+    # @example Find matching all tags in an Array.
+    #   Article.tagged_with(['ruby', 'mongodb'])
+    # @example Find matching all tags in a String.
+    #   Article.tagged_with('ruby, mongodb')
+    #
+    # @param [ String ] :field The field name of the tag.
+    # @param [ Array<String, Symbol>, String ] :tags Tags to match.
+    # @return [ Criteria ] A new criteria.
+    def tagged_with(context, tags)
+      tags = convert_string_to_array(tags, get_tag_separator_for(context)) if tags.is_a? String
+      array_field = tag_options_for(context)[:array_field]
+      all_in(array_field => tags)
+    end
+  
+    # Helper method to convert a String to an Array based on the
+    # configured tag separator.
+    def convert_string_to_array(str = "", seperator = " ")
+      str.split(seperator).map(&:strip).uniq.compact
+    end
+  
+    def convert_array_to_string(ary = [], seperator = " ")
+      ary.uniq.compact.join(seperator)
+    end
+  end
+end

data/lib/mongoid/taggable_with_context/aggregation_strategy/map_reduce.rb

@@ -0,0 +1,96 @@
+module Mongoid::TaggableWithContext::AggregationStrategy
+  module MapReduce
+    extend ActiveSupport::Concern
+    included do
+      set_callback :create, :after, :update_tags_agregation_on_create
+      set_callback :save, :after, :update_tags_aggregation_on_update
+      set_callback :destroy, :after, :update_tags_aggregation_on_destroy
+      delegate :aggregation_collection_for, :to => "self.class"
+    end
+    
+    module ClassMethods
+      # Collection name for storing results of tag count aggregation
+      def aggregation_collection_for(context)
+        "#{collection_name}_#{context}_aggregation"
+      end
+      
+      def tags_for(context, conditions={})
+        conditions = {:sort => '_id'}.merge(conditions)
+        db.collection(aggregation_collection_for(context)).find({:value => {"$gt" => 0 }}, conditions).to_a.map{ |t| t["_id"] }
+      end
+
+      # retrieve the list of tag with weight(count), this is useful for
+      # creating tag clouds
+      def tags_with_weight_for(context, conditions={})
+        conditions = {:sort => '_id'}.merge(conditions)
+        db.collection(aggregation_collection_for(context)).find({:value => {"$gt" => 0 }}, conditions).to_a.map{ |t| [t["_id"], t["value"].to_i] }
+      end
+    end
+    
+    protected
+    
+    def trigger_update_tags_aggregation_on_create?
+      previous_changes.empty?
+    end
+    
+    def trigger_update_tags_aggregation_on_update?
+      !changed_contexts.empty?
+    end
+    
+    def trigger_update_tags_aggregation_on_destroy?
+      true
+    end
+    
+    def update_tags_agregation_on_create
+      return unless trigger_update_tags_aggregation_on_create?
+
+      tag_contexts.each do |context|
+        map_reduce_context_tags!(context)
+      end
+    end
+
+    def update_tags_aggregation_on_update
+      return unless trigger_update_tags_aggregation_on_update?
+
+      changed_contexts.each do |context|
+        map_reduce_context_tags!(context)
+      end
+    end
+
+    def update_tags_aggregation_on_destroy
+      return unless trigger_update_tags_aggregation_on_destroy?
+
+      tag_contexts.each do |context|
+        map_reduce_context_tags!(context)
+      end
+    end
+    
+    private
+    
+    def changed_contexts
+      tag_contexts & previous_changes.keys.map(&:to_sym)
+    end
+    
+    def map_reduce_context_tags!(context)
+      field = tag_options_for(context)[:array_field]
+
+      map = <<-END
+        function() {
+          if (!this.#{field})return;
+          for (index in this.#{field})
+            emit(this.#{field}[index], 1);
+        }
+      END
+
+      reduce = <<-END
+        function(key, values) {
+          var count = 0;
+          for (index in values) count += values[index];
+          return count;
+        }
+      END
+
+      collection.master.map_reduce(map, reduce, :out => aggregation_collection_for(context))
+    end
+  end
+end

data/lib/mongoid/taggable_with_context/aggregation_strategy/real_time.rb

@@ -0,0 +1,92 @@
+module Mongoid::TaggableWithContext::AggregationStrategy
+  module RealTime
+    extend ActiveSupport::Concern
+    
+    included do
+      set_callback :create,   :after, :increment_tags_agregation
+      set_callback :save,     :after, :update_tags_aggregation
+      set_callback :destroy,  :after, :decrement_tags_aggregation
+    end
+    
+    module ClassMethods
+      # Collection name for storing results of tag count aggregation
+      def aggregation_collection_for(context)
+        "#{collection_name}_#{context}_aggregation"
+      end
+      
+      def tags_for(context, conditions={})
+        conditions = {:sort => '_id'}.merge(conditions)
+        db.collection(aggregation_collection_for(context)).find({:value => {"$gt" => 0 }}, conditions).to_a.map{ |t| t["_id"] }
+      end
+
+      # retrieve the list of tag with weight(count), this is useful for
+      # creating tag clouds
+      def tags_with_weight_for(context, conditions={})
+        conditions = {:sort => '_id'}.merge(conditions)
+        db.collection(aggregation_collection_for(context)).find({:value => {"$gt" => 0 }}, conditions).to_a.map{ |t| [t["_id"], t["value"]] }
+      end
+    end
+    
+    private
+    def need_update_tags_aggregation?
+      !changed_contexts.empty?
+    end
+
+    def changed_contexts
+      tag_contexts & previous_changes.keys.map(&:to_sym)
+    end
+    
+    def increment_tags_agregation
+      # if document is created by using MyDocument.new
+      # and attributes are individually assigned
+      # #previous_changes won't be empty and aggregation
+      # is updated in after_save, so we simply skip it.
+      return unless previous_changes.empty?
+
+      # if the document is created by using MyDocument.create(:tags => "tag1 tag2")
+      # #previous_changes hash is empty and we have to update aggregation here
+      tag_contexts.each do |context|
+        coll = self.class.db.collection(self.class.aggregation_collection_for(context))
+        field_name = self.class.tag_options_for(context)[:array_field]
+        tags = self.send field_name || []
+        tags.each do |t|
+          coll.update({:_id => t}, {'$inc' => {:value => 1}}, :upsert => true)
+        end
+      end
+    end
+
+    def decrement_tags_aggregation
+      tag_contexts.each do |context|
+        coll = self.class.db.collection(self.class.aggregation_collection_for(context))
+        field_name = self.class.tag_options_for(context)[:array_field]
+        tags = self.send field_name || []
+        tags.each do |t|
+          coll.update({:_id => t}, {'$inc' => {:value => -1}}, :upsert => true)
+        end
+      end
+    end
+
+    def update_tags_aggregation
+      return unless need_update_tags_aggregation?
+
+      changed_contexts.each do |context|
+        coll = self.class.db.collection(self.class.aggregation_collection_for(context))
+        field_name = self.class.tag_options_for(context)[:array_field]        
+        old_tags, new_tags = previous_changes["#{field_name}"]
+        old_tags ||= []
+        new_tags ||= []
+        unchanged_tags = old_tags & new_tags
+        tags_removed = old_tags - unchanged_tags
+        tags_added = new_tags - unchanged_tags
+
+        tags_removed.each do |t|
+          coll.update({:_id => t}, {'$inc' => {:value => -1}}, :upsert => true)
+        end
+
+        tags_added.each do |t|
+          coll.update({:_id => t}, {'$inc' => {:value => 1}}, :upsert => true)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_taggable_with_context.rb

@@ -1,249 +1,5 @@
-# Copyright (c) 2010 Wilker Lúcio <wilkerlucio@gmail.com>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+require 'active_support/concern'
 
-module Mongoid::TaggableWithContext
-  extend ActiveSupport::Concern
-
-  included do
-    class_inheritable_reader :taggable_with_context_options
-  end
-
-  module ClassMethods
-    # Macro to declare a document class as taggable, specify field name
-    # for tags, and set options for tagging behavior.
-    #
-    # @example Define a taggable document.
-    #
-    #   class Article
-    #     include Mongoid::Document
-    #     include Mongoid::Taggable
-    #     taggable :keywords, :separator => ' ', :aggregation => true, :default_type => "seo"
-    #   end
-    #
-    # @param [ Symbol ] field The name of the field for tags.
-    # @param [ Hash ] options Options for taggable behavior.
-    #
-    # @option options [ String ] :separator The tag separator to
-    #   convert from; defaults to ','
-    # @option options [ true, false ] :aggregation Whether or not to
-    #   aggregate counts of tags within the document collection using
-    #   map/reduce; defaults to false
-    # @option options [ String ] :default_type The default type of the tag.
-    #   Each tag can optionally have a tag type. The default type is nil
-    def taggable(*args)
-      # init variables
-      options = args.extract_options!
-      tags_field = (args.blank? ? :tags : args.shift).to_sym
-      options.reverse_merge!(
-        :separator => ' ',
-        :array_field => "#{tags_field}_array".to_sym
-      )
-      tags_array_field = options[:array_field]
-      first_invoke = taggable_with_context_options.nil?
-      
-      # register / update settings
-      class_options = taggable_with_context_options || {}
-      class_options[tags_field] = options
-      write_inheritable_attribute(:taggable_with_context_options, class_options)
-      
-      # setup fields & indexes
-      field tags_field, :default => ""
-      field tags_array_field, :type => Array, :default => []
-      index tags_array_field
-
-      if first_invoke
-        delegate "convert_string_to_array",     :to => 'self.class'
-        delegate "convert_array_to_string",     :to => 'self.class'
-        delegate "get_tag_separator_for",       :to => 'self.class'
-        delegate "tag_contexts",                :to => 'self.class'
-        delegate "aggregation_collection_for",  :to => 'self.class'
-        delegate "tag_options_for",             :to => 'self.class'
-
-        set_callback :create,   :after, :increment_tags_agregation
-        set_callback :save,     :after, :update_tags_aggregation
-        set_callback :destroy,  :after, :decrement_tags_aggregation
-      end
-      
-      extend SingletonMethods
-      include InstanceMethods
-      
-      # singleton methods
-      class_eval <<-END
-        class << self
-          def #{tags_field}_aggregation_collection
-            @#{tags_field}_aggregation_collection ||= aggregation_collection_for(:"#{tags_field}")
-          end
-    
-          def #{tags_field}
-            tags_for(:"#{tags_field}")
-          end
-      
-          def #{tags_field}_with_weight
-            tags_with_weight_for(:"#{tags_field}")
-          end
-      
-          def #{tags_field}_separator
-            get_tag_separator_for(:"#{tags_field}")
-          end
-          
-          def #{tags_field}_separator=(value)
-            set_tag_separator_for(:"#{tags_field}", value)
-          end
-                  
-          def #{tags_field}_tagged_with(tags)
-            tagged_with(:"#{tags_field}", tags)
-          end
-        end
-      END
-      
-      # instance methods
-      class_eval <<-END
-        def #{tags_field}=(s)
-          super
-          write_attribute(:#{tags_array_field}, convert_string_to_array(s, get_tag_separator_for(:"#{tags_field}")))
-        end
-        
-        def #{tags_array_field}=(a)
-          super
-          write_attribute(:#{tags_field}, convert_array_to_string(a, get_tag_separator_for(:"#{tags_field}")))
-        end
-      END
-    end
-  end
-  
-  module SingletonMethods
-    def tag_contexts
-      taggable_with_context_options.keys
-    end
-    
-    def tag_options_for(context)
-      taggable_with_context_options[context]
-    end
-    
-    # Collection name for storing results of tag count aggregation
-    def aggregation_collection_for(context)
-      "#{collection_name}_#{context}_aggregation"
-    end
-
-    def tags_for(context, conditions={})
-      conditions = {:sort => '_id'}.merge(conditions)
-      db.collection(aggregation_collection_for(context)).find({:value => {"$gt" => 0 }}, conditions).to_a.map{ |t| t["_id"] }
-    end
-    
-    # retrieve the list of tag with weight(count), this is useful for
-    # creating tag clouds
-    def tags_with_weight_for(context, conditions={})
-      conditions = {:sort => '_id'}.merge(conditions)
-      db.collection(aggregation_collection_for(context)).find({:value => {"$gt" => 0 }}, conditions).to_a.map{ |t| [t["_id"], t["value"]] }
-    end
-  
-    def get_tag_separator_for(context)
-      taggable_with_context_options[context][:separator]
-    end
-
-    def set_tag_separator_for(context, value)
-      taggable_with_context_options[context][:separator] = value.nil? ? " " : value.to_s
-    end
-            
-    # Find documents tagged with all tags passed as a parameter, given
-    # as an Array or a String using the configured separator.
-    #
-    # @example Find matching all tags in an Array.
-    #   Article.tagged_with(['ruby', 'mongodb'])
-    # @example Find matching all tags in a String.
-    #   Article.tagged_with('ruby, mongodb')
-    #
-    # @param [ String ] :field The field name of the tag.
-    # @param [ Array<String, Symbol>, String ] :tags Tags to match.
-    # @return [ Criteria ] A new criteria.
-    def tagged_with(context, tags)
-      tags = convert_string_to_array(tags, get_tag_separator_for(context)) if tags.is_a? String
-      array_field = tag_options_for(context)[:array_field]
-      all_in(array_field => tags)
-    end
-  
-    # Helper method to convert a String to an Array based on the
-    # configured tag separator.
-    def convert_string_to_array(str = "", seperator = " ")
-      str.split(seperator).map(&:strip).uniq.compact
-    end
-  
-    def convert_array_to_string(ary = [], seperator = " ")
-      ary.uniq.compact.join(seperator)
-    end
-  end
-  
-  module InstanceMethods
-    def need_update_tags_aggregation?
-      !changed_contexts.empty?
-    end
-    
-    def changed_contexts
-      tag_contexts & previous_changes.keys.map(&:to_sym)
-    end
-    
-    def increment_tags_agregation
-      # if document is created by using MyDocument.new
-      # and attributes are individually assigned
-      # #previous_changes won't be empty and aggregation
-      # is updated in after_save, so we simply skip it.
-      return unless previous_changes.empty?
-      
-      # if the document is created by using MyDocument.create(:tags => "tag1 tag2")
-      # #previous_changes hash is empty and we have to update aggregation here
-      tag_contexts.each do |context|
-        coll = self.class.db.collection(self.class.aggregation_collection_for(context))
-        field_name = self.class.tag_options_for(context)[:array_field]
-        tags = self.send field_name || []
-        tags.each do |t|
-          coll.update({:_id => t}, {'$inc' => {:value => 1}}, :upsert => true)
-        end
-      end
-    end
-    
-    def decrement_tags_aggregation
-      tag_contexts.each do |context|
-        coll = self.class.db.collection(self.class.aggregation_collection_for(context))
-        field_name = self.class.tag_options_for(context)[:array_field]
-        tags = self.send field_name || []
-        tags.each do |t|
-          coll.update({:_id => t}, {'$inc' => {:value => -1}}, :upsert => true)
-        end
-      end
-    end
-    
-    def update_tags_aggregation
-      return unless need_update_tags_aggregation?
-      
-      changed_contexts.each do |context|
-        coll = self.class.db.collection(self.class.aggregation_collection_for(context))
-        field_name = self.class.tag_options_for(context)[:array_field]        
-        old_tags, new_tags = previous_changes["#{field_name}"]
-        old_tags ||= []
-        new_tags ||= []
-        unchanged_tags = old_tags & new_tags
-        tags_removed = old_tags - unchanged_tags
-        tags_added = new_tags - unchanged_tags
-        
-        tags_removed.each do |t|
-          coll.update({:_id => t}, {'$inc' => {:value => -1}}, :upsert => true)
-        end
-        
-        tags_added.each do |t|
-          coll.update({:_id => t}, {'$inc' => {:value => 1}}, :upsert => true)
-        end
-      end
-    end
-  end
-end
+require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context')
+require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/aggregation_strategy/map_reduce')
+require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/aggregation_strategy/real_time')

data/mongoid_taggable_with_context.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_taggable_with_context}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian"]
@@ -19,12 +19,14 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
     "init.rb",
+    "lib/mongoid/taggable_with_context.rb",
+    "lib/mongoid/taggable_with_context/aggregation_strategy/map_reduce.rb",
+    "lib/mongoid/taggable_with_context/aggregation_strategy/real_time.rb",
     "lib/mongoid_taggable_with_context.rb",
     "mongoid_taggable_with_context.gemspec",
     "spec/mongoid_taggable_with_context_spec.rb",

data/spec/mongoid_taggable_with_context_spec.rb

@@ -3,6 +3,25 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 class MyModel
   include Mongoid::Document
   include Mongoid::TaggableWithContext
+    
+  taggable
+  taggable :artists
+end
+
+class M1
+  include Mongoid::Document
+  include Mongoid::TaggableWithContext
+  include Mongoid::TaggableWithContext::AggregationStrategy::MapReduce
+  
+  taggable
+  taggable :artists
+end
+
+class M2
+  include Mongoid::Document
+  include Mongoid::TaggableWithContext
+  include Mongoid::TaggableWithContext::AggregationStrategy::RealTime
+  
   taggable
   taggable :artists
 end
@@ -77,31 +96,47 @@ describe Mongoid::TaggableWithContext do
       @m.tags.should == "some;other;sep"
     end
   end
-
-  context "indexing tags" do
-    it "should generate the tags aggregation collection name correctly" do
-      MyModel.tags_aggregation_collection.should == "my_models_tags_aggregation"
+  
+  context "tagged_with" do
+    before :each do
+      @m1 = MyModel.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
+      @m2 = MyModel.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
+      @m3 = MyModel.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
     end
     
-    it "should generate the artists aggregation collection name correctly" do
-      MyModel.artists_aggregation_collection.should == "my_models_artists_aggregation"
+    it "should retrieve a list of documents" do
+      (MyModel.tags_tagged_with("food").to_a - [@m1, @m2, @m3]).should be_empty
+      (MyModel.artists_tagged_with("aaron").to_a - [@m1, @m3]).should be_empty
     end
-
+  end
+  
+  context "no aggregation" do
+    it "should raise AggregationStrategyMissing exception when retreiving tags" do
+      lambda{ MyModel.tags }.should raise_error(Mongoid::TaggableWithContext::AggregationStrategyMissing)
+    end
+    
+    it "should raise AggregationStrategyMissing exception when retreiving tags with weights" do
+      lambda{ MyModel.tags_with_weight }.should raise_error(Mongoid::TaggableWithContext::AggregationStrategyMissing)
+    end
+    
+  end
+  
+  shared_examples_for "aggregation" do
     context "retriving index" do
       context "on create directly" do
         before :each do
-          MyModel.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-          MyModel.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
-          MyModel.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
+          klass.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
+          klass.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
+          klass.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
         end
       
         it "should retrieve the list of all saved tags distinct and ordered" do
-          MyModel.tags.should == %w[ant bee food honey juice strip zip]
-          MyModel.artists.should == %w[aaron andrew andy grant greg jeff mandy]
+          klass.tags.should == %w[ant bee food honey juice strip zip]
+          klass.artists.should == %w[aaron andrew andy grant greg jeff mandy]
         end
 
         it "should retrieve a list of tags with weight" do
-          MyModel.tags_with_weight.should == [
+          klass.tags_with_weight.should == [
             ['ant', 1],
             ['bee', 2],
             ['food', 3],
@@ -111,7 +146,7 @@ describe Mongoid::TaggableWithContext do
             ['zip', 1]
           ]
         
-          MyModel.artists_with_weight.should == [
+          klass.artists_with_weight.should == [
             ['aaron', 2],
             ['andrew', 1],
             ['andy', 3],
@@ -125,29 +160,29 @@ describe Mongoid::TaggableWithContext do
       
       context "on new then change attributes directly" do
         before :each do
-          m = MyModel.new
+          m = klass.new
           m.tags = "food ant bee"
           m.artists = "jeff greg mandy aaron andy"
           m.save!
           
-          m = MyModel.new
+          m = klass.new
           m.tags = "juice food bee zip"
           m.artists = "grant andrew andy"
           m.save!
 
-          m = MyModel.new
+          m = klass.new
           m.tags = "honey strip food"
           m.artists = "mandy aaron andy"
           m.save!
         end
       
         it "should retrieve the list of all saved tags distinct and ordered" do
-          MyModel.tags.should == %w[ant bee food honey juice strip zip]
-          MyModel.artists.should == %w[aaron andrew andy grant greg jeff mandy]
+          klass.tags.should == %w[ant bee food honey juice strip zip]
+          klass.artists.should == %w[aaron andrew andy grant greg jeff mandy]
         end
 
         it "should retrieve a list of tags with weight" do
-          MyModel.tags_with_weight.should == [
+          klass.tags_with_weight.should == [
             ['ant', 1],
             ['bee', 2],
             ['food', 3],
@@ -157,7 +192,7 @@ describe Mongoid::TaggableWithContext do
             ['zip', 1]
           ]
         
-          MyModel.artists_with_weight.should == [
+          klass.artists_with_weight.should == [
             ['aaron', 2],
             ['andrew', 1],
             ['andy', 3],
@@ -171,9 +206,9 @@ describe Mongoid::TaggableWithContext do
       
       context "on create then update" do
         before :each do
-          m1 = MyModel.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-          m2 = MyModel.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
-          m3 = MyModel.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
+          m1 = klass.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
+          m2 = klass.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
+          m3 = klass.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
           
           m1.tags_array = m1.tags_array + %w[honey strip shoe]
           m1.save!
@@ -183,12 +218,12 @@ describe Mongoid::TaggableWithContext do
         end
       
         it "should retrieve the list of all saved tags distinct and ordered" do
-          MyModel.tags.should == %w[ant bee food honey juice shoe strip zip]
-          MyModel.artists.should == %w[aaron andrew andy gory grant greg jeff mandy]
+          klass.tags.should == %w[ant bee food honey juice shoe strip zip]
+          klass.artists.should == %w[aaron andrew andy gory grant greg jeff mandy]
         end
 
         it "should retrieve a list of tags with weight" do
-          MyModel.tags_with_weight.should == [
+          klass.tags_with_weight.should == [
             ['ant', 1],
             ['bee', 2],
             ['food', 3],
@@ -199,7 +234,7 @@ describe Mongoid::TaggableWithContext do
             ['zip', 1]
           ]
         
-          MyModel.artists_with_weight.should == [
+          klass.artists_with_weight.should == [
             ['aaron', 2],
             ['andrew', 1],
             ['andy', 3],
@@ -214,9 +249,9 @@ describe Mongoid::TaggableWithContext do
 
       context "on create, update, then destroy" do
         before :each do
-          m1 = MyModel.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-          m2 = MyModel.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
-          m3 = MyModel.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
+          m1 = klass.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
+          m2 = klass.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
+          m3 = klass.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
           
           m1.tags_array = m1.tags_array + %w[honey strip shoe] - %w[food]
           m1.save!
@@ -228,12 +263,12 @@ describe Mongoid::TaggableWithContext do
         end
       
         it "should retrieve the list of all saved tags distinct and ordered" do
-          MyModel.tags.should == %w[ant bee food honey shoe strip]
-          MyModel.artists.should == %w[aaron andy gory grant greg jeff mandy]
+          klass.tags.should == %w[ant bee food honey shoe strip]
+          klass.artists.should == %w[aaron andy gory grant greg jeff mandy]
         end
 
         it "should retrieve a list of tags with weight" do
-          MyModel.tags_with_weight.should == [
+          klass.tags_with_weight.should == [
             ['ant', 1],
             ['bee', 1],
             ['food', 1],
@@ -242,7 +277,7 @@ describe Mongoid::TaggableWithContext do
             ['strip', 2]
           ]
         
-          MyModel.artists_with_weight.should == [
+          klass.artists_with_weight.should == [
             ['aaron', 2],
             ['andy', 1],
             ['gory', 1],
@@ -253,20 +288,32 @@ describe Mongoid::TaggableWithContext do
           ]
         end
       end
-      
+    end
+  end
+
+  context "map-reduce aggregation" do
+    let(:klass) { M1 }
+    it_should_behave_like "aggregation"
+
+    it "should generate the tags aggregation collection name correctly" do
+      klass.aggregation_collection_for(:tags).should == "m1s_tags_aggregation"
     end
     
-    context "tagged_with" do
-      before :each do
-        @m1 = MyModel.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-        @m2 = MyModel.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
-        @m3 = MyModel.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
-      end
-      
-      it "should retrieve a list of documents" do
-        (MyModel.tags_tagged_with("food").to_a - [@m1, @m2, @m3]).should be_empty
-        (MyModel.artists_tagged_with("aaron").to_a - [@m1, @m3]).should be_empty
-      end
+    it "should generate the artists aggregation collection name correctly" do
+      klass.aggregation_collection_for(:artists).should == "m1s_artists_aggregation"
+    end
+  end
+  
+  context "realtime aggregation" do
+    let(:klass) { M2 }
+    it_should_behave_like "aggregation"
+
+    it "should generate the tags aggregation collection name correctly" do
+      klass.aggregation_collection_for(:tags).should == "m2s_tags_aggregation"
+    end
+    
+    it "should generate the artists aggregation collection name correctly" do
+      klass.aggregation_collection_for(:artists).should == "m2s_artists_aggregation"
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid_taggable_with_context
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Aaron Qian
@@ -222,12 +222,14 @@ extra_rdoc_files:
 files: 
 - .document
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - init.rb
+- lib/mongoid/taggable_with_context.rb
+- lib/mongoid/taggable_with_context/aggregation_strategy/map_reduce.rb
+- lib/mongoid/taggable_with_context/aggregation_strategy/real_time.rb
 - lib/mongoid_taggable_with_context.rb
 - mongoid_taggable_with_context.gemspec
 - spec/mongoid_taggable_with_context_spec.rb

data/Gemfile.lock

@@ -1,67 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.4)
-      activesupport (= 3.0.4)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activesupport (3.0.4)
-    bson (1.2.1)
-    bson_ext (1.2.1)
-    builder (2.1.2)
-    database_cleaner (0.6.0)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    i18n (0.5.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    mongo (1.2.1)
-      bson (>= 1.2.1)
-    mongoid (2.0.0.rc.7)
-      activemodel (~> 3.0)
-      mongo (~> 1.2)
-      tzinfo (~> 0.3.22)
-      will_paginate (~> 3.0.pre)
-    rake (0.8.7)
-    rcov (0.9.9)
-    reek (1.2.8)
-      ruby2ruby (~> 1.2)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    roodi (2.1.0)
-      ruby_parser
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    ruby2ruby (1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ruby_parser (2.0.5)
-      sexp_processor (~> 3.0)
-    sexp_processor (3.0.5)
-    tzinfo (0.3.24)
-    will_paginate (3.0.pre2)
-    yard (0.6.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bson (~> 1.2.1)
-  bson_ext (~> 1.2.1)
-  bundler (~> 1.0.0)
-  database_cleaner
-  jeweler (~> 1.5.2)
-  mongoid (~> 2.0.0.beta.20)
-  rcov
-  reek (~> 1.2.8)
-  roodi (~> 2.1.0)
-  rspec (~> 2.3.0)
-  yard (~> 0.6.0)