shopify-cli 1.4.1 → 1.8.0

data/lib/project_types/extension/models/lazy_specification_handler.rb

@@ -0,0 +1,12 @@
+module Extension
+  module Models
+    class LazySpecificationHandler < ShopifyCli::LazyDelegator
+      attr_reader :identifier
+
+      def initialize(identifier, &specification_handler_initializer)
+        super(&specification_handler_initializer)
+        @identifier = identifier
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/specification.rb

@@ -0,0 +1,37 @@
+module Extension
+  module Models
+    class Specification
+      include SmartProperties
+
+      module Features
+        class Argo
+          include SmartProperties
+
+          property! :surface, converts: :to_str
+          property! :renderer_package_name, converts: :to_str
+          property! :git_template, converts: :to_str
+        end
+
+        def self.build(feature_set_attributes)
+          feature_set_attributes.each_with_object(OpenStruct.new) do |(identifier, feature_attributes), feature_set|
+            feature_set[identifier] = ShopifyCli::ResolveConstant
+              .call(identifier, namespace: Features)
+              .rescue { OpenStruct }
+              .then { |c| c.new(**feature_attributes) }
+              .unwrap { |error| raise(error) }
+          end
+        end
+      end
+
+      property! :identifier
+      property :name, converts: :to_str
+      property :graphql_identifier, converts: :to_str
+      property! :features, converts: Features.method(:build), default: -> { [] }
+      property! :options, converts: ->(options) { OpenStruct.new(options) }, default: -> { OpenStruct.new }
+
+      def graphql_identifier
+        super || identifier
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/specification_handlers/checkout_post_purchase.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require "base64"
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class CheckoutPostPurchase < Default
+        PERMITTED_CONFIG_KEYS = [:metafields]
+
+        def config(context)
+          {
+            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
+            **argo.config(context),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/specification_handlers/default.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class Default
+        attr_reader :specification
+
+        def initialize(specification)
+          @specification = specification
+        end
+
+        def identifier
+          specification.identifier.to_s.upcase
+        end
+
+        def graphql_identifier
+          specification.graphql_identifier.to_s.upcase
+        end
+
+        def name
+          message("name") || specification.name
+        end
+
+        def tagline
+          message("tagline") || ""
+        end
+
+        def config(context)
+          argo.config(context)
+        end
+
+        def create(directory_name, context)
+          argo.create(directory_name, identifier, context)
+        end
+
+        def extension_context(_context)
+          nil
+        end
+
+        def valid_extension_contexts
+          []
+        end
+
+        protected
+
+        def argo
+          Features::Argo.new(
+            git_template: specification.features.argo.git_template,
+            renderer_package_name: specification.features.argo.renderer_package_name,
+          )
+        end
+
+        private
+
+        def message(key, *params)
+          return unless messages.key?(key.to_sym)
+          messages[key.to_sym] % params
+        end
+
+        def messages
+          @messages ||= Messages::TYPES[identifier.downcase.to_sym] || {}
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/specifications.rb

@@ -0,0 +1,88 @@
+module Extension
+  module Models
+    class Specifications
+      include SmartProperties
+
+      property! :custom_handler_root,
+        accepts: ->(d) { File.directory?(d) },
+        default: -> { File.expand_path("lib/project_types/extension/models/specification_handlers", ShopifyCli::ROOT) }
+
+      property! :custom_handler_namespace,
+        accepts: ->(m) { m.respond_to?(:const_get) },
+        default: -> { ::Extension::Models::SpecificationHandlers }
+
+      property! :fetch_specifications,
+        accepts: ->(p) { p.respond_to?(:to_proc) }
+
+      def [](identifier)
+        handlers[identifier]
+      end
+
+      def valid?(identifier)
+        handlers.key?(identifier)
+      end
+
+      def each(&block)
+        handlers.values.each(&block)
+      end
+
+      def none?
+        each.none?
+      end
+
+      protected
+
+      def handlers
+        @handlers ||= fetch_specifications_and_build_handlers
+      end
+
+      private
+
+      def fetch_specifications_and_build_handlers
+        ShopifyCli::Result
+          .call(&fetch_specifications)
+          .map(&ShopifyCli::TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
+          .then(&method(:select_cli_extensions))
+          .then(&Tasks::ConfigureFeatures)
+          .then(&method(:ensure_legacy_compatibility))
+          .then(&method(:build_specifications))
+          .then(&method(:require_handler_implementations))
+          .then(&method(:instantiate_specification_handlers))
+          .unwrap { |err| raise err }
+      end
+
+      def require_handler_implementations(specifications)
+        specifications.each do |s|
+          implementation_file = File.join(custom_handler_root, "#{s.identifier}.rb")
+          require(implementation_file) if File.file?(implementation_file)
+        end
+      end
+
+      def instantiate_specification_handlers(specifications)
+        specifications.each_with_object({}) do |specification, handlers|
+          ShopifyCli::ResolveConstant.call(specification.identifier, namespace: custom_handler_namespace)
+            .rescue { |error| error.is_a?(NameError) ? SpecificationHandlers::Default : raise(error) }
+            .then { |handler_class| handler_class.new(specification) }
+            .unwrap { |error| raise error }
+            .yield_self { |handler| handlers[handler.identifier] = handler }
+        end
+      end
+
+      def ensure_legacy_compatibility(specification_attribute_sets)
+        specification_attribute_sets.each do |attributes|
+          next unless attributes.fetch(:identifier) == "subscription_management"
+          attributes[:identifier] = "product_subscription"
+          attributes[:graphql_identifier] = "SUBSCRIPTION_MANAGEMENT"
+        end
+      end
+
+      def build_specifications(specification_attribute_sets)
+        specification_attribute_sets.map { |attributes| Models::Specification.new(**attributes) }
+      end
+
+      def select_cli_extensions(specification_attribute_sets)
+        specification_attribute_sets.select { |attributes| attributes.dig(:options, :management_experience) == "cli" }
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/configure_features.rb

@@ -0,0 +1,52 @@
+module Extension
+  module Tasks
+    class ConfigureFeatures
+      include ShopifyCli::MethodObject
+
+      class Error < RuntimeError; end
+      class UnknownSurfaceArea < Error; end
+      class UnspecifiedSurfaceArea < Error; end
+
+      def call(specification_attribute_sets)
+        specification_attribute_sets.each do |attributes|
+          argo_configuration = extract_argo_configuration(attributes)
+          next if argo_configuration.nil?
+          surface_area = extract_surface_area(argo_configuration)
+          surface_area_configuration = fetch_surface_area_configuration(surface_area)
+          argo_configuration.merge!(surface_area_configuration)
+        end
+      end
+
+      private
+
+      def extract_argo_configuration(attributes)
+        attributes.dig(:features, :argo)
+      end
+
+      def extract_surface_area(argo_configuration)
+        argo_configuration.fetch(:surface) do
+          raise UnspecifiedSurfaceArea, "Argo configuration does not specify surface area"
+        end
+      end
+
+      def fetch_surface_area_configuration(surface_area)
+        surface_area_configurations.fetch(surface_area.to_sym) do
+          raise UnknownSurfaceArea, "Unknown surface area: #{surface_area}"
+        end
+      end
+
+      def surface_area_configurations
+        {
+          admin: {
+            git_template: "https://github.com/Shopify/argo-admin-template.git",
+            renderer_package_name: "@shopify/argo-admin",
+          },
+          checkout: {
+            git_template: "https://github.com/Shopify/argo-checkout-template.git",
+            renderer_package_name: "@shopify/argo-checkout",
+          },
+        }
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/converters/app_converter.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Tasks
     module Converters
       module AppConverter
-        API_KEY_FIELD = 'apiKey'
-        API_SECRET_KEYS_FIELD = 'apiSecretKeys'
-        API_SECRET_FIELD = 'secret'
-        TITLE_FIELD = 'title'
-        ORGANIZATION_NAME_FIELD = 'businessName'
+        API_KEY_FIELD = "apiKey"
+        API_SECRET_KEYS_FIELD = "apiSecretKeys"
+        API_SECRET_FIELD = "secret"
+        TITLE_FIELD = "title"
+        ORGANIZATION_NAME_FIELD = "businessName"
 
         def self.from_hash(hash, organization = {})
           return nil if hash.nil?

data/lib/project_types/extension/tasks/converters/registration_converter.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Tasks
     module Converters
       module RegistrationConverter
-        ID_FIELD = 'id'
-        TYPE_FIELD = 'type'
-        TITLE_FIELD = 'title'
-        DRAFT_VERSION_FIELD = 'draftVersion'
+        ID_FIELD = "id"
+        TYPE_FIELD = "type"
+        TITLE_FIELD = "title"
+        DRAFT_VERSION_FIELD = "draftVersion"
 
         def self.from_hash(context, hash)
-          context.abort(context.message('tasks.errors.parse_error')) if hash.nil?
+          context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
 
           Models::Registration.new(
             id: hash[ID_FIELD].to_i,

data/lib/project_types/extension/tasks/converters/validation_error_converter.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Tasks
     module Converters
       module ValidationErrorConverter
-        FIELD_FIELD = 'field'
-        MESSAGE_FIELD = 'message'
+        FIELD_FIELD = "field"
+        MESSAGE_FIELD = "message"
 
         def self.from_array(context, errors)
           return [] if errors.nil?
-          context.abort(context.message('tasks.errors.parse_error')) unless errors.is_a?(Array)
+          context.abort(context.message("tasks.errors.parse_error")) unless errors.is_a?(Array)
 
           errors.map do |error|
             Models::ValidationError.new(

data/lib/project_types/extension/tasks/converters/version_converter.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Tasks
     module Converters
       module VersionConverter
-        REGISTRATION_ID_FIELD = 'registrationId'
-        CONTEXT_FIELD = 'context'
-        LAST_USER_INTERACTION_AT_FIELD = 'lastUserInteractionAt'
-        LOCATION_FIELD = 'location'
-        VALIDATION_ERRORS_FIELD = 'validationErrors'
+        REGISTRATION_ID_FIELD = "registrationId"
+        CONTEXT_FIELD = "context"
+        LAST_USER_INTERACTION_AT_FIELD = "lastUserInteractionAt"
+        LOCATION_FIELD = "location"
+        VALIDATION_ERRORS_FIELD = "validationErrors"
 
         def self.from_hash(context, hash)
-          context.abort(context.message('tasks.errors.parse_error')) if hash.nil?
+          context.abort(context.message("tasks.errors.parse_error")) if hash.nil?
 
           Models::Version.new(
             registration_id: hash[REGISTRATION_ID_FIELD].to_i,

data/lib/project_types/extension/tasks/create_extension.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Tasks
     class CreateExtension < ShopifyCli::Task
       include UserErrors
 
-      GRAPHQL_FILE = 'extension_create'
+      GRAPHQL_FILE = "extension_create"
 
       RESPONSE_FIELD = %w(data extensionCreate)
-      REGISTRATION_FIELD = 'extensionRegistration'
+      REGISTRATION_FIELD = "extensionRegistration"
 
       def call(context:, api_key:, type:, title:, config:, extension_context: nil)
         input = {
@@ -21,7 +21,7 @@ module Extension
         }
 
         response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
-        context.abort(context.message('tasks.errors.parse_error')) if response.nil?
+        context.abort(context.message("tasks.errors.parse_error")) if response.nil?
 
         abort_if_user_errors(context, response)
         Converters::RegistrationConverter.from_hash(context, response.dig(REGISTRATION_FIELD))

data/lib/project_types/extension/tasks/fetch_specifications.rb

@@ -0,0 +1,18 @@
+module Extension
+  module Tasks
+    class FetchSpecifications
+      include ShopifyCli::MethodObject
+
+      property :context
+      property :api_key
+
+      def call
+        response = ShopifyCli::PartnersAPI
+          .query(context, "fetch_specifications", api_key: api_key)
+          .dig("data", "extensionSpecifications")
+        context.abort(context.message("tasks.errors.parse_error")) if response.nil?
+        response
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/get_app.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Tasks
     class GetApp < ShopifyCli::Task
-      GRAPHQL_FILE = 'get_app_by_api_key'
+      GRAPHQL_FILE = "get_app_by_api_key"
 
       RESPONSE_FIELD = %w(data)
-      APP_FIELD = 'app'
+      APP_FIELD = "app"
 
       def call(context:, api_key:)
         input = { api_key: api_key }
 
         response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
-        context.abort(context.message('tasks.errors.parse_error')) if response.nil?
+        context.abort(context.message("tasks.errors.parse_error")) if response.nil?
 
         Converters::AppConverter.from_hash(response.dig(APP_FIELD))
       end