taggregator 0.1.1 → 0.1.2

data/Gemfile

@@ -11,4 +11,5 @@ group :development do
   gem "jeweler", "~> 1.6.2"
   gem "rcov", ">= 0"
   gem 'mongo_mapper', '~> 0.9.0'
+  gem 'pry'
 end

data/Gemfile.lock

@@ -8,12 +8,15 @@ GEM
     activesupport (3.0.9)
     bson (1.3.1)
     builder (2.1.2)
+    coderay (0.9.8)
     git (1.2.5)
     i18n (0.5.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    method_source (0.6.0)
+      ruby_parser (>= 2.0.5)
     mongo (1.3.1)
       bson (>= 1.3.1)
     mongo_mapper (0.9.1)
@@ -22,9 +25,18 @@ GEM
       plucky (~> 0.3.8)
     plucky (0.3.8)
       mongo (~> 1.3)
+    pry (0.9.2)
+      coderay (>= 0.9.8)
+      method_source (>= 0.6.0)
+      ruby_parser (>= 2.0.5)
+      slop (~> 1.9.0)
     rake (0.9.2)
     rcov (0.9.9)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
     shoulda (2.11.3)
+    slop (1.9.1)
 
 PLATFORMS
   ruby
@@ -33,5 +45,6 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.6.2)
   mongo_mapper (~> 0.9.0)
+  pry
   rcov
   shoulda

data/README.md

@@ -1,10 +1,10 @@
 # Taggregator
 
-Adds tagging with 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).
+Adds tagging in context (and aggregation of those tags) to your MongoMapper models. Tag weight and distribution methods make it easy to find real-time taxonomical hotspots in datastore. **Taggregator** 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 "The Progenitor.").
 
-## Usage
+## Basic Usage
 
-**Taggregator** is very easy to use. Just include the MongoMapper plugin in your model the normal way and call `taggable`, like so:
+**Taggregator** is easy to use. Just include the MongoMapper plugin in your model the normal way and call `taggable`, like so:
 
     class Article
       include MongoMapper::Document
@@ -19,9 +19,9 @@ Adds tagging with context and aggregation of tags for MongoMapper. Adds weight a
 
     a = Article.new
 
-Tags are then set with a string by calling `a.tags = 'space separated tags'`. Tag separators default to a space character, but as you see in the above example, can be overridden for with any character or string of your choice. If we follow the lead of the example, we would set `a.ads` by calling `a.ads = 'comma,separated,tags'`. The call to `taggable` will also add the array representation of the taggable fields with context, accessible through `a.tags_array`, `a.keywords_array`, and `a.ads_array`. If you have an array of string tags and wish to set the tags array manually, you can (i.e., `a.ads_array = ['xmas', 'shopping', 'books']`). Just as setting the string `a.ads` will populate `a.ads_array`, setting the tags array will also populate the string representation of the tag list in context.
+Tags are then set with a string by calling `a.tags = 'space separated tags'`. The tag separator character defaults to the space character, but as you see in the above example, it can be overridden with any character or string of your choice. If we follow the lead of the example, we would set `a.ads` by calling `a.ads = 'comma,separated,tags'`. The call to `taggable` injects an array representation of the model's taggable fields with context, accessible through `a.tags_array`, `a.keywords_array`, and `a.ads_array`. If you have an array of tags (strings) and wish to set the tags array manually, you can (i.e., `a.ads_array = ['xmas', 'shopping', 'books']`). When the string `a.ads` is set, `a.ads_array` is populated with the individual tags. Likewise, setting the tags array populates the string representation of the tag list for that context.
 
-The call to `taggable` will also allow you to do some pretty cool stuff now. You can get all articles tags with a call to `Article.tags` and all tags (in the 'keywords' context) with `Article.keywords`. If you would like to get a list of all keywords with the keyword's associated frequency/weight, simply do something like:
+The call to `taggable` will mixes in some cool stuff. You can get all articles tags with a call to `Article.tags` and all tags (in the 'keywords' context) with `Article.keywords`. If you would like to get a list of all keywords with the keyword's associated frequency/weight, try this:
 
     Article.tags_with_weight_for :keywords
     => [["stocks", 4], ["finance", 4], ["banking", 3], ["bonds", 1]]
@@ -38,5 +38,5 @@ The call to `taggable` will also allow you to do some pretty cool stuff now. You
 
 ## Copyright
 
-Copyright © 2011 Mark Coates. See LICENSE.txt for further details.
-
+Copyright © 2011 Mark Coates and dtime, inc. (http://dtime.com). See LICENSE.txt for further details.
+ 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/taggregator.rb

@@ -6,8 +6,8 @@ module MongoMapper
       extend ActiveSupport::Concern
 
       included do
-        class_inheritable_reader :taggable_with_context_options
-        write_inheritable_attribute(:taggable_with_context_options, {})
+        class_attribute :taggable_with_context_options
+        self.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'
@@ -51,9 +51,9 @@ module MongoMapper
           tags_array_field = options[:array_field]
 
           # register / update settings
-          class_options = taggable_with_context_options || {}
+          class_options = self.taggable_with_context_options || {}
           class_options[tags_field] = options
-          write_inheritable_attribute(:taggable_with_context_options, class_options)
+          self.taggable_with_context_options = class_options
 
           # setup fields & indexes
           key tags_field.to_sym, String, :default => ""
@@ -168,10 +168,6 @@ module MongoMapper
          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"
@@ -213,7 +209,19 @@ module MongoMapper
         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)
+          where(:"#{array_field}".in => tags)
+        end
+        
+        # tags for similar items
+        # def similar?(article)
+        # end 
+        
+        # an array returned with similar items
+        def find_similar(article, options={:through => :tags})
+          context = options[:through]
+          array_field = tag_options_for(options[:through])[:array_field]
+          tags = article[array_field]
+          where(:"#{array_field}".in => tags)
         end
 
         # Helper method to convert a String to an Array based on the

data/taggregator.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{taggregator}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Mark Coates"]
-  s.date = %q{2011-07-21}
+  s.authors = [%q{Mark Coates}]
+  s.date = %q{2011-08-08}
   s.description = %q{Adds tagging with 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 = [
@@ -28,12 +28,13 @@ Gem::Specification.new do |s|
     "lib/taggregator/instance_methods.rb",
     "taggregator.gemspec",
     "test/helper.rb",
+    "test/models/article.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.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Bad-ass tagging intelligence for your document tagging in MongoMapper.}
 
   if s.respond_to? :specification_version then
@@ -45,12 +46,14 @@ Gem::Specification.new do |s|
       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"])
+      s.add_development_dependency(%q<pry>, [">= 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"])
+      s.add_dependency(%q<pry>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
@@ -58,6 +61,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+    s.add_dependency(%q<pry>, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -1,4 +1,7 @@
 require 'rubygems'
+require 'active_support'
+require 'pry'
+require 'mongo_mapper'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
@@ -14,5 +17,14 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'taggregator'
 
+MongoMapper.database = "testing_taggregator"
+
+require 'models/article'
+
 class Test::Unit::TestCase
 end
+
+@lipsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus porttitor, ipsum a commodo aliquet, 
+           velit ligula porttitor eros, sit amet consequat purus massa sit amet quam. Aliquam tempus magna faucibus 
+           lacus ultricies rhoncus. In ut metus purus, at venenatis est. Donec vel elementum turpis. Nullam feugiat 
+           massa quis elit egestas."

data/test/models/article.rb

@@ -0,0 +1,13 @@
+class Article
+  include MongoMapper::Document
+  include MongoMapper::Plugins::Taggregator
+  
+  key :title,   String
+  key :body,    String
+  key :authors, Array
+  
+  taggable
+  taggable :keywords
+  taggable :ads, :separator => ', '
+  
+end

data/test/test_taggregator.rb

@@ -1,7 +1,61 @@
 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"
+  def setup
+    @articles = [
+    (@home_and_garden = Article.new( title: 'Is your refrigerator running? Better catch it',
+                                    body: @lipsum,
+                                    authors: ['Thomas Mann', 'Jim Byrd'])),
+    (@golf_digest =    Article.new(  title: 'The Colonial: In Full Swing',
+                                    body: @lipsum,
+                                    authors: ['Rebecca Simmons']))
+                ]
+    @home_and_garden.keywords = 'luxury household appliances'
+    @home_and_garden.ads_array = ['LG Electronics', 'Kenneth Cole']
+    @golf_digest.keywords = 'resort vacation luxury'
+    @golf_digest.ads_array = ['Calloway', 'Ping']
+    save_articles
   end
+  
+  should "Have keywords context" do
+    assert @home_and_garden.keywords
+    assert @golf_digest.keywords
+  end
+  
+  should 'parse a string to tags' do
+    assert @home_and_garden.keywords_array.count == 3
+    assert @golf_digest.keywords_array.count == 3
+  end
+  
+  should 'parse an array for a string representation of the tags' do
+    assert @home_and_garden.ads == 'LG Electronics, Kenneth Cole'
+    assert @golf_digest.ads     == 'Calloway, Ping'
+  end
+  
+  should 'return all tags for Articles with the tag\'s corresponding weight' do
+    tags = Article.tags_with_weight_for :keywords
+    assert tags.kind_of? Array
+    assert tags[0][0] == 'luxury' && tags[0][1] == 2
+  end
+  
+  should 'return a list of articles if given a tag' do
+    articles = Article.keywords_tagged_with 'luxury'
+    assert articles.count == 2
+  end
+  
+  should 'find similar articles when given a context and article' do
+    article = Article.all.first
+    assert (Article.find_similar article, :through => :keywords).count == 2
+  end
+  
+  def teardown
+    Article.destroy_all
+  end
+
+  private
+  def save_articles
+    @articles.each{ |article| article.save }
+  end
+  
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taggregator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-21 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-08-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2152444980 !ruby/object:Gem::Requirement
+  requirement: &2161338120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152444980
+  version_requirements: *2161338120
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152444440 !ruby/object:Gem::Requirement
+  requirement: &2161336380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2152444440
+  version_requirements: *2161336380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2152443920 !ruby/object:Gem::Requirement
+  requirement: &2161326480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +43,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *2152443920
+  version_requirements: *2161326480
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2152443340 !ruby/object:Gem::Requirement
+  requirement: &2161325420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152443340
+  version_requirements: *2161325420
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
-  requirement: &2152442720 !ruby/object:Gem::Requirement
+  requirement: &2161324300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +65,18 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *2152442720
+  version_requirements: *2161324300
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2161323420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161323420
 description: Adds tagging with 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
@@ -89,8 +99,8 @@ files:
 - lib/taggregator/instance_methods.rb
 - taggregator.gemspec
 - test/helper.rb
+- test/models/article.rb
 - test/test_taggregator.rb
-has_rdoc: true
 homepage: http://github.com/oddlyzen/taggregator
 licenses:
 - MIT
@@ -106,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1716478362843917750
+      hash: 3761616067399779497
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Bad-ass tagging intelligence for your document tagging in MongoMapper.