ruby_mongo_utils 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo_utils.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    mongo_utils (0.0.1)
+      mongoid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    database_cleaner (0.9.1)
+    diff-lcs (1.2.4)
+    i18n (0.6.1)
+    mongoid (3.1.3)
+      activemodel (~> 3.2)
+      moped (~> 1.4.2)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.4.5)
+    multi_json (1.7.2)
+    origin (1.1.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  mongo_utils!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nikita Cernovs
+
+MIT License
+
+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,29 @@
+# MongoUtils
+
+Ruby Mongo Utilities
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongo_utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo_utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/mongo_utils/mongo_dump.rb

@@ -0,0 +1,14 @@
+module MongoUtils
+  module MongoDump
+    def self.call(options)
+      cmd = %{
+        mongodump --db         #{Mongoid.respond_to?(:database) ? Mongoid.database.name : Mongoid.default_session['database'].database.name}
+                  --host       #{Mongoid.respond_to?(:database) ? Mongoid.database.connection.primary.join(':') : Mongoid.sessions['default']['hosts'][0]}
+                  --collection #{options[:collection]}
+                  --query      "#{options[:query]}"
+                  -o           #{options[:path]}
+      }.squish
+      `#{cmd}`      
+    end
+  end
+end

data/lib/mongo_utils/mongo_restore.rb

@@ -0,0 +1,12 @@
+module MongoUtils
+  module MongoRestore
+    def self.call(options)
+      cmd = %{
+        mongorestore --host   #{Mongoid.respond_to?(:database) ? Mongoid.database.connection.primary.join(':') : Mongoid.sessions['default']['hosts'][0]}
+                     --filter "#{options[:filter]}"
+                     #{options[:path]}
+      }.squish
+      `#{cmd}`
+    end
+  end
+end

data/lib/mongo_utils/stripable.rb

@@ -0,0 +1,36 @@
+module MongoUtils
+  module Stripable
+    def blank_value?(value)
+      if value.is_a?(Hash)
+        value.reject! { |_, v| blank_value?(v) }
+      end
+      plain_value_blank?(value)
+    end
+
+    def plain_value_blank?(value)
+      value.blank? || value == 0
+    end
+
+    def blank_and_was_blank_value?(attribute, value)
+      blank_value?(value) && respond_to?("#{attribute}_was") && blank_value?(send("#{attribute}_was"))
+    end
+
+    def self.included(base)
+      base.send :include, Mongoid::Document
+
+      base.around_create do |&b|
+        attributes.reject! { |_, value| blank_value?(value) }
+        b.call
+        apply_defaults
+      end
+
+      base.around_update do |&b|
+        attributes.reject! { |a, v|
+          blank_and_was_blank_value?(a, v)
+        }
+        b.call
+        apply_defaults
+      end
+    end
+  end
+end

data/lib/mongo_utils/version.rb

@@ -0,0 +1,3 @@
+module MongoUtils
+  VERSION = '0.0.1'
+end

data/lib/mongo_utils.rb

@@ -0,0 +1,5 @@
+require 'mongoid'
+require 'mongo_utils/version'
+require 'mongo_utils/stripable'
+require 'mongo_utils/mongo_dump'
+require 'mongo_utils/mongo_restore'

data/mongo_utils.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_utils/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ruby_mongo_utils'
+  gem.version       = MongoUtils::VERSION
+  gem.authors       = ['Nikita Cernovs']
+  gem.email         = ['n.cernovs@77agency.com']
+  gem.description   = %q{Ruby Mongo Utilities}
+  gem.summary       = %q{Ruby Mongo Utilities}
+  gem.homepage      = ''
+
+  gem.add_dependency 'mongoid'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'database_cleaner'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/mongodumps/mongo_utils_tests/pages.metadata.json

@@ -0,0 +1 @@
+{indexes:[{ "v" : 1, "key" : { "_id" : 1 }, "ns" : "mongo_utils_tests.pages", "name" : "_id_" }]}

data/spec/fixtures/page.rb

@@ -0,0 +1,12 @@
+class Page
+  include Mongoid::Document
+  include MongoUtils::Stripable
+
+  field :name,  type: String
+  field :tags,  type: Array, default: []
+  field :likes, type: Hash,  default: { lifetime: { total: 0 } }
+
+  embeds_many :posts
+
+
+end

data/spec/fixtures/post.rb

@@ -0,0 +1,9 @@
+class Post
+  include Mongoid::Document
+  include MongoUtils::Stripable
+
+  field :message, type: String, default: ''
+  field :likes,   type: Integer, default: 0
+
+  embedded_in :page
+end

data/spec/mongo_utils/mongo_restore_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe MongoUtils::MongoRestore do
+  it 'should create backup files and be able to restore from it' do
+    10.times { Page.create! page_type: 'Facebook'  }
+    10.times { Page.create! page_type: 'Google+'   }
+    10.times { Page.create! page_type: 'Wordpress' }
+
+    Page.count.should eq 30
+
+    path = "#{Dir.pwd}/mongodumps"
+
+    MongoUtils::MongoDump.call(
+      collection: Page.collection_name,
+      query:      "{ 'page_type': { '\\$ne': 'Wordpress' } }",
+      path:       path
+    )
+
+    Page.count.should eq 30
+
+    Page.destroy_all
+
+    Page.count.should eq 0
+
+    MongoUtils::MongoRestore.call(
+      collection: Page.collection_name,
+      filter:     "{ 'page_type': 'Facebook' }",
+      path:       path
+    )
+
+    Page.count.should eq 10
+
+    MongoUtils::MongoRestore.call(
+      collection: Page.collection_name,
+      filter:     "{ 'page_type': 'Google+' }",
+      path:       path
+    )
+
+    Page.count.should eq 20
+  end
+end

data/spec/mongo_utils/stripable_spec.rb

@@ -0,0 +1,296 @@
+require 'spec_helper'
+
+describe MongoUtils::Stripable do
+  context 'on create' do
+    it 'should not store blank default values' do
+      page = Page.create!
+
+      page.name.should eq nil
+      page.tags.should eq []
+      page.likes.should eq({ lifetime: { total: 0 } })
+      page.posts.should eq []
+
+      Page.collection.find.first.keys.should eq ['_id']
+    end
+
+    it 'should not store blank or zero values' do
+      page = Page.create! name: '', tags: [], likes: nil
+
+      page.name.should eq nil
+      page.tags.should eq []
+      page.likes.should eq({ lifetime: { total: 0 } })
+      page.posts.should eq []
+
+      Page.collection.find.first.keys.should eq ['_id']
+    end
+
+    it 'should store values with content' do
+      page = Page.create! name: 'Name', tags: ['a']      
+
+      page.name.should eq 'Name'
+      page.tags.should eq ['a']
+      page.likes.should eq({ lifetime: { total: 0 } })
+      page.posts.should eq []
+
+      page = Page.collection.find.first
+      page.keys.sort.should eq ['_id', 'name', 'tags']
+      page['name'].should eq 'Name'
+      page['tags'].should eq ['a']
+    end
+
+    it 'should recursiverly detect if hash has no values' do
+      page = Page.create! likes: { lifetime: { user555: 0 } }
+
+      page.name.should eq nil
+      page.tags.should eq []
+      page.likes.should eq({ lifetime: { total: 0 } })
+      page.posts.should eq []
+
+      Page.collection.find.first.keys.sort.should eq ['_id']
+    end
+
+    it 'should recursiverly detect if hash has values' do
+      page = Page.create! likes: { lifetime: { user555: 42 } }
+
+      page.name.should eq nil
+      page.tags.should eq []
+      page.likes.should eq({ lifetime: { user555: 42 } })
+      page.posts.should eq []
+
+      page = Page.collection.find.first
+      page.keys.sort.should eq ['_id', 'likes']
+      page['likes'].should eq({ 'lifetime' => { 'user555' => 42 } })
+    end
+
+    it 'should recursiverly strtip blank values from hash and save the rest' do
+      page = Page.create! likes: { lifetime: { user555: 42, user777: 0 } }
+
+      page.likes.should eq({ lifetime: { user555: 42 } })
+
+      Page.collection.find.first['likes'].should eq({ 'lifetime' => { 'user555' => 42 } })
+    end
+
+    it 'should not strip empty values from embedded document when save is called on it' do
+      page = Page.new
+      post = page.posts.build
+      page.save!
+
+      post.message.should eq ''
+      post.likes.should eq 0
+
+      posts = Page.collection.find.first['posts']
+      posts.count.should eq 1
+
+      post = posts.first
+      post.keys.sort.should eq ['_id', 'likes', 'message']
+      post['message'].should eq ''
+      post['likes'].should eq 0
+    end
+
+    it 'should strip empty values from embedded document when save is called on it' do
+      page = Page.create!
+      post = page.posts.build
+      post.save!
+
+      post.message.should eq ''
+      post.likes.should eq 0
+
+      posts = Page.collection.find.first['posts']
+      posts.count.should eq 1
+      posts.first.keys.should eq ['_id']
+    end
+
+    it 'should save embedded document fields' do
+      page = Page.create!
+      post = page.posts.build message: 'Message of the post!', likes: 2
+      post.save!
+
+      post.message.should eq 'Message of the post!'
+      post.likes.should eq 2
+
+      posts = Page.collection.find.first['posts']
+      posts.count.should eq 1
+
+      post = posts.first
+      post.keys.sort.should eq ['_id', 'likes', 'message']
+      post['message'].should eq 'Message of the post!'
+      post['likes'].should eq 2
+    end
+  end
+
+  describe 'stored post' do
+    before do
+      @page = Page.new({
+        name: 'Page name',
+        tags: ['A', 'B', 'C']
+      })
+      @page.posts.build({ message: 'Post1'})
+      @page.save!
+    end
+
+    it 'should be fetched properly' do
+      page = Page.first
+      page.name.should eq 'Page name'
+      page.tags.should eq ['A', 'B', 'C']
+      page.likes.should eq({ lifetime: { total: 0 } })
+      page.posts.count.should eq 1
+
+      post = page.posts.first
+      post.message.should eq 'Post1'
+      post.likes.should eq 0
+    end
+
+    it 'should look in DB correctly' do
+      page = Page.collection.find.first
+
+      page.keys.sort.should eq ['_id', 'name', 'posts', 'tags']
+      page['name'].should eq 'Page name'
+      page['tags'].should eq ['A', 'B', 'C']
+      page['posts'].count.should eq 1
+
+      post = page['posts'].first
+
+      post.keys.sort.should eq ['_id', 'likes', 'message']
+      post['message'].should eq 'Post1'
+      post['likes'].should eq 0
+    end
+
+    context 'on update' do
+      it 'should set present value to blank' do
+        page = Page.first
+        page.name = ''
+        page.save!      
+
+        page.name.should eq ''
+
+        page = Page.collection.find.first
+        page.keys.should include 'name'
+        page['name'].should eq ''
+      end
+
+      it 'should not set nil value to default empty value' do
+        page = Page.first
+        page.name = 'Page name 2'
+        page.save!      
+
+        page.likes.should eq({ lifetime: { total: 0 } })
+
+        page = Page.collection.find.first
+        page.keys.should_not include 'likes'
+      end
+
+      it 'should allow to set a value to a blank' do
+        page = Page.first
+        page.tags = []
+        page.save!
+
+        page.tags.should eq []
+
+        page = Page.collection.find.first
+        page['tags'].should eq([])
+      end
+
+      it 'should not set empty value to another empty value' do
+        page = Page.first
+        page.likes = { three_months: { total: 0} }
+        page.save!
+
+        page.likes.should eq({ lifetime: { total: 0 } })
+
+        page = Page.collection.find.first
+        page.keys.should_not include 'likes'
+      end
+
+      it 'should not set empty value to another empty value in the second level hash' do
+        page = Page.first
+        page.likes[:lifetime] = { by_user: 0 }
+        page.save!
+
+        page.likes.should eq({ lifetime: { total: 0 } })
+
+        page = Page.collection.find.first
+        page.keys.should_not include 'likes'
+      end
+
+      it 'should update an empty value to another' do
+        page = Page.first
+        page.likes[:lifetime] = { user777: 77 }
+        page.save!
+
+        page.likes.should eq({ lifetime: { user777: 77 } })
+
+        page = Page.collection.find.first
+        page.keys.should include 'likes'
+      end
+
+      it 'should update an empty value to another and stript empties in higher level hashes' do
+        page = Page.first
+        page.likes[:lifetime] = { user777: 77, user555: 0 }
+        page.save!
+
+        page.likes.should eq({ lifetime: { user777: 77 } })
+
+        page = Page.collection.find.first
+        page.keys.should include 'likes'
+      end
+
+      it 'should update an empty value to another and stript empties in higher level hashes' do
+        page = Page.first
+        page.likes[:lifetime] = { user777: 77, user555: 0, total: { by_user: [] } }
+        page.save!
+
+        page.likes.should eq({ lifetime: { user777: 77 } })
+
+        page = Page.collection.find.first
+        page.keys.should include 'likes'
+      end
+
+      context 'after update' do
+        before do
+          page = Page.first
+          page.likes[:lifetime] = { user777: 77, user555: 0, total: { by_user: [] } }
+          page.save!
+        end
+
+        it 'should be able to add another key to the hash' do
+          page = Page.first
+          page.likes[:totals] = 55
+          page.save!
+
+          page = Page.first
+          page.likes['totals'].should eq 55
+          page.likes['lifetime'].should eq({ 'user777' => 77 })
+        end
+
+        it 'should be able to add another key to the second level hash' do
+          page = Page.first
+          page.likes['lifetime']['user555'] = 55
+          page.save!
+
+          page = Page.first
+          page.likes['lifetime']['user555'].should eq 55
+          page.likes['lifetime']['user777'].should eq 77
+        end
+
+        it 'should be able to make existing key inside a hash to empty value' do
+          page = Page.first
+          page.likes['lifetime']['user777'] = 0
+          page.save!
+
+          page = Page.first
+          page.likes['lifetime'].should be_blank
+        end
+
+        it 'should be able to make existing key inside a hash to empty value and set another value' do
+          page = Page.first
+          page.likes['lifetime']['user555'] = 55
+          page.likes['lifetime']['user777'] = 0
+          page.save!
+
+          page = Page.first
+          page.likes['lifetime'].should eq({ 'user555' => 55 })
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'mongo_utils'
+
+Mongoid::Config.send :load_configuration, { sessions: { default: { hosts: ['localhost:27017'] , database: 'mongo_utils_tests' } } }
+
+require './spec/fixtures/page'
+require './spec/fixtures/post'
+
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:suite) do
+    DatabaseCleaner.orm      = :mongoid
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ruby_mongo_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nikita Cernovs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Mongo Utilities
+email:
+- n.cernovs@77agency.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongo_utils.rb
+- lib/mongo_utils/mongo_dump.rb
+- lib/mongo_utils/mongo_restore.rb
+- lib/mongo_utils/stripable.rb
+- lib/mongo_utils/version.rb
+- mongo_utils.gemspec
+- mongodumps/mongo_utils_tests/pages.bson
+- mongodumps/mongo_utils_tests/pages.metadata.json
+- spec/fixtures/page.rb
+- spec/fixtures/post.rb
+- spec/mongo_utils/mongo_restore_spec.rb
+- spec/mongo_utils/stripable_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Ruby Mongo Utilities
+test_files:
+- spec/fixtures/page.rb
+- spec/fixtures/post.rb
+- spec/mongo_utils/mongo_restore_spec.rb
+- spec/mongo_utils/stripable_spec.rb
+- spec/spec_helper.rb