mongoid-collection-separatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8cb98452f75ab68a4ffe0ac3998ca81b78af4daa8dc586251e764b9baa2575a
+  data.tar.gz: 0f7934c424fd0a6f9a517c19ae4608fb6cc3874e7cd17ca46ab50ca10e4b42ac
+SHA512:
+  metadata.gz: 23d2e72379ddf98d8a9545ae644a61657fed118178f26dc98f9bee2762d08d06d082a11e40873d02014d1764f8727314bf48836998ea458c7cfb984418f6caff
+  data.tar.gz: 4ace2b88c02563c469ad57b3fe807a3c4c613f0ece20d2a588c01692646f343f2300693ba8cdd1d82014645bc5f92af959fe09b2b715d25b8efa592ceae2b508

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+tags
+.byebug_history
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mongoid_collection_separatable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    mongoid-collection-separatable (0.1.0)
+      mongoid (~> 6.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    bson (4.3.0)
+    byebug (10.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    mongo (2.6.2)
+      bson (>= 4.3.0, < 5.0.0)
+    mongoid (6.4.2)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  mongoid-collection-separatable!
+  pry-byebug (~> 3.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Oscar Jiang
+
+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,40 @@
+# MongoidCollectionSeparatable
+
+Support mongoid collections to be saved into and queried from separated collections with condition
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_collection_separatable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_collection_separatable
+
+## Usage
+Add the following line into the model class that you want to split:
+```ruby
+  separated_by :form_id, parent_class: 'Form', on_condition: :entries_separated
+```
+
+When `on_condition` field in `parent_class` is set to true, current records referenced to `separated_by` field will be saved into separated collections. Default collections name will be `#{current_collection}_#{form_id_value}` 
+
+Migration task to separate collections:
+```bash
+rake db:mongoid:collection:separate[origin_class,condition_key,condition_value]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mongoid_collection_separatable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid-collection-separatable.rb

@@ -0,0 +1,2 @@
+require "mongoid/collection_separatable"
+

data/lib/mongoid/collection_separatable.rb

@@ -0,0 +1,52 @@
+require 'mongoid'
+require 'mongoid/collection_separatable/monkey_patches'
+require 'mongoid/collection_separatable/tasks/separate'
+require 'active_support'
+require 'mongoid/collection_separatable/version'
+require 'mongoid/collection_separatable/railtie' if defined?(Rails)
+
+
+module Mongoid
+  module CollectionSeparatable
+    extend ActiveSupport::Concern
+
+    included do
+      action_method_module = [Mongoid::Persistable.constants.map {|c| Mongoid::Persistable.const_get(c)} + [Mongoid::Reloadable]].flatten.select {|c| c.is_a?(Module)}
+      action_method_module.each {|action_module| alias_method_with_collection action_module}
+    end
+
+    class_methods do
+      attr_accessor :separated_field, :separated_condition_field, :separated_parent_class, :separated_parent_field, :separated_collection_prefix
+
+      def separated_by separated_field, opts={}
+        @separated_parent_class = opts[:parent_class].constantize
+        @separated_parent_field = opts[:parent_field] || :id
+        @separated_collection_prefix = opts[:prefix].to_s.presence || self.to_s.downcase.pluralize + '_'
+        @separated_condition_field = opts[:on_condition]
+        @separated_field = separated_field
+        unless @separated_parent_class.fields.key?(@separated_condition_field)
+          @separated_parent_class.class_eval <<-END
+            field :#{@separated_condition_field}, type: Boolean
+          END
+        end
+      end
+
+      def alias_method_with_collection action_module
+        action_module.instance_methods(false).each do |action_method|
+          define_method "#{action_method}_with_context" do |*args|
+            klass = self.class
+            self.send "#{action_method}_without_context", *args unless klass.respond_to?(:separated_field)
+
+            collection_name = klass.where(klass.separated_field => self.send(klass.separated_field)).ensured_collection.name
+            self.with(collection: collection_name) {self.send "#{action_method}_without_context", *args}
+          end
+
+          alias_method "#{action_method}_without_context".to_sym, action_method
+          alias_method action_method.to_sym, "#{action_method}_with_context".to_sym
+        end
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/collection_separatable/monkey_patches.rb

@@ -0,0 +1,126 @@
+module Mongoid
+  module Contextual
+    private
+
+    # Changes:
+    # 1. Get form_id from selector
+    # 2. If collection is entries, not matter from context or current collection object, and form has entries_separated flag set, set collection  name instance variable to entries plus form_id as new collection name
+    # 3. It's not good because it will query form to check entries_separated flag exists or not each time. Hope to find a better way later
+
+    def create_context_with_separated_entries
+      context = create_context_without_separated_entries
+      query_class = instance_variable_get :@klass
+      if should_query_from_separated_collection? query_class
+        new_collection_name = query_class.separated_collection_prefix + separated_value(query_class)
+        # self.selector.except!('form_id')
+        # filter = context.instance_variable_get(:@view).filter.except('form_id')
+        # context.instance_variable_get(:@view).instance_variable_set :@filter, filter
+        context.collection.instance_variable_set :@name, new_collection_name
+        collection.instance_variable_set :@name, new_collection_name
+      end
+      instance_variable_set :@context, context
+      context
+    end
+
+    def should_query_from_separated_collection? query_class
+      return if !query_class.respond_to?(:separated_field) || !query_class.send(:separated_field)
+      query_class.separated_parent_class.where(query_class.separated_parent_field => separated_value(query_class), query_class.separated_condition_field => true).exists?
+    end
+
+    def separated_value query_class
+      value = separated_selector(query_class)
+      value = separated_value_from_query_in_with_only_one_value(query_class) if value.is_a?(Hash)
+      value
+    end
+
+    def separated_value_from_query_in_with_only_one_value query_class
+      separated_selector(query_class)['$in']&.first
+    end
+
+    def separated_selector query_class
+      selector[query_class.separated_field.to_s]
+    end
+
+    alias_method :create_context_without_separated_entries, :create_context
+    alias_method :create_context, :create_context_with_separated_entries
+  end
+end
+
+module Mongoid
+  module Relations
+    module Referenced
+      class Many < Relations::Many
+        private
+
+        # Changes:
+        # 1. 'base' should be an instance of Form
+        # 2. If form has entries_separated flat and collection name is entries, clone a new context because it is build each time when called and set to context. Then remove form_id from selector because all the entries inside the new collection has the same form_id
+
+        def criteria_with_separated_entries
+          cri = criteria_without_separated_entries
+          query_class = cri.instance_variable_get :@klass
+          if should_query_from_separated_collection? query_class
+            context = cri.context.clone
+            context.collection.instance_variable_set :@name, "#{query_class.separated_collection_prefix}#{base.id}"
+            cri.instance_variable_set :'@collection', @collection
+            # cri.selector.except!('form_id')
+          end
+          cri
+        end
+
+        def should_query_from_separated_collection?(query_class)
+          query_class.respond_to?(:separated_field) && query_class.send(:separated_field) && base.is_a?(query_class.separated_parent_class) && base.send(query_class.separated_condition_field)
+        end
+
+        alias_method :criteria_without_separated_entries, :criteria
+        alias_method :criteria, :criteria_with_separated_entries
+      end
+    end
+  end
+end
+
+module Mongoid
+  # The +Criteria+ class is the core object needed in Mongoid to retrieve
+  # objects from the database. It is a DSL that essentially sets up the
+  # selector and options arguments that get passed on to a Mongo::Collection
+  # in the Ruby driver. Each method on the +Criteria+ returns self to they
+  # can be chained in order to create a readable criterion to be executed
+  # against the database.
+  class Criteria
+    def ensured_collection
+      context.collection
+    end
+  end
+end
+
+module Mongoid
+  module Clients
+    module Options
+      def collection_with_separated(parent = nil)
+        klass = self.class
+        origin_collection = collection_without_separated(parent)
+        return origin_collection unless self.class.respond_to?(:separated_field)
+        origin_collection.instance_variable_set :@name, separated_collection_name(klass)
+        origin_collection
+      end
+
+      alias_method :collection_without_separated, :collection
+      alias_method :collection, :collection_with_separated
+
+      def collection_name_with_separated
+        klass = self.class
+        origin_collection_name = collection_name_without_separated
+        return origin_collection_name unless self.class.respond_to?(:separated_field)
+        separated_collection_name klass
+      end
+
+      alias_method :collection_name_without_separated, :collection_name
+      alias_method :collection_name, :collection_name_with_separated
+
+      def separated_collection_name(klass)
+        klass.where(klass.separated_field => self.send(klass.separated_field)).ensured_collection.name
+      end
+    end
+  end
+end
+

data/lib/mongoid/collection_separatable/railtie.rb

@@ -0,0 +1,9 @@
+module Mongoid
+  module CollectionSeparatable
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load 'mongoid/collection_separatable/tasks/separate.rake'
+      end
+    end
+  end
+end

data/lib/mongoid/collection_separatable/tasks/separate.rake

@@ -0,0 +1,10 @@
+namespace :db do
+  namespace :mongoid do
+    namespace :collection do
+      desc 'Separate records from one collection into another given a condition and new collection name. e.g. rake db:mongoid:collection:separate[Entry,form_id,5bf626b5c2a6f78321dafc50]'
+      task :separate, [:origin_class, :condition_key, :condition_value] => :environment do |_t, args|
+        Mongoid::CollectionSeparatable::Tasks::Separate.new(args).run
+      end
+    end
+  end
+end

data/lib/mongoid/collection_separatable/tasks/separate.rb

@@ -0,0 +1,25 @@
+module Mongoid
+  module CollectionSeparatable
+    module Tasks
+      class Separate
+        attr_accessor :origin_class, :condition_key, :condition_value
+
+        def initialize opts={}
+          @origin_class = opts[:origin_class].constantize
+          @condition_key = opts[:condition_key]
+          @condition_value = opts[:condition_value] = BSON::ObjectId.legal?(opts[:condition_value]) ? BSON::ObjectId.from_string(opts[:condition_value]) : opts[:condition_value]
+        end
+
+        def run
+          target_collection = "#{origin_class.collection_name}_#{condition_value}"
+
+          origin_class.collection.aggregate([
+                                              {'$match': {condition_key => condition_value}},
+                                              {'$out': target_collection}
+                                            ]).first
+
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/collection_separatable/version.rb

@@ -0,0 +1,6 @@
+module Mongoid 
+  module CollectionSeparatable
+    VERSION = "0.1.0"
+  end
+end
+

data/lib/mongoid_collection_separatable.rb

@@ -0,0 +1,2 @@
+require "mongoid/collection_separatable"
+

data/mongoid_collection_separatable.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongoid/collection_separatable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-collection-separatable"
+  spec.version       = Mongoid::CollectionSeparatable::VERSION
+  spec.authors       = ["Oscar Jiang"]
+  spec.email         = ["pengj0520@gmail.com"]
+
+  spec.summary       = %q{Save the mongoid model into different collections by condition}
+  spec.description   = %q{Mongoid models are saved in one collection by default. However, when collections after too large , it could be extracted into a separated one and query form that, to make it query faster}
+  spec.homepage      = "https://github.com/warmwind/mongoid_collection_separatable"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mongoid', ' ~> 6.4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-collection-separatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oscar Jiang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Mongoid models are saved in one collection by default. However, when
+  collections after too large , it could be extracted into a separated one and query
+  form that, to make it query faster
+email:
+- pengj0520@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-collection-separatable.rb
+- lib/mongoid/collection_separatable.rb
+- lib/mongoid/collection_separatable/monkey_patches.rb
+- lib/mongoid/collection_separatable/railtie.rb
+- lib/mongoid/collection_separatable/tasks/separate.rake
+- lib/mongoid/collection_separatable/tasks/separate.rb
+- lib/mongoid/collection_separatable/version.rb
+- lib/mongoid_collection_separatable.rb
+- mongoid_collection_separatable.gemspec
+homepage: https://github.com/warmwind/mongoid_collection_separatable
+licenses:
+- MIT
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Save the mongoid model into different collections by condition
+test_files: []