discourse_theme 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8115db0a38be583770d879d2c54bf167e27d1f05582ec38144c8598d1b3111d8
-  data.tar.gz: 1963461e7ea2b640514b2ef049ee968d619fc6163c67e0e039969fbe04db23d1
+  metadata.gz: ea250fe17a63ff7c35463db99c6e18a8d19d64445f38a3e572b0897547f903d7
+  data.tar.gz: b3e938ab61da639be2d4e2fdb7928925c78374f9840548ec6ba1aaa1eedcc3da
 SHA512:
-  metadata.gz: c4e0de4798c6667049fbcd3ad97e50f17d3677972d269916f7fa11e0e4a3d310373a6eb58242dad20d3b7fec4f1de4c0b3c255fed30fe0b15e89dce9cac723d8
-  data.tar.gz: e70dad03335fb5dcd6c2f3a074d4e0aca04aba798fc31bc52c9a6137b8422f46da12a1497543d104767907473b6e5e411cd592e41e68a218112873bb5c619107
+  metadata.gz: 8d5cc920192553d7502846f375c6042e613c425eac2f9f20f578d99cbec9d75aa118944965a43a9710b861e3277d2becdbbaafc93e431de4bdbf34b55f95df0c
+  data.tar.gz: e2642e70c461e25d4c4343f0b2865b390db2424918d3339800b0226e8657f55ec17a6e083c72ba843058d9b3e9893d2cf8ae74b52f64672c02f8dcfc63e316ca

data/.github/workflows/ci.yml

@@ -13,7 +13,6 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - "2.7"
           - "3.0"
           - "3.1"
           - "3.2"
@@ -30,6 +29,11 @@ jobs:
       - name: Lint
         run: bundle exec rubocop
 
+      - name: syntax_tree
+        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
 

data/.rubocop.yml

@@ -1,5 +1,5 @@
 inherit_gem:
-  rubocop-discourse: default.yml
+  rubocop-discourse: stree-compat.yml
 inherit_mode:
   merge:
     - Exclude

data/.streerc

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

data/CHANGELOG.md

@@ -5,6 +5,20 @@ 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).
 
+## [0.9.1] - 2023-10-06
+
+### Fixed
+
+- `rspec` command saving settings using wrong dir
+
+## [0.9.0] - 2023-09-27
+
+### Added
+
+- Added the `rspec` command to the CLI to support running RSpec system tests for a theme using either a Docker container
+  running the `discourse/discourse_test` image or a local Discourse development environment. See 100f320847a22e11c145886588fac04479c143bb and
+  c0c920280bef7869f0515f5e4220cf5cd3e408ef for more details.
+
 ## [0.7.6] - 2023-09-16
 
 ### Fixed

data/README.md

@@ -36,6 +36,21 @@ Monitors a theme or component for changes. When changed the program will synchro
 
 Uploads a theme to the server. Requires the theme to have been previously synchronized via `watch`.
 
+### `discourse_theme rspec PATH`
+
+Runs the [RSpec](https://rspec.info/) system tests under the `spec` folder in the designated theme directory.
+
+On the first run for the given directory, you will be asked if you'll like to use a local Discourse repository to run the tests.
+
+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.
+
+When the `--headless` option is used, a local installation of the [Google Chrome browser](https://www.google.com/chrome/) is required.
+
+Run `discourse_theme --help` for more usage details.
+
 ## Contributing
 
 Bug reports and pull requests are welcome at [Meta Discourse](https://meta.discourse.org). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/discourse_theme.gemspec

@@ -5,39 +5,41 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "discourse_theme/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "discourse_theme"
-  spec.version       = DiscourseTheme::VERSION
-  spec.authors       = ["Sam Saffron"]
-  spec.email         = ["sam.saffron@gmail.com"]
-
-  spec.summary       = %q{CLI helper for creating Discourse themes}
-  spec.description   = %q{CLI helper for creating Discourse themes}
-  spec.homepage      = "https://github.com/discourse/discourse_theme"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.name = "discourse_theme"
+  spec.version = DiscourseTheme::VERSION
+  spec.authors = ["Sam Saffron"]
+  spec.email = ["sam.saffron@gmail.com"]
+
+  spec.summary = "CLI helper for creating Discourse themes"
+  spec.description = "CLI helper for creating Discourse themes"
+  spec.homepage = "https://github.com/discourse/discourse_theme"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.add_runtime_dependency "minitar", "~> 0.6"
   spec.add_runtime_dependency "listen", "~> 3.1"
   spec.add_runtime_dependency "multipart-post", "~> 2.0"
   spec.add_runtime_dependency "tty-prompt", "~> 0.18"
   spec.add_runtime_dependency "rubyzip", "~> 1.2"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "guard", "~> 2.14"
-  spec.add_development_dependency "guard-minitest", "~> 2.4"
-  spec.add_development_dependency "webmock", "~> 3.17"
+  spec.add_runtime_dependency "selenium-webdriver", "> 4.11"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  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 "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

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+
+require_relative "cli_commands/rspec"
 module DiscourseTheme
   class Cli
     @@cli_settings_filename = File.expand_path("~/.discourse_theme")
@@ -12,14 +14,25 @@ module DiscourseTheme
     end
 
     def usage
-      puts "Usage: discourse_theme COMMAND [--reset]"
-      puts
-      puts "discourse_theme new DIR - Creates a new theme in the designated directory"
-      puts "discourse_theme download DIR - Downloads a theme from the server and stores in the designated directory"
-      puts "discourse_theme upload DIR - Uploads the theme directory to Discourse"
-      puts "discourse_theme watch DIR - Watches the theme directory and synchronizes with Discourse"
-      puts
-      puts "Use --reset to change the configuration for a directory"
+      puts <<~USAGE
+      Usage: discourse_theme COMMAND [DIR] [OPTIONS]
+
+      Commands:
+        new DIR               - Creates a new theme in the specified directory.
+        download DIR          - Downloads a theme from the server and stores it in the specified directory.
+        upload DIR            - Uploads the theme from the specified directory to Discourse.
+        watch DIR             - Watches the theme in the specified directory and synchronizes any changes with Discourse.
+        rspec DIR [OPTIONS]   - Runs the RSpec tests in the specified directory. The tests can be run using a local Discourse repository or a Docker container.
+          --headless          - Runs the RSpec system type tests in headless mode. Applies to both modes.
+
+          If specified directory has been configured to run in a Docker container, the additional options are supported.
+          --rebuild           - Forces a rebuilds of Docker container.
+          --verbose           - Runs the command to prepare the Docker container in verbose mode.
+
+      Global Options:
+        --reset               - Resets the configuration for the specified directory.
+      USAGE
+
       exit 1
     end
 
@@ -38,7 +51,9 @@ module DiscourseTheme
       components = settings.components
 
       if command == "new"
-        raise DiscourseTheme::ThemeError.new "'#{dir}' is not empty" if Dir.exist?(dir) && !Dir.empty?(dir)
+        if Dir.exist?(dir) && !Dir.empty?(dir)
+          raise DiscourseTheme::ThemeError.new "'#{dir}' is not empty"
+        end
         raise DiscourseTheme::ThemeError.new "git is not installed" if !command?("git")
         raise DiscourseTheme::ThemeError.new "yarn is not installed" if !command?("yarn")
 
@@ -57,18 +72,23 @@ module DiscourseTheme
         options["Create and sync with a new theme"] = :create
         options["Select a different theme"] = :select
 
-        choice = UI.select('How would you like to sync this theme?', options.keys)
+        choice = UI.select("How would you like to sync this theme?", options.keys)
 
         if options[choice] == :create
           theme_id = nil
         elsif options[choice] == :select
           themes = render_theme_list(theme_list)
-          choice = UI.select('Which theme would you like to sync with?', themes)
+          choice = UI.select("Which theme would you like to sync with?", themes)
           theme_id = extract_theme_id(choice)
           theme = theme_list.find { |t| t["id"] == theme_id }
         end
 
-        about_json = JSON.parse(File.read(File.join(dir, 'about.json'))) rescue nil
+        about_json =
+          begin
+            JSON.parse(File.read(File.join(dir, "about.json")))
+          rescue StandardError
+            nil
+          end
         already_uploaded = !!theme
         is_component = theme&.[]("component")
         component_count = about_json&.[]("components")&.length || 0
@@ -78,11 +98,17 @@ module DiscourseTheme
           options["Yes"] = :sync
           options["No"] = :none
           options = options.sort_by { |_, b| b == components.to_sym ? 0 : 1 }.to_h if components
-          choice = UI.select('Would you like to update child theme components?', options.keys)
+          choice = UI.select("Would you like to update child theme components?", options.keys)
           settings.components = components = options[choice].to_s
         end
 
-        uploader = DiscourseTheme::Uploader.new(dir: dir, client: client, theme_id: theme_id, components: components)
+        uploader =
+          DiscourseTheme::Uploader.new(
+            dir: dir,
+            client: client,
+            theme_id: theme_id,
+            components: components,
+          )
 
         UI.progress "Uploading theme from #{dir}"
         settings.theme_id = theme_id = uploader.upload_full_theme
@@ -111,7 +137,7 @@ module DiscourseTheme
         UI.progress "Loading theme list..."
         themes = render_theme_list(client.get_themes_list)
 
-        choice = UI.select('Which theme would you like to download?', themes)
+        choice = UI.select("Which theme would you like to download?", themes)
         theme_id = extract_theme_id(choice)
 
         UI.progress "Downloading theme into #{dir}"
@@ -124,15 +150,25 @@ module DiscourseTheme
         watch_theme?(args)
       elsif command == "upload"
         raise DiscourseTheme::ThemeError.new "'#{dir} does not exist" unless Dir.exist?(dir)
-        raise DiscourseTheme::ThemeError.new "No theme_id is set, please sync via the 'watch' command initially" if theme_id == 0
+        if theme_id == 0
+          raise DiscourseTheme::ThemeError.new "No theme_id is set, please sync via the 'watch' command initially"
+        end
         client = DiscourseTheme::Client.new(dir, settings, reset: reset)
 
         theme_list = client.get_themes_list
 
         theme = theme_list.find { |t| t["id"] == theme_id }
-        raise DiscourseTheme::ThemeError.new "theme_id is set, but the theme does not exist in Discourse" unless theme
+        unless theme
+          raise DiscourseTheme::ThemeError.new "theme_id is set, but the theme does not exist in Discourse"
+        end
 
-        uploader = DiscourseTheme::Uploader.new(dir: dir, client: client, theme_id: theme_id, components: components)
+        uploader =
+          DiscourseTheme::Uploader.new(
+            dir: dir,
+            client: client,
+            theme_id: theme_id,
+            components: components,
+          )
 
         UI.progress "Uploading theme (id:#{theme_id}) from #{dir} "
         settings.theme_id = theme_id = uploader.upload_full_theme
@@ -144,6 +180,13 @@ module DiscourseTheme
         else
           UI.info "Manage: #{client.root}/admin/customize/themes/#{theme_id}"
         end
+      elsif command == "rspec"
+        DiscourseTheme::CliCommands::Rspec.run(
+          settings: config[dir.split("/spec")[0]],
+          dir: dir,
+          args: args,
+          reset: reset,
+        )
       else
         usage
       end
@@ -158,13 +201,15 @@ module DiscourseTheme
     private
 
     def command?(cmd)
-      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each do |ext|
-          exe = File.join(path, "#{cmd}#{ext}")
-          return true if File.executable?(exe) && !File.directory?(exe)
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      ENV["PATH"]
+        .split(File::PATH_SEPARATOR)
+        .each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return true if File.executable?(exe) && !File.directory?(exe)
+          end
         end
-      end
 
       false
     end
@@ -172,14 +217,16 @@ module DiscourseTheme
     def watch_theme?(args)
       if UI.yes?("Would you like to start 'watching' this theme?")
         args[0] = "watch"
-        UI.progress "Running discourse_theme #{args.join(' ')}"
+        UI.progress "Running discourse_theme #{args.join(" ")}"
         run(args)
       end
     end
 
     def render_theme_list(themes)
-      themes.sort_by { |t| t["updated_at"] }
-        .reverse.map { |theme| "#{theme["name"]} (id:#{theme["id"]})" }
+      themes
+        .sort_by { |t| t["updated_at"] }
+        .reverse
+        .map { |theme| "#{theme["name"]} (id:#{theme["id"]})" }
     end
 
     def extract_theme_id(rendered_name)

data/lib/discourse_theme/cli_commands/rspec.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require "selenium-webdriver"
+
+module DiscourseTheme
+  module CliCommands
+    class Rspec
+      DISCOURSE_TEST_DOCKER_CONTAINER_NAME_PREFIX = "discourse_theme_test"
+      DISCOURSE_THEME_TEST_TMP_DIR = "/tmp/.discourse_theme_test"
+      SELENIUM_HEADLESS_ENV = "SELENIUM_HEADLESS=0"
+
+      class << self
+        def discourse_test_docker_container_name
+          "#{DISCOURSE_TEST_DOCKER_CONTAINER_NAME_PREFIX}_#{DiscourseTheme::VERSION}"
+        end
+
+        def run(settings:, dir:, args:, reset: false)
+          settings.local_discourse_directory = nil if reset
+
+          spec_path = "/spec"
+          index = dir.index(spec_path)
+
+          if index
+            spec_path = dir[index..-1]
+            dir = dir[0..index - 1]
+          end
+
+          spec_directory = File.join(dir, "/spec")
+
+          unless Dir.exist?(spec_directory)
+            raise DiscourseTheme::ThemeError.new "'#{spec_directory} does not exist"
+          end
+
+          configure_local_directory(settings)
+
+          headless = !!args.delete("--headless")
+
+          if settings.local_discourse_directory.empty?
+            run_tests_with_docker(
+              File.basename(dir),
+              spec_directory,
+              spec_path,
+              headless: headless,
+              verbose: !!args.delete("--verbose"),
+              rebuild: !!args.delete("--rebuild"),
+            )
+          else
+            run_tests_locally(
+              settings.local_discourse_directory,
+              spec_directory,
+              headless: headless,
+            )
+          end
+        end
+
+        private
+
+        def execute(command:, message: nil, exit_on_error: true, stream: false)
+          UI.progress(message) if message
+
+          success = false
+          output = +""
+
+          Open3.popen2e(command) do |stdin, stdout_and_stderr, wait_thr|
+            Thread.new do
+              stdout_and_stderr.each do |line|
+                puts line if stream
+                output << line
+              end
+            end
+
+            exit_status = wait_thr.value
+            success = exit_status.success?
+
+            unless success
+              UI.error "Error occured while running: `#{command}`:\n\n#{output}" unless stream
+              exit 1 if exit_on_error
+            end
+          end
+
+          output
+        end
+
+        def run_tests_locally(local_directory, spec_path, headless: false)
+          UI.progress(
+            "Running RSpec tests using local Discourse repository located at '#{local_directory}'...",
+          )
+
+          Kernel.exec(
+            ENV,
+            "cd #{local_directory} && #{headless ? SELENIUM_HEADLESS_ENV : ""} bundle exec rspec #{spec_path}",
+          )
+        end
+
+        def run_tests_with_docker(
+          theme_directory_name,
+          spec_directory,
+          spec_path,
+          headless: false,
+          verbose: false,
+          rebuild: false
+        )
+          image = "discourse/discourse_test:release"
+          UI.progress("Running RSpec tests using '#{image}' Docker image...")
+
+          unless Dir.exist?(DISCOURSE_THEME_TEST_TMP_DIR)
+            FileUtils.mkdir_p DISCOURSE_THEME_TEST_TMP_DIR
+          end
+
+          # Checks if the container is running
+          container_name = discourse_test_docker_container_name
+          is_running = false
+
+          if !(
+               output =
+                 execute(
+                   command: "docker ps -a --filter name=#{container_name} --format '{{json .}}'",
+                 )
+             ).empty?
+            is_running = JSON.parse(output)["State"] == "running"
+          end
+
+          if !is_running || rebuild
+            # Stop older versions of Docker container
+            existing_docker_container_ids =
+              execute(
+                command:
+                  "docker ps -a -q --filter name=#{DISCOURSE_TEST_DOCKER_CONTAINER_NAME_PREFIX}",
+              ).split("\n").join(" ")
+
+            if !existing_docker_container_ids.empty?
+              execute(command: "docker stop #{existing_docker_container_ids}")
+              execute(command: "docker rm -f #{existing_docker_container_ids}")
+            end
+
+            execute(
+              command: <<~CMD.squeeze(" "),
+              docker run -d \
+                -p 31337:31337 \
+                --add-host host.docker.internal:host-gateway \
+                --entrypoint=/sbin/boot \
+                --name=#{container_name} \
+                --pull=always \
+                -v #{DISCOURSE_THEME_TEST_TMP_DIR}:/tmp \
+                #{image}
+            CMD
+              message: "Creating #{image} Docker container...",
+              stream: verbose,
+            )
+
+            execute(
+              command:
+                "docker exec -u discourse:discourse #{container_name} ruby script/docker_test.rb --no-tests --checkout-ref origin/tests-passed",
+              message: "Checking out latest Discourse source code...",
+              stream: verbose,
+            )
+
+            execute(
+              command:
+                "docker exec -e SKIP_MULTISITE=1 -u discourse:discourse #{container_name} bundle exec rake docker:test:setup",
+              message: "Setting up Discourse test environment...",
+              stream: verbose,
+            )
+
+            execute(
+              command: "docker exec -u discourse:discourse #{container_name} bin/ember-cli --build",
+              message: "Building Ember CLI assets...",
+              stream: verbose,
+            )
+          end
+
+          rspec_envs = []
+
+          if headless
+            container_ip =
+              execute(
+                command:
+                  "docker inspect #{container_name} --format '{{.NetworkSettings.IPAddress}}'",
+              ).chomp("\n")
+
+            service =
+              start_chromedriver(allowed_origin: "host.docker.internal", allowed_ip: container_ip)
+
+            rspec_envs.push(SELENIUM_HEADLESS_ENV)
+            rspec_envs.push("CAPYBARA_SERVER_HOST=0.0.0.0")
+            rspec_envs.push(
+              "CAPYBARA_REMOTE_DRIVER_URL=http://host.docker.internal:#{service.uri.port}",
+            )
+          end
+
+          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))
+
+            execute(
+              command:
+                "docker exec #{rspec_envs} -t -u discourse:discourse #{container_name} bundle exec rspec #{File.join("/tmp", theme_directory_name, spec_path)}".squeeze(
+                  " ",
+                ),
+              stream: true,
+            )
+          ensure
+            FileUtils.rm_rf(File.join(tmp_theme_directory, "/spec"))
+          end
+        end
+
+        def configure_local_directory(settings)
+          return if settings.local_discourse_directory_configured?
+
+          should_configure_local_directory =
+            UI.yes?(
+              "Would you like to configure a local Discourse repository used to run the RSpec tests? If you select 'n', the tests will be run using a Docker container.",
+            )
+
+          if should_configure_local_directory
+            local_discourse_directory =
+              UI.ask("Please enter the path to the local Discourse directory:")
+
+            unless Dir.exist?(local_discourse_directory)
+              raise DiscourseTheme::ThemeError.new "'#{local_discourse_directory} does not exist"
+            end
+
+            unless File.exist?("#{local_discourse_directory}/lib/discourse.rb")
+              raise DiscourseTheme::ThemeError.new "'#{local_discourse_directory} is not a Discourse repository"
+            end
+
+            settings.local_discourse_directory = local_discourse_directory
+          else
+            settings.local_discourse_directory = ""
+          end
+        end
+
+        def start_chromedriver(allowed_ip:, allowed_origin:)
+          service = Selenium::WebDriver::Service.chrome
+          options = Selenium::WebDriver::Options.chrome
+          service.executable_path = Selenium::WebDriver::DriverFinder.path(options, service.class)
+          service.args = ["--allowed-ips=#{allowed_ip}", "--allowed-origins=#{allowed_origin}"]
+          service.launch
+        end
+      end
+    end
+  end
+end

data/lib/discourse_theme/client.rb

@@ -44,7 +44,15 @@ module DiscourseTheme
     end
 
     def get_themes_list
-      endpoint = root + (@is_theme_creator ? "/user_themes.json" : "/admin/customize/themes.json")
+      endpoint =
+        root +
+          (
+            if @is_theme_creator
+              "/user_themes.json"
+            else
+              "/admin/customize/themes.json"
+            end
+          )
 
       response = request(Net::HTTP::Get.new(endpoint), never_404: true)
       json = JSON.parse(response.body)
@@ -54,7 +62,13 @@ module DiscourseTheme
     def get_raw_theme_export(id)
       endpoint =
         root +
-          (@is_theme_creator ? "/user_themes/#{id}/export" : "/admin/customize/themes/#{id}/export")
+          (
+            if @is_theme_creator
+              "/user_themes/#{id}/export"
+            else
+              "/admin/customize/themes/#{id}/export"
+            end
+          )
 
       response = request(Net::HTTP::Get.new endpoint)
       raise "Error downloading theme: #{response.code}" unless response.code.to_i == 200
@@ -72,7 +86,14 @@ module DiscourseTheme
 
     def upload_full_theme(tgz, theme_id:, components:)
       endpoint =
-        root + (@is_theme_creator ? "/user_themes/import.json" : "/admin/themes/import.json")
+        root +
+          (
+            if @is_theme_creator
+              "/user_themes/import.json"
+            else
+              "/admin/themes/import.json"
+            end
+          )
 
       post =
         Net::HTTP::Post::Multipart.new(

data/lib/discourse_theme/config.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 class DiscourseTheme::Config
-
   class PathSetting
     def initialize(config, path)
       @config = config
@@ -39,6 +38,18 @@ class DiscourseTheme::Config
       set("components", val)
     end
 
+    def local_discourse_directory_configured?
+      !safe_config["local_discourse_directory"].nil?
+    end
+
+    def local_discourse_directory
+      safe_config["local_discourse_directory"]
+    end
+
+    def local_discourse_directory=(dir)
+      set("local_discourse_directory", dir)
+    end
+
     protected
 
     def set(name, val)
@@ -79,7 +90,7 @@ class DiscourseTheme::Config
       begin
         @raw_config = YAML.load_file(@filename)
         raise unless Hash === @raw_config
-      rescue
+      rescue StandardError
         @raw_config = {}
         $stderr.puts "ERROR: #{@filename} contains invalid config, resetting"
       end

data/lib/discourse_theme/downloader.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
-require 'zip'
+require "zip"
 
 class DiscourseTheme::Downloader
-
   def initialize(dir:, client:)
     @dir = dir
     @client = client
@@ -26,7 +25,7 @@ class DiscourseTheme::Downloader
 
       # Minitar extracts into a sub directory, move all the files up one dir
       Dir.chdir(@dir) do
-        folders = Dir.glob('*/')
+        folders = Dir.glob("*/")
         raise "Extraction failed" unless folders.length == 1
         FileUtils.mv(Dir.glob("#{folders[0]}*"), "./")
         FileUtils.remove_dir(folders[0])
@@ -37,8 +36,6 @@ class DiscourseTheme::Downloader
   private
 
   def add_headers(request)
-    if @is_theme_creator
-      request["User-Api-Key"] = @api_key
-    end
+    request["User-Api-Key"] = @api_key if @is_theme_creator
   end
 end

data/lib/discourse_theme/scaffold.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'json'
+require "date"
+require "json"
 
 module DiscourseTheme
   class Scaffold
-
     ABOUT_JSON = {
       about_url: "TODO: Put your theme's public repo or Meta topic URL here",
       license_url: "TODO: Put your theme's LICENSE URL here",
-      assets: {}
+      assets: {
+      },
     }
 
     HELP = <<~STR
@@ -93,27 +93,29 @@ module DiscourseTheme
     def self.generate(dir)
       UI.progress "Generating a scaffold theme at #{dir}"
 
-      name = loop do
-        input = UI.ask("What would you like to call your theme?").to_s.strip
-        if input.empty?
-          UI.error("Theme name cannot be empty")
-        else
-          break input
+      name =
+        loop do
+          input = UI.ask("What would you like to call your theme?").to_s.strip
+          if input.empty?
+            UI.error("Theme name cannot be empty")
+          else
+            break input
+          end
         end
-      end
 
       is_component = UI.yes?("Is this a component?")
 
       FileUtils.mkdir_p dir
       Dir.chdir dir do
-        author = loop do
-          input = UI.ask("Who is authoring the theme?", default: ENV['USER']).to_s.strip
-          if input.empty?
-            UI.error("Author cannot be empty")
-          else
-            break input
+        author =
+          loop do
+            input = UI.ask("Who is authoring the theme?", default: ENV["USER"]).to_s.strip
+            if input.empty?
+              UI.error("Author cannot be empty")
+            else
+              break input
+            end
           end
-        end
 
         description = UI.ask("How would you describe this theme?").to_s.strip
 
@@ -125,19 +127,19 @@ module DiscourseTheme
           about_template[:color_schemes] = {}
         end
 
-        encoded_name = name.downcase.gsub(/[^a-zA-Z0-9_-]+/, '_')
-
-        write('about.json', JSON.pretty_generate(about_template))
-        write('HELP', HELP)
-        write('LICENSE', LICENSE.sub("#YEAR", "#{Date.today.year}").sub("#AUTHOR", author))
-        write('.eslintrc', ESLINT_RC)
-        write('.gitignore', GIT_IGNORE)
-        write('.template-lintrc.js', TEMPLATE_LINT_RC)
-        write('package.json', PACKAGE_JSON.sub("#AUTHOR", author))
-        write('settings.yml', SETTINGS_YML)
-        write('common/common.scss', '')
+        encoded_name = name.downcase.gsub(/[^a-zA-Z0-9_-]+/, "_")
+
+        write("about.json", JSON.pretty_generate(about_template))
+        write("HELP", HELP)
+        write("LICENSE", LICENSE.sub("#YEAR", "#{Date.today.year}").sub("#AUTHOR", author))
+        write(".eslintrc", ESLINT_RC)
+        write(".gitignore", GIT_IGNORE)
+        write(".template-lintrc.js", TEMPLATE_LINT_RC)
+        write("package.json", PACKAGE_JSON.sub("#AUTHOR", author))
+        write("settings.yml", SETTINGS_YML)
+        write("common/common.scss", "")
         write("javascripts/discourse/api-initializers/#{encoded_name}.js", API_INITIALIZER)
-        write('locales/en.yml', EN_YML.sub("#DESCRIPTION", description))
+        write("locales/en.yml", EN_YML.sub("#DESCRIPTION", description))
 
         UI.info "Initializing git repo"
         puts `git init && git symbolic-ref HEAD refs/heads/main`

data/lib/discourse_theme/uploader.rb

@@ -9,13 +9,13 @@ module DiscourseTheme
     end
 
     def compress_dir(gzip, dir)
-      sgz = Zlib::GzipWriter.new(File.open(gzip, 'wb'))
+      sgz = Zlib::GzipWriter.new(File.open(gzip, "wb"))
       tar = Archive::Tar::Minitar::Output.new(sgz)
 
       Dir.chdir(dir + "/../") do
         Find.find(File.basename(dir)) do |x|
           bn = File.basename(x)
-          Find.prune if bn == "node_modules" || bn == "src" || bn[0] == ?.
+          Find.prune if bn == "node_modules" || bn == "src" || bn[0] == "."
           next if File.directory?(x)
 
           Minitar.pack_file(x, tar)
@@ -39,25 +39,18 @@ module DiscourseTheme
       count
     end
 
-    def upload_theme_field(target: , name: , type_id: , value:)
+    def upload_theme_field(target:, name:, type_id:, value:)
       raise "expecting theme_id to be set!" unless @theme_id
 
       args = {
         theme: {
-          theme_fields: [{
-            name: name,
-            target: target,
-            type_id: type_id,
-            value: value
-          }]
-        }
+          theme_fields: [{ name: name, target: target, type_id: type_id, value: value }],
+        },
       }
 
       response = @client.update_theme(@theme_id, args)
       json = JSON.parse(response.body)
-        if diagnose_errors(json) != 0
-          UI.error "(end of errors)"
-        end
+      UI.error "(end of errors)" if diagnose_errors(json) != 0
     end
 
     def upload_full_theme
@@ -69,14 +62,11 @@ module DiscourseTheme
 
         json = JSON.parse(response.body)
         @theme_id = json["theme"]["id"]
-        if diagnose_errors(json) != 0
-          UI.error "(end of errors)"
-        end
+        UI.error "(end of errors)" if diagnose_errors(json) != 0
         @theme_id
       end
     ensure
       FileUtils.rm_f filename
     end
-
   end
 end

data/lib/discourse_theme/version.rb

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

data/lib/discourse_theme/watcher.rb

@@ -15,38 +15,36 @@ module DiscourseTheme
     end
 
     def watch
-      listener = Listen.to(@dir) do |modified, added, removed|
-        begin
-          if modified.length == 1 &&
-              added.length == 0 &&
-              removed.length == 0 &&
-              (resolved = resolve_file(modified[0]))
+      listener =
+        Listen.to(@dir) do |modified, added, removed|
+          begin
+            if modified.length == 1 && added.length == 0 && removed.length == 0 &&
+                 (resolved = resolve_file(modified[0]))
+              target, name, type_id = resolved
+              UI.progress "Fast updating #{target}.scss"
 
-            target, name, type_id = resolved
-            UI.progress "Fast updating #{target}.scss"
-
-            @uploader.upload_theme_field(
-              target: target,
-              name: name,
-              value: File.read(modified[0]),
-              type_id: type_id
-            )
-          else
-            count = modified.length + added.length + removed.length
-            if count > 1
-              UI.progress "Detected changes in #{count} files, uploading theme"
+              @uploader.upload_theme_field(
+                target: target,
+                name: name,
+                value: File.read(modified[0]),
+                type_id: type_id,
+              )
             else
-              filename = modified[0] || added[0] || removed[0]
-              UI.progress "Detected changes in #{filename.gsub(@dir, '')}, uploading theme"
+              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
-            @uploader.upload_full_theme
+            UI.success "Done! Watching for changes..."
+          rescue DiscourseTheme::ThemeError => e
+            UI.error "#{e.message}"
+            UI.progress "Watching for changes..."
           end
-          UI.success "Done! Watching for changes..."
-        rescue DiscourseTheme::ThemeError => e
-          UI.error "#{e.message}"
-          UI.progress "Watching for changes..."
         end
-      end
 
       listener.start
       sleep unless self.class.return_immediately?
@@ -60,10 +58,10 @@ module DiscourseTheme
 
       target, file = name.split("/")
 
-      if ["common", "desktop", "mobile"].include?(target)
+      if %w[common desktop mobile].include?(target)
         if file == "#{target}.scss"
           # a CSS file
-          return [target, "scss", 1]
+          return target, "scss", 1
         end
       end
 

data/lib/discourse_theme.rb

@@ -1,29 +1,30 @@
 # frozen_string_literal: true
-require 'fileutils'
-require 'pathname'
-require 'tempfile'
-require 'securerandom'
-require 'minitar'
-require 'zlib'
-require 'find'
-require 'net/http'
-require 'net/http/post/multipart'
-require 'uri'
-require 'listen'
-require 'json'
-require 'yaml'
-require 'tty/prompt'
+require "fileutils"
+require "pathname"
+require "tempfile"
+require "securerandom"
+require "minitar"
+require "zlib"
+require "find"
+require "net/http"
+require "net/http/post/multipart"
+require "uri"
+require "listen"
+require "json"
+require "yaml"
+require "tty/prompt"
 
-require_relative 'discourse_theme/version'
-require_relative 'discourse_theme/config'
-require_relative 'discourse_theme/ui'
-require_relative 'discourse_theme/cli'
-require_relative 'discourse_theme/client'
-require_relative 'discourse_theme/downloader'
-require_relative 'discourse_theme/uploader'
-require_relative 'discourse_theme/watcher'
-require_relative 'discourse_theme/scaffold'
+require_relative "discourse_theme/version"
+require_relative "discourse_theme/config"
+require_relative "discourse_theme/ui"
+require_relative "discourse_theme/cli"
+require_relative "discourse_theme/client"
+require_relative "discourse_theme/downloader"
+require_relative "discourse_theme/uploader"
+require_relative "discourse_theme/watcher"
+require_relative "discourse_theme/scaffold"
 
 module DiscourseTheme
-  class ThemeError < StandardError; end
+  class ThemeError < StandardError
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_theme
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -80,90 +80,104 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  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: 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CLI helper for creating Discourse themes
 email:
 - sam.saffron@gmail.com
@@ -217,6 +273,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".streerc"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -228,6 +285,7 @@ files:
 - discourse_theme.gemspec
 - lib/discourse_theme.rb
 - lib/discourse_theme/cli.rb
+- lib/discourse_theme/cli_commands/rspec.rb
 - lib/discourse_theme/client.rb
 - lib/discourse_theme/config.rb
 - lib/discourse_theme/downloader.rb
@@ -248,7 +306,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="