elasticgraph-schema_definition 0.18.0.0

data/lib/elastic_graph/schema_definition/test_support.rb

@@ -0,0 +1,113 @@
+# Copyright 2024 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/error"
+require "elastic_graph/schema_definition/api"
+require "elastic_graph/schema_artifacts/runtime_metadata/schema_element_names"
+
+module ElasticGraph
+  module SchemaDefinition
+    # Mixin designed to facilitate writing tests that define schemas.
+    #
+    # @private
+    module TestSupport
+      extend self
+
+      def define_schema(
+        schema_element_name_form:,
+        schema_element_name_overrides: {},
+        index_document_sizes: true,
+        json_schema_version: 1,
+        extension_modules: [],
+        derived_type_name_formats: {},
+        type_name_overrides: {},
+        enum_value_overrides_by_type: {},
+        output: nil,
+        &block
+      )
+        schema_elements = SchemaArtifacts::RuntimeMetadata::SchemaElementNames.new(
+          form: schema_element_name_form,
+          overrides: schema_element_name_overrides
+        )
+
+        define_schema_with_schema_elements(
+          schema_elements,
+          index_document_sizes: index_document_sizes,
+          json_schema_version: json_schema_version,
+          extension_modules: extension_modules,
+          derived_type_name_formats: derived_type_name_formats,
+          type_name_overrides: type_name_overrides,
+          enum_value_overrides_by_type: enum_value_overrides_by_type,
+          output: output,
+          &block
+        )
+      end
+
+      def define_schema_with_schema_elements(
+        schema_elements,
+        index_document_sizes: true,
+        json_schema_version: 1,
+        extension_modules: [],
+        derived_type_name_formats: {},
+        type_name_overrides: {},
+        enum_value_overrides_by_type: {},
+        output: nil
+      )
+        api = API.new(
+          schema_elements,
+          index_document_sizes,
+          extension_modules: extension_modules,
+          derived_type_name_formats: derived_type_name_formats,
+          type_name_overrides: type_name_overrides,
+          enum_value_overrides_by_type: enum_value_overrides_by_type,
+          output: output || $stdout
+        )
+
+        yield api if block_given?
+
+        # Set the json_schema_version to the provided value, if needed.
+        if !json_schema_version.nil? && api.state.json_schema_version.nil?
+          api.json_schema_version json_schema_version
+        end
+
+        api.results
+      end
+
+      DOC_COMMENTS = (
+        '(?:^ *"""\\n' + # opening sequence of `"""` on its own line.
+        '(?:[^"]|(?:"(?!")))*' + # any sequence characters with no `""` sequence. (either no `"` or `"` is not followed by another)
+        '\\n *"""\\n)' # closing sequence of `"""` on its own line.
+      )
+
+      def type_def_from(sdl, type, include_docs: false)
+        type_def_keyword = '^(type|input|enum|union|interface|scalar|directive)\b'
+        # capture from the start of the type definition for `type` until the next type definition (or `\z` for end of string)
+        type_extraction_regex = /(#{DOC_COMMENTS}?#{type_def_keyword} #{type}\b.*?)(?:(?:#{DOC_COMMENTS}?#{type_def_keyword})|\z)/m
+        # type_defs = sdl.scan(type_extraction_regex).map(&:first)
+        type_defs = sdl.scan(type_extraction_regex).map { |match| [match].flatten.first }
+
+        if type_defs.size >= 2
+          # :nocov: -- only executed when a mistake has been made; causes a failing test.
+          raise SchemaError,
+            "Expected to find 0 or 1 type definition for #{type}, but found #{type_defs.size}. Type defs:\n\n#{type_defs.join("\n\n")}"
+          # :nocov:
+        end
+
+        result = type_defs.first&.strip
+        result &&= strip_docs(result) unless include_docs
+        result
+      end
+
+      def strip_docs(string)
+        string
+          .gsub(/#{DOC_COMMENTS}/o, "") # strip doc comments
+          .gsub("\n\n", "\n") # cleanup formatting so we don't have extra blank lines.
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,513 @@
+--- !ruby/object:Gem::Specification
+name: elasticgraph-schema_definition
+version: !ruby/object:Gem::Version
+  version: 0.18.0.0
+platform: ruby
+authors:
+- Myron Marston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: flatware-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-indexer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-schema_artifacts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-datastore_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-opensearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.0.0
+description: 
+email:
+- myron@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- elasticgraph-schema_definition.gemspec
+- lib/elastic_graph/schema_definition/api.rb
+- lib/elastic_graph/schema_definition/factory.rb
+- lib/elastic_graph/schema_definition/indexing/derived_fields/append_only_set.rb
+- lib/elastic_graph/schema_definition/indexing/derived_fields/field_initializer_support.rb
+- lib/elastic_graph/schema_definition/indexing/derived_fields/immutable_value.rb
+- lib/elastic_graph/schema_definition/indexing/derived_fields/min_or_max_value.rb
+- lib/elastic_graph/schema_definition/indexing/derived_indexed_type.rb
+- lib/elastic_graph/schema_definition/indexing/event_envelope.rb
+- lib/elastic_graph/schema_definition/indexing/field.rb
+- lib/elastic_graph/schema_definition/indexing/field_reference.rb
+- lib/elastic_graph/schema_definition/indexing/field_type/enum.rb
+- lib/elastic_graph/schema_definition/indexing/field_type/object.rb
+- lib/elastic_graph/schema_definition/indexing/field_type/scalar.rb
+- lib/elastic_graph/schema_definition/indexing/field_type/union.rb
+- lib/elastic_graph/schema_definition/indexing/index.rb
+- lib/elastic_graph/schema_definition/indexing/json_schema_field_metadata.rb
+- lib/elastic_graph/schema_definition/indexing/json_schema_with_metadata.rb
+- lib/elastic_graph/schema_definition/indexing/list_counts_mapping.rb
+- lib/elastic_graph/schema_definition/indexing/relationship_resolver.rb
+- lib/elastic_graph/schema_definition/indexing/rollover_config.rb
+- lib/elastic_graph/schema_definition/indexing/update_target_factory.rb
+- lib/elastic_graph/schema_definition/indexing/update_target_resolver.rb
+- lib/elastic_graph/schema_definition/json_schema_pruner.rb
+- lib/elastic_graph/schema_definition/mixins/can_be_graphql_only.rb
+- lib/elastic_graph/schema_definition/mixins/has_derived_graphql_type_customizations.rb
+- lib/elastic_graph/schema_definition/mixins/has_directives.rb
+- lib/elastic_graph/schema_definition/mixins/has_documentation.rb
+- lib/elastic_graph/schema_definition/mixins/has_indices.rb
+- lib/elastic_graph/schema_definition/mixins/has_readable_to_s_and_inspect.rb
+- lib/elastic_graph/schema_definition/mixins/has_subtypes.rb
+- lib/elastic_graph/schema_definition/mixins/has_type_info.rb
+- lib/elastic_graph/schema_definition/mixins/implements_interfaces.rb
+- lib/elastic_graph/schema_definition/mixins/supports_default_value.rb
+- lib/elastic_graph/schema_definition/mixins/supports_filtering_and_aggregation.rb
+- lib/elastic_graph/schema_definition/mixins/verifies_graphql_name.rb
+- lib/elastic_graph/schema_definition/rake_tasks.rb
+- lib/elastic_graph/schema_definition/results.rb
+- lib/elastic_graph/schema_definition/schema_artifact_manager.rb
+- lib/elastic_graph/schema_definition/schema_elements/argument.rb
+- lib/elastic_graph/schema_definition/schema_elements/built_in_types.rb
+- lib/elastic_graph/schema_definition/schema_elements/deprecated_element.rb
+- lib/elastic_graph/schema_definition/schema_elements/directive.rb
+- lib/elastic_graph/schema_definition/schema_elements/enum_type.rb
+- lib/elastic_graph/schema_definition/schema_elements/enum_value.rb
+- lib/elastic_graph/schema_definition/schema_elements/enum_value_namer.rb
+- lib/elastic_graph/schema_definition/schema_elements/enums_for_indexed_types.rb
+- lib/elastic_graph/schema_definition/schema_elements/field.rb
+- lib/elastic_graph/schema_definition/schema_elements/field_path.rb
+- lib/elastic_graph/schema_definition/schema_elements/field_source.rb
+- lib/elastic_graph/schema_definition/schema_elements/graphql_sdl_enumerator.rb
+- lib/elastic_graph/schema_definition/schema_elements/input_field.rb
+- lib/elastic_graph/schema_definition/schema_elements/input_type.rb
+- lib/elastic_graph/schema_definition/schema_elements/interface_type.rb
+- lib/elastic_graph/schema_definition/schema_elements/list_counts_state.rb
+- lib/elastic_graph/schema_definition/schema_elements/object_type.rb
+- lib/elastic_graph/schema_definition/schema_elements/relationship.rb
+- lib/elastic_graph/schema_definition/schema_elements/scalar_type.rb
+- lib/elastic_graph/schema_definition/schema_elements/sort_order_enum_value.rb
+- lib/elastic_graph/schema_definition/schema_elements/sub_aggregation_path.rb
+- lib/elastic_graph/schema_definition/schema_elements/type_namer.rb
+- lib/elastic_graph/schema_definition/schema_elements/type_reference.rb
+- lib/elastic_graph/schema_definition/schema_elements/type_with_subfields.rb
+- lib/elastic_graph/schema_definition/schema_elements/union_type.rb
+- lib/elastic_graph/schema_definition/scripting/file_system_repository.rb
+- lib/elastic_graph/schema_definition/scripting/script.rb
+- lib/elastic_graph/schema_definition/scripting/scripts/field/as_day_of_week.painless
+- lib/elastic_graph/schema_definition/scripting/scripts/field/as_time_of_day.painless
+- lib/elastic_graph/schema_definition/scripting/scripts/filter/by_time_of_day.painless
+- lib/elastic_graph/schema_definition/scripting/scripts/update/index_data.painless
+- lib/elastic_graph/schema_definition/state.rb
+- lib/elastic_graph/schema_definition/test_support.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  gem_category: local
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: ElasticGraph gem that provides the schema definition API and generates schema
+  artifacts.
+test_files: []