mongoid_taggable_with_context 0.5.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gem 'mongoid', '~> 2.0.0.beta.20'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'database_cleaner'
+  gem 'bson', '~> 1.2.1'
+  gem 'bson_ext', '~> 1.2.1'
+  gem 'rspec', '~> 2.3.0'
+  gem 'yard', '~> 0.6.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'rcov', '>= 0'
+  gem 'reek', '~> 1.2.8'
+  gem 'roodi', '~> 2.1.0'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+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)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Aaron Qian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,133 @@
+== 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.
+
+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.
+
+Another example, aggregation such as counting tag occurrences was achieved by map-reduce with Mongoid Taggable. It was ok for small amount of tags, but when the amount of tags and documents grow, the original Mongoid Taggable won't be able to scale to real-time statistics demand.
+
+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.
+
+== Installation
+
+You can simply install from rubygems:
+
+  gem install mongoid_taggable_with_context
+
+or in Gemfile:
+
+  gem 'mongoid_taggable_with_context'
+
+== Basic Usage
+
+To make a document taggable you need to include Mongoid::TaggableOnContext into your document and call the *taggable* macro with optional arguments:
+
+  class Post
+    include Mongoid::Document
+    include Mongoid::TaggableWithContext
+
+    field :title
+    field :content
+
+    # default context is 'tags'.
+    # This creates #tags, #tags=, #tags_array, #tags_array= instance methods
+    # separator is " " by default
+    # #tags method returns space separated string
+    # #tags= methods accepts space separated string
+    # #tags_array method returns an array of tags
+    # #tags_array= method accepts an array of tags
+    # #tags and #tags_array are automatically synched.
+    taggable
+    
+    # tagging for 'interests' context.
+    # This creates #interests, #interests=, #interests_array, #interests_array= instance methods
+    taggable :interests
+    
+    # tagging for 'skills' context.
+    # This creates #skills, #skills=, #skills_array, #skills_array= instance methods
+    # changing tag separator to "," (Default is " ") 
+    taggable :skills, :separator => ','
+  end
+
+Then in your form, for example:
+
+  <% form_for @post do |f| %>
+    <p>
+      <%= f.label :title %><br />
+      <%= f.text_field :title %>
+    </p>
+    <p>
+      <%= f.label :content %><br />
+      <%= f.text_area :content %>
+    </p>
+    <p>
+      <%= f.label :tags %><br />
+      <%= text_field_tag 'post[tags]' %>
+    </p>
+    <p>
+      <%= f.label :interests %><br />
+      <%= text_field_tag 'post[interests]' %>
+    </p>
+    <p>
+      <%= f.label :skills %><br />
+      <%= text_field_tag 'post[skills]' %>
+    </p>
+    <p>
+      <button type="submit">Send</button>
+    </p>
+  <% end %>
+
+
+== Tag Aggregation with Counts
+
+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.
+
+  Post.create!(:tags => "food,ant,bee")
+  Post.create!(:tags => "juice,food,bee,zip")
+  Post.create!(:tags => "honey,strip,food")
+
+  Post.tags # will retrieve ["ant", "bee", "food", "honey", "juice", "strip", "zip"]
+  Post.tags_with_weight # will retrieve:
+  # [
+  #   ['ant', 1],
+  #   ['bee', 2],
+  #   ['food', 3],
+  #   ['honey', 1],
+  #   ['juice', 1],
+  #   ['strip', 1],
+  #   ['zip', 1]
+  # ]
+
+== Changing default separator
+
+To change the default separator you may pass a *separator* argument to the macro:
+
+  class Post
+    include Mongoid::Document
+    include Mongoid::Taggable
+
+    field :title
+    field :content
+
+    taggable :separator => ','    # tags will be delineated by comma instead of space
+  end
+
+== Development and Testing
+
+Mongoid Taggable With Context uses Bundler for easy installation of development dependent gems.
+To get all dependent gems for development, while inside mongoid_taggable_with_context directory:
+
+  bundle install
+
+
+Mongoid Taggable With Context uses RSpec for its test coverage.
+Inside mongoid_taggable_with_context directory, you can run the specs with:
+
+  rake spec
+
+To see the test coverage, you need to be on ruby 1.8.7 (since latest rcov doesn't work 1.9)
+and run the following command:
+
+  rake rcov

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "mongoid_taggable_with_context"
+  gem.homepage = "http://github.com/aq1018/mongoid_taggable_with_context"
+  gem.license = "MIT"
+  gem.summary = %Q{Mongoid taggable behaviour}
+  gem.description = %Q{It provides some helpers to create taggable documents with context.}
+  gem.email = "aq1018@gmail.com"
+  gem.authors = ["Aaron Qian"]
+  gem.add_runtime_dependency 'mongoid', '~> 2.0.0.beta.20'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = "--color --format progress"
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = "--exclude ~\/.rvm,spec"
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/init.rb

@@ -0,0 +1 @@
+require 'mongoid/taggable_with_context'

data/lib/mongoid_taggable_with_context.rb

@@ -0,0 +1,249 @@
+# 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
+
+  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

data/mongoid_taggable_with_context.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_taggable_with_context}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Qian"]
+  s.date = %q{2011-02-12}
+  s.description = %q{It provides some helpers to create taggable documents with context.}
+  s.email = %q{aq1018@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/mongoid_taggable_with_context.rb",
+    "mongoid_taggable_with_context.gemspec",
+    "spec/mongoid_taggable_with_context_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/aq1018/mongoid_taggable_with_context}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Mongoid taggable behaviour}
+  s.test_files = [
+    "spec/mongoid_taggable_with_context_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, ["~> 2.0.0.beta.20"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<bson>, ["~> 1.2.1"])
+      s.add_development_dependency(%q<bson_ext>, ["~> 1.2.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 2.0.0.beta.20"])
+    else
+      s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.20"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<bson>, ["~> 1.2.1"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.2.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+      s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.20"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.20"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<bson>, ["~> 1.2.1"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.2.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+    s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.20"])
+  end
+end
+

data/spec/mongoid_taggable_with_context_spec.rb

@@ -0,0 +1,272 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class MyModel
+  include Mongoid::Document
+  include Mongoid::TaggableWithContext
+  taggable
+  taggable :artists
+end
+
+describe Mongoid::TaggableWithContext do
+  context "saving tags from plain text" do
+    before :each do
+      @m = MyModel.new
+    end
+
+    it "should set tags array from string" do
+      @m.tags = "some new tag"
+      @m.tags_array.should == %w[some new tag]
+    end
+    
+    it "should set artists array from string" do
+      @m.artists = "some new tag"
+      @m.artists_array.should == %w[some new tag]
+    end
+
+    it "should retrieve tags string from array" do
+      @m.tags_array = %w[some new tags]
+      @m.tags.should == "some new tags"
+    end
+    
+    it "should retrieve artists string from array" do
+      @m.artists_array = %w[some new tags]
+      @m.artists.should == "some new tags"
+    end
+
+    it "should strip tags before put in array" do
+      @m.tags = "now   with   some spaces   in places "
+      @m.tags_array.should == %w[now with some spaces in places]
+    end
+    
+    it "should remove repeated tags from string" do
+      @m.tags = "some new tags some new tags"
+      @m.tags_array.should == %w[some new tags]
+    end
+    
+    it "should remove repeated tags from array" do
+      @m.tags_array = %w[some new tags some new tags]
+      @m.tags.should == "some new tags"
+    end
+    
+    it "should remove nil tags from array" do
+      @m.tags_array = ["some", nil, "new", nil, "tags"]
+      @m.tags.should == "some new tags"
+    end
+  end
+
+  context "changing separator" do
+    before :all do
+      MyModel.tags_separator = ";"
+    end
+
+    after :all do
+      MyModel.tags_separator = " "
+    end
+
+    before :each do
+      @m = MyModel.new
+    end
+
+    it "should split with custom separator" do
+      @m.tags = "some;other;separator"
+      @m.tags_array.should == %w[some other separator]
+    end
+
+    it "should join with custom separator" do
+      @m.tags_array = %w[some other sep]
+      @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"
+    end
+    
+    it "should generate the artists aggregation collection name correctly" do
+      MyModel.artists_aggregation_collection.should == "my_models_artists_aggregation"
+    end
+
+    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")
+        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]
+        end
+
+        it "should retrieve a list of tags with weight" do
+          MyModel.tags_with_weight.should == [
+            ['ant', 1],
+            ['bee', 2],
+            ['food', 3],
+            ['honey', 1],
+            ['juice', 1],
+            ['strip', 1],
+            ['zip', 1]
+          ]
+        
+          MyModel.artists_with_weight.should == [
+            ['aaron', 2],
+            ['andrew', 1],
+            ['andy', 3],
+            ['grant', 1],
+            ['greg', 1],
+            ['jeff', 1],
+            ['mandy', 2]
+          ]
+        end
+      end
+      
+      context "on new then change attributes directly" do
+        before :each do
+          m = MyModel.new
+          m.tags = "food ant bee"
+          m.artists = "jeff greg mandy aaron andy"
+          m.save!
+          
+          m = MyModel.new
+          m.tags = "juice food bee zip"
+          m.artists = "grant andrew andy"
+          m.save!
+
+          m = MyModel.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]
+        end
+
+        it "should retrieve a list of tags with weight" do
+          MyModel.tags_with_weight.should == [
+            ['ant', 1],
+            ['bee', 2],
+            ['food', 3],
+            ['honey', 1],
+            ['juice', 1],
+            ['strip', 1],
+            ['zip', 1]
+          ]
+        
+          MyModel.artists_with_weight.should == [
+            ['aaron', 2],
+            ['andrew', 1],
+            ['andy', 3],
+            ['grant', 1],
+            ['greg', 1],
+            ['jeff', 1],
+            ['mandy', 2]
+          ]
+        end
+      end
+      
+      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.tags_array = m1.tags_array + %w[honey strip shoe]
+          m1.save!
+          
+          m3.artists_array = m3.artists_array + %w[grant greg gory]
+          m3.save!
+        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]
+        end
+
+        it "should retrieve a list of tags with weight" do
+          MyModel.tags_with_weight.should == [
+            ['ant', 1],
+            ['bee', 2],
+            ['food', 3],
+            ['honey', 2],
+            ['juice', 1],
+            ['shoe', 1],
+            ['strip', 2],
+            ['zip', 1]
+          ]
+        
+          MyModel.artists_with_weight.should == [
+            ['aaron', 2],
+            ['andrew', 1],
+            ['andy', 3],
+            ['gory', 1],
+            ['grant', 2],
+            ['greg', 2],
+            ['jeff', 1],
+            ['mandy', 2]
+          ]
+        end
+      end
+
+      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.tags_array = m1.tags_array + %w[honey strip shoe] - %w[food]
+          m1.save!
+          
+          m3.artists_array = m3.artists_array + %w[grant greg gory] - %w[andy]
+          m3.save!
+          
+          m2.destroy
+        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]
+        end
+
+        it "should retrieve a list of tags with weight" do
+          MyModel.tags_with_weight.should == [
+            ['ant', 1],
+            ['bee', 1],
+            ['food', 1],
+            ['honey', 2],
+            ['shoe', 1],
+            ['strip', 2]
+          ]
+        
+          MyModel.artists_with_weight.should == [
+            ['aaron', 2],
+            ['andy', 1],
+            ['gory', 1],
+            ['grant', 1],
+            ['greg', 2],
+            ['jeff', 1],
+            ['mandy', 2]
+          ]
+        end
+      end
+      
+    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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'mongoid'
+require 'mongoid_taggable_with_context.rb'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_taggable_with_context_test")
+end

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_taggable_with_context
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Aaron Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  name: mongoid
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: database_cleaner
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  name: bson
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  name: bson_ext
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id009
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  name: reek
+  version_requirements: *id010
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  name: roodi
+  version_requirements: *id011
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  name: mongoid
+  version_requirements: *id012
+  prerelease: false
+description: It provides some helpers to create taggable documents with context.
+email: aq1018@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/mongoid_taggable_with_context.rb
+- mongoid_taggable_with_context.gemspec
+- spec/mongoid_taggable_with_context_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/aq1018/mongoid_taggable_with_context
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Mongoid taggable behaviour
+test_files: 
+- spec/mongoid_taggable_with_context_spec.rb
+- spec/spec_helper.rb