rugroupy 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Wynn
+
+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,42 @@
+= rugroupy
+
+rugroupy is a ruby library which interacts with mongodb allowing one to tag entities and perform queries
+to determine similarity between entities. rugroupy finds similarities by performing a series of map-reduce
+operations using mongo.  By using mongo's auto sharding capabilities rugroupy's grouping operation can 
+be distributed between multiple servers.
+
+== features
+ * find entities most similiar to a given entity
+ * find the most similiar entities over the entire entity set
+ * use javascript to include only certain tags in the grouping operation
+ * use javascript to assign custom scoring to certain tags
+ * use javascript to create dynamic tags
+
+== Examples
+
+See http://github.com/rwynn/rugroupy/tree/master/test
+
+== Requirements
+
+* Mongo http://www.mongodb.org/downloads
+* Mongo Ruby Driver http://www.mongodb.org/display/DOCS/Ruby+Language+Center#RubyLanguageCenter-RubyDriver
+
+== Install
+
+* sudo gem install rugroupy
+
+== Contributing to rugroupy
+ 
+* 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 Ryan Wynn. See LICENSE.txt for
+further details.
+

data/lib/rugroupy/entity.rb

@@ -0,0 +1,86 @@
+require 'mongo'
+require 'bson'
+
+module Groupy
+  
+  class Entity
+    def initialize(database, name, entity_id, create=true)
+      @database, @name, @entity_id = database, name, entity_id
+      @database.create_collection(@name) if not @database.collection_names.member?(@name)
+    
+      @database["#{@name}_count"].ensure_index([['_id.e', Mongo::DESCENDING],
+        ['_id.tag', Mongo::DESCENDING], 
+        ['value.count', Mongo::DESCENDING]], :background => false)
+    
+      if create
+        begin
+          doc = Hash["_id"=>@entity_id, "tags"=>Hash.new]
+          @database[@name].insert(doc, :safe=>true)
+        rescue Mongo::MongoDBError => e
+        end
+      end
+    end
+
+    def get
+      @database[@name].find_one({ "_id" => @entity_id })
+    end
+    
+    def delete
+      @database[@name].remove({"_id" => @entity_id}, :safe => true)
+      nil
+    end
+
+    def clear_tags
+      spec = {"_id" => @entity_id }
+      doc = {"$set" => { "tags" => Hash.new } }
+      @database[@name].update(spec, doc, :safe=>true)
+      nil
+    end
+  
+    def has_tag(tag, value)
+      e = self.get()
+      e['tags'].member?(tag) and e['tags'][tag].member?(value)
+    end
+    
+    def tag(tag, value)
+      self.apply_tag(tag, value)
+      nil
+    end
+    
+    def untag(tag, value)
+      self.apply_tag(tag, value, add=false)
+      nil
+    end
+    
+    def apply_tag(tag, value, add=true)
+      op = add ? "$addToSet" : "$pull"
+      doc = Hash.new
+      field = "tags.#{tag}"
+      if value.is_a?(String)
+        doc[op] = { field => value }
+      else
+        op = "$pullAll" unless add
+        doc[op] = add ? {field => {"$each" => value}} : {field => value}
+      end
+      spec = Hash["_id" => @entity_id]
+      @database[@name].update(spec, doc, :safe=>true)
+      nil
+    end
+  
+    def similiar(tag=nil, skip=nil, limit=nil, reverse=false)
+      q = BSON::OrderedHash.new
+      q["_id.e"] = @entity_id
+      q["_id.tag"] = tag ? tag : {"$exists" => false}
+      cursor = @database["#{@name}_count"].find(q, :fields => {"_id.e" => 1})
+      cursor.skip(skip) if skip
+      cursor.limit(limit) if limit
+      cursor.sort("value.count", reverse ? Mongo::ASCENDING : Mongo::DESCENDING)
+      cursor.collect do |r|
+        pair = r["_id"]["e"]
+        pair[0] == @entity_id ? pair[1] : pair[0]
+      end
+    end
+  
+  end
+end
+

data/lib/rugroupy/group.rb

@@ -0,0 +1,101 @@
+require 'mongo'
+require 'bson'
+
+module Groupy
+  
+  class EntityGrouper
+  
+    @@defaultScoreFunction = "function(tag) { return 1; }"
+    @@defaultIncludeFunction = "function(tag) { return true; }"
+    @@dynamicTagFunction = "function(doc) {}"
+  
+    def initialize(database, entity)
+      @database, @entity = database, entity
+      @database["#{@entity}_count"].ensure_index([['_id.tag', Mongo::DESCENDING],
+        ['value.count', Mongo::DESCENDING]], :background => false)
+    end
+  
+    def similiar(tag=nil, skip=nil, limit=nil, reverse=false)
+      q = BSON::OrderedHash.new
+      q["_id.tag"] = tag ? tag : {"$exists" => false}
+      cursor = @database["#{@entity}_count"].find(q, :fields => {"_id.e" => 1})
+      cursor.skip(skip) if skip
+      cursor.limit(limit) if limit
+      cursor.sort("value.count", reverse ? Mongo::ASCENDING : Mongo::DESCENDING)
+      cursor.collect { |r| r["_id"]["e"] }
+    end
+  
+    def group(options={})
+      self.invert_entities(options[:includeFunction] || @@defaultIncludeFunction,
+        options[:dynamicTagFunction] || @@dynamicTagFunction)
+      self.count_entities(options[:scoreFunction] || @@defaultScoreFunction)
+    end
+  
+    def count_entities(scoreFunction)
+      map = BSON::Code.new(<<eos)
+        function() { 
+          score = #{scoreFunction}; 
+          tag = this._id.tag; 
+          tagScore = score(tag); 
+          entities = this.value.entities.slice(0).sort(); 
+          for (x in entities) { 
+            for (y in entities) { 
+              if (x < y) { 
+                emit({tag:tag, e:[entities[x], entities[y]]}, {count:tagScore}); 
+                emit({e:[entities[x], entities[y]]}, {count:tagScore}); 
+              } 
+            } 
+          } 
+        } 
+eos
+
+      reduce = BSON::Code.new(<<eos)
+        function(key, values) { 
+          result = {count:0}; 
+          values.forEach(function(value) { 
+            result.count += value.count; 
+          }); 
+          return result; 
+        } 
+eos
+    
+      @database["#{@entity}_invert"].map_reduce(map, reduce, :out => "#{@entity}_count")
+      nil
+    end
+  
+    def invert_entities(includeFunction, dynamicTagFunction)
+      map = BSON::Code.new(<<eos)
+        function() { 
+          include = #{includeFunction};
+          dynamicTagFunction = #{dynamicTagFunction};
+          entity_id = this._id; 
+          if (this.tags) { 
+            for (tag in this.tags) { 
+              if (!include(tag)) continue; 
+              this.tags[tag].forEach(function(z) { 
+                emit({tag:tag, value:z}, {entities: [entity_id]}); 
+              });
+            }
+            dynamicTagFunction(this);
+          } 
+        }
+eos
+    
+      reduce = BSON::Code.new(<<eos)
+        function(key, values) { 
+          result = {entities:[]}; 
+          values.forEach(function(value) { 
+            value['entities'].forEach(function(entity_id) { 
+              result['entities'].push( entity_id ); 
+            }); 
+          }); 
+          return result; 
+        }
+eos
+     
+      @database[@entity].map_reduce(map, reduce, :out => "#{@entity}_invert")
+      nil
+    end
+  
+  end
+end

data/lib/rugroupy.rb

@@ -0,0 +1,2 @@
+require 'rugroupy/entity'
+require 'rugroupy/group'

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification 
+name: rugroupy
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Wynn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: shoulda
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  version_requirements: *id005
+  name: mongo
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  version_requirements: *id006
+  name: bson
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  version_requirements: *id007
+  name: bson_ext
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  version_requirements: *id008
+  name: SystemTimer
+  prerelease: false
+  type: :development
+description: a library which uses the map-reduce capabilities of mongodb to group entities based on tags.
+email: ryan.m.wynn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/rugroupy.rb
+- lib/rugroupy/entity.rb
+- lib/rugroupy/group.rb
+- LICENSE.txt
+- README.rdoc
+homepage: http://github.com/rwynn/rugroupy
+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.8.6
+signing_key: 
+specification_version: 3
+summary: find things that are similiar to things
+test_files: []
+