shopify-cli 1.0.4 → 1.2.0

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'),
@@ -138,6 +142,14 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.shop_script_undefined_cause'),
           }
+        when Layers::Infrastructure::Errors::PackagesOutdatedError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              'script.error.packages_outdated_cause',
+              e.outdated_packages.join(', ')
+            ),
+            help_suggestion: ShopifyCli::Context.message('script.error.packages_outdated_help'),
+          }
         end
       end
     end

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

data/lib/shopify-cli/commands/connect.rb

@@ -12,21 +12,14 @@ module ShopifyCli
           @ctx.puts prod_warning if [:rails, :node].include?(Project.current_project_type)
         end
 
-        env_data = begin
-          Resources::EnvFile.parse_external_env
-                   rescue Errno::ENOENT
-                     {}
-        end
-
-        org = fetch_org
-        id = org['id']
-        app = get_app(id, org['apps'])
-        shop = get_shop(org['stores'], id)
-
-        write_env(app, shop, env_data[:scopes], env_data[:extra])
-        write_cli_yml(project_type, id) unless Project.has_current?
+        org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
+        write_cli_yml(project_type, org['id']) unless Project.has_current?
+        api_key = Project.current(force_reload: true).env['api_key']
+        @ctx.puts(@ctx.message('core.connect.connected', get_app(org['apps'], api_key).first["title"]))
+      end
 
-        @ctx.puts(@ctx.message('core.connect.connected', app['title']))
+      def get_app(apps, api_key)
+        apps.select { |app| app["apiKey"] == api_key }
       end
 
       def ask_project_type
@@ -37,67 +30,6 @@ module ShopifyCli
         end
       end
 
-      def fetch_org
-        orgs = PartnersAPI::Organizations.fetch_with_app(@ctx)
-        org_id = if orgs.count == 1
-          orgs.first["id"]
-        else
-          CLI::UI::Prompt.ask(@ctx.message('core.connect.organization_select')) do |handler|
-            orgs.each do |org|
-              handler.option(
-                @ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])
-              ) { org["id"] }
-            end
-          end
-        end
-        org = orgs.find { |o| o["id"] == org_id }
-        org
-      end
-
-      def get_app(org_id, apps)
-        if apps.count == 1
-          apps.first
-        elsif apps.count == 0
-          @ctx.puts(@ctx.message('core.connect.no_apps'))
-          title = CLI::UI::Prompt.ask(@ctx.message('core.connect.app_name'))
-          type = CLI::UI::Prompt.ask(@ctx.message('core.connect.app_type.select')) do |handler|
-            handler.option(@ctx.message('core.connect.app_type.select_public')) { 'public' }
-            handler.option(@ctx.message('core.connect.app_type.select_custom')) { 'custom' }
-          end
-          ShopifyCli::Tasks::CreateApiClient.call(@ctx, org_id: org_id, title: title, type: type)
-        else
-          CLI::UI::Prompt.ask(@ctx.message('core.connect.app_select')) do |handler|
-            apps.each { |app| handler.option(app["title"]) { app } }
-          end
-        end
-      end
-
-      def get_shop(shops, id)
-        if shops.count == 1
-          shop = shops.first["shopDomain"]
-        elsif shops.count == 0
-          @ctx.puts(@ctx.message('core.connect.no_development_stores', id))
-        else
-          shop = CLI::UI::Prompt.ask(@ctx.message('core.connect.development_store_select')) do |handler|
-            shops.each { |s| handler.option(s["shopName"]) { s["shopDomain"] } }
-          end
-        end
-        shop
-      end
-
-      def write_env(app, shop, scopes, extra)
-        scopes = 'write_products,write_customers,write_draft_orders' if scopes.nil?
-        extra = {} if extra.nil?
-
-        Resources::EnvFile.new(
-          api_key: app["apiKey"],
-          secret: app["apiSecretKeys"].first["secret"],
-          shop: shop,
-          scopes: scopes,
-          extra: extra,
-        ).write(@ctx)
-      end
-
       def write_cli_yml(project_type, org_id)
         ShopifyCli::Project.write(
           @ctx,

data/lib/shopify-cli/commands/create.rb

@@ -32,7 +32,7 @@ module ShopifyCli
       end
 
       def self.help
-        project_types = all_visible_type.map(&:project_type).join(" | ")
+        project_types = all_visible_type.map(&:project_type).sort.join(" | ")
         ShopifyCli::Context.message('core.create.help', ShopifyCli::TOOL_NAME, project_types)
       end
 

data/lib/shopify-cli/commands/system.rb

@@ -36,11 +36,13 @@ module ShopifyCli
         cli_constants_extra = %w(
           PROJECT_TYPES_DIR
           TEMP_DIR
-          CACHE_DIR
-          TOOL_CONFIG_PATH
-          LOG_FILE
-          DEBUG_LOG_FILE
         )
+        cli_path_methods = [
+          :cache_dir,
+          :tool_config_path,
+          :log_file,
+          :debug_log_file,
+        ]
 
         cli_constants += cli_constants_extra if show_all_details
 
@@ -48,6 +50,12 @@ module ShopifyCli
         cli_constants.each do |s|
           @ctx.puts("  " + @ctx.message('core.system.const', s, ShopifyCli.const_get(s.to_sym)) + "\n")
         end
+
+        if show_all_details
+          cli_path_methods.each do |m|
+            @ctx.puts("  " + @ctx.message('core.system.const', m.upcase, ShopifyCli.send(m)) + "\n")
+          end
+        end
       end
 
       def display_cli_ruby(_show_all_details)
@@ -60,13 +68,14 @@ module ShopifyCli
       end
 
       def display_utility_commands(_show_all_details)
-        commands = %w(git curl tar unzip)
+        commands = %w(git curl tar)
 
         @ctx.puts("\n" + @ctx.message('core.system.command_header'))
         commands.each do |s|
-          output, status = @ctx.capture2e('which', s)
-          if status.success?
-            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, output))
+          cmd_path = @ctx.which(s)
+
+          if !cmd_path.nil?
+            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, cmd_path))
           else
             @ctx.puts("  " + @ctx.message('core.system.command_not_found', s))
           end
@@ -74,7 +83,7 @@ module ShopifyCli
       end
 
       def display_ngrok
-        ngrok_location = File.join(ShopifyCli::CACHE_DIR, 'ngrok')
+        ngrok_location = File.join(ShopifyCli.cache_dir, @ctx.windows? ? 'ngrok.exe' : 'ngrok')
         if File.exist?(ngrok_location)
           @ctx.puts("  " + @ctx.message('core.system.ngrok_available', ngrok_location))
         else
@@ -94,11 +103,11 @@ module ShopifyCli
       def display_project(project_type, commands)
         @ctx.puts("\n" + @ctx.message('core.system.project.header', project_type))
         commands.each do |s|
-          output, status = @ctx.capture2e('which', s)
-          if status.success?
+          cmd_path = @ctx.which(s)
+          if !cmd_path.nil?
             version_output, _ = @ctx.capture2e(s, '--version')
             version = version_output.match(/(\d+\.[^\s]+)/)[0]
-            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, output.strip, version.strip))
+            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, cmd_path.strip, version.strip))
           else
             @ctx.puts("  " + @ctx.message('core.system.project.command_not_found', s))
           end

data/lib/shopify-cli/context.rb

@@ -2,6 +2,8 @@
 require 'shopify_cli'
 require 'fileutils'
 require 'rbconfig'
+require 'net/http'
+require 'json'
 
 module ShopifyCli
   ##
@@ -11,6 +13,11 @@ module ShopifyCli
   # resoures.
   #
   class Context
+    GEM_LATEST_URI = URI.parse('https://rubygems.org/api/v1/versions/shopify-cli/latest.json')
+    VERSION_CHECK_SECTION = 'versioncheck'
+    LAST_CHECKED_AT_FIELD = 'last_checked_at'
+    VERSION_CHECK_INTERVAL = 86400
+
     class << self
       attr_reader :messages
 
@@ -56,6 +63,7 @@ module ShopifyCli
       host = uname
       return :mac if /darwin/.match(host)
       return :linux if /linux/.match(host)
+      return :windows if /mingw32/.match(host)
     end
 
     # will return true if the cli is running on an apple computer.
@@ -68,6 +76,11 @@ module ShopifyCli
       os == :linux
     end
 
+    # will return true if the cli is running on Windows
+    def windows?
+      os == :windows
+    end
+
     # will return true if the cli is being run from an installation, and not a
     # development instance. The gem installation will not have a 'test' directory.
     # See `#development?` for checking for development environment.
@@ -418,6 +431,45 @@ module ShopifyCli
       end
     end
 
+    # Checks if the given command exists in the system
+    #
+    # #### Parameters
+    # - `cmd`: The command to test
+    #
+    # #### Returns
+    # The path of the executable if it is found
+    #
+    # @todo This is currently a duplicate of CLI::Kit::System.which() - we should make that method public when we make
+    #       Kit changes and make this a wrapper instead.
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(File.expand_path(path), "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+
+      nil
+    end
+
+    # Checks if there's a newer version of the CLI available and returns version string if
+    # this should be conveyed to the user (i.e., if it's been over 24 hours since last check)
+    #
+    # #### Parameters
+    #
+    # #### Returns
+    # - `version`: string of newer version available, IFF new version is available AND it's time to inform user,
+    #            : nil otherwise
+    #
+    def new_version
+      if (time_of_last_check + VERSION_CHECK_INTERVAL) < (now = Time.now.to_i)
+        update_time_of_last_check(now)
+        latest_version = retrieve_latest_gem_version
+        latest_version unless latest_version == ShopifyCli::VERSION
+      end
+    end
+
     private
 
     def ctx_path(fname)
@@ -428,5 +480,21 @@ module ShopifyCli
         File.join(root, fname)
       end
     end
+
+    def retrieve_latest_gem_version
+      response = Net::HTTP.get_response(GEM_LATEST_URI)
+      latest = JSON.parse(response.body)
+      latest["version"]
+    rescue
+      nil
+    end
+
+    def time_of_last_check
+      (val = ShopifyCli::Config.get(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD)) ? val.to_i : 0
+    end
+
+    def update_time_of_last_check(time)
+      ShopifyCli::Config.set(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD, time)
+    end
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -28,6 +28,9 @@ module ShopifyCli
             ctx.puts(
               ctx.message('core.warning.development_version', File.join(ShopifyCli::ROOT, 'bin', ShopifyCli::TOOL_NAME))
             )
+          else
+            new_version = ctx.new_version
+            ctx.puts(ctx.message('core.warning.new_version', ShopifyCli::VERSION, new_version)) unless new_version.nil?
           end
 
           ProjectType.load_type(Project.current_project_type)
@@ -35,7 +38,7 @@ module ShopifyCli
           task_registry = ShopifyCli::Tasks::Registry
 
           command, command_name, args = ShopifyCli::Resolver.call(args)
-          executor = ShopifyCli::Core::Executor.new(ctx, task_registry, log_file: ShopifyCli::LOG_FILE)
+          executor = ShopifyCli::Core::Executor.new(ctx, task_registry, log_file: ShopifyCli.log_file)
           ShopifyCli::Core::Monorail.log(command_name, args) do
             executor.call(command, command_name, args)
           end

data/lib/shopify-cli/core/executor.rb

@@ -3,16 +3,14 @@ require 'shopify_cli'
 module ShopifyCli
   module Core
     class Executor < CLI::Kit::Executor
-      def initialize(ctx, task_registry, *args)
+      def initialize(ctx, task_registry, *args, **kwargs)
         @ctx = ctx || ShopifyCli::Context.new
         @task_registry = task_registry || ShopifyCli::Tasks::TaskRegistry.new
-        super(*args)
+        super(*args, **kwargs)
       end
 
       def call(command, command_name, args)
-        command.prerequisite_tasks.each do |task, _|
-          @task_registry[task]&.call(@ctx)
-        end
+        command.task_registry = @task_registry
         command.ctx = @ctx
         super
       end