deckard 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -1
- data/README.md +15 -3
- data/lib/deckard/model_config.rb +17 -6
- data/lib/deckard/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bddfb319d58a0263077f4ecd1599d859e429b06762cd32af84220540ab0c87b9
|
|
4
|
+
data.tar.gz: 3addf61fbe07c2ea578a873a3aa515b31e8ad6b141cd45b53c7902ab72c83b9d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1b393a27053d774049cd08ec8e4792124e733e68479ee22305ff83c9f2bfe825a5b21753165218d19574107dd9309ec332d14b26470fbd631a2ecadd275ea541
|
|
7
|
+
data.tar.gz: 8be46ba56f0c582f16db7e73d46d5b4970f8b93a9e8d61c3582ea1af8f9a3d315266deaa07eb9ca76268755b27dd0c5afb57bf576139af46d8cb38767ff1daec
|
data/CHANGELOG.md
CHANGED
|
@@ -5,7 +5,29 @@ All notable changes to deckard are recorded here. The format follows
|
|
|
5
5
|
[Semantic Versioning](https://semver.org/). Before 1.0, minor versions may
|
|
6
6
|
change the stream format and the Ruby API.
|
|
7
7
|
|
|
8
|
-
## [0.
|
|
8
|
+
## [0.3.1] - 2026-10-10
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
|
|
12
|
+
- Reject unknown names in `omit_associations` with a `ConfigurationError`,
|
|
13
|
+
so a typo cannot silently leave an association included in a dump.
|
|
14
|
+
|
|
15
|
+
## [0.3.0] - 2026-09-30
|
|
16
|
+
|
|
17
|
+
### Added
|
|
18
|
+
|
|
19
|
+
- `natural_keys` inside a `replicate` block: one table of class name to
|
|
20
|
+
attribute name or names, the short form for a reached class that only
|
|
21
|
+
needs a natural key. `model "Name" do natural_key ... end` still works
|
|
22
|
+
for an entry that also names associations or omissions.
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
|
|
26
|
+
- A plan gives each class one natural key. Declaring it twice in the same
|
|
27
|
+
plan is reported by validation as a `ConfigurationError`; before, the
|
|
28
|
+
later declaration silently replaced the earlier one.
|
|
29
|
+
|
|
30
|
+
## [0.2.0] - 2026-09-30
|
|
9
31
|
|
|
10
32
|
### Changed
|
|
11
33
|
|
data/README.md
CHANGED
|
@@ -92,7 +92,7 @@ gives every order the full plan, and a record two dumps share lands once.
|
|
|
92
92
|
|
|
93
93
|
## Plans
|
|
94
94
|
|
|
95
|
-
The `replicate` block offers
|
|
95
|
+
The `replicate` block offers six methods:
|
|
96
96
|
|
|
97
97
|
```ruby
|
|
98
98
|
replicate do
|
|
@@ -101,17 +101,25 @@ replicate do
|
|
|
101
101
|
omit_fields :internal_notes # keep a field out of the stream
|
|
102
102
|
omit_associations :warehouse # do not traverse this association
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
natural_keys "Product" => :sku, # how each reached class is matched
|
|
105
|
+
"Warehouse" => [:region, :code]
|
|
106
|
+
|
|
107
|
+
model "LineItem" do # the first four, for a class the dump reaches
|
|
105
108
|
associations :adjustments
|
|
106
109
|
end
|
|
107
110
|
end
|
|
108
111
|
```
|
|
109
112
|
|
|
113
|
+
Most reached classes need nothing but a natural key, and `natural_keys` says
|
|
114
|
+
that for all of them in one table. A `model` block is for the rest: a
|
|
115
|
+
collection to bring along, a field to leave out. A plan gives each class one
|
|
116
|
+
key, so naming it in both places is a plan problem, not an override.
|
|
117
|
+
|
|
110
118
|
Classes are named as strings, so the root never forces them to load first,
|
|
111
119
|
and an STI subclass follows the entry for its nearest declared ancestor. Each
|
|
112
120
|
record travels with the natural key its plan gave it, so the destination
|
|
113
121
|
needs no plan of its own. That also means a natural key is repeated in every
|
|
114
|
-
plan whose dumps reach the class: a Customer
|
|
122
|
+
plan whose dumps reach the class: a Customer line in Order's plan and one in
|
|
115
123
|
Invoice's, each saying how a customer is matched.
|
|
116
124
|
|
|
117
125
|
Before dumping, the `deckard` executable eager loads the application so
|
|
@@ -203,3 +211,7 @@ manual runs using Ruby 4.0.6 and an isolated PostgreSQL 18.6 service. The
|
|
|
203
211
|
workflow is in `.crow/ruby.yaml`; it covers specs, Standard lint, and the
|
|
204
212
|
style ratchet. The Docker end-to-end harness and performance suite remain
|
|
205
213
|
separate local tasks.
|
|
214
|
+
|
|
215
|
+
Release automation uses a version increase and matching changelog notes in a
|
|
216
|
+
pull request. See [Releasing Deckard](docs/releasing.md) for the shared workflow
|
|
217
|
+
and one-time RubyGems trusted publisher setup.
|
data/lib/deckard/model_config.rb
CHANGED
|
@@ -4,10 +4,10 @@ require "active_support/core_ext/string/inflections"
|
|
|
4
4
|
|
|
5
5
|
module Deckard
|
|
6
6
|
# A replication plan: a root model's `replicate do ... end` block. The plan
|
|
7
|
-
# is an entry for the root plus
|
|
8
|
-
#
|
|
9
|
-
# finds its entry through its ancestors, so an
|
|
10
|
-
# nearest declared ancestor. See docs/traversal.md.
|
|
7
|
+
# is an entry for the root plus an entry for each class its dumps reach,
|
|
8
|
+
# declared through `natural_keys` or `model`, all in one table shared by
|
|
9
|
+
# the plan's entries. A class finds its entry through its ancestors, so an
|
|
10
|
+
# STI subclass follows its nearest declared ancestor. See docs/traversal.md.
|
|
11
11
|
class ModelConfig
|
|
12
12
|
attr_reader :name, :extra_associations, :natural_key_attributes, :omitted_fields, :omitted_associations
|
|
13
13
|
|
|
@@ -47,11 +47,17 @@ module Deckard
|
|
|
47
47
|
end
|
|
48
48
|
|
|
49
49
|
# DSL: attributes identifying an existing destination record to reuse.
|
|
50
|
-
#
|
|
50
|
+
# Declaring it twice in one plan is a problem, not an override.
|
|
51
51
|
def natural_key(*attributes)
|
|
52
|
+
@redeclared_natural_key = !@natural_key_attributes.empty?
|
|
52
53
|
@natural_key_attributes = attributes.map(&:to_s)
|
|
53
54
|
end
|
|
54
55
|
|
|
56
|
+
# DSL: class name to natural key, for reached classes needing nothing else.
|
|
57
|
+
def natural_keys(keys)
|
|
58
|
+
keys.each { |name, attributes| model(name) { natural_key(*attributes) } }
|
|
59
|
+
end
|
|
60
|
+
|
|
55
61
|
# DSL: fields to exclude from dumped attributes. Additive across calls.
|
|
56
62
|
def omit_fields(*names)
|
|
57
63
|
@omitted_fields |= names.map(&:to_s)
|
|
@@ -99,14 +105,19 @@ module Deckard
|
|
|
99
105
|
"which deckard does not support; replicate :#{reflection.through_reflection.name} instead"
|
|
100
106
|
end
|
|
101
107
|
end
|
|
108
|
+
problems += @omitted_associations.filter_map do |name|
|
|
109
|
+
"#{model} has no #{name.inspect} association" unless model.reflect_on_association(name)
|
|
110
|
+
end
|
|
102
111
|
attributes = @natural_key_attributes + @omitted_fields
|
|
103
112
|
unless attributes.empty? || model.abstract_class?
|
|
104
113
|
missing = attributes - model.attribute_names
|
|
105
114
|
problems += missing.map { |attribute| "#{model} has no #{attribute.inspect} attribute" }
|
|
106
115
|
end
|
|
107
|
-
problems
|
|
116
|
+
problems += (@natural_key_attributes & @omitted_fields).map do |attribute|
|
|
108
117
|
"#{model} names #{attribute.inspect} as both a natural key attribute and an omitted field"
|
|
109
118
|
end
|
|
119
|
+
problems << "#{model} is given a natural key more than once in the same plan" if @redeclared_natural_key
|
|
120
|
+
problems
|
|
110
121
|
end
|
|
111
122
|
|
|
112
123
|
# The plan as data, root entry first: what PlanReport renders.
|
data/lib/deckard/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: deckard
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.3.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Rob Sanheim
|
|
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
90
90
|
- !ruby/object:Gem::Version
|
|
91
91
|
version: '0'
|
|
92
92
|
requirements: []
|
|
93
|
-
rubygems_version: 4.0.
|
|
93
|
+
rubygems_version: 4.0.16
|
|
94
94
|
specification_version: 4
|
|
95
95
|
summary: Stream ActiveRecord objects between Rails environments
|
|
96
96
|
test_files: []
|