shopify-cli 1.3.1 → 1.7.0

data/lib/project_types/rails/cli.rb

@@ -1,29 +1,32 @@
 # frozen_string_literal: true
 module Rails
   class Project < ShopifyCli::ProjectType
-    creator 'Ruby on Rails App', 'Rails::Commands::Create'
+    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_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')
+    require Project.project_filepath("messages/messages")
     register_messages(Rails::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
   module Commands
-    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')
+    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")
   end
 
   # define/autoload project specific Tasks
@@ -32,9 +35,9 @@ module Rails
 
   # define/autoload project specific Forms
   module Forms
-    autoload :Create, Project.project_filepath('forms/create')
+    autoload :Create, Project.project_filepath("forms/create")
   end
 
-  autoload :Ruby, Project.project_filepath('ruby')
-  autoload :Gem, Project.project_filepath('gem')
+  autoload :Ruby, Project.project_filepath("ruby")
+  autoload :Gem, Project.project_filepath("gem")
 end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Rails
+  module Commands
+    class Connect < ShopifyCli::SubCommand
+      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")
+        @ctx.done(@ctx.message("rails.connect.connected", app))
+      end
+    end
+  end
+end

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

@@ -14,21 +14,25 @@ module Rails
 
       options do |parser, flags|
         # 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('--shop_domain=MYSHOPIFYDOMAIN') { |url| flags[:shop_domain] = url }
-        parser.on('--type=APPTYPE') { |url| flags[:type] = url }
-        parser.on('--db=DB') { |db| flags[:db] = db }
-        parser.on('--rails_opts=RAILSOPTS') { |opts| flags[:rails_opts] = opts }
+        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("--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("--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 }
       end
 
       def call(args, _name)
         form = Forms::Create.ask(@ctx, args, options.flags)
         return @ctx.puts(self.class.help) if form.nil?
 
-        @ctx.abort(@ctx.message('rails.create.error.invalid_ruby_version')) unless
-          Ruby.version(@ctx).satisfies?('~>2.5')
+        ruby_version = Ruby.version(@ctx)
+        @ctx.abort(@ctx.message("rails.create.error.invalid_ruby_version")) unless
+          ruby_version.satisfies?("~>2.5") || ruby_version.satisfies?("~>3.0.0")
 
         check_node
         check_yarn
@@ -37,7 +41,7 @@ module Rails
         set_custom_ua
         ShopifyCli::Project.write(
           @ctx,
-          project_type: 'rails',
+          project_type: "rails",
           organization_id: form.organization_id,
         )
 
@@ -52,72 +56,74 @@ module Rails
           api_key: api_client["apiKey"],
           secret: api_client["apiSecretKeys"].first["secret"],
           shop: form.shop_domain,
-          scopes: 'write_products,write_customers,write_draft_orders',
+          scopes: "write_products,write_customers,write_draft_orders",
         ).write(@ctx)
 
-        partners_url = "https://partners.shopify.com/#{form.organization_id}/apps/#{api_client['id']}"
+        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"], local_debug?)
 
-        @ctx.puts(@ctx.message('rails.create.info.created', form.title, partners_url))
-        @ctx.puts(@ctx.message('rails.create.info.serve', form.name, ShopifyCli::TOOL_NAME))
-        @ctx.puts(@ctx.message('rails.create.info.install', partners_url, form.title))
+        @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))
+        unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
+          @ctx.puts(@ctx.message("apps.create.info.install", partners_url, form.title))
+        end
       end
 
       def self.help
-        ShopifyCli::Context.message('rails.create.help', ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("rails.create.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
       end
 
       private
 
       def check_node
-        cmd_path = @ctx.which('node')
+        cmd_path = @ctx.which("node")
         if cmd_path.nil?
-          @ctx.abort(@ctx.message('rails.create.error.node_required')) unless @ctx.windows?
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.node_required') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'node'))
+          @ctx.abort(@ctx.message("rails.create.error.node_required")) unless @ctx.windows?
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.node_required") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "node"))
           raise ShopifyCli::AbortSilent
         end
 
-        version, stat = @ctx.capture2e('node', '-v')
+        version, stat = @ctx.capture2e("node", "-v")
         unless stat.success?
-          @ctx.abort(@ctx.message('rails.create.error.node_version_failure')) unless @ctx.windows?
+          @ctx.abort(@ctx.message("rails.create.error.node_version_failure")) unless @ctx.windows?
           # execution stops above if not Windows
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.node_version_failure') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'node'))
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.node_version_failure") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "node"))
           raise ShopifyCli::AbortSilent
         end
 
-        @ctx.done(@ctx.message('rails.create.node_version', version))
+        @ctx.done(@ctx.message("rails.create.node_version", version))
       end
 
       def check_yarn
-        cmd_path = @ctx.which('yarn')
+        cmd_path = @ctx.which("yarn")
         if cmd_path.nil?
-          @ctx.abort(@ctx.message('rails.create.error.yarn_required')) unless @ctx.windows?
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.yarn_required') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'yarn'))
+          @ctx.abort(@ctx.message("rails.create.error.yarn_required")) unless @ctx.windows?
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.yarn_required") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "yarn"))
           raise ShopifyCli::AbortSilent
         end
 
-        version, stat = @ctx.capture2e('yarn', '-v')
+        version, stat = @ctx.capture2e("yarn", "-v")
         unless stat.success?
-          @ctx.abort(@ctx.message('rails.create.error.yarn_version_failure')) unless @ctx.windows?
-          @ctx.puts("{{x}} {{red:" + @ctx.message('rails.create.error.yarn_version_failure') + "}}")
-          @ctx.puts(@ctx.message('rails.create.info.open_new_shell', 'yarn'))
+          @ctx.abort(@ctx.message("rails.create.error.yarn_version_failure")) unless @ctx.windows?
+          @ctx.puts("{{x}} {{red:" + @ctx.message("rails.create.error.yarn_version_failure") + "}}")
+          @ctx.puts(@ctx.message("rails.create.info.open_new_shell", "yarn"))
           raise ShopifyCli::AbortSilent
         end
 
-        @ctx.done(@ctx.message('rails.create.yarn_version', version))
+        @ctx.done(@ctx.message("rails.create.yarn_version", version))
       end
 
       def build(name, db)
-        @ctx.abort(@ctx.message('rails.create.error.install_failure', 'rails')) unless install_gem('rails')
-        @ctx.abort(@ctx.message('rails.create.error.install_failure', 'bundler ~>2.0')) unless
-          install_gem('bundler', '~>2.0')
+        @ctx.abort(@ctx.message("rails.create.error.install_failure", "rails")) unless install_gem("rails", "<6.1")
+        @ctx.abort(@ctx.message("rails.create.error.install_failure", "bundler ~>2.0")) unless
+          install_gem("bundler", "~>2.0")
 
         full_path = File.join(@ctx.root, name)
-        @ctx.abort(@ctx.message('rails.create.error.dir_exists', name)) if Dir.exist?(full_path)
+        @ctx.abort(@ctx.message("rails.create.error.dir_exists", name)) if Dir.exist?(full_path)
 
-        CLI::UI::Frame.open(@ctx.message('rails.create.generating_app', name)) do
+        CLI::UI::Frame.open(@ctx.message("rails.create.generating_app", name)) do
           new_command = %w(rails new)
           new_command += DEFAULT_RAILS_FLAGS
           new_command << "--database=#{db}"
@@ -129,38 +135,34 @@ module Rails
 
         @ctx.root = full_path
 
-        File.open(File.join(@ctx.root, '.gitignore'), 'a') { |f| f.write('.env') }
+        File.open(File.join(@ctx.root, ".gitignore"), "a") { |f| f.write(".env") }
 
-        @ctx.puts(@ctx.message('rails.create.adding_shopify_gem'))
-        File.open(File.join(@ctx.root, 'Gemfile'), 'a') do |f|
-          f.puts "\ngem 'shopify_app', '>=11.3.0'"
+        @ctx.puts(@ctx.message("rails.create.adding_shopify_gem"))
+        File.open(File.join(@ctx.root, "Gemfile"), "a") do |f|
+          f.puts "\ngem 'shopify_app', '>=17.0.3'"
         end
-        CLI::UI::Frame.open(@ctx.message('rails.create.running_bundle_install')) do
+        CLI::UI::Frame.open(@ctx.message("rails.create.running_bundle_install")) do
           syscall(%w(bundle install))
         end
 
-        CLI::UI::Frame.open(@ctx.message('rails.create.running_generator')) do
-          begin
-            syscall(%w(spring stop))
-          rescue
-          end
-          syscall(%w(rails generate shopify_app))
+        CLI::UI::Frame.open(@ctx.message("rails.create.running_generator")) do
+          syscall(%w(rails generate shopify_app --new-shopify-cli-app))
         end
 
-        CLI::UI::Frame.open(@ctx.message('rails.create.running_migrations')) do
+        CLI::UI::Frame.open(@ctx.message("rails.create.running_migrations")) do
           syscall(%w(rails db:create))
           syscall(%w(rails db:migrate RAILS_ENV=development))
         end
 
-        unless File.exist?(File.join(@ctx.root, 'config/webpacker.yml'))
-          CLI::UI::Frame.open(@ctx.message('rails.create.running_webpacker_install')) do
+        unless File.exist?(File.join(@ctx.root, "config/webpacker.yml"))
+          CLI::UI::Frame.open(@ctx.message("rails.create.running_webpacker_install")) do
             syscall(%w(rails webpacker:install))
           end
         end
       end
 
       def set_custom_ua
-        ua_path = File.join('config', 'initializers', 'user_agent.rb')
+        ua_path = File.join("config", "initializers", "user_agent.rb")
         @ctx.write(ua_path, USER_AGENT_CODE)
       end
 
@@ -172,6 +174,10 @@ module Rails
       def install_gem(name, version = nil)
         Gem.install(@ctx, name, version)
       end
+
+      def local_debug?
+        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
+      end
     end
   end
 end

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

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Rails
   module Commands
     class Deploy < ShopifyCli::Command
-      subcommand :Heroku, 'heroku', Project.project_filepath('commands/deploy/heroku')
+      subcommand :Heroku, "heroku", Project.project_filepath("commands/deploy/heroku")
 
       def call(*)
         @ctx.puts(self.class.help)
       end
 
       def self.help
-        ShopifyCli::Context.message('rails.deploy.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("rails.deploy.help", ShopifyCli::TOOL_NAME)
       end
 
       def self.extended_help
-        ShopifyCli::Context.message('rails.deploy.extended_help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("rails.deploy.extended_help", ShopifyCli::TOOL_NAME)
       end
     end
   end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Rails
   module Commands
@@ -8,15 +8,15 @@ module Rails
         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)
+          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|
+          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))
+              spinner.update_title(@ctx.message("rails.deploy.heroku.db_check.validated", db_type))
             end
             true
           end
@@ -24,53 +24,53 @@ module Rails
           spin_group = CLI::UI::SpinGroup.new
           heroku_service = ShopifyCli::Heroku.new(@ctx)
 
-          spin_group.add(@ctx.message('rails.deploy.heroku.downloading')) do |spinner|
+          spin_group.add(@ctx.message("rails.deploy.heroku.downloading")) do |spinner|
             heroku_service.download
-            spinner.update_title(@ctx.message('rails.deploy.heroku.downloaded'))
+            spinner.update_title(@ctx.message("rails.deploy.heroku.downloaded"))
           end
           spin_group.wait
 
-          spin_group.add(@ctx.message('rails.deploy.heroku.installing')) do |spinner|
+          spin_group.add(@ctx.message("rails.deploy.heroku.installing")) do |spinner|
             heroku_service.install
-            spinner.update_title(@ctx.message('rails.deploy.heroku.installed'))
+            spinner.update_title(@ctx.message("rails.deploy.heroku.installed"))
           end
-          spin_group.add(@ctx.message('rails.deploy.heroku.git.checking')) do |spinner|
+          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'))
+            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))
+            @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')
+              @ctx.message("rails.deploy.heroku.authenticating"),
+              success_text: @ctx.message("rails.deploy.heroku.authenticated")
             ) do
               heroku_service.authenticate
             end
           end
 
           if (app_name = heroku_service.app)
-            @ctx.puts(@ctx.message('rails.deploy.heroku.app.selected', app_name))
+            @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 }
+            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'))
+              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)
+                @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')
+                @ctx.message("rails.deploy.heroku.app.creating"),
+                success_text: @ctx.message("rails.deploy.heroku.app.created")
               ) do
                 heroku_service.create_new_app
               end
@@ -80,9 +80,9 @@ module Rails
           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))
+            @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|
+            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
@@ -90,8 +90,8 @@ module Rails
           end
 
           CLI::UI::Frame.open(
-            @ctx.message('rails.deploy.heroku.deploying'),
-            success_text: @ctx.message('rails.deploy.heroku.deployed')
+            @ctx.message("rails.deploy.heroku.deploying"),
+            success_text: @ctx.message("rails.deploy.heroku.deployed")
           ) do
             heroku_service.deploy(branch_to_deploy)
           end
@@ -99,10 +99,10 @@ module Rails
 
         def check_db(ctx)
           out, stat = ctx.capture2e(DB_CHECK_CMD)
-          if stat.success? && out.strip == 'sqlite'
-            ['sqlite', 'rails.deploy.heroku.db_check.sqlite']
+          if stat.success? && out.strip == "sqlite"
+            ["sqlite", "rails.deploy.heroku.db_check.sqlite"]
           elsif !stat.success?
-            [nil, 'rails.deploy.heroku.db_check.problem']
+            [nil, "rails.deploy.heroku.db_check.problem"]
           else
             [out.strip, nil]
           end

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module Rails
   module Commands
     class Generate < ShopifyCli::Command
-      subcommand :Webhook, 'webhook', Project.project_filepath('commands/generate/webhook')
+      subcommand :Webhook, "webhook", Project.project_filepath("commands/generate/webhook")
 
       def call(*)
         @ctx.puts(self.class.help)
       end
 
       def self.help
-        ShopifyCli::Context.message('rails.generate.help', ShopifyCli::TOOL_NAME)
+        ShopifyCli::Context.message("rails.generate.help", ShopifyCli::TOOL_NAME)
       end
 
       def self.extended_help
@@ -24,7 +24,7 @@ module Rails
           end
           extended_help += "\n"
         end
-        extended_help += ShopifyCli::Context.message('rails.generate.extended_help', ShopifyCli::TOOL_NAME)
+        extended_help += ShopifyCli::Context.message("rails.generate.extended_help", ShopifyCli::TOOL_NAME)
       end
 
       def self.run_generate(script, name, ctx)
@@ -38,11 +38,11 @@ module Rails
       def self.response(code, name, ctx)
         case code
         when 1
-          ctx.message('rails.generate.error.generic', name)
+          ctx.message("rails.generate.error.generic", name)
         when 2
-          ctx.message('rails.generate.error.name_exists', name)
+          ctx.message("rails.generate.error.name_exists", name)
         else
-          ctx.message('rails.error.generic')
+          ctx.message("rails.error.generic")
         end
       end
     end