mongoid_schema_dump 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 005aae594a16407adeddafc34cabefce3a262366
+  data.tar.gz: 9b70d0fa0b87c436a1f3e7c239c90c8d4eb0340f
+SHA512:
+  metadata.gz: 82ce1e21d99c4f23089bbf7fe93f0817dd0becd374c93446778f90ac2e291eda5e8e8848b682b5affd8124cb5a456a66d99bb9004b2ba5feb4aa620c1e3d0e3d
+  data.tar.gz: a1ee07445eb9c7480cdb4cbcf8b44e84d298a0af0b67444de52c9d9978a0fe3eb6cd3a94f0c890893541e42b5b6f4c4df15b2a1c844140e8db2c5f02e6229c9c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Applidget SAS
+
+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,41 @@
+# Mongoid Schema Dump
+
+This gem allows you to dump your Mongoid schema based on a top level object. If you have an `Organization` model or equivalent, this tool can help you get the shortest path (by following `belongs_to` relationships) from any other object from your data model to your `Organization` model. 
+
+You can then use the output of this gem in combination with https://github.com/applidget/mongo-partial-dump, a MongoDB extractor reading from a database a writing to another one based on the filters you define with this gem. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_schema_dump'
+```
+Then run `bundle install`
+
+Or install it yourself as:
+
+    $ gem install mongoid_schema_dump
+
+## Usage in Rails
+
+You can install a rake task in your app allowing you to dump your schema. This rake task will have to be customized in order to take into account what is specific about your data model, in particular the reference class, which is Organization in the default generated rake task :
+
+    $ bundle exec rails generate mongoid_schema_dump:task
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/applidget/mongoid_schema_dump. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid_schema_dump"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongoid_schema_dump.rb

@@ -0,0 +1,121 @@
+require "mongoid_schema_dump/version"
+
+module MongoidSchemaDump
+  require 'mongoid_schema_dump/engine' if defined?(Rails)
+  module_function
+  
+  #Computes all paths to reference class
+  def paths_to_klass(klass, reference_klass)
+    displayed_for_klass = false
+    paths = []
+    to_visit = [[klass, []]]
+    current_klass = klass
+    
+    loop do
+      current_klass, path = to_visit.pop #FIFO
+      break unless current_klass  
+      path << current_klass
+    
+      if current_klass.to_s == reference_klass 
+        paths << path
+        next
+      end
+      break if current_klass.nil?
+      next_klasses = all_belongs_to(current_klass)
+      next_klasses.each do |next_klass|
+        next if next_klass == current_klass.to_s
+        to_visit << [next_klass.constantize, path.clone]
+      end
+      break if to_visit.empty?
+    end
+    return paths 
+  end
+  
+  #returns all has_many relation class names
+  def has_many(from_klass, to_klass)
+    all_has_many = from_klass.relations.map(&:second).select do |r| 
+      r.macro == :has_many && r.class_name == to_klass.to_s
+    end.map(&:class_name)
+  end
+  
+  #returns all belongs_to class names 
+  def all_belongs_to(from_klass)
+    monomorphic_relations = from_klass.relations.map(&:second).select do |r| 
+      r.macro == :belongs_to && !r[:polymorphic]
+    end.map do |relation|
+      relation.class_name
+    end
+    
+    polymorphic_relations = from_klass.relations.map(&:second).reduce([]) do |memo, r| 
+      if r.macro == :belongs_to && r[:polymorphic] == true
+        models.each do |model_klass_name|
+          next unless has_many(model_klass_name.constantize, from_klass).any?
+          next if monomorphic_relations.include? model_klass_name
+          memo << model_klass_name 
+        end
+      end
+      memo
+    end
+    monomorphic_relations + polymorphic_relations
+  end
+  
+  def models
+    Mongoid.models.map &:to_s
+  end
+  
+  def shortest_array(arrays)
+    result = arrays.reduce({path: [], size: 1000000}) do |memo, current|
+      new_size = [current.count, memo[:size]].min
+      memo = {path: current, size: new_size} if new_size < memo[:size]
+      memo
+    end
+    result[:path]
+  end
+  
+  def export_options(klass_name, ref)
+    path = shortest_array(paths_to_klass(klass_name.constantize, ref))
+    return {} if path.count <= 1
+    dependency_klass = path.second
+    
+    #1. Standard belongs_to
+    relation = klass_name.constantize.relations.map(&:second).select do |r| 
+      r.macro == :belongs_to && !r[:polymorphic] && r.class_name == dependency_klass.to_s
+    end.first
+    if relation.present?
+      return {
+        "collection" => klass_name.constantize.collection.name,
+        "dependency" => dependency_klass.collection.name,
+        "foreign_key" => relation.key
+      }
+    end
+    
+    #2. Handle polymorphic relations 
+    hm_names = dependency_klass.relations.map(&:second).select do |r| 
+      r.macro == :has_many && r.class_name == klass_name
+    end.map(&:as)
+    
+    relation = klass_name.constantize.relations.map(&:second).select do |r| 
+      r.macro == :belongs_to && r[:polymorphic] == true && hm_names.include?(r.name)
+    end.first
+    return nil if relation.blank?
+    
+    return {
+      "collection" => klass_name.constantize.collection.name,
+      "dependency" => dependency_klass.collection.name,
+      "foreign_key" => relation.key,
+      "filters" => {
+        "#{relation.name}_type" => dependency_klass.to_s
+      }
+    }
+  end
+  
+  def dump(reference_klass_name)
+    #path_to_reference_klass(model_name.constantize, "Guest")  
+    schema = []
+    models.each do |model_name|    
+      res = export_options(model_name, reference_klass_name)
+      schema << res if res.present?
+    end
+    return schema
+  end
+end

data/lib/mongoid_schema_dump/engine.rb

@@ -0,0 +1,5 @@
+require 'rails'
+module MongoidSchemaDump
+  class Engine < Rails::Engine
+  end
+end

data/lib/mongoid_schema_dump/version.rb

@@ -0,0 +1,3 @@
+module MongoidSchemaDump
+  VERSION = "0.0.1"
+end

data/lib/rails/generators/mongoid_schema_dump/task_generator.rb

@@ -0,0 +1,16 @@
+module MongoidSchemaDump
+  module Generators
+    class TaskGenerator < Rails::Generators::Base
+      desc "Creates a Rake task that you can customize for your own schema"
+
+      def self.source_root
+        @_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_rake_task
+        template 'mongoid_schema_dump.rake', File.join('lib', "tasks", "mongoid_schema_dump.rake")
+      end
+
+    end
+  end
+end

data/lib/rails/generators/mongoid_schema_dump/templates/mongoid_schema_dump.rake

@@ -0,0 +1,10 @@
+require "mongoid_schema_dump"
+namespace :mongoid do
+  task :schema_dump => :environment do
+    #This is used to make sure all your models are loaded 
+    Rails.application.eager_load!
+    
+    #Customize your base class here )
+    MongoidSchemaDump.dump("Organization")
+  end
+end

data/mongoid_schema_dump.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_schema_dump/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_schema_dump"
+  spec.version       = MongoidSchemaDump::VERSION
+  spec.authors       = ["rpechayr"]
+  spec.email         = ["romain.pechayre@applidget.com"]
+
+  spec.summary       = %q{Extract your Mongoid schema based on a top level class}
+  spec.description   = %q{Extract your Mongoid schema based on a top level class}
+  spec.homepage      = "https://github.com/applidget/mongoid_schema_dump"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mongoid", "~> 5"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_schema_dump
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- rpechayr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extract your Mongoid schema based on a top level class
+email:
+- romain.pechayre@applidget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid_schema_dump.rb
+- lib/mongoid_schema_dump/engine.rb
+- lib/mongoid_schema_dump/version.rb
+- lib/rails/generators/mongoid_schema_dump/task_generator.rb
+- lib/rails/generators/mongoid_schema_dump/templates/mongoid_schema_dump.rake
+- mongoid_schema_dump.gemspec
+homepage: https://github.com/applidget/mongoid_schema_dump
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Extract your Mongoid schema based on a top level class
+test_files: []