discourse_theme 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ef711d0d73bc44d77980d883fd0ae32ce4cf14a71aa28f8e1d81ec0ec6f077b
-  data.tar.gz: b63d4ce664f8c5243fc413d3eba9222502b52565d5f183b8154f747955ee1ded
+  metadata.gz: b049cb77cb8542cd1991928a60dab7567f11e8a89c8c4ddaba8e297c05938f6c
+  data.tar.gz: c799d67427d340e1ce920c8deaebd9ae34b0af598905bf6176421ed816c3eade
 SHA512:
-  metadata.gz: 5c5af4afa4206257a58e3957533c47c5205454e465def3377e193fd46bb672882b5e761285e16394c0253ba873802c39072c213fabaeab4d658ad777f8b805ee
-  data.tar.gz: 4e1872e14d330163a2bd23316d66593f5786e00e99689546ef3196513b066638d94ccec1519117e99e097e1b9f6534932da2f291837ebe105476765f738b2007
+  metadata.gz: 6936df70b44ba83c191cb2b37a0897fa9caaf00614e3d1caa70d9f033e796eba29b8c9276e90ec8b9523af200d1f18b053c06957cefa3a6b3ab435a91b748c87
+  data.tar.gz: 0d7f183e24fb26fefed3000b4b7d681bfb51326dd1c7a9e5693fcc940dd077eb5bf31a79fa6ec287a76dd4989c60e135e3b23fb08dbce26a953aefd26d5486d4

data/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Lint
+        run: bundle exec rubocop
+
+      - name: Tests
+        run: bundle exec rake test
+
+  publish:
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: discourse/publish-rubygems-action@v2-beta
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.gitignore

@@ -1,11 +1 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
 Gemfile.lock
-
-.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rubocop.yml

@@ -1 +1,7 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+inherit_gem:
+  rubocop-discourse: default.yml
+inherit_mode:
+  merge:
+    - Exclude
+Discourse/NoChdir:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 directories %w(app lib test) \
   .select { |d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist") }
 

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
 
@@ -20,11 +20,17 @@ For help run:
 discourse_theme
 ```
 
-it contains two helpers:
+### `discourse_theme new PATH`
 
-You can use `discourse_theme new PATH` to crate a new blank theme, the CLI will guide you through the process.
+Creates 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.
+### `discourse_theme download PATH`
+
+Downloads a theme from the server and stores in the designated directory.
+
+### `discourse_theme watch PATH`
+
+Monitors a theme or component for changes. When changed the program will synchronize the theme or component to your Discourse of choice.
 
 ## Contributing
 

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/bin/discourse_theme

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/discourse_theme'
 

data/discourse_theme.gemspec

@@ -23,18 +23,20 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.5.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", "~> 10.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.5"
-
-  spec.add_dependency "minitar", "~> 0.6"
-  spec.add_dependency "listen", "~> 3.1"
-  spec.add_dependency "multipart-post", "~> 2.0"
-  spec.add_dependency "tty-prompt", "~> 0.18"
-  spec.add_dependency "rubyzip", "~> 1.2"
-
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-discourse"
 end

data/lib/discourse_theme.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'pathname'
 require 'tempfile'

data/lib/discourse_theme/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseTheme
   class Cli
 
@@ -37,9 +38,9 @@ module DiscourseTheme
     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 : Download a theme from the server, and store in the designated directory"
-      puts "discourse_theme watch DIR : Watches the theme directory and synchronizes with Discourse"
+      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 watch DIR - Watches the theme directory and synchronizes with Discourse"
       puts
       puts "Use --reset to change the configuration for a directory"
       exit 1
@@ -57,6 +58,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 +89,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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseTheme
   class Client
     THEME_CREATOR_REGEX = /^https:\/\/theme-creator.discourse.org$/i
@@ -79,7 +80,7 @@ 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"
@@ -90,6 +91,7 @@ module DiscourseTheme
       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)
@@ -102,12 +104,16 @@ module DiscourseTheme
       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)

data/lib/discourse_theme/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class DiscourseTheme::Config
 
   class PathSetting
@@ -30,6 +31,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/downloader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'zip'
 
 class DiscourseTheme::Downloader

data/lib/discourse_theme/scaffold.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseTheme
   class Scaffold
 

data/lib/discourse_theme/uploader.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
 module DiscourseTheme
   class Uploader
 
     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 +68,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.2"
+  VERSION = "0.4.1"
 end

data/lib/discourse_theme/watcher.rb

@@ -1,5 +1,14 @@
+# frozen_string_literal: true
 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 +49,7 @@ module DiscourseTheme
       end
 
       listener.start
-      sleep
+      sleep unless self.class.return_immediately?
     end
 
     protected

metadata

@@ -1,169 +1,197 @@
 --- !ruby/object:Gem::Specification
 name: discourse_theme
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
+        version: '0.18'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
+        version: '1.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: minitar
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: '2.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :runtime
+        version: '2.4'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
+        version: '3.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
+- !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'
+  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
@@ -172,9 +200,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -204,14 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: CLI helper for creating Discourse themes

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.1