discourse_theme 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc25d48532311173b00bda69ffeb62ac04ada54bee21d428f7b1402a73715915
-  data.tar.gz: 6c96df10a9701d44e2124a9efde5421c4fd96a2b9be060a33c6ea24c0293c203
+  metadata.gz: 1e3352f4282ac30c46402e5cdf6f7c9ba504e7c8b5980884e4a42b700eef3e90
+  data.tar.gz: b13f657e0e023c3a6bee4eca8dc3a9090c55333f444bc5b9a55d67781baac017
 SHA512:
-  metadata.gz: 37c3272d730598d0931372ff5cee3ac6dee268e1b21dbadac8eae774976268f06cb81f141d6eb85d1d0b5cd3e27751723190200b16160c7ea8c752ef882972d0
-  data.tar.gz: 266dafc9e80dee4994b827a0cb9518b009dc2e3cbf5a996b5e70d5494e38548070e3cae107b193eefb6f1e7cc30a14af42866df70c1b21f0e96b0e344c19444a
+  metadata.gz: 9900153835d064382bdde7fbd395345a66cdeb5bd4b5df85f825c2d8ac12556bc4c329d56bd91030a5efae836c567db79ab219d7276d3e5cef784e51aedeba82
+  data.tar.gz: 26aec19d02acf892b7f5434ec7f141c1afa7e3d8e099917e40d15cafa6d8a2ff27a7076769eaa6319b44d0d46a4561d12374fa295929b140e2e0938789334792

data/CHANGELOG.md

@@ -5,9 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2024-01-10
+
+### Added
+
+- Add upload theme migrations prompt to `watch` command for `discourse_theme` CLI (#38)
+
+## [1.0.2] - 2023-12-08
+
+### Fixed
+
+- `discourse_theme rspec` command using Docker container not copying theme to the right directory that is mounted inside
+  the Docker container.
+
 ## [1.0.1] - 2023-10-19
 
-## Fixed
+### Fixed
 
 - Spec path was not preserved when running rspec against a local Discourse repository.
 

data/lib/discourse_theme/cli.rb

@@ -36,7 +36,7 @@ module DiscourseTheme
       exit 1
     end
 
-    def run(args)
+    def run(args, &block)
       usage unless args[1]
 
       reset = !!args.delete("--reset")
@@ -66,9 +66,11 @@ module DiscourseTheme
         theme_list = client.get_themes_list
 
         options = {}
+
         if theme_id && theme = theme_list.find { |t| t["id"] == theme_id }
           options["Sync with existing theme: '#{theme["name"]}' (id:#{theme_id})"] = :default
         end
+
         options["Create and sync with a new theme"] = :create
         options["Select a different theme"] = :select
 
@@ -89,6 +91,7 @@ module DiscourseTheme
           rescue StandardError
             nil
           end
+
         already_uploaded = !!theme
         is_component = theme&.[]("component")
         component_count = about_json&.[]("components")&.length || 0
@@ -111,7 +114,9 @@ module DiscourseTheme
           )
 
         UI.progress "Uploading theme from #{dir}"
-        settings.theme_id = theme_id = uploader.upload_full_theme
+
+        settings.theme_id =
+          theme_id = uploader.upload_full_theme(ignore_files: ignored_migrations(theme, dir))
 
         UI.success "Theme uploaded (id:#{theme_id})"
         UI.info "Preview: #{client.url}/?preview_theme_id=#{theme_id}"
@@ -126,7 +131,7 @@ module DiscourseTheme
 
         watcher = DiscourseTheme::Watcher.new(dir: dir, uploader: uploader)
         UI.progress "Watching for changes in #{dir}..."
-        watcher.watch
+        watcher.watch(&block)
       elsif command == "download"
         client = DiscourseTheme::Client.new(dir, settings, reset: reset)
         downloader = DiscourseTheme::Downloader.new(dir: dir, client: client)
@@ -200,6 +205,43 @@ module DiscourseTheme
 
     private
 
+    def ignored_migrations(theme, dir)
+      return [] unless theme && Dir.exist?(File.join(dir, "migrations"))
+
+      existing_migrations =
+        theme
+          .dig("theme_fields")
+          &.filter_map do |theme_field|
+            theme_field["name"] if theme_field["target"] == "migrations"
+          end || []
+
+      new_migrations =
+        Dir["#{dir}/migrations/**/*.js"]
+          .reject do |f|
+            existing_migrations.any? do |existing_migration|
+              File.basename(f).include?(existing_migration)
+            end
+          end
+          .map { |f| Pathname.new(f).relative_path_from(Pathname.new(dir)).to_s }
+
+      if !new_migrations.empty?
+        options = { "Yes" => :yes, "No" => :no }
+
+        choice = UI.select(<<~TEXT, options.keys)
+        Would you like to upload and run the following pending theme migration(s): #{new_migrations.join(", ")}
+        TEXT
+
+        if options[choice] == :no
+          UI.warn "Pending theme migrations have not been uploaded, run `discourse_theme upload #{dir}` if you wish to upload and run the theme migrations."
+          new_migrations
+        else
+          []
+        end
+      else
+        []
+      end
+    end
+
     def command?(cmd)
       exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
       ENV["PATH"]

data/lib/discourse_theme/cli_commands/rspec.rb

@@ -37,7 +37,7 @@ module DiscourseTheme
 
           if settings.local_discourse_directory.empty?
             run_tests_with_docker(
-              File.basename(dir),
+              dir,
               spec_directory,
               spec_path,
               headless: headless,
@@ -93,13 +93,15 @@ module DiscourseTheme
         end
 
         def run_tests_with_docker(
-          theme_directory_name,
+          theme_directory,
           spec_directory,
           spec_path,
           headless: false,
           verbose: false,
           rebuild: false
         )
+          theme_directory_name = File.basename(theme_directory)
+
           image = "discourse/discourse_test:release"
           UI.progress("Running RSpec tests using '#{image}' Docker image...")
 
@@ -191,9 +193,7 @@ module DiscourseTheme
           rspec_envs = rspec_envs.map { |env| "-e #{env}" }.join(" ")
 
           begin
-            tmp_theme_directory = File.join(DISCOURSE_THEME_TEST_TMP_DIR, theme_directory_name)
-            FileUtils.mkdir_p(tmp_theme_directory) if !Dir.exist?(tmp_theme_directory)
-            FileUtils.cp_r(spec_directory, File.join(tmp_theme_directory))
+            FileUtils.cp_r(theme_directory, DISCOURSE_THEME_TEST_TMP_DIR)
 
             execute(
               command:
@@ -203,7 +203,7 @@ module DiscourseTheme
               stream: true,
             )
           ensure
-            FileUtils.rm_rf(File.join(tmp_theme_directory, "/spec"))
+            FileUtils.rm_rf(File.join(DISCOURSE_THEME_TEST_TMP_DIR, theme_directory_name))
           end
         end
 

data/lib/discourse_theme/ui.rb

@@ -28,6 +28,10 @@ module DiscourseTheme
       puts @@pastel.red("✘ #{message}")
     end
 
+    def self.warn(message)
+      puts @@pastel.yellow("⚠ #{message}")
+    end
+
     def self.success(message)
       puts @@pastel.green("✔ #{message}")
     end

data/lib/discourse_theme/uploader.rb

@@ -1,6 +1,20 @@
 # frozen_string_literal: true
 module DiscourseTheme
   class Uploader
+    def self.upload_full_theme_callbacks
+      @upload_callbacks ||= []
+    end
+
+    # Used in the test environment to register a callback that is called with the directory of the theme being uploaded.
+    def self.register_upload_full_theme_callback(&block)
+      self.upload_full_theme_callbacks << block
+    end
+
+    # Used in the test environment to clear the registered callbacks.
+    def self.reset_upload_full_theme_callbacks
+      self.upload_full_theme_callbacks.clear
+    end
+
     def initialize(dir:, client:, theme_id: nil, components: nil)
       @dir = dir
       @client = client
@@ -53,9 +67,24 @@ module DiscourseTheme
       UI.error "(end of errors)" if diagnose_errors(json) != 0
     end
 
-    def upload_full_theme
+    def upload_full_theme(ignore_files: [])
       filename = "#{Pathname.new(Dir.tmpdir).realpath}/bundle_#{SecureRandom.hex}.tar.gz"
-      compress_dir(filename, @dir)
+      temp_dir = nil
+
+      theme_dir =
+        if !ignore_files.empty?
+          temp_dir = Dir.mktmpdir
+          FileUtils.copy_entry(@dir, temp_dir)
+          dir_pathname = Pathname.new(@dir)
+          ignore_files.each { |file| FileUtils.rm_f(File.join(temp_dir, file)) }
+          temp_dir
+        else
+          @dir
+        end
+
+      self.class.upload_full_theme_callbacks.each { |cb| cb.call(theme_dir) }
+
+      compress_dir(filename, theme_dir)
 
       File.open(filename) do |tgz|
         response = @client.upload_full_theme(tgz, theme_id: @theme_id, components: @components)
@@ -66,7 +95,8 @@ module DiscourseTheme
         @theme_id
       end
     ensure
-      FileUtils.rm_f filename
+      FileUtils.rm_rf(temp_dir) if temp_dir
+      FileUtils.rm_f(filename)
     end
   end
 end

data/lib/discourse_theme/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DiscourseTheme
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/discourse_theme/watcher.rb

@@ -1,14 +1,33 @@
 # frozen_string_literal: true
 module DiscourseTheme
   class Watcher
+    LISTEN_IGNORE_PATTERNS = [%r{migrations/.+/.+\.js}]
+
     def self.return_immediately!
       @return_immediately = true
     end
 
+    def self.return_immediately=(val)
+      @return_immediately = val
+    end
+
     def self.return_immediately?
       !!@return_immediately
     end
 
+    def self.subscribe_start(&block)
+      @subscribers ||= []
+      @subscribers << block
+    end
+
+    def self.call_start_subscribers
+      @subscribers&.each(&:call)
+    end
+
+    def self.reset_start_subscribers
+      @subscribers = []
+    end
+
     def initialize(dir:, uploader:)
       @dir = dir
       @uploader = uploader
@@ -16,7 +35,9 @@ module DiscourseTheme
 
     def watch
       listener =
-        Listen.to(@dir) do |modified, added, removed|
+        Listen.to(@dir, ignore: LISTEN_IGNORE_PATTERNS) do |modified, added, removed|
+          yield(modified, added, removed) if block_given?
+
           begin
             if modified.length == 1 && added.length == 0 && removed.length == 0 &&
                  (resolved = resolve_file(modified[0]))
@@ -31,12 +52,14 @@ module DiscourseTheme
               )
             else
               count = modified.length + added.length + removed.length
+
               if count > 1
                 UI.progress "Detected changes in #{count} files, uploading theme"
               else
                 filename = modified[0] || added[0] || removed[0]
                 UI.progress "Detected changes in #{filename.gsub(@dir, "")}, uploading theme"
               end
+
               @uploader.upload_full_theme
             end
             UI.success "Done! Watching for changes..."
@@ -47,7 +70,8 @@ module DiscourseTheme
         end
 
       listener.start
-      sleep unless self.class.return_immediately?
+      self.class.call_start_subscribers
+      sleep 1 while !self.class.return_immediately?
     end
 
     protected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_theme
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar