shopify-cli 1.0.3 → 1.1.2

data/lib/project_types/script/commands/create.rb

@@ -34,12 +34,8 @@ module Script
       end
 
       def self.help
-        ShopifyCli::Context.message('script.create.help', ShopifyCli::TOOL_NAME)
-      end
-
-      def self.extended_help
         allowed_values = Script::Layers::Application::ExtensionPoints.types.map { |type| "{{cyan:#{type}}}" }
-        ShopifyCli::Context.message('script.create.extended_help', ShopifyCli::TOOL_NAME, allowed_values.join(', '))
+        ShopifyCli::Context.message('script.create.help', ShopifyCli::TOOL_NAME, allowed_values.join(', '))
       end
     end
   end

data/lib/project_types/script/commands/disable.rb

@@ -3,9 +3,8 @@
 module Script
   module Commands
     class Disable < ShopifyCli::Command
-      prerequisite_task :ensure_env
-
       def call(_args, _name)
+        ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
         project = ScriptProject.current
         Layers::Application::DisableScript.call(
           ctx: @ctx,

data/lib/project_types/script/commands/enable.rb

@@ -3,7 +3,6 @@
 module Script
   module Commands
     class Enable < ShopifyCli::Command
-      prerequisite_task :ensure_env
       options do |parser, flags|
         parser.on('--config_props=KEYVALUEPAIRS', Array) do |t|
           flags[:config_props] = Hash[t.map { |s| s.split(':') }]
@@ -12,6 +11,7 @@ module Script
       end
 
       def call(_args, _name)
+        ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
         project = ScriptProject.current
         api_key = project.env[:api_key]
         shop_domain = project.env[:shop]
@@ -32,6 +32,8 @@ module Script
           title: project.script_name
         ))
         @ctx.puts(@ctx.message('script.enable.info'))
+      rescue Errors::InvalidConfigYAMLError => e
+        UI::ErrorHandler.pretty_print_and_raise(e)
       rescue StandardError => e
         UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message('script.enable.error.operation_failed'))
       end
@@ -40,10 +42,6 @@ module Script
         ShopifyCli::Context.message('script.enable.help', ShopifyCli::TOOL_NAME)
       end
 
-      def self.extended_help
-        ShopifyCli::Context.message('script.enable.extended_help', ShopifyCli::TOOL_NAME)
-      end
-
       private
 
       def acquire_configuration(config_file: nil, config_props: nil)
@@ -59,6 +57,8 @@ module Script
           })
         end
         configuration
+      rescue Errno::ENOENT, Psych::SyntaxError
+        raise Errors::InvalidConfigYAMLError, options.flags[:config_file]
       end
 
       # No slice pre Ruby 2.5 so roll our own

data/lib/project_types/script/commands/push.rb

@@ -3,13 +3,12 @@
 module Script
   module Commands
     class Push < ShopifyCli::Command
-      prerequisite_task :ensure_env
-
       options do |parser, flags|
         parser.on('--force') { |t| flags[:force] = t }
       end
 
       def call(_args, _name)
+        ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
         project = ScriptProject.current
         api_key = project.env[:api_key]
         return @ctx.puts(self.class.help) unless api_key &&
@@ -31,10 +30,6 @@ module Script
       def self.help
         ShopifyCli::Context.message('script.push.help', ShopifyCli::TOOL_NAME)
       end
-
-      def self.extended_help
-        ShopifyCli::Context.message('script.push.extended_help', ShopifyCli::TOOL_NAME)
-      end
     end
   end
 end

data/lib/project_types/script/config/extension_points.yml

@@ -1,24 +1,24 @@
 discount:
   assemblyscript:
     package: "@shopify/extension-point-as-discount"
-    version: "^0.2.4"
+    version: "^0.2.10"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 unit_limit_per_order:
   assemblyscript:
     package: "@shopify/extension-point-as-unit-limit-per-order"
-    version: "^0.1.6"
+    version: "^0.1.12"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 payment_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-payment-filter"
-    version: "^0.2.2"
+    version: "^0.2.8"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 shipping_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-shipping-filter"
-    version: "^0.2.4"
+    version: "^0.2.10"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"

data/lib/project_types/script/errors.rb

@@ -9,9 +9,17 @@ module Script
     class NoExistingStoresError < ScriptProjectError
       attr_reader :organization_id
       def initialize(organization_id)
+        super()
         @organization_id = organization_id
       end
     end
     class ScriptProjectAlreadyExistsError < ScriptProjectError; end
+    class InvalidConfigYAMLError < ScriptProjectError
+      attr_reader :config_file
+      def initialize(config_file)
+        super()
+        @config_file = config_file
+      end
+    end
   end
 end

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

@@ -2,7 +2,7 @@
 
 module Script
   module Forms
-    class Create < ScriptForm
+    class Create < ShopifyCli::Form
       flag_arguments :extension_point, :name
 
       def ask

data/lib/project_types/script/layers/domain/errors.rb

@@ -8,12 +8,14 @@ module Script
         class InvalidExtensionPointError < ScriptProjectError
           attr_reader :type
           def initialize(type)
+            super()
             @type = type
           end
         end
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type
           def initialize(extension_point_type, script_name)
+            super()
             @script_name = script_name
             @extension_point_type = extension_point_type
           end

data/lib/project_types/script/layers/infrastructure/errors.rb

@@ -21,6 +21,7 @@ module Script
         class ScriptRepushError < ScriptProjectError
           attr_reader :api_key
           def initialize(api_key)
+            super()
             @api_key = api_key
           end
         end

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -49,7 +49,7 @@ module Script
           resp_hash = script_service_request(
             query_name: query_name,
             api_key: api_key,
-            shop_domain: shop_domain,
+            shop_domain: format_shop_domain(shop_domain),
             variables: variables,
           )
           user_errors = resp_hash["data"]["shopScriptUpdateOrCreate"]["userErrors"]
@@ -76,7 +76,7 @@ module Script
           resp_hash = script_service_request(
             query_name: query_name,
             api_key: api_key,
-            shop_domain: shop_domain,
+            shop_domain: format_shop_domain(shop_domain),
             variables: variables,
           )
           user_errors = resp_hash["data"]["shopScriptDelete"]["userErrors"]
@@ -91,6 +91,10 @@ module Script
 
         private
 
+        def format_shop_domain(shop_domain)
+          shop_domain.delete_suffix("/")
+        end
+
         class ScriptServiceAPI < ShopifyCli::API
           property(:api_key, accepts: String)
           property(:shop_id, accepts: Integer)

data/lib/project_types/script/messages/messages.rb

@@ -29,7 +29,7 @@ module Script
           no_existing_orgs_cause: "You don't have any partner organizations.",
           no_existing_orgs_help: "Please visit https://partners.shopify.com/ to create a partners account.",
 
-          no_existing_stores_cause: "You don't have any development stores.",
+          no_existing_stores_cause: "You don't have any stores.",
           no_existing_stores_help: "Visit https://partners.shopify.com/%{organization_id}/stores/ to create one.",
 
           project_exists_cause: "Directory with the same name as the script already exists.",
@@ -38,9 +38,12 @@ module Script
           invalid_extension_cause: "Invalid extension point %s",
           invalid_extension_help: "Allowed values: %s.",
 
+          invalid_config: "Can't change the configuration values because %1$s is missing or "\
+                          "it is not formatted properly.",
+
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 
-          app_not_installed_cause: "App not installed on development store.",
+          app_not_installed_cause: "App not installed on store.",
 
           app_script_not_pushed_help: "Push the script and then try this command again.",
 
@@ -67,18 +70,16 @@ module Script
                                       "on this extension point.",
           shop_script_conflict_help: "Disable that script or uninstall that app and try again.",
 
-          shop_script_undefined_cause: "Script is already turned off in development store.",
+          shop_script_undefined_cause: "Script is already turned off in store.",
         },
 
         create: {
           help: <<~HELP,
           {{command:%1$s create script}}: Creates a script project.
             Usage: {{command:%1$s create script}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--name=NAME}} Script project name. Use any string.
-              \s\s{{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
+            Options:
+              {{command:--name=NAME}} Script project name. Use any string.
+              {{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
           HELP
 
           error: {
@@ -94,14 +95,12 @@ module Script
           help: <<~HELP,
           Build the script and put it into production. If you've already pushed a script with the same extension point, use --force to replace the current script with the newest one.
             Usage: {{command:%s push}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
+            Options:
+              {{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
           HELP
 
           error: {
-            operation_failed: "Script not pushed.",
+            operation_failed: "Couldn't push script to app.",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
@@ -109,27 +108,24 @@ module Script
 
         disable: {
           help: <<~HELP,
-          Turn off script in development store.
+          Turn off script in store.
             Usage: {{command:%s disable}}
           HELP
 
           error: {
             operation_failed: "Can't disable script.",
-            not_pushed_to_app: "Can't disable the script because it hasn't been pushed to the app.",
           },
 
-          script_disabled: "{{v}} Script disabled. Script is turned off in development store.",
+          script_disabled: "{{v}} Script disabled. Script is turned off in store.",
         },
 
         enable: {
           help: <<~HELP,
-          Turn on script in development store.
+          Turn on script in store.
             Usage: {{command:%s enable}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--config_props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config_props will override those set in the file.
-              \s\s{{command:--config_file=<path/to/YAMLFilename>}} Optional. Define the configuration of your script using a YAML formatted file. --config_props values override properties in this file.
+            Options:
+              {{command:--config_props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config_props will override those set in the file.
+              {{command:--config_file=<path/to/YAMLFilename>}} Optional. Define the configuration of your script using a YAML formatted file. --config_props values override properties in this file.
           HELP
 
           info: "{{*}} A script always remains enabled until you disable it - even after pushing "\
@@ -138,11 +134,10 @@ module Script
 
           error: {
             operation_failed: "Can't enable script.",
-            not_pushed_to_app: "Can't enable the script because it hasn't been pushed to the app.",
           },
 
           script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
-                          "is turned on in development store {{green:%{shop_domain}}}",
+                          "is turned on in store {{green:%{shop_domain}}}",
         },
 
         project_deps: {
@@ -152,35 +147,11 @@ module Script
           installed: "Missing dependencies installed",
         },
 
-        test: {
-          help: <<~HELP,
-          Runs unit tests on your script.
-            Usage: {{command:%s test}}
-          HELP
-
-          error: {
-            operation_failed: "Tests didn't run or they ran with failures.",
-          },
-
-          running: "Running tests",
-          success: "{{v}} Tests finished.",
-        },
-
         forms: {
           create: {
             select_extension_point: "Which extension point do you want to use?",
             script_name: "Script Name",
           },
-          script_form: {
-            ask_app_api_key_default: "Which app do you want this script to belong to?",
-            ask_shop_domain_default: "Select a development store",
-            fetching_organizations: "Fetching partner organizations",
-            fetched_organizations: "Fetched partner organizations",
-            select_organization: "Select partner organization.",
-            using_app: "Using app {{green:%{title} (%{api_key})}}.",
-            using_development_store: "Using development store {{green:%{domain}}}",
-            using_organization: "Partner organization {{green:%s}}.",
-          },
         },
 
         application: {

data/lib/project_types/script/ui/error_handler.rb

@@ -44,6 +44,10 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
           }
+        when Errors::InvalidConfigYAMLError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_config', e.config_file),
+          }
         when Errors::InvalidScriptNameError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_script_name_cause'),

data/lib/rubygems_plugin.rb

@@ -1,17 +1,25 @@
 Gem.post_uninstall do |uninstaller|
   if uninstaller.spec.name == 'shopify-cli'
-    require 'fileutils'
+    if RUBY_PLATFORM.match(/mingw32/)
+      bat_path = File.dirname(RbConfig.ruby)
+      bat = "#{bat_path}\\shopify.bat"
 
-    symlink = '/usr/local/bin/shopify'
+      # delete the auto-generated batch script
+      File.unlink(bat)
+    else
+      require 'fileutils'
 
-    # delete the symbolic link IFF it exists AND it does not point to a file
-    # (i.e., it's been left hanging as a result of the uninstall, as expected)
-    #
-    # if the file still exists, either the uninstall failed (possible but
-    # unlikely) OR
-    # there's another installation of the gem in another ruby folder that has
-    # overwritten it, so leave the symbolic link alone
-    system("sudo rm -f #{symlink}") if File.symlink?(symlink) && !File.exist?(symlink)
+      symlink = '/usr/local/bin/shopify'
+
+      # delete the symbolic link IFF it exists AND it does not point to a file
+      # (i.e., it's been left hanging as a result of the uninstall, as expected)
+      #
+      # if the file still exists, either the uninstall failed (possible but
+      # unlikely) OR
+      # there's another installation of the gem in another ruby folder that has
+      # overwritten it, so leave the symbolic link alone
+      system("sudo rm -f #{symlink}") if File.symlink?(symlink) && !File.exist?(symlink)
+    end
   end
 
   true

data/lib/shopify-cli/admin_api/populate_resource_command.rb

@@ -118,7 +118,7 @@ module ShopifyCli
         kwargs = { input: data }
         kwargs[:shop] = @shop
         resp = AdminAPI.query(
-          @ctx, "create_#{snake_case_resource_type}", kwargs
+          @ctx, "create_#{snake_case_resource_type}", **kwargs
         )
         @ctx.abort(resp['errors']) if resp['errors']
         @ctx.done(message(resp['data'])) unless @silent

data/lib/shopify-cli/command.rb

@@ -9,17 +9,19 @@ module ShopifyCli
     attr_accessor :options
 
     class << self
-      attr_writer :ctx
+      attr_writer :ctx, :task_registry
 
       def call(args, command_name)
         subcommand, resolved_name = subcommand_registry.lookup_command(args.first)
         if subcommand
           subcommand.ctx = @ctx
+          subcommand.task_registry = @task_registry
           subcommand.call(args, resolved_name, command_name)
         else
           cmd = new(@ctx)
           cmd.options.parse(@_options, args)
           return call_help(command_name) if cmd.options.help
+          run_prerequisites
           cmd.call(args, command_name)
         end
       end
@@ -41,13 +43,16 @@ module ShopifyCli
       end
 
       def prerequisite_task(*tasks)
-        tasks.each do |task|
-          prerequisite_tasks[task] = ShopifyCli::Tasks::Registry[task]
-        end
+        @prerequisite_tasks ||= []
+        @prerequisite_tasks += tasks
+      end
+
+      def run_prerequisites
+        (@prerequisite_tasks || []).each { |task| task_registry[task]&.call(@ctx) }
       end
 
-      def prerequisite_tasks
-        @prerequisite_tasks ||= {}
+      def task_registry
+        @task_registry || ShopifyCli::Tasks::Registry
       end
 
       def call_help(*cmds)
@@ -57,6 +62,7 @@ module ShopifyCli
     end
 
     def initialize(ctx = nil)
+      super()
       @ctx = ctx || ShopifyCli::Context.new
       self.options = Options.new
     end