graph_weaver 0.7.4 → 0.7.5

data/lib/graph_weaver.rb

@@ -214,7 +214,7 @@ module GraphWeaver
     attr_accessor :skip_generated_load
 
     # The name of the shared module — the types that live once per schema
-    # (input types, enums, unions hoisted from shared fragments) and are
+    # (input types, enums, the types hoisted from shared fragments) and are
     # aliased into every query module that touches them. Constant, not derived
     # from where you put the files: set it globally, or pass types_module: per
     # generate!. A multi-schema layout names it in the same initializer that
@@ -795,7 +795,7 @@ module GraphWeaver
 
     # (filename, source) per artifact. Types a schema shares across queries —
     # input types, schema enums, and each named shared fragment spread as a
-    # whole-union field — are emitted once into the shared module, with query
+    # whole field — are emitted once into the shared module, with query
     # modules aliasing what they use. That's the difference between hundreds of
     # duplicated bool_exp structs (or one Ruby class per query for the same
     # schema enum) and one copy per schema. (Single-query parse inlines
@@ -814,7 +814,7 @@ module GraphWeaver
       @unmatched_registrations |= registry.unmatched_registrations(schema)
 
       used = { inputs: [], enums: [], mapped: [] }
-      used_unions = []
+      hoisted = []
       helpers = []
       shared = Codegen.load_fragments(fragments)
 
@@ -831,14 +831,14 @@ module GraphWeaver
           name:,
           graph_name: graph.name,
           types_namespace: graph.types_module,
-          hoistable_unions: Codegen.shared_fragment_spreads(source, shared, path),
+          hoistable_fragments: Codegen.shared_fragment_spreads(source, shared, path),
           path:,
           registry:,
         )
         out = codegen.generate
         codegen.variable_type_names.each { |kind, names| used[kind] |= names }
         found.concat(codegen.untyped_scalars).uniq!
-        used_unions |= codegen.used_union_names
+        hoisted |= codegen.used_fragment_names
         helpers |= codegen.block_helpers
         [filename, out]
       rescue GraphWeaver::Error => e
@@ -849,12 +849,12 @@ module GraphWeaver
       end
       refuse_all!(refusals, paths.size)
 
-      if used_unions.any? || used.values.any?(&:any?)
+      if hoisted.any? || used.values.any?(&:any?)
         refuse_duplicate_types!(seen, graph)
         codegen = Codegen.new(schema:, query: "", name: graph.types_module, registry:)
         types = codegen.generate_types(
           inputs: used[:inputs], enums: used[:enums] + used[:mapped],
-          unions: used_unions, fragments: shared,
+          hoisted:, fragments: shared,
         )
         found.concat(codegen.untyped_scalars).uniq!
         helpers |= codegen.block_helpers
@@ -1051,6 +1051,12 @@ module GraphWeaver
     # mid-rename needs:
     #
     #      GraphWeaver.register_enum("Status", alias: { "legacy_mode" => "LEGACY_MODE" })
+    #
+    # fallback: true is the type-less form of forward-compat: the generated
+    # enum gains an Other member and casts every value the schema doesn't
+    # declare to it, so a server adding one doesn't take the client down.
+    #
+    #      GraphWeaver.register_enum("Species", fallback: true)
     def register_enum(graphql_name, type = nil, positional_map = nil, map: nil, fallback: nil, requires: nil,
       alias: nil)
       # `alias` is a Ruby keyword, so the parameter is only readable through binding

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graph_weaver
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Daniel Pepper
@@ -281,6 +281,7 @@ files:
 - docs/getting_started.md
 - docs/i18n.md
 - docs/logging.md
+- docs/migrating.md
 - docs/real_world.md
 - docs/scalars.md
 - docs/testing.md
@@ -363,7 +364,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dpep/graph_weaver/issues
-  changelog_uri: https://github.com/dpep/graph_weaver/blob/v0.7.4/CHANGELOG.md
+  changelog_uri: https://github.com/dpep/graph_weaver/blob/v0.7.5/CHANGELOG.md
   documentation_uri: https://github.com/dpep/graph_weaver/tree/main/docs
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/dpep/graph_weaver