shopify-cli 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b05da9533ccffc11607217b455d2a23590668a445a0af58c67c168fe5a5dfe96
-  data.tar.gz: e10408bf78ac963dd50953edbf438bc4dbf247d0001db8a1b1013b0f981189f1
+  metadata.gz: 9f47a49090da5b25b266e4186c08b377e91e6fe240620076f24bb0174accc854
+  data.tar.gz: 68be2a02c00aa4e0c67295024d0997c453eb40b9d92f4cec9ae06dc5c0b3d0fa
 SHA512:
-  metadata.gz: 7626a67bc6ba0fe13b6223b4239927e4f4e39c74a2536e7fe0a38b4403d9c115771a913c4921d28a81175de84c1cc9e7fc9b84e046042a5957ba9f3aa1d56d7d
-  data.tar.gz: 630008b941f6c034f51fcdb370f6dd09dba5bcb18a44b5bd1035367443bdc28d679adf69ee9e0f3a9417ddfcbef473411d99934a9a14fc777310edf67677711c
+  metadata.gz: f0cd5e1c1e79ec89fcba9834eb1c1ea98d53a98ad46f2fcc45e5fefebfabcd9b1655cb73c1431c503b9c1a26f2d684d6a1c330813423733601670839c7e82efc
+  data.tar.gz: a3f83e966247aee450f3a73615dce3d324f82ab944304be131dec81973d1984c405d060844601047ceb259163faaa79524d859bbe9a874479ea4a26c21530152

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+Version 1.1.0
+------
+* Add native Windows 10 support, including variety of stability fixes.
+
 Version 1.0.5
 ------
 * Fix a bug in out opt-in metrics

data/bin/load_shopify.rb

@@ -9,7 +9,9 @@ ENV['USER_PWD'] ||= Dir.pwd
 # Prune non-absolute paths from PATH to prevent non-deterministic behavior
 # i.e. If user has "." or "./bin" in their PATH
 # Note that this logic is duplicated in lib/shopify.rb
-ENV['PATH'] = ENV['PATH'].split(':').select { |p| p.start_with?('/', '~') }.join(':')
+ENV['PATH'] = ENV['PATH'].split(File::PATH_SEPARATOR).select do |p|
+  p.start_with?('/', '~', /[A-Z]:\\/)
+end.join(File::PATH_SEPARATOR)
 
 $original_env = ENV.to_hash
 

data/bin/shopify

@@ -8,6 +8,8 @@ module Kernel
   def require(name)
     original_require(name)
   rescue LoadError => e
+    # Special case for readline.so, which fails harmlessly on Windows
+    raise if (name == "readline.so") && ShopifyCli::Context.new.windows?
     # Special case for psych (yaml), which rescues this itself
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
     STDERR.puts "[Note] You cannot use gems with Shopify App CLI."

data/ext/shopify-cli/extconf.rb

@@ -3,25 +3,45 @@ require 'fileutils'
 
 gem = File.expand_path('../../../', __FILE__)
 exe = File.join(gem, 'bin', 'shopify')
-script = exe + '.sh'
-symlink = '/usr/local/bin/shopify'
-
-script_content = <<~SCRIPT
-  #!/usr/bin/env bash
-  #{RbConfig.ruby} --disable=gems -I #{gem} #{exe} $@
-SCRIPT
-
-File.write(script, script_content)
-FileUtils.chmod("+x", script)
-
-makefile_content = <<~MAKEFILE
-  .PHONY: clean install
-  
-  clean:
-  \t@sudo rm -f #{symlink}
-  
-  install: clean
-  \t@sudo ln -s #{script} #{symlink}
-MAKEFILE
+
+if RUBY_PLATFORM.match(/mingw32/)
+  bat_path = File.dirname(RbConfig.ruby)
+  bat = "#{bat_path}\\shopify.bat"
+
+  script_content = "#{RbConfig.ruby} --disable=gems -I '#{gem}' '#{exe}' %*"
+
+  FileUtils.mkdir_p(bat_path)
+  makefile_content = <<~MAKEFILE
+    .PHONY: clean install
+
+    clean:
+    \t rm -f "#{bat}"
+
+    install: clean
+    \t echo "@ECHO OFF"> "#{bat}"
+    \t echo "#{script_content}">> "#{bat}"
+  MAKEFILE
+else
+  script = exe + '.sh'
+  symlink = '/usr/local/bin/shopify'
+
+  script_content = <<~SCRIPT
+    #!/usr/bin/env bash
+    #{RbConfig.ruby} --disable=gems -I #{gem} #{exe} $@
+  SCRIPT
+
+  File.write(script, script_content)
+  FileUtils.chmod("+x", script)
+
+  makefile_content = <<~MAKEFILE
+    .PHONY: clean install
+    
+    clean:
+    \t@sudo rm -f #{symlink}
+    
+    install: clean
+    \t@sudo ln -s #{script} #{symlink}
+  MAKEFILE
+end
 
 File.write('Makefile', makefile_content)

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,12 @@ 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 = 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,12 @@ 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 = 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,12 @@ module Node
               end
             end
           end
+
+          generate_path = File.join(ShopifyCli::Project.current.directory, "node_modules/.bin/generate-node-app")
+
           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/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",

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,51 @@ 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
 
         CLI::UI::Frame.open(@ctx.message('rails.create.generating_app', name)) do
           new_command = %w(rails new)
@@ -106,6 +148,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

@@ -26,12 +26,16 @@ module Rails
             @ctx.open_url!("#{project.env.host}/login?shop=#{project.env.shop}")
           end
         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