rpw 0.0.5 → 1.2.0

data/lib/rpw/cli.rb

@@ -0,0 +1,268 @@
+require "thor"
+require "thor/hollaback"
+require "rpw"
+require "rpw/cli/bannerlord"
+require "rpw/cli/sub_command_base"
+require "rpw/cli/key"
+require "cli/ui"
+
+CLI::UI::StdoutRouter.enable
+
+module RPW
+  class CLI < Thor
+    class_before :check_version
+
+    desc "key register [EMAIL_ADDRESS]", "Change email registered w/Speedshop"
+    subcommand "key", Key
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "start", "Tutorial and onboarding"
+    def start
+      warn_if_already_started
+
+      print_banner
+      say "\u{1F48E} Welcome to the Rails Performance Workshop. \u{1F48E}"
+      say ""
+      say "This is rpw, the command line client for this workshop."
+      say ""
+      say "This client will download files from the internet into the current"
+      say "working directory, so it's best to run this client from a new directory"
+      say "that you'll use as your 'scratch space' for working on the Workshop."
+      say ""
+
+      ans = ::CLI::UI.confirm "Create files and folders in this directory? (no will quit)"
+
+      exit(1) unless ans
+
+      say ""
+
+      ans = ::CLI::UI::Prompt.ask("Where should we save your course progress?",
+        options: [
+          "here",
+          "my home directory (~/.rpw)"
+        ])
+
+      client.directory_setup((ans == "my home directory (~/.rpw)"))
+
+      key = ::CLI::UI::Prompt.ask("Your Purchase Key: ")
+
+      unless client.setup(key)
+        say "That is not a valid key. Please try again."
+        exit(0)
+      end
+
+      say ""
+      say "Successfully authenticated with the RPW server and saved your key."
+      say ""
+      say "Setup complete!"
+      say ""
+      say "To learn how to use this command-line client, consult ./README.md,"
+      say "which we just created."
+      say ""
+      say "Once you've read that and you're ready to get going: $ rpw next"
+    end
+
+    desc "next", "Proceed to the next lesson of the workshop"
+    option :"no-open", type: :boolean
+    def next
+      exit_with_no_key
+      content = client.next
+
+      if content.nil?
+        RPW::CLI.new.print_banner
+        say "Congratulations!"
+        say "You have completed the Rails Performance Workshop."
+        exit(0)
+      end
+
+      say "Proceeding to next lesson: #{content["title"]}"
+      client.download_and_extract(content)
+      client.complete(content["position"])
+      display_content(content, !options[:"no-open"])
+    end
+
+    desc "current", "Open the current lesson"
+    option :"no-open", type: :boolean
+    def current
+      exit_with_no_key
+      content = client.current
+      say "Opening: #{content["title"]}"
+      client.download_and_extract(content)
+      display_content(content, !options[:"no-open"])
+    end
+
+    desc "complete", "Mark the current lesson as complete"
+    def complete
+      say "Marked current lesson as complete"
+      client.complete(nil)
+    end
+
+    desc "list", "Show all available workshop lessons"
+    def list
+      ::CLI::UI::Frame.open("{{*}} {{bold:All Lessons}}", color: :green)
+
+      frame_open = false
+      client.list.each do |lesson|
+        if lesson["title"].start_with?("Section")
+          ::CLI::UI::Frame.close(nil) if frame_open
+          ::CLI::UI::Frame.open(lesson["title"])
+          frame_open = true
+          next
+        end
+
+        no_data = client.send(:client_data)["completed"].nil?
+        completed = client.send(:client_data)["completed"]&.include?(lesson["position"])
+
+        str = if no_data
+          ""
+        elsif completed
+          "\u{2705} "
+        else
+          "\u{274C} "
+        end
+
+        case lesson["style"]
+        when "video"
+          puts str + ::CLI::UI.fmt("{{red:#{lesson["title"]}}}")
+        when "quiz"
+          # puts ::CLI::UI.fmt "{{green:#{"  " + lesson["title"]}}}"
+        when "lab"
+          puts str + ::CLI::UI.fmt("{{yellow:#{"  " + lesson["title"]}}}")
+        when "text"
+          puts str + ::CLI::UI.fmt("{{magenta:#{"  " + lesson["title"]}}}")
+        else
+          puts str + ::CLI::UI.fmt("{{magenta:#{"  " + lesson["title"]}}}")
+        end
+      end
+
+      ::CLI::UI::Frame.close(nil)
+      ::CLI::UI::Frame.close(nil, color: :green)
+    end
+
+    desc "download", "Download all workshop contents"
+    def download
+      exit_with_no_key
+      total = client.list.size
+      client.list.each do |content|
+        current = client.list.index(content) + 1
+        puts "Downloading #{content["title"]} (#{current}/#{total})"
+        client.download_and_extract(content)
+      end
+    end
+
+    desc "show", "Show any individal workshop lesson"
+    option :"no-open", type: :boolean
+    def show
+      exit_with_no_key
+      title = ::CLI::UI::Prompt.ask(
+        "Which lesson would you like to view?",
+        options: client.list.reject { |l| l["title"] == "Quiz" }.map { |l| "  " * l["indent"] + l["title"] }
+      )
+      title.strip!
+      content_order = client.list.find { |l| l["title"] == title }["position"]
+      content = client.show(content_order)
+      client.download_and_extract(content)
+      display_content(content, !options[:"no-open"])
+    end
+
+    desc "set_progress", "Set current lesson to a particular lesson"
+    def set_progress
+      title = ::CLI::UI::Prompt.ask(
+        "Which lesson would you like to set your progress to? All prior lessons will be marked complete",
+        options: client.list.reject { |l| l["title"] == "Quiz" }.map { |l| "  " * l["indent"] + l["title"] }
+      )
+      title.strip!
+      content_order = client.list.find { |l| l["title"] == title }["position"]
+      content = client.set_progress(content_order, all_prior: true)
+      say "Setting current progress to #{content.last["title"]}"
+    end
+
+    desc "reset", "Erase all progress and start over"
+    def reset
+      return unless ::CLI::UI.confirm("Are you sure you want to erase all of your progress?", default: false)
+      say "Resetting progress."
+      client.set_progress(nil)
+    end
+
+    no_commands do
+      def print_banner
+        RPW::Bannerlord.print_banner
+      end
+    end
+
+    private
+
+    def exit_with_no_key
+      unless client.setup?
+        say "You have not yet set up the client. Run $ rpw start"
+        exit(1)
+      end
+      unless client.directories_ready?
+        say "You are not in your workshop scratch directory, or you have not yet"
+        say "set up the client. Change directory or run $ rpw start"
+        exit(1)
+      end
+    end
+
+    def client
+      @client ||= RPW::Client.new
+    end
+
+    def display_content(content, open_after)
+      openable = false
+      case content["style"]
+      when "video"
+        location = "video/#{content["s3_key"]}"
+        openable = true
+      when "quiz"
+        Quiz.start(["give_quiz", "quiz/" + content["s3_key"]])
+      when "lab"
+        location = "lab/#{content["s3_key"][0..-8]}"
+        openable = true
+      when "text"
+        location = "text/#{content["s3_key"]}"
+        openable = true
+      when "cgrp"
+        say "The Complete Guide to Rails Performance has been downloaded and extracted to the ./cgrp directory."
+        say "All source code for the CGRP is in the src directory, PDF and other compiled formats are in the release directory."
+        say "You can check it out now, or to continue: $ rpw next "
+      end
+      if location
+        if openable && !open_after
+          say "Download complete. Open with: $ #{open_command} #{location}"
+        elsif open_after && openable
+          exec "#{open_command} #{location}"
+        end
+      end
+    end
+
+    require "rbconfig"
+    def open_command
+      host_os = RbConfig::CONFIG["host_os"]
+      case host_os
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        "start"
+      when /darwin|mac os/
+        "open"
+      else
+        "xdg-open"
+      end
+    end
+
+    def warn_if_already_started
+      return unless client.setup?
+      exit(0) unless ::CLI::UI.confirm "You have already started the workshop. Continuing "\
+        "this command will wipe all of your current progress. Continue?", default: false
+    end
+
+    def check_version
+      unless client.latest_version?
+        say "WARNING: You are running an old version of rpw."
+        say "WARNING: Please run `$ gem install rpw`"
+      end
+    end
+  end
+end

data/lib/rpw/cli/bannerlord.rb

@@ -0,0 +1,59 @@
+module RPW
+  class Bannerlord
+    class << self
+      def print_banner
+        puts r
+        if `tput cols 80`.to_i < 80
+          puts small_banner
+        else
+          puts banner
+        end
+        puts reset
+      end
+
+      def r
+        "\e[31m"
+      end
+
+      def reset
+        "\e[0m"
+      end
+
+      def small_banner
+        %(
+       _____ _          _____     _ _
+      |_   _| |_ ___   | __  |___|_| |___
+        | | |   | -_|  |    -| .'| | |_ -|
+        |_| |_|_|___|  |__|__|__,|_|_|___|
+       _____         ___
+      |  _  |___ ___|  _|___ ___ _____ ___ ___ ___ ___
+      |   __| -_|  _|  _| . |  _|     | .'|   |  _| -_|
+      |__|  |___|_| |_| |___|_| |_|_|_|__,|_|_|___|___|
+       _ _ _         _       _
+      | | | |___ ___| |_ ___| |_ ___ ___
+      | | | | . |  _| '_|_ -|   | . | . |
+      |_____|___|_| |_,_|___|_|_|___|  _|
+                                    |_|
+          #{reset})
+      end
+
+      def banner
+        %(
+                                 _____ _          _____     _ _
+      +hmNMMMMMm/`  -ymMMNh/    |_   _| |_ ___   | __  |___|_| |___
+      sMMMMMMMMMy   +MMMMMMMMy    | | |   | -_|  |    -| .'| | |_ -|
+      yMMMMMMMMMMy` yMMMMMMMMN    |_| |_|_|___|  |__|__|__,|_|_|___|
+       `dMMMMMMMMMMm:-dMMMMMMm:   _____         ___
+        `sNMMMMMMMMMMs.:+sso:`   |  _  |___ ___|  _|___ ___ _____ ___ ___ ___ ___
+          :dMMMMMMMMMMm/         |   __| -_|  _|  _| . |  _|     | .'|   |  _| -_|
+      :oss+:.sNMMMMMMMMMMy`      |__|  |___|_| |_| |___|_| |_|_|_|__,|_|_|___|___|
+     /mMMMMMMd-:mMMMMMMMMMMd.     _ _ _         _       _
+     NMMMMMMMMy `hMMMMMMMMMMh    | | | |___ ___| |_ ___| |_ ___ ___
+     yMMMMMMMM+  `dMMMMMMMMMy    | | | | . |  _| '_|_ -|   | . | . |
+     /hNMMmy-  `/mMMMMMNmy/      |_____|___|_| |_,_|___|_|_|___|  _|
+                                                               |_|
+          #{reset})
+      end
+    end
+  end
+end

data/lib/rpw/cli/key.rb

@@ -0,0 +1,17 @@
+module RPW
+  class Key < SubCommandBase
+    desc "register [EMAIL_ADDRESS]", "Change email registered with Speedshop. One-time only."
+    def register(email)
+      unless client.setup?
+        say "You have not yet set up the client. Run $ rpw start"
+        exit(1)
+      end
+      if client.register_email(email)
+        say "Key registered with #{email}. You should receive a Slack invite soon."
+      else
+        say "Key has already been registered. If you believe this is in error,"\
+          " please email support@speedshop.co"
+      end
+    end
+  end
+end

data/lib/rpw/cli/quiz.rb

@@ -0,0 +1,28 @@
+require "digest"
+require "thor"
+
+module RPW
+  class Quiz < Thor
+    desc "give_quiz FILENAME", ""
+    def give_quiz(filename)
+      @quiz_data = YAML.safe_load(File.read(filename))
+      @quiz_data["questions"].each { |q| question(q) }
+    end
+
+    private
+
+    def question(data)
+      puts data["prompt"]
+      data["answer_choices"].each { |ac| puts ac }
+      provided_answer = ::CLI::UI::Prompt.ask("Your answer?", options: %w[A B C D])
+      answer_digest = Digest::MD5.hexdigest(data["prompt"] + provided_answer)
+      if answer_digest == data["answer_digest"]
+        say "Correct!"
+      else
+        say "Incorrect."
+        say "I encourage you to try reviewing the material to see what the correct answer is."
+      end
+      say ""
+    end
+  end
+end

data/lib/rpw/cli/sub_command_base.rb

@@ -0,0 +1,18 @@
+module RPW
+  class SubCommandBase < Thor
+    def self.banner(command, namespace = nil, subcommand = false)
+      "#{basename} #{subcommand_prefix} #{command.usage}"
+    end
+
+    def self.subcommand_prefix
+      name.gsub(%r{.*::}, "").gsub(%r{^[A-Z]}) { |match| match[0].downcase }
+        .gsub(%r{[A-Z]}) { |match| "-#{match[0].downcase}" }
+    end
+
+    no_commands do
+      def client
+        @client ||= RPW::Client.new
+      end
+    end
+  end
+end

data/lib/rpw/client.rb

@@ -0,0 +1,158 @@
+require "fileutils"
+require "rpw/cli/quiz"
+
+module RPW
+  class Client
+    RPW_SERVER_DOMAIN = ENV["RPW_SERVER_DOMAIN"] || "https://rpw-licensor.speedshop.co"
+    attr_reader :gateway
+
+    def initialize(gateway = nil)
+      @gateway = gateway || Gateway.new(RPW_SERVER_DOMAIN, client_data["key"])
+    end
+
+    def setup(key)
+      success = gateway.authenticate_key(key)
+      client_data["key"] = key if success
+      success
+    end
+
+    def register_email(email)
+      gateway.register_email(email)
+    end
+
+    def next
+      return list.first unless client_data["completed"]
+      list.sort_by { |c| c["position"] }.find { |c| c["position"] > current_position }
+    end
+
+    def current
+      return list.first unless client_data["completed"]
+      list.sort_by { |c| c["position"] }.find { |c| c["position"] == current_position }
+    end
+
+    def list
+      @list ||= begin
+        if client_data["content_cache_generated"] &&
+            client_data["content_cache_generated"] >= Time.now - 60 * 60
+
+          client_data["content_cache"]
+        else
+          begin
+            client_data["content_cache"] = gateway.list_content
+            client_data["content_cache_generated"] = Time.now
+            client_data["content_cache"]
+          rescue
+            client_data["content_cache"] || (raise Error.new("No internet connection"))
+          end
+        end
+      end
+    end
+
+    def show(content_pos)
+      list.find { |l| l["position"] == content_pos }
+    end
+
+    def directory_setup(home_dir_ok = true)
+      ["video", "quiz", "lab", "text", "cgrp"].each do |path|
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+      end
+
+      if home_dir_ok
+        ClientData.create_in_home!
+      else
+        ClientData.create_in_pwd!
+      end
+
+      unless File.exist?(".gitignore") && File.read(".gitignore").match(/rpw_info/)
+        File.open(".gitignore", "a") do |f|
+          f.puts "\n"
+          f.puts ".rpw_info\n"
+          f.puts "video\n"
+          f.puts "quiz\n"
+          f.puts "lab\n"
+          f.puts "text\n"
+          f.puts "cgrp\n"
+        end
+      end
+
+      File.open("README.md", "w+") do |f|
+        f.puts File.read(File.join(File.dirname(__FILE__), "README.md"))
+      end
+    end
+
+    def set_progress(pos, all_prior: false)
+      client_data["completed"] = [] && return if pos.nil?
+      if all_prior
+        lessons = list.select { |l| l["position"] <= pos }
+        client_data["completed"] = lessons.map { |l| l["position"] }
+        lessons
+      else
+        lesson = list.find { |l| l["position"] == pos }
+        client_data["completed"] += [pos]
+        lesson
+      end
+    end
+
+    def latest_version?
+      return true unless ClientData.exists?
+      return true if client_data["last_version_check"] &&
+        client_data["last_version_check"] >= Time.now - (60 * 60)
+
+      begin
+        latest = gateway.latest_version?
+      rescue
+        return true
+      end
+
+      client_data["last_version_check"] = if latest
+        Time.now
+      else
+        false
+      end
+    end
+
+    def setup?
+      return false unless ClientData.exists?
+      client_data["key"]
+    end
+
+    def directories_ready?
+      ["video", "quiz", "lab", "text", "cgrp"].all? do |path|
+        File.directory?(path)
+      end
+    end
+
+    def download_and_extract(content)
+      location = content["style"] + "/" + content["s3_key"]
+      unless File.exist?(location)
+        gateway.download_content(content, folder: content["style"])
+        extract_content(content) if content["s3_key"].end_with?(".tar.gz")
+      end
+    end
+
+    def complete(position)
+      if client_data["completed"]
+        # we actually have to put the _next_ lesson on the completed stack
+        set_progress(self.next["position"])
+      else
+        client_data["completed"] = []
+        set_progress(position)
+      end
+    end
+
+    private
+
+    def current_position
+      @current_position ||= client_data["completed"]&.last || 0
+    end
+
+    def client_data
+      @client_data ||= ClientData.new
+    end
+
+    def extract_content(content)
+      folder = content["style"]
+      `tar -C #{folder} -xvzf #{folder}/#{content["s3_key"]}`
+    end
+  end
+end