shopify-cli 1.6.0 → 1.7.0

data/lib/shopify-cli/http_request.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require "net/http"
 
 module ShopifyCli
   class HttpRequest
@@ -18,7 +18,7 @@ module ShopifyCli
         http.use_ssl = true
 
         req.body = body unless body.nil?
-        req['Content-Type'] = 'application/json'
+        req["Content-Type"] = "application/json"
         headers.each { |header, value| req[header] = value }
         http.request(req)
       end

data/lib/shopify-cli/js_deps.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   ##
@@ -37,9 +37,9 @@ module ShopifyCli
     #   ShopifyCli::JsDeps.new(context).install(true)
     #
     def install(verbose = false)
-      title = ctx.message('core.js_deps.installing', @system.package_manager)
-      success = ctx.message('core.js_deps.installed')
-      failure = ctx.message('core.js_deps.error.install_error', @system.package_manager)
+      title = ctx.message("core.js_deps.installing", @system.package_manager)
+      success = ctx.message("core.js_deps.installed")
+      failure = ctx.message("core.js_deps.error.install_error", @system.package_manager)
 
       CLI::UI::Frame.open(title, success_text: success, failure_text: failure) do
         @system.call(
@@ -53,14 +53,14 @@ module ShopifyCli
 
     def yarn(verbose = false)
       cmd = %w(yarn install)
-      cmd << '--silent' unless verbose
+      cmd << "--silent" unless verbose
 
       run_install_command(cmd)
     end
 
     def npm(verbose = false)
       cmd = %w(npm install --no-audit)
-      cmd << '--quiet' unless verbose
+      cmd << "--quiet" unless verbose
 
       run_install_command(cmd)
     end
@@ -69,7 +69,7 @@ module ShopifyCli
       deps = parse_dependencies
       errors = nil
 
-      spinner_title = ctx.message('core.js_deps.installing', @system.package_manager)
+      spinner_title = ctx.message("core.js_deps.installing", @system.package_manager)
       success = CLI::UI::Spinner.spin(spinner_title, auto_debrief: false) do |spinner|
         _, errors, status = CLI::Kit::System.capture3(*cmd, env: @ctx.env, chdir: ctx.root)
         update_spinner_title_and_status(spinner, status, deps)
@@ -81,19 +81,19 @@ module ShopifyCli
 
     def update_spinner_title_and_status(spinner, status, deps)
       if status.success?
-        spinner.update_title(ctx.message('core.js_deps.installed', deps.size))
+        spinner.update_title(ctx.message("core.js_deps.installed", deps.size))
       else
-        spinner.update_title(ctx.message('core.js_deps.error.install_spinner_error', deps.size))
+        spinner.update_title(ctx.message("core.js_deps.error.install_spinner_error", deps.size))
         CLI::UI::Spinner::TASK_FAILED
       end
     end
 
     def parse_dependencies
-      package_json = File.join(ctx.root, 'package.json')
+      package_json = File.join(ctx.root, "package.json")
       pkg = begin
               JSON.parse(File.read(package_json))
             rescue Errno::ENOENT, Errno::ENOTDIR
-              ctx.abort(ctx.message('core.js_deps.error.missing_package', package_json))
+              ctx.abort(ctx.message("core.js_deps.error.missing_package", package_json))
             end
 
       %w(dependencies devDependencies).map do |key|
@@ -101,7 +101,7 @@ module ShopifyCli
       end.flatten
     rescue JSON::ParserError
       ctx.puts(
-        ctx.message('core.js_deps.error.invalid_package', File.read(File.join(path, 'package.json'))),
+        ctx.message("core.js_deps.error.invalid_package", File.read(File.join(path, "package.json"))),
         error: true
       )
       raise ShopifyCli::AbortSilent

data/lib/shopify-cli/js_system.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   ##
@@ -7,8 +7,8 @@ module ShopifyCli
   class JsSystem
     include SmartProperties
 
-    YARN_CORE_COMMAND = 'yarn'
-    NPM_CORE_COMMAND = 'npm'
+    YARN_CORE_COMMAND = "yarn"
+    NPM_CORE_COMMAND = "npm"
 
     class << self
       ##
@@ -64,8 +64,8 @@ module ShopifyCli
     #
     def yarn?
       @has_yarn ||= begin
-        cmd_path = @ctx.which('yarn')
-        File.exist?(File.join(ctx.root, 'yarn.lock')) && !cmd_path.nil?
+        cmd_path = @ctx.which("yarn")
+        File.exist?(File.join(ctx.root, "yarn.lock")) && !cmd_path.nil?
       end
     end
 

data/lib/shopify-cli/lazy_delegator.rb

@@ -0,0 +1,55 @@
+require "delegate"
+
+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
+  # delegator cannot handle itself:
+  #
+  #   result = LazyDelegator.new do
+  #     # carry out costly operation ...
+  #   end
+  #
+  #   result      # referencing the object itself does not result in Proc evaluation
+  #   result.to_h # however, calling a method on it will result in Proc evaluation
+  #
+  # LazyDelegator lends itself to being subclassed in scenarios where some
+  # facts are known and others are costly to compute:
+  #
+  #   class LazySpecificationHandler < ShopifyCli::LazyDelegator
+  #     attr_reader :identifier
+  #
+  #     def initialize(identifier, &initializer)
+  #       super(&initializer)
+  #       @identifier = identifier
+  #     end
+  #   end
+  #
+  #   handler = LazySpecificationHandler.new(:product_subscription) do
+  #      # fetch specification from the Partners Dashboard API ...
+  #   end
+  #
+  #   # Accessing identifier will not result in Proc evaluation as it is
+  #   # available as an attribute of the delegator itself
+  #   handler.identifier # => :product_subscription
+  #
+  #   # Accessing the specification will result in evaluation of the Proc
+  #   # and in our example in a subsequent network call
+  #   handler.specification # => <Extension::Models::Specifcation:...>
+  #
+  class LazyDelegator < SimpleDelegator
+    def initialize(&delegatee_initializer)
+      super([false, delegatee_initializer])
+    end
+
+    protected
+
+    def __getobj__(*)
+      initialized, value_or_initializer = super
+      return value_or_initializer if initialized
+      value_or_initializer.call.tap do |value|
+        __setobj__([true, value])
+      end
+    end
+  end
+end

data/lib/shopify-cli/messages/messages.rb

@@ -76,16 +76,6 @@ module ShopifyCli
             is_enabled: "{{v}} analytics are currently enabled",
             is_disabled: "{{v}} analytics are currently disabled",
           },
-          shopifolk_beta: {
-            help: <<~HELP,
-            Opt in/out of shopifolk beta
-              Usage: {{command:%s config [ analytics ] }}
-            HELP
-            enabled: "{{v}} shopifolk-beta has been enabled",
-            disabled: "{{v}} shopifolk-beta has been disabled",
-            is_enabled: "{{v}} shopifolk-beta is currently enabled",
-            is_disabled: "{{v}} shopifolk-beta is currently disabled",
-          },
         },
 
         git: {
@@ -129,7 +119,7 @@ module ShopifyCli
             missing_package: "expected to have a file at: %s",
             invalid_package: "{{info:%s}} was not valid JSON. Fix this then try again",
             install_spinner_error: "Unable to install all %d dependencies",
-            install_error: 'An error occurred while installing dependencies',
+            install_error: "An error occurred while installing dependencies",
           },
 
           installing: "Installing dependencies with %s...",
@@ -192,9 +182,9 @@ module ShopifyCli
 
         api: {
           error: {
-            internal_server_error: '{{red:{{x}} An unexpected error occurred on Shopify.}}',
+            internal_server_error: "{{red:{{x}} An unexpected error occurred on Shopify.}}",
             internal_server_error_debug: "\n{{red:Response details:}}\n%s\n\n",
-            invalid_url: 'Invalid URL: %s',
+            invalid_url: "Invalid URL: %s",
           },
         },
 
@@ -282,7 +272,7 @@ module ShopifyCli
             MESSAGE
             development_store_select: "Which development store would you like to use?",
             app_select: "To which app does this project belong?",
-            no_apps: 'You have no apps to connect to, creating a new app.',
+            no_apps: "You have no apps to connect to, creating a new app.",
             app_name: "App name",
             app_type: {
               select: "What type of app are you building?",

data/lib/shopify-cli/oauth.rb

@@ -1,18 +1,18 @@
-require 'base64'
-require 'digest'
-require 'json'
-require 'net/http'
-require 'securerandom'
-require 'openssl'
-require 'shopify_cli'
-require 'uri'
-require 'webrick'
+require "base64"
+require "digest"
+require "json"
+require "net/http"
+require "securerandom"
+require "openssl"
+require "shopify_cli"
+require "uri"
+require "webrick"
 
 module ShopifyCli
   class OAuth
     include SmartProperties
 
-    autoload :Servlet, 'shopify-cli/oauth/servlet'
+    autoload :Servlet, "shopify-cli/oauth/servlet"
 
     class Error < StandardError; end
     LocalRequest = Struct.new(:method, :path, :query, :protocol)
@@ -54,10 +54,10 @@ module ShopifyCli
       @server ||= begin
         server = WEBrick::HTTPServer.new(
           Port: DEFAULT_PORT,
-          Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
+          Logger: WEBrick::Log.new(File.open(File::NULL, "w")),
           AccessLog: [],
         )
-        server.mount('/', Servlet, self, state_token)
+        server.mount("/", Servlet, self, state_token)
         server
       end
     end
@@ -80,17 +80,17 @@ module ShopifyCli
     end
 
     def output_authentication_info(uri)
-      login_location = ctx.message(service == 'admin' ? 'core.oauth.location.admin' : 'core.oauth.location.partner')
-      ctx.puts(ctx.message('core.oauth.authentication_required', login_location))
+      login_location = ctx.message(service == "admin" ? "core.oauth.location.admin" : "core.oauth.location.partner")
+      ctx.puts(ctx.message("core.oauth.authentication_required", login_location))
       ctx.open_url!(uri)
     end
 
     def receive_access_code
       @access_code ||= begin
         @server_thread.join(240)
-        raise Error, ctx.message('core.oauth.error.timeout') if response_query.nil?
-        raise Error, response_query['error_description'] unless response_query['error'].nil?
-        response_query['code']
+        raise Error, ctx.message("core.oauth.error.timeout") if response_query.nil?
+        raise Error, response_query["error_description"] unless response_query["error"].nil?
+        response_query["code"]
       end
     end
 
@@ -105,8 +105,8 @@ module ShopifyCli
         }.merge(confirmation_param)
       )
       store.set(
-        "#{service}_access_token".to_sym => resp['access_token'],
-        "#{service}_refresh_token".to_sym => resp['refresh_token'],
+        "#{service}_access_token".to_sym => resp["access_token"],
+        "#{service}_refresh_token".to_sym => resp["refresh_token"],
       )
     end
 
@@ -130,8 +130,8 @@ module ShopifyCli
         client_id: client_id,
       )
       store.set(
-        "#{service}_access_token".to_sym => resp['access_token'],
-        "#{service}_refresh_token".to_sym => resp['refresh_token'],
+        "#{service}_access_token".to_sym => resp["access_token"],
+        "#{service}_refresh_token".to_sym => resp["refresh_token"],
       )
     end
 
@@ -155,7 +155,7 @@ module ShopifyCli
         scope: scopes,
         subject_token: store.get("#{service}_access_token".to_sym),
       )
-      store.set("#{service}_exchange_token".to_sym => resp['access_token'])
+      store.set("#{service}_exchange_token".to_sym => resp["access_token"])
     end
 
     def post_token_request(url, params)
@@ -163,17 +163,17 @@ 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 App CLI #{::ShopifyCli::VERSION}"
+      request["User-Agent"] = "Shopify App CLI #{::ShopifyCli::VERSION}"
       request.body = URI.encode_www_form(params)
       res = https.request(request)
-      raise Error, JSON.parse(res.body)['error_description'] unless res.is_a?(Net::HTTPSuccess)
+      raise Error, JSON.parse(res.body)["error_description"] unless res.is_a?(Net::HTTPSuccess)
       JSON.parse(res.body)
     end
 
     def challange_params
       {
         code_challenge: code_challenge,
-        code_challenge_method: 'S256',
+        code_challenge_method: "S256",
       }
     end
 

data/lib/shopify-cli/oauth/servlet.rb

@@ -26,18 +26,18 @@ module ShopifyCli
       end
 
       def do_GET(req, res) # rubocop:disable Naming/MethodName
-        if !req.query['error'].nil?
+        if !req.query["error"].nil?
           respond_with(
             res,
             400,
-            Context.message('core.oauth.servlet.invalid_request_response', req.query['error_description'])
+            Context.message("core.oauth.servlet.invalid_request_response", req.query["error_description"])
           )
-        elsif req.query['state'] != @state_token
-          response_message = Context.message('core.oauth.servlet.invalid_state_response')
-          req.query.merge!('error' => 'invalid_state', 'error_description' => response_message)
+        elsif req.query["state"] != @state_token
+          response_message = Context.message("core.oauth.servlet.invalid_state_response")
+          req.query.merge!("error" => "invalid_state", "error_description" => response_message)
           respond_with(res, 403, response_message)
         else
-          respond_with(res, 200, Context.message('core.oauth.servlet.success_response'))
+          respond_with(res, 200, Context.message("core.oauth.servlet.success_response"))
         end
         @oauth.response_query = req.query
         @server.shutdown
@@ -48,10 +48,10 @@ module ShopifyCli
         locals = {
           status: status,
           message: message,
-          color: successful ? 'black' : 'red',
+          color: successful ? "black" : "red",
           title:
-            Context.message(successful ? 'core.oauth.servlet.authenticated' : 'core.oauth.servlet.not_authenticated'),
-          autoclose: successful ? AUTOCLOSE_TEMPLATE : '',
+            Context.message(successful ? "core.oauth.servlet.authenticated" : "core.oauth.servlet.not_authenticated"),
+          autoclose: successful ? AUTOCLOSE_TEMPLATE : "",
         }
         response.status = status
         response.body = format(TEMPLATE, locals)

data/lib/shopify-cli/options.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'shopify_cli'
-require 'optparse'
+require "shopify_cli"
+require "optparse"
 
 module ShopifyCli
   class Options
@@ -31,7 +31,7 @@ module ShopifyCli
     def parser
       @parser ||= begin
         opt = OptionParser.new
-        opt.on('--help', '-h', Context.message('core.options.help_text')) do |v|
+        opt.on("--help", "-h", Context.message("core.options.help_text")) do |v|
           @help = v
         end
       end

data/lib/shopify-cli/packager.rb

@@ -1,17 +1,17 @@
 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)
     end
 
     def build_debian
-      ensure_program_installed('dpkg-deb', 'brew install dpkg')
+      ensure_program_installed("dpkg-deb", "brew install dpkg")
 
-      root_dir = File.join(PACKAGING_DIR, 'debian')
-      debian_dir = File.join(root_dir, 'shopify-cli', 'DEBIAN')
+      root_dir = File.join(PACKAGING_DIR, "debian")
+      debian_dir = File.join(root_dir, "shopify-cli", "DEBIAN")
       FileUtils.mkdir_p(debian_dir)
 
       puts "\nBuilding Debian package"
@@ -24,15 +24,15 @@ 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.open(file_path, 'w', 0775) { |f| f.write(file_contents) }
+        file_contents = file_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
+        File.open(file_path, "w", 0775) { |f| f.write(file_contents) }
       end
 
       puts "Building package..."
       Dir.chdir(root_dir)
-      raise "Failed to build package" unless system('dpkg-deb', '-b', 'shopify-cli')
+      raise "Failed to build package" unless system("dpkg-deb", "-b", "shopify-cli")
 
-      output_path = File.join(root_dir, 'shopify-cli.deb')
+      output_path = File.join(root_dir, "shopify-cli.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"
@@ -40,34 +40,34 @@ module ShopifyCli
     end
 
     def build_rpm
-      ensure_program_installed('rpmbuild', 'brew install rpm')
+      ensure_program_installed("rpmbuild", "brew install rpm")
 
-      root_dir = File.join(PACKAGING_DIR, 'rpm')
-      rpm_build_dir = File.join(root_dir, 'build')
+      root_dir = File.join(PACKAGING_DIR, "rpm")
+      rpm_build_dir = File.join(root_dir, "build")
       FileUtils.mkdir_p(rpm_build_dir)
 
-      spec_path = File.join(root_dir, 'shopify-cli.spec')
+      spec_path = File.join(root_dir, "shopify-cli.spec")
       puts "\nBuilding RPM package"
 
       puts "Generating spec file..."
       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 = File.read(File.join(root_dir, "shopify-cli.spec.base"))
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
       File.write(spec_path, spec_contents)
 
       puts "Building package..."
       Dir.chdir(root_dir)
-      system('rpmbuild', '-bb', File.basename(spec_path))
+      system("rpmbuild", "-bb", File.basename(spec_path))
 
-      output_dir = File.join(root_dir, 'build', 'noarch')
+      output_dir = File.join(root_dir, "build", "noarch")
 
       puts "Moving generated packages: \n  From: #{output_dir}\n  To: #{BUILDS_DIR}\n\n"
       FileUtils.mv(Dir.glob("#{output_dir}/*.rpm"), BUILDS_DIR)
     end
 
     def build_homebrew
-      root_dir = File.join(PACKAGING_DIR, 'homebrew')
+      root_dir = File.join(PACKAGING_DIR, "homebrew")
 
       build_path = File.join(BUILDS_DIR, "shopify-cli.rb")
       puts "\nBuilding Homebrew package"
@@ -75,18 +75,18 @@ module ShopifyCli
       puts "Generating formula..."
       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 = File.read(File.join(root_dir, "shopify-cli.base.rb"))
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
 
       puts "Grabbing sha256 checksum from Rubygems.org"
-      require 'digest/sha2'
-      require 'open-uri'
+      require "digest/sha2"
+      require "open-uri"
       gem_checksum = open("https://rubygems.org/downloads/shopify-cli-#{ShopifyCli::VERSION}.gem") do |io|
         Digest::SHA256.new.hexdigest(io.read)
       end
 
       puts "Got sha256 checksum for gem: #{gem_checksum}"
-      spec_contents = spec_contents.gsub('SHOPIFY_CLI_GEM_CHECKSUM', gem_checksum)
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_GEM_CHECKSUM", gem_checksum)
 
       puts "Writing generated formula\n  To: #{build_path}\n\n"
       File.write(build_path, spec_contents)
@@ -95,7 +95,7 @@ module ShopifyCli
     private
 
     def ensure_program_installed(program, installation_cmd)
-      unless system(program, '--version', out: File::NULL, err: File::NULL)
+      unless system(program, "--version", out: File::NULL, err: File::NULL)
         raise <<~MESSAGE
 
           Could not find program #{program} which is required to build the package.