shopify-cli 1.0.4 → 1.2.0

data/lib/project_types/extension/cli.rb

@@ -53,6 +53,7 @@ module Extension
     autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
     autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
     autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
+    autoload :ArgoConfig, Project.project_filepath('features/argo_config')
   end
 
   module Models

data/lib/project_types/extension/features/argo_config.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Extension
+  module Features
+    class ArgoConfig
+      CONFIG_FILE_NAME = 'extension.config.yml'
+
+      class << self
+        def parse_yaml(context, permitted_keys = [])
+          file_name = File.join(context.root, CONFIG_FILE_NAME)
+
+          return {} unless File.size?(file_name)
+
+          require 'yaml' # takes 20ms, so deferred as late as possible.
+          begin
+            config = YAML.load_file(file_name)
+
+            # `YAML.load_file` returns nil if the file is not empty
+            # but does not contain any parsable yml data, e.g. only comments
+            # We consider this valid
+            return {} if config.nil?
+
+            unless config.is_a?(Hash)
+              raise ShopifyCli::Abort, ShopifyCli::Context.message('core.yaml.error.not_hash', CONFIG_FILE_NAME)
+            end
+
+            config.transform_keys!(&:to_sym)
+            assert_valid_config(config, permitted_keys) unless permitted_keys.empty?
+
+            config
+          rescue Psych::SyntaxError => e
+            raise(
+              ShopifyCli::Abort,
+              ShopifyCli::Context.message('core.yaml.error.invalid', CONFIG_FILE_NAME, e.message)
+            )
+          end
+        end
+
+        private
+
+        def assert_valid_config(config, permitted_keys)
+          unpermitted_keys = config.keys.select do |k|
+            !permitted_keys.include?(k)
+          end
+
+          unless unpermitted_keys.empty?
+            raise(
+              ShopifyCli::Abort,
+              ShopifyCli::Context.message(
+                'features.argo.config.unpermitted_keys',
+                CONFIG_FILE_NAME,
+                unpermitted_keys.map { |k| "\n- #{k}" }.join
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/messages/messages.rb

@@ -96,6 +96,9 @@ module Extension
               version_too_low: 'Your node version %s does not meet the minimum required version %s',
             },
           },
+          config: {
+            unpermitted_keys: '`%s` contains the following unpermitted keys: %s',
+          },
         },
       },
       tasks: {

data/lib/project_types/extension/models/type.rb

@@ -12,6 +12,7 @@ module Extension
         end
 
         def inherited(klass)
+          super
           @all_extension_types ||= []
           @all_extension_types << klass
         end

data/lib/project_types/extension/models/types/checkout_post_purchase.rb

@@ -6,13 +6,16 @@ module Extension
     module Types
       class CheckoutPostPurchase < Models::Type
         IDENTIFIER = 'CHECKOUT_POST_PURCHASE'
-
+        PERMITTED_CONFIG_KEYS = [:metafields]
         def create(directory_name, context)
           Features::Argo.checkout.create(directory_name, IDENTIFIER, context)
         end
 
         def config(context)
-          Features::Argo.checkout.config(context)
+          {
+            **Features::ArgoConfig.parse_yaml(context, PERMITTED_CONFIG_KEYS),
+            **Features::Argo.checkout.config(context),
+          }
         end
       end
     end

data/lib/project_types/extension/tasks/create_extension.rb

@@ -20,7 +20,7 @@ module Extension
           extension_context: extension_context,
         }
 
-        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, input).dig(*RESPONSE_FIELD)
+        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
         context.abort(context.message('tasks.errors.parse_error')) if response.nil?
 
         abort_if_user_errors(context, response)

data/lib/project_types/extension/tasks/get_app.rb

@@ -12,7 +12,7 @@ module Extension
       def call(context:, api_key:)
         input = { api_key: api_key }
 
-        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, input).dig(*RESPONSE_FIELD)
+        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
         context.abort(context.message('tasks.errors.parse_error')) if response.nil?
 
         Converters::AppConverter.from_hash(response.dig(APP_FIELD))

data/lib/project_types/extension/tasks/update_draft.rb

@@ -18,7 +18,7 @@ module Extension
           config: JSON.generate(config),
           extension_context: extension_context,
         }
-        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, input).dig(*RESPONSE_FIELD)
+        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, **input).dig(*RESPONSE_FIELD)
         context.abort(context.message('tasks.errors.parse_error')) if response.nil?
 
         abort_if_user_errors(context, response)

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

@@ -54,8 +54,8 @@ module Node
       private
 
       def check_node
-        _, stat = @ctx.capture2e('which', 'node')
-        @ctx.abort(@ctx.message('node.create.error.node_required')) unless stat.success?
+        cmd_path = @ctx.which('node')
+        @ctx.abort(@ctx.message('node.create.error.node_required')) if cmd_path.nil?
 
         version, stat = @ctx.capture2e('node', '-v')
         @ctx.abort(@ctx.message('node.create.error.node_version_failure')) unless stat.success?
@@ -64,8 +64,8 @@ module Node
       end
 
       def check_npm
-        _, stat = @ctx.capture2e('which', 'npm')
-        @ctx.abort(@ctx.message('node.create.error.npm_required')) unless stat.success?
+        cmd_path = @ctx.which('npm')
+        @ctx.abort(@ctx.message('node.create.error.npm_required')) if cmd_path.nil?
 
         version, stat = @ctx.capture2e('npm', '-v')
         @ctx.abort(@ctx.message('node.create.error.npm_version_failure')) unless stat.success?

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

@@ -19,10 +19,15 @@ module Node
           end
           spin_group.wait
 
-          spin_group.add(@ctx.message('node.deploy.heroku.installing')) do |spinner|
+          install_message = @ctx.message(
+            @ctx.windows? ? 'node.deploy.heroku.installing_windows' : 'node.deploy.heroku.installing'
+          )
+          spin_group.add(install_message) do |spinner|
             heroku_service.install
             spinner.update_title(@ctx.message('node.deploy.heroku.installed'))
           end
+          spin_group.wait
+
           spin_group.add(@ctx.message('node.deploy.heroku.git.checking')) do |spinner|
             ShopifyCli::Git.init(@ctx)
             spinner.update_title(@ctx.message('node.deploy.heroku.git.initialized'))

data/lib/project_types/node/commands/generate/billing.rb

@@ -5,8 +5,8 @@ module Node
     class Generate
       class Billing < ShopifyCli::SubCommand
         BILLING_TYPES = {
-          'recurring-billing' => './node_modules/.bin/generate-node-app recurring-billing',
-          'one-time-billing' => './node_modules/.bin/generate-node-app one-time-billing',
+          'recurring-billing' => ['./node_modules/.bin/generate-node-app', 'recurring-billing'],
+          'one-time-billing' => ['./node_modules/.bin/generate-node-app', 'one-time-billing'],
         }
         def call(args, _name)
           selected_type = BILLING_TYPES[args[1]]
@@ -18,11 +18,13 @@ module Node
             end
           end
           billing_type_name = BILLING_TYPES.key(selected_type)
+          selected_type[0] = File.join(ShopifyCli::Project.current.directory, selected_type[0])
+          selected_type[0] = "\"#{selected_type[0]}\""
+          selected_type = selected_type.join(' ')
+
           spin_group = CLI::UI::SpinGroup.new
           spin_group.add(@ctx.message('node.generate.billing.generating', billing_type_name)) do |spinner|
-            Node::Commands::Generate.run_generate(
-              selected_type, billing_type_name, @ctx
-            )
+            Node::Commands::Generate.run_generate(selected_type, billing_type_name, @ctx)
             spinner.update_title(@ctx.message('node.generate.billing.generated', billing_type_name))
           end
           spin_group.wait

data/lib/project_types/node/commands/generate/page.rb

@@ -5,10 +5,10 @@ module Node
     class Generate
       class Page < ShopifyCli::SubCommand
         PAGE_TYPES = {
-          'empty-state' => './node_modules/.bin/generate-node-app empty-state-page',
-          'two-column' => './node_modules/.bin/generate-node-app two-column-page',
-          'annotated' => './node_modules/.bin/generate-node-app settings-page',
-          'list' => './node_modules/.bin/generate-node-app list-page',
+          'empty-state' => ['./node_modules/.bin/generate-node-app', 'empty-state-page'],
+          'two-column' => ['./node_modules/.bin/generate-node-app', 'two-column-page'],
+          'annotated' => ['./node_modules/.bin/generate-node-app', 'settings-page'],
+          'list' => ['./node_modules/.bin/generate-node-app', 'list-page'],
         }
 
         options do |parser, flags|
@@ -37,9 +37,13 @@ module Node
               end
             end
           end
+          page_type_name = PAGE_TYPES.key(selected_type)
+          selected_type[0] = File.join(ShopifyCli::Project.current.directory, selected_type[0])
+          selected_type[0] = "\"#{selected_type[0]}\""
+          selected_type = selected_type.join(' ')
 
           spin_group = CLI::UI::SpinGroup.new
-          spin_group.add(@ctx.message('node.generate.page.generating', selected_type)) do |spinner|
+          spin_group.add(@ctx.message('node.generate.page.generating', page_type_name)) do |spinner|
             Node::Commands::Generate.run_generate("#{selected_type} #{name}", name, @ctx)
             spinner.update_title(@ctx.message('node.generate.page.generated', name, name))
           end

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

@@ -15,9 +15,13 @@ module Node
               end
             end
           end
+
+          generate_path = File.join(ShopifyCli::Project.current.directory, "node_modules/.bin/generate-node-app")
+          generate_path = "\"#{generate_path}\""
+
           spin_group = CLI::UI::SpinGroup.new
           spin_group.add(@ctx.message('node.generate.webhook.generating', selected_type)) do |spinner|
-            Node::Commands::Generate.run_generate("./node_modules/.bin/generate-node-app webhook #{selected_type}",
+            Node::Commands::Generate.run_generate("#{generate_path} webhook #{selected_type}",
               selected_type, @ctx)
             spinner.update_title(@ctx.message('node.generate.webhook.generated', selected_type))
           end

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

@@ -20,12 +20,12 @@ module Node
           url: url,
           callback_url: "/auth/callback",
         )
-        if @ctx.mac? && project.env.shop
-          @ctx.puts(@ctx.message('node.serve.open_info', project.env.shop))
-          @ctx.on_siginfo do
-            @ctx.open_url!("#{project.env.host}/auth?shop=#{project.env.shop}")
-          end
+
+        if project.env.shop
+          project_url = "#{project.env.host}/auth?shop=#{project.env.shop}"
+          @ctx.puts("\n" + @ctx.message('node.serve.open_info', project_url) + "\n")
         end
+
         CLI::UI::Frame.open(@ctx.message('node.serve.running_server')) do
           env = project.env.to_h
           env['PORT'] = ShopifyCli::Tunnel::PORT.to_s

data/lib/project_types/node/messages/messages.rb

@@ -54,6 +54,7 @@ module Node
             downloading: "Downloading Heroku CLI…",
             downloaded: "Downloaded Heroku CLI",
             installing: "Installing Heroku CLI…",
+            installing_windows: "Running Heroku CLI install wizard…",
             installed: "Installed Heroku CLI",
             authenticating: "Authenticating with Heroku…",
             authenticated: "{{v}} Authenticated with Heroku",
@@ -201,7 +202,10 @@ module Node
             host_must_be_https: "HOST must be a HTTPS url.",
           },
 
-          open_info: "{{*}} Press {{yellow: Control-T}} to open this project in {{green:%s}} ",
+          open_info: <<~MESSAGE,
+            {{*}} To install and start using your app, open this URL in your browser:
+            {{green:%s}}
+          MESSAGE
           running_server: "Running server...",
         },
 

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

@@ -30,6 +30,9 @@ module Rails
         @ctx.abort(@ctx.message('rails.create.error.invalid_ruby_version')) unless
           Ruby.version(@ctx).satisfies?('~>2.5')
 
+        check_node
+        check_yarn
+
         build(form.name, form.db)
         set_custom_ua
         ShopifyCli::Project.write(
@@ -65,12 +68,54 @@ module Rails
 
       private
 
+      def check_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'))
+          raise ShopifyCli::AbortSilent
+        end
+
+        version, stat = @ctx.capture2e('node', '-v')
+        unless stat.success?
+          @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'))
+          raise ShopifyCli::AbortSilent
+        end
+
+        @ctx.done(@ctx.message('rails.create.node_version', version))
+      end
+
+      def check_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'))
+          raise ShopifyCli::AbortSilent
+        end
+
+        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'))
+          raise ShopifyCli::AbortSilent
+        end
+
+        @ctx.done(@ctx.message('rails.create.yarn_version', version))
+      end
+
       def build(name, db)
-        install_gem('rails')
-        CLI::UI::Frame.open(@ctx.message('rails.create.installing_bundler')) do
-          install_gem('bundler', '~>1.0')
+        @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')
-        end
+
+        full_path = File.join(@ctx.root, name)
+        @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
           new_command = %w(rails new)
@@ -82,7 +127,7 @@ module Rails
           syscall(new_command)
         end
 
-        @ctx.root = File.join(@ctx.root, name)
+        @ctx.root = full_path
 
         File.open(File.join(@ctx.root, '.gitignore'), 'a') { |f| f.write('.env') }
 
@@ -106,6 +151,12 @@ module Rails
           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
+            syscall(%w(rails webpacker:install))
+          end
+        end
       end
 
       def set_custom_ua

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

@@ -28,6 +28,7 @@ module Rails
       end
 
       def self.run_generate(script, name, ctx)
+        Gem.gem_path(ctx)
         stat = ctx.system(script)
         unless stat.success?
           ctx.abort(response(stat.exitstatus, name, ctx))

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

@@ -29,9 +29,10 @@ module Rails
 
         def generate_command(selected_type)
           parts = selected_type.downcase.split("_")
-          env = ShopifyCli::Project.current.env.host
+          host = ShopifyCli::Project.current.env.host
           selected_type = parts[0..-2].join("_") + "/" + parts[-1]
-          "rails g shopify_app:add_webhook -t #{selected_type} -a #{env}/webhooks/#{selected_type.downcase}"
+          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

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

@@ -20,18 +20,22 @@ module Rails
           url: url,
           callback_url: "/auth/shopify/callback",
         )
-        if @ctx.mac? && project.env.shop
-          @ctx.puts(@ctx.message('rails.serve.open_info', project.env.shop))
-          @ctx.on_siginfo do
-            @ctx.open_url!("#{project.env.host}/login?shop=#{project.env.shop}")
-          end
+
+        if project.env.shop
+          project_url = "#{project.env.host}/login?shop=#{project.env.shop}"
+          @ctx.puts("\n" + @ctx.message('rails.serve.open_info', project_url) + "\n")
         end
-        Gem.gem_home(@ctx)
+
         CLI::UI::Frame.open(@ctx.message('rails.serve.running_server')) do
           env = ShopifyCli::Project.current.env.to_h
           env.delete('HOST')
           env['PORT'] = ShopifyCli::Tunnel::PORT.to_s
-          @ctx.system('bin/rails server', env: env)
+          env['GEM_PATH'] = Gem.gem_path(@ctx)
+          if @ctx.windows?
+            @ctx.system("ruby bin\\rails server", env: env)
+          else
+            @ctx.system('bin/rails server', env: env)
+          end
         end
       end
 

data/lib/project_types/rails/gem.rb

@@ -15,30 +15,65 @@ module Rails
         version = args.shift
         gem = new(ctx: ctx, name: name, version: version)
         ctx.debug(ctx.message('rails.gem.installed_debug', name, gem.installed?))
-        gem.install! unless gem.installed?
+        gem.installed? ? true : gem.install!
       end
 
       def binary_path_for(ctx, binary)
-        File.join(gem_home(ctx), 'bin', 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 = File.join(ctx.getenv('HOME'), '.gem', 'ruby', RUBY_VERSION)
+        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?
-      !!Dir.glob("#{self.class.gem_home(ctx)}/gems/#{name}-*").detect do |f|
-        f =~ %r{/#{Regexp.quote(name)}-\d}
+      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!
@@ -46,11 +81,31 @@ module Rails
       spin.add(ctx.message('rails.gem.installing', name)) do |spinner|
         args = %w(gem install)
         args.push(name)
-        args.push('-v', version) unless version.nil?
+        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\.]+)})&.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