shopify-cli 1.13.1 → 2.1.0

data/lib/project_types/rails/commands/generate.rb

@@ -2,12 +2,22 @@
 require "shopify_cli"
 
 module Rails
-  module Commands
-    class Generate < ShopifyCli::Command
-      subcommand :Webhook, "webhook", Project.project_filepath("commands/generate/webhook")
+  class Command
+    class Generate < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :rails
 
-      def call(*)
-        @ctx.puts(self.class.help)
+      autoload :Webhook, Project.project_filepath("commands/generate/webhook")
+
+      WEBHOOK = "webhook"
+
+      def call(args, _name)
+        subcommand = args.shift
+        case subcommand
+        when WEBHOOK
+          Rails::Command::Generate::Webhook.start(@ctx, args)
+        else
+          @ctx.puts(self.class.help)
+        end
       end
 
       def self.help

data/lib/project_types/rails/commands/generate/webhook.rb

@@ -1,38 +1,40 @@
 require "shopify_cli"
 require "json"
 module Rails
-  module Commands
+  class Command
     class Generate
-      class Webhook < ShopifyCli::SubCommand
-        def call(args, _name)
-          selected_type = args.first
-          schema = ShopifyCli::AdminAPI::Schema.get(@ctx)
-          webhooks = schema.get_names_from_type("WebhookSubscriptionTopic")
-          unless selected_type && webhooks.include?(selected_type)
-            selected_type = CLI::UI::Prompt.ask(@ctx.message("rails.generate.webhook.select")) do |handler|
-              webhooks.each do |type|
-                handler.option(type) { type }
+      class Webhook
+        class << self
+          def start(ctx, args)
+            selected_type = args.first
+            schema = ShopifyCli::AdminAPI::Schema.get(ctx)
+            webhooks = schema.get_names_from_type("WebhookSubscriptionTopic")
+            unless selected_type && webhooks.include?(selected_type)
+              selected_type = CLI::UI::Prompt.ask(ctx.message("rails.generate.webhook.select")) do |handler|
+                webhooks.each do |type|
+                  handler.option(type) { type }
+                end
               end
             end
+            spin_group = CLI::UI::SpinGroup.new
+            spin_group.add(ctx.message("rails.generate.webhook.selected", selected_type)) do |spinner|
+              Rails::Command::Generate.run_generate(generate_command(selected_type, ctx), selected_type, ctx)
+              spinner.update_title("{{green:#{selected_type}}} config/initializers/shopify_app.rb")
+            end
+            spin_group.wait
           end
-          spin_group = CLI::UI::SpinGroup.new
-          spin_group.add(@ctx.message("rails.generate.webhook.selected", selected_type)) do |spinner|
-            Rails::Commands::Generate.run_generate(generate_command(selected_type), selected_type, @ctx)
-            spinner.update_title("{{green:#{selected_type}}} config/initializers/shopify_app.rb")
-          end
-          spin_group.wait
-        end
 
-        def self.help
-          ShopifyCli::Context.message("rails.generate.webhook.help", ShopifyCli::TOOL_NAME)
-        end
+          def help
+            ShopifyCli::Context.message("rails.generate.webhook.help", ShopifyCli::TOOL_NAME)
+          end
 
-        def generate_command(selected_type)
-          parts = selected_type.downcase.split("_")
-          host = ShopifyCli::Project.current.env.host
-          selected_type = parts[0..-2].join("_") + "/" + parts[-1]
-          command = @ctx.windows? ? "ruby bin\\rails" : "bin/rails"
-          "#{command} g shopify_app:add_webhook -t #{selected_type} -a #{host}/webhooks/#{selected_type.downcase}"
+          def generate_command(selected_type, ctx)
+            parts = selected_type.downcase.split("_")
+            host = ShopifyCli::Project.current.env.host
+            selected_type = parts[0..-2].join("_") + "/" + parts[-1]
+            command = ctx.windows? ? "ruby bin\\rails" : "bin/rails"
+            "#{command} g shopify_app:add_webhook -t #{selected_type} -a #{host}/webhooks/#{selected_type.downcase}"
+          end
         end
       end
     end

data/lib/project_types/rails/commands/open.rb

@@ -1,8 +1,10 @@
 require "shopify_cli"
 
 module Rails
-  module Commands
-    class Open < ShopifyCli::Command
+  class Command
+    class Open < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :rails
+
       def call(*)
         project = ShopifyCli::Project.current
         @ctx.open_url!("#{project.env.host}/login?shop=#{project.env.shop}")

data/lib/project_types/rails/commands/serve.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 module Rails
-  module Commands
-    class Serve < ShopifyCli::Command
+  class Command
+    class Serve < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :rails
       prerequisite_task :ensure_env, :ensure_dev_store
 
       options do |parser, flags|

data/lib/project_types/rails/commands/tunnel.rb

@@ -3,10 +3,12 @@
 require "shopify_cli"
 
 module Rails
-  module Commands
-    class Tunnel < ShopifyCli::Command
+  class Command
+    class Tunnel < ShopifyCli::SubCommand
       # subcommands :auth, :start, :stop
 
+      prerequisite_task ensure_project_type: :rails
+
       def call(args, _name)
         subcommand = args.shift
         case subcommand

data/lib/project_types/rails/messages/messages.rb

@@ -4,6 +4,11 @@ module Rails
   module Messages
     MESSAGES = {
       rails: {
+        help: <<~HELP,
+          Suite of commands for developing Ruby on Rails apps. See {{command:%1$s rails <command> --help}} for usage of each command.
+            Usage: {{command:%1$s rails [ %2$s ]}}
+        HELP
+
         error: {
           generic: "Error",
         },
@@ -12,37 +17,36 @@ module Rails
           checking_installation_path: "Checking path %s for gem %s",
           installed: "Installed %s gem",
           installed_debug: "%s installed: %s",
-          installing: "Installing %s gem...",
+          installing: "Installing %s gem…",
           setting_gem_home: "GEM_HOME being set to %s",
           setting_gem_path: "GEM_PATH being set to %s",
         },
 
         connect: {
           connected: "Project now connected to {{green:%s}}",
+          help: <<~HELP,
+            {{command:%s rails connect}}: Connects an existing Ruby on Rails app to Shopify CLI. Creates a config file.
+              Usage: {{command:%s rails connect}}
+          HELP
           production_warning: <<~MESSAGE,
-          {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
+            {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
           MESSAGE
         },
 
         create: {
           help: <<~HELP,
-          {{command:%s create rails}}: Creates a ruby on rails app.
-            Usage: {{command:%s create rails}}
-            Options:
-              {{command:--name=NAME}} App name. Any string.
-              {{command:--app-url=APPURL}} App URL. Must be a valid URL.
-              {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
-              {{command:--shop-domain=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
-              {{command:--db=DB}} Database type. Must be one of: mysql, postgresql, sqlite3, oracle, frontbase, ibm_db, sqlserver, jdbcmysql, jdbcsqlite3, jdbcpostgresql, jdbc.
-              {{command:--rails-opts=RAILSOPTS}} Additional options. Must be string containing one or more valid Rails options, separated by spaces.
+            {{command:%s rails create}}: Creates a ruby on rails app.
+              Usage: {{command:%s rails create}}
+              Options:
+                {{command:--name=NAME}} App name. Any string.
+                {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
+                {{command:--store=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
+                {{command:--db=DB}} Database type. Must be one of: mysql, postgresql, sqlite3, oracle, frontbase, ibm_db, sqlserver, jdbcmysql, jdbcsqlite3, jdbcpostgresql, jdbc.
+                {{command:--rails-opts=RAILSOPTS}} Additional options. Must be string containing one or more valid Rails options, separated by spaces.
           HELP
 
           error: {
-            invalid_ruby_version: <<~MSG,
-            This project requires a Ruby version ~> 2.5 or Ruby 3.0
-            See {{underline:https://github.com/Shopify/shopify-app-cli/blob/master/docs/installing-ruby.md}}
-            for our recommended method of installing ruby.
-            MSG
+            invalid_ruby_version: "This project requires a Ruby version ~> 2.5 or Ruby 3.0.",
             dir_exists: "Project directory %s already exists. Please use a different name.",
             install_failure: "Error installing %s gem",
             node_required: "node is required to create a rails project. Download at https://nodejs.org/en/download.",
@@ -58,55 +62,55 @@ module Rails
             open_new_shell: "{{*}} {{yellow:After installing %s, please open a new Command Prompt or PowerShell " \
               "window to continue.}}",
           },
-          installing_bundler: "Installing bundler...",
-          generating_app: "Generating new rails app project in %s...",
-          adding_shopify_gem: "{{v}} Adding shopify_app gem...",
+          installing_bundler: "Installing bundler…",
+          generating_app: "Generating new rails app project in %s…",
+          adding_shopify_gem: "{{v}} Adding shopify_app gem…",
           node_version: "node %s",
           yarn_version: "yarn %s",
-          running_bundle_install: "Running bundle install...",
-          running_generator: "Running shopify_app generator...",
-          running_migrations: "Running migrations...",
-          running_webpacker_install: "Running webpacker:install...",
+          running_bundle_install: "Running bundle install…",
+          running_generator: "Running shopify_app generator…",
+          running_migrations: "Running migrations…",
+          running_webpacker_install: "Running webpacker:install…",
         },
 
         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 deploy [ heroku ]}}
+            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 rails deploy [ heroku ]}}
           HELP
           extended_help: <<~HELP,
-          {{bold:Subcommands:}}
-            {{cyan:heroku}}: Deploys the current Rails project to Heroku.
-              Usage: {{command:%s deploy heroku}}
+            {{bold:Subcommands:}}
+              {{cyan:heroku}}: Deploys the current Rails project to Heroku.
+                Usage: {{command:%s rails deploy heroku}}
           HELP
 
           heroku: {
             help: <<~HELP,
-            Deploy the current Rails project to Heroku
-            Usage: {{command:%s deploy heroku}}
+              Deploy the current Rails project to Heroku
+              Usage: {{command:%s rails deploy heroku}}
             HELP
-            downloading: "Downloading Heroku CLI...",
+            downloading: "Downloading Heroku CLI…",
             downloaded: "Downloaded Heroku CLI",
-            installing: "Installing Heroku CLI...",
+            installing: "Installing Heroku CLI…",
             installed: "Installed Heroku CLI",
             authenticated_with_account: "{{v}} Authenticated with Heroku as {{green:%s}}",
-            authenticating: "Authenticating with Heroku...",
+            authenticating: "Authenticating with Heroku…",
             authenticated: "{{v}} Authenticated with Heroku",
-            deploying: "Deploying to Heroku...",
+            deploying: "Deploying to Heroku…",
             deployed: "{{v}} Deployed to Heroku",
             db_check: {
-              validating: "Validating application...",
-              checking: "Checking database type...",
+              validating: "Validating application…",
+              checking: "Checking database type…",
               validated: "Database type \"%s\" validated for platform \"Heroku\"",
               problem: "A problem was encountered while checking your database type.",
               sqlite: <<~SQLITE,
-              Heroku does not support deployment using the SQLite database system.
-              Change the database type using {{command:rails db:system:change --to=[new_db_type]}}. For more info:
-              {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
+                Heroku does not support deployment using the SQLite database system.
+                Change the database type using {{command:rails db:system:change --to=[new_db_type]}}. For more info:
+                {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
               SQLITE
             },
             git: {
-              checking: "Checking git repo...",
+              checking: "Checking git repo…",
               initialized: "Git repo initialized",
               what_branch: "What branch would you like to deploy?",
               branch_selected: "{{v}} Git branch {{green:%s}} selected for deploy",
@@ -115,10 +119,10 @@ module Rails
               no_apps_found: "No existing Heroku app found. What would you like to do?",
               name: "What is your Heroku app’s name?",
               select: "Specify an existing Heroku app",
-              selecting: "Selecting Heroku app %s...",
+              selecting: "Selecting Heroku app %s…",
               selected: "{{v}} Heroku app {{green:%s}} selected",
               create: "Create a new Heroku app",
-              creating: "Creating new Heroku app...",
+              creating: "Creating new Heroku app…",
               created: "{{v}} New Heroku app created",
             },
           },
@@ -126,13 +130,13 @@ module Rails
 
         generate: {
           help: <<~HELP,
-          Generate code in your Rails project. Currently supports generating new webhooks.
-            Usage: {{command:%s generate [ webhook ]}}
+            Generate code in your Rails project. Currently supports generating new webhooks.
+              Usage: {{command:%s 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.
+            {{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: {
@@ -142,8 +146,8 @@ module Rails
 
           webhook: {
             help: <<~HELP,
-            Generate and register a new webhook that listens for the specified Shopify store event.
-              Usage: {{command:%s generate webhook <type>}}
+              Generate and register a new webhook that listens for the specified Shopify store event.
+                Usage: {{command:%s rails generate webhook <type>}}
             HELP
 
             select: "What type of webhook would you like to create?",
@@ -153,70 +157,19 @@ module Rails
 
         open: {
           help: <<~HELP,
-          Open your local development app in the default browser.
-            Usage: {{command:%s open}}
-          HELP
-        },
-
-        populate: {
-          help: <<~HELP,
-          Populate your Shopify development store with example customers, orders, or products.
-            Usage: {{command:%s populate [ customers | draftorders | products ]}}
+            Open your local development app in the default browser.
+              Usage: {{command:%s rails open}}
           HELP
-          extended_help: <<~HELP,
-          {{bold:Subcommands:}}
-
-            {{cyan:customers [options]}}: Add dummy customers to the specified development store.
-              Usage: {{command:%1$s populate customers}}
-
-            {{cyan:draftorders [options]}}: Add dummy orders to the specified development store.
-              Usage: {{command:%1$s populate draftorders}}
-
-            {{cyan:products [options]}}: Add dummy products to the specified development store.
-              Usage: {{command:%1$s populate products}}
-
-          {{bold:Options:}}
-
-            {{cyan:--count [integer]}}: The number of dummy items to populate. Defaults to 5.
-            {{cyan:--silent}}: Silence the populate output.
-            {{cyan:--help}}: Display more options specific to each subcommand.
-
-          {{bold:Examples:}}
-
-            {{command:%1$s populate products}}
-              Populate your development store with 5 additional products.
-
-            {{command:%1$s populate customers --count 30}}
-              Populate your development store with 30 additional customers.
-
-            {{command:%1$s populate draftorders}}
-              Populate your development store with 5 additional orders.
-
-            {{command:%1$s populate products --help}}
-              Display the list of options available to customize the {{command:%1$s populate products}} command.
-          HELP
-
-          customer: {
-            added: "%s added to {{green:%s}} at {{underline:%scustomers/%d}}",
-          },
-
-          draft_order: {
-            added: "DraftOrder added to {{green:%s}} at {{underline:%sdraft_orders/%d}}",
-          },
-
-          product: {
-            added: "%s added to {{green:%s}} at {{underline:%sproducts/%d}}",
-          },
         },
 
         serve: {
           help: <<~HELP,
-          Start a local development rails server for your project, as well as a public ngrok tunnel to your localhost.
-            Usage: {{command:%s serve}}
+            Start a local development rails server for your project, as well as a public ngrok tunnel to your localhost.
+              Usage: {{command:%s rails serve}}
           HELP
           extended_help: <<~HELP,
-          {{bold:Options:}}
-            {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+            {{bold:Options:}}
+              {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
           HELP
 
           error: {
@@ -227,25 +180,25 @@ module Rails
             {{*}} To install and start using your app, open this URL in your browser:
             {{green:%s}}
           MESSAGE
-          running_server: "Running server...",
+          running_server: "Running server…",
         },
 
         tunnel: {
           help: <<~HELP,
-          Start or stop an http tunnel to your local development app using ngrok.
-            Usage: {{command:%s tunnel [ auth | start | stop ]}}
+            Start or stop an http tunnel to your local development app using ngrok.
+              Usage: {{command:%s rails tunnel [ auth | start | stop ]}}
           HELP
           extended_help: <<~HELP,
-          {{bold:Subcommands:}}
+            {{bold:Subcommands:}}
 
-            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. Visit https://dashboard.ngrok.com/signup to sign up.
-              Usage: {{command:%1$s tunnel auth <token>}}
+              {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. Visit https://dashboard.ngrok.com/signup to sign up.
+                Usage: {{command:%1$s rails tunnel auth <token>}}
 
-            {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
-              Usage: {{command:%1$s tunnel start}}
+              {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
+                Usage: {{command:%1$s rails tunnel start}}
 
-            {{cyan:stop}}: Stops the ngrok tunnel.
-              Usage: {{command:%1$s tunnel stop}}
+              {{cyan:stop}}: Stops the ngrok tunnel.
+                Usage: {{command:%1$s rails tunnel stop}}
 
           HELP
 
@@ -270,9 +223,9 @@ module Rails
             },
             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}}
+                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)",

data/lib/project_types/script/cli.rb

@@ -3,20 +3,18 @@
 module Script
   class Project < ShopifyCli::ProjectType
     hidden_feature(feature_set: :script_project)
-    title("Script")
-    creator("Script::Commands::Create")
-
-    register_command("Script::Commands::Push", "push")
 
     require Project.project_filepath("messages/messages")
     register_messages(Script::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
-  module Commands
-    autoload :Create, Project.project_filepath("commands/create")
-    autoload :Push, Project.project_filepath("commands/push")
+  class Command < ShopifyCli::ProjectCommands
+    hidden_feature(feature_set: :script_project)
+    subcommand :Create, "create", Project.project_filepath("commands/create")
+    subcommand :Push, "push", Project.project_filepath("commands/push")
   end
+  ShopifyCli::Commands.register("Script::Command", "script")
 
   # define/autoload project specific Forms
   module Forms
@@ -39,10 +37,10 @@ module Script
 
     module Domain
       autoload :Errors, Project.project_filepath("layers/domain/errors")
-      autoload :ConfigUi, Project.project_filepath("layers/domain/config_ui")
       autoload :PushPackage, Project.project_filepath("layers/domain/push_package")
       autoload :Metadata, Project.project_filepath("layers/domain/metadata")
       autoload :ExtensionPoint, Project.project_filepath("layers/domain/extension_point")
+      autoload :ScriptJson, Project.project_filepath("layers/domain/script_json")
       autoload :ScriptProject, Project.project_filepath("layers/domain/script_project")
     end