elasticgraph 0.19.0.0 → 0.19.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eca32e62a4248d2e0af28f5fc55387b041730fab33f333393681f2ce4c8b7d4
-  data.tar.gz: 885c292bd452fd17ccd495478097c3e3fbbe60214f56f4c75a9371e40cf0392a
+  metadata.gz: 2bc0f43e12d65d88384972b991179c77c5ec7856c86c85f151138e0af2d99f2f
+  data.tar.gz: f12ed7e628eba142a6299f5878a97d8d80de3068fbff13606fe6ffbc7e181acd
 SHA512:
-  metadata.gz: 753d971644015e750ff3a23f639059a14b70794c8cff317609d405861c5e602230be5e0ed911baf9860a627c304aaaba77a80f4acb552f9a38fe9acc58887439
-  data.tar.gz: 712cd194f44ecb3cc412811214a761150936ea166611a2bc901f862108cc830d7db531e4fd9ab683e8039b5c845a07b933610a8d98f22d4dc8eb50692b718418
+  metadata.gz: 276bb3d1e4e9aa8180c01031468d60115ec05567bfbc02d39fbd65e8777dec65f874a19f6e46a5bbeb20aca56d0855c66ba0dd1a989462804ba01cddf6ba81e5
+  data.tar.gz: c191d95111cf81157ef2777bea143d12a0f71aa095b9df0da9bccf27ede6b3f53f250e01bc1bf0d20ab911840dbe33534c9c5fb7557cc521f08496eb8bc2a49f

data/README.md

@@ -2,3 +2,11 @@
 
 ElasticGraph meta-gem that pulls in all the core ElasticGraph gems. Intended for use when all
 parts of ElasticGraph are used from the same deployed app.
+
+## Getting Started
+
+Run this command to bootstrap a new local project:
+
+```bash
+elasticgraph new my_app
+```

data/exe/elasticgraph

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# 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/cli"
+ElasticGraph::CLI.start(ARGV)

data/lib/elastic_graph/cli.rb

@@ -0,0 +1,106 @@
+# 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 "bundler"
+require "elastic_graph/version"
+require "thor"
+
+module ElasticGraph
+  class CLI < ::Thor
+    include ::Thor::Actions
+
+    # Tell Thor where our template files live
+    def self.source_root
+      ::File.expand_path("project_template", __dir__)
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    VALID_DATASTORES = %w[elasticsearch opensearch]
+
+    option :datastore, desc: "elasticsearch or opensearch", type: :string, default: "opensearch"
+    desc "new APP_NAME", "Generate a new ElasticGraph project in APP_NAME."
+    def new(app_path)
+      new_app_path = ::File.join(::Dir.pwd, app_path)
+      app_name = ::File.basename(new_app_path)
+
+      unless app_name.match?(/\A[a-z_]+\z/)
+        raise ::Thor::Error, "App name must be in `snake_case` form but was not: `#{app_name}`."
+      end
+
+      unless VALID_DATASTORES.include?(options[:datastore])
+        raise ::Thor::Error, "Invalid datastore option: #{options[:datastore]}. Must be #{VALID_DATASTORES.join(" or ")}."
+      end
+
+      setup_env = SetupEnv.new(
+        app_name: app_name,
+        app_module: app_name.split("_").map(&:capitalize).join,
+        datastore: options.fetch(:datastore),
+        gemfile_elasticgraph_details_code_snippet: %(["#{VERSION}"])
+      )
+
+      say "Creating a new #{setup_env.datastore_name} ElasticGraph project called '#{app_name}' at: #{new_app_path}", :green
+
+      ElasticGraph.with_setup_env(setup_env) do
+        # Recursively copy all files from project_template into the new_app_path
+        directory ".", new_app_path, exclude_pattern: %r{/lib/app_name/}
+        directory "lib/app_name", ::File.join(new_app_path, "lib", app_name)
+      end
+
+      inside new_app_path do
+        ::Bundler.with_unbundled_env do
+          run "bundle install"
+          run "bundle exec rake schema_artifacts:dump query_registry:dump_variables:all build"
+        end
+
+        run "git init"
+        run "git add ."
+        run "git commit -m 'Bootstrapped ElasticGraph with `elasticgraph new`.'"
+      end
+
+      say "Successfully bootstrapped '#{app_name}' as a new #{setup_env.datastore_name} ElasticGraph project.", :green
+
+      say <<~INSTRUCTIONS, :yellow
+        Next steps:
+          1. cd #{app_path}
+          2. Run `bundle exec rake boot_locally` to try it out in your browser.
+          3. Run `bundle exec rake -T` to view other available tasks.
+          4. Customize your new project as needed. (Search for `TODO` to find things that need updating.)
+      INSTRUCTIONS
+    end
+  end
+
+  class SetupEnv < ::Data.define(:app_name, :app_module, :datastore, :gemfile_elasticgraph_details_code_snippet)
+    DATASTORE_NAMES = {"elasticsearch" => "Elasticsearch", "opensearch" => "OpenSearch"}
+    DATASTORE_UI_NAMES = {"elasticsearch" => "Kibana", "opensearch" => "OpenSearch Dashboards"}
+
+    def datastore_name
+      DATASTORE_NAMES.fetch(datastore)
+    end
+
+    def datastore_ui_name
+      DATASTORE_UI_NAMES.fetch(datastore)
+    end
+
+    def ruby_major_minor
+      "3.4"
+    end
+  end
+
+  singleton_class.attr_reader :setup_env
+
+  def self.with_setup_env(setup_env)
+    original_setup_env = self.setup_env
+    @setup_env = setup_env
+    yield
+  ensure
+    @setup_env = original_setup_env
+  end
+end

data/lib/elastic_graph/project_template/.gitignore

@@ -0,0 +1,5 @@
+bin/*
+bundle/*
+.bundle/*
+tmp/*
+log/*

data/lib/elastic_graph/project_template/.standard.yml.tt

@@ -0,0 +1,8 @@
+ruby_version: <%= ElasticGraph.setup_env.ruby_major_minor %>
+format: progress
+ignore:
+  - bin/**/*
+  - bundle/**/*
+  - .bundle/**/*
+  - log/**/*
+  - tmp/**/*

data/lib/elastic_graph/project_template/Gemfile.tt

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Gem details for the elasticgraph gems.
+elasticgraph_details = <%= ElasticGraph.setup_env.gemfile_elasticgraph_details_code_snippet %>
+
+gem "elasticgraph-local", *elasticgraph_details
+gem "elasticgraph-<%= ElasticGraph.setup_env.datastore %>", *elasticgraph_details
+gem "elasticgraph-query_registry", *elasticgraph_details
+
+gem "httpx", "~> 1.3"
+
+group :development do
+  gem "factory_bot"
+  gem "faker"
+  gem "rspec"
+  gem "standard"
+end

data/lib/elastic_graph/project_template/README.md.tt

@@ -0,0 +1,176 @@
+# <%= ElasticGraph.setup_env.app_module %> ElasticGraph Project
+
+This repository contains the files for creating and maintaining the <%= ElasticGraph.setup_env.app_module %> ElasticGraph Project.
+
+## Development Environment
+
+Here's what you need:
+
+| Requirement    | Version | Installation Instructions                                                 |
+|----------------|---------|---------------------------------------------------------------------------|
+| Ruby           | <%= ElasticGraph.setup_env.ruby_major_minor %>.x   | [ruby-lang.org](https://www.ruby-lang.org/en/documentation/installation/) |
+| Docker Engine  | 27.x    | [docker.com](https://docs.docker.com/engine/install/)                     |
+| Docker Compose | 2.29.x  | [docker.com](https://docs.docker.com/compose/install/)                    |
+
+### Ruby
+
+This project is written in Ruby, a dynamic, open source programming language with a focus on simplicity and productivity.
+
+You may verify your `ruby` installation via the terminal:
+
+```bash
+$ ruby -v
+ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +PRISM [arm64-darwin24]
+```
+
+If you do not have Ruby, we recommend installing it using one of the following:
+
+* [RVM](https://rvm.io/)
+* [asdf](https://asdf-vm.com/)
+* [rbenv](https://rbenv.org/)
+* [ruby-install](https://github.com/postmodern/ruby-install)
+
+### Ruby Dependencies
+
+Ruby dependencies are managed using [bundler](https://bundler.io/), which comes installed with Ruby.
+To install Ruby dependencies, run:
+
+```bash
+$ bundle install
+```
+
+Once that is done, prefix Ruby commands with `bundle exec` in order to run them in the context of the project bundle.
+
+### Docker and Docker Compose
+
+This project uses Docker Engine and Docker Compose to run <%= ElasticGraph.setup_env.datastore_name %> locally. We recommend installing
+[Docker Desktop](https://docs.docker.com/desktop/) to get both Docker dependencies.
+
+## Local Development
+
+Some useful commands to try:
+
+```bash
+# The build rake task can be used after making changes to rebuild everything
+bundle exec rake build
+
+# See all tasks available for managing your project and schemas
+bundle exec rake -T
+
+# Boot a local instance prepopulated with fake data, useful for experimenting
+bundle exec rake boot_locally
+
+# The GraphiQL UI should open automatically
+open http://localhost:9393/
+
+# You can also visit <%= ElasticGraph.setup_env.datastore_ui_name %> via:
+open http://localhost:19293/
+```
+
+### Run Build Tasks
+
+Run a complete suite of build tasks with the build `rake` task:
+
+```bash
+bundle exec rake build
+```
+
+This will:
+1. (Re)generate your schema artifacts
+2. Validate all registered queries against the latest schema
+3. Lint everything (use `bundle exec standardrb --fix` to fix most issues)
+4. Run tests (including the common shared ElasticGraph tests)
+
+Note: on CI, you'll want to use `bundle exec rake check` instead of `bundle exec rake build`,
+so that it verifies that schema artifacts are up-to-date (rather than dumping them).
+
+### Upgrading ElasticGraph
+
+Upgrades to the ElasticGraph gems will come with [release notes](https://github.com/block/elasticgraph/releases/tag/v0.19.0.0) that include upgrade instructions, if necessary.
+
+Here's the bare minimum upgrade process:
+
+1. Modify `elasticgraph_details` in the root `Gemfile` and run `bundle install`.
+2. Run `bundle exec rake`.
+3. Commit the results.
+
+### Managing <%= ElasticGraph.setup_env.datastore_name %>
+
+The `<%= ElasticGraph.setup_env.datastore %>:` tasks will boot the desired <%= ElasticGraph.setup_env.datastore_name %> version using docker. You can
+use either the `:boot` or `:daemon` tasks:
+
+* The `:boot` task will keep <%= ElasticGraph.setup_env.datastore_name %> in the foreground, allowing you to see the logs.
+* The `:daemon` task runs <%= ElasticGraph.setup_env.datastore_name %> as a background daemon task. Notably, it waits to return
+  until <%= ElasticGraph.setup_env.datastore_name %> is ready to receive traffic.
+
+If you use a `:daemon` task, you can later use the corresponding `:halt` task to stop the daemon.
+
+### Using the GraphiQL interactive GraphQL query editor
+
+When running `bundle exec rake boot_locally` the GraphiQL editor should open automatically
+(`open http://localhost:9393/`). Using it you can query your ElasticGraph cluster using GraphQL.
+
+### Seeding Fake Data
+
+The `bundle exec rake index_fake_data:<type_name>` tasks generate and index a batch of fake data.
+You can pass an arg (note quotes) to seed more batches of data:
+`bundle exec rake "index_fake_data:<type_name>[10]"`.
+
+### Using <%= ElasticGraph.setup_env.datastore_ui_name %>
+
+After running `bundle exec rake boot_locally` and opening <%= ElasticGraph.setup_env.datastore_ui_name %>
+`open http://localhost:19293/` click "Dev Tools" to open the <%= ElasticGraph.setup_env.datastore_name %> console.
+
+Here are some queries to get you started:
+
+```
+# Cluster info
+GET /_cat/indices?v
+GET /_cat/shards?v
+GET /_cat/templates?v
+GET /_cat/nodes?v
+GET /_cat/allocation?v
+
+# Or with a pattern
+GET /_cat/shards/*_rollover__202*?v
+
+# More cluster info
+GET /_cluster/health
+GET /_cluster/settings
+
+# Test queries (change from `artists` to your index name)
+GET /artists/_search
+{
+  "from": 0,
+  "size": 1
+}
+
+GET /artists/_search
+{
+  "from": 0,
+  "size": 1,
+  "query": {
+    "bool": {
+      "must": [
+        {
+          "match": {
+            "bio": "accordion"
+          }
+        }
+      ]
+    }
+  }
+}
+```
+
+### Query Registry
+
+This project uses the ElasticGraph query registry extension. This is an optional piece you can choose to remove,
+but provides many benefits--see the [elasticgraph-query_registry
+README](https://github.com/block/elasticgraph/tree/main/elasticgraph-query_registry#elasticgraphqueryregistry)
+for details.
+
+With the registry in place, clients must register their queries in a directory under
+[config/queries](config/queries) that matches their resolved application name.
+The CI build will validate that all schema changes are compatible with all registered queries, and
+your deployed GraphQL endpoints will reject any unregistered queries.

data/lib/elastic_graph/project_template/Rakefile.tt

@@ -0,0 +1,64 @@
+project_root = File.expand_path(__dir__)
+
+require "elastic_graph/local/rake_tasks"
+require "elastic_graph/query_registry/rake_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+require_relative "lib/<%= ElasticGraph.setup_env.app_name %>/fake_data_batch_generator"
+
+settings_file = "#{project_root}/config/settings/local.yaml"
+
+ElasticGraph::Local::RakeTasks.new(
+  local_config_yaml: settings_file,
+  path_to_schema: "#{project_root}/config/schema.rb"
+) do |tasks|
+  # Set this to true once you're beyond the prototyping stage.
+  tasks.enforce_json_schema_version = false
+
+  # Determines casing of field names. Can be either `:camelCase` or `:snake_case`.
+  tasks.schema_element_name_form = :camelCase
+
+  # Customizes the names of fields generated by ElasticGraph.
+  tasks.schema_element_name_overrides = {
+    # Example: force inequality operators to be spelled out.
+    # gt: "greaterThan",
+    # gte: "greaterThanOrEqualTo",
+    # lt: "lessThan",
+    # lte: "lessThanOrEqualTo"
+  }
+
+  # Customizes the naming format used by derived types.
+  tasks.derived_type_name_formats = {
+    # Example: change suffix used for filter inputs from `FilterInput` to just `Filter`.
+    # FilterInput: "%{base}Filter",
+  }
+
+  # Use this to override type names generated by ElasticGraph. We generally recommend sticking
+  # with the defaults, but to align with conventions in your organization you may need to override
+  # some type names.
+  tasks.type_name_overrides = {
+    # Example: this would make your ElasticGraph schema use `IDFilter` in place of the standard `IDFilterInput`.
+    # IDFilterInput: "IDFilter"
+  }
+
+  # TODO: replace this with a fake data generator for your own dataset.
+  tasks.define_fake_data_batch_for :artists do
+    <%= ElasticGraph.setup_env.app_module %>::FakeDataBatchGenerator.generate(artists: 100, venues: 10)
+  end
+end
+
+ElasticGraph::QueryRegistry::RakeTasks.from_yaml_file(
+  settings_file,
+  "config/queries",
+  require_eg_latency_slo_directive: false
+)
+
+::RSpec::Core::RakeTask.new
+
+standard_checks = ["standard", "query_registry:validate_queries", "spec"]
+
+desc "Rebuild everything. Intended to be run locally as you iterate on the schema"
+task build: ["schema_artifacts:dump", *standard_checks]
+
+desc "Check everything. Intended to be run on CI to check your project."
+task check: ["schema_artifacts:check", *standard_checks]

data/lib/elastic_graph/project_template/config/queries/example_client/FindArtist.graphql

@@ -0,0 +1,24 @@
+# TODO: remove or replace this query when you replace the artist schema.
+query FindArtist {
+  byName: artists(filter: {
+    name: {equalToAnyOf: ["U2"]}
+  }) {
+    nodes {
+      name
+      bio {
+        yearFormed
+      }
+    }
+  }
+
+  byBioYearFounded: artists(filter: {
+    bio: {yearFormed: {gt: 2000}}
+  }) {
+    nodes {
+      name
+      bio {
+        yearFormed
+      }
+    }
+  }
+}

data/lib/elastic_graph/project_template/config/queries/example_client/ListArtistAlbums.graphql

@@ -0,0 +1,16 @@
+# TODO: remove or replace this query when you replace the artist schema.
+query ListArtistAlbums {
+  artists {
+    nodes {
+      name
+      albums {
+        name
+        releasedOn
+
+        tracks {
+          name
+        }
+      }
+    }
+  }
+}

data/lib/elastic_graph/project_template/config/schema/artists.rb.tt

@@ -0,0 +1,65 @@
+# TODO: replace this file with one that defines the schema for your own dataset.
+ElasticGraph.define_schema do |schema|
+  schema.object_type "Artist" do |t|
+    t.field "id", "ID"
+    t.field "name", "String"
+    t.field "lifetimeSales", "JsonSafeLong"
+    t.field "bio", "ArtistBio"
+
+    t.field "albums", "[Album!]!" do |f|
+      f.mapping type: "nested"
+    end
+
+    t.field "tours", "[Tour!]!" do |f|
+      f.mapping type: "nested"
+    end
+
+    t.index "artists"
+  end
+
+  schema.object_type "ArtistBio" do |t|
+    t.field "yearFormed", "Int"
+    t.field "homeCountry", "String"
+    t.field "description", "String" do |f|
+      f.mapping type: "text"
+    end
+  end
+
+  schema.object_type "Album" do |t|
+    t.field "name", "String"
+    t.field "releasedOn", "Date"
+    t.field "soldUnits", "Int"
+    t.field "tracks", "[AlbumTrack!]!" do |f|
+      f.mapping type: "nested"
+    end
+  end
+
+  schema.object_type "AlbumTrack" do |t|
+    t.field "name", "String"
+    t.field "trackNumber", "Int"
+    t.field "lengthInSeconds", "Int"
+  end
+
+  schema.object_type "Tour" do |t|
+    t.field "name", "String"
+    t.field "shows", "[Show!]!" do |f|
+      f.mapping type: "nested"
+    end
+  end
+
+  schema.object_type "Show" do |t|
+    t.relates_to_one "venue", "Venue", via: "venueId", dir: :out
+    t.field "attendance", "Int"
+    t.field "startedAt", "DateTime"
+  end
+
+  schema.object_type "Venue" do |t|
+    t.field "id", "ID"
+    t.field "name", "String"
+    t.field "location", "GeoLocation"
+    t.field "capacity", "Int"
+    t.relates_to_many "featuredArtists", "Artist", via: "tours.shows.venueId", dir: :in, singular: "featuredArtist"
+
+    t.index "venues"
+  end
+end

data/lib/elastic_graph/project_template/config/schema.rb.tt

@@ -0,0 +1,21 @@
+require "pathname"
+
+ElasticGraph.define_schema do |schema|
+  # ElasticGraph will tell you when you need to bump this.
+  schema.json_schema_version 1
+
+  # This registers the elasticgraph-query_registry extension, which can be used to reject queries that
+  # clients have not registered (and to reject queries that differ from what a client has registered).
+  # In addition, every registered query is validated against the schema in the CI build, giving you
+  # confidence as you evolve your schema that you're not breaking client queries.
+  #
+  # If you don't want to use this extension, you can remove these lines.
+  require(query_registry_path = "elastic_graph/query_registry/graphql_extension")
+  schema.register_graphql_extension ElasticGraph::QueryRegistry::GraphQLExtension, defined_at: query_registry_path
+end
+
+# Load the rest of the schema from files at config/schema/**/*.rb.
+Dir["#{__dir__}/schema/**/*.rb"].each do |schema_def_file|
+  # Must use `load`, not `require` so that if the schema is evaluated multiple times it works.
+  load Pathname(schema_def_file).expand_path
+end

data/lib/elastic_graph/project_template/config/settings/local.yaml.tt

@@ -0,0 +1,36 @@
+datastore:
+  client_faraday_adapter:
+    name: httpx
+    require: httpx/adapters/faraday
+  clusters:
+    main:
+      backend: <%= ElasticGraph.setup_env.datastore %>
+      url: http://localhost:9293
+      settings: {}
+  index_definitions:
+    # TODO: replace the `artists:` and `venues:` keys with the indices from your dataset
+    artists: &main_index_settings
+      # elasticgraph-local relies on the cluster being named "main".
+      query_cluster: "main"
+      index_into_clusters: ["main"]
+      ignore_routing_values: []
+      custom_timestamp_ranges: []
+      setting_overrides:
+        number_of_shards: 10
+      setting_overrides_by_timestamp: {}
+    venues: *main_index_settings
+  max_client_retries: 3
+graphql:
+  default_page_size: 50
+  max_page_size: 500
+logger:
+  device: stderr
+indexer:
+  latency_slo_thresholds_by_timestamp_in_ms: {}
+schema_artifacts:
+  directory: config/schema/artifacts
+query_registry:
+  # Allow any query by any client since this is for local use.
+  allow_unregistered_clients: true
+  allow_any_query_for_clients: []
+  path_to_registry: config/queries

data/lib/elastic_graph/project_template/lib/app_name/factories.rb

@@ -0,0 +1,107 @@
+require "factory_bot"
+require "faker"
+require_relative "shared_factories"
+
+# TODO: replace the artist/album/tour/venue factories with your own.
+FactoryBot.define do
+  factory :artist, parent: :indexed_type_base do
+    __typename { "Artist" }
+    name { Faker::Music.band }
+
+    lifetimeSales do
+      albums.map { |a| a.fetch(:soldUnits) }.sum
+    end
+
+    bio { build(:artist_bio) }
+
+    albums do
+      Faker::Number.between(from: 1, to: 10).times.map { build(:album) }
+    end
+
+    tours do
+      Faker::Number.between(from: 0, to: 8).times.map { build(:tour, venueIds: venueIds) }
+    end
+
+    transient do
+      venueIds { [] }
+    end
+  end
+
+  factory :artist_bio, parent: :hash_base do
+    __typename { "ArtistBio" }
+    yearFormed { Faker::Number.between(from: 1900, to: 2025) }
+    homeCountry { Faker::Address.country }
+    description { Faker::Lorem.paragraphs(number: 3).join("\n\n") }
+  end
+
+  factory :album, parent: :hash_base do
+    __typename { "Album" }
+    name { Faker::Music.album }
+    releasedOn { Faker::Date.between(from: "1900-01-01", to: "2025-12-31").iso8601 }
+    soldUnits { Faker::Number.between(from: 10000, to: 100_000_000) }
+    tracks do
+      Faker::Number.between(from: 1, to: 20).times.map do |index|
+        build(:album_track, trackNumber: index + 1)
+      end
+    end
+  end
+
+  factory :album_track, parent: :hash_base do
+    __typename { "AlbumTrack" }
+    name { Faker::Music::RockBand.song }
+    trackNumber { Faker::Number.between(from: 1, to: 20) }
+    lengthInSeconds { Faker::Number.between(from: 30, to: 1200) }
+  end
+
+  factory :tour, parent: :hash_base do
+    __typename { "Tour" }
+    name { "#{Faker::Music::RockBand.song} Tour" }
+    shows do
+      start_date = Faker::Date.between(from: "1900-01-01", to: "2025-12-31")
+
+      Faker::Number.between(from: 3, to: 200).times.map do |index|
+        venue_id = Faker::Base.sample(venueIds)
+        build(:show, date: start_date + index, venueId: venue_id)
+      end
+    end
+
+    transient do
+      venueIds { [] }
+    end
+  end
+
+  factory :show, parent: :hash_base do
+    __typename { "Show" }
+    attendance { Faker::Number.between(from: 200, to: 100_000) }
+    startedAt { "#{date.iso8601}T#{startTime}" }
+    venueId { nil }
+
+    transient do
+      date { Faker::Date.between(from: "1900-01-01", to: "2025-12-31") }
+      startTime { Faker::Base.sample(%w[19:00:00Z 19:30:00Z 20:00:00Z 20:30:00Z]) }
+    end
+  end
+
+  factory :venue, parent: :indexed_type_base do
+    __typename { "Venue" }
+
+    name do
+      # Some common music venue types
+      venue_types = ["Theater", "Arena", "Music Hall", "Stadium", "Opera House", "Amphitheater"]
+
+      city_name = Faker::Address.city
+      venue_type = Faker::Base.sample(venue_types)
+
+      "#{city_name} #{venue_type}"
+    end
+
+    location { build(:geo_location) }
+    capacity { Faker::Number.between(from: 200, to: 100_000) }
+  end
+
+  factory :geo_location, parent: :hash_base do
+    __typename { "GeoLocation" }
+    latitude { Faker::Number.between(from: -90.0, to: 90.0) }
+    longitude { Faker::Number.between(from: -180.0, to: 180.0) }
+  end
+end

data/lib/elastic_graph/project_template/lib/app_name/fake_data_batch_generator.rb.tt

@@ -0,0 +1,14 @@
+require_relative "factories"
+
+module <%= ElasticGraph.setup_env.app_module %>
+  module FakeDataBatchGenerator
+    def self.generate(artists:, venues:)
+      venue_list = FactoryBot.build_list(:venue, venues)
+      venue_ids = venue_list.map { |v| v.fetch(:id) }
+
+      artist_list = FactoryBot.build_list(:artist, artists, venueIds: venue_ids)
+
+      venue_list + artist_list
+    end
+  end
+end

data/lib/elastic_graph/project_template/lib/app_name/shared_factories.rb

@@ -0,0 +1,29 @@
+require "date"
+require "factory_bot"
+require "faker"
+
+FactoryBot.define do
+  factory :hash_base, class: Hash do
+    initialize_with { attributes }
+  end
+
+  trait :uuid_id do
+    id { Faker::Internet.uuid }
+  end
+
+  trait :versioned do
+    __version { Faker::Number.between(from: 1, to: 10) }
+  end
+
+  current_json_schema_version = nil
+
+  factory :indexed_type_base, parent: :hash_base, traits: [:uuid_id, :versioned] do
+    __typename { raise NotImplementedError, "You must supply __typename" }
+    __json_schema_version do
+      current_json_schema_version ||= begin
+        json_schema_file = File.expand_path("../../config/schema/artifacts/json_schemas.yaml", __dir__)
+        YAML.safe_load_file(json_schema_file).fetch("json_schema_version")
+      end
+    end
+  end
+end

data/lib/elastic_graph/project_template/spec/project_spec.rb.tt

@@ -0,0 +1,19 @@
+require "elastic_graph/local/spec_support/common_project_specs"
+require "<%= ElasticGraph.setup_env.app_name %>/factories"
+require "<%= ElasticGraph.setup_env.app_name %>/fake_data_batch_generator"
+
+RSpec.describe "ElasticGraph project" do
+  ignored_factories = [
+    # List any factories to ignore
+  ]
+
+  include_examples "an ElasticGraph project",
+    use_settings_yaml: "local.yaml",
+    ignored_factories: ignored_factories
+
+  # TODO: update this spec as needed to generate example fake data for your dataset.
+  it "generates a batch of valid records from `FakeDataBatchGenerator`" do
+    batch = <%= ElasticGraph.setup_env.app_module %>::FakeDataBatchGenerator.generate(artists: 20, venues: 5)
+    expect(batch.size).to eq(25)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph
 version: !ruby/object:Gem::Version
-  version: 0.19.0.0
+  version: 0.19.1.0
 platform: ruby
 authors:
 - Myron Marston
@@ -10,139 +10,71 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2025-02-06 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.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.41.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.41.0
-- !ruby/object:Gem::Dependency
-  name: elasticgraph-admin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.19.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.19.0.0
-- !ruby/object:Gem::Dependency
-  name: elasticgraph-graphql
+  name: elasticgraph-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.0.0
+        version: 0.19.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.0.0
+        version: 0.19.1.0
 - !ruby/object:Gem::Dependency
-  name: elasticgraph-indexer
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.19.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.19.0.0
-- !ruby/object:Gem::Dependency
-  name: elasticgraph-local
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0.0
+        version: '1.3'
 description:
 email:
 - myron@squareup.com
-executables: []
+executables:
+- elasticgraph
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- elasticgraph.gemspec
+- exe/elasticgraph
+- lib/elastic_graph/cli.rb
+- lib/elastic_graph/project_template/.gitignore
+- lib/elastic_graph/project_template/.standard.yml.tt
+- lib/elastic_graph/project_template/Gemfile.tt
+- lib/elastic_graph/project_template/README.md.tt
+- lib/elastic_graph/project_template/Rakefile.tt
+- lib/elastic_graph/project_template/config/queries/example_client/FindArtist.graphql
+- lib/elastic_graph/project_template/config/queries/example_client/ListArtistAlbums.graphql
+- lib/elastic_graph/project_template/config/schema.rb.tt
+- lib/elastic_graph/project_template/config/schema/artists.rb.tt
+- lib/elastic_graph/project_template/config/settings/local.yaml.tt
+- lib/elastic_graph/project_template/lib/app_name/factories.rb
+- lib/elastic_graph/project_template/lib/app_name/fake_data_batch_generator.rb.tt
+- lib/elastic_graph/project_template/lib/app_name/shared_factories.rb
+- lib/elastic_graph/project_template/spec/project_spec.rb.tt
 homepage: https://block.github.io/elasticgraph/
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v0.19.0.0
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v0.19.1.0
   documentation_uri: https://block.github.io/elasticgraph/docs/main/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v0.19.0.0/elasticgraph
+  source_code_uri: https://github.com/block/elasticgraph/tree/v0.19.1.0/elasticgraph
   gem_category: core
 post_install_message:
 rdoc_options: []
@@ -150,9 +82,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -162,5 +97,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: ElasticGraph meta-gem that pulls in all the core ElasticGraph gems.
+summary: Bootstraps ElasticGraph projects.
 test_files: []

data/elasticgraph.gemspec

@@ -1,18 +0,0 @@
-# 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_relative "../gemspec_helper"
-
-ElasticGraphGemspecHelper.define_elasticgraph_gem(gemspec_file: __FILE__, category: :core) do |spec, eg_version|
-  spec.summary = "ElasticGraph meta-gem that pulls in all the core ElasticGraph gems."
-
-  spec.add_dependency "elasticgraph-admin", eg_version
-  spec.add_dependency "elasticgraph-graphql", eg_version
-  spec.add_dependency "elasticgraph-indexer", eg_version
-  spec.add_dependency "elasticgraph-local", eg_version
-end