shopify_toolkit 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b8574729a741fe496f0377291bf3a93c0bf25df56aa03b9b37f5694e9161f8a
-  data.tar.gz: a38af4ad93e5b3dd0e18694b4627c5d220b73bddf657d22b1a23ffe87268c9da
+  metadata.gz: 7e5e83e71a4d7f6e6d0d8746e307076e7908f4e6c03d28820e99fde10557c6ba
+  data.tar.gz: c9d9bce64d5af477e1e46a18dc18b175088fde22288c2d97e935c495f06beb42
 SHA512:
-  metadata.gz: f1b5bc3beb644866a7110b0f8bebc531e310a7f3e2bdf25ab89da50bcd3741de7d7f082af0e180371e64108bfbdbb1efb5b38ff7f4dc50a26c8b8eb51898b406
-  data.tar.gz: 6a6b7dfdd94a7bae0480d801f685a1fb0f62999be5ad2024b21d8833c6bd72065545f514587986df53ba67a384d61f3f0cb0c6669e171a94769e7f90b02dbe60
+  metadata.gz: 7c39acdbf5c2b15e1b0c5276aefd65063857bae0da5431b9a929b55d2d8fe51517ba40c71ffe508ddda2100965c378f9a99c494de398afc906cfdb5674e65b7c
+  data.tar.gz: cfa96c9301a1502eb02ba5fb5c854ffa8a5e72a4960910ba17cd82d475c9edeeab39989fe5d5f6c879b94b7f55835be6e334100cec24304ba1a56621e0fb5faa

data/lib/shopify_toolkit/schema.rb

@@ -8,7 +8,37 @@ module ShopifyToolkit::Schema
   extend self
   include ShopifyToolkit::MetafieldStatements
   include ShopifyToolkit::Migration::Logging
+
+  delegate :logger, to: Rails
+
   SCHEMA_PATH = "config/shopify/schema.rb"
+  # https://shopify.dev/docs/api/admin-graphql/2024-10/enums/MetafieldOwnerType
+  OWNER_TYPES = %i[
+    api_permissions
+    articles
+    blogs
+    carttransforms
+    collections
+    companies
+    company_locations
+    customers
+    delivery_customizations
+    discounts
+    draftorders
+    fulfillment_constraint_rules
+    gift_card_transactions
+    locations
+    markets
+    orders
+    order_routing_location_rules
+    pages
+    payment_customizations
+    products
+    productvariants
+    selling_plans
+    shops
+    validations
+  ].freeze
 
   def load!
     path = Rails.root.join(SCHEMA_PATH)
@@ -38,10 +68,12 @@ module ShopifyToolkit::Schema
     instance_eval(&block)
   end
 
-  def fetch_definitions
+  def fetch_definitions(owner_type:)
+    owner_type = owner_type.to_s.singularize.upcase
+
     query = <<~GRAPHQL
       query {
-        metafieldDefinitions(first: 250, ownerType: PRODUCT) {
+        metafieldDefinitions(first: 250, ownerType: #{owner_type}) {
           nodes {
             id
             name
@@ -74,57 +106,71 @@ module ShopifyToolkit::Schema
       }
     GRAPHQL
 
-    result = shopify_admin_client.query(query:).tap { handle_shopify_admin_client_errors(_1) }.body
+    result =
+      shopify_admin_client
+        .query(query:)
+        .tap { handle_shopify_admin_client_errors(_1) }
+        .body
 
     result.dig("data", "metafieldDefinitions", "nodes") || []
   end
 
   def generate_schema_content
-    definitions = fetch_definitions
+    definitions =
+      OWNER_TYPES.flat_map { |owner_type| fetch_definitions(owner_type:) }
+
     content = StringIO.new
     content << <<~RUBY
-        # This file is auto-generated from the current state of the Shopify metafields.
-        # Instead of editing this file, please use the metafields migration feature of ShopifyToolkit
-        # to incrementally modify your metafields, and then regenerate this schema definition.
-        #
-        # This file is the source used to define your metafields when running `bin/rails shopify:schema:load`.
-        #
-        # It's strongly recommended that you check this file into your version control system.
-        ShopifyToolkit::Schema.define do
-      RUBY
-
-    definitions.each do |defn|
-      owner_type = defn["ownerType"].downcase.pluralize.to_sym
-      key = defn["key"].to_sym
-      type = defn["type"]["name"].to_sym
-      name = defn["name"]
-      namespace = defn["namespace"]&.to_sym
-      description = defn["description"]
-      validations = defn["validations"]&.map { |v| v.transform_keys(&:to_sym) }
-      capabilities = defn["capabilities"]&.transform_keys(&:to_sym)&.transform_values { |v| v.transform_keys(&:to_sym) }
-
-      args = [owner_type, key, type]
-      kwargs = { name: name }
-      kwargs[:namespace] = namespace if namespace && namespace != :custom
-      kwargs[:description] = description if description
-      kwargs[:validations] = validations if validations.present?
-
-      # Only include capabilities if they have non-default values
-      if capabilities.present?
-        has_non_default_capabilities =
-          capabilities.any? do |cap, value|
-            case cap
-            when :smartCollectionCondition, :adminFilterable
-              value[:enabled] == true
-            else
-              true
+      # This file is auto-generated from the current state of the Shopify metafields.
+      # Instead of editing this file, please use the metafields migration feature of ShopifyToolkit
+      # to incrementally modify your metafields, and then regenerate this schema definition.
+      #
+      # This file is the source used to define your metafields when running `bin/rails shopify:schema:load`.
+      #
+      # It's strongly recommended that you check this file into your version control system.
+      ShopifyToolkit::Schema.define do
+    RUBY
+
+    # Sort for consistent output
+    definitions
+      .sort_by { [_1["ownerType"], _1["namespace"], _1["key"]] }
+      .each do
+        owner_type = _1["ownerType"].downcase.pluralize.to_sym
+        key = _1["key"].to_sym
+        type = _1["type"]["name"].to_sym
+        name = _1["name"]
+        namespace = _1["namespace"]&.to_sym
+        description = _1["description"]
+        validations = _1["validations"]&.map { |v| v.transform_keys(&:to_sym) }
+        capabilities =
+          _1["capabilities"]
+            &.transform_keys(&:to_sym)
+            &.transform_values { |v| v.transform_keys(&:to_sym) }
+
+        args = [owner_type, key, type]
+        kwargs = { name: name }
+        kwargs[:namespace] = namespace if namespace && namespace != :custom
+        kwargs[:description] = description if description
+        kwargs[:validations] = validations if validations.present?
+
+        # Only include capabilities if they have non-default values
+        if capabilities.present?
+          has_non_default_capabilities =
+            capabilities.any? do |cap, value|
+              case cap
+              when :smartCollectionCondition, :adminFilterable
+                value[:enabled] == true
+              else
+                true
+              end
             end
-          end
-        kwargs[:capabilities] = capabilities if has_non_default_capabilities
-      end
+          kwargs[:capabilities] = capabilities if has_non_default_capabilities
+        end
 
-      content.puts "  create_metafield #{args.map(&:inspect).join(", ")}, #{kwargs.map { |k, v| "#{k}: #{v.inspect}" }.join(", ")}"
-    end
+        args_string = args.map(&:inspect).join(", ")
+        kwargs_string = kwargs.map { |k, v| "#{k}: #{v.inspect}" }.join(", ")
+        content.puts "  create_metafield #{args_string}, #{kwargs_string}"
+      end
 
     content.puts "end"
     content.string

data/lib/shopify_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShopifyToolkit
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Elia Schito
 - Nebulab Team
 bindir: exe
 cert_chain: []
-date: 2025-04-14 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties