taggregator 0.0.2.dev

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem 'mongo_mapper', '~> 0.9.0'
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.9)
+    bson (1.3.1)
+    builder (2.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mongo (1.3.1)
+      bson (>= 1.3.1)
+    mongo_mapper (0.9.1)
+      activemodel (~> 3.0)
+      activesupport (~> 3.0)
+      plucky (~> 0.3.8)
+    plucky (0.3.8)
+      mongo (~> 1.3)
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  mongo_mapper (~> 0.9.0)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mark Coates
+
+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,19 @@
+= taggregator
+
+Description goes here.
+
+== Contributing to taggregator
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Mark Coates. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "taggregator"
+  gem.homepage = "http://github.com/oddlyzen/taggregator"
+  gem.license = "MIT"
+  gem.summary = %Q{Bad-ass tagging intelligence for your document tagging in MongoMapper.}
+  gem.description = %Q{Taggable in context and aggregation of tags for MongoMapper. Adds weight and distribution convenience methods to models in which it is included. Uses MongoDB's increment/decrement ($inc/$dec) to keep real-time counts of individual tags in context with optional type. Based on 'Mongoid Taggable With Context' (https://github.com/aq1018/mongoid_taggable_with_context).}
+  gem.email = "mark.coates@gmail.com"
+  gem.authors = ["Mark Coates"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "taggregator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2.dev

data/lib/taggregator.rb

@@ -0,0 +1,231 @@
+module MongoMapper
+  module Plugins
+    autoload :Taggregator, 'taggregator'
+  end
+end
+
+module Taggregator
+  extend ActiveSupport::Concern
+  
+  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'
+    set_callback :create,   :after, :increment_tags_agregation
+    set_callback :save,     :after, :update_tags_aggregation
+    set_callback :destroy,  :after, :decrement_tags_aggregation
+  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
+    
+      # 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
+  
+    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/taggregator.gemspec

@@ -0,0 +1,62 @@
+# 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{taggregator}
+  s.version = "0.0.2.dev"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Coates"]
+  s.date = %q{2011-07-21}
+  s.description = %q{Taggable in context and aggregation of tags for MongoMapper. Adds weight and distribution convenience methods to models in which it is included. Uses MongoDB's increment/decrement ($inc/$dec) to keep real-time counts of individual tags in context with optional type. Based on 'Mongoid Taggable With Context' (https://github.com/aq1018/mongoid_taggable_with_context).}
+  s.email = %q{mark.coates@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/taggregator.rb",
+    "taggregator.gemspec",
+    "test/helper.rb",
+    "test/test_taggregator.rb"
+  ]
+  s.homepage = %q{http://github.com/oddlyzen/taggregator}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Bad-ass tagging intelligence for your document tagging in MongoMapper.}
+
+  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_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'taggregator'
+
+class Test::Unit::TestCase
+end

data/test/test_taggregator.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTaggregator < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: taggregator
+version: !ruby/object:Gem::Version
+  version: 0.0.2.dev
+  prerelease: 6
+platform: ruby
+authors:
+- Mark Coates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-21 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2153013020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153013020
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153012040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153012040
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2153011220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *2153011220
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2153010400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153010400
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &2153009760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153009760
+description: Taggable in context and aggregation of tags for MongoMapper. Adds weight
+  and distribution convenience methods to models in which it is included. Uses MongoDB's
+  increment/decrement ($inc/$dec) to keep real-time counts of individual tags in context
+  with optional type. Based on 'Mongoid Taggable With Context' (https://github.com/aq1018/mongoid_taggable_with_context).
+email: mark.coates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/taggregator.rb
+- taggregator.gemspec
+- test/helper.rb
+- test/test_taggregator.rb
+has_rdoc: true
+homepage: http://github.com/oddlyzen/taggregator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -779744515643755822
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Bad-ass tagging intelligence for your document tagging in MongoMapper.
+test_files: []