shopify-cli 2.8.0 → 2.10.2

data/lib/shopify_cli/result.rb

@@ -363,70 +363,72 @@ module ShopifyCLI
       Result::Failure.new(error)
     end
 
-    ##
-    # takes either a value or a block and chooses the appropriate result
-    # container based on the type of the value or the type of the block's return
-    # value. If the type is an exception, it is wrapped in a
-    # `ShopifyCLI::Result::Failure` and otherwise in a
-    # `ShopifyCLI::Result::Success`. If a block was provided instead of value, a
-    # `Proc` is returned and the result wrapping doesn't occur until the block
-    # is invoked.
-    #
-    # #### Parameters
-    #
-    # * `*args` should be an `Array` with zero or one element
-    # * `&block` should be a `Proc` that takes zero or one argument
-    #
-    # #### Returns
-    #
-    # Returns either a `Result::Success`, `Result::Failure` or a `Proc` that
-    # produces one of the former when invoked.
-    #
-    # #### Examples
-    #
-    #   Result.wrap(1) # => ShopifyCLI::Result::Success
-    #   Result.wrap(RuntimeError.new) # => ShopifyCLI::Result::Failure
-    #
-    #   Result.wrap { 1 } # => Proc
-    #   Result.wrap { 1 }.call # => ShopifyCLI::Result::Success
-    #   Result.wrap { raise }.call # => ShopifyCLI::Result::Failure
-    #
-    #   Result.wrap { |s| s.upcase }.call("hello").tap do |result|
-    #     result # => Result::Success
-    #     result.value # => "HELLO"
-    #   end
-    #
-    def self.wrap(*values, &block)
-      raise ArgumentError, "expected either a value or a block" unless (values.length == 1) ^ block
+    class << self
+      ##
+      # takes either a value or a block and chooses the appropriate result
+      # container based on the type of the value or the type of the block's return
+      # value. If the type is an exception, it is wrapped in a
+      # `ShopifyCli::Result::Failure` and otherwise in a
+      # `ShopifyCli::Result::Success`. If a block was provided instead of value, a
+      # `Proc` is returned and the result wrapping doesn't occur until the block
+      # is invoked.
+      #
+      # #### Parameters
+      #
+      # * `*args` should be an `Array` with zero or one element
+      # * `&block` should be a `Proc` that takes zero or one argument
+      #
+      # #### Returns
+      #
+      # Returns either a `Result::Success`, `Result::Failure` or a `Proc` that
+      # produces one of the former when invoked.
+      #
+      # #### Examples
+      #
+      #   Result.wrap(1) # => ShopifyCli::Result::Success
+      #   Result.wrap(RuntimeError.new) # => ShopifyCli::Result::Failure
+      #
+      #   Result.wrap { 1 } # => Proc
+      #   Result.wrap { 1 }.call # => ShopifyCli::Result::Success
+      #   Result.wrap { raise }.call # => ShopifyCli::Result::Failure
+      #
+      #   Result.wrap { |s| s.upcase }.call("hello").tap do |result|
+      #     result # => Result::Success
+      #     result.value # => "HELLO"
+      #   end
+      #
+      ruby2_keywords def wrap(*values, &block)
+        raise ArgumentError, "expected either a value or a block" unless (values.length == 1) ^ block
 
-      if values.length == 1
-        values.pop.yield_self do |value|
-          case value
-          when Result::Success, Result::Failure
-            value
-          when NilClass, Exception
-            Result.failure(value)
-          else
-            Result.success(value)
-          end
-        end
-      else
-        ->(*args) do
-          begin
-            wrap(block.call(*args))
-          rescue Exception => error # rubocop:disable Lint/RescueException
-            wrap(error)
+        if values.length == 1
+          values.pop.yield_self do |value|
+            case value
+            when Result::Success, Result::Failure
+              value
+            when NilClass, Exception
+              Result.failure(value)
+            else
+              Result.success(value)
+            end
           end
+        else
+          ->(*args) do
+            begin
+              wrap(block.call(*args))
+            rescue Exception => error # rubocop:disable Lint/RescueException
+              wrap(error)
+            end
+          end.ruby2_keywords
         end
       end
-    end
 
-    ##
-    # Wraps the given block and invokes it with the passed arguments.
-    #
-    def self.call(*args, &block)
-      raise ArgumentError, "expected a block" unless block
-      wrap(&block).call(*args)
+      ##
+      # Wraps the given block and invokes it with the passed arguments.
+      #
+      ruby2_keywords def call(*args, &block)
+        raise ArgumentError, "expected a block" unless block
+        wrap(&block).call(*args)
+      end
     end
   end
 end

data/lib/shopify_cli/task.rb

@@ -2,9 +2,11 @@ require "shopify_cli"
 
 module ShopifyCLI
   class Task
-    def self.call(*args, **kwargs)
-      task = new
-      task.call(*args, **kwargs)
+    class << self
+      ruby2_keywords def call(*args)
+        task = new
+        task.call(*args)
+      end
     end
 
     private

data/lib/shopify_cli/theme/dev_server/hot-reload.js

@@ -15,9 +15,23 @@
     eventSource.onerror = () => eventSource.close();
   }
 
-  connect();
+  function reloadMode() {
+    var namespace = window.__SHOPIFY_CLI_ENV__;
+    return namespace.mode;
+  }
+
+  function isFullPageReloadMode(){
+    return reloadMode() === "full-page";
+  }
+
+  function isReloadModeActive(){
+    return reloadMode() !== "off";
+  }
 
   function isRefreshRequired(files) {
+    if (isFullPageReloadMode()) {
+      return true;
+    }
     return files.some((file) => !isCssFile(file) && !isSectionFile(file));
   }
 
@@ -119,4 +133,8 @@
       }
     }
   }
+
+  if (isReloadModeActive()) {
+    connect();
+  }
 })();

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

@@ -4,10 +4,11 @@ module ShopifyCLI
   module Theme
     module DevServer
       class HotReload
-        def initialize(ctx, app, theme:, watcher:, ignore_filter: nil)
+        def initialize(ctx, app, theme:, watcher:, mode:, ignore_filter: nil)
           @ctx = ctx
           @app = app
           @theme = theme
+          @mode = mode
           @streams = SSE::Streams.new
           @watcher = watcher
           @watcher.add_observer(self, :notify_streams_of_file_change)
@@ -48,12 +49,27 @@ module ShopifyCLI
 
         def inject_hot_reload_javascript(body)
           hot_reload_js = ::File.read("#{__dir__}/hot-reload.js")
-          hot_reload_script = "<script>\n#{hot_reload_js}</script>"
+          hot_reload_script = [
+            "<script>",
+            params_js,
+            hot_reload_js,
+            "</script>",
+          ].join("\n")
+
           body = body.join.gsub("</body>", "#{hot_reload_script}\n</body>")
 
           [body]
         end
 
+        def params_js
+          env = { mode: @mode }
+          <<~JS
+            (() => {
+              window.__SHOPIFY_CLI_ENV__ = #{env.to_json};
+            })();
+          JS
+        end
+
         def create_stream
           stream = @streams.new
 

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

@@ -18,6 +18,7 @@ module ShopifyCLI
         "trailer",
         "transfer-encoding",
         "upgrade",
+        "content-security-policy",
       ]
 
       class Proxy

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

@@ -6,6 +6,7 @@ require_relative "syncer"
 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 +26,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 +37,7 @@ 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 = HotReload.new(ctx, @app, theme: theme, watcher: watcher, mode: mode, ignore_filter: ignore_filter)
           stopped = false
           address = "http://#{host}:#{port}"
 
@@ -83,7 +84,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 +97,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/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.8.0"
+  VERSION = "2.10.2"
 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/system.rb

@@ -174,11 +174,16 @@ module CLI
         end
 
         def os
-          return :mac if /darwin/.match(RUBY_PLATFORM)
-          return :linux if /linux/.match(RUBY_PLATFORM)
-          return :windows if /mingw32/.match(RUBY_PLATFORM)
-
-          raise "Could not determine OS from platform #{RUBY_PLATFORM}"
+          @current_os ||= case RbConfig::CONFIG['host_os']
+          when /darwin/ then :mac
+          when /linux/ then :linux
+          else
+            if RUBY_PLATFORM !~ /cygwin/ && ENV['OS'] == 'Windows_NT'
+              :windows
+            else
+              raise "Could not determine OS from host_os #{RbConfig::CONFIG["host_os"]}"
+            end
+          end
         end
 
         private

data/vendor/deps/cli-ui/lib/cli/ui/os.rb

@@ -4,15 +4,17 @@ module CLI
       # Determines which OS is currently running the UI, to make it easier to
       # adapt its behaviour to the features of the OS.
       def self.current
-        @current_os ||= case RUBY_PLATFORM
+        @current_os ||= case RbConfig::CONFIG['host_os']
         when /darwin/
           Mac
         when /linux/
           Linux
-        when /mingw32/
-          Windows
         else
-          raise "Could not determine OS from platform #{RUBY_PLATFORM}"
+          if RUBY_PLATFORM !~ /cygwin/ && ENV['OS'] == 'Windows_NT'
+            Windows
+          else
+            raise "Could not determine OS from host_os #{RbConfig::CONFIG["host_os"]}"
+          end
         end
       end