shopify-cli 1.5.0 → 1.9.0

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,8 +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",
           },
         },
 
@@ -281,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?",
@@ -329,6 +320,8 @@ module ShopifyCli
             url_fetch_failure: "Unable to fetch external url",
             prereq_command_required: "%1$s is required for installing ngrok. Please install %1$s using the appropriate"\
               " package manager for your system.",
+            ngrok: "Something went wrong with ngrok installation,"\
+              "please make sure %s exists within %s before trying again",
           },
 
           not_running: "{{green:x}} ngrok tunnel not running",
@@ -363,15 +356,15 @@ module ShopifyCli
           {{x}} This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
             Please visit this page for complete instructions:
-            {{underline:https://shopify.github.io/shopify-app-cli/migrate/}}
+            {{underline:https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version}}
 
           MESSAGE
 
           new_version: <<~MESSAGE,
-          {{*}} {{yellow:A new version of the Shopify App CLI is available! You have version %s and the latest version is %s.
+          {{*}} {{yellow:A new version of Shopify App CLI is available! You have version %s and the latest version is %s.
 
             To upgrade, follow the instructions for the package manager you’re using:
-            {{underline:https://shopify.github.io/shopify-app-cli/getting-started/upgrade/}}}}
+            {{underline:https://shopify.dev/tools/cli/troubleshooting#upgrade-shopify-app-cli}}}}
 
           MESSAGE
         },

data/lib/shopify-cli/method_object.rb

@@ -0,0 +1,104 @@
+module ShopifyCli
+  ##
+  # The `MethodObject` mixin can be included in any class that implements `call`
+  # to ensure that
+  #
+  # * `call` will always return a `ShopifyCli::Result` by prepending a module
+  #   that takes care of the result wrapping and
+  # * a `to_proc` method that allows instances of this class to be passed as a
+  #   block.
+  #
+  # For convenience, this mixin also adds the corresponding class methods:
+  # `call` and `to_proc`. Method and result objects pair nicely as they greatly
+  # simplify the creation of complex processing chains:
+  #
+  #   class Serialize
+  #     include MethodObject
+  #
+  #     def call(attrs)
+  #       attrs.to_json
+  #     end
+  #   end
+  #
+  #   class Deserialize
+  #     include MethodObject
+  #
+  #     def call(json)
+  #       JSON.parse(json)
+  #     end
+  #   end
+  #
+  #   Serialize
+  #     .call(firstname: "John", lastname: "Doe")
+  #     .then(&Deserialize)
+  #     .map { |attrs| OpenStruct.new(attrs) }
+  #     .unwrap(nil)
+  #
+  # While this example is contrived, it still illustrates some key advantages of
+  # this programming paradigm:
+  #
+  # * chaining operations is as simple as repeatedly calling `then` or `map`,
+  # * method objects don't have to be manually instantiated but can be
+  #   constructed using the `&` operator,
+  # * error handling is deferred until the result is unwrapped.
+  #
+  # Please see the section for `ShopifyCli::Result`,
+  # `ShopifyCli::Result::Success`, and `ShopifyCli::Result::Failure` for more
+  # information on the API of result objects.
+  #
+  module MethodObject
+    module AutoCreateResultObject
+      ##
+      # invokes the original `call` implementation and wraps its return value
+      # into a result object.
+      #
+      def call(*args, **kwargs)
+        Result.wrap { super(*args, **kwargs) }.call
+      end
+    end
+
+    module ClassMethods
+      ##
+      # creates a new instance and invokes `call`. Any positional argument
+      # is forward to `call`. Keyword arguments are either forwarded to the
+      # initializer or to `call`. If the keyword argument matches the name of
+      # property, it is forwarded to the initializer, otherwise to call.
+      #
+      def call(*args, **kwargs)
+        properties.keys.yield_self do |properties|
+          new(**kwargs.slice(*properties))
+            .call(*args, **kwargs.slice(*(kwargs.keys - properties)))
+        end
+      end
+
+      ##
+      # returns a proc that invokes `call` with all arguments it receives when
+      # called itself.
+      #
+      def to_proc
+        method(:call).to_proc
+      end
+    end
+
+    ##
+    # is invoked when this mixin is included into a class. This results in
+    #
+    # * including `SmartProperties`,
+    # * prepending the result wrapping mechanism, and
+    # * adding the class methods `.call` and `.to_proc`.
+    #
+    def self.included(method_object_implementation)
+      method_object_implementation.prepend(AutoCreateResultObject)
+      method_object_implementation.include(SmartProperties)
+      method_object_implementation.extend(ClassMethods)
+    end
+
+    ##
+    # returns a proc that invokes `call` with all arguments it receives when
+    # called itself.
+    #
+    def to_proc
+      method(:call).to_proc
+    end
+  end
+end

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