shopify-cli 2.4.0 → 2.5.0

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/proxy.rb

@@ -3,7 +3,7 @@ require "net/http"
 require "stringio"
 require "time"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       HOP_BY_HOP_HEADERS = [
@@ -79,7 +79,7 @@ module ShopifyCli
         end
 
         def bearer_token
-          ShopifyCli::DB.get(:storefront_renderer_production_exchange_token) ||
+          ShopifyCLI::DB.get(:storefront_renderer_production_exchange_token) ||
             raise(KeyError, "storefront_renderer_production_exchange_token missing")
         end
 

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/sse.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "thread"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # Server-Sent events implementation for Rack.

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/watcher.rb

@@ -2,7 +2,7 @@
 require "listen"
 require "observer"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # Watches for file changes and publish events to the theme

data/lib/{shopify-cli → shopify_cli}/theme/dev_server/web_server.rb

@@ -3,7 +3,7 @@
 require "webrick"
 require "stringio"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       # WEBrick will sometimes cause a fatal deadlock error on shutdown.

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

@@ -14,7 +14,7 @@ require_relative "dev_server/certificate_manager"
 
 require "pathname"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     module DevServer
       class << self
@@ -80,8 +80,8 @@ module ShopifyCli
           )
           watcher.stop
 
-        rescue ShopifyCli::API::APIRequestForbiddenError,
-               ShopifyCli::API::APIRequestUnauthorizedError
+        rescue ShopifyCLI::API::APIRequestForbiddenError,
+               ShopifyCLI::API::APIRequestUnauthorizedError
           @ctx.abort("You are not authorized to edit themes on #{theme.shop}.\n" \
                      "Make sure you are a user of that store, and allowed to edit themes.")
         end

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

@@ -4,17 +4,17 @@ require_relative "theme"
 require "socket"
 require "securerandom"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     API_NAME_LIMIT = 50
 
     class DevelopmentTheme < Theme
       def id
-        ShopifyCli::DB.get(:development_theme_id)
+        ShopifyCLI::DB.get(:development_theme_id)
       end
 
       def name
-        existing_name = ShopifyCli::DB.get(:development_theme_name)
+        existing_name = ShopifyCLI::DB.get(:development_theme_name)
         # Up to version 2.3.0 (included) generated names stored locally
         # could have more than 50 characters and the API rejected them.
         # This code ensures we update the name for those users to ensure
@@ -36,27 +36,27 @@ module ShopifyCli
         else
           create
           @ctx.debug("Created temporary development theme: #{@id}")
-          ShopifyCli::DB.set(development_theme_id: @id)
+          ShopifyCLI::DB.set(development_theme_id: @id)
         end
       end
 
       def exists?
         return false unless id
 
-        ShopifyCli::AdminAPI.rest_request(
+        ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: shop,
           path: "themes/#{id}.json",
           api_version: "unstable",
         )
-      rescue ShopifyCli::API::APIRequestNotFoundError
+      rescue ShopifyCLI::API::APIRequestNotFoundError
         false
       end
 
       def delete
         super if exists?
-        ShopifyCli::DB.del(:development_theme_id) if ShopifyCli::DB.exists?(:development_theme_id)
-        ShopifyCli::DB.del(:development_theme_name) if ShopifyCli::DB.exists?(:development_theme_name)
+        ShopifyCLI::DB.del(:development_theme_id) if ShopifyCLI::DB.exists?(:development_theme_id)
+        ShopifyCLI::DB.del(:development_theme_name) if ShopifyCLI::DB.exists?(:development_theme_name)
       end
 
       def self.delete(ctx)
@@ -74,7 +74,7 @@ module ShopifyCli
         identifier = "#{hash}-#{hostname[0, hostname_character_limit]}"
         theme_name = "Development (#{identifier})"
 
-        ShopifyCli::DB.set(development_theme_name: theme_name)
+        ShopifyCLI::DB.set(development_theme_name: theme_name)
 
         theme_name
       end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require_relative "mime_type"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class File < Struct.new(:path)
       attr_reader :relative_path

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class IgnoreFilter
       FILE = ".shopifyignore"

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "webrick"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class MimeType < Struct.new(:name)
       MIME_TYPES = WEBrick::HTTPUtils::DefaultMimeTypes.merge(

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

@@ -3,7 +3,7 @@ require "thread"
 require "json"
 require "base64"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class Syncer
       class Operation < Struct.new(:method, :file)
@@ -80,7 +80,7 @@ module ShopifyCli
       end
 
       def fetch_checksums!
-        _status, response = ShopifyCli::AdminAPI.rest_request(
+        _status, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",
@@ -211,7 +211,7 @@ module ShopifyCli
           used, total = limit.split("/").map(&:to_i)
           backoff_if_near_limit!(used, total)
         end
-      rescue ShopifyCli::API::APIRequestError => e
+      rescue ShopifyCLI::API::APIRequestError => e
         report_error(
           "{{red:ERROR}} {{blue:#{operation}}}:\n  " +
           parse_api_errors(e).join("\n  ")
@@ -228,7 +228,7 @@ module ShopifyCli
           asset[:attachment] = Base64.encode64(file.read)
         end
 
-        _status, body, response = ShopifyCli::AdminAPI.rest_request(
+        _status, body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",
@@ -243,7 +243,7 @@ module ShopifyCli
       end
 
       def get(file)
-        _status, body, response = ShopifyCli::AdminAPI.rest_request(
+        _status, body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",
@@ -265,7 +265,7 @@ module ShopifyCli
       end
 
       def delete(file)
-        _status, _body, response = ShopifyCli::AdminAPI.rest_request(
+        _status, _body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: @theme.shop,
           path: "themes/#{@theme.id}/assets.json",

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

@@ -4,7 +4,7 @@ require_relative "file"
 require "pathname"
 require "time"
 
-module ShopifyCli
+module ShopifyCLI
   module Theme
     class InvalidThemeRole < StandardError; end
 
@@ -101,7 +101,7 @@ module ShopifyCli
       def create
         raise InvalidThemeRole, "Can't create live theme. Use publish." if live?
 
-        _status, body = ShopifyCli::AdminAPI.rest_request(
+        _status, body = ShopifyCLI::AdminAPI.rest_request(
           @ctx,
           shop: shop,
           path: "themes.json",
@@ -144,11 +144,11 @@ module ShopifyCli
       end
 
       def current_development?
-        development? && id == ShopifyCli::DB.get(:development_theme_id)
+        development? && id == ShopifyCLI::DB.get(:development_theme_id)
       end
 
       def foreign_development?
-        development? && id != ShopifyCli::DB.get(:development_theme_id)
+        development? && id != ShopifyCLI::DB.get(:development_theme_id)
       end
 
       def to_h

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

@@ -1,5 +1,5 @@
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # `TransformDataStructure` helps to standardize data structure access. It
   # traverses nested data structures and can convert
@@ -22,13 +22,13 @@ module ShopifyCli
   # Since `TransformDataStructure` is a method object, it can easily be chained:
   #
   #    require 'open-uri'
-  #    ShopifyCli::Result
+  #    ShopifyCLI::Result
   #      .call { open("https://jsonplaceholder.typicode.com/todos/1") }
   #      .map(&TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
   #      .value # => { id: 1, user_id: 1, ... }
   #
   class TransformDataStructure
-    include ShopifyCli::MethodObject
+    include ShopifyCLI::MethodObject
 
     class << self
       private
@@ -53,7 +53,7 @@ module ShopifyCli
           result[transform_key(key)] = call(value).value
         end
       else
-        ShopifyCli::Result.success(object)
+        ShopifyCLI::Result.success(object)
       end
     end
 

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

@@ -4,7 +4,7 @@ require "shopify_cli"
 require "forwardable"
 require "uri"
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # Wraps around ngrok functionality to allow you to spawn a ngrok proccess in the
   # background and stop the process when you need to. It also allows control over
@@ -39,8 +39,8 @@ module ShopifyCli
     # * `ctx` - running context from your command
     #
     def stop(ctx)
-      if ShopifyCli::ProcessSupervision.running?(:ngrok)
-        if ShopifyCli::ProcessSupervision.stop(:ngrok)
+      if ShopifyCLI::ProcessSupervision.running?(:ngrok)
+        if ShopifyCLI::ProcessSupervision.stop(:ngrok)
           ctx.puts(ctx.message("core.tunnel.stopped"))
         else
           ctx.abort(ctx.message("core.tunnel.error.stop"))
@@ -75,7 +75,7 @@ module ShopifyCli
         end
         ctx.puts(ctx.message("core.tunnel.start", url))
         ctx.puts(ctx.message("core.tunnel.will_timeout", seconds_to_hm(seconds_remaining)))
-        ctx.puts(ctx.message("core.tunnel.signup_suggestion", ShopifyCli::TOOL_NAME))
+        ctx.puts(ctx.message("core.tunnel.signup_suggestion", ShopifyCLI::TOOL_NAME))
       end
       url
     end
@@ -91,7 +91,7 @@ module ShopifyCli
     #
     def auth(ctx, token)
       install(ctx)
-      ctx.system(File.join(ShopifyCli.cache_dir, "ngrok"), "authtoken", token)
+      ctx.system(File.join(ShopifyCLI.cache_dir, "ngrok"), "authtoken", token)
     end
 
     ##
@@ -145,28 +145,28 @@ module ShopifyCli
 
     def install(ctx)
       ngrok = "ngrok#{ctx.executable_file_extension}"
-      return if File.exist?(File.join(ShopifyCli.cache_dir, ngrok))
+      return if File.exist?(File.join(ShopifyCLI.cache_dir, ngrok))
       check_prereq_command(ctx, "curl")
       check_prereq_command(ctx, ctx.linux? ? "unzip" : "tar")
       spinner = CLI::UI::SpinGroup.new
       spinner.add(ctx.message("core.tunnel.installing")) do
-        zip_dest = File.join(ShopifyCli.cache_dir, "ngrok.zip")
+        zip_dest = File.join(ShopifyCLI.cache_dir, "ngrok.zip")
         unless File.exist?(zip_dest)
-          ctx.system("curl", "-o", zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli.cache_dir)
+          ctx.system("curl", "-o", zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCLI.cache_dir)
         end
         args = if ctx.linux?
           %W(unzip -u #{zip_dest})
         else
           %W(tar -xf #{zip_dest})
         end
-        ctx.system(*args, chdir: ShopifyCli.cache_dir)
+        ctx.system(*args, chdir: ShopifyCLI.cache_dir)
         ctx.rm(zip_dest)
       end
       spinner.wait
 
       # final check to see if ngrok is accessible
-      unless File.exist?(File.join(ShopifyCli.cache_dir, ngrok))
-        ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCli.cache_dir))
+      unless File.exist?(File.join(ShopifyCLI.cache_dir, ngrok))
+        ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCLI.cache_dir))
       end
     end
 
@@ -178,7 +178,7 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "\"#{File.join(ShopifyCli.cache_dir, "ngrok")}\" http -inspect=false -log=stdout -log-level=debug #{port}"
+      "\"#{File.join(ShopifyCLI.cache_dir, "ngrok")}\" http -inspect=false -log=stdout -log-level=debug #{port}"
     end
 
     def seconds_to_hm(seconds)
@@ -186,14 +186,14 @@ module ShopifyCli
     end
 
     def start_ngrok(ctx, port)
-      process = ShopifyCli::ProcessSupervision.start(:ngrok, ngrok_command(port))
+      process = ShopifyCLI::ProcessSupervision.start(:ngrok, ngrok_command(port))
       log = fetch_url(ctx, process.log_path)
       seconds_remaining = (process.time.to_i + log.timeout) - Time.now.to_i
       [log.url, log.account, seconds_remaining]
     end
 
     def restart_ngrok(ctx, port)
-      unless ShopifyCli::ProcessSupervision.stop(:ngrok)
+      unless ShopifyCLI::ProcessSupervision.stop(:ngrok)
         ctx.abort(ctx.message("core.tunnel.error.stop"))
       end
       start_ngrok(ctx, port)

data/lib/shopify_cli/version.rb

@@ -0,0 +1,3 @@
+module ShopifyCLI
+  VERSION = "2.5.0"
+end

data/lib/shopify_cli.rb

@@ -24,7 +24,7 @@ end
 require "cli/ui"
 require "cli/kit"
 require "smart_properties"
-require_relative "shopify-cli/version"
+require_relative "shopify_cli/version"
 
 # Enable stdout routing. At this point all calls to STDOUT (and STDERR) will go through this class.
 # See https://github.com/Shopify/cli-ui/blob/main/lib/cli/ui/stdout_router.rb for more info
@@ -36,7 +36,7 @@ CLI::UI::StdoutRouter.enable
 #
 # It is recommended to read through CLI Kit (https://github.com/shopify/cli-kit) and a CLI Kit example
 # (https://github.com/Shopify/cli-kit-example) to fully understand how shopify-cli functions
-module ShopifyCli
+module ShopifyCLI
   extend CLI::Kit::Autocall
 
   TOOL_NAME         = "shopify"
@@ -75,63 +75,64 @@ module ShopifyCli
   # application and CLI kit framework.
   # To understand how this works, read https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit.rb
 
-  # ShopifyCli::Config
+  # ShopifyCLI::Config
   autocall(:Config)   { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
-  # ShopifyCli::Logger
-  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCli.debug_log_file) }
-  # ShopifyCli::Resolver
+  # ShopifyCLI::Logger
+  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCLI.debug_log_file) }
+  # ShopifyCLI::Resolver
   autocall(:Resolver) do
-    ShopifyCli::Core::HelpResolver.new(
+    ShopifyCLI::Core::HelpResolver.new(
       tool_name: TOOL_NAME,
-      command_registry: ShopifyCli::Commands::Registry
+      command_registry: ShopifyCLI::Commands::Registry
     )
   end
-  # ShopifyCli::ErrorHandler
+  # ShopifyCLI::ErrorHandler
   autocall(:ErrorHandler) do
     CLI::Kit::ErrorHandler.new(
-      log_file: ShopifyCli.log_file,
+      log_file: ShopifyCLI.log_file,
       exception_reporter: nil,
     )
   end
 
-  autoload :Constants, "shopify-cli/constants"
-  autoload :Environment, "shopify-cli/environment"
-  autoload :AdminAPI, "shopify-cli/admin_api"
-  autoload :API, "shopify-cli/api"
-  autoload :Command, "shopify-cli/command"
-  autoload :Commands, "shopify-cli/commands"
-  autoload :Connect, "shopify-cli/connect"
-  autoload :Context, "shopify-cli/context"
-  autoload :Core, "shopify-cli/core"
-  autoload :DB, "shopify-cli/db"
-  autoload :Feature, "shopify-cli/feature"
-  autoload :Form, "shopify-cli/form"
-  autoload :Git, "shopify-cli/git"
-  autoload :Helpers, "shopify-cli/helpers"
-  autoload :Heroku, "shopify-cli/heroku"
-  autoload :IdentityAuth, "shopify-cli/identity_auth"
-  autoload :JsDeps, "shopify-cli/js_deps"
-  autoload :JsSystem, "shopify-cli/js_system"
-  autoload :LazyDelegator, "shopify-cli/lazy_delegator"
-  autoload :MethodObject, "shopify-cli/method_object"
-  autoload :Options, "shopify-cli/options"
-  autoload :PartnersAPI, "shopify-cli/partners_api"
-  autoload :ProcessSupervision, "shopify-cli/process_supervision"
-  autoload :Project, "shopify-cli/project"
-  autoload :ProjectCommands, "shopify-cli/project_commands"
-  autoload :ProjectType, "shopify-cli/project_type"
-  autoload :ResolveConstant, "shopify-cli/resolve_constant"
-  autoload :Resources, "shopify-cli/resources"
-  autoload :Result, "shopify-cli/result"
-  autoload :Shopifolk, "shopify-cli/shopifolk"
-  autoload :SubCommand, "shopify-cli/sub_command"
-  autoload :Task, "shopify-cli/task"
-  autoload :Tasks, "shopify-cli/tasks"
-  autoload :TransformDataStructure, "shopify-cli/transform_data_structure"
-  autoload :Tunnel, "shopify-cli/tunnel"
-
-  require "shopify-cli/messages/messages"
-  Context.load_messages(ShopifyCli::Messages::MESSAGES)
+  autoload :Constants, "shopify_cli/constants"
+  autoload :Environment, "shopify_cli/environment"
+  autoload :AdminAPI, "shopify_cli/admin_api"
+  autoload :API, "shopify_cli/api"
+  autoload :Command, "shopify_cli/command"
+  autoload :Commands, "shopify_cli/commands"
+  autoload :Connect, "shopify_cli/connect"
+  autoload :Context, "shopify_cli/context"
+  autoload :Core, "shopify_cli/core"
+  autoload :DB, "shopify_cli/db"
+  autoload :Feature, "shopify_cli/feature"
+  autoload :Form, "shopify_cli/form"
+  autoload :Git, "shopify_cli/git"
+  autoload :Helpers, "shopify_cli/helpers"
+  autoload :Heroku, "shopify_cli/heroku"
+  autoload :IdentityAuth, "shopify_cli/identity_auth"
+  autoload :JsDeps, "shopify_cli/js_deps"
+  autoload :JsSystem, "shopify_cli/js_system"
+  autoload :PHPDeps, "shopify_cli/php_deps"
+  autoload :LazyDelegator, "shopify_cli/lazy_delegator"
+  autoload :MethodObject, "shopify_cli/method_object"
+  autoload :Options, "shopify_cli/options"
+  autoload :PartnersAPI, "shopify_cli/partners_api"
+  autoload :ProcessSupervision, "shopify_cli/process_supervision"
+  autoload :Project, "shopify_cli/project"
+  autoload :ProjectCommands, "shopify_cli/project_commands"
+  autoload :ProjectType, "shopify_cli/project_type"
+  autoload :ResolveConstant, "shopify_cli/resolve_constant"
+  autoload :Resources, "shopify_cli/resources"
+  autoload :Result, "shopify_cli/result"
+  autoload :Shopifolk, "shopify_cli/shopifolk"
+  autoload :SubCommand, "shopify_cli/sub_command"
+  autoload :Task, "shopify_cli/task"
+  autoload :Tasks, "shopify_cli/tasks"
+  autoload :TransformDataStructure, "shopify_cli/transform_data_structure"
+  autoload :Tunnel, "shopify_cli/tunnel"
+
+  require "shopify_cli/messages/messages"
+  Context.load_messages(ShopifyCLI::Messages::MESSAGES)
 
   def self.cache_dir
     cache_dir = if Environment.running_tests?
@@ -168,6 +169,6 @@ module ShopifyCli
 
   def self.sha
     return @sha if defined?(@sha)
-    @sha = Git.sha(dir: ShopifyCli::ROOT)
+    @sha = Git.sha(dir: ShopifyCLI::ROOT)
   end
 end

data/shopify-cli.gemspec

@@ -1,8 +1,8 @@
-require_relative "lib/shopify-cli/version"
+require_relative "lib/shopify_cli/version"
 
 Gem::Specification.new do |spec|
   spec.name = "shopify-cli"
-  spec.version = ShopifyCli::VERSION
+  spec.version = ShopifyCLI::VERSION
   spec.authors = ["Shopify"]
   spec.email = ["dev-tools-education@shopify.com"]
   spec.license = "MIT"