shopify_toolkit 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e21a90f2ee3abbe3ca01f52a8b3f559437d357e41e649d2351a5740c83dfcb1c
-  data.tar.gz: 5e731cba7ace9bf63e2e68203efe6a12db03642a2fbe88d3db34ed91cc903450
+  metadata.gz: 5b5096d0e8a69b382a17ac046866f2386e2c1b06cf5b8c657138dafc1efef67b
+  data.tar.gz: 85d2b5e79156013fcd95a8aa35e21eb6db331d287ffab98d3cfc759ca76f1e98
 SHA512:
-  metadata.gz: 87dd02b8491e762cf1e3ffa8e2cada8b8c243d921b35e69f7978dad66d333fe767b463b61e9920600bfbd312c438734342adc6306d656efe07efa63bab918b83
-  data.tar.gz: e1a5daad1b1dd2f8239f8e2c45b5b988c8864a9536533656fc76a66cd7c420df9be66bc441f58e5a1786019bac4d284e515367d6aa3d1b3ce672f0354023fdbc
+  metadata.gz: 3eeed116a762958bc570bc258f7b22982130becad873278303249b1fddb29fc807ffe1ebbac00f8cff2d96602389e7a39f4a980cdfe97c9bb61cc54c92e38e09
+  data.tar.gz: b7b6f2de4725cc821bfd3f7c6fdac9172491ddfd7b8b70d89ab1c73707608c8b52afb150b50a2bb835e3d107586b19ba976d0526ea0b74bd6d8ca2c89debe0ff

data/README.md

@@ -2,6 +2,12 @@
 
 A toolkit for working with Custom Shopify Apps built on Rails.
 
+### Assumptions
+
+- You are using Rails 7.0 or later
+- The custom app is only installed on a single store
+- In order for the schema dump/load to work, you need to have the `shopify_app` gem installed and configured
+
 ## Features/Roadmap
 
 - [x] Shopify/Matrixify CSV tools

data/exe/shopify-toolkit

@@ -54,6 +54,18 @@ class ShopifyToolkit::CommandLine < Thor
     IRB.conf[:IRB_NAME] = basename
     Result.class_eval { binding.irb(show_code: false) }
   end
+
+  desc "schema_load", 'Load schema from "config/shopify/schema.rb"'
+  def schema_load
+    require "./config/environment"
+    ::Shop.sole.with_shopify_session { ShopifyToolkit::Schema.load! }
+  end
+
+  desc "schema_dump", 'Dump schema to "config/shopify/schema.rb"'
+  def schema_dump
+    require "./config/environment"
+    ::Shop.sole.with_shopify_session { ShopifyToolkit::Schema.dump! }
+  end
 end
 
 ShopifyToolkit::CommandLine.start(ARGV)

data/lib/shopify_toolkit/metafield_statements.rb

@@ -101,8 +101,8 @@ module ShopifyToolkit::MetafieldStatements
       .tap { handle_shopify_admin_client_errors(_1, "metafieldDefinitionDelete.userErrors") }
   end
 
-  def update_metafield(owner_type, key, namespace: :custom, **options)
   log_time \
+  def update_metafield(owner_type, key, namespace: :custom, **options)
     shopify_admin_client
       .query(
         # Documentation: https://shopify.dev/docs/api/admin-graphql/2024-10/mutations/metafieldDefinitionUpdate

data/lib/shopify_toolkit/migration/logging.rb

@@ -6,9 +6,8 @@ module ShopifyToolkit::Migration::Logging
   end
 
   def announce(message)
-    text = "#{version} #{name}: #{message}"
-    length = [0, 75 - text.length].max
-    write "== %s %s" % [text, "=" * length]
+    length = [0, 75 - message.length].max
+    write "== %s %s" % [message, "=" * length]
   end
 
   # Takes a message argument and outputs it as is.

data/lib/shopify_toolkit/schema.rb

@@ -0,0 +1,116 @@
+module ShopifyToolkit::Schema
+  extend self
+  include ShopifyToolkit::MetafieldStatements
+  include ShopifyToolkit::Migration::Logging
+  SCHEMA_PATH = "config/shopify/schema.rb"
+
+  def load!
+    path = Rails.root.join(SCHEMA_PATH)
+
+    unless path.exist?
+      logger.warn "Schema file not found at #{path}."
+      return
+    end
+
+    announce "Loading metafield schema from #{path}"
+    say_with_time "Executing schema statements" do
+      load path
+    end
+  end
+
+  def dump!
+    schema_path = Rails.root.join(SCHEMA_PATH)
+
+    announce "Dumping metafield schema to #{schema_path}"
+    say_with_time "Generating schema" do
+      content = generate_schema_content
+      File.write(schema_path, content)
+    end
+  end
+
+  def define(&block)
+    instance_eval(&block)
+  end
+
+  def fetch_definitions
+    query = <<~GRAPHQL
+      query {
+        metafieldDefinitions(first: 250, ownerType: PRODUCT) {
+          nodes {
+            id
+            name
+            key
+            type {
+              name
+            }
+            namespace
+            description
+            validations {
+              name
+              value
+            }
+            capabilities {
+              smartCollectionCondition {
+                enabled
+              }
+              adminFilterable {
+                enabled
+              }
+            }
+            access {
+              admin
+              customerAccount
+              storefront
+            }
+            ownerType
+          }
+        }
+      }
+    GRAPHQL
+
+    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
+    content = ["ShopifyToolkit::Schema.define do"]
+
+    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
+            end
+          end
+        kwargs[:capabilities] = capabilities if has_non_default_capabilities
+      end
+
+      content << "  create_metafield #{args.map(&:inspect).join(", ")}, #{kwargs.map { |k, v| "#{k}: #{v.inspect}" }.join(", ")}"
+    end
+
+    content << "end"
+    content.join("\n")
+  end
+end

data/lib/shopify_toolkit/version.rb

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

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: shopify_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Elia Schito
 - Nebulab Team
 bindir: exe
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +110,7 @@ files:
 - lib/shopify_toolkit/admin_client.rb
 - lib/shopify_toolkit/metafield_statements.rb
 - lib/shopify_toolkit/migration/logging.rb
+- lib/shopify_toolkit/schema.rb
 - lib/shopify_toolkit/version.rb
 - sig/shopify_toolkit.rbs
 homepage: https://github.com/nebulab/shopify_toolkit?tab=readme-ov-file#readme