partial_ks 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b14cf3641f82c08ea9ea16536510c59b950dd0f6
+  data.tar.gz: ee41b04d67e616c72787e953ca341da267b15317
+SHA512:
+  metadata.gz: 5b20e05c16bd828f7c9d0f1797fd95b9a5281f49f251f65cb4353caf176b0ef8891ad9f4aa56225935d2a890d28c223e39c827fa080e85b6713838bf96f177f5
+  data.tar.gz: 0b9d556d6419799d9f05649198fc3b4b40e4658ecd2d08f59ad2a6193af4d27a0d8afbc4b82424cb1e236fbe9b2564bd50cb99a65ded4f8bbd56e2de192fab2c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Powershop New Zealand Limited
+
+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,32 @@
+PartialKs
+  - ConfigurationGenerator
+  - Runner
+    - runs
+    - reports (mostly for debugging)
+
+So how does it work ?
+
+`brew install kitchen-sync`
+
+```
+manual_configuration = []
+config = PartialKs::ConfigurationGenerator.new().call
+PartialKs::Runner.new([config]).run!
+```
+
+You can specify manual configurations if needed.
+
+```
+manual_configuration = [
+  ["users", nil, User.where(:id => [1])],      # specify a subset of users. as users have no parent, specify `nil`
+  ["blog_posts", User]                         # filter blog_posts by User
+]
+```
+
+TODO :
+
+Rename PartialKs::ConfigurationGenerator#call to something better
+What in the world is the tuples in `manual_configuration` meant to be ?
+Minimize Public API
+
+

data/lib/partial_ks/configuration_generator.rb

@@ -0,0 +1,61 @@
+# Given an initial table graph
+# goes through each table not already in the table graph,
+# and attempts to automatically populate the table into the table graph
+class PartialKs::ConfigurationGenerator
+  attr_reader :table_graph, :ignored_table_names
+
+  def initialize(table_graph, ignored_table_names: [])
+    @table_graph = table_graph
+    @ignored_table_names = ignored_table_names
+  end
+
+  def call
+    @auto_constructed_table_graph ||= auto_construct_table_graph
+  end
+
+  protected
+  def all_tables
+    @all_tables ||= (ActiveRecord::Base.connection.tables - ignored_table_names).map {|table_name| PartialKs::Table.new(table_name) }.select(&:model?).index_by(&:table_name)
+  end
+
+  def auto_construct_table_graph
+    synced_tables = {}
+
+    table_graph.each do |table_name, parent_table, table_graph|
+      next unless all_tables[table_name]
+
+      synced_tables[table_name] = [table_name, parent_table, table_graph]
+    end
+
+    all_tables.each do |table_name, table|
+      next if synced_tables[table_name]
+      next unless table.top_level_table?
+
+      synced_tables[table_name] = [table_name, nil]
+    end
+
+    all_tables.each do |table_name, table|
+      next if synced_tables[table_name]
+      next unless table.non_nullable_parent_tables.size == 1
+
+      parent_table_name, _, _ = synced_tables[table.non_nullable_parent_tables.only]
+      parent_table = all_tables[parent_table_name] if parent_table_name
+      next unless parent_table
+
+      synced_tables[table.table_name] = [table_name, parent_table.model]
+    end
+
+    puts "***************"
+    remaining_size = 0
+    all_tables.each do |table_name, table|
+      next if synced_tables[table_name]
+
+      puts "#{table.table_name} - #{table.parent_tables.join(',')}"
+      remaining_size += 1
+    end
+    puts "WARNING: #{remaining_size} tables has no configuration"
+
+    synced_tables.values
+  end
+
+end

data/lib/partial_ks/runner.rb

@@ -0,0 +1,81 @@
+class PartialKs::Runner
+  attr_reader :table_graphs
+
+  def initialize(table_graphs)
+    @table_graphs = table_graphs
+  end
+
+  def run!
+    each_generation do |generation|
+      tables_to_filter = {}
+      table_names = []
+
+      generation.each do |table_name, filter_config, depth|
+        table_names << table_name
+
+        if !filter_config.nil?
+          if filter_config.is_a?(ActiveRecord::Relation) || filter_config.respond_to?(:where_sql)
+            only_filter = filter_config.where_sql.to_s.sub("WHERE", "")
+          elsif filter_config.is_a?(String)
+            only_filter = filter_config
+          else
+            only_filter = "#{filter_config.to_s.foreign_key} IN (#{[0, *filter_config.pluck(:id)].join(',')})"
+          end
+
+          tables_to_filter[table_name] = {"only" => only_filter}
+        end
+      end
+
+      yield tables_to_filter, table_names
+    end
+  end
+
+  def report
+    each_generation.with_index do |generation, depth|
+      generation.each do |table_name, table_graph|
+        print " " * depth
+        puts [table_name, table_graph.try!(:to_s), depth].inspect
+      end
+    end
+  end
+
+  # Yields the following
+  # 1. table name
+  # 2. the foreign key columns used to filter this table, and a lambda that will return the foreign key ids
+  def each_generation
+    return enum_for(:each_generation) unless block_given?
+
+    generations.each do |generation|
+      yield generation
+    end
+  end
+
+  protected
+  def generations
+    return @generations if @generations
+
+    @generations = []
+    table_graphs.each do |table_graph|
+      q = []
+
+      table_graph.each do |table_name, parent_table, configuration_for_table|
+        q << [table_name, configuration_for_table || parent_table] if parent_table.nil?
+      end
+
+      until q.empty?
+        @generations << q
+
+        next_generation = []
+        q.each do |table_name, _|
+          table_graph.each do |child_table_name, parent_table, configuration_for_table|
+            next_generation << [child_table_name, configuration_for_table || parent_table] if parent_table && parent_table.table_name == table_name
+          end
+        end
+
+        q = next_generation
+      end
+    end
+
+    @generations
+  end
+end

data/lib/partial_ks/table.rb

@@ -0,0 +1,47 @@
+module PartialKs
+  class Table
+    attr_reader :table_name
+
+    def initialize(table_name)
+      @table_name = table_name
+    end
+
+    def model
+      @model ||= table_name.classify.constantize
+    rescue NameError
+      nil
+    end
+
+    # sometimes the table is present, but the model is not defined
+    # e.g. in market specific tables
+    def model?
+      model && model.respond_to?(:table_name)
+    end
+
+    def top_level_table?
+      non_nullable_reflections.empty?
+    end
+
+    def non_nullable_parent_tables
+      non_nullable_reflections.map(&:plural_name)
+    end
+
+    def parent_tables
+      belongs_to_reflections.map(&:plural_name)
+    end
+
+    private
+    def belongs_to_reflections
+      @belongs_to_reflections ||= model.reflect_on_all_associations(:belongs_to)
+    end
+
+    def non_nullable_reflections
+      # We have to consider the situation where the column does not exist on
+      # the remote end, which results in a discrepancy between model.columns and the current schema
+      belongs_to_reflections.reject do |reflection|
+        fk_column = model.columns.find{|column| column.name.to_s == reflection.foreign_key.to_s }
+        fk_column.nil? || fk_column.null
+      end
+    end
+  end
+end

data/lib/partial_ks/version.rb

@@ -0,0 +1,3 @@
+module PartialKs
+  VERSION = '0.0.4'
+end

data/lib/partial_ks.rb

@@ -0,0 +1,6 @@
+module PartialKs
+end
+
+require_relative 'partial_ks/runner'
+require_relative 'partial_ks/table'
+require_relative 'partial_ks/configuration_generator'

data/partial_ks.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/partial_ks/version', __FILE__)
+
+spec = Gem::Specification.new do |gem|
+  gem.name         = 'partial_ks'
+  gem.version      = PartialKs::VERSION
+  gem.summary      = "Partial KS"
+  gem.description  = <<-EOF
+A library to use kitchen-sync to sync a subset of your database
+EOF
+  gem.has_rdoc     = false
+  gem.author       = "Thong Kuah"
+  gem.email        = "kuahyeow@gmail.com"
+  gem.homepage     = "https://github.com/powershop/partial_ks"
+  gem.license      = "MIT"
+
+  gem.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files        = `git ls-files`.split("\n")
+  gem.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_path = "lib"
+
+  gem.add_dependency "activerecord"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: partial_ks
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Thong Kuah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A library to use kitchen-sync to sync a subset of your database
+email: kuahyeow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/partial_ks.rb
+- lib/partial_ks/configuration_generator.rb
+- lib/partial_ks/runner.rb
+- lib/partial_ks/table.rb
+- lib/partial_ks/version.rb
+- partial_ks.gemspec
+homepage: https://github.com/powershop/partial_ks
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Partial KS
+test_files: []