mongoid-mapreduce 0.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Jason Coene
+
+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.md

@@ -0,0 +1,95 @@
+# Mongoid MapReduce
+
+Mongoid MapReduce provides simple aggregation functions to your models using MongoDB map/reduce.
+
+[![travis](https://secure.travis-ci.org/jcoene/mongoid-mapreduce.png)](http://travis-ci.org/jcoene/mongoid-mapreduce)
+
+## How simple is simple?
+
+Very. You provide a Mongoid model, criteria, map key and a list of fields to be aggregated. It returns a list of results (one per unique map key value).
+
+## Getting Started
+
+First, add mongoid-mapreduce to your Gemfile:
+
+```ruby
+gem 'mongoid-mapreduce'
+```
+
+Next, include the module in any models for collections you'll be wanting to map/reduce on:
+
+```ruby
+class Employee
+  include Mongoid::Document
+  include Mongoid::MapReduce
+
+  field :name
+  field :division
+  field :awards, :type => Integer
+  field :age, :type => Integer
+  field :male, :type => Integer
+end
+```
+
+You can now use the *map_reduce* method on your model to aggregate data:
+
+```ruby
+# Create a few example employees
+Employee.create :name => 'Alan', :division => 'Software', :age => 20, :awards => 5, :male => 1
+Employee.create :name => 'Bob', :division => 'Software', :age => 25, :awards => 4, :male => 1
+Employee.create :name => 'Chris', :division => 'Hardware', :age => 30, :awards => 3, :male => 1
+Employee.create :name => 'Darcy', :division => 'Sales', :age => 35, :awards => 3, :male => 0
+
+# Produces 3 records, one for each division.
+divs = Employee.map_reduce(:division, :fields => [:age, :awards])
+divs.length               # => 3
+divs.find('Software').age # => 45
+divs['Hardware'].awards   # => 3
+divs.first.awards         # => 9
+divs.last.age             # => 35
+divs.keys                 # => ['Hardware', 'Software', 'Sales']
+divs.has_key?('Sales')    # => true
+divs.to_hash              # => { "Software" => ..., "Hardware" => ..., "Sales" => ... }
+```
+
+You can also add Mongoid criteria before the operation:
+
+```ruby
+# Produces 2 records, one for each matching division (men only!)
+divs = Employee.where(:male => 1).map_reduce(:division, :fields => [:age, :awards])
+divs.length               # => 2
+divs.has_key?('Sales')    # => false
+```
+
+Additional meta fields are included in the results:
+
+NOTE: _key_name and _key_value are discarded when converting to Hash.
+
+```ruby
+# Produces 2 records, one for each matching division (men only!)
+divs = Employee.map_reduce(:division, :fields => [:age, :awards])
+divs.find('Software')._key_name   # => :division
+divs.find('Software')._key_value  # => "Software"
+divs.find('Software').division    # => "Software" (_key_name => _key_value)
+divs.find('Software')._count      # => 2
+
+# You can choose another name for the count field
+Employee.map_reduce(:division, :count_field => :num).find('Software').num  #=> 2
+```
+
+You can also choose to supply fields in a block:
+
+```ruby
+Employee.where(:age.gt => 20).map_reduce(:division) do
+  field :age
+  field :awards
+end
+```
+
+## Enhancements and Pull Requests
+
+If you find the project useful but it doesn't meet all of your needs, feel free to fork it and send a pull request.
+
+## License
+
+MIT license, go wild.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run all specs in the spec directory'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid-mapreduce.rb

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

data/lib/mongoid/mapreduce.rb

@@ -0,0 +1,6 @@
+require 'mongoid'
+require 'mongoid/mapreduce/base'
+require 'mongoid/mapreduce/document'
+require 'mongoid/mapreduce/reducer'
+require 'mongoid/mapreduce/results'
+require 'mongoid/mapreduce/version'

data/lib/mongoid/mapreduce/base.rb

@@ -0,0 +1,31 @@
+module Mongoid
+  module MapReduce
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Run a map/reduce operation on the current model
+      #
+      # map_key: Symbol or String, the field used in the map function
+      #
+      # Returns a Hash of results
+      def map_reduce(map_key=:_id, options={}, &block)
+        reducer = Reducer.new(self, criteria.selector, map_key)
+
+        if options.key?(:count_field)
+          reducer.count_field = options[:count_field].to_sym
+        end
+
+        if options.key?(:fields)
+          reducer.fields = options[:fields].collect {|f| f.to_sym }
+        end
+
+        reducer.instance_eval(&block) if block.present?
+        reducer.run
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/mapreduce/document.rb

@@ -0,0 +1,48 @@
+module Mongoid
+  module MapReduce
+
+    class Document < Hash
+
+      # Accept a hash of attributes dring initialization
+      #
+      # attrs - Hash of attributes to initialize with
+      #
+      # Returns value of super
+      def initialize(attrs)
+        attrs.each do |k, v|
+          self[k.to_sym] = v
+        end
+        super
+      end
+
+      # Allow dot notation on our Document
+      #
+      # sym - Symbol/String of the missing value
+      # args - Arguments supplied
+      # block - Block supplied
+      #
+      # Returns value of supplied symbol/string if exists
+      def method_missing(sym, *args, &block)
+        if self.has_key?(sym.to_sym)
+          return self[sym.to_sym]
+        elsif self.has_key?(sym.to_s)
+          return self[sym.to_s]
+        end
+        super
+      end
+
+      # Converts the Results to a Hash
+      #
+      # Returns Hash
+      def to_hash
+        h = Hash.new
+        self.each do |k, v|
+          h[k.to_s] = v unless [:_key_name, :_key_value].include?(k)
+        end
+        h
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/mapreduce/reducer.rb

@@ -0,0 +1,69 @@
+module Mongoid
+  module MapReduce
+
+    class Reducer
+
+      attr_accessor :fields, :count_field
+
+      # Initialize the reducer with given values
+      #
+      # klass - Mongoid model Class
+      # selector - Selector to use for search (often from criteria)
+      # map_key - Key to use in map function
+      #
+      # Returns nothing
+      def initialize(klass, selector, map_key)
+        @klass = klass
+        @selector = selector
+        @map_key = map_key
+        @count_field = :_count
+        @fields = []
+      end
+
+      # Generates the JavaScript map function
+      #
+      # Returns String
+      def map
+        "function() { emit(this.#{@map_key}, [1, #{@fields.collect{|k| "this.#{k}"}.join(", ")}]); }"
+      end
+
+      # Generates the JavaScript reduce function
+      #
+      # Returns String
+      def reduce
+        "function(k, v) { var results = [0#{",0" * @fields.length}]; v.forEach(function(v){ [0,#{@fields.collect.with_index{|k,i| i+1}.join(",")}].forEach(function(k){ results[k] += v[k] }) }); return results.toString(); }"
+      end
+
+      # Adds a field to the map/reduce operation
+      #
+      # sym - String or Symbol, name of field to add
+      #
+      # Returns nothing.
+      def field(sym)
+        @fields << sym.to_sym
+      end
+
+      # Runs the map/reduce operation and returns the result
+      #
+      # Returns Mongoid::MapReduce::Results object (array)
+      # containing Mongoid::MapReduce::Document objects (hashes)
+      def run
+        begin
+          res = @klass.collection.map_reduce(map, reduce, { query: @selector, out: "#map_reduce" } ).find.to_a
+          return res.inject(Results.new) do |h, k|
+            idx = k.values[0]
+            d = (k.values[1].is_a?(String) ? k.values[1].split(',') : k.values[1]).collect {|i| i.is_a?(Boolean) ? (i ? 1 : 0) : i.to_i }
+            doc = Document.new :_key_name => @map_key.to_sym, :_key_value => idx, @map_key.to_sym => idx, @count_field.to_sym => d[0]
+            @fields.flatten.each_with_index do |k, i|
+              doc[k.to_sym] = d[i + 1]
+            end
+            h << doc
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/mapreduce/results.rb

@@ -0,0 +1,54 @@
+module Mongoid
+  module MapReduce
+
+    class Results < Array
+
+      # Allow [] to be used to find records by key
+      #
+      # value - Value of the index or value to search by
+      #
+      # Return record at index if Fixnum, or result of find(value)
+      def [](value)
+        unless value.is_a? Fixnum
+          return find(value)
+        end
+        super
+      end
+
+      # Search for contained Documents by key
+      #
+      # value - Value of the map key
+      #
+      # Return Document or nil
+      def find(value)
+        self.each {|doc| return doc if doc._key_value == value }
+        nil
+      end
+
+      # Returns a list of keys from contained documents
+      #
+      # Returns Array
+      def keys
+        self.collect {|d| d._key_value }
+      end
+
+      # Determines whether or not a key exists
+      #
+      # value - Value of the map key
+      #
+      # Returns true or false
+      def has_key?(value)
+        find(value) ? true : false
+      end
+
+      # Converts the Results to a Hash
+      #
+      # Returns Hash
+      def to_hash
+        self.each.inject({}){|h, doc| h[doc._key_value] = doc.to_hash; h }
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/mapreduce/version.rb

@@ -0,0 +1,7 @@
+module Mongoid
+  module MapReduce
+
+    VERSION = '0.1.0'
+
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-mapreduce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Coene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70365613354940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70365613354940
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70365613354440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70365613354440
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70365613354060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365613354060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70365613353520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70365613353520
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70365613353020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70365613353020
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70365613352560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: *70365613352560
+description: Mongoid MapReduce provides simple aggregation features for your Mongoid
+  models
+email:
+- jcoene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongoid/mapreduce/base.rb
+- lib/mongoid/mapreduce/document.rb
+- lib/mongoid/mapreduce/reducer.rb
+- lib/mongoid/mapreduce/results.rb
+- lib/mongoid/mapreduce/version.rb
+- lib/mongoid/mapreduce.rb
+- lib/mongoid-mapreduce.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: http://github.com/jcoene/mongoid-mapreduce
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Simple map-reduce functionality for your Mongoid models
+test_files: []