shopify-cli 1.5.0 → 1.9.0

data/lib/shopify-cli/commands/create.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Commands
@@ -10,11 +10,11 @@ module ShopifyCli
 
       def call(args, command_name)
         unless args.empty?
-          @ctx.puts(@ctx.message('core.create.error.invalid_app_type', args[0]))
+          @ctx.puts(@ctx.message("core.create.error.invalid_app_type", args[0]))
           return @ctx.puts(self.class.help)
         end
 
-        type_name = CLI::UI::Prompt.ask(@ctx.message('core.create.project_type_select')) do |handler|
+        type_name = CLI::UI::Prompt.ask(@ctx.message("core.create.project_type_select")) do |handler|
           self.class.all_visible_type.each do |type|
             handler.option(type.project_name) { type.project_type }
           end
@@ -22,7 +22,7 @@ module ShopifyCli
 
         klass = ProjectType.load_type(type_name).create_command
         klass.ctx = @ctx
-        klass.call(args, command_name, 'create')
+        klass.call(args, command_name, "create")
       end
 
       def self.all_visible_type
@@ -33,7 +33,7 @@ module ShopifyCli
 
       def self.help
         project_types = all_visible_type.map(&:project_type).sort.join(" | ")
-        ShopifyCli::Context.message('core.create.help', ShopifyCli::TOOL_NAME, project_types)
+        ShopifyCli::Context.message("core.create.help", ShopifyCli::TOOL_NAME, project_types)
       end
 
       def self.extended_help

data/lib/shopify-cli/commands/help.rb

@@ -1,11 +1,11 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Commands
     class Help < ShopifyCli::Command
       def call(args, _name)
         command = args.shift
-        if command && command != 'help'
+        if command && command != "help"
           if Registry.exist?(command)
             cmd, _ = Registry.lookup_command(command)
             subcmd, _ = cmd.subcommand_registry.lookup_command(args.first)
@@ -16,15 +16,15 @@ module ShopifyCli
             end
             return
           else
-            @ctx.puts(@ctx.message('core.help.error.command_not_found', command))
+            @ctx.puts(@ctx.message("core.help.error.command_not_found", command))
           end
         end
 
-        preamble = @ctx.message('core.help.preamble', ShopifyCli::TOOL_NAME)
+        preamble = @ctx.message("core.help.preamble", ShopifyCli::TOOL_NAME)
         @ctx.puts(preamble)
 
         core_commands.each do |name, klass|
-          next if name == 'help'
+          next if name == "help"
           @ctx.puts("{{command:#{name}}}: #{klass.help}\n")
         end
 
@@ -34,7 +34,7 @@ module ShopifyCli
         @ctx.puts("{{bold:Available commands for #{project_type_name} projects:}}\n\n")
 
         local_commands.each do |name, klass|
-          next if name == 'help'
+          next if name == "help"
           @ctx.puts("{{command:#{name}}}: #{klass.help}\n")
         end
       end

data/lib/shopify-cli/commands/logout.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Commands
@@ -12,11 +12,11 @@ module ShopifyCli
         LOGIN_TOKENS.each do |token|
           ShopifyCli::DB.del(token) if ShopifyCli::DB.exists?(token)
         end
-        @ctx.puts(@ctx.message('core.logout.success'))
+        @ctx.puts(@ctx.message("core.logout.success"))
       end
 
       def self.help
-        ShopifyCli::Context.message('core.logout.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("core.logout.help", ShopifyCli::TOOL_NAME)
       end
     end
   end

data/lib/shopify-cli/commands/system.rb

@@ -1,5 +1,5 @@
-require 'shopify_cli'
-require 'rbconfig'
+require "shopify_cli"
+require "rbconfig"
 
 module ShopifyCli
   module Commands
@@ -9,13 +9,13 @@ module ShopifyCli
       def call(args, _name)
         show_all_details = false
         flag = args.shift
-        if flag && flag != 'all'
-          @ctx.puts(@ctx.message('core.system.error.unknown_option', flag))
+        if flag && flag != "all"
+          @ctx.puts(@ctx.message("core.system.error.unknown_option", flag))
           @ctx.puts("\n" + self.class.help)
           return
         end
 
-        show_all_details = true if flag == 'all'
+        show_all_details = true if flag == "all"
 
         display_environment if show_all_details
 
@@ -27,7 +27,7 @@ module ShopifyCli
       end
 
       def self.help
-        ShopifyCli::Context.message('core.system.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("core.system.help", ShopifyCli::TOOL_NAME)
       end
 
       private
@@ -47,14 +47,14 @@ module ShopifyCli
 
         cli_constants += cli_constants_extra if show_all_details
 
-        @ctx.puts(@ctx.message('core.system.header'))
+        @ctx.puts(@ctx.message("core.system.header"))
         cli_constants.each do |s|
-          @ctx.puts("  " + @ctx.message('core.system.const', s, ShopifyCli.const_get(s.to_sym)) + "\n")
+          @ctx.puts("  " + @ctx.message("core.system.const", s, ShopifyCli.const_get(s.to_sym)) + "\n")
         end
 
         if show_all_details
           cli_path_methods.each do |m|
-            @ctx.puts("  " + @ctx.message('core.system.const', m.upcase, ShopifyCli.send(m)) + "\n")
+            @ctx.puts("  " + @ctx.message("core.system.const", m.upcase, ShopifyCli.send(m)) + "\n")
           end
         end
       end
@@ -62,55 +62,55 @@ module ShopifyCli
       def display_cli_ruby(_show_all_details)
         rbconfig_constants = %w(host RUBY_VERSION_NAME)
 
-        @ctx.puts("\n" + @ctx.message('core.system.ruby_header', RbConfig.ruby))
+        @ctx.puts("\n" + @ctx.message("core.system.ruby_header", RbConfig.ruby))
         rbconfig_constants.each do |s|
-          @ctx.puts("  " + @ctx.message('core.system.rb_config', RbConfig::CONFIG[s], s))
+          @ctx.puts("  " + @ctx.message("core.system.rb_config", RbConfig::CONFIG[s], s))
         end
       end
 
       def display_utility_commands(_show_all_details)
         commands = %w(git curl tar)
 
-        @ctx.puts("\n" + @ctx.message('core.system.command_header'))
+        @ctx.puts("\n" + @ctx.message("core.system.command_header"))
         commands.each do |s|
           cmd_path = @ctx.which(s)
 
           if !cmd_path.nil?
-            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, cmd_path))
+            @ctx.puts("  " + @ctx.message("core.system.command_with_path", s, cmd_path))
           else
-            @ctx.puts("  " + @ctx.message('core.system.command_not_found', s))
+            @ctx.puts("  " + @ctx.message("core.system.command_not_found", s))
           end
         end
       end
 
       def display_ngrok
-        ngrok_location = File.join(ShopifyCli.cache_dir, @ctx.windows? ? 'ngrok.exe' : 'ngrok')
+        ngrok_location = File.join(ShopifyCli.cache_dir, "ngrok#{@ctx.executable_file_extension}")
         if File.exist?(ngrok_location)
-          @ctx.puts("  " + @ctx.message('core.system.ngrok_available', ngrok_location))
+          @ctx.puts("  " + @ctx.message("core.system.ngrok_available", ngrok_location))
         else
-          @ctx.puts("  " + @ctx.message('core.system.ngrok_not_available'))
+          @ctx.puts("  " + @ctx.message("core.system.ngrok_not_available"))
         end
       end
 
       def display_project_commands(_show_all_details)
         case Project.current_project_type
         when :node
-          display_project('Node.js', %w(npm node yarn))
+          display_project("Node.js", %w(npm node yarn))
         when :rails
-          display_project('Rails', %w(gem rails rake ruby))
+          display_project("Rails", %w(gem rails rake ruby))
         end
       end
 
       def display_project(project_type, commands)
-        @ctx.puts("\n" + @ctx.message('core.system.project.header', project_type))
+        @ctx.puts("\n" + @ctx.message("core.system.project.header", project_type))
         commands.each do |s|
           cmd_path = @ctx.which(s)
           if !cmd_path.nil?
-            version_output, _ = @ctx.capture2e(s, '--version')
+            version_output, _ = @ctx.capture2e(s, "--version")
             version = version_output.match(/(\d+\.[^\s]+)/)[0]
-            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, cmd_path.strip, version.strip))
+            @ctx.puts("  " + @ctx.message("core.system.project.command_with_path", s, cmd_path.strip, version.strip))
           else
-            @ctx.puts("  " + @ctx.message('core.system.project.command_not_found', s))
+            @ctx.puts("  " + @ctx.message("core.system.project.command_not_found", s))
           end
         end
         display_ngrok
@@ -118,25 +118,25 @@ module ShopifyCli
       end
 
       def display_project_environment
-        @ctx.puts("\n  " + @ctx.message('core.system.project.env_header'))
-        if File.exist?('./.env')
+        @ctx.puts("\n  " + @ctx.message("core.system.project.env_header"))
+        if File.exist?("./.env")
           Project.current.env.to_h.each do |k, v|
-            display_value = if v.nil? || v.strip == ''
-              @ctx.message('core.system.project.env_not_set')
+            display_value = if v.nil? || v.strip == ""
+              @ctx.message("core.system.project.env_not_set")
             else
               k.match(/^SHOPIFY_API/) ? "********" : v
             end
-            @ctx.puts("  " + @ctx.message('core.system.project.env', k, display_value))
+            @ctx.puts("  " + @ctx.message("core.system.project.env", k, display_value))
           end
         else
-          @ctx.puts("  " + @ctx.message('core.system.project.no_env'))
+          @ctx.puts("  " + @ctx.message("core.system.project.no_env"))
         end
       end
 
       def display_environment
-        @ctx.puts(@ctx.message('core.system.environment_header'))
+        @ctx.puts(@ctx.message("core.system.environment_header"))
         %w(TERM SHELL PATH USING_SHOPIFY_CLI LANG).each do |k|
-          @ctx.puts("  " + @ctx.message('core.system.env', k, ENV[k])) unless ENV[k].nil?
+          @ctx.puts("  " + @ctx.message("core.system.env", k, ENV[k])) unless ENV[k].nil?
         end
         @ctx.puts("")
       end
@@ -144,8 +144,8 @@ module ShopifyCli
       def display_shopify_staff_identity
         is_shopifolk = ShopifyCli::Shopifolk.check
         if is_shopifolk
-          @ctx.puts("\n" + @ctx.message('core.system.identity_header'))
-          @ctx.puts("  " + @ctx.message('core.system.identity_is_shopifolk'))
+          @ctx.puts("\n" + @ctx.message("core.system.identity_header"))
+          @ctx.puts("  " + @ctx.message("core.system.identity_is_shopifolk"))
         end
       end
     end

data/lib/shopify-cli/commands/version.rb

@@ -1,10 +1,10 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Commands
     class Version < ShopifyCli::Command
       def self.help
-        ShopifyCli::Context.message('core.version.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("core.version.help", ShopifyCli::TOOL_NAME)
       end
 
       def call(_args, _name)

data/lib/shopify-cli/context.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-require 'shopify_cli'
-require 'fileutils'
-require 'rbconfig'
-require 'net/http'
-require 'json'
+require "shopify_cli"
+require "fileutils"
+require "rbconfig"
+require "net/http"
+require "json"
 
 module ShopifyCli
   ##
@@ -13,9 +13,9 @@ module ShopifyCli
   # resoures.
   #
   class Context
-    GEM_LATEST_URI = URI.parse('https://rubygems.org/api/v1/versions/shopify-cli/latest.json')
-    VERSION_CHECK_SECTION = 'versioncheck'
-    LAST_CHECKED_AT_FIELD = 'last_checked_at'
+    GEM_LATEST_URI = URI.parse("https://rubygems.org/api/v1/versions/shopify-cli/latest.json")
+    VERSION_CHECK_SECTION = "versioncheck"
+    LAST_CHECKED_AT_FIELD = "last_checked_at"
     VERSION_CHECK_INTERVAL = 86400
 
     class << self
@@ -40,7 +40,7 @@ module ShopifyCli
       # * `key` - a symbol representing the message
       # * `params` - the parameters to format the string with
       def message(key, *params)
-        key_parts = key.split('.').map(&:to_sym)
+        key_parts = key.split(".").map(&:to_sym)
         str = Context.messages.dig(*key_parts)
         str ? str % params : key
       end
@@ -86,7 +86,7 @@ module ShopifyCli
     # See `#development?` for checking for development environment.
     #
     def system?
-      !Dir.exist?(File.join(ShopifyCli::ROOT, 'test'))
+      !Dir.exist?(File.join(ShopifyCli::ROOT, "test"))
     end
 
     # will return true if the cli is running on your development instance.
@@ -97,13 +97,13 @@ module ShopifyCli
 
     # will return true while tests are running, either locally or on CI
     def testing?
-      ci? || ENV['TEST']
+      ci? || ENV["TEST"]
     end
 
     ##
     # will return true if the cli is being tested on CI
     def ci?
-      ENV['CI']
+      ENV["CI"]
     end
 
     # get a environment variable value by name.
@@ -116,7 +116,7 @@ module ShopifyCli
     #
     def getenv(name)
       v = @env[name]
-      v == '' ? nil : v
+      v == "" ? nil : v
     end
 
     # set a environment variable value by name.
@@ -144,6 +144,34 @@ module ShopifyCli
       File.write(ctx_path(fname), content)
     end
 
+    # will read a binary file relative to the context root unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are reading, relative to root unless it is absolute.
+    #
+    # #### Example
+    #
+    #   @ctx.read('binary.out')
+    #
+    def binread(fname)
+      File.binread(ctx_path(fname))
+    end
+
+    # will write/overwrite a binary file with the provided contents, relative to the context root
+    # unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are writing, relative to root unless it is absolute.
+    # * `content` - the body contents of the file that you are writing
+    #
+    # #### Example
+    #
+    #   @ctx.binwrite('binary.out', 'ASCII-8BIT encoded binary')
+    #
+    def binwrite(fname, content)
+      File.binwrite(ctx_path(fname), content)
+    end
+
     # will change directories and update the root, the filepath is relative to the command root unless absolute
     #
     # #### Parameters
@@ -254,7 +282,7 @@ module ShopifyCli
     # * `uri` - a http URI to open in a browser
     #
     def open_url!(uri)
-      help = message('core.context.open_url', uri)
+      help = message("core.context.open_url", uri)
       puts(help)
     end
 
@@ -303,7 +331,7 @@ module ShopifyCli
     # * `text` - a string message to output
     #
     def debug(text)
-      puts("{{red:DEBUG}} #{text}") if getenv('DEBUG')
+      puts("{{red:DEBUG}} #{text}") if getenv("DEBUG")
     end
 
     # proxy call to Context.message.
@@ -329,14 +357,18 @@ module ShopifyCli
     # - `**kwargs`: additional keyword arguments to pass to Process.spawn
     #
     # #### Returns
-    # - `status`: boolean success status of the command execution
+    # - `status`: The `Process::Status` result of the command execution.
     #
     # #### Usage
     #
     #   stat = @ctx.system('ls', 'a_folder')
     #
     def system(*args, **kwargs)
-      CLI::Kit::System.system(*args, env: @env, **kwargs)
+      process_status = CLI::Kit::System.system(*args, env: @env, **kwargs)
+      unless process_status.success?
+        abort("System call failed: #{args.join(" ")}")
+      end
+      process_status
     end
 
     # Execute a command in the user's environment
@@ -410,13 +442,13 @@ module ShopifyCli
     #
     def on_siginfo
       # Reset any previous SIGINFO handling we had so the only action we take is the given block
-      trap('INFO', 'DEFAULT')
+      trap("INFO", "DEFAULT")
 
       fork do
         begin
           r, w = IO.pipe
           @signal = false
-          trap('SIGINFO') do
+          trap("SIGINFO") do
             @signal = true
             w.write(0)
           end
@@ -442,8 +474,8 @@ module ShopifyCli
     # @todo This is currently a duplicate of CLI::Kit::System.which() - we should make that method public when we make
     #       Kit changes and make this a wrapper instead.
     def which(cmd)
-      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
         exts.each do |ext|
           exe = File.join(File.expand_path(path), "#{cmd}#{ext}")
           return exe if File.executable?(exe) && !File.directory?(exe)
@@ -470,10 +502,27 @@ module ShopifyCli
       end
     end
 
+    # Returns file extension depending on OS
+    # since windows has multiple extensions, the default is .exe unless otherwise specified
+    #
+    # #### Parameters
+    # - ext: optional extension for windows file
+    #
+    # #### Returns
+    # - ext: string for file extension on windows
+    #      : empty string otherwise
+    def executable_file_extension(ext = ".exe")
+      if windows?
+        ext
+      else
+        ""
+      end
+    end
+
     private
 
     def ctx_path(fname)
-      require 'pathname'
+      require "pathname"
       if Pathname.new(fname).absolute?
         fname
       else