discourse_theme 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b049cb77cb8542cd1991928a60dab7567f11e8a89c8c4ddaba8e297c05938f6c
-  data.tar.gz: c799d67427d340e1ce920c8deaebd9ae34b0af598905bf6176421ed816c3eade
+  metadata.gz: d0626e7865ec3b7d06ae9e198351dfd51f111897393bf393aa7da26b52c19777
+  data.tar.gz: 77856b459abd70854c9350960d98eb0887420222732390a22f4f52b69fbcd691
 SHA512:
-  metadata.gz: 6936df70b44ba83c191cb2b37a0897fa9caaf00614e3d1caa70d9f033e796eba29b8c9276e90ec8b9523af200d1f18b053c06957cefa3a6b3ab435a91b748c87
-  data.tar.gz: 0d7f183e24fb26fefed3000b4b7d681bfb51326dd1c7a9e5693fcc940dd077eb5bf31a79fa6ec287a76dd4989c60e135e3b23fb08dbce26a953aefd26d5486d4
+  metadata.gz: adf9a56c7ffb98ea9b14df04220096105c0b2e63074e4dc789984a1c9c01e6162b7118651cb9e1b95ed8a8c64740d97358d5c3fa7fb7614c3ca8416126c8d1dc
+  data.tar.gz: 1550d47250f811999035af55efc28dd3a081a22a5f9961a9e2fdfe9ee522a688de402064ed9df339a6c67395bf41ba6eb76b9db812d8bde4470f8dba8e178e40

data/lib/discourse_theme/cli.rb

@@ -1,38 +1,6 @@
 # frozen_string_literal: true
 module DiscourseTheme
   class Cli
-
-    @@prompt = ::TTY::Prompt.new(help_color: :cyan)
-    @@pastel = Pastel.new
-
-    def self.yes?(message)
-      @@prompt.yes?(@@pastel.cyan("? ") + message)
-    end
-
-    def self.ask(message, default: nil)
-      @@prompt.ask(@@pastel.cyan("? ") + message, default: default)
-    end
-
-    def self.select(message, options)
-      @@prompt.select(@@pastel.cyan("? ") + message, options)
-    end
-
-    def self.info(message)
-      puts @@pastel.blue("i ") + message
-    end
-
-    def self.progress(message)
-      puts @@pastel.yellow("» ") + message
-    end
-
-    def self.error(message)
-      puts @@pastel.red("✘ #{message}")
-    end
-
-    def self.success(message)
-      puts @@pastel.green("✔ #{message}")
-    end
-
     SETTINGS_FILE = File.expand_path("~/.discourse_theme")
 
     def usage
@@ -61,13 +29,12 @@ module DiscourseTheme
       components = settings.components
 
       if command == "new"
-        raise DiscourseTheme::ThemeError.new "'#{dir} is not empty" if Dir.exists?(dir) && !Dir.empty?(dir)
+        raise DiscourseTheme::ThemeError.new "'#{dir}' is not empty" if Dir.exists?(dir) && !Dir.empty?(dir)
+        raise DiscourseTheme::ThemeError.new "git is not installed" if !command?("git")
+        raise DiscourseTheme::ThemeError.new "yarn is not installed" if !command?("yarn")
+
         DiscourseTheme::Scaffold.generate(dir)
-        if Cli.yes?("Would you like to start 'watching' this theme?")
-          args[0] = "watch"
-          Cli.progress "Running discourse_theme #{args.join(' ')}"
-          run(args)
-        end
+        watch_theme?(args)
       elsif command == "watch"
         raise DiscourseTheme::ThemeError.new "'#{dir} does not exist" unless Dir.exists?(dir)
         client = DiscourseTheme::Client.new(dir, settings, reset: reset)
@@ -81,13 +48,13 @@ module DiscourseTheme
         options["Create and sync with a new theme"] = :create
         options["Select a different theme"] = :select
 
-        choice = Cli.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 = Cli.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
@@ -102,27 +69,26 @@ module DiscourseTheme
           options["Yes"] = :sync
           options["No"] = :none
           options = options.sort_by { |_, b| b == components.to_sym ? 0 : 1 }.to_h if components
-          choice = Cli.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)
 
-        Cli.progress "Uploading theme from #{dir}"
+        UI.progress "Uploading theme from #{dir}"
         settings.theme_id = theme_id = uploader.upload_full_theme
 
-        Cli.success "Theme uploaded (id:#{theme_id})"
-        Cli.info "Preview: #{client.root}/?preview_theme_id=#{theme_id}"
+        UI.success "Theme uploaded (id:#{theme_id})"
+        UI.info "Preview: #{client.root}/?preview_theme_id=#{theme_id}"
         if client.is_theme_creator
-          Cli.info "Manage: #{client.root}/my/themes"
+          UI.info "Manage: #{client.root}/my/themes"
         else
-          Cli.info "Manage: #{client.root}/admin/customize/themes/#{theme_id}"
+          UI.info "Manage: #{client.root}/admin/customize/themes/#{theme_id}"
         end
         watcher = DiscourseTheme::Watcher.new(dir: dir, uploader: uploader)
 
-        Cli.progress "Watching for changes in #{dir}..."
+        UI.progress "Watching for changes in #{dir}..."
         watcher.watch
-
       elsif command == "download"
         client = DiscourseTheme::Client.new(dir, settings, reset: reset)
         downloader = DiscourseTheme::Downloader.new(dir: dir, client: client)
@@ -130,33 +96,51 @@ module DiscourseTheme
         FileUtils.mkdir_p dir unless Dir.exists?(dir)
         raise DiscourseTheme::ThemeError.new "'#{dir} is not empty" unless Dir.empty?(dir)
 
-        Cli.progress "Loading theme list..."
+        UI.progress "Loading theme list..."
         themes = render_theme_list(client.get_themes_list)
 
-        choice = Cli.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)
 
-        Cli.progress "Downloading theme into #{dir}"
+        UI.progress "Downloading theme into #{dir}"
 
         downloader.download_theme(theme_id)
         settings.theme_id = theme_id
 
-        Cli.success "Theme downloaded"
+        UI.success "Theme downloaded"
 
-        if Cli.yes?("Would you like to start 'watching' this theme?")
-          args[0] = "watch"
-          Cli.progress "Running discourse_theme #{args.join(' ')}"
-          run(args)
-        end
+        watch_theme?(args)
       else
         usage
       end
 
-      Cli.progress "Exiting..."
+      UI.progress "Exiting..."
     rescue DiscourseTheme::ThemeError => e
-      Cli.error "#{e.message}"
+      UI.error "#{e.message}"
     rescue Interrupt, TTY::Reader::InputInterrupt => e
-      Cli.error "Interrupted"
+      UI.error "Interrupted"
+    end
+
+    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)
+        end
+      end
+
+      false
+    end
+
+    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(' ')}"
+        run(args)
+      end
     end
 
     def render_theme_list(themes)

data/lib/discourse_theme/client.rb

@@ -14,8 +14,8 @@ module DiscourseTheme
       @is_theme_creator = !!(THEME_CREATOR_REGEX =~ @url)
 
       if !self.class.has_needed_version?(discourse_version, "2.3.0.beta1")
-        Cli.info "discourse_theme is designed for Discourse 2.3.0.beta1 or above"
-        Cli.info "download will not function, and syncing destination will be unpredictable"
+        UI.info "discourse_theme is designed for Discourse 2.3.0.beta1 or above"
+        UI.info "download will not function, and syncing destination will be unpredictable"
       end
     end
 
@@ -105,7 +105,7 @@ module DiscourseTheme
     end
 
     def root
-      @url
+      URI.parse(@url).path
     end
 
     def is_theme_creator
@@ -116,6 +116,12 @@ module DiscourseTheme
 
     def request(request, never_404: false)
       uri = URI.parse(@url)
+
+      if uri.userinfo
+        username, password = uri.userinfo.split(":", 2)
+        request.basic_auth username, password
+      end
+
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = URI::HTTPS === uri
       add_headers(request)
@@ -142,26 +148,26 @@ module DiscourseTheme
     def guess_url(settings)
       url = ENV['DISCOURSE_URL']
       if url
-        Cli.progress "Using #{url} from DISCOURSE_URL"
+        UI.progress "Using #{url} from DISCOURSE_URL"
       end
 
       if !url && settings.url
         url = settings.url
-        Cli.progress "Using #{url} from #{DiscourseTheme::Cli::SETTINGS_FILE}"
+        UI.progress "Using #{url} from #{DiscourseTheme::Cli::SETTINGS_FILE}"
       end
 
       if !url || @reset
-        url = Cli.ask("What is the root URL of your Discourse site?", default: url).strip
+        url = UI.ask("What is the root URL of your Discourse site?", default: url).strip
         url = "http://#{url}" unless url =~ /^https?:\/\//
 
         # maybe this is an HTTPS redirect
         uri = URI.parse(url)
         if URI::HTTP === uri && uri.port == 80 && is_https_redirect?(url)
-          Cli.info "Detected that #{url} should be accessed over https"
+          UI.info "Detected that #{url} should be accessed over https"
           url = url.sub("http", "https")
         end
 
-        if Cli.yes?("Would you like this site name stored in #{DiscourseTheme::Cli::SETTINGS_FILE}?")
+        if UI.yes?("Would you like this site name stored in #{DiscourseTheme::Cli::SETTINGS_FILE}?")
           settings.url = url
         else
           settings.url = nil
@@ -174,17 +180,17 @@ module DiscourseTheme
     def guess_api_key(settings)
       api_key = ENV['DISCOURSE_API_KEY']
       if api_key
-        Cli.progress "Using api key from DISCOURSE_API_KEY"
+        UI.progress "Using api key from DISCOURSE_API_KEY"
       end
 
       if !api_key && settings.api_key
         api_key = settings.api_key
-        Cli.progress "Using api key from #{DiscourseTheme::Cli::SETTINGS_FILE}"
+        UI.progress "Using api key from #{DiscourseTheme::Cli::SETTINGS_FILE}"
       end
 
       if !api_key || @reset
-        api_key = Cli.ask("What is your API key?", default: api_key).strip
-        if Cli.yes?("Would you like this API key stored in #{DiscourseTheme::Cli::SETTINGS_FILE}?")
+        api_key = UI.ask("What is your API key?", default: api_key).strip
+        if UI.yes?("Would you like this API key stored in #{DiscourseTheme::Cli::SETTINGS_FILE}?")
           settings.api_key = api_key
         else
           settings.api_key = nil

data/lib/discourse_theme/scaffold.rb

@@ -1,75 +1,143 @@
 # frozen_string_literal: true
+
+require 'json'
+
 module DiscourseTheme
   class Scaffold
 
     BLANK_FILES = %w{
       common/common.scss
-      common/header.html
-      common/after_header.html
-      common/footer.html
-      common/head_tag.html
-      common/body_tag.html
-      common/embedded.scss
-
-      desktop/desktop.scss
-      desktop/header.html
-      desktop/after_header.html
-      desktop/footer.html
-      desktop/head_tag.html
-      desktop/body_tag.html
-
-      mobile/mobile.scss
-      mobile/header.html
-      mobile/after_header.html
-      mobile/footer.html
-      mobile/head_tag.html
-      mobile/body_tag.html
-
-      locales/en.yml
 
       settings.yml
     }
 
-    ABOUT_JSON = <<~STR
-    {
-      "name": "#NAME#",
-      "about_url": null,
-      "license_url": null,
-      "assets": {
-      },
-      "color_schemes": {
-      }
+    ABOUT_JSON = {
+      about_url: nil,
+      license_url: nil,
+      assets: {}
     }
-  STR
 
     HELP = <<~STR
       Are you a bit lost? Be sure to read https://meta.discourse.org/t/how-to-develop-custom-themes/60848
     STR
 
     GIT_IGNORE = <<~STR
-    .discourse-site
-    HELP
-  STR
+      .discourse-site
+      node_modules
+      HELP
+    STR
+
+    API_INITIALIZER = <<~STR
+      import { apiInitializer } from "discourse/lib/api";
+
+      export default apiInitializer("0.11.1", api => {
+        console.log("hello world from api initializer!");
+      });
+    STR
+
+    PACKAGE_JSON = <<~STR
+      {
+        "author": "#AUTHOR",
+        "license": "MIT",
+        "devDependencies": {
+          "eslint-config-discourse": "latest"
+        }
+      }
+    STR
+
+    ESLINT_RC = <<~STR
+      {
+        "extends": "eslint-config-discourse"
+      }
+    STR
+
+    TEMPLATE_LINT_RC = <<~STR
+      module.exports = {
+        plugins: ["ember-template-lint-plugin-discourse"],
+        extends: "discourse:recommended",
+      };
+    STR
+
+    EN_YML = <<~YAML
+      en:
+        theme_metadata:
+          description: "#DESCRIPTION"
+    YAML
 
     def self.generate(dir)
-      Cli.progress "Generating a scaffold theme at #{dir}"
+      UI.progress "Generating a scaffold theme at #{dir}"
 
-      name = Cli.ask("What would you like to call your theme?").strip
+      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
+
+      is_component = UI.yes?("Is this a component?")
 
       FileUtils.mkdir_p dir
       Dir.chdir dir do
-        File.write('about.json', ABOUT_JSON.sub("#NAME#", name))
+        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
+
+        description = UI.ask("How would you describe this theme?").to_s.strip
+
+        UI.info "Creating about.json"
+        about_template = ABOUT_JSON.dup
+        about_template[:name] = name
+        if is_component
+          about_template[:component] = true
+        else
+          about_template[:color_schemes] = {}
+        end
+        File.write('about.json', JSON.pretty_generate(about_template))
+
+        UI.info "Creating HELP"
         File.write('HELP', HELP)
+
+        UI.info "Creating package.json"
+        File.write('package.json', PACKAGE_JSON.sub("#AUTHOR", author))
+
+        UI.info "Creating .template-lintrc.js"
+        File.write('.template-lintrc.js', TEMPLATE_LINT_RC)
+
+        UI.info "Creating .eslintrc"
+        File.write('.eslintrc', ESLINT_RC)
+
+        UI.info "Creating .gitignore"
         File.write('.gitignore', GIT_IGNORE)
 
+        locale = "locales/en.yml"
+        UI.info "Creating #{locale}"
+        FileUtils.mkdir_p(File.dirname(locale))
+        File.write(locale, EN_YML.sub("#DESCRIPTION", description))
+
+        encoded_name = name.downcase.gsub(/[^\w_-]+/, '_')
+        initializer = "javascripts/discourse/api-initializers/#{encoded_name}.js"
+        UI.info "Creating #{initializer}"
+        FileUtils.mkdir_p(File.dirname(initializer))
+        File.write(initializer, API_INITIALIZER)
+
         BLANK_FILES.each do |f|
-          Cli.info "Creating #{f}"
+          UI.info "Creating #{f}"
           FileUtils.mkdir_p File.dirname(f)
           FileUtils.touch f
         end
 
-        Cli.info "Initializing git repo"
-        puts `git init .`
+        UI.info "Initializing git repo"
+        puts `git init . --initial-branch=main`
+
+        UI.info "Installing dependencies"
+        puts `yarn`
       end
     end
   end

data/lib/discourse_theme/ui.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module DiscourseTheme
+  class UI
+    @@prompt = ::TTY::Prompt.new(help_color: :cyan)
+    @@pastel = Pastel.new
+
+    def self.yes?(message)
+      @@prompt.yes?(@@pastel.cyan("? ") + message)
+    end
+
+    def self.ask(message, default: nil)
+      @@prompt.ask(@@pastel.cyan("? ") + message, default: default)
+    end
+
+    def self.select(message, options)
+      @@prompt.select(@@pastel.cyan("? ") + message, options)
+    end
+
+    def self.info(message)
+      puts @@pastel.blue("i ") + message
+    end
+
+    def self.progress(message)
+      puts @@pastel.yellow("» ") + message
+    end
+
+    def self.error(message)
+      puts @@pastel.red("✘ #{message}")
+    end
+
+    def self.success(message)
+      puts @@pastel.green("✔ #{message}")
+    end
+  end
+end

data/lib/discourse_theme/uploader.rb

@@ -34,9 +34,9 @@ module DiscourseTheme
       json["theme"]["theme_fields"].each do |row|
         if (error = row["error"]) && error.length > 0
           count += 1
-          Cli.error ""
-          Cli.error "Error in #{row["target"]} #{row["name"]}: #{row["error"]}"
-          Cli.error ""
+          UI.error ""
+          UI.error "Error in #{row["target"]} #{row["name"]}: #{row["error"]}"
+          UI.error ""
         end
       end
       count
@@ -59,7 +59,7 @@ module DiscourseTheme
       response = @client.update_theme(@theme_id, args)
       json = JSON.parse(response.body)
         if diagnose_errors(json) != 0
-          Cli.error "(end of errors)"
+          UI.error "(end of errors)"
         end
     end
 
@@ -73,7 +73,7 @@ module DiscourseTheme
         json = JSON.parse(response.body)
         @theme_id = json["theme"]["id"]
         if diagnose_errors(json) != 0
-          Cli.error "(end of errors)"
+          UI.error "(end of errors)"
         end
         @theme_id
       end

data/lib/discourse_theme/version.rb

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

data/lib/discourse_theme/watcher.rb

@@ -23,7 +23,7 @@ module DiscourseTheme
               (resolved = resolve_file(modified[0]))
 
             target, name, type_id = resolved
-            Cli.progress "Fast updating #{target}.scss"
+            UI.progress "Fast updating #{target}.scss"
 
             @uploader.upload_theme_field(
               target: target,
@@ -34,17 +34,17 @@ module DiscourseTheme
           else
             count = modified.length + added.length + removed.length
             if count > 1
-              Cli.progress "Detected changes in #{count} files, uploading theme"
+              UI.progress "Detected changes in #{count} files, uploading theme"
             else
               filename = modified[0] || added[0] || removed[0]
-              Cli.progress "Detected changes in #{filename.gsub(@dir, '')}, uploading theme"
+              UI.progress "Detected changes in #{filename.gsub(@dir, '')}, uploading theme"
             end
             @uploader.upload_full_theme
           end
-          Cli.success "Done! Watching for changes..."
+          UI.success "Done! Watching for changes..."
         rescue DiscourseTheme::ThemeError => e
-          Cli.error "#{e.message}"
-          Cli.progress "Watching for changes..."
+          UI.error "#{e.message}"
+          UI.progress "Watching for changes..."
         end
       end
 

data/lib/discourse_theme.rb

@@ -14,14 +14,15 @@ require 'json'
 require 'yaml'
 require 'tty/prompt'
 
-require 'discourse_theme/version'
-require 'discourse_theme/config'
-require 'discourse_theme/cli'
-require 'discourse_theme/client'
-require 'discourse_theme/downloader'
-require 'discourse_theme/uploader'
-require 'discourse_theme/watcher'
-require '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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_theme
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -217,6 +217,7 @@ files:
 - lib/discourse_theme/config.rb
 - lib/discourse_theme/downloader.rb
 - lib/discourse_theme/scaffold.rb
+- lib/discourse_theme/ui.rb
 - lib/discourse_theme/uploader.rb
 - lib/discourse_theme/version.rb
 - lib/discourse_theme/watcher.rb
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: CLI helper for creating Discourse themes