elasticgraph-schema_artifacts 1.0.0.rc3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2173ff8c84a7c1ee9170dd00a8e8d2193e6ffceec4fb0c9e66492b7affdedabf
-  data.tar.gz: 71638cad65652eafcaaa0cbdb34727aaadedf7d1d4c27e76dfc2c882f7e1358e
+  metadata.gz: f614f488ed50162571c9c5df096b7cc8c06785f1f1b364f702c67a1558a1426f
+  data.tar.gz: f107371645d484100628967f067b5dc29c5b9e274ddc4d8dc462c497f1689406
 SHA512:
-  metadata.gz: ff8228ee7aaeeaaf85e03f6333b1613de7f1a3a6ed73607f10821b6e3f5b123d5e50de7b3a015f1186504d66d3931c204f3314d641a21456185bbe9cfc5647b8
-  data.tar.gz: 0337417d2246da9439688563271a027a7f7a4c3c17d38f5d691f8609a4bc4a52e6ee3d25076bb576079929371f69edd532b64090950503744c42a35ffafa3164
+  metadata.gz: 6e2df97965c644d519af306754e0c8e5b29dcda4315c28fd5009b498fa23971e8237d7005037b2d079892c4bfe31dbf9b243279dcee856952698b923441bf3e5
+  data.tar.gz: e070c0e111edcbb4a545e7bc5ab05c781f5c2e7df68776609ee0da62acd6053e0bebc9c2052c216d017944255524e93840ed426c790dc98e159b182f89e10e69

data/README.md

@@ -33,3 +33,19 @@ graph LR;
     elasticgraph-schema_definition --> elasticgraph-schema_artifacts;
     class elasticgraph-schema_definition otherEgGemStyle;
 ```
+
+## Usage
+
+`elasticgraph-schema_artifacts` is used internally by the other parts of ElasticGraph, but it can also be used directly:
+
+```ruby
+require "elastic_graph/schema_artifacts"
+
+artifacts = ElasticGraph::SchemaArtifacts.from_yaml_file("config/settings/local.yaml")
+
+# The `artifacts` object provides access to the various schema artifacts:
+artifacts.graphql_schema_string
+artifacts.datastore_config
+artifacts.runtime_metadata
+artifacts.json_schemas_for(artifacts.latest_json_schema_version)
+```

data/lib/elastic_graph/schema_artifacts/from_disk.rb

@@ -10,35 +10,11 @@ require "elastic_graph/constants"
 require "elastic_graph/errors"
 require "elastic_graph/schema_artifacts/artifacts_helper_methods"
 require "elastic_graph/schema_artifacts/runtime_metadata/schema"
-require "elastic_graph/support/hash_util"
 require "elastic_graph/support/memoizable_data"
 require "yaml"
 
 module ElasticGraph
-  # Namespace for all code related to ElasticGraph schema artifacts.
-  # Schema artifacts are generated by {SchemaDefinition} and dumped to disk.
-  # Later, they are used to power ElasticGraph.
   module SchemaArtifacts
-    # Builds a `SchemaArtifacts::FromDisk` instance using the provided YAML settings.
-    #
-    # @param parsed_yaml [Hash<String, Object>] hash parsed from a settings YAML file
-    # @return [FromDisk]
-    def self.from_parsed_yaml(parsed_yaml)
-      schema_artifacts = parsed_yaml.fetch("schema_artifacts") do
-        raise Errors::ConfigError, "Config is missing required key `schema_artifacts`."
-      end
-
-      if (extra_keys = schema_artifacts.keys - ["directory"]).any?
-        raise Errors::ConfigError, "Config has extra `schema_artifacts` keys: #{extra_keys}"
-      end
-
-      directory = schema_artifacts.fetch("directory") do
-        raise Errors::ConfigError, "Config is missing required key `schema_artifacts.directory`."
-      end
-
-      FromDisk.new(directory)
-    end
-
     # Responsible for loading schema artifacts from disk and providing access to each artifact.
     #
     # @!attribute [r] artifacts_dir

data/lib/elastic_graph/schema_artifacts.rb

@@ -0,0 +1,40 @@
+# Copyright 2024 - 2025 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/errors"
+require "elastic_graph/schema_artifacts/from_disk"
+require "elastic_graph/support/from_yaml_file"
+
+module ElasticGraph
+  # Namespace for all code related to ElasticGraph schema artifacts.
+  # Schema artifacts are generated by {SchemaDefinition} and dumped to disk.
+  # Later, they are used to power ElasticGraph.
+  module SchemaArtifacts
+    extend Support::FromYamlFile
+
+    # Builds a `SchemaArtifacts::FromDisk` instance using the provided YAML settings.
+    #
+    # @param parsed_yaml [Hash<String, Object>] hash parsed from a settings YAML file
+    # @return [FromDisk]
+    def self.from_parsed_yaml(parsed_yaml)
+      schema_artifacts = parsed_yaml.fetch("schema_artifacts") do
+        raise Errors::ConfigError, "Config is missing required key `schema_artifacts`."
+      end
+
+      if (extra_keys = schema_artifacts.keys - ["directory"]).any?
+        raise Errors::ConfigError, "Config has extra `schema_artifacts` keys: #{extra_keys}"
+      end
+
+      directory = schema_artifacts.fetch("directory") do
+        raise Errors::ConfigError, "Config is missing required key `schema_artifacts.directory`."
+      end
+
+      FromDisk.new(directory)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-schema_artifacts
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0
 platform: ruby
 authors:
 - Myron Marston
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: elasticgraph-indexer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0
 email:
 - myron@squareup.com
 executables: []
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- lib/elastic_graph/schema_artifacts.rb
 - lib/elastic_graph/schema_artifacts/artifacts_helper_methods.rb
 - lib/elastic_graph/schema_artifacts/from_disk.rb
 - lib/elastic_graph/schema_artifacts/runtime_metadata/computation_detail.rb
@@ -88,10 +89,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-schema_artifacts
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0/elasticgraph-schema_artifacts
   gem_category: core
 rdoc_options: []
 require_paths:
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
-summary: ElasticGraph gem containing code related to generated schema artifacts.
+summary: Provides access to ElasticGraph schema artifacts.
 test_files: []