discourse_theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f39560cfe4f927edff0919dc9c325d0288982107
+  data.tar.gz: ad749d7d12462e0eb5b217a1bab3ad19e0398e72
+SHA512:
+  metadata.gz: 9c4cc9c5149385f35616b8f0f6aade9320b1eb2fdb0c77fb3d8dcc4fe457301ee9a7082d3e90b28ecc553cc3b07fa74c67729780946ad0de76ede02474b2a48e
+  data.tar.gz: 538a23533f1e9eebaad4a1decd9e388bfd782c4d0c38e49072eaf98d18b8392c82c93511bf18a206de904c18d44e43fcd937ff877af65b53acc2723c8fd9e367

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sam.saffron@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in discourse_theme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Civilized Discourse Construction Kit
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# Discourse Theme
+
+This CLI contains helpers for creating [Discourse themes](https://meta.discourse.org/c/theme).
+
+## Installation
+
+To install the CLI use:
+
+    $ gem install discourse_theme
+
+## 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!
+
+## Usage
+
+For help run:
+
+```
+discourse_theme
+```
+
+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.
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DiscourseTheme project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SamSaffron/discourse_theme/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/discourse_theme

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/discourse_theme'
+
+DiscourseTheme::Cli.new.run

data/discourse_theme.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "minitar", "~> 0.5"
+  spec.add_dependency "listen", "~> 3.1"
+  spec.add_dependency "multipart-post", "~> 2.0"
+
+  spec.required_ruby_version = '>= 2.2.0'
+end

data/lib/discourse_theme.rb

@@ -0,0 +1,21 @@
+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 'discourse_theme/version'
+require 'discourse_theme/cli'
+require 'discourse_theme/uploader'
+require 'discourse_theme/watcher'
+require 'discourse_theme/scaffold'
+
+module DiscourseTheme
+end

data/lib/discourse_theme/cli.rb

@@ -0,0 +1,112 @@
+class DiscourseTheme::Cli
+
+  WATCHER_SETTINGS_FILE = File.expand_path("~/.discourse-theme-watcher")
+
+  def usage
+    puts "Usage: discourse-theme COMMAND"
+    puts
+    puts "discourse-theme new DIR : Creates a new theme in the designated directory"
+    puts "discourse-theme watch DIR : Watches the theme directory and synchronizes with Discourse"
+    exit 1
+  end
+
+  def guess_api_key
+    api_key = ENV['DISCOURSE_API_KEY']
+    if api_key
+      puts "Using api_key provided by DISCOURSE_API_KEY"
+    end
+
+    if !api_key && File.exist?(WATCHER_SETTINGS_FILE)
+      api_key = File.read(WATCHER_SETTINGS_FILE).strip
+      puts "Using previously stored api key in #{WATCHER_SETTINGS_FILE}"
+    end
+
+    if !api_key
+      puts "No API key found in DISCOURSE_API_KEY env var enter your API key: "
+      api_key = STDIN.gets.strip
+      puts "Would you like me to store this API key in #{WATCHER_SETTINGS_FILE}? (Yes|No)"
+      answer = STDIN.gets.strip
+      if answer =~ /y(es)?/i
+        File.write WATCHER_SETTINGS_FILE, api_key
+      end
+    end
+
+    api_key
+  end
+
+  def guess_site(dir)
+    site = ENV['DISCOURSE_SITE']
+    if site
+      puts "Site provided by DISCOURSE_SITE"
+    end
+
+    site_conf = dir + "/.discourse-site"
+
+    if !site && File.exist?(site_conf)
+      site = File.read(site_conf).strip
+      puts "Using #{site} defined in #{site_conf}"
+    end
+
+    if !site
+      puts "No site found, where would you like to synchronize the theme to: "
+      site = STDIN.gets.strip
+      puts "Would you like me to store this site name at: #{site_conf}? (Yes|No)"
+      answer = STDIN.gets.strip
+      if answer =~ /y(es)?/i
+        File.write site_conf, site
+        # got to make sure this is in .gitignore
+
+        gitignore = File.read(dir + "/.gitignore") rescue ""
+        if gitignore !~ /^.discourse-site/
+          gitignore.strip!
+          gitignore += "\n.discourse-site"
+          File.write(dir + '/.gitignore', gitignore)
+        end
+      end
+    end
+
+    site
+  end
+
+  def run
+    usage unless ARGV[1]
+
+    command = ARGV[0].to_s.downcase
+    dir = File.expand_path(ARGV[1])
+
+    dir_exists = File.exist?(dir)
+
+    if command == "new" && !dir_exists
+      DiscourseTheme::Scaffold.generate(dir)
+    elsif command == "watch" && dir_exists
+      if !File.exist?("#{dir}/about.json")
+        puts "No about.json file found in #{dir}!"
+        puts
+        usage
+      end
+
+      api_key = guess_api_key
+      site = guess_site(dir)
+
+      if !site
+        puts "Missing site!"
+        usage
+      end
+
+      if !api_key
+        puts "Missing api key!"
+        usage
+      end
+
+      uploader = DiscourseTheme::Uploader.new(dir: dir, api_key: api_key, site: site)
+      print "Uploading theme from #{dir} to #{site} : "
+      uploader.upload_full_theme
+
+      watcher = DiscourseTheme::Watcher.new(dir: dir, uploader: uploader)
+
+      watcher.watch
+    else
+      usage
+    end
+  end
+end

data/lib/discourse_theme/scaffold.rb

@@ -0,0 +1,74 @@
+class DiscourseTheme::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
+  }
+
+  ABOUT_JSON = <<~STR
+    {
+      "name": "#NAME#",
+      "about_url": "URL",
+      "license_url": "URL",
+      "assets": {
+      },
+      "color_schemes": {
+      }
+    }
+  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
+
+  def self.generate(dir)
+    puts "Generating a scaffold theme at #{dir}"
+
+    puts "What would you like to call your theme? "
+    name = STDIN.gets.strip
+    if name.length == 0
+      puts "Please pick a name"
+      exit 1
+    end
+
+    FileUtils.mkdir_p dir
+    Dir.chdir dir do
+      File.write('about.json', ABOUT_JSON.sub("#NAME#", name))
+      File.write('HELP', HELP)
+      File.write('.gitignore', GIT_IGNORE)
+
+      BLANK_FILES.each do |f|
+        puts "#{f}"
+        FileUtils.mkdir_p File.dirname(f)
+        FileUtils.touch f
+      end
+
+      puts "Initializing git repo"
+      puts `git init .`
+    end
+  end
+end

data/lib/discourse_theme/uploader.rb

@@ -0,0 +1,108 @@
+class DiscourseTheme::Uploader
+
+  def initialize(dir:, api_key:, site:)
+    @dir = dir
+    @api_key = api_key
+    @site = site
+    @theme_id = nil
+  end
+
+  def compress_dir(gzip, dir)
+    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|
+        Find.prune if File.basename(x)[0] == ?.
+        next if File.directory?(x)
+
+        Minitar.pack_file(x, tar)
+      end
+    end
+  ensure
+    tar.close
+    sgz.close
+  end
+
+  def diagnose_errors(json)
+    count = 0
+    json["theme"]["theme_fields"].each do |row|
+      if (error = row["error"]) && error.length > 0
+        if count == 0
+          puts
+        end
+        count += 1
+        puts
+        puts "Error in #{row["target"]} #{row["name"]}: #{row["error"]}"
+        puts
+      end
+    end
+    count
+  end
+
+
+  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
+        }]
+      }
+    }
+
+    uri = URI.parse(@site + "/admin/themes/#{@theme_id}?api_key=#{@api_key}")
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Put.new(uri.request_uri, 'Content-Type' => 'application/json')
+    request.body = args.to_json
+
+    http.start do |h|
+      response = h.request(request)
+      if response.code.to_i == 200
+        json = JSON.parse(response.body)
+        if diagnose_errors(json) == 0
+          puts "(done)"
+        end
+      else
+        puts "Error importing field status: #{response.code}"
+      end
+    end
+  end
+
+  def upload_full_theme
+    filename = "#{Pathname.new(Dir.tmpdir).realpath}/bundle_#{SecureRandom.hex}.tar.gz"
+    compress_dir(filename, @dir)
+
+    # new full upload endpoint
+    uri = URI.parse(@site + "/admin/themes/import.json?api_key=#{@api_key}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    File.open(filename) do |tgz|
+
+      request = Net::HTTP::Post::Multipart.new(
+        uri.request_uri,
+        "bundle" => UploadIO.new(tgz, "application/tar+gzip", "bundle.tar.gz"),
+      )
+      response = http.request(request)
+      if response.code.to_i == 201
+        json = JSON.parse(response.body)
+        @theme_id = json["theme"]["id"]
+        if diagnose_errors(json) == 0
+          puts "(done)"
+        end
+      else
+        puts "Error importing theme status: #{response.code}"
+      end
+    end
+
+  ensure
+    FileUtils.rm_f filename
+  end
+
+
+end

data/lib/discourse_theme/version.rb

@@ -0,0 +1,3 @@
+module DiscourseTheme
+  VERSION = "0.1.0"
+end

data/lib/discourse_theme/watcher.rb

@@ -0,0 +1,53 @@
+class DiscourseTheme::Watcher
+  def initialize(dir:, uploader:)
+    @dir = dir
+    @uploader = uploader
+  end
+
+  def watch
+    listener = Listen.to(@dir) do |modified, added, removed|
+      if modified.length == 1 &&
+          added.length == 0 &&
+          removed.length == 0 &&
+          (resolved = resolve_file(modified[0]))
+
+        target, name, type_id = resolved
+        print "Updating #{target} #{name}: "
+
+        @uploader.upload_theme_field(
+          target: target,
+          name: name,
+          value: File.read(modified[0]),
+          type_id: type_id
+        )
+      else
+        print "Full re-sync is required, re-uploading theme: "
+        @uploader.upload_full_theme
+      end
+    end
+
+    listener.start
+    sleep
+
+  end
+
+  protected
+
+  def resolve_file(path)
+    dir_len = File.expand_path(@dir).length
+    name = File.expand_path(path)[dir_len + 1..-1]
+
+    target, file = name.split("/")
+
+    if ["common", "desktop", "mobile"].include?(target)
+      if file = "#{target}.scss"
+        # a CSS file
+        return [target, "scss", 1]
+      end
+    end
+
+    nil
+  end
+
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: discourse_theme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Saffron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: CLI helper for creating Discourse themes
+email:
+- sam.saffron@gmail.com
+executables:
+- discourse_theme
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/discourse_theme
+- discourse_theme.gemspec
+- lib/discourse_theme.rb
+- lib/discourse_theme/cli.rb
+- lib/discourse_theme/scaffold.rb
+- lib/discourse_theme/uploader.rb
+- lib/discourse_theme/version.rb
+- lib/discourse_theme/watcher.rb
+homepage: https://github.com/discourse/discourse_theme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: CLI helper for creating Discourse themes
+test_files: []