shopify-cli 2.7.3 → 2.10.0

data/lib/shopify_cli/theme/dev_server/proxy/template_param_builder.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+module ShopifyCLI
+  module Theme
+    module DevServer
+      class Proxy
+        class TemplateParamBuilder
+          def build
+            # Core doesn't support replace_templates
+            return {} if core?(current_path)
+
+            (syncer_templates + request_templates)
+              .select { |file| file.liquid? || file.json? }
+              .uniq(&:relative_path)
+              .map { |file| as_param(file) }
+              .to_h
+          end
+
+          def with_core_endpoints(core_endpoints)
+            @core_endpoints = core_endpoints
+            self
+          end
+
+          def with_syncer(syncer)
+            @syncer = syncer
+            self
+          end
+
+          def with_rack_env(rack_env)
+            @rack_env = rack_env
+            self
+          end
+
+          def with_theme(theme)
+            @theme = theme
+            self
+          end
+
+          private
+
+          def as_param(file)
+            ["replace_templates[#{file.relative_path}]", file.read]
+          end
+
+          def syncer_templates
+            @syncer&.pending_updates || []
+          end
+
+          def request_templates
+            cookie_sections
+              .map { |section| @theme[section] unless @theme.nil? }
+              .compact
+          end
+
+          def cookie_sections
+            CGI::Cookie.parse(cookie)["hot_reload_sections"].join.split(",") || []
+          end
+
+          def core?(path)
+            core_endpoints.include?(path)
+          end
+
+          def current_path
+            rack_env["PATH_INFO"]
+          end
+
+          def cookie
+            rack_env["HTTP_COOKIE"]
+          end
+
+          def core_endpoints
+            @core_endpoints || []
+          end
+
+          def rack_env
+            @rack_env || {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/dev_server/proxy.rb

@@ -2,6 +2,9 @@
 require "net/http"
 require "stringio"
 require "time"
+require "cgi"
+
+require_relative "proxy/template_param_builder"
 
 module ShopifyCLI
   module Theme
@@ -15,6 +18,7 @@ module ShopifyCLI
         "trailer",
         "transfer-encoding",
         "upgrade",
+        "content-security-policy",
       ]
 
       class Proxy
@@ -112,21 +116,12 @@ module ShopifyCLI
         end
 
         def build_replace_templates_param(env)
-          params = {}
-
-          # Core doesn't support replace_templates
-          return params if @core_endpoints.include?(env["PATH_INFO"])
-
-          pending_templates = @syncer.pending_updates.select do |file|
-            # Only replace Liquid or JSON files
-            file.liquid? || file.json?
-          end
-
-          pending_templates.each do |path|
-            params["replace_templates[#{path.relative_path}]"] = path.read
-          end
-
-          params
+          TemplateParamBuilder.new
+            .with_core_endpoints(@core_endpoints)
+            .with_syncer(@syncer)
+            .with_theme(@theme)
+            .with_rack_env(env)
+            .build
         end
 
         def add_session_cookie(cookie_header)

data/lib/shopify_cli/theme/dev_server/reload_mode.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    module DevServer
+      class ReloadMode
+        MODES = [:"hot-reload", :"full-page", :off]
+
+        class << self
+          def default
+            :"hot-reload"
+          end
+
+          def get!(mode)
+            MODES.find { |m| m == mode.to_sym } || raise_error(mode)
+          end
+
+          private
+
+          def raise_error(invalid_mode)
+            error_message = ShopifyCLI::Context.message("theme.serve.reload_mode_is_not_valid", invalid_mode)
+            help_message = ShopifyCLI::Context.message("theme.serve.try_a_valid_reload_mode", valid_modes)
+
+            ShopifyCLI::Context.abort(error_message, help_message)
+          end
+
+          def valid_modes
+            MODES.map { |v| "`#{v}`" }.join(", ")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/dev_server.rb

@@ -3,9 +3,11 @@ require_relative "development_theme"
 require_relative "ignore_filter"
 require_relative "syncer"
 
+require_relative "dev_server/cdn_assets"
 require_relative "dev_server/cdn_fonts"
 require_relative "dev_server/hot_reload"
 require_relative "dev_server/header_hash"
+require_relative "dev_server/reload_mode"
 require_relative "dev_server/local_assets"
 require_relative "dev_server/proxy"
 require_relative "dev_server/sse"
@@ -25,7 +27,7 @@ module ShopifyCLI
       class << self
         attr_accessor :ctx
 
-        def start(ctx, root, host: "127.0.0.1", port: 9292, poll: false)
+        def start(ctx, root, host: "127.0.0.1", port: 9292, poll: false, mode: ReloadMode.default)
           @ctx = ctx
           theme = DevelopmentTheme.new(ctx, root: root)
           ignore_filter = IgnoreFilter.from_path(root)
@@ -36,7 +38,8 @@ module ShopifyCLI
           @app = Proxy.new(ctx, theme: theme, syncer: @syncer)
           @app = CdnFonts.new(@app, theme: theme)
           @app = LocalAssets.new(ctx, @app, theme: theme)
-          @app = HotReload.new(ctx, @app, theme: theme, watcher: watcher, ignore_filter: ignore_filter)
+          @app = CdnAssets.new(@app, theme: theme)
+          @app = HotReload.new(ctx, @app, theme: theme, watcher: watcher, mode: mode, ignore_filter: ignore_filter)
           stopped = false
           address = "http://#{host}:#{port}"
 
@@ -83,7 +86,9 @@ module ShopifyCLI
                ShopifyCLI::API::APIRequestUnauthorizedError
           raise ShopifyCLI::Abort, @ctx.message("theme.serve.ensure_user", theme.shop)
         rescue Errno::EADDRINUSE
-          abort_address_already_in_use(address)
+          error_message = @ctx.message("theme.serve.address_already_in_use", address)
+          help_message = @ctx.message("theme.serve.try_port_option")
+          @ctx.abort(error_message, help_message)
         rescue Errno::EADDRNOTAVAIL
           raise AddressBindingError, "Error binding to the address #{host}."
         end
@@ -94,24 +99,6 @@ module ShopifyCLI
           @syncer.shutdown
           WebServer.shutdown
         end
-
-        private
-
-        def abort_address_already_in_use(address)
-          open_frame(@ctx.message("theme.serve.already_in_use_error"), color: :red) do
-            @ctx.puts(@ctx.message("theme.serve.address_already_in_use", address))
-          end
-
-          open_frame(@ctx.message("theme.serve.try_this"), color: :green) do
-            @ctx.puts(@ctx.message("theme.serve.try_port_option"))
-          end
-
-          raise ShopifyCLI::AbortSilent
-        end
-
-        def open_frame(title, color:, &block)
-          CLI::UI::Frame.open(title, color: CLI::UI.resolve_color(color), timing: false, &block)
-        end
       end
     end
   end

data/lib/shopify_cli/theme/file.rb

@@ -18,7 +18,7 @@ module ShopifyCLI
 
       def read
         if text?
-          path.read
+          path.read(universal_newline: true)
         else
           path.read(mode: "rb")
         end
@@ -27,7 +27,7 @@ module ShopifyCLI
       def write(content)
         path.parent.mkpath unless path.parent.directory?
         if text?
-          path.write(content)
+          path.write(content, universal_newline: true)
         else
           path.write(content, 0, mode: "wb")
         end

data/lib/shopify_cli/theme/filter/path_matcher.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Theme
+    module Filter
+      module PathMatcher
+        def regex_match?(regex, path)
+          regex.match?(path)
+        rescue StandardError
+          false
+        end
+
+        def glob_match?(glob, path)
+          !!::File.fnmatch?(glob, path)
+        end
+
+        def regex?(pattern)
+          pattern.start_with?("/") && pattern.end_with?("/")
+        end
+
+        def as_regex(pattern)
+          Regexp.new(pattern.gsub(%r{^\/|\/$}, ""))
+        end
+
+        def as_glob(pattern)
+          # if specifying a directory, match everything below it
+          pattern += "*" if pattern.end_with?("/")
+
+          # The pattern will be scoped to root directory, so it should match anything
+          # within that space
+          pattern.prepend("*") unless pattern.start_with?("*")
+
+          pattern
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/ignore_filter.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "filter/path_matcher"
+
 module ShopifyCLI
   module Theme
     class IgnoreFilter
+      include Filter::PathMatcher
+
       FILE = ".shopifyignore"
 
       DEFAULT_REGEXES = [
@@ -72,11 +76,11 @@ module ShopifyCLI
         return true if path.empty?
 
         regexes.each do |regex|
-          return true if regex.match(path)
+          return true if regex_match?(regex, path)
         end
 
         globs.each do |glob|
-          return true if ::File.fnmatch?(glob, path)
+          return true if glob_match?(glob, path)
         end
 
         false
@@ -91,24 +95,16 @@ module ShopifyCLI
         new_regexes = DEFAULT_REGEXES.dup
         new_globs = DEFAULT_GLOBS.dup
 
-        patterns.each do |pattern|
-          pattern = pattern.strip
-
-          if pattern.start_with?("/") && pattern.end_with?("/")
-            new_regexes << Regexp.new(pattern.gsub(%r{^\/|\/$}, ""))
-            next
+        patterns
+          .map(&:strip)
+          .each do |pattern|
+            if regex?(pattern)
+              new_regexes << as_regex(pattern)
+            else
+              new_globs << as_glob(pattern)
+            end
           end
 
-          # if specifying a directory, match everything below it
-          pattern += "*" if pattern.end_with?("/")
-
-          # The pattern will be scoped to root directory, so it should match anything
-          # within that space
-          pattern.prepend("*") unless pattern.start_with?("*")
-
-          new_globs << pattern
-        end
-
         [new_regexes, new_globs]
       end
     end

data/lib/shopify_cli/theme/include_filter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "filter/path_matcher"
+
+module ShopifyCLI
+  module Theme
+    class IncludeFilter
+      include Filter::PathMatcher
+
+      def initialize(pattern = nil)
+        @pattern = pattern
+      end
+
+      def match?(path)
+        return true unless present?(@pattern)
+
+        if regex_pattern?
+          regex_match?(regex_pattern, path)
+        else
+          glob_match?(glob_pattern, path)
+        end
+      end
+
+      private
+
+      def present?(pattern)
+        !pattern.nil? && !pattern.empty?
+      end
+
+      def regex_pattern?
+        @is_regex_pattern ||= regex?(@pattern)
+      end
+
+      def regex_pattern
+        @regex_pattern ||= as_regex(@pattern)
+      end
+
+      def glob_pattern
+        @glob_pattern ||= as_glob(@pattern)
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/syncer.rb

@@ -16,13 +16,15 @@ module ShopifyCLI
       API_VERSION = "unstable"
 
       attr_reader :checksums
+      attr_accessor :include_filter
       attr_accessor :ignore_filter
 
       def_delegators :@error_reporter, :has_any_error?
 
-      def initialize(ctx, theme:, ignore_filter: nil)
+      def initialize(ctx, theme:, include_filter: nil, ignore_filter: nil)
         @ctx = ctx
         @theme = theme
+        @include_filter = include_filter
         @ignore_filter = ignore_filter
         @error_reporter = ErrorReporter.new(ctx)
         @standard_reporter = StandardReporter.new(ctx)
@@ -193,7 +195,7 @@ module ShopifyCLI
         # Already enqueued
         return if @pending.include?(operation)
 
-        if @ignore_filter&.ignore?(operation.file_path)
+        if ignore?(operation)
           @ctx.debug("ignore #{operation.file_path}")
           return
         end
@@ -251,6 +253,19 @@ module ShopifyCLI
         response
       end
 
+      def ignore?(operation)
+        path = operation.file_path
+        ignored_by_ignore_filter?(path) || ignored_by_include_filter?(path)
+      end
+
+      def ignored_by_ignore_filter?(path)
+        ignore_filter&.ignore?(path)
+      end
+
+      def ignored_by_include_filter?(path)
+        include_filter && !include_filter.match?(path)
+      end
+
       def get(file)
         _status, body, response = ShopifyCLI::AdminAPI.rest_request(
           @ctx,

data/lib/shopify_cli/theme/theme.rb

@@ -173,15 +173,37 @@ module ShopifyCLI
         end
 
         def live(ctx, root: nil)
-          _status, body = fetch_themes(ctx)
+          find(ctx, root) { |attrs| attrs["role"] == "main" }
+        end
 
-          body["themes"]
-            .find { |theme_attrs| theme_attrs["role"] == "main" }
-            .tap { |theme_attrs| break new(ctx, root: root, **allowed_attrs(theme_attrs)) }
+        def development(ctx, root: nil)
+          find(ctx, root) { |attrs| attrs["role"] == "development" }
+        end
+
+        # Finds a Theme by its identifier
+        #
+        # #### Parameters
+        # * `ctx` - current running context of your command
+        # * `root` - theme root
+        # * `identifier` - theme ID or theme name
+        def find_by_identifier(ctx, root: nil, identifier:)
+          find(ctx, root) do |attrs|
+            attrs.slice("name", "id").values.map(&:to_s).include?(identifier)
+          end
         end
 
         private
 
+        def find(ctx, root, &block)
+          _status, body = fetch_themes(ctx)
+
+          body["themes"]
+            .find(&block)
+            .tap do |attrs|
+              break new(ctx, root: root, **allowed_attrs(attrs)) if attrs
+            end
+        end
+
         def allowed_attrs(attrs)
           attrs.slice("id", "name", "role").transform_keys(&:to_sym)
         end

data/lib/shopify_cli/thread_pool/job.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  class ThreadPool
+    class Job
+      attr_reader :error
+
+      def perform!
+        raise "`#{self.class.name}#perform!` must be defined"
+      end
+
+      def call
+        perform!
+      rescue StandardError => error
+        @error = error
+      end
+
+      def success?
+        !@error
+      end
+
+      def error?
+        !!@error
+      end
+    end
+  end
+end

data/lib/shopify_cli/thread_pool.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  class ThreadPool
+    attr_reader :errors
+
+    def initialize(pool_size: 10)
+      @jobs = Queue.new
+      @pool = Array.new(pool_size) { spawn_thread }
+    end
+
+    def schedule(job)
+      @jobs << job
+    end
+
+    def shutdown
+      @pool.size.times do
+        schedule(-> { throw(:stop_thread) })
+      end
+      @pool.map(&:join)
+    ensure
+      @jobs.close
+    end
+
+    private
+
+    def spawn_thread
+      Thread.new do
+        catch(:stop_thread) do
+          loop do
+            @jobs.pop.call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.7.3"
+  VERSION = "2.10.0"
 end

data/lib/shopify_cli.rb

@@ -15,12 +15,13 @@ ENV["PATH"] = ENV["PATH"].split(":").select { |p| p.start_with?("/", "~") }.join
 vendor_path = File.expand_path("../../vendor/lib", __FILE__)
 $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
 
-deps = %w(cli-ui cli-kit smart_properties webrick)
+deps = %w(cli-ui cli-kit smart_properties ruby2_keywords webrick)
 deps.each do |dep|
   vendor_path = File.expand_path("../../vendor/deps/#{dep}/lib", __FILE__)
   $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
 end
 
+require "ruby2_keywords"
 require "cli/ui"
 require "cli/kit"
 require "smart_properties"
@@ -139,6 +140,10 @@ module ShopifyCLI
   require "shopify_cli/messages/messages"
   Context.load_messages(ShopifyCLI::Messages::MESSAGES)
 
+  # cli-ui utilities for capturing the output close the stream while capturing.
+  # By setting the value here we persist the tty value for the whole lifetime of the process.
+  Environment.interactive = $stdin.tty?
+
   def self.cache_dir
     cache_dir = if Environment.test?
       TEMP_DIR

data/vendor/deps/cli-kit/lib/cli/kit/error_handler.rb

@@ -114,7 +114,9 @@ module CLI
       end
 
       def print_error_message(e)
-        $stderr.puts(format_error_message(e.message))
+        CLI::UI::Frame.open("Error", color: :red, timing: false) do
+          $stderr.puts(format_error_message(e.message))
+        end
       end
     end
   end

data/vendor/deps/ruby2_keywords/LICENSE

@@ -0,0 +1,22 @@
+Copyright 2019-2020 Nobuyoshi Nakada, Yusuke Endoh
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/vendor/deps/ruby2_keywords/README.md

@@ -0,0 +1,67 @@
+# ruby2_keywords
+
+Provides empty `Module#ruby2_keywords` method, for the forward
+source-level compatibility against ruby2.7 and ruby3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby2_keywords'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby2_keywords
+
+## Usage
+
+For class/module instance methods:
+
+```ruby
+require 'ruby2_keywords'
+
+module YourModule
+  ruby2_keywords def delegating_method(*args)
+    other_method(*args)
+  end
+end
+```
+
+For global methods:
+
+```ruby
+require 'ruby2_keywords'
+
+ruby2_keywords def oldstyle_keywords(options = {})
+end
+```
+
+You can do the same for a method defined by `Module#define_method`:
+
+```ruby
+define_method :delegating_method do |*args, &block|
+  other_method(*args, &block)
+end
+ruby2_keywords :delegating_method
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub] or
+[Ruby Issue Tracking System].
+
+## License
+
+The gem is available as open source under the terms of the
+[Ruby License] or the [2-Clause BSD License].
+
+[GitHub]: https://github.com/ruby/ruby2_keywords/
+[Ruby Issue Tracking System]: https://bugs.ruby-lang.org
+[Ruby License]: https://www.ruby-lang.org/en/about/license.txt
+[2-Clause BSD License]: https://opensource.org/licenses/BSD-2-Clause