shopify-cli 2.2.2 → 2.6.0

data/lib/{shopify-cli → shopify_cli}/js_system.rb

@@ -1,8 +1,8 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::JsSystem allows conditional system calls of npm or yarn commands.
+  # ShopifyCLI::JsSystem allows conditional system calls of npm or yarn commands.
   #
   class JsSystem
     include SmartProperties
@@ -12,21 +12,21 @@ module ShopifyCli
 
     class << self
       ##
-      # Proxy to instance method `ShopifyCli::JsSystem.new.yarn?`
+      # Proxy to instance method `ShopifyCLI::JsSystem.new.yarn?`
       #
       # #### Parameters
       # - `ctx`: running context from your command
       #
       # #### Example
       #
-      #   ShopifyCli::JsSystem.yarn?(ctx)
+      #   ShopifyCLI::JsSystem.yarn?(ctx)
       #
       def yarn?(ctx)
         JsSystem.new(ctx: ctx).yarn?
       end
 
       ##
-      # Proxy to instance method `ShopifyCli::JsSystem.new.call`
+      # Proxy to instance method `ShopifyCLI::JsSystem.new.call`
       #
       # #### Parameters
       # - `ctx`: running context from your command
@@ -35,21 +35,21 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   ShopifyCli::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+      #   ShopifyCLI::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
       #
       def call(ctx, yarn:, npm:, capture_response: false)
         JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm, capture_response: capture_response)
       end
     end
 
-    property :ctx, accepts: ShopifyCli::Context
+    property :ctx, accepts: ShopifyCLI::Context
 
     ##
     # Returns the name of the JS package manager being used
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).package_manager
+    #   ShopifyCLI::JsSystem.new(ctx: ctx).package_manager
     #
     def package_manager
       yarn? ? YARN_CORE_COMMAND : NPM_CORE_COMMAND
@@ -60,7 +60,7 @@ module ShopifyCli
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).yarn?
+    #   ShopifyCLI::JsSystem.new(ctx: ctx).yarn?
     #
     def yarn?
       @has_yarn ||= begin
@@ -80,7 +80,7 @@ module ShopifyCli
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).call(
+    #   ShopifyCLI::JsSystem.new(ctx: ctx).call(
     #     yarn: ['install', '--silent'],
     #     npm: ['install', '--no-audit'],
     #     capture_response: false

data/lib/{shopify-cli → shopify_cli}/lazy_delegator.rb

@@ -1,6 +1,6 @@
 require "delegate"
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # `LazyDelegator` defers initialization of its underlying delegatee until the
   # latter is accessed for the first time due to a method call that the
@@ -16,7 +16,7 @@ module ShopifyCli
   # LazyDelegator lends itself to being subclassed in scenarios where some
   # facts are known and others are costly to compute:
   #
-  #   class LazySpecificationHandler < ShopifyCli::LazyDelegator
+  #   class LazySpecificationHandler < ShopifyCLI::LazyDelegator
   #     attr_reader :identifier
   #
   #     def initialize(identifier, &initializer)

data/lib/{shopify-cli → shopify_cli}/messages/messages.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Messages
     MESSAGES = {
       apps: {
@@ -14,6 +14,25 @@ module ShopifyCli
         },
       },
       core: {
+        error_reporting: {
+          unhandled_error: {
+            message: "{{x}} {{red:An unexpected error occured.}}",
+            issue_message: "{{red:\tTo \e]8;;#{ShopifyCLI::Constants::Links::NEW_ISSUE}\e\\submit an issue\e]8;;\e\\"\
+              " include the stack trace.}}",
+            stacktrace_message: "{{red:\tTo print the stack trace, add the environment variable %s.}}",
+          },
+          enable_automatic_reporting_prompt: {
+            question: "Automatically send error reports moving forward?",
+            yes: "Automatically send error reports to the Shopify team",
+            no: "Don't send error reports",
+            enabled: "Anonymized error reports will be sent to Shopify.",
+          },
+          report_error: {
+            question: "Send an error report to Shopify?",
+            yes: "Send report",
+            no: "Don't send",
+          },
+        },
         connect: {
           already_connected_warning: "{{yellow:! This app appears to be already connected}}",
           project_type_select: "What type of project would you like to connect?",
@@ -67,10 +86,18 @@ module ShopifyCli
             repo_not_initiated:
               "Git repo is not initiated. Please run {{command:git init}} and make at least one commit.",
             no_commits_made: "No git commits have been made. Please make at least one commit.",
+            remote_not_added: "Remote could not be added.",
+            sparse_checkout_not_enabled: "Sparse checkout could not be enabled.",
+            sparse_checkout_not_set: "Sparse checkout set command failed.",
+            pull_failed: "Pull failed.",
+            pull_failed_bad_branch: "Pull failed. Branch %s cannot be found. Check the branch name and try again.",
           },
 
           cloning: "Cloning %s into %s…",
           cloned: "{{v}} Cloned into %s",
+          pulling_from_to: "Pulling %s into %s…",
+          pulling: "Pulling…",
+          pulled: "Pulled into %s",
         },
 
         help: {
@@ -92,6 +119,8 @@ module ShopifyCli
             download: "Heroku CLI could not be downloaded",
             install: "Could not install Heroku CLI",
             could_not_select_app: "Heroku app {{green:%s}} could not be selected",
+            set_config: "Failed to set config %s to %s in Heroku app",
+            add_buildpacks: "Failed to add buildpacks in Heroku app",
           },
         },
 
@@ -188,6 +217,20 @@ module ShopifyCli
           },
         },
 
+        php_deps: {
+          error: {
+            missing_package: "Expected to have a file at: %s",
+            invalid_package: "{{info:%s}} was not valid JSON. Fix this then try again",
+            install: "Failed to install %s packages",
+            install_spinner_error: "Unable to install all %d dependencies",
+            install_error: "An error occurred while installing dependencies",
+          },
+
+          installing: "Installing Composer dependencies…",
+          installed: "Dependencies installed",
+          installed_count: "%d dependencies installed",
+        },
+
         api: {
           error: {
             failed_auth: "Failed to authenticate with Shopify. Please try again later.",
@@ -413,7 +456,6 @@ module ShopifyCli
             ngrok: "Something went wrong with ngrok installation,"\
               "please make sure %s exists within %s before trying again",
           },
-
           installing: "Installing ngrok…",
           not_running: "{{green:x}} ngrok tunnel not running",
           prereq_command_location: "%s @ %s",

data/lib/{shopify-cli → shopify_cli}/method_object.rb

@@ -1,9 +1,9 @@
-module ShopifyCli
+module ShopifyCLI
   ##
   # The `MethodObject` mixin can be included in any class that implements `call`
   # to ensure that
   #
-  # * `call` will always return a `ShopifyCli::Result` by prepending a module
+  # * `call` will always return a `ShopifyCLI::Result` by prepending a module
   #   that takes care of the result wrapping and
   # * a `to_proc` method that allows instances of this class to be passed as a
   #   block.
@@ -42,18 +42,20 @@ module ShopifyCli
   #   constructed using the `&` operator,
   # * error handling is deferred until the result is unwrapped.
   #
-  # Please see the section for `ShopifyCli::Result`,
-  # `ShopifyCli::Result::Success`, and `ShopifyCli::Result::Failure` for more
+  # Please see the section for `ShopifyCLI::Result`,
+  # `ShopifyCLI::Result::Success`, and `ShopifyCLI::Result::Failure` for more
   # information on the API of result objects.
   #
   module MethodObject
     module AutoCreateResultObject
+      def self.ruby2_keywords(*); end unless respond_to?(:ruby2_keywords, true)
+
       ##
       # invokes the original `call` implementation and wraps its return value
       # into a result object.
       #
-      def call(*args, **kwargs, &block)
-        Result.wrap { kwargs.any? ? super(*args, **kwargs, &block) : super(*args, &block) }.call
+      ruby2_keywords def call(*args, &block)
+        Result.wrap { super(*args, &block) }.call
       end
     end
 
@@ -66,8 +68,13 @@ module ShopifyCli
       #
       def call(*args, **kwargs, &block)
         properties.keys.yield_self do |properties|
-          new(**kwargs.slice(*properties))
-            .call(*args, **kwargs.slice(*(kwargs.keys - properties)), &block)
+          instance = new(**kwargs.slice(*properties))
+          kwargs = kwargs.slice(*(kwargs.keys - properties))
+          if kwargs.any?
+            instance.call(*args, **kwargs, &block)
+          else
+            instance.call(*args, &block)
+          end
         end
       end
 

data/lib/shopify_cli/migrator/migration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "date"
+
+module ShopifyCLI
+  module Migrator
+    class Migration
+      attr_reader :name, :path, :date
+
+      def initialize(name:, path:, date:)
+        @name = name
+        @path = path
+        @date = date
+      end
+
+      def run
+        require(path)
+        ShopifyCli::Migrator::Migrations.const_get(class_name).run
+      rescue StandardError
+        # Continue
+      end
+
+      def class_name
+        name.split("_").collect(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/shopify_cli/migrator/migrations/1631709766_noop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Migrator
+    module Migrations
+      class Base
+        def self.run
+          # This is a noop migration to be used as a reference
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/migrator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require "date"
+
+module ShopifyCLI
+  module Migrator
+    autoload :Migration, "shopify_cli/migrator/migration"
+
+    def self.migrate(
+      migrations_directory: File.expand_path("migrator/migrations", __dir__)
+    )
+      baseline_date = last_migration_date
+      unless baseline_date.nil?        
+        migrations = migrations(migrations_directory: migrations_directory)
+          .select { |m| 
+            m.date > baseline_date.to_i 
+          }
+          .each { |m| m.run }
+      end
+
+      store_last_migration_date
+    end
+
+    private
+
+    def self.store_last_migration_date
+      ShopifyCLI::DB.set(ShopifyCLI::Constants::StoreKeys::LAST_MIGRATION_DATE => Time.now.to_i)
+    end
+    
+    def self.last_migration_date
+      ShopifyCLI::DB.get(ShopifyCLI::Constants::StoreKeys::LAST_MIGRATION_DATE)
+    end
+
+    def self.migrations(migrations_directory:)
+      Dir.glob(File.join(migrations_directory, "*.rb")).map do |file_path|
+        file_name = File.basename(file_path).gsub(".rb", "")
+        file_name_components = file_name.split("_")
+        date_timestamp = file_name_components[0].to_i
+        migration_name = file_name_components[1...].join("_")
+
+        Migrator::Migration.new(
+          name: migration_name,
+          date: Time.at(date_timestamp).to_i,
+          path: file_path
+        )
+      end
+    end
+  end
+end

data/lib/{shopify-cli → shopify_cli}/options.rb

@@ -2,7 +2,7 @@
 require "shopify_cli"
 require "optparse"
 
-module ShopifyCli
+module ShopifyCLI
   class Options
     include SmartProperties
 

data/lib/{shopify-cli → shopify_cli}/packager.rb

@@ -1,7 +1,7 @@
-module ShopifyCli
+module ShopifyCLI
   class Packager
-    PACKAGING_DIR = File.join(ShopifyCli::ROOT, "packaging")
-    BUILDS_DIR = File.join(PACKAGING_DIR, "builds", ShopifyCli::VERSION)
+    PACKAGING_DIR = File.join(ShopifyCLI::ROOT, "packaging")
+    BUILDS_DIR = File.join(PACKAGING_DIR, "builds", ShopifyCLI::VERSION)
 
     def initialize
       FileUtils.mkdir_p(BUILDS_DIR)
@@ -24,7 +24,7 @@ module ShopifyCli
         file_path = File.join(debian_dir, file)
 
         file_contents = File.read(File.join(root_dir, "#{file}.base"))
-        file_contents = file_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
+        file_contents = file_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCLI::VERSION)
         File.open(file_path, "w", 0775) { |f| f.write(file_contents) }
       end
 
@@ -33,7 +33,7 @@ module ShopifyCli
       raise "Failed to build package" unless system("dpkg-deb", "-b", "shopify-cli")
 
       output_path = File.join(root_dir, "shopify-cli.deb")
-      final_path = File.join(BUILDS_DIR, "shopify-cli-#{ShopifyCli::VERSION}.deb")
+      final_path = File.join(BUILDS_DIR, "shopify-cli-#{ShopifyCLI::VERSION}.deb")
 
       puts "Moving generated package: \n  From: #{output_path}\n  To: #{final_path}\n\n"
       FileUtils.mv(output_path, final_path)
@@ -53,7 +53,7 @@ module ShopifyCli
       File.delete(spec_path) if File.exist?(spec_path)
 
       spec_contents = File.read(File.join(root_dir, "shopify-cli.spec.base"))
-      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCLI::VERSION)
       File.write(spec_path, spec_contents)
 
       puts "Building package…"
@@ -76,12 +76,12 @@ module ShopifyCli
       File.delete(build_path) if File.exist?(build_path)
 
       spec_contents = File.read(File.join(root_dir, "shopify-cli.base.rb"))
-      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCLI::VERSION)
 
       puts "Grabbing sha256 checksum from Rubygems.org"
       require "digest/sha2"
       require "open-uri"
-      gem_checksum = open("https://rubygems.org/downloads/shopify-cli-#{ShopifyCli::VERSION}.gem") do |io|
+      gem_checksum = open("https://rubygems.org/downloads/shopify-cli-#{ShopifyCLI::VERSION}.gem") do |io|
         Digest::SHA256.new.hexdigest(io.read)
       end
 

data/lib/{shopify-cli → shopify_cli}/partners_api/organizations.rb

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   class PartnersAPI
     class Organizations
       class << self

data/lib/{shopify-cli → shopify_cli}/partners_api.rb

@@ -1,22 +1,12 @@
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::PartnersAPI provides easy access to the partners dashboard CLI
+  # ShopifyCLI::PartnersAPI provides easy access to the partners dashboard CLI
   # schema.
   #
   class PartnersAPI < API
-    autoload :Organizations, "shopify-cli/partners_api/organizations"
-
-    # Defines the environment variable that this API looks for to operate on local
-    # services. If you set this environment variable in your shell then the partners
-    # API will operate on your local instance
-    #
-    # #### Example
-    #
-    #  SHOPIFY_APP_CLI_LOCAL_PARTNERS=1 shopify create
-    #
-    LOCAL_DEBUG = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
+    autoload :Organizations, "shopify_cli/partners_api/organizations"
 
     class << self
       ##
@@ -31,10 +21,10 @@ module ShopifyCli
       #
       # #### Raises
       #
-      # * http 404 will raise a ShopifyCli::API::APIRequestNotFoundError
-      # * http 400..499 will raise a ShopifyCli::API::APIRequestClientError
-      # * http 500..599 will raise a ShopifyCli::API::APIRequestServerError
-      # * All other codes will raise ShopifyCli::API::APIRequestUnexpectedError
+      # * http 404 will raise a ShopifyCLI::API::APIRequestNotFoundError
+      # * http 400..499 will raise a ShopifyCLI::API::APIRequestClientError
+      # * http 500..599 will raise a ShopifyCLI::API::APIRequestServerError
+      # * All other codes will raise ShopifyCLI::API::APIRequestUnexpectedError
       #
       # #### Returns
       #
@@ -42,13 +32,13 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   ShopifyCli::PartnersAPI.query(@ctx, 'all_organizations')
+      #   ShopifyCLI::PartnersAPI.query(@ctx, 'all_organizations')
       #
       def query(ctx, query_name, **variables)
         CLI::Kit::Util.begin do
           api_client(ctx).query(query_name, variables: variables)
         end.retry_after(API::APIRequestUnauthorizedError, retries: 1) do
-          ShopifyCli::IdentityAuth.new(ctx: ctx).reauthenticate
+          ShopifyCLI::IdentityAuth.new(ctx: ctx).reauthenticate
         end
       rescue API::APIRequestUnauthorizedError => e
         if (request_info = auth_failure_info(ctx, e))
@@ -56,14 +46,14 @@ module ShopifyCli
         end
         ctx.abort(ctx.message("core.api.error.failed_auth"))
       rescue API::APIRequestNotFoundError
-        ctx.puts(ctx.message("core.partners_api.error.account_not_found", ShopifyCli::TOOL_NAME))
+        ctx.puts(ctx.message("core.partners_api.error.account_not_found", ShopifyCLI::TOOL_NAME))
       end
 
-      def partners_url_for(organization_id, api_client_id, local_debug)
-        if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+      def partners_url_for(organization_id, api_client_id)
+        if ShopifyCLI::Shopifolk.acting_as_shopify_organization?
           organization_id = "internal"
         end
-        "#{partners_endpoint(local_debug)}/#{organization_id}/apps/#{api_client_id}"
+        "https://#{Environment.partners_domain}/#{organization_id}/apps/#{api_client_id}"
       end
 
       private
@@ -72,29 +62,15 @@ module ShopifyCli
         new(
           ctx: ctx,
           token: access_token(ctx),
-          url: "#{endpoint}/api/cli/graphql",
+          url: "https://#{Environment.partners_domain}/api/cli/graphql",
         )
       end
 
       def access_token(ctx)
-        ShopifyCli::DB.get(:partners_exchange_token) do
+        ShopifyCLI::DB.get(:partners_exchange_token) do
           IdentityAuth.new(ctx: ctx).authenticate
-          ShopifyCli::DB.get(:partners_exchange_token)
-        end
-      end
-
-      def endpoint
-        return "https://partners.shopify.com" if ENV[LOCAL_DEBUG].nil?
-        "https://partners.myshopify.io/"
-      end
-
-      def partners_endpoint(local_debug)
-        domain = if local_debug
-          "partners.myshopify.io"
-        else
-          "partners.shopify.com"
+          ShopifyCLI::DB.get(:partners_exchange_token)
         end
-        "https://#{domain}"
       end
 
       def auth_failure_info(ctx, error)

data/lib/shopify_cli/php_deps.rb

@@ -0,0 +1,102 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  ##
+  # ShopifyCLI::PHPDeps ensures that all PHP dependencies are installed for projects.
+  #
+  class PHPDeps
+    include SmartProperties
+
+    property! :ctx, accepts: ShopifyCLI::Context
+
+    ##
+    # Proxy to instance method ShopifyCLI::PHPDeps.new.install.
+    #
+    # #### Parameters
+    # - `ctx`: running context from your command
+    # - `verbose`: whether to run the installation tools in verbose mode
+    #
+    # #### Example
+    #
+    #   ShopifyCLI::PHPDeps.install(ctx)
+    #
+    def self.install(ctx, verbose = false)
+      new(ctx: ctx).install(verbose)
+    end
+
+    ##
+    # Installs all of a project's PHP dependencies using Composer.
+    #
+    # #### Parameters
+    # - `verbose`: whether to run the installation tools in verbose mode
+    #
+    # #### Example
+    #
+    #   # context is the running context for the command
+    #   ShopifyCLI::PHPDeps.new(context).install(true)
+    #
+    def install(verbose = false)
+      title = ctx.message("core.php_deps.installing")
+      success = ctx.message("core.php_deps.installed")
+      failure = ctx.message("core.php_deps.error.install_error")
+
+      CLI::UI::Frame.open(title, success_text: success, failure_text: failure) do
+        composer(verbose)
+      end
+    end
+
+    private
+
+    def composer(verbose = false)
+      cmd = %w(composer install)
+      cmd << "--quiet" unless verbose
+
+      run_install_command(cmd)
+    end
+
+    def run_install_command(cmd)
+      deps = parse_dependencies
+      errors = nil
+
+      spinner_title = ctx.message("core.php_deps.installing")
+      success = CLI::UI::Spinner.spin(spinner_title, auto_debrief: false) do |spinner|
+        _out, errors, status = CLI::Kit::System.capture3(*cmd, env: @ctx.env, chdir: ctx.root)
+        update_spinner_title_and_status(spinner, status, deps)
+      end
+
+      errors.lines.each { |e| ctx.puts e } unless success || errors.nil?
+
+      ctx.abort(ctx.message("core.php_deps.error.install", "Composer")) unless success
+      success
+    end
+
+    def update_spinner_title_and_status(spinner, status, deps)
+      if status.success?
+        spinner.update_title(ctx.message("core.php_deps.installed_count", deps.size))
+      else
+        spinner.update_title(ctx.message("core.php_deps.error.install_spinner_error", deps.size))
+        CLI::UI::Spinner::TASK_FAILED
+      end
+    end
+
+    def parse_dependencies
+      composer_json = File.join(ctx.root, "composer.json")
+      pkg =
+        begin
+          JSON.parse(File.read(composer_json))
+        rescue Errno::ENOENT, Errno::ENOTDIR
+          ctx.abort(ctx.message("core.php_deps.error.missing_package", composer_json))
+        end
+
+      %w(require require-dev).map do |key|
+        pkg.fetch(key, []).keys
+      end.flatten
+    rescue JSON::ParserError
+      ctx.puts(
+        ctx.message("core.php_deps.error.invalid_package", File.read(File.join(path, "composer.json"))),
+        error: true
+      )
+      raise ShopifyCLI::AbortSilent
+    end
+  end
+end