shopify-cli 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5e31b928a8c3d1e98c383786f85be502045be59731cef6adcd2fde4f337c4d7
-  data.tar.gz: c0f5fc0e586f2fef7a7e2a92d9357acf06547b53545bc1319e6bcf58f636fb1b
+  metadata.gz: 60163978b05868670c0b5535cc49060ba5f55c9e127d6f97232970751caeb4d8
+  data.tar.gz: b3993bcef0bd4d5488f4b4d7f3e8b6f219a0322279159a512a12cc3986f2e63a
 SHA512:
-  metadata.gz: 9699459d8bf5a49683a00b8b166a7dc5b09be204b5d0bc0d73288508dc08eace03ddba62223f20001183931895434102f8d5cfd66f3494afc1f2fa5d1a4700c5
-  data.tar.gz: e980565315b842028e05786f1acf63fae983d00ff28aa2db71d976d3b3b3615a530c47710727fe83c311a6bca8cec0995fc34cb5a288a7ff2d223510ddd0c79f
+  metadata.gz: cd65b86469afbc40117f58257840588dea0fd07141e899ac9273e0eee9da4bcaef119c4df14921777d3ae88932fd053771392154658704294b59afd9656b00f8
+  data.tar.gz: 2d199c2d96954b9d2c666fc4822f845f1a176115eb90a28078af42ceaf0cf691b3b2e21896485afe4c42b2ec43e7c5af576ba18a86188bf01a22f7ff32ffb8f0

data/.github/workflows/shopify.yml

@@ -25,7 +25,6 @@ jobs:
           - macos-11
           - ubuntu-20.04
           - ubuntu-18.04
-          - ubuntu-16.04
     steps:
       - uses: actions/checkout@v2
       - name: Set Git configuration
@@ -58,7 +57,6 @@ jobs:
           - macos-11
           - ubuntu-20.04
           - ubuntu-18.04
-          - ubuntu-16.04
     steps:
       - uses: actions/checkout@v2
       - name: Set Git configuration

data/.rubocop.yml

@@ -11,8 +11,8 @@ inherit_gem:
 Minitest:
   Enabled: true
   Include:
-    - '**/test/**/*'
-    - '**/*_test.rb'
+    - "**/test/**/*"
+    - "**/*_test.rb"
 
 Minitest/AssertInDelta: # (new in 0.10)
   Enabled: true
@@ -43,15 +43,15 @@ Minitest/UnspecifiedException: # (new in 0.10)
 
 AllCops:
   Exclude:
-    - 'vendor/**/*'
-    - 'docs/**/*'
-    - 'packaging/**/*'
+    - "vendor/**/*"
+    - "docs/**/*"
+    - "packaging/**/*"
   TargetRubyVersion: 2.4
 
 Layout/EmptyLines:
   Exclude:
     # Need extra line so comment at top isnt registered to the Dev namespace
-    - 'lib/dev/helpers/chruby_reset.rb'
+    - "lib/dev/helpers/chruby_reset.rb"
 
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
@@ -59,10 +59,10 @@ Layout/EmptyLineBetweenDefs:
 # Changing this could effect the way the content is rendered.
 Layout/HeredocIndentation:
   Exclude:
-    - 'lib/project_types/node/messages/messages.rb'
-    - 'lib/project_types/rails/messages/messages.rb'
-    - 'lib/project_types/script/messages/messages.rb'
-    - 'lib/shopify-cli/messages/messages.rb'
+    - "lib/project_types/node/messages/messages.rb"
+    - "lib/project_types/rails/messages/messages.rb"
+    - "lib/project_types/script/messages/messages.rb"
+    - "lib/shopify_cli/messages/messages.rb"
 
 # allow String.new to create mutable strings
 Style/EmptyLiteral:
@@ -71,7 +71,7 @@ Style/EmptyLiteral:
 # allow String.new to create mutable strings
 Style/HashSyntax:
   Exclude:
-    - 'Rakefile'
+    - "Rakefile"
 
 # allow using %r{} for regexes
 Style/RegexpLiteral:
@@ -97,6 +97,6 @@ Style/MethodCallWithArgsParentheses:
 
 Layout/TrailingWhitespace:
   Exclude:
-    - 'ext/shopify-cli/extconf.rb' # unsure if safe to remove
-    - 'lib/project_types/extension/messages/messages.rb' # unsure if safe to remove
-    - 'test/project_types/extension/extension_test_helpers/stubs/argo_script.rb' # unsure if save to remove
+    - "ext/shopify-cli/extconf.rb" # unsure if safe to remove
+    - "lib/project_types/extension/messages/messages.rb" # unsure if safe to remove
+    - "test/project_types/extension/extension_test_helpers/stubs/argo_script.rb" # unsure if save to remove

data/.rubocop_todo.yml

@@ -14,11 +14,11 @@ Minitest/MultipleAssertions:
 # Cop supports --auto-correct.
 Style/PerlBackrefs:
   Exclude:
-    - 'lib/docgen/markdown.rb'
+    - "lib/docgen/markdown.rb"
 
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/RedundantBegin:
   Exclude:
-    - 'lib/shopify-cli/shopifolk.rb'
-    - 'test/shopify-cli/tunnel_test.rb'
+    - "lib/shopify_cli/shopifolk.rb"
+    - "test/shopify_cli/tunnel_test.rb"

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased
 ------
 
+Version 2.5.0
+------
+
+* [#1553](https://github.com/Shopify/shopify-cli/pull/1553): Add support for PHP app projects
+
 Version 2.4.0
 ------
 

data/Dockerfile

@@ -13,7 +13,7 @@ WORKDIR /usr/src/app
 
 COPY Gemfile Gemfile.lock ./
 COPY shopify-cli.gemspec  shopify-cli.gemspec
-COPY lib/shopify-cli/version.rb  lib/shopify-cli/version.rb
+COPY lib/shopify_cli/version.rb  lib/shopify_cli/version.rb
 COPY . .
 
 RUN bundle install

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.4.0)
+    shopify-cli (2.5.0)
       listen (~> 3.7.0)
       theme-check (~> 1.4.0)
 

data/RELEASING.md

@@ -13,7 +13,7 @@
    $ git checkout -b release_X_Y_Z
    ```
 
-1. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
+1. Update the version of Shopify CLI in `lib/shopify_cli/version.rb`
 
 1. Update the version of Shopify CLI at the top of `Gemfile.lock` (failing to do so causes the CI build to fail)
 

data/Rakefile

@@ -51,20 +51,20 @@ namespace :rdoc do
   repo = "https://github.com/Shopify/shopify-cli.wiki.git"
   intermediate = "markdown_intermediate"
   file_to_doc = [
-    "lib/shopify-cli/admin_api.rb",
-    "lib/shopify-cli/context.rb",
-    "lib/shopify-cli/db.rb",
-    "lib/shopify-cli/git.rb",
-    "lib/shopify-cli/heroku.rb",
-    "lib/shopify-cli/js_deps.rb",
-    "lib/shopify-cli/lazy_delegator.rb",
-    "lib/shopify-cli/method_object.rb",
-    "lib/shopify-cli/partners_api.rb",
-    "lib/shopify-cli/process_supervision.rb",
-    "lib/shopify-cli/project.rb",
-    "lib/shopify-cli/result.rb",
-    "lib/shopify-cli/transform_data_structure.rb",
-    "lib/shopify-cli/tunnel.rb",
+    "lib/shopify_cli/admin_api.rb",
+    "lib/shopify_cli/context.rb",
+    "lib/shopify_cli/db.rb",
+    "lib/shopify_cli/git.rb",
+    "lib/shopify_cli/heroku.rb",
+    "lib/shopify_cli/js_deps.rb",
+    "lib/shopify_cli/lazy_delegator.rb",
+    "lib/shopify_cli/method_object.rb",
+    "lib/shopify_cli/partners_api.rb",
+    "lib/shopify_cli/process_supervision.rb",
+    "lib/shopify_cli/project.rb",
+    "lib/shopify_cli/result.rb",
+    "lib/shopify_cli/transform_data_structure.rb",
+    "lib/shopify_cli/tunnel.rb",
   ]
 
   task all: [:markdown, :wiki, :cleanup]
@@ -104,23 +104,23 @@ desc("Generate markdown documentation and update the wiki")
 task(rdoc: "rdoc:all")
 
 namespace :package do
-  require "shopify-cli/packager"
+  require "shopify_cli/packager"
 
   task all: [:debian, :rpm, :homebrew]
 
   desc("Builds a Debian package of the CLI")
   task :debian do
-    ShopifyCli::Packager.new.build_debian
+    ShopifyCLI::Packager.new.build_debian
   end
 
   desc("Builds an RPM package of the CLI")
   task :rpm do
-    ShopifyCli::Packager.new.build_rpm
+    ShopifyCLI::Packager.new.build_rpm
   end
 
   desc("Builds a Homebrew package of the CLI")
   task :homebrew do
-    ShopifyCli::Packager.new.build_homebrew
+    ShopifyCLI::Packager.new.build_homebrew
   end
 end
 

data/bin/shopify

@@ -9,7 +9,7 @@ module Kernel
     original_require(name)
   rescue LoadError => e
     # Special case for readline.so, which fails harmlessly on Windows
-    raise if (name == "readline.so") && ShopifyCli::Context.new.windows?
+    raise if (name == "readline.so") && ShopifyCLI::Context.new.windows?
     # Special case for psych (yaml), which rescues this itself
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
     STDERR.puts "[Note] You cannot use gems with Shopify CLI."
@@ -29,6 +29,6 @@ end
 
 require_relative "./load_shopify"
 
-exit(ShopifyCli::ErrorHandler.call do
-  ShopifyCli::Core::EntryPoint.call(ARGV.dup)
+exit(ShopifyCLI::ErrorHandler.call do
+  ShopifyCLI::Core::EntryPoint.call(ARGV.dup)
 end)

data/lib/project_types/extension/cli.rb

@@ -3,7 +3,7 @@
 module Extension
   class PackageResolutionFailed < RuntimeError; end
 
-  class Project < ShopifyCli::ProjectType
+  class Project < ShopifyCLI::ProjectType
     hidden_feature
 
     require Project.project_filepath("messages/messages")
@@ -12,7 +12,7 @@ module Extension
     register_messages(Extension::Messages::MessageLoading.load)
   end
 
-  class Command < ShopifyCli::ProjectCommands
+  class Command < ShopifyCLI::ProjectCommands
     hidden_feature
     autoload :ExtensionCommand, Project.project_filepath("commands/extension_command")
 
@@ -26,7 +26,7 @@ module Extension
     subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
     subcommand :Check, "check", Project.project_filepath("commands/check")
   end
-  ShopifyCli::Commands.register("Extension::Command", "extension")
+  ShopifyCLI::Commands.register("Extension::Command", "extension")
 
   module Tasks
     autoload :UserErrors, Project.project_filepath("tasks/user_errors")

data/lib/project_types/extension/commands/build.rb

@@ -18,7 +18,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("build.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("build.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -40,7 +40,7 @@ module Extension
       end
 
       def run_legacy_flow
-        system = ShopifyCli::JsSystem.new(ctx: @ctx)
+        system = ShopifyCLI::JsSystem.new(ctx: @ctx)
 
         CLI::UI::Frame.open(@ctx.message("build.frame_title", system.package_manager)) do
           success = system.call(yarn: YARN_BUILD_COMMAND, npm: NPM_BUILD_COMMAND)

data/lib/project_types/extension/commands/check.rb

@@ -4,7 +4,7 @@ require "theme_check"
 module Extension
   class Command
     class Check < ExtensionCommand
-      class CheckOptions < ShopifyCli::Options
+      class CheckOptions < ShopifyCLI::Options
         def initialize(ctx, theme_check)
           super()
           @theme_check = theme_check
@@ -37,7 +37,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.message("check.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("check.help", ShopifyCLI::TOOL_NAME)
       end
     end
   end

data/lib/project_types/extension/commands/connect.rb

@@ -19,7 +19,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("connect.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
       end
 
       private

data/lib/project_types/extension/commands/create.rb

@@ -2,7 +2,7 @@
 
 module Extension
   class Command
-    class Create < ShopifyCli::SubCommand
+    class Create < ShopifyCLI::SubCommand
       DEVELOPMENT_SERVER_SUPPORTED_TYPES = [
         "checkout_ui_extension",
       ]
@@ -22,27 +22,15 @@ module Extension
             @ctx.abort(message_for_extension["create.errors.directory_exists", form.directory_name])
           end
 
-          return use_new_create_flow(form, message_for_extension) if supports_development_server?(form.type)
-
-          if form.type.create(form.directory_name, @ctx, getting_started: options.flags[:getting_started])
-            ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
-            ExtensionProject.write_env_file(
-              context: @ctx,
-              title: form.name,
-              api_key: form.app.api_key,
-              api_secret: form.app.secret
-            )
-
-            @ctx.puts(message_for_extension["create.ready_to_start", form.directory_name, form.name])
-            @ctx.puts(message_for_extension["create.learn_more", form.type.name])
-          else
-            @ctx.puts(message_for_extension["create.try_again"])
-          end
+          ShopifyCLI::Result.success(supports_development_server?(form.type.identifier))
+            .then { |supported| create_extension(supported, form) }
+            .then { notify_success(form, message_for_extension) }
+            .unwrap { |err| @ctx.puts(message_for_extension["create.try_again"]) unless err.nil? }
         end
       end
 
       def self.help
-        @ctx.message("create.help", ShopifyCli::TOOL_NAME)
+        @ctx.message("create.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -55,22 +43,52 @@ module Extension
       end
 
       def supports_development_server?(type)
-        Models::DevelopmentServerRequirements.supported?(type.identifier)
+        Models::DevelopmentServerRequirements.supported?(type)
       end
 
-      def use_new_create_flow(form, msg)
+      def create_extension(supported, form)
+        if supported
+          use_new_create_flow(form)
+        else
+          use_legacy_flow(form)
+        end
+        ShopifyCLI::Result.success(nil)
+      end
+
+      def use_new_create_flow(form)
         Tasks::RunExtensionCommand.new(
           root_dir: form.directory_name,
           template: form.template,
           type: form.type.identifier.downcase,
           command: "create"
         ).call
+        @ctx.chdir(form.directory_name)
+        write_env_file(form)
+      rescue => error
+        raise error
+      end
+
+      def use_legacy_flow(form)
+        if form.type.create(form.directory_name, @ctx, getting_started: options.flags[:getting_started])
+          write_env_file(form)
+        else
+          raise StandardError
+        end
+      end
 
+      def write_env_file(form)
+        ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
+        ExtensionProject.write_env_file(
+          context: @ctx,
+          title: form.name,
+          api_key: form.app.api_key,
+          api_secret: form.app.secret
+        )
+      end
+
+      def notify_success(form, msg)
         @ctx.puts(msg["create.ready_to_start", form.directory_name, form.name])
         @ctx.puts(msg["create.learn_more", form.type.name])
-      rescue => error
-        @ctx.debug(error)
-        @ctx.puts(msg["create.try_again"])
       end
     end
   end

data/lib/project_types/extension/commands/extension_command.rb

@@ -3,7 +3,7 @@ require "shopify_cli"
 
 module Extension
   class Command
-    class ExtensionCommand < ShopifyCli::SubCommand
+    class ExtensionCommand < ShopifyCLI::SubCommand
       def project
         @project ||= ExtensionProject.current
       end

data/lib/project_types/extension/commands/info.rb

@@ -14,7 +14,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("info.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("info.help", ShopifyCLI::TOOL_NAME)
       end
 
       private

data/lib/project_types/extension/commands/push.rb

@@ -18,7 +18,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("push.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("push.help", ShopifyCLI::TOOL_NAME)
       end
 
       private

data/lib/project_types/extension/commands/register.rb

@@ -20,7 +20,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("register.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("register.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -60,7 +60,7 @@ module Extension
 
       def abort_not_registered
         @ctx.puts(@ctx.message("register.confirm_abort"))
-        raise ShopifyCli::AbortSilent
+        raise ShopifyCLI::AbortSilent
       end
     end
   end

data/lib/project_types/extension/commands/serve.rb

@@ -29,7 +29,7 @@ module Extension
           resource_url: options.flags[:resource_url]
         )
 
-        ShopifyCli::Result
+        ShopifyCLI::Result
           .success(config)
           .then(&method(:find_available_port))
           .then(&method(:start_tunnel_if_required))
@@ -38,7 +38,7 @@ module Extension
       end
 
       def self.help
-        ShopifyCli::Context.new.message("serve.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.new.message("serve.help", ShopifyCLI::TOOL_NAME)
       end
 
       private
@@ -66,12 +66,12 @@ module Extension
       end
 
       def can_start_tunnel?(runtime_configuration)
-        return true if ShopifyCli::Tunnel.urls.empty?
-        ShopifyCli::Tunnel.running_on?(runtime_configuration.port)
+        return true if ShopifyCLI::Tunnel.urls.empty?
+        ShopifyCLI::Tunnel.running_on?(runtime_configuration.port)
       end
 
       def start_tunnel(runtime_configuration)
-        tunnel_url = ShopifyCli::Tunnel.start(@ctx, port: runtime_configuration.port)
+        tunnel_url = ShopifyCLI::Tunnel.start(@ctx, port: runtime_configuration.port)
         runtime_configuration.tap { |c| c.tunnel_url = tunnel_url }
       end
 

data/lib/project_types/extension/commands/tunnel.rb

@@ -21,25 +21,25 @@ module Extension
 
         case subcommand
         when AUTH_SUBCOMMAND then authorize(args)
-        when START_SUBCOMMAND then ShopifyCli::Tunnel.start(@ctx, port: port)
-        when STOP_SUBCOMMAND then ShopifyCli::Tunnel.stop(@ctx)
+        when START_SUBCOMMAND then ShopifyCLI::Tunnel.start(@ctx, port: port)
+        when STOP_SUBCOMMAND then ShopifyCLI::Tunnel.stop(@ctx)
         when STATUS_SUBCOMMAND then status
         else @ctx.puts(self.class.help)
         end
       end
 
       def self.help
-        ShopifyCli::Context.message("tunnel.help", ShopifyCli::TOOL_NAME)
+        ShopifyCLI::Context.message("tunnel.help", ShopifyCLI::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message("tunnel.extended_help", ShopifyCli::TOOL_NAME, DEFAULT_PORT)
+        ShopifyCLI::Context.message("tunnel.extended_help", ShopifyCLI::TOOL_NAME, DEFAULT_PORT)
       end
 
       private
 
       def status
-        tunnel_urls = ShopifyCli::Tunnel.urls
+        tunnel_urls = ShopifyCLI::Tunnel.urls
         tunnel_url = tunnel_urls.find { |url| url.start_with?("https://") }
         tunnel_url = tunnel_urls.first if tunnel_url.nil?
 
@@ -65,7 +65,7 @@ module Extension
           @ctx.puts(@ctx.message("tunnel.missing_token"))
           @ctx.puts("#{self.class.help}\n#{self.class.extended_help}")
         else
-          ShopifyCli::Tunnel.auth(@ctx, token)
+          ShopifyCLI::Tunnel.auth(@ctx, token)
         end
       end
     end

data/lib/project_types/extension/extension_project.rb

@@ -3,10 +3,10 @@ require "shopify_cli"
 require "securerandom"
 
 module Extension
-  class ExtensionProject < ShopifyCli::Project
+  class ExtensionProject < ShopifyCLI::Project
     class << self
       def write_cli_file(context:, type:)
-        ShopifyCli::Project.write(
+        ShopifyCLI::Project.write(
           context,
           project_type: :extension,
           organization_id: nil,
@@ -42,7 +42,7 @@ module Extension
         resource_url: nil,
         shop: nil
       )
-        ShopifyCli::Resources::EnvFile.new(
+        ShopifyCLI::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
           shop: shop,
@@ -134,7 +134,7 @@ module Extension
 
     def validate_env_present
       return if env
-      raise ShopifyCli::Abort, "Missing .env file. Run `shopify extension connect` to generate an .env file."
+      raise ShopifyCLI::Abort, "Missing .env file. Run `shopify extension connect` to generate an .env file."
     end
 
     def integer?(value)

data/lib/project_types/extension/features/argo.rb

@@ -24,7 +24,7 @@ module Extension
       end
 
       def config(context)
-        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        js_system = ShopifyCLI::JsSystem.new(ctx: context)
         if js_system.package_manager == "yarn"
           run_yarn_install(context, js_system)
           run_yarn_run_script(context, js_system)
@@ -42,7 +42,7 @@ module Extension
       end
 
       def renderer_package(context)
-        js_system = ShopifyCli::JsSystem.new(ctx: context)
+        js_system = ShopifyCLI::JsSystem.new(ctx: context)
         Tasks::FindNpmPackages
           .exactly_one_of(renderer_package_name, js_system: js_system)
           .unwrap { |err| raise err }

data/lib/project_types/extension/features/argo_config.rb

@@ -21,7 +21,7 @@ module Extension
             return {} if config.nil?
 
             unless config.is_a?(Hash)
-              raise ShopifyCli::Abort, ShopifyCli::Context.message("core.yaml.error.not_hash", CONFIG_FILE_NAME)
+              raise ShopifyCLI::Abort, ShopifyCLI::Context.message("core.yaml.error.not_hash", CONFIG_FILE_NAME)
             end
 
             config.transform_keys!(&:to_sym)
@@ -30,8 +30,8 @@ module Extension
             config
           rescue Psych::SyntaxError => e
             raise(
-              ShopifyCli::Abort,
-              ShopifyCli::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
+              ShopifyCLI::Abort,
+              ShopifyCLI::Context.message("core.yaml.error.invalid", CONFIG_FILE_NAME, e.message)
             )
           end
         end
@@ -45,8 +45,8 @@ module Extension
 
           unless unpermitted_keys.empty?
             raise(
-              ShopifyCli::Abort,
-              ShopifyCli::Context.message(
+              ShopifyCLI::Abort,
+              ShopifyCLI::Context.message(
                 "features.argo.config.unpermitted_keys",
                 CONFIG_FILE_NAME,
                 unpermitted_keys.map { |k| "\n- #{k}" }.join