shopify-cli 1.5.0 → 1.9.0

data/lib/project_types/extension/features/argo_config.rb

@@ -3,7 +3,7 @@
 module Extension
   module Features
     class ArgoConfig
-      CONFIG_FILE_NAME = 'extension.config.yml'
+      CONFIG_FILE_NAME = "extension.config.yml"
 
       class << self
         def parse_yaml(context, permitted_keys = [])
@@ -11,7 +11,7 @@ module Extension
 
           return {} unless File.size?(file_name)
 
-          require 'yaml' # takes 20ms, so deferred as late as possible.
+          require "yaml" # takes 20ms, so deferred as late as possible.
           begin
             config = YAML.load_file(file_name)
 
@@ -21,7 +21,7 @@ module Extension
             return {} if config.nil?
 
             unless config.is_a?(Hash)
-              raise ShopifyCli::Abort, ShopifyCli::Context.message('core.yaml.error.not_hash', CONFIG_FILE_NAME)
+              raise ShopifyCli::Abort, ShopifyCli::Context.message("core.yaml.error.not_hash", CONFIG_FILE_NAME)
             end
 
             config.transform_keys!(&:to_sym)
@@ -31,7 +31,7 @@ module Extension
           rescue Psych::SyntaxError => e
             raise(
               ShopifyCli::Abort,
-              ShopifyCli::Context.message('core.yaml.error.invalid', CONFIG_FILE_NAME, e.message)
+              ShopifyCli::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
             )
           end
         end
@@ -47,7 +47,7 @@ module Extension
             raise(
               ShopifyCli::Abort,
               ShopifyCli::Context.message(
-                'features.argo.config.unpermitted_keys',
+                "features.argo.config.unpermitted_keys",
                 CONFIG_FILE_NAME,
                 unpermitted_keys.map { |k| "\n- #{k}" }.join
               )

data/lib/project_types/extension/features/argo_dependencies.rb

@@ -5,21 +5,21 @@ module Extension
     class ArgoDependencies
       def self.node_installed(min_major:, min_minor: nil)
         -> (context) do
-          out, status = CLI::Kit::System.capture2('node', '-v')
-          context.abort(context.message('features.argo.dependencies.node.node_not_installed')) unless status.success?
+          out, status = CLI::Kit::System.capture2("node", "-v")
+          context.abort(context.message("features.argo.dependencies.node.node_not_installed")) unless status.success?
 
-          min_version = 'v' + min_major .to_s + '.' + (min_minor.nil? ? 'x' : min_minor.to_s) + '.x'
+          min_version = "v" + min_major .to_s + "." + (min_minor.nil? ? "x" : min_minor.to_s) + ".x"
           version = out.strip
           parsed_version = version.match(/v(?<major>\d+).(?<minor>\d+).(?<patch>\d+)/)
 
           unless min_major.nil? || parsed_version[:major].to_i >= min_major
-            context.abort(context.message('features.argo.dependencies.node.version_too_low', version, min_version))
+            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
           end
 
           return if parsed_version[:major].to_i > min_major
 
           unless min_minor.nil? || parsed_version[:minor].to_i >= min_minor
-            context.abort(context.message('features.argo.dependencies.node.version_too_low', version, min_version))
+            context.abort(context.message("features.argo.dependencies.node.version_too_low", version, min_version))
           end
         end
       end

data/lib/project_types/extension/features/argo_renderer_package.rb

@@ -0,0 +1,32 @@
+module Extension
+  module Features
+    class ArgoRendererPackage
+      include SmartProperties
+
+      ARGO_CHECKOUT = "@shopify/argo-checkout"
+      ARGO_ADMIN = "@shopify/argo-admin"
+
+      PACKAGE_NAMES = [
+        ARGO_CHECKOUT,
+        ARGO_ADMIN,
+      ].freeze
+      MINIMUM_ARGO_VERSION = "0.9.3".freeze
+
+      property! :package_name, accepts: PACKAGE_NAMES
+      property! :version, accepts: String
+
+      def checkout?
+        package_name == ARGO_CHECKOUT
+      end
+
+      def admin?
+        package_name == ARGO_ADMIN
+      end
+
+      def supports_uuid_flag?
+        return false if checkout?
+        Gem::Version.new(version) > Gem::Version.new(MINIMUM_ARGO_VERSION)
+      end
+    end
+  end
+end

data/lib/project_types/extension/features/argo_serve.rb

@@ -0,0 +1,69 @@
+module Extension
+  module Features
+    class ArgoServe
+      include SmartProperties
+
+      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
+      property! :context, accepts: ShopifyCli::Context
+
+      YARN_SERVE_COMMAND = %w(server)
+      NPM_SERVE_COMMAND = %w(run-script server)
+
+      def call
+        validate_env!
+
+        CLI::UI::Frame.open(context.message("serve.frame_title")) do
+          success = ShopifyCli::JsSystem.call(context, yarn: yarn_serve_command, npm: npm_serve_command)
+          context.abort(context.message("serve.serve_failure_message")) unless success
+        end
+      end
+
+      private
+
+      def specification
+        specification_handler.specification
+      end
+
+      def validate_env!
+        ExtensionProject.reload
+
+        ShopifyCli::Shopifolk.check && ShopifyCli::Feature.enabled?(:argo_admin_beta)
+
+        required_fields = specification.features.argo.required_fields
+
+        return if required_fields.none?
+
+        ShopifyCli::Tasks::EnsureEnv.call(context, required: required_fields)
+        ShopifyCli::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
+
+        project = ExtensionProject.current
+
+        return if required_fields.all? do |field|
+          value = project.env.public_send(field)
+          value && !value.strip.empty?
+        end
+
+        context.abort(context.message("serve.serve_missing_information"))
+      end
+
+      def yarn_serve_command
+        YARN_SERVE_COMMAND + serve_options(specification.features.argo.required_fields)
+      end
+
+      def npm_serve_command
+        NPM_SERVE_COMMAND + ["--"] + serve_options(specification.features.argo.required_fields)
+      end
+
+      def serve_options(required_fields)
+        renderer_package = specification_handler.renderer_package(context)
+        project = ExtensionProject.current
+        @serve_options ||= [].tap do |options|
+          options << "--shop=#{project.env.shop}" if required_fields.include?(:shop)
+          options << "--apiKey=#{project.env.api_key}" if required_fields.include?(:api_key)
+          options << "--argoVersion=#{renderer_package.version}" if renderer_package.admin?
+          options << "--uuid=#{project.registration_uuid}" if renderer_package.supports_uuid_flag?
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/features/argo_setup.rb

@@ -5,8 +5,8 @@ module Extension
     class ArgoSetup
       include SmartProperties
 
-      GIT_DIRECTORY = '.git'
-      SCRIPTS_DIRECTORY = 'scripts'
+      GIT_DIRECTORY = ".git"
+      SCRIPTS_DIRECTORY = "scripts"
 
       property! :git_template, accepts: String
       property! :dependency_checks, default: []

data/lib/project_types/extension/features/argo_setup_steps.rb

@@ -5,7 +5,7 @@ module Extension
     module ArgoSetupSteps
       YARN_INITIALIZE_COMMAND = %w(generate).freeze
       NPM_INITIALIZE_COMMAND = %w(run generate --).freeze
-      INITIALIZE_TYPE_PARAMETER = '--type=%s'
+      INITIALIZE_TYPE_PARAMETER = "--type=%s"
 
       def self.check_dependencies(dependency_checks)
         ArgoSetupStep.always_successful do |context, _identifier, _directory_name, _js_system|
@@ -21,7 +21,7 @@ module Extension
             ShopifyCli::Git.clone(git_template, directory_name, ctx: context)
             context.root = File.join(context.root, directory_name)
           rescue StandardError
-            context.puts('{{x}} Unable to clone the repository.')
+            context.puts("{{x}} Unable to clone the repository.")
           end
         end
       end
@@ -34,8 +34,8 @@ module Extension
 
       def self.initialize_project
         ArgoSetupStep.default do |context, identifier, _directory_name, js_system|
-          frame_title = context.message('create.setup_project_frame_title')
-          failure_message = context.message('features.argo.initialization_error')
+          frame_title = context.message("create.setup_project_frame_title")
+          failure_message = context.message("features.argo.initialization_error")
 
           result = true
           CLI::UI::Frame.open(frame_title, failure_text: failure_message) do

data/lib/project_types/extension/forms/create.rb

@@ -3,50 +3,44 @@
 module Extension
   module Forms
     class Create < ShopifyCli::Form
-      flag_arguments :name, :type
+      flag_arguments :name, :type, :api_key
 
-      def ask
-        self.type = ask_type
-        self.name = ask_name
-      end
+      attr_reader :app
 
-      def directory_name
-        @directory_name ||= name.strip.gsub(/( )/, '_').downcase
-      end
+      class ExtensionProjectDetails
+        include SmartProperties
 
-      private
+        property :app, accepts: Models::App
+        property :name, accepts: String
+        property :type, accepts: Models::SpecificationHandlers::Default
 
-      def ask_name
-        ask_with_reprompt(
-          initial_value: name,
-          break_condition: -> (current_name) { Models::Registration.valid_title?(current_name) },
-          prompt_message: ctx.message('create.ask_name'),
-          reprompt_message: ctx.message('create.invalid_name', Models::Registration::MAX_TITLE_LENGTH)
-        )
+        def complete?
+          !!(app && name && type)
+        end
       end
 
-      def ask_type
-        return Models::Type.load_type(type) if Models::Type.valid?(type)
-        ctx.puts(ctx.message('create.invalid_type')) unless type.nil?
-
-        CLI::UI::Prompt.ask(ctx.message('create.ask_type')) do |handler|
-          Models::Type.repository.values.each do |type|
-            handler.option("#{type.name} #{type.tagline}") { type }
+      def ask
+        ShopifyCli::Result.wrap(ExtensionProjectDetails.new)
+          .then(&Questions::AskApp.new(ctx: ctx, api_key: api_key))
+          .then(&Questions::AskType.new(ctx: ctx, type: type))
+          .then(&Questions::AskName.new(ctx: ctx, name: name))
+          .unwrap { |e| raise e }
+          .tap do |project_details|
+            ctx.abort(ctx.message("create.incomplete_configuration")) unless project_details.complete?
+
+            self.app = project_details.app
+            self.type = project_details.type
+            self.name = project_details.name
           end
-        end
       end
 
-      def ask_with_reprompt(initial_value:, break_condition:, prompt_message:, reprompt_message:)
-        value = initial_value
-        reprompt = false
-
-        until break_condition.call(value)
-          ctx.puts(reprompt_message) if reprompt
-          value = CLI::UI::Prompt.ask(prompt_message)&.strip
-          reprompt = true
-        end
-        value
+      def directory_name
+        name.strip.gsub(/( )/, "_").downcase
       end
+
+      private
+
+      attr_writer :app
     end
   end
 end

data/lib/project_types/extension/forms/questions/ask_app.rb

@@ -0,0 +1,53 @@
+module Extension
+  module Forms
+    module Questions
+      class AskApp
+        include ShopifyCli::MethodObject
+
+        property! :ctx
+        property :api_key
+        property! :prompt,
+          converts: :to_proc,
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          project_details.tap(&method(:prompt_for_app))
+        end
+
+        private
+
+        def prompt_for_app(project_details)
+          project_details.app =
+            api_key.nil? ? choose_interactively(load_apps) : validate_app_ownership(api_key)
+        end
+
+        def validate_app_ownership(api_key)
+          found_app = Tasks::GetApp.call(context: ctx, api_key: api_key)
+          ctx.abort(ctx.message("create.invalid_api_key", api_key)) if found_app.nil?
+          found_app
+        end
+
+        def choose_interactively(apps)
+          prompt.call(ctx.message("create.ask_app")) do |handler|
+            apps.each do |app|
+              handler.option("#{app.title} by #{app.business_name}") { app }
+            end
+          end
+        end
+
+        def load_apps
+          ctx.puts(@ctx.message("create.loading_apps"))
+          apps = Tasks::GetApps.call(context: ctx)
+
+          apps.empty? ? abort_no_apps : apps
+        end
+
+        def abort_no_apps
+          ctx.puts(@ctx.message("create.no_apps"))
+          ctx.puts(@ctx.message("create.learn_about_apps"))
+          raise ShopifyCli::AbortSilent
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/forms/questions/ask_name.rb

@@ -0,0 +1,40 @@
+module Extension
+  module Forms
+    module Questions
+      class AskName
+        include ShopifyCli::MethodObject
+
+        property! :ctx
+        property :name
+        property :prompt,
+          accepts: ->(prompt) { prompt.respond_to?(:call) },
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          project_details.name = ask_with_reprompt(
+            initial_value: name,
+            break_condition: -> (current_name) { Models::Registration.valid_title?(current_name) },
+            prompt_message: ctx.message("create.ask_name"),
+            reprompt_message: ctx.message("create.invalid_name", Models::Registration::MAX_TITLE_LENGTH)
+          )
+          project_details
+        end
+
+        private
+
+        def ask_with_reprompt(initial_value:, break_condition:, prompt_message:, reprompt_message:)
+          value = initial_value
+          reprompt = false
+
+          until break_condition.call(value)
+            ctx.puts(reprompt_message) if reprompt
+            value = prompt.call(prompt_message)&.strip
+            reprompt = true
+          end
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/forms/questions/ask_type.rb

@@ -0,0 +1,47 @@
+module Extension
+  module Forms
+    module Questions
+      class AskType
+        include ShopifyCli::MethodObject
+
+        property! :ctx
+        property :type
+        property :prompt,
+          converts: :to_proc,
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          specifications = Models::Specifications.new(
+            fetch_specifications: Tasks::FetchSpecifications.new(context: ctx, api_key: project_details.app.api_key)
+          )
+
+          project_details.tap do |p|
+            p.type = type.nil? ? choose_type(specifications) : validate_given_type(specifications, type)
+          end
+        end
+
+        private
+
+        def validate_given_type(specifications, type)
+          return specifications[type] if specifications.valid?(type)
+          ctx.abort(ctx.message("create.invalid_type")) unless type.nil?
+        end
+
+        def choose_type(specifications)
+          abort_due_to_missing_specifications if specifications.none?
+
+          prompt.call(ctx.message("create.ask_type")) do |handler|
+            specifications.each do |type|
+              handler.option("#{type.name} #{type.tagline}") { type }
+            end
+          end
+        end
+
+        def abort_due_to_missing_specifications
+          ctx.puts(@ctx.message("create.no_available_extensions"))
+          raise ShopifyCli::AbortSilent
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/messages/message_loading.rb

@@ -16,7 +16,9 @@ module Extension
 
       def self.load_current_type_messages
         return unless ShopifyCli::Project.has_current?
-        messages_for_type(ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::EXTENSION_TYPE_KEY])
+        messages_for_type(
+          ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
+        )
       end
 
       def self.messages_for_type(type_identifier)