elasticgraph 0.19.1.1 → 0.19.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4216f5fd015ccd7747fe31e176991c5e964f5d1e35a1a4cc1ff850255e199093
-  data.tar.gz: 8c666e0b5472ded7333ff51b011a190d64b7907e6790b2232782daa35b895c4c
+  metadata.gz: 58ba3bb1a9f40188184fbc0643ce36b185899c313f7d20ee31cbaff2f7a7780e
+  data.tar.gz: 28b7ebeebf6e62758d96c71a7cb65cd6407faee2ffbc73bae7cfdac9c6e7d80b
 SHA512:
-  metadata.gz: 60dd8cca595070065b5a98d883600b970e32126048f1c0c34c47d7b79085f1b8824a887d7ab307615130c0dafbf44ed8f11763c59c6c134d94c0573d9a88ae71
-  data.tar.gz: b3e96d1d0df7464927feaea717ac4ab9afaaddbf6100521ad461bb24dedec7329defc83b71a4d98ed2e544cfa3a8f760bffbe540dca2a8b97cf44aa74343aec8
+  metadata.gz: 0d08e4fdb06b68f8d624e4c9f11287b50569de46ca8ff220bb899fd454600f131b6bd27b8482a6521d30c9a7beca02bbd6b820af4c4c3197ad45469a33b3e0a1
+  data.tar.gz: 6cc08418acf93e855bb3445869be51e0903c000fcb025a0d773f82d3fc3e6f72606a33bea333440c9211393fbebd30b3ac367ce5e71f501c2f70c0c1dc70e340

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Block, Inc.
+Copyright (c) 2024 - 2025 Block, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/elastic_graph/cli.rb

@@ -1,4 +1,4 @@
-# Copyright 2024 Block, Inc.
+# 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
@@ -28,7 +28,7 @@ module ElasticGraph
     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)
+      new_app_path = ::File.absolute_path?(app_path) ? app_path : ::File.join(::Dir.pwd, app_path)
       app_name = ::File.basename(new_app_path)
 
       unless app_name.match?(/\A[a-z][a-z0-9_]+\z/)
@@ -39,11 +39,25 @@ module ElasticGraph
         raise ::Thor::Error, "Invalid datastore option: #{options[:datastore]}. Must be #{VALID_DATASTORES.join(" or ")}."
       end
 
+      # This determines where the ElasticGraph gems are sourced from. By default, we source them from the
+      # released gems (using the current `VERSION`). However, we also need to be able to use the local
+      # unreleased gems in some specific situations:
+      #
+      # - From our cli acceptance spec -- we want to test against our local gems, not the released gems.
+      # - From our Dockerfile -- we want it to build the docker image from our local gems.
+      gemfile_elasticgraph_details_code_snippet = %(["#{VERSION}"])
+      if (eg_gems_path = ENV["ELASTICGRAPH_GEMS_PATH"])
+        gemfile_elasticgraph_details_code_snippet = %([path: "#{eg_gems_path}"])
+        # :nocov: -- our tests always override `gemfile_elasticgraph_details_code_snippet` using the ENV var.
+      else
+        # :nocov:
+      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}"])
+        gemfile_elasticgraph_details_code_snippet: gemfile_elasticgraph_details_code_snippet
       )
 
       say "Creating a new #{setup_env.datastore_name} ElasticGraph project called '#{app_name}' at: #{new_app_path}", :green

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

@@ -61,10 +61,10 @@ bundle exec rake -T
 bundle exec rake boot_locally
 
 # The GraphiQL UI should open automatically
-open http://localhost:9393/
+open http://localhost:9000/
 
 # You can also visit <%= ElasticGraph.setup_env.datastore_ui_name %> via:
-open http://localhost:19293/
+open http://localhost:19200/
 ```
 
 ### Run Build Tasks
@@ -108,7 +108,7 @@ If you use a `:daemon` task, you can later use the corresponding `:halt` task to
 ### 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.
+(`open http://localhost:9000/`). Using it you can query your ElasticGraph cluster using GraphQL.
 
 ### Seeding Fake Data
 
@@ -119,7 +119,7 @@ You can pass an arg (note quotes) to seed more batches of data:
 ### 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.
+`open http://localhost:19200/` click "Dev Tools" to open the <%= ElasticGraph.setup_env.datastore_name %> console.
 
 Here are some queries to get you started:
 

data/lib/elastic_graph/project_template/Rakefile.tt

@@ -43,7 +43,7 @@ ElasticGraph::Local::RakeTasks.new(
 
   # 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)
+    <%= ElasticGraph.setup_env.app_module %>::FakeDataBatchGenerator.generate(venues: 100)
   end
 end
 
@@ -62,3 +62,6 @@ 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]
+
+# Make `rake` run `rake build` for convenience.
+task default: :build

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

@@ -1,10 +1,32 @@
 # TODO: replace this file with one that defines the schema for your own dataset.
 ElasticGraph.define_schema do |schema|
+  schema.enum_type "MusicGenre" do |t|
+    t.value "ALTERNATIVE"
+    t.value "BLUES"
+    t.value "BLUEGRASS"
+    t.value "CLASSICAL"
+    t.value "COUNTRY"
+    t.value "ELECTRONIC"
+    t.value "FOLK"
+    t.value "HIP_HOP"
+    t.value "INDIE"
+    t.value "JAZZ"
+    t.value "METAL"
+    t.value "POP"
+    t.value "PUNK"
+    t.value "REGGAE"
+    t.value "RNB"
+    t.value "ROCK"
+    t.value "SKA"
+    t.value "SOUL"
+  end
+
   schema.object_type "Artist" do |t|
     t.field "id", "ID"
     t.field "name", "String"
     t.field "lifetimeSales", "JsonSafeLong"
     t.field "bio", "ArtistBio"
+    t.field "genres", "[MusicGenre!]!"
 
     t.field "albums", "[Album!]!" do |f|
       f.mapping type: "nested"

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

@@ -5,7 +5,7 @@ datastore:
   clusters:
     main:
       backend: <%= ElasticGraph.setup_env.datastore %>
-      url: http://localhost:9293
+      url: http://localhost:9200
       settings: {}
   index_definitions:
     # TODO: replace the `artists:` and `venues:` keys with the indices from your dataset

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

@@ -1,3 +1,4 @@
+require "digest/md5"
 require "factory_bot"
 require "faker"
 require_relative "shared_factories"
@@ -6,20 +7,37 @@ require_relative "shared_factories"
 FactoryBot.define do
   factory :artist, parent: :indexed_type_base do
     __typename { "Artist" }
+    # Prevent multiple artists with the same name by hashing the name to produce the id.
+    id { Digest::MD5.hexdigest(name) }
+
     name { Faker::Music.band }
 
     lifetimeSales do
       albums.map { |a| a.fetch(:soldUnits) }.sum
     end
 
-    bio { build(:artist_bio) }
+    bio { build(:artist_bio, artistName: name) }
+
+    genres do
+      # Available genres from the MusicGenre enum
+      all_genres = %w[
+        ALTERNATIVE BLUES BLUEGRASS CLASSICAL COUNTRY ELECTRONIC FOLK HIP_HOP
+        INDIE JAZZ METAL POP PUNK REGGAE RNB ROCK SKA SOUL
+      ]
+
+      # Pick 1-3 random genres
+      Faker::Base.sample(all_genres, Faker::Number.between(from: 1, to: 3)).uniq
+    end
 
     albums do
-      Faker::Number.between(from: 1, to: 10).times.map { build(:album) }
+      Faker::Number.between(from: 1, to: 6).times.map { build(:album) }
     end
 
     tours do
-      Faker::Number.between(from: 0, to: 8).times.map { build(:tour, venueIds: venueIds) }
+      Faker::Number.between(from: 0, to: 4).times.map do
+        song = Faker::Base.sample(albums.flat_map { |a| a.fetch(:tracks).map { |t| t.fetch(:name) } })
+        build(:tour, venueIds: venueIds, name: "The #{song} Tour")
+      end
     end
 
     transient do
@@ -31,16 +49,76 @@ FactoryBot.define do
     __typename { "ArtistBio" }
     yearFormed { Faker::Number.between(from: 1900, to: 2025) }
     homeCountry { Faker::Address.country }
-    description { Faker::Lorem.paragraphs(number: 3).join("\n\n") }
+    description do
+      # Generate a realistic artist bio by combining multiple sentences
+      year = yearFormed
+
+      # Common adjectives for music descriptions
+      adjectives = [
+        "innovative", "groundbreaking", "distinctive", "masterful", "energetic",
+        "soulful", "dynamic", "melodic", "haunting", "powerful", "ethereal",
+        "raw", "polished", "intricate", "atmospheric", "intense", "virtuosic"
+      ].shuffle
+
+      # Musical elements for variety
+      musical_elements = [
+        "harmonies", "compositions", "arrangements", "rhythms", "melodies",
+        "songwriting", "instrumentation", "productions", "performances", "vocals"
+      ].shuffle
+
+      genres = Faker::Base.sample(Faker::Base.translate("faker.music.genres"), 20)
+      instruments = Faker::Base.sample(Faker::Base.translate("faker.music.instruments"), 20).map(&:downcase)
+
+      # Origin story variants
+      origin = [
+        "#{artistName} was formed in #{year} in #{homeCountry}.",
+        "Emerging from #{homeCountry}'s #{genres.pop.downcase} scene in #{year}, #{artistName} began their musical journey.",
+        "Founded in #{homeCountry} in #{year}, #{artistName} started as a collective of #{genres.pop.downcase} musicians.",
+        "The story of #{artistName} began in #{year} when a group of musicians in #{homeCountry} came together."
+      ].sample
+
+      # Musical style variants
+      style = [
+        "Drawing inspiration from #{genres.pop} and #{genres.pop}, they developed a sound featuring #{instruments.pop}, #{instruments.pop}, #{instruments.pop}, and #{instruments.pop}.",
+        "Their #{adjectives.pop} style blends elements of #{genres.pop} with #{genres.pop}, creating a unique musical identity centered on their #{adjectives.pop} #{instruments.pop} and #{instruments.pop} counterpoint.",
+        "Known for their #{adjectives.pop} #{musical_elements.pop}, they combine #{instruments.pop} and #{instruments.pop} with #{adjectives.pop} #{instruments.pop} and #{adjectives.pop} #{instruments.pop} arrangements.",
+        "Their music explores the intersection of #{instruments.pop} #{genres.pop} and #{instruments.pop} #{genres.pop}, highlighted by #{adjectives.pop} #{musical_elements.pop}."
+      ].sample
+
+      # Career highlight variants
+      highlight_year = year + rand(2..5)
+      highlight = [
+        "Their breakthrough came with '#{Faker::Music.album}' in #{highlight_year}, which showcased their #{adjectives.pop} style.",
+        "The release of '#{Faker::Music.album}' in #{highlight_year} marked a turning point, earning critical acclaim for its #{adjectives.pop} #{musical_elements.pop}.",
+        "#{highlight_year} saw the release of their defining work '#{Faker::Music.album}', which demonstrated their #{adjectives.pop} approach to #{musical_elements.pop}.",
+        "With the #{adjectives.pop} '#{Faker::Music.album}' in #{highlight_year}, they established themselves as pioneers in #{genres.pop.downcase}."
+      ].sample
+
+      # Legacy/impact variants
+      legacy = [
+        "They continue to influence the music scene with their #{adjectives.pop} approach to #{musical_elements.pop}.",
+        "Their #{adjectives.pop} contributions to #{genres.pop.downcase} have left a lasting impact on the genre.",
+        "To this day, their #{adjectives.pop} #{musical_elements.pop} continue to inspire new generations of musicians.",
+        "They remain celebrated for their #{adjectives.pop} live performances and #{adjectives.pop} #{musical_elements.pop}.",
+        "Their influence on #{genres.pop.downcase} endures through their #{adjectives.pop} body of work.",
+        "Artists today still draw inspiration from their #{adjectives.pop} approach to #{musical_elements.pop}."
+      ].sample
+
+      [origin, style, highlight, legacy].join(" ")
+    end
+
+    transient do
+      artistName { raise "`artistName` must be provided." }
+    end
   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 }
+    releasedOn { Faker::Date.between(from: "1950-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|
+      Faker::Number.between(from: 1, to: 15).times.map do |index|
         build(:album_track, trackNumber: index + 1)
       end
     end
@@ -57,9 +135,9 @@ FactoryBot.define do
     __typename { "Tour" }
     name { "#{Faker::Music::RockBand.song} Tour" }
     shows do
-      start_date = Faker::Date.between(from: "1900-01-01", to: "2025-12-31")
+      start_date = Faker::Date.between(from: "1950-01-01", to: "2025-12-31")
 
-      Faker::Number.between(from: 3, to: 200).times.map do |index|
+      Faker::Number.between(from: 3, to: 30).times.map do |index|
         venue_id = Faker::Base.sample(venueIds)
         build(:show, date: start_date + index, venueId: venue_id)
       end
@@ -77,7 +155,7 @@ FactoryBot.define do
     venueId { nil }
 
     transient do
-      date { Faker::Date.between(from: "1900-01-01", to: "2025-12-31") }
+      date { Faker::Date.between(from: "1950-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

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

@@ -2,11 +2,15 @@ require_relative "factories"
 
 module <%= ElasticGraph.setup_env.app_module %>
   module FakeDataBatchGenerator
-    def self.generate(artists:, venues:)
-      venue_list = FactoryBot.build_list(:venue, venues)
+    def self.generate(venues:)
+      venue_list = FactoryBot.build_list(:venue, venues - 1) + [FactoryBot.build(:venue, name: nil)]
       venue_ids = venue_list.map { |v| v.fetch(:id) }
 
-      artist_list = FactoryBot.build_list(:artist, artists, venueIds: venue_ids)
+      # Make one artist per unique name available via Faker.
+      artist_names = ::Faker::Base.translate("faker.music.bands") + ::Faker::Base.translate("faker.rock_band.name")
+      artist_list = artist_names.uniq.map do |name|
+        FactoryBot.build(:artist, name: name, venueIds: venue_ids)
+      end
 
       venue_list + artist_list
     end

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

@@ -1,6 +1,6 @@
-require "date"
 require "factory_bot"
 require "faker"
+require "yaml"
 
 FactoryBot.define do
   factory :hash_base, class: Hash do
@@ -12,7 +12,8 @@ FactoryBot.define do
   end
 
   trait :versioned do
-    __version { Faker::Number.between(from: 1, to: 10) }
+    # Use the current time as the version so that newly generated records always "win" over previously indexed records.
+    __version { Time.now.to_i }
   end
 
   current_json_schema_version = nil

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

@@ -13,7 +13,11 @@ RSpec.describe "ElasticGraph project" do
 
   # 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)
+    batch = <%= ElasticGraph.setup_env.app_module %>::FakeDataBatchGenerator.generate(venues: 5)
+
+    expect(batch.map { |r| r.fetch(:__typename) }.tally).to match({
+      "Artist" => a_value > 100,
+      "Venue" => 5
+    })
   end
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph
 version: !ruby/object:Gem::Version
-  version: 0.19.1.1
+  version: 0.19.2.0
 platform: ruby
 authors:
 - Myron Marston
 - Ben VandenBos
 - Block Engineering
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticgraph-support
@@ -18,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.1
+        version: 0.19.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.1.1
+        version: 0.19.2.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -33,6 +32,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -40,7 +42,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 email:
 - myron@squareup.com
 executables:
@@ -71,12 +75,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v0.19.1.1
-  documentation_uri: https://block.github.io/elasticgraph/docs/main/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v0.19.2.0
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v0.19.2.0/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v0.19.1.1/elasticgraph
-  gem_category: core
-post_install_message:
+  source_code_uri: https://github.com/block/elasticgraph/tree/v0.19.2.0/elasticgraph
+  gem_category: local
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Bootstraps ElasticGraph projects.
 test_files: []