@shopify/cli-kit 3.69.4 → 3.71.0

package/assets/cli-ruby/lib/project_types/rails/forms/create.rb

@@ -1,75 +0,0 @@
-require "uri"
-
-module Rails
-  module Forms
-    class Create < ShopifyCLI::Form
-      flag_arguments :name, :organization_id, :shop_domain, :type, :db
-      VALID_DB_TYPES = ["sqlite3",
-                        "mysql",
-                        "postgresql",
-                        "oracle",
-                        "frontbase",
-                        "ibm_db",
-                        "sqlserver",
-                        "jdbcmysql",
-                        "jdbcsqlite3",
-                        "jdbcpostgresql",
-                        "jdbc"]
-
-      def ask
-        self.name ||= CLI::UI::Prompt.ask(ctx.message("rails.forms.create.app_name"))
-        self.name = format_name
-        self.type = ask_type
-        res = ShopifyCLI::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
-        self.organization_id = res[:organization_id]
-        self.shop_domain = res[:shop_domain]
-        self.db = ask_db
-      end
-
-      private
-
-      def format_name
-        formatted_name = name.downcase.split(" ").join("_")
-
-        if formatted_name.include?("shopify")
-          ctx.abort(ctx.message("rails.forms.create.error.invalid_app_name"))
-        end
-
-        formatted_name
-      end
-
-      def ask_type
-        if type.nil?
-          return CLI::UI::Prompt.ask(ctx.message("rails.forms.create.app_type.select")) do |handler|
-            handler.option(ctx.message("rails.forms.create.app_type.select_public")) { "public" }
-            handler.option(ctx.message("rails.forms.create.app_type.select_custom")) { "custom" }
-          end
-        end
-
-        unless ShopifyCLI::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
-          ctx.abort(ctx.message("rails.forms.create.error.invalid_app_type", type))
-        end
-        ctx.puts(ctx.message("rails.forms.create.app_type.selected", type))
-        type
-      end
-
-      def ask_db
-        if db.nil?
-          return "sqlite3" unless CLI::UI::Prompt.confirm(ctx.message("rails.forms.create.db.want_select"),
-            default: false)
-          @db = CLI::UI::Prompt.ask(ctx.message("rails.forms.create.db.select")) do |handler|
-            VALID_DB_TYPES.each do |db_type|
-              handler.option(ctx.message("rails.forms.create.db.select_#{db_type}")) { db_type }
-            end
-          end
-        end
-
-        unless VALID_DB_TYPES.include?(db)
-          ctx.abort(ctx.message("rails.forms.create.error.invalid_db_type", db))
-        end
-        ctx.puts(ctx.message("rails.forms.create.db.selected", db))
-        db
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/rails/gem.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-
-module Rails
-  class Gem
-    include SmartProperties
-
-    property :ctx, accepts: ShopifyCLI::Context, required: true
-    property :name, converts: :to_s, required: true
-    property :version, converts: :to_s
-
-    class << self
-      def install(ctx, *args)
-        name = args.shift
-        version = args.shift
-        gem = new(ctx: ctx, name: name, version: version)
-        ctx.debug(ctx.message("rails.gem.installed_debug", name, gem.installed?))
-        gem.installed? ? true : gem.install!
-      end
-
-      def binary_path_for(ctx, binary)
-        path_to_binary = File.join(gem_home(ctx), "bin", binary)
-        File.exist?(path_to_binary) ? path_to_binary : binary
-      end
-
-      def gem_home(ctx)
-        ctx.getenv("GEM_HOME") || apply_gem_home(ctx)
-      end
-
-      def gem_path(ctx)
-        ctx.getenv("GEM_PATH") || apply_gem_path(ctx)
-      end
-
-      private
-
-      def apply_gem_home(ctx)
-        path = ""
-        # extract GEM_HOME from `gem environment home` command
-        out, stat = ctx.capture2e("gem", "environment", "home")
-        path = out&.empty? ? "" : out.strip if stat.success?
-        # fallback if return from `gem environment home` is empty (somewhat unlikely)
-        path = fallback_gem_home_path(ctx) if path.empty?
-        # fallback if path isn't writable (if using a system installed ruby)
-        path = fallback_gem_home_path(ctx) unless File.writable?(path)
-        ctx.mkdir_p(path) unless Dir.exist?(path)
-        ctx.debug(ctx.message("rails.gem.setting_gem_home", path))
-        ctx.setenv("GEM_HOME", path)
-      end
-
-      def apply_gem_path(ctx)
-        path = ""
-        out, stat = ctx.capture2e("gem", "environment", "path")
-        path = out&.empty? ? "" : out.strip if stat.success?
-        # usually GEM_PATH already contains GEM_HOME
-        # if gem_home() falls back to our fallback path, we need to add it
-        path = gem_home(ctx) + File::PATH_SEPARATOR + path unless path.include?(gem_home(ctx))
-        ctx.debug(ctx.message("rails.gem.setting_gem_path", path))
-        ctx.setenv("GEM_PATH", path)
-      end
-
-      def fallback_gem_home_path(ctx)
-        File.join(ctx.getenv("HOME"), ".gem", "ruby", RUBY_VERSION)
-      end
-    end
-
-    def installed?
-      found = false
-      paths = self.class.gem_path(ctx).split(File::PATH_SEPARATOR)
-      paths.each do |path|
-        ctx.debug(ctx.message("rails.gem.checking_installation_path", "#{path}/gems/", name))
-        found = !!Dir.glob("#{path}/gems/#{name}-*").detect do |f|
-          gem_satisfies_version?(f)
-        end
-        break if found
-      end
-      found
-    end
-
-    def install!
-      spin = CLI::UI::SpinGroup.new
-      spin.add(ctx.message("rails.gem.installing", name)) do |spinner|
-        args = ["#{ENV["RUBY_BINDIR"]}gem", "install", name]
-        unless version.nil?
-          if ctx.windows? && version.include?("~")
-            args.push("-v", "\"#{version}\"")
-          else
-            args.push("-v", version)
-          end
-        end
-        ctx.system(*args)
-        spinner.update_title(ctx.message("rails.gem.installed", name))
-      end
-      spin.wait
-    end
-
-    def gem_satisfies_version?(path)
-      if version
-        # there was a specific version given during new(), so
-        # check version of gem found to determine match
-        require "semantic/semantic"
-        found_version, _ = path.match(%r{/#{Regexp.quote(name)}-(\d\.\d\.\d)})&.captures
-        found_version.nil? ? false : Semantic::Version.new(found_version).satisfies?(version)
-      else
-        # otherwise ignore the actual version number,
-        # just check there's an initial digit
-        %r{/#{Regexp.quote(name)}-\d}.match?(path)
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/rails/messages/messages.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module Rails
-  module Messages
-    MESSAGES = {
-      rails: {
-        help: <<~HELP,
-          Suite of commands for developing Ruby on Rails apps. See {{command:%1$s app rails <command> --help}} for usage of each command.
-            Usage: {{command:%1$s app rails [ %2$s ]}}
-        HELP
-
-        error: {
-          generic: "Error",
-        },
-
-        gem: {
-          checking_installation_path: "Checking path %s for gem %s",
-          installed: "Installed %s gem",
-          installed_debug: "%s installed: %s",
-          installing: "Installing %s gem…",
-          setting_gem_home: "GEM_HOME being set to %s",
-          setting_gem_path: "GEM_PATH being set to %s",
-        },
-        deploy: {
-          help: <<~HELP,
-            Deploy the current Rails project to a hosting service. Heroku ({{underline:https://www.heroku.com}}) is currently the only option, but more will be added in the future.
-              Usage: {{command:%s app rails deploy [ heroku ]}}
-          HELP
-          extended_help: <<~HELP,
-            {{bold:Subcommands:}}
-              {{cyan:heroku}}: Deploys the current Rails project to Heroku.
-                Usage: {{command:%s app rails deploy heroku}}
-          HELP
-        },
-
-        generate: {
-          help: <<~HELP,
-            Generate code in your Rails project. Currently supports generating new webhooks.
-              Usage: {{command:%s app rails generate [ webhook ]}}
-          HELP
-          extended_help: <<~EXAMPLES,
-            {{bold:Examples:}}
-              {{cyan:%s generate webhook PRODUCTS_CREATE}}
-                Generate and register a new webhook that will be called every time a new product is created on your store.
-          EXAMPLES
-
-          error: {
-            name_exists: "%s already exists!",
-            generic: "Error generating %s",
-          },
-
-          webhook: {
-            help: <<~HELP,
-              Generate and register a new webhook that listens for the specified Shopify store event.
-                Usage: {{command:%s app rails generate webhook <type>}}
-            HELP
-
-            select: "What type of webhook would you like to create?",
-            selected: "Generating webhook: %s",
-          },
-        },
-        forms: {
-          create: {
-            error: {
-              invalid_app_name: "App name cannot contain 'Shopify'",
-              invalid_app_type: "Invalid app type %s",
-              invalid_db_type: "Invalid database type %s",
-            },
-            app_name: "App name",
-            app_type: {
-              select: "What type of app are you building?",
-              select_public: "Public: An app built for a wide merchant audience.",
-              select_custom: "Custom: An app custom built for a single client.",
-              selected: "App type {{green:%s}}",
-            },
-            db: {
-              want_select: <<~WANT_SELECT,
-                Would you like to select what database type to use now? (SQLite is the default)
-                If you want to change this in the future, run {{command:rails db:system:change --to=[new_db_type]}}. For more info:
-                {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
-              WANT_SELECT
-              select: "What database type would you like to use? Please ensure the database is installed.",
-              select_sqlite3: "SQLite (default)",
-              select_mysql: "MySQL",
-              select_postgresql: "PostgreSQL",
-              select_oracle: "Oracle",
-              select_frontbase: "FrontBase",
-              select_ibm_db: "IBM_DB",
-              select_sqlserver: "SQL Server",
-              select_jdbcmysql: "JDBC MySQL",
-              select_jdbcsqlite3: "JDBC SQlite",
-              select_jdbcpostgresql: "JDBC PostgreSQL",
-              select_jdbc: "JDBC",
-              selected: "Database Type {{green:%s}}",
-            },
-          },
-        },
-      },
-    }.freeze
-  end
-end

package/assets/cli-ruby/lib/project_types/script/cli.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  class Project < ShopifyCLI::ProjectType
-    hidden_feature(feature_set: :script_project)
-
-    require Project.project_filepath("messages/messages")
-    register_messages(Script::Messages::MESSAGES)
-  end
-
-  # define/autoload project specific Commands
-  class Command < ShopifyCLI::Command::ProjectCommand
-    hidden_feature(feature_set: :script_project)
-    subcommand :Create, "create", Project.project_filepath("commands/create")
-    subcommand :Push, "push", Project.project_filepath("commands/push")
-    subcommand :Connect, "connect", Project.project_filepath("commands/connect")
-    subcommand :Javy, "javy", Project.project_filepath("commands/javy")
-  end
-  ShopifyCLI::Commands.register("Script::Command", "script")
-
-  module Loaders
-    autoload :Project, Script::Project.project_filepath("loaders/project")
-    autoload :SpecificationHandler, Script::Project.project_filepath("loaders/specification_handler")
-  end
-
-  class ScriptProjectError < StandardError; end
-end

package/assets/cli-ruby/lib/project_types/script/commands/connect.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-module Script
-  class Command
-    class Connect < ShopifyCLI::Command::SubCommand
-      hidden_feature
-
-      def call(_args, _)
-        @ctx.abort(@ctx.message("script.deprecated"))
-      end
-
-      def self.help
-        ShopifyCLI::Context.new.message("script.deprecated")
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/script/commands/create.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  class Command
-    class Create < ShopifyCLI::Command::SubCommand
-      hidden_feature
-
-      options do |parser, flags|
-        parser.on("--title=TITLE") { |title| flags[:title] = title }
-        parser.on("--api=API_NAME") { |ep_name| flags[:extension_point] = ep_name }
-        parser.on("--language=LANGUAGE") { |language| flags[:language] = language }
-        parser.on("--branch=BRANCH") { |branch| flags[:branch] = branch }
-      end
-
-      def call(_args, _)
-        @ctx.abort(@ctx.message("script.deprecated"))
-      end
-
-      def self.help
-        ShopifyCLI::Context.new.message("script.deprecated")
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/script/commands/javy.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require "shopify_cli"
-require_relative "../../../../ext/javy/javy.rb"
-
-module Script
-  class Command
-    class Javy < ShopifyCLI::Command::SubCommand
-      hidden_feature
-
-      options do |parser, flags|
-        parser.on("--in=IN") { |in_file| flags[:in_file] = in_file }
-        parser.on("--out=OUT") { |out_file| flags[:out_file] = out_file }
-      end
-
-      def call(_args, _)
-        @ctx.abort(@ctx.message("script.deprecated"))
-      end
-
-      def self.help
-        ShopifyCLI::Context.new.message("script.deprecated")
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/script/commands/push.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  class Command
-    class Push < ShopifyCLI::Command::SubCommand
-      hidden_feature
-
-      options do |parser, flags|
-        parser.on("--force") { |t| flags[:force] = t }
-        parser.on("--api-key=API_KEY") { |api_key| flags[:api_key] = api_key.gsub('"', "") }
-        parser.on("--api-secret=API_SECRET") { |api_secret| flags[:api_secret] = api_secret.gsub('"', "") }
-        parser.on("--uuid=UUID") do |uuid|
-          flags[:uuid] = uuid.gsub('""', "")
-        end
-      end
-
-      def call(_args, _)
-        @ctx.abort(@ctx.message("script.deprecated"))
-      end
-
-      def self.help
-        ShopifyCLI::Context.new.message("script.deprecated")
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/script/loaders/project.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  module Loaders
-    module Project
-      def self.load(directory:, api_key:, uuid:, api_secret:, context: ShopifyCLI::Context.new)
-        env_overrides = {
-          "SHOPIFY_API_KEY" => api_key,
-          "SHOPIFY_API_SECRET" => api_secret,
-          "UUID" => uuid,
-        }.compact
-        env_file_present = env_file_exists?(directory)
-        env = if env_file_present
-          ShopifyCLI::Resources::EnvFile.read(directory, overrides: env_overrides)
-        else
-          ShopifyCLI::Resources::EnvFile.from_hash(env_overrides)
-        end
-
-        project = ShopifyCLI::Project.at(directory)
-        project.env = env
-        project
-      rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
-        handle_error(error, context: context)
-      end
-
-      def self.handle_error(error, context:)
-        if ShopifyCLI::Environment.interactive?
-          properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
-          missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          message = context.message("script.error.missing_env_file_variables", missing_env_variables)
-          message += context.message("script.error.missing_env_file_variables_solution", ShopifyCLI::TOOL_NAME)
-        else
-          properties_hash = { api_key: "--api-key", secret: "--api-secret" }
-          missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
-          message = context.message("script.error.missing_push_options_ci", missing_options)
-          message += context.message("script.error.missing_push_options_ci_solution", ShopifyCLI::TOOL_NAME)
-        end
-        raise ShopifyCLI::Abort, message
-      end
-
-      def self.env_file_exists?(directory)
-        File.exist?(ShopifyCLI::Resources::EnvFile.path(directory))
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/script/loaders/specification_handler.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  module Loaders
-    module SpecificationHandler
-      def self.load(project:, context:)
-        identifier = project.specification_identifier
-        Models::LazySpecificationHandler.new(identifier) do
-          specifications = Models::Specifications.new(
-            fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: context)
-          )
-
-          unless specifications.valid?(identifier)
-            context.abort(context.message("errors.unknown_type", project.specification_identifier))
-          end
-
-          specifications[identifier]
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/script/messages/messages.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  module Messages
-    MESSAGES = {
-      script: {
-        deprecated: "Script projects are no longer supported in CLI 2.0. Please upgrade to CLI 3.0.",
-      },
-    }.freeze
-  end
-end

package/assets/cli-ruby/lib/project_types/theme/cli.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Theme
-  class Project < ShopifyCLI::ProjectType
-    require Project.project_filepath("messages/messages")
-    register_messages(Theme::Messages.all)
-  end
-
-  class Command < ShopifyCLI::Command::ProjectCommand
-    subcommand :Init, "init", Project.project_filepath("commands/init")
-    subcommand :Serve, "serve", Project.project_filepath("commands/serve")
-    subcommand :Pull, "pull", Project.project_filepath("commands/pull")
-    subcommand :Push, "push", Project.project_filepath("commands/push")
-    subcommand :Delete, "delete", Project.project_filepath("commands/delete")
-    subcommand :Publish, "publish", Project.project_filepath("commands/publish")
-    subcommand :Package, "package", Project.project_filepath("commands/package")
-    subcommand :Open, "open", Project.project_filepath("commands/open")
-    subcommand :List, "list", Project.project_filepath("commands/list")
-    subcommand :Share, "share", Project.project_filepath("commands/share")
-    subcommand :Console, "console", Project.project_filepath("commands/console")
-    subcommand :Token, "token", Project.project_filepath("commands/token")
-  end
-  ShopifyCLI::Commands.register("Theme::Command", "theme")
-
-  module Forms
-    autoload :ConfirmStore, Project.project_filepath("forms/confirm_store")
-    autoload :Select, Project.project_filepath("forms/select")
-  end
-
-  module UI
-    autoload :SyncProgressBar, Project.project_filepath("ui/sync_progress_bar")
-  end
-end

package/assets/cli-ruby/lib/project_types/theme/commands/common/root_helper.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-require "project_types/theme/models/specification_handlers/theme"
-
-module Theme
-  class Command
-    module Common
-      module RootHelper
-        def root_value(options, name)
-          argv = default_argv(options)
-          command_index = argv.index(name.to_s)
-
-          return "." if command_index.nil?
-
-          next_index = command_index + 1
-          option_by_key = options_map(options)
-
-          while next_index < argv.size
-            element = argv[next_index]
-            key, value = key_value_tuple(element)
-            option = option_by_key[key]
-
-            return element if option.nil?
-
-            # Skip the option argument
-            next_index += 1 if !option.arg.nil? && !value
-
-            # PATTERN arguments take precedence over the `root`
-            if option.arg =~ /PATTERN/ && !value
-              next_index += 1 while option_argument?(argv, next_index, option_by_key)
-              next
-            end
-
-            next_index += 1
-          end
-
-          "."
-        end
-
-        def valid_theme_directory?(root)
-          Theme::Models::SpecificationHandlers::Theme.new(root).valid? ||
-            current_directory_confirmed?
-        end
-
-        def exist_and_not_empty?(root)
-          Dir.exist?(root) && !Dir[File.join(root, "*")].empty?
-        end
-
-        private
-
-        def current_directory_confirmed?
-          return true if options.flags[:force]
-
-          @ctx.warn(@ctx.message("theme.current_directory_is_not_theme_directory"))
-          Forms::ConfirmStore.ask(
-            @ctx,
-            [],
-            title: @ctx.message("theme.confirm_current_directory"),
-            force: !ShopifyCLI::Environment.interactive?,
-          ).confirmed?
-        end
-
-        def default_argv(options)
-          options.parser.default_argv.compact
-        end
-
-        def options_map(options)
-          map = {}
-          options_list(options).each do |option|
-            map[option.short.first] = option
-            map[option.long.first] = option
-          end
-          map
-        end
-
-        def options_list(options)
-          options.parser.top.list
-        end
-
-        def option_argument?(argv, next_index, option_by_key)
-          return false unless next_index < argv.size
-
-          element = argv[next_index]
-          key, _value = key_value_tuple(element)
-          option_by_key[key].nil?
-        end
-
-        def key_value_tuple(element)
-          element.split("=")
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/theme/commands/common/shop_helper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Theme
-  class Command
-    module Common
-      module ShopHelper
-        def shop
-          ShopifyCLI::Theme::ThemeAdminAPI.new(@ctx).get_shop_or_abort
-        end
-      end
-    end
-  end
-end

package/assets/cli-ruby/lib/project_types/theme/commands/console.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require "shopify_cli/theme/repl"
-
-module Theme
-  class Command
-    class Console < ShopifyCLI::Command::SubCommand
-      options do |parser, flags|
-        parser.on("--url=URL") { |url| flags[:url] = url }
-        parser.on("--port=PORT") { |port| flags[:port] = port }
-        parser.on("--theme=THEME") { |theme| flags[:theme] = theme }
-      end
-
-      def call(_args, _name)
-        url = options.flags[:url]
-        port = options.flags[:port]
-        theme = options.flags[:theme]
-
-        ShopifyCLI::Theme::Repl.new(@ctx, url, port, theme).run
-      end
-    end
-  end
-end