discourse_theme 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa9710726909f2b5a1381132fb5e68748965bf8af6cf50893c013126e1c6db0d
-  data.tar.gz: 6446feb3d912101d7193a07776d4aa5dc476fd00ef649e7b4c94e10e1ac21b56
+  metadata.gz: 8115db0a38be583770d879d2c54bf167e27d1f05582ec38144c8598d1b3111d8
+  data.tar.gz: 1963461e7ea2b640514b2ef049ee968d619fc6163c67e0e039969fbe04db23d1
 SHA512:
-  metadata.gz: 72cead3a6060f62bc7e3fd225b82a98ee59e0852559506bcd2d5bd0f83196e4372ca1331c14654d51edc9ff20dad665a7c29777391db85789b4d6367b61a64ea
-  data.tar.gz: 65b6d6b3d547867b706be85beab21f7d2a47daa521e1b9a5dbd71420a80126a32740f8f3286d5c6ab5c52ee85b92ea9e71a7395def9f2ed8ec4d6bc6aa7f0959
+  metadata.gz: c4e0de4798c6667049fbcd3ad97e50f17d3677972d269916f7fa11e0e4a3d310373a6eb58242dad20d3b7fec4f1de4c0b3c255fed30fe0b15e89dce9cac723d8
+  data.tar.gz: e70dad03335fb5dcd6c2f3a074d4e0aca04aba798fc31bc52c9a6137b8422f46da12a1497543d104767907473b6e5e411cd592e41e68a218112873bb5c619107

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+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.7.6] - 2023-09-16
+
+### Fixed
+
+- Remove trailing slash when storing URL (#25)

data/lib/discourse_theme/client.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 module DiscourseTheme
   class Client
-    THEME_CREATOR_REGEX = /^https:\/\/(theme-creator\.discourse\.org|discourse\.theme-creator\.io)$/i
+    THEME_CREATOR_REGEX =
+      %r{^https://(theme-creator\.discourse\.org|discourse\.theme-creator\.io)$}i
 
     attr_reader :url
 
@@ -23,17 +24,17 @@ module DiscourseTheme
 
     # From https://github.com/discourse/discourse/blob/main/lib/version.rb
     def self.has_needed_version?(current, needed)
-      current_split = current.split('.')
-      needed_split = needed.split('.')
+      current_split = current.split(".")
+      needed_split = needed.split(".")
 
       (0..[current_split.size, needed_split.size].max).each do |idx|
-        current_str = current_split[idx] || ''
+        current_str = current_split[idx] || ""
 
-        c0 = (needed_split[idx] || '').sub('beta', '').to_i
-        c1 = (current_str || '').sub('beta', '').to_i
+        c0 = (needed_split[idx] || "").sub("beta", "").to_i
+        c1 = (current_str || "").sub("beta", "").to_i
 
         # beta is less than stable
-        return false if current_str.include?('beta') && (c0 == 0) && (c1 > 0)
+        return false if current_str.include?("beta") && (c0 == 0) && (c1 > 0)
 
         return true if c1 > c0
         return false if c0 > c1
@@ -43,12 +44,7 @@ module DiscourseTheme
     end
 
     def get_themes_list
-      endpoint = root +
-        if @is_theme_creator
-          "/user_themes.json"
-        else
-          "/admin/customize/themes.json"
-        end
+      endpoint = root + (@is_theme_creator ? "/user_themes.json" : "/admin/customize/themes.json")
 
       response = request(Net::HTTP::Get.new(endpoint), never_404: true)
       json = JSON.parse(response.body)
@@ -56,12 +52,9 @@ module DiscourseTheme
     end
 
     def get_raw_theme_export(id)
-      endpoint = root +
-        if @is_theme_creator
-          "/user_themes/#{id}/export"
-        else
-          "/admin/customize/themes/#{id}/export"
-        end
+      endpoint =
+        root +
+          (@is_theme_creator ? "/user_themes/#{id}/export" : "/admin/customize/themes/#{id}/export")
 
       response = request(Net::HTTP::Get.new endpoint)
       raise "Error downloading theme: #{response.code}" unless response.code.to_i == 200
@@ -70,32 +63,24 @@ module DiscourseTheme
     end
 
     def update_theme(id, args)
-      endpoint = root +
-        if @is_theme_creator
-          "/user_themes/#{id}"
-        else
-          "/admin/themes/#{id}"
-        end
+      endpoint = root + (@is_theme_creator ? "/user_themes/#{id}" : "/admin/themes/#{id}")
 
-      put = Net::HTTP::Put.new(endpoint, 'Content-Type' => 'application/json')
+      put = Net::HTTP::Put.new(endpoint, "Content-Type" => "application/json")
       put.body = args.to_json
       request(put)
     end
 
     def upload_full_theme(tgz, theme_id:, components:)
-      endpoint = root +
-        if @is_theme_creator
-          "/user_themes/import.json"
-        else
-          "/admin/themes/import.json"
-        end
-
-      post = Net::HTTP::Post::Multipart.new(
-        endpoint,
-        "theme_id" => theme_id,
-        "components" => components,
-        "bundle" => UploadIO.new(tgz, "application/tar+gzip", "bundle.tar.gz")
-      )
+      endpoint =
+        root + (@is_theme_creator ? "/user_themes/import.json" : "/admin/themes/import.json")
+
+      post =
+        Net::HTTP::Post::Multipart.new(
+          endpoint,
+          "theme_id" => theme_id,
+          "components" => components,
+          "bundle" => UploadIO.new(tgz, "application/tar+gzip", "bundle.tar.gz"),
+        )
       request(post)
     end
 
@@ -132,14 +117,21 @@ module DiscourseTheme
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = URI::HTTPS === uri
       add_headers(request)
-      http.request(request).tap do |response|
-        if response.code == '404' && never_404
-          raise DiscourseTheme::ThemeError.new "Error: Incorrect site URL, or API key does not have the correct privileges"
-        elsif !['200', '201'].include?(response.code)
-          errors = JSON.parse(response.body)["errors"].join(', ') rescue nil
-          raise DiscourseTheme::ThemeError.new "Error #{response.code} for #{request.path.split("?")[0]}#{(": " + errors) if errors}"
+      http
+        .request(request)
+        .tap do |response|
+          if response.code == "404" && never_404
+            raise DiscourseTheme::ThemeError.new "Error: Incorrect site URL, or API key does not have the correct privileges"
+          elsif !%w[200 201].include?(response.code)
+            errors =
+              begin
+                JSON.parse(response.body)["errors"].join(", ")
+              rescue StandardError
+                nil
+              end
+            raise DiscourseTheme::ThemeError.new "Error #{response.code} for #{request.path.split("?")[0]}#{(": " + errors) if errors}"
+          end
         end
-      end
     rescue Errno::ECONNREFUSED
       raise DiscourseTheme::ThemeError.new "Connection refused for #{request.path}"
     end
@@ -153,19 +145,17 @@ module DiscourseTheme
     end
 
     def guess_url(settings)
-      url = ENV['DISCOURSE_URL']
-      if url
-        UI.progress "Using #{url} from DISCOURSE_URL"
-      end
+      url = normalize_url(ENV["DISCOURSE_URL"])
+      UI.progress "Using #{url} from DISCOURSE_URL" if url
 
       if !url && settings.url
-        url = settings.url
+        url = normalize_url(settings.url)
         UI.progress "Using #{url} from #{DiscourseTheme::Cli.settings_file}"
       end
 
       if !url || @reset
-        url = UI.ask("What is the root URL of your Discourse site?", default: url).strip
-        url = "http://#{url}" unless url =~ /^https?:\/\//
+        url = normalize_url(UI.ask("What is the root URL of your Discourse site?", default: url))
+        url = "http://#{url}" unless url =~ %r{^https?://}
 
         # maybe this is an HTTPS redirect
         uri = URI.parse(url)
@@ -184,11 +174,13 @@ module DiscourseTheme
       url
     end
 
+    def normalize_url(url)
+      url&.strip&.chomp("/")
+    end
+
     def guess_api_key(settings)
-      api_key = ENV['DISCOURSE_API_KEY']
-      if api_key
-        UI.progress "Using api key from DISCOURSE_API_KEY"
-      end
+      api_key = ENV["DISCOURSE_API_KEY"]
+      UI.progress "Using api key from DISCOURSE_API_KEY" if api_key
 
       if !api_key && settings.api_key
         api_key = settings.api_key
@@ -213,8 +205,7 @@ module DiscourseTheme
       path = "/" if path.empty?
       req = Net::HTTP::Get.new("/")
       response = Net::HTTP.start(url.host, url.port) { |http| http.request(req) }
-      Net::HTTPRedirection === response && response['location'] =~ /^https/i
+      Net::HTTPRedirection === response && response["location"] =~ /^https/i
     end
-
   end
 end

data/lib/discourse_theme/scaffold.rb

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
+require 'date'
 require 'json'
 
 module DiscourseTheme
   class Scaffold
 
-    BLANK_FILES = %w{
-      common/common.scss
-
-      settings.yml
-    }
-
     ABOUT_JSON = {
-      about_url: nil,
-      license_url: nil,
+      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: {}
     }
 
@@ -21,6 +16,28 @@ module DiscourseTheme
       Are you a bit lost? Be sure to read https://meta.discourse.org/t/how-to-develop-custom-themes/60848
     STR
 
+    LICENSE = <<~STR
+      Copyright #YEAR #AUTHOR
+
+      Permission is hereby granted, free of charge, to any person obtaining a copy
+      of this software and associated documentation files (the "Software"), to deal
+      in the Software without restriction, including without limitation the rights
+      to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+      copies of the Software, and to permit persons to whom the Software is
+      furnished to do so, subject to the following conditions:
+
+      The above copyright notice and this permission notice shall be included in all
+      copies or substantial portions of the Software.
+
+      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+      IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+      FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+      AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+      LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+      OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+      SOFTWARE.
+    STR
+
     GIT_IGNORE = <<~STR
       .discourse-site
       node_modules
@@ -30,7 +47,7 @@ module DiscourseTheme
     API_INITIALIZER = <<~STR
       import { apiInitializer } from "discourse/lib/api";
 
-      export default apiInitializer("0.11.1", api => {
+      export default apiInitializer("1.8.0", (api) => {
         console.log("hello world from api initializer!");
       });
     STR
@@ -68,6 +85,11 @@ module DiscourseTheme
           description: "#DESCRIPTION"
     YAML
 
+    SETTINGS_YML = <<~YAML
+      todo_rename_and_use_setting:
+        default: ""
+    YAML
+
     def self.generate(dir)
       UI.progress "Generating a scaffold theme at #{dir}"
 
@@ -95,7 +117,6 @@ module DiscourseTheme
 
         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
@@ -103,46 +124,35 @@ module DiscourseTheme
         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(/[^a-zA-Z0-9_-]+/, '_')
-        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|
-          UI.info "Creating #{f}"
-          FileUtils.mkdir_p File.dirname(f)
-          FileUtils.touch f
-        end
+
+        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))
 
         UI.info "Initializing git repo"
-        puts `git init . --initial-branch=main`
+        puts `git init && git symbolic-ref HEAD refs/heads/main`
 
         UI.info "Installing dependencies"
         puts `yarn`
       end
     end
+
+    private
+
+    def self.write(filename, contents)
+      UI.info "Creating #{filename}"
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.write(filename, contents)
+    end
   end
 end

data/lib/discourse_theme/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_theme
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -217,6 +217,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile