discourse_theme 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb98d3753bcab52a2596dfa6923d790aa30ed28a20a7c6a8cd9f5b0bbf20507
-  data.tar.gz: 8e38ee9da80ea2a4ed63a9b4d9e57b48a20d85af3e196275026b94da7a8d308a
+  metadata.gz: de1cb65ed52d9dd44bbe0039b0a40f00f55897e68106d5193cfb0717937b4ff9
+  data.tar.gz: 8192308474973266925422876401c974c3daf0ffb331d7423ac06d2368c3db68
 SHA512:
-  metadata.gz: 3bb47c55cd4b039c6393428f099e79e1862aed8727edf1441506fd9d07028210f081b0e33fa3c3b7b987519aebc4dd34b646eb02586dcf1b305d0a967f11dbe8
-  data.tar.gz: 54f88f3057aa2e1935a07cfac8641defa0d77e6abfc446f5793e46450d853169b01c022624605f9db4d41eec7f85412a6419746d7da807403fbc6345dba1ed61
+  metadata.gz: 2dcbaf4918cf88082c27270a05e1fb888d5d2e462160834c7a2b82ab79acfb3eaf62d0732ea5da840f83d1656f36d6aadda4633cdec86b77149d57c5188c0514
+  data.tar.gz: 3c095bcfcc224691d30405353a06eb6ccf64446331175dc28e7f8eebf1347b8b2707c37313e1c29668a35937a4a550c8ef81bc2701201674a5baf8b525d72211

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  publish:
+    if: contains(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: CvX/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/README.md

@@ -1,6 +1,6 @@
 # Discourse Theme
 
-This CLI contains helpers for creating [Discourse themes](https://meta.discourse.org/c/theme).
+This CLI contains helpers for creating [Discourse themes](https://meta.discourse.org/c/theme) and theme components.
 
 ## Installation
 
@@ -10,7 +10,7 @@ To install the CLI use:
 
 ## Why this gem exists?
 
-This gem allows you to use your editor of choice when developing Discourse themes. As you save files the CLI will update the remote theme and changes to it will appear live!
+This gem allows you to use your editor of choice when developing Discourse themes and theme components. As you save files the CLI will update the remote theme or component and changes to it will appear live!
 
 ## Usage
 
@@ -24,7 +24,7 @@ it contains two helpers:
 
 You can use `discourse_theme new PATH` to crate a new blank theme, the CLI will guide you through the process.
 
-You can use `discourse_theme watch PATH` to monitor your theme for changes, when changed the program will synchronize the theme to your Discourse of choice.
+You can use `discourse_theme watch PATH` to monitor your theme or component for changes, when changed the program will synchronize the theme or component to your Discourse of choice.
 
 ## Contributing
 

data/discourse_theme.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "tty-prompt", "~> 0.18"
   spec.add_dependency "rubyzip", "~> 1.2"
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.6.0'
 end

data/lib/discourse_theme/cli.rb

@@ -57,6 +57,7 @@ module DiscourseTheme
       settings = config[dir]
 
       theme_id = settings.theme_id
+      components = settings.components
 
       if command == "new"
         raise DiscourseTheme::ThemeError.new "'#{dir} is not empty" if Dir.exists?(dir) && !Dir.empty?(dir)
@@ -87,14 +88,35 @@ module DiscourseTheme
           themes = render_theme_list(theme_list)
           choice = Cli.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
 
-        uploader = DiscourseTheme::Uploader.new(dir: dir, client: client, theme_id: theme_id)
+        about_json = JSON.parse(File.read(File.join(dir, 'about.json'))) rescue nil
+        already_uploaded = !!theme
+        is_component = theme&.[]("component")
+        component_count = about_json&.[]("components")&.length || 0
+
+        if !already_uploaded && !is_component && component_count > 0
+          options = {}
+          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)
+          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}"
         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}"
+        if client.is_theme_creator
+          Cli.info "Manage: #{client.root}/my/themes"
+        else
+          Cli.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}..."

data/lib/discourse_theme/client.rb

@@ -44,7 +44,7 @@ module DiscourseTheme
         if @is_theme_creator
           "/user_themes.json"
         else
-          "/admin/customize/themes.json?api_key=#{@api_key}"
+          "/admin/customize/themes.json"
         end
 
       response = request(Net::HTTP::Get.new(endpoint), never_404: true)
@@ -57,7 +57,7 @@ module DiscourseTheme
         if @is_theme_creator
           "/user_themes/#{id}/export"
         else
-          "/admin/customize/themes/#{id}/export?api_key=#{@api_key}"
+          "/admin/customize/themes/#{id}/export"
         end
 
       response = request(Net::HTTP::Get.new endpoint)
@@ -71,7 +71,7 @@ module DiscourseTheme
         if @is_theme_creator
           "/user_themes/#{id}"
         else
-          "/admin/themes/#{id}?api_key=#{@api_key}"
+          "/admin/themes/#{id}"
         end
 
       put = Net::HTTP::Put.new(endpoint, 'Content-Type' => 'application/json')
@@ -79,41 +79,40 @@ module DiscourseTheme
       request(put)
     end
 
-    def upload_full_theme(tgz, theme_id:)
+    def upload_full_theme(tgz, theme_id:, components:)
       endpoint = root +
         if @is_theme_creator
           "/user_themes/import.json"
         else
-          "/admin/themes/import.json?api_key=#{@api_key}"
+          "/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")
       )
       request(post)
     end
 
     def discourse_version
-      endpoint = root +
-        if @is_theme_creator
-          "/about.json"
-        else
-          "/about.json?api_key=#{@api_key}"
-        end
-
+      endpoint = "#{root}/about.json"
       response = request(Net::HTTP::Get.new(endpoint), never_404: true)
       json = JSON.parse(response.body)
       json["about"]["version"]
     end
 
-    private
-
     def root
       @url
     end
 
+    def is_theme_creator
+      @is_theme_creator
+    end
+
+    private
+
     def request(request, never_404: false)
       uri = URI.parse(@url)
       http = Net::HTTP.new(uri.host, uri.port)
@@ -134,6 +133,8 @@ module DiscourseTheme
     def add_headers(request)
       if @is_theme_creator
         request["User-Api-Key"] = @api_key
+      else
+        request["Api-Key"] = @api_key
       end
     end
 

data/lib/discourse_theme/config.rb

@@ -30,6 +30,14 @@ class DiscourseTheme::Config
       set("theme_id", theme_id.to_i)
     end
 
+    def components
+      safe_config["components"]
+    end
+
+    def components=(val)
+      set("components", val)
+    end
+
     protected
 
     def set(name, val)

data/lib/discourse_theme/uploader.rb

@@ -3,10 +3,11 @@ module DiscourseTheme
 
     THEME_CREATOR_REGEX = /^https:\/\/theme-creator.discourse.org$/i
 
-    def initialize(dir:, client:, theme_id: nil)
+    def initialize(dir:, client:, theme_id: nil, components: nil)
       @dir = dir
       @client = client
       @theme_id = theme_id
+      @components = components
     end
 
     def compress_dir(gzip, dir)
@@ -66,7 +67,7 @@ module DiscourseTheme
       compress_dir(filename, @dir)
 
       File.open(filename) do |tgz|
-        response = @client.upload_full_theme(tgz, theme_id: @theme_id)
+        response = @client.upload_full_theme(tgz, theme_id: @theme_id, components: @components)
 
         json = JSON.parse(response.body)
         @theme_id = json["theme"]["id"]

data/lib/discourse_theme/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseTheme
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/discourse_theme/watcher.rb

@@ -1,5 +1,13 @@
 module DiscourseTheme
   class Watcher
+    def self.return_immediately!
+      @return_immediately = true
+    end
+
+    def self.return_immediately?
+      !!@return_immediately
+    end
+
     def initialize(dir:, uploader:)
       @dir = dir
       @uploader = uploader
@@ -40,7 +48,7 @@ module DiscourseTheme
       end
 
       listener.start
-      sleep
+      sleep unless self.class.return_immediately?
     end
 
     protected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discourse_theme
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -204,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="