mongo_coffee 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 547f3b0707e2398d5c0a152f388ac7829016ed66
+  data.tar.gz: c1f1810cce1be4064da94e419d701282730a1336
+SHA512:
+  metadata.gz: bd37c3876a41c87371e201feae768d8a56e618d0658ef319f60f8f4974ac88254ce53028ffa7110d3be3b4f3e6410531272c964eb5bbe615bff8c6c96110dc3f
+  data.tar.gz: ee423dd995131c1d81401c764792bc96a6c32b049c9837a005945c536e94673f391ac8583b73a3a0a632fac7524c5d97e2ece3419663fa2e3092a0adf1a579b2

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in mongocoffee.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Guillermo Guerrero
+
+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,108 @@
+# MongoCoffee
+
+Map reduce your mongo documents writing in with coffeescript.
+As simple as it sounds! Finally you can organize and write your huge map/reduce/finalize functions in coffeescript syntax!
+
+## Setup and run!
+Run **mongo_coffee:config** generator to setup config files on your rails project.
+Then you can edit them as your needs:
+
+```bash
+$ rails g mongo_coffee:config
+      create  config/mongo_coffee.yml
+      create  config/initializers/mongo_coffee.rb
+```
+
+On *mongo_coffee.yml* file you'll find some config you might change:
+
+```yaml
+coffee_path: 'app/models/map_reduces'
+coffee_extensions:
+  - .js.coffee
+  - .coffee
+```
+
+## Usage
+The **MongoCoffee** compiler engine will search on **coffee_path** path (see *setup* section above) for files 
+matching the following convention: **%name%_%map/reduce/finalize%.js.coffee**, i.e in the example below the 
+following files should be ready in *coffee_path* directory (could be in some subdirectory):
+
+- playing_stats_map.js.coffee
+- playing_stats_reduce.js.coffee
+- playing_stats_finalize.js.coffee
+
+Where this may be the content of the files:
+
+**playing_stats_map.js.coffee**
+
+```coffeescript
+->
+  emit
+    artirst: @artist
+    album: @album,
+      plays: 1
+      votes: 1
+```
+
+**playing_stats_reduce.js.coffee**
+
+
+```coffeescript
+(key, values) ->
+  result =
+    plays: 0
+    votes: 0
+  
+
+  for value in values
+    result.plays += value.plays
+    result.votes += value.votes
+```
+
+Have a look at [**the mongodb map/reduce documentation**](https://docs.mongodb.org/manual/core/map-reduce/).
+
+### Caffeine to your model
+Call any of your map/reduce coffeescript collection with:
+
+```ruby
+Band.caffeine_map_reduce('playing_stats').out(inline: 1)
+```
+
+If you've defined a finalize coffesript function you can also use it with:
+
+```ruby
+Band.caffeine_map_reduce('playing_stats').caffeine_finalize('playing_stats').out(inline: 1)
+```
+
+As you may think, a map/reduce action will generate a new collection on MongoDB so, you may create it's model for interaction with new documents:
+
+```ruby
+class PlayingStat
+  include Mongoid::Document
+  store_in collection: 'playing_stats'
+
+  field :value
+
+  index({"_id.artist" => 1},{background: true})
+  index({"_id.artist" => 1, "_id.album" => 1},{background: true})
+
+  def artist
+    _id["artist"]
+  end
+
+  def album
+    _id["album"]
+  end
+
+  def total_plays
+    value["plays"]
+  end
+
+  def total_votes
+    value["votes"]
+  end
+end
+```
+
+## License
+This project uses [*MIT-LICENSE*](http://en.wikipedia.org/wiki/MIT_License).

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mongocoffee'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/mongo_coffee/config_generator.rb

@@ -0,0 +1,9 @@
+class MongoCoffee::ConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+ 
+  desc "Generate the mongo coffee config and initializer files in your project."
+  def copy_config_file
+    copy_file "mongo_coffee.yml", "config/mongo_coffee.yml"
+    copy_file "mongo_coffee.rb",  "config/initializers/mongo_coffee.rb"
+  end
+end

data/lib/generators/mongo_coffee/templates/mongo_coffee.rb

@@ -0,0 +1,2 @@
+require 'mongo_coffee'
+MongoCoffee::Compiler.setup! File.expand_path('../../mongo_coffee.yml', __FILE__)

data/lib/generators/mongo_coffee/templates/mongo_coffee.yml

@@ -0,0 +1,4 @@
+coffee_path: 'app/models/map_reduces'
+coffee_extensions:
+  - .js.coffee
+  - .coffee

data/lib/mongo_coffee/compiler.rb

@@ -0,0 +1,45 @@
+require 'coffee-script'
+
+module MongoCoffee
+
+  class CoffeeFileNotFound < StandardError
+    def initialize(filename)
+      message = "File '#{filename}' does not exists."
+      super message
+    end
+  end
+
+  class Compiler
+
+    class << self
+      def setup!(filename)
+        @config = Config.load filename
+      end
+
+      def compile(name, action)
+        @name   = name
+        @action = action
+
+        extract
+      end
+
+      private
+      def filename
+        path = @config["coffee_path"]
+        extensions = @config["coffee_extensions"].join(',')
+
+        wildcard = Rails.root.join(path, "**/#{@name}_#{@action}{#{extensions}}")
+
+        files = Dir.glob(wildcard)
+        raise CoffeeFileNotFound, wildcard if files.empty?
+
+        files.first
+      end
+
+      def extract
+        CoffeeScript.compile(File.open(filename), bare: true).chomp.slice(1..-3)
+      end
+    end
+  end
+
+end

data/lib/mongo_coffee/config.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+module MongoCoffee
+  class Config
+    def self.load(filename)
+      YAML.load_file(filename)
+    end
+  end
+end

data/lib/mongo_coffee/engine.rb

@@ -0,0 +1,4 @@
+module MongoCoffee
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/mongo_coffee/mongoid/finders.rb

@@ -0,0 +1,12 @@
+module MongoCoffee::Mongoid
+  module Finders
+
+    def caffeine_map_reduce(filename)
+      compiled_map    = MongoCoffee::Compiler.compile(filename, :map) 
+      compiled_reduce = MongoCoffee::Compiler.compile(filename, :reduce) 
+
+      map_reduce(compiled_map, compiled_reduce)
+    end
+
+  end
+end

data/lib/mongo_coffee/mongoid/map_reduce.rb

@@ -0,0 +1,11 @@
+module MongoCoffee::Mongoid
+  module MapReduce
+
+    def caffeine_finalize(filename)
+      compiled_finalize = MongoCoffee::Compiler.compile(filename, :finalize)
+ 
+      finalize compiled_finalize
+    end
+
+  end
+end

data/lib/mongo_coffee/version.rb

@@ -0,0 +1,3 @@
+module MongoCoffee
+  VERSION = "1.0.0"
+end

data/lib/mongo_coffee.rb

@@ -0,0 +1,17 @@
+require 'mongo_coffee/version'
+require 'mongo_coffee/engine'
+require 'mongo_coffee/config'
+require 'mongo_coffee/compiler'
+require 'mongo_coffee/mongoid/finders'
+require 'mongo_coffee/mongoid/map_reduce'
+
+
+if defined? Mongoid
+  module Mongoid::Finders
+    include MongoCoffee::Mongoid::Finders
+  end
+  
+  class Mongoid::Contextual::MapReduce
+    include MongoCoffee::Mongoid::MapReduce
+  end
+end

data/lib/tasks/mongocoffee_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mongocoffee do
+#   # Task goes here
+# end

data/mongo_coffee.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "mongo_coffee/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "mongo_coffee"
+  s.version     = MongoCoffee::VERSION
+  s.authors     = ["Guillermo Guerrero"]
+  s.email       = ["g.guerrero.bus@gmail.com"]
+  s.homepage    = "https://github.com/gguerrero/mongocoffee"
+  s.summary     = "MongoDB mapReduce with coffeescript."
+  s.description = "Map reduce your mongo documents writing in with coffeescript."
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "rails", "~> 3.2.14"
+  s.add_dependency "coffee-script", "~> 2.2.0"
+  s.add_dependency "mongoid", "~> 3.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: mongo_coffee
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Guillermo Guerrero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Map reduce your mongo documents writing in with coffeescript.
+email:
+- g.guerrero.bus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/mongo_coffee/config_generator.rb
+- lib/generators/mongo_coffee/templates/mongo_coffee.rb
+- lib/generators/mongo_coffee/templates/mongo_coffee.yml
+- lib/mongo_coffee.rb
+- lib/mongo_coffee/compiler.rb
+- lib/mongo_coffee/config.rb
+- lib/mongo_coffee/engine.rb
+- lib/mongo_coffee/mongoid/finders.rb
+- lib/mongo_coffee/mongoid/map_reduce.rb
+- lib/mongo_coffee/version.rb
+- lib/tasks/mongocoffee_tasks.rake
+- mongo_coffee.gemspec
+homepage: https://github.com/gguerrero/mongocoffee
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: MongoDB mapReduce with coffeescript.
+test_files: []