shopify-cli 1.4.1 → 1.8.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_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/messages.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Extension
   module Messages
     MESSAGES = {
       create: {
-        ask_name: 'Extension name',
-        invalid_name: 'Extension name must be under %s characters',
-        ask_type: 'What type of extension are you creating?',
-        invalid_type: 'Extension type is invalid.',
-        setup_project_frame_title: 'Initializing project',
+        ask_name: "Extension name",
+        invalid_name: "Extension name must be under %s characters",
+        ask_type: "What type of extension are you creating?",
+        invalid_type: "Extension type is invalid.",
+        setup_project_frame_title: "Initializing project",
         ready_to_start: <<~MESSAGE,
           {{v}} A new folder was generated at {{green:./%s}}.
           {{*}} You’re ready to start building {{green:%s}}!
@@ -19,49 +19,52 @@ module Extension
           {{*}} Once you're ready to version and publish your extension,
           run {{command:shopify register}} to register this extension with one of your apps.
         MESSAGE
-        try_again: '{{*}} Fix the errors and run {{command:shopify create extension}} again.',
+        try_again: "{{*}} Fix the errors and run {{command:shopify create extension}} again.",
         errors: {
-          directory_exists: 'Directory ‘%s’ already exists. Please remove it or choose a new name for your project.',
+          directory_exists: "Directory ‘%s’ already exists. Please remove it or choose a new name for your project.",
         },
+        incomplete_configuration: "Cannot create extension due to missing configuration information",
+        invalid_api_key: "The API key %s does not match any of your apps.",
+        ask_app: "Which app would you like to register this extension with?",
+        no_apps: "{{x}} You don’t have any apps.",
+        learn_about_apps: "{{*}} Learn more about building apps at <https://shopify.dev/concepts/apps>, " \
+          "or try creating a new app using {{command:shopify create}}.",
+        loading_apps: "Loading your apps...",
+        no_available_extensions: "{{x}} There are no available extensions for this app.",
       },
       build: {
-        frame_title: 'Building extension with: %s...',
-        build_failure_message: 'Failed to build extension code.',
+        frame_title: "Building extension with: %s...",
+        build_failure_message: "Failed to build extension code.",
       },
       register: {
-        frame_title: 'Registering Extension',
-        waiting_text: 'Registering with Shopify...',
-        already_registered: 'Extension is already registered.',
-        loading_apps: 'Loading your apps...',
-        ask_app: 'Which app would you like to register this extension with?',
-        no_apps: '{{x}} You don’t have any apps.',
-        learn_about_apps: '{{*}} Learn more about building apps at <https://shopify.dev/concepts/apps>, ' \
-          'or try creating a new app using {{command:shopify create}}.',
-        invalid_api_key: 'The API key %s does not match any of your apps.',
-        confirm_info: 'This will create a new extension registration for %s, which can’t be undone.',
-        confirm_question: 'Would you like to register this extension with {{green:%s}}? (y/n)',
-        confirm_abort: 'Extension was not registered.',
-        success: '{{v}} Registered {{green:%s}} with {{green:%s}}.',
-        success_info: '{{*}} Run {{command:shopify push}} to push your extension to Shopify.',
+        frame_title: "Registering Extension",
+        waiting_text: "Registering with Shopify...",
+        already_registered: "Extension is already registered.",
+        confirm_info: "This will create a new extension registration for %s, which can’t be undone.",
+        confirm_question: "Would you like to register this extension? (y/n)",
+        confirm_abort: "Extension was not registered.",
+        success: "{{v}} Registered {{green:%s}}.",
+        success_info: "{{*}} Run {{command:shopify push}} to push your extension to Shopify.",
       },
       push: {
-        frame_title: 'Pushing your extension to Shopify',
-        waiting_text: 'Pushing code to Shopify...',
-        pushed_with_errors: '{{x}} Code pushed to Shopify with errors on %s.',
-        push_with_errors_info: '{{*}} Fix these errors and run {{command:shopify push}} to revalidate your extension.',
-        success_confirmation: '{{v}} Pushed {{green:%s}} to a draft on %s.',
-        success_info: '{{*}} Visit %s to version and publish your extension.',
+        frame_title: "Pushing your extension to Shopify",
+        waiting_text: "Pushing code to Shopify...",
+        pushed_with_errors: "{{x}} Code pushed to Shopify with errors on %s.",
+        push_with_errors_info: "{{*}} Fix these errors and run {{command:shopify push}} to revalidate your extension.",
+        success_confirmation: "{{v}} Pushed {{green:%s}} to a draft on %s.",
+        success_info: "{{*}} Visit %s to version and publish your extension.",
       },
       serve: {
-        frame_title: 'Serving extension...',
-        serve_failure_message: 'Failed to run extension code.',
+        frame_title: "Serving extension...",
+        serve_failure_message: "Failed to run extension code.",
+        serve_missing_information: "Missing shop or api_key.",
       },
       tunnel: {
-        missing_token: '{{x}} {{red:auth requires a token argument}}. '\
-          'Find it on your ngrok dashboard: {{underline:https://dashboard.ngrok.com/auth/your-authtoken}}.',
-        invalid_port: '%s is not a valid port.',
-        no_tunnel_running: 'No tunnel running.',
-        tunnel_running_at: 'Tunnel running at: {{underline:%s}}',
+        missing_token: "{{x}} {{red:auth requires a token argument}}. "\
+          "Find it on your ngrok dashboard: {{underline:https://dashboard.ngrok.com/auth/your-authtoken}}.",
+        invalid_port: "%s is not a valid port.",
+        no_tunnel_running: "No tunnel running.",
+        tunnel_running_at: "Tunnel running at: {{underline:%s}}",
         help: <<~HELP,
           Start or stop an http tunnel to your local development extension using ngrok.
             Usage: {{command:%s tunnel [ auth | start | stop | status ]}}
@@ -69,7 +72,7 @@ module Extension
         extended_help: <<~HELP,
           {{bold:Subcommands:}}
 
-            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. 
+            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account.
             Visit https://dashboard.ngrok.com/signup to sign up.
               Usage: {{command:%1$s tunnel auth <token>}}
 
@@ -87,48 +90,48 @@ module Extension
       },
       features: {
         argo: {
-          missing_file_error: 'Could not find built extension file.',
-          script_prepare_error: 'An error occurred while attempting to prepare your script.',
-          initialization_error: '{{x}} There was an error while initializing the project.',
+          missing_file_error: "Could not find built extension file.",
+          script_prepare_error: "An error occurred while attempting to prepare your script.",
+          initialization_error: "{{x}} There was an error while initializing the project.",
           dependencies: {
             node: {
-              node_not_installed: 'Node must be installed to create this extension.',
-              version_too_low: 'Your node version %s does not meet the minimum required version %s',
+              node_not_installed: "Node must be installed to create this extension.",
+              version_too_low: "Your node version %s does not meet the minimum required version %s",
             },
-            argo_missing_renderer_package_error: '%s Install the missing package and try again.',
+            argo_missing_renderer_package_error: "%s Install the missing package and try again.",
             argo_renderer_package_invalid_version_error: <<~MESSAGE,
               The renderer package version is not a valid SemVer Version (http://semver.org)
             MESSAGE
             yarn_install_error: "Something went wrong while running 'yarn install'. %s.",
-            yarn_run_script_error: 'Something went wrong while running script. %s.',
+            yarn_run_script_error: "Something went wrong while running script. %s.",
           },
           config: {
-            unpermitted_keys: '`%s` contains the following unpermitted keys: %s',
+            unpermitted_keys: "`%s` contains the following unpermitted keys: %s",
           },
         },
       },
       tasks: {
         errors: {
-          parse_error: 'Unable to parse response from Partners Dashboard.',
+          parse_error: "Unable to parse response from Partners Dashboard.",
         },
       },
       errors: {
-        unknown_type: 'Unknown extension type %s',
+        unknown_type: "Unknown extension type %s",
       },
     }
 
     TYPES = {
       product_subscription: {
-        name: 'Product Subscription',
-        tagline: '(limit 1 per app)',
+        name: "Product Subscription",
+        tagline: "(limit 1 per app)",
         overrides: {
           register: {
-            confirm_info: 'You can only create one %s extension per app, which can’t be undone.',
+            confirm_info: "You can only create one %s extension per app, which can’t be undone.",
           },
         },
       },
       checkout_post_purchase: {
-        name: 'Checkout Post Purchase',
+        name: "Checkout Post Purchase",
       },
     }
   end