discourse_theme 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3352f4282ac30c46402e5cdf6f7c9ba504e7c8b5980884e4a42b700eef3e90
-  data.tar.gz: b13f657e0e023c3a6bee4eca8dc3a9090c55333f444bc5b9a55d67781baac017
+  metadata.gz: 418652d7c45d966814257d956464454ae771dba99d94156a322ad38c76200580
+  data.tar.gz: 31ae03c9cc2ad4c858a2666bf59da8a38102078c77cb631fa612de8ef405dfe4
 SHA512:
-  metadata.gz: 9900153835d064382bdde7fbd395345a66cdeb5bd4b5df85f825c2d8ac12556bc4c329d56bd91030a5efae836c567db79ab219d7276d3e5cef784e51aedeba82
-  data.tar.gz: 26aec19d02acf892b7f5434ec7f141c1afa7e3d8e099917e40d15cafa6d8a2ff27a7076769eaa6319b44d0d46a4561d12374fa295929b140e2e0938789334792
+  metadata.gz: baeefaa0afe4afd2b880a2f01235f004e4921185854d5bd35d92b032c2a69c680967a91fdd97164078cfff2ead4ad88caa55ed0ed23f547883b544c55839e876
+  data.tar.gz: f731b2771c1e225291dab344601e3aa5724094d3370e3600fd81cfb4df2f93cdf2775892008438b6edd609b1b9e080f5becbc98438f9c729101cef781e2ee0d9

data/.github/workflows/ci.yml

@@ -13,12 +13,12 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - "3.0"
           - "3.1"
           - "3.2"
+          - "3.3"
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
@@ -33,7 +33,6 @@ jobs:
         run: |
           bundle exec stree check Gemfile $(git ls-files '*.rb') $(git ls-files '*.rake') $(git ls-files '*.thor')
 
-
       - name: Tests
         run: bundle exec rake test
 
@@ -43,10 +42,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2
+        uses: discourse/publish-rubygems-action@v3
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           GIT_EMAIL: team@discourse.org

data/.streerc

@@ -1,2 +1,2 @@
 --print-width=100
---plugins=plugin/trailing_comma,disable_ternary
+--plugins=plugin/trailing_comma,plugin/disable_auto_ternary

data/CHANGELOG.md

@@ -5,6 +5,17 @@ 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).
 
+## [2.0.0] - 2024-01-31
+
+### Added
+
+- `watch` command for `discourse_theme` will prompt user if pending theme migrations should be run (#40)
+
+### Removed
+
+- Remove upload theme migrations prompt to `watch` command for `discourse_theme` CLI previously added in #38. Theme migrations
+  files are always uploaded going forward.
+
 ## [1.1.0] - 2024-01-10
 
 ### Added

data/README.md

@@ -45,7 +45,7 @@ On the first run for the given directory, you will be asked if you'll like to us
 If you select 'Y' and proceeds to configure the path to the local Discourse repository, the tests will be ran using the local Discourse development environment provided by the local Discourse repository. Note that you'll have to set up the local test environment before
 the tests can be ran successfully.
 
-If the 'n' option is selected, the tests will run in a Docker container created using the [`discourse/discours_test:release`](https://hub.docker.com/r/discourse/discourse_test) Docker image. Note that this requires [Docker](https://docs.docker.com/engine/install/) to be installed.
+If the 'n' option is selected, the tests will run in a Docker container created using the [`discourse/discourse_test:release`](https://hub.docker.com/r/discourse/discourse_test) Docker image. Note that this requires [Docker](https://docs.docker.com/engine/install/) to be installed.
 
 When the `--headless` option is used, a local installation of the [Google Chrome browser](https://www.google.com/chrome/) is required.
 

data/bin/discourse_theme

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/discourse_theme'
+require_relative "../lib/discourse_theme"
 
 DiscourseTheme::Cli.new.run(ARGV)

data/discourse_theme.gemspec

@@ -36,10 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "rubocop-discourse"
+  spec.add_development_dependency "rubocop-discourse", "~> 3.6.0"
   spec.add_development_dependency "m"
   spec.add_development_dependency "syntax_tree"
-  spec.add_development_dependency "syntax_tree-disable_ternary"
   spec.add_development_dependency "mocha"
 end

data/lib/discourse_theme/cli.rb

@@ -36,7 +36,7 @@ module DiscourseTheme
       exit 1
     end
 
-    def run(args, &block)
+    def run(args)
       usage unless args[1]
 
       reset = !!args.delete("--reset")
@@ -116,7 +116,7 @@ module DiscourseTheme
         UI.progress "Uploading theme from #{dir}"
 
         settings.theme_id =
-          theme_id = uploader.upload_full_theme(ignore_files: ignored_migrations(theme, dir))
+          theme_id = uploader.upload_full_theme(skip_migrations: skip_migrations(theme, dir))
 
         UI.success "Theme uploaded (id:#{theme_id})"
         UI.info "Preview: #{client.url}/?preview_theme_id=#{theme_id}"
@@ -131,7 +131,7 @@ module DiscourseTheme
 
         watcher = DiscourseTheme::Watcher.new(dir: dir, uploader: uploader)
         UI.progress "Watching for changes in #{dir}..."
-        watcher.watch(&block)
+        watcher.watch
       elsif command == "download"
         client = DiscourseTheme::Client.new(dir, settings, reset: reset)
         downloader = DiscourseTheme::Downloader.new(dir: dir, client: client)
@@ -205,40 +205,41 @@ module DiscourseTheme
 
     private
 
-    def ignored_migrations(theme, dir)
-      return [] unless theme && Dir.exist?(File.join(dir, "migrations"))
+    def skip_migrations(theme, dir)
+      return true unless theme && Dir.exist?(File.join(dir, "migrations"))
 
-      existing_migrations =
+      migrated_migrations =
         theme
           .dig("theme_fields")
           &.filter_map do |theme_field|
-            theme_field["name"] if theme_field["target"] == "migrations"
+            if theme_field["target"] == "migrations" && theme_field["migrated"] == true
+              theme_field["name"]
+            end
           end || []
 
-      new_migrations =
+      pending_migrations =
         Dir["#{dir}/migrations/**/*.js"]
           .reject do |f|
-            existing_migrations.any? do |existing_migration|
+            migrated_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 }
+      return true if pending_migrations.empty?
+
+      options = { "No" => :no, "Yes" => :yes }
 
-        choice = UI.select(<<~TEXT, options.keys)
-        Would you like to upload and run the following pending theme migration(s): #{new_migrations.join(", ")}
+      choice = UI.select(<<~TEXT, options.keys)
+        Would you like to run the following pending theme migration(s): #{pending_migrations.join(", ")}
+          Select 'No' if you are in the midst of adding or modifying theme migration(s).
         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
+      if options[choice] == :no
+        UI.warn "Pending theme migrations have not been run, run `discourse_theme upload #{dir}` if you wish to run the theme migrations."
+        true
       else
-        []
+        false
       end
     end
 

data/lib/discourse_theme/cli_commands/rspec.rb

@@ -73,7 +73,7 @@ module DiscourseTheme
             success = exit_status.success?
 
             unless success
-              UI.error "Error occured while running: `#{command}`:\n\n#{output}" unless stream
+              UI.error "Error occurred while running: `#{command}`:\n\n#{output}" unless stream
               exit 1 if exit_on_error
             end
           end

data/lib/discourse_theme/client.rb

@@ -84,7 +84,7 @@ module DiscourseTheme
       request(put)
     end
 
-    def upload_full_theme(tgz, theme_id:, components:)
+    def upload_full_theme(tgz, theme_id:, components:, skip_migrations: false)
       endpoint =
         root +
           (
@@ -95,13 +95,15 @@ module DiscourseTheme
             end
           )
 
-      post =
-        Net::HTTP::Post::Multipart.new(
-          endpoint,
-          "theme_id" => theme_id,
-          "components" => components,
-          "bundle" => UploadIO.new(tgz, "application/tar+gzip", "bundle.tar.gz"),
-        )
+      params = {
+        "theme_id" => theme_id,
+        "components" => components,
+        "bundle" => UploadIO.new(tgz, "application/tar+gzip", "bundle.tar.gz"),
+      }
+
+      params["skip_migrations"] = true if skip_migrations
+
+      post = Net::HTTP::Post::Multipart.new(endpoint, params)
       request(post)
     end
 

data/lib/discourse_theme/uploader.rb

@@ -1,20 +1,6 @@
 # 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
@@ -67,27 +53,19 @@ module DiscourseTheme
       UI.error "(end of errors)" if diagnose_errors(json) != 0
     end
 
-    def upload_full_theme(ignore_files: [])
+    def upload_full_theme(skip_migrations: false)
       filename = "#{Pathname.new(Dir.tmpdir).realpath}/bundle_#{SecureRandom.hex}.tar.gz"
-      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)
+      compress_dir(filename, @dir)
 
       File.open(filename) do |tgz|
-        response = @client.upload_full_theme(tgz, theme_id: @theme_id, components: @components)
+        response =
+          @client.upload_full_theme(
+            tgz,
+            theme_id: @theme_id,
+            components: @components,
+            skip_migrations: skip_migrations,
+          )
 
         json = JSON.parse(response.body)
         @theme_id = json["theme"]["id"]
@@ -95,7 +73,6 @@ module DiscourseTheme
         @theme_id
       end
     ensure
-      FileUtils.rm_rf(temp_dir) if temp_dir
       FileUtils.rm_f(filename)
     end
   end

data/lib/discourse_theme/version.rb

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

data/lib/discourse_theme/watcher.rb

@@ -1,33 +1,14 @@
 # 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
@@ -35,9 +16,7 @@ module DiscourseTheme
 
     def watch
       listener =
-        Listen.to(@dir, ignore: LISTEN_IGNORE_PATTERNS) do |modified, added, removed|
-          yield(modified, added, removed) if block_given?
-
+        Listen.to(@dir) do |modified, added, removed|
           begin
             if modified.length == 1 && added.length == 0 && removed.length == 0 &&
                  (resolved = resolve_file(modified[0]))
@@ -60,7 +39,7 @@ module DiscourseTheme
                 UI.progress "Detected changes in #{filename.gsub(@dir, "")}, uploading theme"
               end
 
-              @uploader.upload_full_theme
+              @uploader.upload_full_theme(skip_migrations: true)
             end
             UI.success "Done! Watching for changes..."
           rescue DiscourseTheme::ThemeError => e
@@ -70,8 +49,7 @@ module DiscourseTheme
         end
 
       listener.start
-      self.class.call_start_subscribers
-      sleep 1 while !self.class.return_immediately?
+      sleep if !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.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sam Saffron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -178,34 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: m
   requirement: !ruby/object:Gem::Requirement
@@ -234,20 +220,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: syntax_tree-disable_ternary
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -298,7 +270,7 @@ homepage: https://github.com/discourse/discourse_theme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -313,8 +285,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: CLI helper for creating Discourse themes
 test_files: []