rpw 0.0.5 → 0.0.6

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,15 @@
+module RPW
+  class Key < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "register [EMAIL_ADDRESS]", "Change email registered with Speedshop. One-time only."
+    def register(email)
+      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 nate.berkopec@speedshop.co"
+      end
+    end
+  end
+end

data/lib/rpw/cli/lesson.rb

@@ -0,0 +1,99 @@
+module RPW
+  class Lesson < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "next", "Proceed to the next lesson of the workshop"
+    option :open
+    def next
+      say "Proceeding to next lesson..."
+      content = client.next
+
+      if content.nil?
+        RPW::CLI.new.print_banner
+        say "Congratulations!"
+        say "You have completed the Rails Performance Workshop."
+        exit(0)
+      end
+
+      client.download_and_extract(content)
+      client.increment_current_lesson!(content["position"])
+      display_content(content, options[:open])
+    end
+
+    desc "complete", "Mark the current lesson as complete"
+    def complete
+      say "Marked current lesson as complete"
+      client.complete
+    end
+
+    desc "list", "Show all available workshop lessons"
+    def list
+      say "All available workshop lessons:"
+      client.list.each do |lesson|
+        puts "#{"  " * lesson["indent"]}[#{lesson["position"]}]: #{lesson["title"]}"
+      end
+    end
+
+    desc "download [CONTENT | all]", "Download one or all workshop contents"
+    def download(content_pos)
+      to_download = if content_pos.downcase == "all"
+        client.list
+      else
+        [client.show(content_pos)]
+      end
+      to_download.each { |content| client.download_and_extract(content) }
+    end
+
+    desc "show [CONTENT]", "Show any workshop lesson, shows current lesson w/no arguments"
+    option :open
+    def show(content_order = :current)
+      content = client.show(content_order)
+      client.download_and_extract(content)
+      display_content(content, options[:open])
+    end
+
+    private
+
+    def display_content(content, open_after)
+      say "Current Lesson: #{content["title"]}"
+      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]}"
+      when "text"
+        location = "lab/#{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."
+      end
+      if location
+        if openable && !open_after
+          say "This file can be opened automatically if you use the --open flag next time."
+          say "e.g. $ rpw lesson next --open"
+          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
+  end
+end

data/lib/rpw/cli/progress.rb

@@ -0,0 +1,32 @@
+module RPW
+  class Progress < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "set [LESSON]", "Set current lesson to a particular lesson"
+    def set(lesson)
+      client.set_progress(lesson)
+    end
+
+    desc "reset", "Erase all progress and start over"
+    def reset
+      yes? "Are you sure you want to reset your progress? (Y/N)"
+      client.reset_progress
+    end
+
+    desc "show", "Show current workshop progress"
+    def show
+      data = client.progress
+      say "The Rails Performance Workshop"
+      say "You have completed #{data[:completed]} out of #{data[:total]} total sections."
+      say "Current lesson: #{data[:current_lesson]["title"]}" if data[:current_lesson]
+      say "Progress by Section (X == completed, O == current):"
+      data[:sections].each do |section|
+        say "#{section[:title]}: #{section[:progress]}"
+      end
+    end
+
+    private
+
+    default_task :show
+  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 = ask("Your answer?")
+      answer_digest = Digest::MD5.hexdigest(data["prompt"] + provided_answer.upcase)
+      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,30 @@
+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
+
+      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
+    end
+  end
+end

data/lib/rpw/client.rb

@@ -0,0 +1,168 @@
+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
+      contents = gateway.list_content
+      return contents.first unless client_data["completed"]
+      contents.delete_if { |c| client_data["completed"].include? c["position"] }
+      contents.sort_by { |c| c["position"] }[1] # 0 would be the current lesson
+    end
+
+    def list
+      gateway.list_content
+    end
+
+    def show(content_pos)
+      content_pos = client_data["current_lesson"] if content_pos == :current
+      gateway.get_content_by_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 increment_current_lesson!(position)
+      mark_current_lesson_as_completed
+      client_data["current_lesson"] = position
+    end
+
+    def progress
+      contents = gateway.list_content
+      completed_lessons = client_data["completed"] || []
+      {
+        completed: completed_lessons.size,
+        total: contents.size,
+        current_lesson: contents.find { |c| c["position"] == client_data["current_lesson"] },
+        sections: chart_section_progress(contents, completed_lessons)
+      }
+    end
+
+    def set_progress(lesson)
+      client_data["current_lesson"] = lesson.to_i
+    end
+
+    def reset_progress
+      client_data["current_lesson"] = 0
+      client_data["completed"] = []
+    end
+
+    def latest_version?
+      return true unless ClientData.exists?
+
+      if client_data["last_version_check"]
+        return true if client_data["last_version_check"] >= Time.now - (60 * 60 * 24)
+        return false if client_data["last_version_check"] == false
+      end
+
+      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
+
+    private
+
+    def mark_current_lesson_as_completed
+      reset_progress unless client_data["current_lesson"] && client_data["completed"]
+      client_data["completed"] ||= []
+      client_data["completed"] += [client_data["current_lesson"] || 0]
+    end
+
+    def chart_section_progress(contents, completed)
+      contents.group_by { |c| c["position"] / 100 }
+        .each_with_object([]) do |(_, c), memo|
+          completed_str = c.map { |l|
+            if l["position"] == client_data["current_lesson"]
+              "O"
+            elsif completed.include?(l["position"])
+              "X"
+            else
+              "."
+            end
+          }.join
+          memo << {
+            title: c[0]["title"],
+            progress: completed_str
+          }
+        end
+    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

data/lib/rpw/client_data.rb

@@ -0,0 +1,73 @@
+require "fileutils"
+require "yaml"
+
+module RPW
+  class ClientData
+    DOTFILE_NAME = ".rpw_info"
+
+    def initialize
+      data # access file to load
+    end
+
+    def [](key)
+      data[key]
+    end
+
+    def []=(key, value)
+      data
+      data[key] = value
+
+      begin
+        File.open(filestore_location, "w") { |f| f.write(YAML.dump(data)) }
+      rescue
+        raise Error, "The RPW data at #{filestore_location} is not writable. \
+                      Check your file permissions."
+      end
+    end
+
+    def self.create_in_pwd!
+      FileUtils.touch(File.expand_path("./" + DOTFILE_NAME))
+    end
+
+    def self.create_in_home!
+      unless File.directory?(File.expand_path("~/.rpw/"))
+        FileUtils.mkdir(File.expand_path("~/.rpw/"))
+      end
+
+      FileUtils.touch(File.expand_path("~/.rpw/" + DOTFILE_NAME))
+    end
+
+    def self.delete_filestore
+      return unless File.exist?(filestore_location)
+      FileUtils.remove(filestore_location)
+    end
+
+    def self.exists?
+      File.exist? filestore_location
+    end
+
+    def self.filestore_location
+      if File.exist?(File.expand_path("./" + DOTFILE_NAME))
+        File.expand_path("./" + DOTFILE_NAME)
+      else
+        File.expand_path("~/.rpw/" + DOTFILE_NAME)
+      end
+    end
+
+    private
+
+    def filestore_location
+      self.class.filestore_location
+    end
+
+    def data
+      @data ||= begin
+        begin
+          YAML.safe_load(File.read(filestore_location), permitted_classes: [Time]) || {}
+        rescue Errno::ENOENT
+          {}
+        end
+      end
+    end
+  end
+end