zero-rails-adapter 0.2.0 → 0.3.1

data/lib/zero_rails_adapter/type_script/generator.rb

@@ -37,13 +37,31 @@ module ZeroRailsAdapter
         jsonb: "z.json()"
       }.freeze
 
-      attr_reader :models
+      attr_reader :models, :crud_models
+
+      def initialize(published_schema: nil, crud_models: nil, manual_relationships: nil)
+        schema = published_schema || ZeroRailsAdapter.configuration.published_schema.call
+        @published_schema = PublishedSchema.new(
+          schema,
+          zero_key: ZeroRailsAdapter.configuration.zero_key
+        )
+        @models = @published_schema.models.sort_by(&:table_name)
+        relationship_definitions = manual_relationships ||
+          ZeroRailsAdapter.configuration.relationship_provider.call
+        @manual_relationships = Array(relationship_definitions).map do |definition|
+          Relationship.from_definition(definition, published_schema: @published_schema)
+        end
+        requested_crud_models = Array(
+          crud_models || ZeroRailsAdapter.configuration.crud_model_provider.call
+        )
+        unpublished = requested_crud_models - models
+        if unpublished.any?
+          labels = unpublished.map { |model| model.respond_to?(:name) ? model.name : model.inspect }
+          raise UnsafePublicationError,
+            "CRUD models must also be published: #{labels.join(', ')}"
+        end
 
-      def initialize(models: nil)
-        @models = Array(models || ZeroRailsAdapter.configuration.model_provider.call)
-          .select { |model| active_record_model?(model) }
-          .uniq
-          .sort_by(&:table_name)
+        @crud_models = requested_crud_models.uniq.sort_by(&:table_name)
       end
 
       def schema
@@ -75,7 +93,7 @@ module ZeroRailsAdapter
 
       def table_definitions
         models.map do |model|
-          columns = model.columns.map do |column|
+          columns = columns_for(model).map do |column|
             "    #{property_name(column.name)}: #{zero_type(model, column)},"
           end.join("\n")
           keys = primary_keys(model).map { |key| quote(key) }.join(", ")
@@ -91,22 +109,20 @@ module ZeroRailsAdapter
       end
 
       def relationship_definitions
-        relationships.group_by(&:first).map do |model, definitions|
-          kinds = definitions.map do |_source, reflection, _destination|
-            reflection.collection? ? "many" : "one"
-          end.uniq.sort.join(", ")
-          entries = definitions.map do |_source, reflection, destination|
-            source_fields, destination_fields =
-              relationship_fields(model, reflection, destination)
-            kind = reflection.collection? ? "many" : "one"
-
-            [
-              "#{property_name(reflection.name)}: #{kind}({",
-              "  sourceField: [#{source_fields.map { |field| quote(field) }.join(', ')}],",
-              "  destSchema: #{variable_name(destination)},",
-              "  destField: [#{destination_fields.map { |field| quote(field) }.join(', ')}],",
-              "}),"
-            ].join("\n")
+        relationships.group_by(&:source).map do |model, definitions|
+          kinds = definitions.map(&:kind).uniq.sort.join(", ")
+          entries = definitions.map do |relationship|
+            hops = relationship.hops.map do |hop|
+              [
+                "{",
+                "  sourceField: [#{hop.source_fields.map { |field| quote(field) }.join(', ')}],",
+                "  destSchema: #{variable_name(hop.destination)},",
+                "  destField: [#{hop.destination_fields.map { |field| quote(field) }.join(', ')}],",
+                "}"
+              ].join("\n")
+            end.join(", ")
+
+            "#{property_name(relationship.name)}: #{relationship.kind}(#{hops}),"
           end.join("\n")
 
           [
@@ -119,7 +135,7 @@ module ZeroRailsAdapter
 
       def schema_export
         table_vars = models.map { |model| variable_name(model) }.join(", ")
-        relation_vars = relationships.map(&:first).uniq.map do |model|
+        relation_vars = relationships.map(&:source).uniq.map do |model|
           relationship_variable_name(model)
         end.join(", ")
 
@@ -140,7 +156,7 @@ module ZeroRailsAdapter
       end
 
       def argument_schemas
-        models.flat_map do |model|
+        crud_models.flat_map do |model|
           [
             zod_schema(model, :create),
             zod_schema(model, :update),
@@ -162,7 +178,7 @@ module ZeroRailsAdapter
       end
 
       def mutator_export
-        tables = models.map do |model|
+        tables = crud_models.map do |model|
           variable = variable_name(model)
           table = property_name(model.table_name)
           create_values = create_insert_values(model)
@@ -193,8 +209,8 @@ module ZeroRailsAdapter
 
       def create_insert_values(model)
         additions = []
-        additions << "created_at: now" if model.column_names.include?("created_at")
-        additions << "updated_at: now" if model.column_names.include?("updated_at")
+        additions << "created_at: now" if published_column?(model, "created_at")
+        additions << "updated_at: now" if published_column?(model, "updated_at")
         defaulted_columns(model).each do |column|
           value = if generated_attribute_names(model, :create).include?(column.name)
             "args.#{property_name(column.name)} ?? #{typescript_default(column)}"
@@ -208,7 +224,7 @@ module ZeroRailsAdapter
 
       def update_insert_values(model)
         additions = []
-        additions << "updated_at: Date.now()" if model.column_names.include?("updated_at")
+        additions << "updated_at: Date.now()" if published_column?(model, "updated_at")
         object_with_additions(additions)
       end
 
@@ -220,21 +236,24 @@ module ZeroRailsAdapter
 
       def mutation_columns(model, action)
         primary = primary_keys(model)
+        immutable = (primary + Array(model.primary_key).compact.map(&:to_s)).uniq
         case action
         when :create
           allowed = generated_attribute_names(model, action)
-          model.columns.select do |column|
+          columns_for(model).select do |column|
             !timestamp_column?(column) &&
               (primary.include?(column.name) || allowed.include?(column.name))
           end
         when :update
           allowed = generated_attribute_names(model, action)
-          model.columns.select do |column|
+          columns_for(model).select do |column|
             primary.include?(column.name) ||
-              (!timestamp_column?(column) && allowed.include?(column.name))
+              (!immutable.include?(column.name) &&
+                !timestamp_column?(column) &&
+                allowed.include?(column.name))
           end
         when :destroy
-          model.columns.select { |column| primary.include?(column.name) }
+          columns_for(model).select { |column| primary.include?(column.name) }
         end
       end
 
@@ -250,7 +269,7 @@ module ZeroRailsAdapter
 
       def defaulted_columns(model)
         primary = primary_keys(model)
-        model.columns.select do |column|
+        columns_for(model).select do |column|
           !primary.include?(column.name) &&
             !timestamp_column?(column) &&
             !column.null &&
@@ -264,7 +283,7 @@ module ZeroRailsAdapter
           return column.null ? "#{type}.optional()" : type
         end
 
-        type = enum_values(model, column)&.then do |values|
+        type = native_enum_values(model, column)&.then do |values|
           "enumeration<#{values.map { |value| quote(value) }.join(' | ')}>()"
         end
         type ||= mapped_type(SCHEMA_TYPES, model, column)
@@ -273,7 +292,7 @@ module ZeroRailsAdapter
       end
 
       def zod_type(model, column, action)
-        values = enum_values(model, column)
+        values = native_enum_values(model, column)
         type = if column.respond_to?(:array) && column.array
           "z.array(#{mapped_type(ZOD_TYPES, model, column)})"
         elsif values
@@ -300,18 +319,24 @@ module ZeroRailsAdapter
         end
       end
 
-      def enum_values(model, column)
+      def native_enum_values(model, column)
+        return unless column.type.to_sym == :enum
+
         definition = model.defined_enums[column.name]
-        definition&.keys
+        return definition.keys if definition
+
+        enum_types = model.connection.enum_types.to_h
+        enum_types[column.sql_type] ||
+          raise(UnsupportedColumnTypeError,
+            "Cannot read PostgreSQL enum values for #{model.name}.#{column.name}")
       end
 
       def schema_imports
         imports = %w[createSchema table]
         imports << "relationships" if relationships.any?
-        imports << "enumeration" if models.any? { |model| model.defined_enums.any? }
         models.each do |model|
-          model.columns.each do |column|
-            imports << if enum_values(model, column)
+          columns_for(model).each do |column|
+            imports << if native_enum_values(model, column)
               "enumeration"
             elsif column.respond_to?(:array) && column.array
               "json"
@@ -334,14 +359,42 @@ module ZeroRailsAdapter
       end
 
       def relationships
-        @relationships ||= models.flat_map do |model|
-          model.reflect_on_all_associations.filter_map do |reflection|
-            next if reflection.polymorphic? || reflection.options[:through]
-
-            destination = reflection.klass
-            [model, reflection, destination] if models.include?(destination)
-          rescue NameError
-            nil
+        @relationships ||= begin
+          automatic = models.flat_map do |model|
+            model.reflect_on_all_associations.filter_map do |reflection|
+              next if reflection.polymorphic? || reflection.options[:through]
+
+              destination = reflection.klass
+              next unless models.include?(destination)
+
+              source_fields, destination_fields =
+                relationship_fields(model, reflection, destination)
+              if source_fields.all? { |field| published_column?(model, field) } &&
+                  destination_fields.all? { |field| published_column?(destination, field) }
+                Relationship.new(
+                  source: model,
+                  name: reflection.name,
+                  kind: reflection.collection? ? :many : :one,
+                  hops: [{
+                    source_fields:,
+                    destination:,
+                    destination_fields:
+                  }],
+                  published_schema: @published_schema
+                )
+              end
+            rescue NameError
+              nil
+            end
+          end
+
+          manual_keys = @manual_relationships.map do |relationship|
+            [relationship.source, relationship.name]
+          end
+          (automatic.reject do |relationship|
+            manual_keys.include?([relationship.source, relationship.name])
+          end + @manual_relationships).sort_by do |relationship|
+            [relationship.source.table_name, relationship.name]
           end
         end
       end
@@ -366,10 +419,15 @@ module ZeroRailsAdapter
       end
 
       def primary_keys(model)
-        keys = Array(model.primary_key).compact.map(&:to_s)
-        return keys if keys.any?
+        @published_schema.zero_keys_for(model)
+      end
+
+      def columns_for(model)
+        @published_schema.columns_for(model)
+      end
 
-        raise UnsupportedColumnTypeError, "#{model.name} has no primary key"
+      def published_column?(model, name)
+        columns_for(model).any? { |column| column.name == name.to_s }
       end
 
       def relationship_variable_name(model)

data/lib/zero_rails_adapter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZeroRailsAdapter
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/zero_rails_adapter.rb

@@ -11,6 +11,8 @@ require_relative "zero_rails_adapter/errors"
 require_relative "zero_rails_adapter/identity"
 require_relative "zero_rails_adapter/context"
 require_relative "zero_rails_adapter/configuration"
+require_relative "zero_rails_adapter/published_schema"
+require_relative "zero_rails_adapter/relationship"
 require_relative "zero_rails_adapter/request_verifiers/api_key"
 require_relative "zero_rails_adapter/registry"
 require_relative "zero_rails_adapter/mutator"
@@ -18,6 +20,7 @@ require_relative "zero_rails_adapter/mutation"
 require_relative "zero_rails_adapter/request"
 require_relative "zero_rails_adapter/crud/dispatcher"
 require_relative "zero_rails_adapter/type_script/generator"
+require_relative "zero_rails_adapter/postgresql/publication_generator"
 require_relative "zero_rails_adapter/storage/zero_schema"
 require_relative "zero_rails_adapter/processor"
 require_relative "zero_rails_adapter/engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails-adapter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Zero Rails Adapter contributors
@@ -35,6 +35,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - app/controllers/zero_rails_adapter/mutations_controller.rb
@@ -46,6 +47,7 @@ files:
 - lib/generators/zero_rails_adapter/install/templates/initializer.rb
 - lib/generators/zero_rails_adapter/mutator/mutator_generator.rb
 - lib/generators/zero_rails_adapter/mutator/templates/mutator.rb
+- lib/generators/zero_rails_adapter/publication/publication_generator.rb
 - lib/generators/zero_rails_adapter/typescript/typescript_generator.rb
 - lib/zero_rails_adapter.rb
 - lib/zero_rails_adapter/configuration.rb
@@ -56,8 +58,11 @@ files:
 - lib/zero_rails_adapter/identity.rb
 - lib/zero_rails_adapter/mutation.rb
 - lib/zero_rails_adapter/mutator.rb
+- lib/zero_rails_adapter/postgresql/publication_generator.rb
 - lib/zero_rails_adapter/processor.rb
+- lib/zero_rails_adapter/published_schema.rb
 - lib/zero_rails_adapter/registry.rb
+- lib/zero_rails_adapter/relationship.rb
 - lib/zero_rails_adapter/request.rb
 - lib/zero_rails_adapter/request_verifiers/api_key.rb
 - lib/zero_rails_adapter/storage/zero_schema.rb
@@ -83,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A Rails 8 Active Record adapter for Rocicorp Zero
 test_files: []