RubyGems - shopify-cli - Versions diffs - 2.4.0 → 2.5.0 - Mend

shopify-cli 2.4.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (223) hide show

data/lib/{shopify-cli → shopify_cli}/http_request.rb RENAMED Viewed

@@ -1,7 +1,7 @@
 require "net/http"
 require "openssl"
-module ShopifyCli
+module ShopifyCLI
   class HttpRequest
     class << self
       def post(uri, body, headers)

data/lib/{shopify-cli → shopify_cli}/identity_auth/servlet.rb RENAMED Viewed

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   class IdentityAuth
     class Servlet < WEBrick::HTTPServlet::AbstractServlet
       TEMPLATE = %{<!DOCTYPE html>

data/lib/{shopify-cli → shopify_cli}/identity_auth.rb RENAMED Viewed

@@ -8,11 +8,11 @@ require "shopify_cli"
 require "uri"
 require "webrick"
-module ShopifyCli
+module ShopifyCLI
   class IdentityAuth
     include SmartProperties
-    autoload :Servlet, "shopify-cli/identity_auth/servlet"
+    autoload :Servlet, "shopify_cli/identity_auth/servlet"
     class Error < StandardError; end
     class Timeout < StandardError; end
@@ -49,7 +49,7 @@ module ShopifyCli
     ]
     property! :ctx
-    property :store, default: -> { ShopifyCli::DB.new }
+    property :store, default: -> { ShopifyCLI::DB.new }
     property :state_token, accepts: String, default: SecureRandom.hex(30)
     property :code_verifier, accepts: String, default: SecureRandom.hex(30)
@@ -70,7 +70,7 @@ module ShopifyCli
     def reauthenticate
       return if refresh_exchange_tokens || refresh_access_tokens
-      ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCli::TOOL_NAME))
+      ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCLI::TOOL_NAME))
     end
     def code_challenge
@@ -93,8 +93,8 @@ module ShopifyCli
     end
     def self.delete_tokens_and_keys
-      ShopifyCli::DB.del(*IDENTITY_ACCESS_TOKENS)
-      ShopifyCli::DB.del(*EXCHANGE_TOKENS)
+      ShopifyCLI::DB.del(*IDENTITY_ACCESS_TOKENS)
+      ShopifyCLI::DB.del(*EXCHANGE_TOKENS)
     end
     private
@@ -212,7 +212,7 @@ module ShopifyCli
       https = Net::HTTP.new(uri.host, uri.port)
       https.use_ssl = true
       request = Net::HTTP::Post.new(uri.path)
-      request["User-Agent"] = "Shopify CLI #{::ShopifyCli::VERSION}"
+      request["User-Agent"] = "Shopify CLI #{::ShopifyCLI::VERSION}"
       request.body = URI.encode_www_form(params)
       res = https.request(request)
       unless res.is_a?(Net::HTTPSuccess)
@@ -256,7 +256,7 @@ module ShopifyCli
     def scopes(additional_scopes = [])
       (["openid"] + additional_scopes).tap do |result|
-        result << "employee" if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        result << "employee" if ShopifyCLI::Shopifolk.acting_as_shopify_organization?
       end.join(" ")
     end

data/lib/{shopify-cli → shopify_cli}/js_deps.rb RENAMED Viewed

@@ -1,17 +1,17 @@
 require "shopify_cli"
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::JsDeps ensures that all JavaScript dependencies are installed for projects.
+  # ShopifyCLI::JsDeps ensures that all JavaScript dependencies are installed for projects.
   #
   class JsDeps
     include SmartProperties
-    property! :ctx, accepts: ShopifyCli::Context
+    property! :ctx, accepts: ShopifyCLI::Context
     property! :system, accepts: JsSystem, default: -> { JsSystem.new(ctx: ctx) }
     ##
-    # Proxy to instance method ShopifyCli::JsDeps.new.install.
+    # Proxy to instance method ShopifyCLI::JsDeps.new.install.
     #
     # #### Parameters
     # - `ctx`: running context from your command
@@ -19,7 +19,7 @@ module ShopifyCli
     #
     # #### Example
     #
-    #   ShopifyCli::JsDeps.install(ctx)
+    #   ShopifyCLI::JsDeps.install(ctx)
     #
     def self.install(ctx, verbose = false)
       new(ctx: ctx).install(verbose)
@@ -34,7 +34,7 @@ module ShopifyCli
     # #### Example
     #
     #   # context is the running context for the command
-    #   ShopifyCli::JsDeps.new(context).install(true)
+    #   ShopifyCLI::JsDeps.new(context).install(true)
     #
     def install(verbose = false)
       title = ctx.message("core.js_deps.installing", @system.package_manager)
@@ -104,7 +104,7 @@ module ShopifyCli
         ctx.message("core.js_deps.error.invalid_package", File.read(File.join(path, "package.json"))),
         error: true
       )
-      raise ShopifyCli::AbortSilent
+      raise ShopifyCLI::AbortSilent
     end
   end
 end

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

@@ -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 RENAMED Viewed

@@ -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 RENAMED Viewed

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module ShopifyCli
+module ShopifyCLI
   module Messages
     MESSAGES = {
       apps: {
@@ -92,6 +92,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 +190,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.",

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

@@ -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,8 +42,8 @@ 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

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

@@ -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 RENAMED Viewed

@@ -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 RENAMED Viewed

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

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

@@ -1,12 +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"
+    autoload :Organizations, "shopify_cli/partners_api/organizations"
     class << self
       ##
@@ -21,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
       #
@@ -32,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))
@@ -46,11 +46,11 @@ 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)
-        if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        if ShopifyCLI::Shopifolk.acting_as_shopify_organization?
           organization_id = "internal"
         end
         "https://#{Environment.partners_domain}/#{organization_id}/apps/#{api_client_id}"
@@ -67,9 +67,9 @@ module ShopifyCli
       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)
+          ShopifyCLI::DB.get(:partners_exchange_token)
         end
       end

data/lib/shopify_cli/php_deps.rb ADDED Viewed

@@ -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

data/lib/{shopify-cli → shopify_cli}/process_supervision.rb RENAMED Viewed

@@ -1,6 +1,6 @@
 require "fileutils"
-module ShopifyCli
+module ShopifyCLI
   ##
   # ProcessSupervision wraps a running process spawned by `exec` and keeps track
   # if its `pid` and keeps a log file for it as well
@@ -19,7 +19,7 @@ module ShopifyCli
     class << self
       def run_dir
         # is the directory where the pid and logfile are kept
-        File.join(ShopifyCli.cache_dir, "sv")
+        File.join(ShopifyCLI.cache_dir, "sv")
       end
       ##
@@ -36,7 +36,7 @@ module ShopifyCli
       #   will be nil if the process is not running.
       #
       def for_ident(identifier)
-        pid, time = File.read(File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")).split(":")
+        pid, time = File.read(File.join(ShopifyCLI::ProcessSupervision.run_dir, "#{identifier}.pid")).split(":")
         new(identifier, pid: Integer(pid), time: time)
       rescue Errno::ENOENT
         nil
@@ -50,19 +50,21 @@ module ShopifyCli
       #
       # * `identifier` - a string or symbol to identify the new process by.
       # * `args` - a command to run, either a string or array of strings
+      # * `force_spawn` - whether we want the child process to be a spawn and not a fork, so it is terminated along with
+      #                   the parent
       #
       # #### Returns
       #
       # * `process` - ProcessSupervision instance if the process is running, this
       #   will be nil if the process did not start.
       #
-      def start(identifier, args)
+      def start(identifier, args, force_spawn: false)
         return for_ident(identifier) if running?(identifier)
         # Some systems don't support forking process without extra gems, so we resort to spawning a new child process -
         # that means that it dies along with the original process if it is interrupted. If possible, we fork the process
         # so that it doesn't have to be restarted on every run.
-        if Process.respond_to?(:fork)
+        if Process.respond_to?(:fork) && !force_spawn
           fork do
             pid_file = new(identifier, pid: Process.pid)
             pid_file.write
@@ -132,9 +134,9 @@ module ShopifyCli
       @identifier = identifier
       @pid = pid
       @time = time
-      FileUtils.mkdir_p(ShopifyCli::ProcessSupervision.run_dir)
-      @pid_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")
-      @log_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.log")
+      FileUtils.mkdir_p(ShopifyCLI::ProcessSupervision.run_dir)
+      @pid_path = File.join(ShopifyCLI::ProcessSupervision.run_dir, "#{identifier}.pid")
+      @log_path = File.join(ShopifyCLI::ProcessSupervision.run_dir, "#{identifier}.log")
     end
     ##