@shopify/cli-kit 3.69.4 → 3.71.0

package/assets/cli-ruby/lib/shopify_cli/feature.rb

@@ -1,95 +0,0 @@
-module ShopifyCLI
-  ##
-  # ShopifyCLI::Feature contains the logic to hide and show features across the CLI
-  # These features can be either commands or project types currently.
-  #
-  # Feature flags will persist between runs so if the flag is enabled or disabled,
-  # it will still be in that same state on the next cli invocation.
-  class Feature
-    SECTION = "features"
-
-    ##
-    # ShopifyCLI::Feature::Set is included on commands and projects to allow you to hide
-    # and enable projects and commands based on feature flags.
-    module Set
-      ##
-      # will hide a feature, either a project_type or a command
-      #
-      # #### Parameters
-      #
-      # * `feature_set` - either a single, or array of symbols that represent feature sets
-      #
-      # #### Example
-      #
-      #    module ShopifyCLI
-      #      module Commands
-      #        class Config < ShopifyCLI::Command
-      #          hidden_feature(feature_set: :basic)
-      #          ....
-      #
-      def hidden_feature(feature_set: [])
-        @feature_hidden = true
-        @hidden_feature_set = Array(feature_set).compact
-      end
-
-      ##
-      # will return if the feature has been hidden or not
-      #
-      # #### Returns
-      #
-      # * `is_hidden` - returns true if the feature has been hidden and false otherwise
-      #
-      # #### Example
-      #
-      #     ShopifyCLI::Commands::Config.hidden?
-      #
-      def hidden?
-        enabled = (@hidden_feature_set || []).any? do |feature|
-          Feature.enabled?(feature)
-        end
-        @feature_hidden && !enabled
-      end
-    end
-
-    class << self
-      ##
-      # will enable a feature in the CLI.
-      #
-      # #### Parameters
-      #
-      # * `feature` - a symbol representing the flag to be enabled
-      def enable(feature)
-        set(feature, true)
-      end
-
-      ##
-      # will disable a feature in the CLI.
-      #
-      # #### Parameters
-      #
-      # * `feature` - a symbol representing the flag to be disabled
-      def disable(feature)
-        set(feature, false)
-      end
-
-      ##
-      # will check if the feature has been enabled
-      #
-      # #### Parameters
-      #
-      # * `feature` - a symbol representing a flag that the status should be requested
-      #
-      # #### Returns
-      #
-      # * `is_enabled` - will be true if the feature has been enabled.
-      def enabled?(feature)
-        return false if feature.nil?
-        ShopifyCLI::Config.get_bool(SECTION, feature.to_s)
-      end
-
-      def set(feature, value)
-        ShopifyCLI::Config.set(SECTION, feature.to_s, value)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/file_system_listener.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-require "listen"
-require "observer"
-
-module ShopifyCLI
-  class FileSystemListener
-    include Observable
-
-    def initialize(root:, force_poll:, ignore_regex:)
-      @root = root
-      @force_poll = force_poll
-      @ignore_regex = ignore_regex
-
-      @listener = Listen.to(@root, force_polling: @force_poll, ignore: @ignore_regex) do |updated, added, removed|
-        changed
-        notify_observers(updated, added, removed)
-      end
-    end
-
-    def start
-      @listener.start
-    rescue ArgumentError
-      # Ignore errors during the transition of 'listen' events
-    end
-
-    def stop
-      @listener.stop
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/form.rb

@@ -1,42 +0,0 @@
-require "shopify_cli"
-
-module ShopifyCLI
-  class Form
-    class << self
-      def ask(ctx, args, flags)
-        attrs = {}
-        (@positional_arguments || []).each { |name| attrs[name] = args.shift }
-        return nil if attrs.any? { |_k, v| v.nil? }
-        (@flag_arguments || []).each { |arg| attrs[arg] = flags[arg] }
-        form = new(ctx, args, attrs)
-        begin
-          form.ask
-          form
-        rescue ShopifyCLI::Abort => err
-          ctx.puts(err.message)
-          nil
-        rescue ShopifyCLI::AbortSilent
-          nil
-        end
-      end
-
-      def positional_arguments(*args)
-        @positional_arguments = args
-        attr_accessor(*args)
-      end
-
-      def flag_arguments(*args)
-        @flag_arguments = args
-        attr_accessor(*args)
-      end
-    end
-
-    attr_accessor :ctx, :xargs
-
-    def initialize(ctx, xargs, attributes)
-      @ctx = ctx
-      @xargs = xargs
-      attributes.each { |k, v| send("#{k}=", v) unless v.nil? }
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/git.rb

@@ -1,320 +0,0 @@
-module ShopifyCLI
-  ##
-  # ShopifyCLI::Git wraps git functionality to make it easier to integrate will
-  # git.
-  class Git
-    class << self
-      # Check if Git exists in the environment
-      def exists?(ctx)
-        _output, status = ctx.capture2e("git", "version")
-        status.success?
-      rescue Errno::ENOENT # git is not installed
-        false
-      end
-
-      # Check if the current working directory is a Git repository
-      def available?(ctx)
-        _output, status = ctx.capture2e("git", "status")
-        status.success?
-      rescue Errno::ENOENT # git is not installed
-        false
-      end
-
-      ##
-      # will return the current sha of the cli repo
-      #
-      # #### Parameters
-      #
-      # * `dir` - the directory of the git repo. This defaults to the cli repo
-      # * `ctx` - the current running context of your command
-      #
-      # #### Returns
-      #
-      # * `sha_string` - string of the sha of the most recent commit to the repo
-      #
-      # #### Example
-      #
-      #   ShopifyCLI::Git.sha
-      #
-      # Some environments don't have git in PATH and this prevents
-      # the execution from raising an error
-      # https://app.bugsnag.com/shopify/shopify-cli/errors/615dd36365ce57000889d4c5
-      def sha(dir: Dir.pwd, ctx: Context.new)
-        if available?(ctx)
-          rev_parse("HEAD", dir: dir, ctx: ctx)
-        end
-      end
-
-      ##
-      # returns array with components of git clone command
-      #
-      # #### Parameters
-      #
-      # * `repo` - repo url without branch name
-      # * `dest` - a filepath to where the repo should be cloned to
-      # * `branch` - branch name when cloning
-      #
-      # #### Returns
-      #
-      # * array of strings
-      #
-      # #### Example
-      #
-      #   ["clone", "--single-branch", "--branch", "test-branch", "test-app"]
-      #
-      def git_clone_command(repo, dest, branch)
-        if branch
-          ["clone", "--single-branch", "--branch", branch, repo, dest]
-        else
-          ["clone", "--single-branch", repo, dest]
-        end
-      end
-
-      ##
-      # calls git to clone a new repo into a supplied destination,
-      # it will also call a supplied block with the percentage of clone completion
-      #
-      # #### Parameters
-      #
-      # * `repo_with_branch` - a git url for git to clone the repo from
-      # * `dest` - a filepath to where the repo should be cloned to
-      # * `ctx` - the current running context of your command, defaults to a new context.
-      #
-      # #### Returns
-      #
-      # * `sha_string` - string of the sha of the most recent commit to the repo
-      #
-      # #### Example
-      #
-      #   ShopifyCLI::Git.raw_clone('git@github.com:shopify/test.git', 'test-app')
-      #
-      def raw_clone(repo_with_branch, dest, ctx: Context.new)
-        if Dir.exist?(dest) && !Dir.empty?(dest)
-          ctx.abort(ctx.message("core.git.error.directory_exists"))
-        else
-          msg = []
-          # require at usage point to not slow down CLI startup
-          # https://github.com/Shopify/shopify-cli/pull/698#discussion_r444342445
-          require "open3"
-
-          repo, branch = repo_with_branch.split("#")
-          git_cmd = git_clone_command(repo, dest, branch)
-
-          success = Open3.popen3("git", *git_cmd, "--progress") do |_stdin, _stdout, stderr, thread|
-            msg = clone_progress(stderr, bar: nil)
-
-            thread.value
-          end.success?
-
-          ctx.abort((msg.join("\n"))) unless success
-        end
-      end
-
-      ##
-      # calls git to clone a new repo into a supplied destination,
-      # it will also output progress of the cloning process into a new progress bar
-      #
-      # #### Parameters
-      #
-      # * `repo_with_branch` - a git url for git to clone the repo from
-      # * `dest` - a filepath to where the repo should be cloned to
-      # * `ctx` - the current running context of your command, defaults to a new context.
-      #
-      # #### Returns
-      #
-      # * `sha_string` - string of the sha of the most recent commit to the repo
-      #
-      # #### Example
-      #
-      #   ShopifyCLI::Git.clone('git@github.com:shopify/test.git', 'test-app')
-      #
-      def clone(repo_with_branch, dest, ctx: Context.new)
-        if Dir.exist?(dest) && !Dir.empty?(dest)
-          ctx.abort(ctx.message("core.git.error.directory_exists"))
-        else
-          msg = []
-          # require at usage point to not slow down CLI startup
-          # https://github.com/Shopify/shopify-cli/pull/698#discussion_r444342445
-          require "open3"
-
-          repo, branch = repo_with_branch.split("#")
-          git_cmd = git_clone_command(repo, dest, branch)
-
-          success_message = ctx.message("core.git.cloned", dest)
-
-          CLI::UI::Frame.open(ctx.message("core.git.cloning", repo, dest), success_text: success_message) do
-            CLI::UI::Progress.progress do |bar|
-              success = Open3.popen3("git", *git_cmd, "--progress") do |_stdin, _stdout, stderr, thread|
-                msg = clone_progress(stderr, bar: bar)
-
-                thread.value
-              end.success?
-
-              ctx.abort((msg.join("\n"))) unless success
-              bar.tick(set_percent: 1.0)
-            end
-          end
-        end
-      end
-
-      ##
-      # will fetch the repos list of branches.
-      #
-      # #### Parameters
-      #
-      # * `ctx` - the current running context of your command, defaults to a new context.
-      #
-      # #### Returns
-      #
-      # * `branches` - [String] an array of strings that are branch names
-      #
-      # #### Example
-      #
-      #   branches = ShopifyCLI::Git.branches(@ctx)
-      #
-      def branches(ctx)
-        output, status = ctx.capture2e("git", "branch", "--list", "--format=%(refname:short)")
-        ctx.abort(ctx.message("core.git.error.no_branches_found")) unless status.success?
-
-        branches = if output == ""
-          ["master"]
-        else
-          output.split("\n")
-        end
-
-        branches
-      end
-
-      ##
-      # Run git three-way file merge (it doesn't require an initialized git repository)
-      #
-      # #### Parameters
-      #
-      # * `current_file  - string path of the current file
-      # * `base_file`    - string path of the base file
-      # * `other_file`   - string path of the other file
-      # * `opts`         - list of "git merge-file" options. Valid values:
-      #                    - "-q"       - do not warn about conflicts
-      #                    - "--diff3"  - show conflicts
-      #                    - "--ours"   - resolve conflicts favoring lines from `current_file`
-      #                    - "--theirs" - resolve conflicts favoring lines from `other_file`
-      #                    - "--union"  - resolve conflicts favoring lines from both files
-      #                    - "-p"       - send results to standard output instead of
-      #                                 overwriting the `current_file`
-      # * `ctx`          - the current running context of your command, defaults to a new context
-      #
-      # #### Returns
-      #
-      # * standard output from git
-      #
-      # #### Example
-      #
-      #   output = ShopifyCLI::Git.merge_file(current_file, base_file, other_file, opts, ctx: ctx)
-      #
-      def merge_file(current_file, base_file, other_file, opts = [], ctx: Context.new)
-        output, status = ctx.capture2e("git", "merge-file", current_file, base_file, other_file, *opts)
-
-        unless status.success?
-          ctx.abort(ctx.message("core.git.error.merge_failed"))
-        end
-
-        output
-      end
-
-      ##
-      # will initialize a new repo in the current directory. This will output
-      # if it was successful or not.
-      #
-      # #### Parameters
-      #
-      # * `ctx` - the current running context of your command, defaults to a new context.
-      #
-      # #### Example
-      #
-      #   ShopifyCLI::Git.init(@ctx)
-      #
-      def init(ctx)
-        output, status = ctx.capture2e("git", "status")
-
-        unless status.success?
-          ctx.abort(ctx.message("core.git.error.repo_not_initiated"))
-        end
-
-        if output.include?("No commits yet")
-          ctx.abort(ctx.message("core.git.error.no_commits_made"))
-        end
-      end
-
-      def sparse_checkout(repo, set, branch, ctx)
-        _, status = ctx.capture2e("git init")
-        unless status.success?
-          ctx.abort(ctx.message("core.git.error.repo_not_initiated"))
-        end
-
-        _, status = ctx.capture2e("git remote add -f origin #{repo}")
-        unless status.success?
-          ctx.abort(ctx.message("core.git.error.remote_not_added"))
-        end
-
-        _, status = ctx.capture2e("git config core.sparsecheckout true")
-        unless status.success?
-          ctx.abort(ctx.message("core.git.error.sparse_checkout_not_enabled"))
-        end
-
-        _, status = ctx.capture2e("git sparse-checkout set #{set}")
-        unless status.success?
-          ctx.abort(ctx.message("core.git.error.sparse_checkout_not_set"))
-        end
-
-        resp, status = ctx.capture2e("git pull origin #{branch}")
-        unless status.success?
-          if resp.include?("fatal: couldn't find remote ref")
-            ctx.abort(ctx.message("core.git.error.pull_failed_bad_branch", branch))
-          end
-          ctx.abort(ctx.message("core.git.error.pull_failed"))
-        end
-      end
-
-      ##
-      # handles showing the progress of the git clone command.
-      # if block given, assumes passing percent to block, otherwise
-      # increments bar for progress bar
-      #
-      # #### Parameters
-      #
-      # * `stderr` - Open3.popen3 output stream
-      # * `bar` - progress bar object to set percent
-      #
-      def clone_progress(stderr, bar: nil)
-        msg = []
-
-        while (line = stderr.gets)
-          msg << line.chomp
-          next unless line.strip.start_with?("Receiving objects:")
-          percent = (line.match(/Receiving objects:\s+(\d+)/)[1].to_f / 100).round(2)
-
-          if block_given?
-            yield percent
-          elsif !bar.nil?
-            bar.tick(set_percent: percent)
-          end
-        end
-
-        msg
-      end
-
-      private
-
-      def exec(*args, dir: Dir.pwd, default: nil, ctx: Context.new)
-        args = %w(git) + ["--git-dir", File.join(dir, ".git")] + args
-        out, _, stat = ctx.capture3(*args)
-        return default unless stat.success?
-        out.chomp
-      end
-
-      def rev_parse(*args, dir: nil, ctx: Context.new)
-        exec("rev-parse", *args, dir: dir, ctx: ctx)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/github/issue_url_generator.rb

@@ -1,30 +0,0 @@
-module ShopifyCLI
-  module GitHub
-    module IssueURLGenerator
-      def self.error_url(error)
-        title = "[Bug]: #{error.class}: #{error.message}"
-        labels = "type:bug"
-
-        # take at most 5 lines from backtrace
-        stacktrace_text =
-          if error.backtrace # Sometimes errors seem to appear without backtrace, see https://github.com/Shopify/shopify-cli/issues/1972#issuecomment-1028013630
-            stacktrace = error.backtrace.length < 5 ? error.backtrace : error.backtrace[0..4]
-            stacktrace.join("\n").to_s
-          else
-            ""
-          end
-        query = URI.encode_www_form({
-          title: title,
-          labels: labels,
-          template: "bug_report.yaml",
-          stack_trace: stacktrace_text,
-          os: RUBY_PLATFORM,
-          cli_version: ShopifyCLI::VERSION,
-          ruby_version: "#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}",
-          shell: ENV["SHELL"],
-        })
-        "#{ShopifyCLI::Constants::Links::NEW_ISSUE}?#{query}"
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/github.rb

@@ -1,5 +0,0 @@
-module ShopifyCLI
-  module GitHub
-    autoload :IssueURLGenerator, "shopify_cli/github/issue_url_generator"
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/helpers/haikunator.rb

@@ -1,92 +0,0 @@
-# Copyright (c) 2015 Usman Bashir
-#
-# MIT License
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require "securerandom"
-
-module ShopifyCLI
-  module Helpers
-    module Haikunator
-      class << self
-        def title
-          build(0, " ")
-        end
-
-        def haikunate(token_range = 9999, delimiter = "-")
-          build(token_range, delimiter)
-        end
-
-        def name
-          first = nouns[random_seed % nouns.length]
-          last = adjectives[random_seed % adjectives.length]
-          [first, last]
-        end
-
-        private
-
-        def build(token_range, delimiter)
-          sections = [
-            adjectives[random_seed % adjectives.length],
-            nouns[random_seed % nouns.length],
-            token(token_range),
-          ]
-
-          sections.compact.join(delimiter)
-        end
-
-        def random_seed
-          SecureRandom.random_number(4096)
-        end
-
-        def token(range)
-          SecureRandom.random_number(range) if range > 0
-        end
-
-        def adjectives
-          %w(
-            autumn hidden bitter misty silent empty dry dark summer
-            icy delicate quiet white cool spring winter patient
-            twilight dawn crimson wispy weathered blue billowing
-            broken cold damp falling frosty green long late lingering
-            bold little morning muddy old red rough still small
-            sparkling throbbing shy wandering withered wild black
-            young holy solitary fragrant aged snowy proud floral
-            restless divine polished ancient purple lively nameless
-          )
-        end
-
-        def nouns
-          %w(
-            waterfall river breeze moon rain wind sea morning
-            snow lake sunset pine shadow leaf dawn glitter forest
-            hill cloud meadow sun glade bird brook butterfly
-            bush dew dust field fire flower firefly feather grass
-            haze mountain night pond darkness snowflake silence
-            sound sky shape surf thunder violet water wildflower
-            wave water resonance sun wood dream cherry tree fog
-            frost voice paper frog smoke star
-          )
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/helpers.rb

@@ -1,5 +0,0 @@
-module ShopifyCLI
-  module Helpers
-    autoload :Haikunator, "shopify_cli/helpers/haikunator"
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/http_request.rb

@@ -1,43 +0,0 @@
-require "net/http"
-require "openssl"
-
-module ShopifyCLI
-  class HttpRequest
-    class << self
-      def post(uri, body, headers)
-        req = ::Net::HTTP::Post.new(uri.request_uri)
-        request(uri, body, headers, req)
-      end
-
-      def put(uri, body, headers)
-        req = ::Net::HTTP::Put.new(uri.request_uri)
-        request(uri, body, headers, req)
-      end
-
-      def get(uri, body, headers)
-        req = ::Net::HTTP::Get.new(uri.request_uri)
-        request(uri, body, headers, req)
-      end
-
-      def delete(uri, body, headers)
-        req = ::Net::HTTP::Delete.new(uri.request_uri)
-        request(uri, body, headers, req)
-      end
-
-      def request(uri, body, headers, req)
-        cert_store = OpenSSL::X509::Store.new
-        cert_store.set_default_paths
-
-        http = ::Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.cert_store = cert_store
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if ENV["SSL_VERIFY_NONE"]
-
-        req.body = body unless body.nil?
-        req["Content-Type"] = "application/json"
-        headers.each { |header, value| req[header] = value }
-        http.request(req)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/shopify_cli/identity_auth/env_auth_token.rb

@@ -1,34 +0,0 @@
-module ShopifyCLI
-  class IdentityAuth
-    class EnvAuthToken
-      Token = Struct.new(:token, :expires_at, keyword_init: true)
-
-      class << self
-        attr_accessor :exchanged_partners_token
-
-        def partners_token_present?
-          Environment.auth_token
-        end
-
-        def fetch_exchanged_partners_token
-          current_time = Time.now.to_i
-
-          # If we have an in-memory token that hasn't expired yet, we reuse it.
-          if exchanged_partners_token && current_time < exchanged_partners_token.expires_at.to_i
-            return exchanged_partners_token.token
-          end
-
-          new_exchanged_token = yield(Environment.auth_token)
-          token = new_exchanged_token["access_token"]
-          expires_in = new_exchanged_token["expires_in"].to_i
-          expires_at = Time.at(current_time + expires_in)
-
-          token = Token.new(token: token, expires_at: expires_at)
-
-          self.exchanged_partners_token = token
-          token.token
-        end
-      end
-    end
-  end
-end