partial_ks 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6f2760377220a11179eb98450908820dbfd86ca
-  data.tar.gz: 39e16a10891aad2aea68916f57f4e3b8392d88f2
+SHA256:
+  metadata.gz: fbc1cd0a2fa2a07636eb8343189227655545d592546ae4271f2c7a2525fefd93
+  data.tar.gz: f60d0fd9bcf8a9409e53cb272aa70dcf1f3009aafaa3513e3bf6e82ceae15b61
 SHA512:
-  metadata.gz: a039c6bf09d0a69a55cb4f36676ea3e5f92365a009dd5f688d832cc2d82563bb5cfa0ef0725bc4c0e91cacb0543eaa80662e2f53d016d1706951bd72da2055c2
-  data.tar.gz: 0c9adb839f994ed6f3d350f526d61faa21d5c15054df366527fd29c3f617f5017a5477583b0c70927496faa457bbcb31c4ad84491cf3955fb1ce1ce2bc2cc830
+  metadata.gz: d667eab2216765f872360fb9a11748a2e334192e9f28558bca8b81547843dbe75c57503be7ca03faa23b7ce16d075dbc01ba5832339c9eb099f5de2434f895b9
+  data.tar.gz: 1086325707f98099a5fc815d029e63cf91eba347c9702befe0e69ea05ea9f61fb1c0682c27c37ffb28036d9aa4b3ccdfddb21bc2a889e1c33a20228999845f43

data/CHANGES.md

@@ -1,5 +1,26 @@
 # Changelog
 
+# 0.7.0
+
+* Removed Kitchen Sync specific behaviour - now yields full SQL statements (and no longer kitchen sync specific filter format)
+
+To maintain previous behaviour, use the folllowing code snippet:
+
+```
+PartialKs::Sync.new(manual_configuration).run! do |tables_to_filter, tables|
+  kitchen_sync_filter = {}
+  tables_to_filter.each do |table_name, filter|
+    kitchen_sync_filter[table_name] = { "only" => filter }
+  end
+end
+```
+
+* Rename main class to PartialKs::Sync
+
+* Remove FilteredTable#where_fragment
+
+* Introduces FilteredTable#to_sql
+
 # 0.6.0
 
 Propogate filters down the tree. If the parent downloads the whole table, do the same for the child.

data/CONTRIBUTING.md

@@ -2,7 +2,7 @@ This document should tell all you need to know for contributing to this project.
 
 # Testing
 
-Tested with activerecord 4.2.10, 5.0.6, 5.1.4 (on Ruby 2.3.5)
+Tested with activerecord 4.2.10, 5.0.7, 5.1.6, 5.2.0 (on Ruby 2.3.5)
 
 
 To install and run tests :
@@ -26,4 +26,4 @@ Filters are run on the source DB.
 
 ## Dependencies
 
-KitchenSync -> (ModelList -> Table) -> Runner -> (FilteredTable -> Table)
+Sync -> (ModelList -> Table) -> Runner -> (FilteredTable -> Table)

data/README.md

@@ -1,42 +1,53 @@
 # PartialKs
 
-A library to use kitchen-sync to sync a subset of your database
+A library to sync a subset of your database
 
-# Usage
-
-So how does it work ?
+## Usage
 
+See the following example:
 
 ```
-PartialKs::KitchenSync.new(manual_configuration).run! do |tables_to_filter, tables|
+configuration = [
+  [User, nil, -> { User.where(:id => [1]) }],     # specify a subset of users. as users have no "parent", specify `nil`
+  [BlogPost, User]                                # filter blog_posts by User
+]
+
+PartialKs::Sync.new(configuration).run! do |tables_to_filter, tables|
   puts tables_to_filter.inspect
   puts tables.inspect
 end
 ```
 
-You can specify manual configurations if needed.
+## So how does it work ?
+
+The idea is that PartialKS builds a tree of models and uses
+the parent of a model to sync a subset of the database records for
+the model. E.g. 
 
 ```
-manual_configuration = [
-  [User, nil, -> { User.where(:id => [1]) }],     # specify a subset of users. as users have no parent, specify `nil`
-  [BlogPost, User]                         # filter blog_posts by User
-]
+  User id 1, 3, 5, 7
+  User -> BlogPost
 ```
 
-NB: The first use case for this gem is to be run in conjuction with [Kitchen Sync](https://github.com/willbryant/kitchen_sync). On OSX, one can install Kitchen Sync using `brew install kitchen-sync`
+PartialKS will only download blog_posts records for users 1, 3, 5, and 7.
 
-# Public API
+Most of the time PartialKS will be able to deduce the parent automatically.
 
-It currently consists of :
+If a model has no "parent", PartialKS will download the whole table.
 
-  - PartialKs::KitchenSync
+If a model has "multiple parents", then PartialKS will not choose, and hence
+will download the whole table. If it is not a problem to download the whole
+table, then you can address the warning at your leisure.
 
+## Public API
 
-# Not supported
+It currently consists of :
+
+  - PartialKs::Sync
+
+## Not supported
 
 Things that are not supported in this version.
 
 * Polymorphic relationships
 * Tables with STI
-
-

data/lib/partial_ks.rb

@@ -5,4 +5,4 @@ require_relative 'partial_ks/filtered_table'
 require_relative 'partial_ks/runner'
 require_relative 'partial_ks/table'
 require_relative 'partial_ks/models_list'
-require_relative 'partial_ks/kitchen_sync'
+require_relative 'partial_ks/sync'

data/lib/partial_ks/filtered_table.rb

@@ -9,13 +9,13 @@ module PartialKs
       @custom_filter_relation = custom_filter_relation
     end
 
-    def kitchen_sync_filter
+    def to_sql
       if custom_filter_relation
-        {"only" => filter_based_on_custom_filter_relation}
-      elsif parent && parent.kitchen_sync_filter.nil?
+        filter_based_on_custom_filter_relation
+      elsif parent && parent.to_sql.nil?
         nil
       elsif parent
-        {"only" => filter_based_on_parent_model(parent.table.model)}
+        filter_based_on_parent_model(parent.table.model)
       else
         nil
       end
@@ -23,21 +23,17 @@ module PartialKs
 
     protected
     def filter_based_on_parent_model(parent_model)
-      table.relation_for_associated_model(parent_model).where_sql.to_s.sub(where_regexp, "")
+      table.relation_for_associated_model(parent_model).to_sql.to_s
     end
 
     def filter_based_on_custom_filter_relation
       relation = custom_filter_relation.respond_to?(:call) ? custom_filter_relation.call : custom_filter_relation
 
       if relation.is_a?(ActiveRecord::Relation) || relation.respond_to?(:where_sql)
-        relation.to_sql.to_s.sub(where_regexp, "")
+        relation.to_sql.to_s
       elsif relation.is_a?(String)
-        relation.sub(where_regexp, "")
+        relation
       end
     end
-
-    def where_regexp
-      /\A.*WHERE\s*/i
-    end
   end
 end

data/lib/partial_ks/runner.rb

@@ -13,7 +13,7 @@ module PartialKs
 
         generation.each do |table|
           table_names << table.table_name
-          filter_config = table.kitchen_sync_filter
+          filter_config = table.to_sql
 
           if !filter_config.nil?
             tables_to_filter[table.table_name] = filter_config

data/lib/partial_ks/{kitchen_sync.rb → sync.rb}

@@ -1,5 +1,5 @@
 module PartialKs
-  class KitchenSync
+  class Sync
     attr_reader :models_list
     delegate :issues, to: :models_list
 

data/lib/partial_ks/version.rb

@@ -1,3 +1,3 @@
 module PartialKs
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/partial_ks.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.version      = PartialKs::VERSION
   gem.summary      = "Partial KS"
   gem.description  = <<-EOF
-A library to use kitchen-sync to sync a subset of your database
+A library to sync a subset of your database
 EOF
   gem.has_rdoc     = false
   gem.author       = "Thong Kuah"

data/test/filtered_table_test.rb

@@ -1,60 +1,62 @@
 require 'test_helper'
 
-describe "kitchen sync filter" do
+describe "filtered table" do
   let(:model) { PostTag }
   let(:parent_model) { BlogPost }
 
   it "proxies to Table if there's parent only" do
     table_parent_relation_method = :relation_for_associated_model
     relation_mock = Minitest::Mock.new
-    relation_mock.expect :where_sql, "WHERE tag_id IN (0)"
+    statement = "SELECT * FROM #{model.table_name} WHERE tag_id IN (0)"
+    relation_mock.expect :to_sql, statement
+    relation_mock.expect :to_sql, statement
     parent = PartialKs::FilteredTable.new(parent, nil, custom_filter_relation: BlogPost.where("1=0"))
 
     filtered_table = PartialKs::FilteredTable.new(model, parent)
     filtered_table.table.stub table_parent_relation_method, relation_mock do
-      filtered_table.kitchen_sync_filter.must_equal({"only" => 'tag_id IN (0)'})
+      filtered_table.to_sql.must_equal(statement)
     end
   end
 
   it "short-circuits evaluation if the parent has no filter" do
     parent = PartialKs::FilteredTable.new(parent, nil)
     filtered_table = PartialKs::FilteredTable.new(model, parent)
-    filtered_table.kitchen_sync_filter.must_be_nil
+    filtered_table.to_sql.must_be_nil
   end
 
   it "uses the custom filter if provided" do
     filter = PostTag.where(:id => [1, 2])
     filtered_table = PartialKs::FilteredTable.new(model, nil, custom_filter_relation: filter)
-    filtered_table.kitchen_sync_filter.must_equal({"only" => '"post_tags"."id" IN (1, 2)'})
+    filtered_table.to_sql.must_equal('SELECT "post_tags".* FROM "post_tags" WHERE "post_tags"."id" IN (1, 2)')
   end
 
   it "uses the filter inside a lambda" do
     filter = -> { PostTag.where(:id => [1, 2]) }
     filtered_table = PartialKs::FilteredTable.new(model, nil, custom_filter_relation: filter)
-    filtered_table.kitchen_sync_filter.must_equal({"only" => '"post_tags"."id" IN (1, 2)'})
+    filtered_table.to_sql.must_equal('SELECT "post_tags".* FROM "post_tags" WHERE "post_tags"."id" IN (1, 2)')
   end
 
   it "uses a SQL where fragment as a filter if provided" do
     string_filter = "1=0"
     filtered_table = PartialKs::FilteredTable.new(model, nil, custom_filter_relation: string_filter)
-    filtered_table.kitchen_sync_filter.must_equal({"only" => string_filter})
+    filtered_table.to_sql.must_equal(string_filter)
   end
 
   it "uses a SQL statement as a filter if provided" do
     string_filter = "1=0"
     sql_statement = "select * from #{model.table_name} where #{string_filter}"
     filtered_table = PartialKs::FilteredTable.new(model, nil, custom_filter_relation: sql_statement)
-    filtered_table.kitchen_sync_filter.must_equal({"only" => string_filter})
+    filtered_table.to_sql.must_equal(sql_statement)
   end
 
   it "returns nil if parent is nil" do
     filtered_table = PartialKs::FilteredTable.new(model, nil)
-    filtered_table.kitchen_sync_filter.must_be_nil
+    filtered_table.to_sql.must_be_nil
   end
 
   it "generates a complete where fragment from a custom filter" do
     filter = PostTag.where(:id => 2)
     filtered_table = PartialKs::FilteredTable.new(model, nil, custom_filter_relation: filter)
-    filtered_table.kitchen_sync_filter.must_equal({"only" => '"post_tags"."id" = 2'})
+    filtered_table.to_sql.must_equal('SELECT "post_tags".* FROM "post_tags" WHERE "post_tags"."id" = 2')
   end
 end

data/test/runner_test.rb

@@ -47,7 +47,7 @@ describe 'running based on output from generator' do
     actual_filters.size.must_equal expected_filters.size
     actual_filters.keys.must_equal expected_filters
     expected_filters.each do |table_name|
-      actual_filters[table_name]["only"].must_be_kind_of String
+      actual_filters[table_name].must_be_kind_of String
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: partial_ks
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Thong Kuah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'A library to use kitchen-sync to sync a subset of your database
+description: 'A library to sync a subset of your database
 
 '
 email: kuahyeow@gmail.com
@@ -70,9 +70,9 @@ files:
 - lib/partial_ks.rb
 - lib/partial_ks/all_rails_models.rb
 - lib/partial_ks/filtered_table.rb
-- lib/partial_ks/kitchen_sync.rb
 - lib/partial_ks/models_list.rb
 - lib/partial_ks/runner.rb
+- lib/partial_ks/sync.rb
 - lib/partial_ks/table.rb
 - lib/partial_ks/version.rb
 - partial_ks.gemspec
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Partial KS