separatum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b772e3f0272e01367a9e4e8ab1be143964046207677841d6b0532262d6e8a7c1
+  data.tar.gz: 824578f149e375bbc57bb28cf6b44155610a53c7448c5e27b4e09646d625b951
+SHA512:
+  metadata.gz: 92051fcf37e11b151718a21281a95cc23a6cda366a4891623182ba2f3e183e720ebff0758d48960169ff74c0a2e682c1381d581a49f7c3a5561deaa7a2d32325
+  data.tar.gz: 457a164b48dcf7b0b6f30bb5d29e55e24784b7257f2d3d448f611f59a2ce16674f84481bda7d93d4e6d4baadeb3a790a7802937e880fd8af7a4bf6e6afdf1ba4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-*
+/.idea
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+

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.4.5
+before_install: gem install bundler -v 1.17.3

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 separatum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 kraaaken
+
+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,101 @@
+# (WIP) Separatum
+
+Extract and transfer linked objects from one database into another.
+
+## How you can use it
+
+- Making seeds.rb as copy of production data for testing purposes.
+- Making separate database for AB-testing (performance or marketing purposes)
+- Checking your data logical structure (it will raise on broken or unexisting links)
+
+## UUID
+
+It is better if you are using UUID primary key in every table you want to extract.
+This will allow you to avoid problems (with primary keys and sequences) during importing objects into a new database.
+Also `UuidChanger` can help you avoid collisions in case of importing same objects more than one time in the same database.
+
+## Examples
+
+```bash
+gem install separatum
+```
+
+```ruby
+require 'separatum'
+```
+
+### Extract and export
+
+Build new exporter
+
+```ruby
+exporter = Separatum.build do
+  use Separatum::Importers::ActiveRecord  # We are going to crawl ActiveRecord objects
+  use Separatum::Converters::Object2Hash  # Most of the modules in Separatum is working with Hash-form of objects
+  use Separatum::Processors::UuidChanger  # Hide production's UUIDs with no broken links 
+  use Separatum::Exporters::JsonFile, file_name: 'separate.json' # Export object to json file                                      
+end
+```
+
+Define start object and extract all linked records into `separate.json` file
+
+```ruby
+start_object = User.find('any_uuid_from_your_table')
+exporter.(start_object)
+```
+
+### Import into new database
+
+Build new importer
+
+```ruby
+importer = Separatum.build do
+  use Separatum::Importers::JsonFile, file_name: 'separate.json' # We are going to import hashed objects from separate.json
+  use Separatum::Converters::Hash2Object # Convert back to real objects (not persisted)
+  use Separatum::Exporters::ActiveRecord # Save them (in one transaction for all objects in set)
+end
+```
+
+Import records to a database from `separate.json` file
+
+```ruby
+importer.() # It returns set of persisted objects
+```
+
+### Extract and generate ruby code
+
+```ruby
+seeds_generator = Separatum.build do
+  use Separatum::Importers::ActiveRecord
+  use Separatum::Converters::Object2Hash
+  use Separatum::Processors::UuidChanger
+  use Separatum::Converters::Hash2Object
+  use Separatum::Exporters::ActiveRecordCode
+end
+
+```
+
+Return generated ruby code for creating objects in a database
+
+```ruby
+start_object = User.find('any_uuid_you_want_to_start_from')
+puts seeds_generator.(start_object)
+```
+
+## TODO
+
+- Data obfuscation (respecting to private data)
+
+## 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/a0s/separatum.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "separatum"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/separatum.rb

@@ -0,0 +1,35 @@
+require "separatum/version"
+
+Dir[File.expand_path(File.join(__FILE__, %w(.. ** *.rb)))].each(&method(:require))
+
+module Separatum
+  def self.build(&block)
+    instance = Class.new.include(StackMethods).new
+    stack = instance.instance_eval(&block)
+    Stack.new(stack: stack)
+  end
+
+  module StackMethods
+    def use(klass, *params)
+      fail unless klass.is_a?(Class)
+      (@stack ||= []) << [klass, *params]
+    end
+  end
+
+  class Stack
+    def initialize(stack:)
+      @stack = stack
+    end
+
+    def call(*options)
+      current_options = options
+      current_result = nil
+      @stack.each do |el|
+        klass, *params = el
+        instance = klass.new(*params)
+        current_result = instance.(*(current_result || current_options))
+      end
+      current_result
+    end
+  end
+end

data/lib/separatum/converters/hash2_object.rb

@@ -0,0 +1,17 @@
+module Separatum
+  module Converters
+    class Hash2Object
+      def call(*hashes)
+        hashes.map do |hash|
+          hash_copy = hash.symbolize_keys
+          _klass = hash_copy.delete(:_klass).constantize
+          instance = _klass.new
+          hash_copy.symbolize_keys.each do |k, v|
+            instance.send("#{k}=", v)
+          end
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/separatum/converters/object2_hash.rb

@@ -0,0 +1,20 @@
+module Separatum
+  module Converters
+    class Object2Hash
+      def call(*objects)
+        objects.map do |object|
+          klass = object.class.respond_to?(:name) ? object.class.name : object.class.to_s
+          if object.respond_to?(:as_json)
+            { _klass: klass }.merge(object.as_json)
+          elsif object.respond_to?(:to_hash)
+            { _klass: klass }.merge(object.to_hash)
+          elsif object.respond_to?(:to_h)
+            { _klass: klass }.merge(object.to_h)
+          else
+            fail(object.inspect)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/separatum/exporters/active_record.rb

@@ -0,0 +1,16 @@
+module Separatum
+  module Exporters
+    class ActiveRecord
+      def call(*objects)
+        ::ActiveRecord::Base.transaction do
+          objects.each do |o|
+            o.class.connection.execute("ALTER TABLE %s DISABLE TRIGGER ALL;" % [o.class.table_name])
+            o.save!(validate: false)
+            o.class.connection.execute("ALTER TABLE %s ENABLE TRIGGER ALL;" % [o.class.table_name])
+          end
+        end
+        objects.map(&:reload)
+      end
+    end
+  end
+end

data/lib/separatum/exporters/active_record_code.rb

@@ -0,0 +1,27 @@
+module Separatum
+  module Exporters
+    class ActiveRecordCode
+      T_TRANSACTION = File.expand_path(File.join(__FILE__, %w(.. active_record_code transaction.rb.erb)))
+      T_OBJECT = File.expand_path(File.join(__FILE__, %w(.. active_record_code object.rb.erb)))
+      T_ATTRIBUTE = File.expand_path(File.join(__FILE__, %w(.. active_record_code attribute.rb.erb)))
+
+      attr_reader :objects_str, :attributes_str, :key_str, :value_str
+
+      def call(*objects)
+        @objects_str = objects.map do |object|
+          @attributes_str = object.attributes.map do |key, value|
+            @key_str = key
+            if value.is_a?(ActiveSupport::TimeWithZone)
+              @value_str = "\"#{value}\""
+            else
+              @value_str = value.inspect
+            end
+            ERB.new(File.read(T_ATTRIBUTE)).result(binding).strip
+          end
+          ERB.new(File.read(T_OBJECT)).result(binding).strip
+        end
+        ERB.new(File.read(T_TRANSACTION)).result(binding).strip
+      end
+    end
+  end
+end

data/lib/separatum/exporters/active_record_code/attribute.rb.erb

@@ -0,0 +1 @@
+<%= key_str %>: <%= value_str %>

data/lib/separatum/exporters/active_record_code/object.rb.erb

@@ -0,0 +1,3 @@
+<%= object.class %>.connection.execute("ALTER TABLE <%= object.class.table_name %> DISABLE TRIGGER ALL;")
+<%= object.class %>.new(<%= attributes_str.join(', ') %>).save!(validate: false)
+<%= object.class %>.connection.execute("ALTER TABLE <%= object.class.table_name %> ENABLE TRIGGER ALL;")

data/lib/separatum/exporters/active_record_code/transaction.rb.erb

@@ -0,0 +1,3 @@
+::ActiveRecord::Base.transaction do
+<%= objects_str.join("\n") %>
+end

data/lib/separatum/exporters/json_file.rb

@@ -0,0 +1,16 @@
+module Separatum
+  module Exporters
+    class JsonFile
+      def initialize(file_name:, pretty_print: false)
+        @file_name = file_name
+        @pretty_print = pretty_print
+      end
+
+      def call(*array)
+        str = @pretty_print ? JSON.pretty_generate(array) : JSON.dump(array)
+        File.write(@file_name, str)
+        array
+      end
+    end
+  end
+end

data/lib/separatum/importers/active_record.rb

@@ -0,0 +1,86 @@
+require 'set'
+
+module Separatum
+  module Importers
+    class ActiveRecord
+      attr_reader :klass_transitions, :object_transitions
+
+      def initialize(**params)
+        @max_depth = params[:max_depth] || 2
+        @skip_through = params[:skip_through] || true
+        @skip_nil = params[:skip_nil] || true
+
+        @skip_klasses = params[:skip_klasses] || []
+        @skip_objects = params[:skip_objects] || []
+        @skip_klass_transitions = params[:skip_klass_transitions] || []
+        @skip_object_transitions = params[:skip_object_transitions] || []
+
+        @klass_transitions = Set[]
+        @object_transitions = Set[]
+        @objects = Set[]
+      end
+
+      def call(object)
+        @objects.add(object)
+        act(object)
+        @objects.to_a
+      end
+
+      def act(object, depth = 1)
+        object.class.reflections.each do |association_name, reflection|
+          if @skip_through && reflection.is_a?(ActiveRecord::Reflection::ThroughReflection)
+            next
+          end
+
+          if @skip_nil && object.send(association_name).nil?
+            next
+          end
+
+          if depth >= @max_depth
+            next
+          end
+
+          case reflection.macro
+          when :belongs_to, :has_one
+            new_object = object.send(association_name)
+            next if @objects.include?(new_object)
+            next if new_object.is_one_of_a?(@skip_klasses)
+
+            next if @object_transitions.include?([new_object, object])
+            next if @skip_objects.include?(new_object)
+            next if @skip_object_transitions.include?([object, new_object])
+            next if @skip_klasses.include?(new_object.class)
+            next if @skip_klass_transitions.include?([object.class, new_object.class])
+
+            @objects.add(new_object)
+            @klass_transitions.add([object.class, new_object.class])
+            @object_transitions.add([object, new_object])
+            act(new_object, depth + 1)
+
+
+          when :has_many
+            new_objects = object.send(association_name)
+            new_objects.each do |new_object|
+              next if @objects.include?(new_object)
+              next if new_object.is_one_of_a?(@skip_klasses)
+
+              next if @object_transitions.include?([new_object, object])
+              next if @skip_objects.include?(new_object)
+              next if @skip_object_transitions.include?([object, new_object])
+              next if @skip_klasses.include?(new_object.class)
+              next if @skip_klass_transitions.include?([object.class, new_object.class])
+
+              @objects.add(new_object)
+              @klass_transitions.add([object.class, new_object.class])
+              @object_transitions.add([object, new_object])
+              act(new_object, depth + 1)
+            end
+
+          else
+            fail
+          end
+        end
+      end
+    end
+  end
+end

data/lib/separatum/importers/json_file.rb

@@ -0,0 +1,14 @@
+module Separatum
+  module Importers
+    class JsonFile
+      def initialize(file_name:)
+        @file_name = file_name
+      end
+
+      def call(*_)
+        str = File.read(@file_name)
+        JSON.parse(str)
+      end
+    end
+  end
+end

data/lib/separatum/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def is_one_of_a?(*types)
+    types.flatten.any? { |t| self.class.to_s == t.to_s }
+  end
+end

data/lib/separatum/processors/inspect.rb

@@ -0,0 +1,10 @@
+module Separatum
+  module Processors
+    class Inspect
+      def call(*array)
+        array.each { |o| puts "#{o.inspect}" }
+        array
+      end
+    end
+  end
+end

data/lib/separatum/processors/uuid_changer.rb

@@ -0,0 +1,30 @@
+require 'securerandom'
+
+module Separatum
+  module Processors
+    class UuidChanger
+      def initialize
+        @uuid_map = {}
+      end
+
+      def call(*hashes)
+        hashes.map(&method(:transform_hash))
+      end
+
+      def transform_hash(h)
+        new_h = {}
+        h.each do |k, v|
+          if v.is_a?(String) && v.is_uuid?
+            unless @uuid_map[v]
+              @uuid_map[v] = SecureRandom.uuid
+            end
+            new_h[k] = @uuid_map[v]
+          else
+            new_h[k] = v
+          end
+        end
+        new_h
+      end
+    end
+  end
+end

data/lib/separatum/string.rb

@@ -0,0 +1,5 @@
+class String
+  def is_uuid?
+    !!self.match(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/)
+  end
+end

data/lib/separatum/version.rb

@@ -0,0 +1,3 @@
+module Separatum
+  VERSION = "0.1.0"
+end

data/separatum.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "separatum/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "separatum"
+  spec.version = Separatum::VERSION
+  spec.authors = ["Anton Osenenko"]
+
+  spec.summary = %q{Extract and transfer linked objects from one database into another.}
+  spec.homepage = "https://github.com/a0s/separatum"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = "https://github.com/a0s/separatum"
+    spec.metadata["source_code_uri"] = "https://github.com/a0s/separatum"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: separatum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Osenenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-16 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/separatum.rb
+- lib/separatum/converters/hash2_object.rb
+- lib/separatum/converters/object2_hash.rb
+- lib/separatum/exporters/active_record.rb
+- lib/separatum/exporters/active_record_code.rb
+- lib/separatum/exporters/active_record_code/attribute.rb.erb
+- lib/separatum/exporters/active_record_code/object.rb.erb
+- lib/separatum/exporters/active_record_code/transaction.rb.erb
+- lib/separatum/exporters/json_file.rb
+- lib/separatum/importers/active_record.rb
+- lib/separatum/importers/json_file.rb
+- lib/separatum/object.rb
+- lib/separatum/processors/inspect.rb
+- lib/separatum/processors/uuid_changer.rb
+- lib/separatum/string.rb
+- lib/separatum/version.rb
+- separatum.gemspec
+homepage: https://github.com/a0s/separatum
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/a0s/separatum
+  source_code_uri: https://github.com/a0s/separatum
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Extract and transfer linked objects from one database into another.
+test_files: []