shopify-cli 2.4.0 → 2.6.2

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

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

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

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 require "shopify_cli"
 
-module ShopifyCli
+module ShopifyCLI
   ##
-  # ShopifyCli::Project captures the current project that the user is working on.
+  # ShopifyCLI::Project captures the current project that the user is working on.
   # This class can be used to fetch and save project environment as well as the
   # project config `.shopify-cli.yml`.
   #
@@ -25,13 +25,13 @@ module ShopifyCli
       #
       # #### Raises
       #
-      # * `ShopifyCli::Abort` - If the cli is not currently in a project directory
+      # * `ShopifyCLI::Abort` - If the cli is not currently in a project directory
       #   then this will be raised with a message implying that the user is not in
       #   a project directory.
       #
       # #### Example
       #
-      #   project = ShopifyCli::Project.current
+      #   project = ShopifyCLI::Project.current
       #
       def current(force_reload: false)
         clear if force_reload
@@ -60,7 +60,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   type = ShopifyCli::Project.current_project_type
+      #   type = ShopifyCLI::Project.current_project_type
       #
       def current_project_type
         return unless has_current?
@@ -81,7 +81,7 @@ module ShopifyCli
       #
       # #### Example
       #
-      #   type = ShopifyCli::Project.current_project_type
+      #   type = ShopifyCLI::Project.current_project_type
       #
       def write(ctx, project_type:, organization_id:, **identifiers)
         require "yaml" # takes 20ms, so deferred as late as possible.
@@ -113,7 +113,7 @@ module ShopifyCli
       def at(dir)
         proj_dir = directory(dir)
         unless proj_dir
-          raise(ShopifyCli::Abort, Context.message("core.project.error.not_in_project"))
+          raise(ShopifyCLI::Abort, Context.message("core.project.error.not_in_project"))
         end
         @at ||= Hash.new { |h, k| h[k] = new(directory: k) }
         @at[proj_dir]
@@ -136,11 +136,11 @@ module ShopifyCli
     #
     # #### Returns
     #
-    # * `env` - An instance of a ShopifyCli::Resources::EnvFile
+    # * `env` - An instance of a ShopifyCLI::Resources::EnvFile
     #
     # #### Example
     #
-    #   ShopifyCli::Project.current.env
+    #   ShopifyCLI::Project.current.env
     #
     def env
       @env ||= begin
@@ -159,18 +159,18 @@ module ShopifyCli
     #
     # #### Raises
     #
-    # * `ShopifyCli::Abort` - If the yml is invalid or poorly formatted
-    # * `ShopifyCli::Abort` - If the yml file does not exist
+    # * `ShopifyCLI::Abort` - If the yml is invalid or poorly formatted
+    # * `ShopifyCLI::Abort` - If the yml file does not exist
     #
     # #### Example
     #
-    #   ShopifyCli::Project.current.config
+    #   ShopifyCLI::Project.current.config
     #
     def config
       @config ||= begin
         config = load_yaml_file(".shopify-cli.yml")
         unless config.is_a?(Hash)
-          raise ShopifyCli::Abort, Context.message("core.yaml.error.not_hash", ".shopify-cli.yml")
+          raise ShopifyCLI::Abort, Context.message("core.yaml.error.not_hash", ".shopify-cli.yml")
         end
 
         # The app_type key was deprecated in favour of project_type, so replace it
@@ -191,12 +191,12 @@ module ShopifyCli
       begin
         YAML.load_file(f)
       rescue Psych::SyntaxError => e
-        raise(ShopifyCli::Abort, Context.message("core.yaml.error.invalid", relative_path, e.message))
+        raise(ShopifyCLI::Abort, Context.message("core.yaml.error.invalid", relative_path, e.message))
       # rescue Errno::EACCES => e
       # TODO
       #   Dev::Helpers::EaccesHandler.diagnose_and_raise(f, e, mode: :read)
       rescue Errno::ENOENT
-        raise ShopifyCli::Abort, Context.message("core.yaml.error.not_found", f)
+        raise ShopifyCLI::Abort, Context.message("core.yaml.error.not_found", f)
       end
     end
   end

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

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   class ProjectCommands < Command
     def call(*)
       @ctx.puts(self.class.help)
@@ -6,9 +6,9 @@ module ShopifyCli
 
     def self.help
       project_type = name.split("::")[0].downcase
-      ShopifyCli::Context.message(
+      ShopifyCLI::Context.message(
         "#{project_type}.help",
-        ShopifyCli::TOOL_NAME,
+        ShopifyCLI::TOOL_NAME,
         subcommand_registry.command_names.join(" | ")
       )
     end

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

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   class ProjectType
     extend Feature::Set
 
@@ -20,7 +20,7 @@ module ShopifyCli
       end
 
       def load_type(current_type, shallow = false)
-        filepath = File.join(ShopifyCli::ROOT, "lib", "project_types", current_type.to_s, "cli.rb")
+        filepath = File.join(ShopifyCLI::ROOT, "lib", "project_types", current_type.to_s, "cli.rb")
         return unless File.exist?(filepath)
         @shallow_load = shallow
         @current_type = current_type
@@ -31,7 +31,7 @@ module ShopifyCli
       end
 
       def load_all
-        Dir.glob(File.join(ShopifyCli::ROOT, "lib", "project_types", "*", "cli.rb")).map do |filepath|
+        Dir.glob(File.join(ShopifyCLI::ROOT, "lib", "project_types", "*", "cli.rb")).map do |filepath|
           load_type(filepath.split(File::Separator)[-2].to_sym, true)
         end
       end
@@ -41,7 +41,7 @@ module ShopifyCli
       end
 
       def project_filepath(path)
-        File.join(ShopifyCli::PROJECT_TYPES_DIR, project_type.to_s, path)
+        File.join(ShopifyCLI::PROJECT_TYPES_DIR, project_type.to_s, path)
       end
 
       def title(name)
@@ -50,7 +50,7 @@ module ShopifyCli
 
       def register_task(task, name)
         return if project_load_shallow
-        ShopifyCli::Tasks.register(task, name)
+        ShopifyCLI::Tasks.register(task, name)
       end
 
       def register_messages(messages)

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

@@ -4,13 +4,13 @@
 # are resolved relative to `Kernal`, but the top-level namespace is
 # configurable:
 #
-#    ShopifyCli::Resolve.call(:object).value # => Object
-#    ShopifyCli::Resolve.call('minitest/test').value # => MiniTest::Test
-#    ShopifyCli::Resolve.call(:test, namespace: MiniTest) # => MiniTest::Test
+#    ShopifyCLI::Resolve.call(:object).value # => Object
+#    ShopifyCLI::Resolve.call('minitest/test').value # => MiniTest::Test
+#    ShopifyCLI::Resolve.call(:test, namespace: MiniTest) # => MiniTest::Test
 #
-module ShopifyCli
+module ShopifyCLI
   class ResolveConstant
-    include ShopifyCli::MethodObject
+    include ShopifyCLI::MethodObject
     property! :namespace, accepts: ->(ns) { ns.respond_to?(:const_get) }, default: -> { Kernel }
 
     def call(name)

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Resources
     class EnvFile
       include SmartProperties

data/lib/shopify_cli/resources.rb

@@ -0,0 +1,5 @@
+module ShopifyCLI
+  module Resources
+    autoload :EnvFile, "shopify_cli/resources/env_file"
+  end
+end

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

@@ -1,4 +1,4 @@
-module ShopifyCli
+module ShopifyCLI
   ##
   # This module defines two containers for wrapping the result of an action. One
   # for signifying the successful execution of an action and one for signifying
@@ -261,8 +261,8 @@ module ShopifyCli
       end
 
       ##
-      # raises an `ShopifyCli::Result::UnexpectedError` as a
-      # `ShopifyCli::Result::Failure` does not carry a success value.
+      # raises an `ShopifyCLI::Result::UnexpectedError` as a
+      # `ShopifyCLI::Result::Failure` does not carry a success value.
       #
       def value
         raise UnexpectedFailure
@@ -342,7 +342,7 @@ module ShopifyCli
     end
 
     ##
-    # wraps the given value into a `ShopifyCli::Result::Success` container
+    # wraps the given value into a `ShopifyCLI::Result::Success` container
     #
     # #### Parameters
     #
@@ -353,7 +353,7 @@ module ShopifyCli
     end
 
     ##
-    # wraps the given value into a `ShopifyCli::Result::Failure` container
+    # wraps the given value into a `ShopifyCLI::Result::Failure` container
     #
     # #### Parameters
     #
@@ -367,8 +367,8 @@ module ShopifyCli
     # takes either a value or a block and chooses the appropriate result
     # container based on the type of the value or the type of the block's return
     # value. If the type is an exception, it is wrapped in a
-    # `ShopifyCli::Result::Failure` and otherwise in a
-    # `ShopifyCli::Result::Success`. If a block was provided instead of value, a
+    # `ShopifyCLI::Result::Failure` and otherwise in a
+    # `ShopifyCLI::Result::Success`. If a block was provided instead of value, a
     # `Proc` is returned and the result wrapping doesn't occur until the block
     # is invoked.
     #
@@ -384,12 +384,12 @@ module ShopifyCli
     #
     # #### Examples
     #
-    #   Result.wrap(1) # => ShopifyCli::Result::Success
-    #   Result.wrap(RuntimeError.new) # => ShopifyCli::Result::Failure
+    #   Result.wrap(1) # => ShopifyCLI::Result::Success
+    #   Result.wrap(RuntimeError.new) # => ShopifyCLI::Result::Failure
     #
     #   Result.wrap { 1 } # => Proc
-    #   Result.wrap { 1 }.call # => ShopifyCli::Result::Success
-    #   Result.wrap { raise }.call # => ShopifyCli::Result::Failure
+    #   Result.wrap { 1 }.call # => ShopifyCLI::Result::Success
+    #   Result.wrap { raise }.call # => ShopifyCLI::Result::Failure
     #
     #   Result.wrap { |s| s.upcase }.call("hello").tap do |result|
     #     result # => Result::Success