shopify-cli 1.14.0 → 2.0.0

data/lib/project_types/rails/cli.rb

@@ -1,33 +1,21 @@
 # frozen_string_literal: true
 module Rails
   class Project < ShopifyCli::ProjectType
-    title("Ruby on Rails App")
-    creator("Rails::Commands::Create")
-    connector("Rails::Commands::Connect")
-
-    register_command("Rails::Commands::Deploy", "deploy")
-    register_command("Rails::Commands::Generate", "generate")
-    register_command("Rails::Commands::Open", "open")
-    register_command("Rails::Commands::Populate", "populate")
-    register_command("Rails::Commands::Serve", "serve")
-    register_command("Rails::Commands::Tunnel", "tunnel")
-    # register_task('Rails::Tasks::RailsTask', 'rails_task')
-
     require Project.project_filepath("messages/messages")
     register_messages(Rails::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
-  module Commands
-    autoload :Connect, Project.project_filepath("commands/connect")
-    autoload :Create, Project.project_filepath("commands/create")
-    autoload :Deploy, Project.project_filepath("commands/deploy")
-    autoload :Generate, Project.project_filepath("commands/generate")
-    autoload :Open, Project.project_filepath("commands/open")
-    autoload :Populate, Project.project_filepath("commands/populate")
-    autoload :Serve, Project.project_filepath("commands/serve")
-    autoload :Tunnel, Project.project_filepath("commands/tunnel")
+  class Command < ShopifyCli::ProjectCommands
+    subcommand :Connect, "connect", Project.project_filepath("commands/connect")
+    subcommand :Create, "create", Project.project_filepath("commands/create")
+    subcommand :Deploy, "deploy", Project.project_filepath("commands/deploy")
+    subcommand :Generate, "generate", Project.project_filepath("commands/generate")
+    subcommand :Open, "open", Project.project_filepath("commands/open")
+    subcommand :Serve, "serve", Project.project_filepath("commands/serve")
+    subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
   end
+  ShopifyCli::Commands.register("Rails::Command", "rails")
 
   # define/autoload project specific Tasks
   module Tasks

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

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 module Rails
-  module Commands
+  class Command
     class Connect < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :rails
+
       def call(*)
         if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
           @ctx.puts(@ctx.message("rails.connect.production_warning"))
         end
 
-        app = ShopifyCli::Commands::Connect.new.default_connect("rails")
+        app = ShopifyCli::Connect.new(@ctx).default_connect("rails")
         @ctx.done(@ctx.message("rails.connect.connected", app))
       end
+
+      def self.help
+        ShopifyCli::Context.message("rails.connect.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
     end
   end
 end

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 module Rails
-  module Commands
+  class Command
     class Create < ShopifyCli::SubCommand
+      prerequisite_task :ensure_authenticated
+
       USER_AGENT_CODE = <<~USERAGENT
         module ShopifyAPI
           class Base < ActiveResource::Base
-            self.headers['User-Agent'] << " | ShopifyApp/\#{ShopifyApp::VERSION} | Shopify App CLI"
+            self.headers['User-Agent'] << " | ShopifyApp/\#{ShopifyApp::VERSION} | Shopify CLI"
           end
         end
       USERAGENT
@@ -16,11 +18,13 @@ module Rails
         # backwards compatibility allow 'title' for now
         parser.on("--title=TITLE") { |t| flags[:title] = t }
         parser.on("--name=NAME") { |t| flags[:title] = t }
-        parser.on("--organization_id=ID") { |url| flags[:organization_id] = url }
-        parser.on("--organization-id=ID") { |url| flags[:organization_id] = url }
+        parser.on("--organization_id=ID") { |id| flags[:organization_id] = id }
+        parser.on("--organization-id=ID") { |id| flags[:organization_id] = id }
+        parser.on("--store=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
+        # backwards compatibility allow 'shop domain' for now
         parser.on("--shop_domain=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
         parser.on("--shop-domain=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
-        parser.on("--type=APPTYPE") { |url| flags[:type] = url }
+        parser.on("--type=APPTYPE") { |type| flags[:type] = type }
         parser.on("--db=DB") { |db| flags[:db] = db }
         parser.on("--rails_opts=RAILSOPTS") { |opts| flags[:rails_opts] = opts }
         parser.on("--rails-opts=RAILSOPTS") { |opts| flags[:rails_opts] = opts }
@@ -62,7 +66,7 @@ module Rails
         partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"], local_debug?)
 
         @ctx.puts(@ctx.message("apps.create.info.created", form.title, partners_url))
-        @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCli::TOOL_NAME))
+        @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCli::TOOL_NAME, "rails"))
         unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
           @ctx.puts(@ctx.message("apps.create.info.install", partners_url, form.title))
         end

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

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

data/lib/project_types/rails/commands/deploy/heroku.rb

@@ -2,109 +2,111 @@
 require "shopify_cli"
 
 module Rails
-  module Commands
+  class Command
     class Deploy
-      class Heroku < ShopifyCli::SubCommand
-        DB_CHECK_CMD = 'bundle exec rails runner "puts ActiveRecord::Base.connection.adapter_name.downcase"'
+      class Heroku
+        class << self
+          DB_CHECK_CMD = 'bundle exec rails runner "puts ActiveRecord::Base.connection.adapter_name.downcase"'
 
-        def self.help
-          ShopifyCli::Context.message("rails.deploy.heroku.help", ShopifyCli::TOOL_NAME)
-        end
-
-        def call(*)
-          CLI::UI::Frame.open(@ctx.message("rails.deploy.heroku.db_check.validating")) do
-            CLI::UI::Spinner.spin(@ctx.message("rails.deploy.heroku.db_check.checking")) do |spinner|
-              db_type, err = check_db(@ctx)
-              @ctx.abort(@ctx.message(err)) unless err.nil?
-              spinner.update_title(@ctx.message("rails.deploy.heroku.db_check.validated", db_type))
-            end
-            true
+          def help
+            ShopifyCli::Context.message("rails.deploy.heroku.help", ShopifyCli::TOOL_NAME)
           end
 
-          spin_group = CLI::UI::SpinGroup.new
-          heroku_service = ShopifyCli::Heroku.new(@ctx)
+          def start(ctx)
+            CLI::UI::Frame.open(ctx.message("rails.deploy.heroku.db_check.validating")) do
+              CLI::UI::Spinner.spin(ctx.message("rails.deploy.heroku.db_check.checking")) do |spinner|
+                db_type, err = check_db(ctx)
+                ctx.abort(ctx.message(err)) unless err.nil?
+                spinner.update_title(ctx.message("rails.deploy.heroku.db_check.validated", db_type))
+              end
+              true
+            end
 
-          spin_group.add(@ctx.message("rails.deploy.heroku.downloading")) do |spinner|
-            heroku_service.download
-            spinner.update_title(@ctx.message("rails.deploy.heroku.downloaded"))
-          end
-          spin_group.wait
+            spin_group = CLI::UI::SpinGroup.new
+            heroku_service = ShopifyCli::Heroku.new(ctx)
 
-          spin_group.add(@ctx.message("rails.deploy.heroku.installing")) do |spinner|
-            heroku_service.install
-            spinner.update_title(@ctx.message("rails.deploy.heroku.installed"))
-          end
-          spin_group.add(@ctx.message("rails.deploy.heroku.git.checking")) do |spinner|
-            ShopifyCli::Git.init(@ctx)
-            spinner.update_title(@ctx.message("rails.deploy.heroku.git.initialized"))
-          end
-          spin_group.wait
-
-          if (account = heroku_service.whoami)
-            @ctx.puts(@ctx.message("rails.deploy.heroku.authenticated_with_account", account))
-          else
-            CLI::UI::Frame.open(
-              @ctx.message("rails.deploy.heroku.authenticating"),
-              success_text: @ctx.message("rails.deploy.heroku.authenticated")
-            ) do
-              heroku_service.authenticate
+            spin_group.add(ctx.message("rails.deploy.heroku.downloading")) do |spinner|
+              heroku_service.download
+              spinner.update_title(ctx.message("rails.deploy.heroku.downloaded"))
             end
-          end
+            spin_group.wait
 
-          if (app_name = heroku_service.app)
-            @ctx.puts(@ctx.message("rails.deploy.heroku.app.selected", app_name))
-          else
-            app_type = CLI::UI::Prompt.ask(@ctx.message("rails.deploy.heroku.app.no_apps_found")) do |handler|
-              handler.option(@ctx.message("rails.deploy.heroku.app.create")) { :new }
-              handler.option(@ctx.message("rails.deploy.heroku.app.select")) { :existing }
+            spin_group.add(ctx.message("rails.deploy.heroku.installing")) do |spinner|
+              heroku_service.install
+              spinner.update_title(ctx.message("rails.deploy.heroku.installed"))
+            end
+            spin_group.add(ctx.message("rails.deploy.heroku.git.checking")) do |spinner|
+              ShopifyCli::Git.init(ctx)
+              spinner.update_title(ctx.message("rails.deploy.heroku.git.initialized"))
             end
+            spin_group.wait
 
-            if app_type == :existing
-              app_name = CLI::UI::Prompt.ask(@ctx.message("rails.deploy.heroku.app.name"))
+            if (account = heroku_service.whoami)
+              ctx.puts(ctx.message("rails.deploy.heroku.authenticated_with_account", account))
+            else
               CLI::UI::Frame.open(
-                @ctx.message("rails.deploy.heroku.app.selecting", app_name),
-                success_text: @ctx.message("rails.deploy.heroku.app.selected", app_name)
+                ctx.message("rails.deploy.heroku.authenticating"),
+                success_text: ctx.message("rails.deploy.heroku.authenticated")
               ) do
-                heroku_service.select_existing_app(app_name)
+                heroku_service.authenticate
               end
-            elsif app_type == :new
-              CLI::UI::Frame.open(
-                @ctx.message("rails.deploy.heroku.app.creating"),
-                success_text: @ctx.message("rails.deploy.heroku.app.created")
-              ) do
-                heroku_service.create_new_app
+            end
+
+            if (app_name = heroku_service.app)
+              ctx.puts(ctx.message("rails.deploy.heroku.app.selected", app_name))
+            else
+              app_type = CLI::UI::Prompt.ask(ctx.message("rails.deploy.heroku.app.no_apps_found")) do |handler|
+                handler.option(ctx.message("rails.deploy.heroku.app.create")) { :new }
+                handler.option(ctx.message("rails.deploy.heroku.app.select")) { :existing }
+              end
+
+              if app_type == :existing
+                app_name = CLI::UI::Prompt.ask(ctx.message("rails.deploy.heroku.app.name"))
+                CLI::UI::Frame.open(
+                  ctx.message("rails.deploy.heroku.app.selecting", app_name),
+                  success_text: ctx.message("rails.deploy.heroku.app.selected", app_name)
+                ) do
+                  heroku_service.select_existing_app(app_name)
+                end
+              elsif app_type == :new
+                CLI::UI::Frame.open(
+                  ctx.message("rails.deploy.heroku.app.creating"),
+                  success_text: ctx.message("rails.deploy.heroku.app.created")
+                ) do
+                  heroku_service.create_new_app
+                end
               end
             end
-          end
 
-          branches = ShopifyCli::Git.branches(@ctx)
-          if branches.length == 1
-            branch_to_deploy = branches[0]
-            @ctx.puts(@ctx.message("rails.deploy.heroku.git.branch_selected", branch_to_deploy))
-          else
-            branch_to_deploy = CLI::UI::Prompt.ask(@ctx.message("rails.deploy.heroku.git.what_branch")) do |handler|
-              branches.each do |branch|
-                handler.option(branch) { branch }
+            branches = ShopifyCli::Git.branches(ctx)
+            if branches.length == 1
+              branch_to_deploy = branches[0]
+              ctx.puts(ctx.message("rails.deploy.heroku.git.branch_selected", branch_to_deploy))
+            else
+              branch_to_deploy = CLI::UI::Prompt.ask(ctx.message("rails.deploy.heroku.git.what_branch")) do |handler|
+                branches.each do |branch|
+                  handler.option(branch) { branch }
+                end
               end
             end
-          end
 
-          CLI::UI::Frame.open(
-            @ctx.message("rails.deploy.heroku.deploying"),
-            success_text: @ctx.message("rails.deploy.heroku.deployed")
-          ) do
-            heroku_service.deploy(branch_to_deploy)
+            CLI::UI::Frame.open(
+              ctx.message("rails.deploy.heroku.deploying"),
+              success_text: ctx.message("rails.deploy.heroku.deployed")
+            ) do
+              heroku_service.deploy(branch_to_deploy)
+            end
           end
-        end
 
-        def check_db(ctx)
-          out, stat = ctx.capture2e(DB_CHECK_CMD)
-          if stat.success? && out.strip == "sqlite"
-            ["sqlite", "rails.deploy.heroku.db_check.sqlite"]
-          elsif !stat.success?
-            [nil, "rails.deploy.heroku.db_check.problem"]
-          else
-            [out.strip, nil]
+          def check_db(ctx)
+            out, stat = ctx.capture2e(DB_CHECK_CMD)
+            if stat.success? && out.strip == "sqlite"
+              ["sqlite", "rails.deploy.heroku.db_check.sqlite"]
+            elsif !stat.success?
+              [nil, "rails.deploy.heroku.db_check.problem"]
+            else
+              [out.strip, nil]
+            end
           end
         end
       end

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|