rpw 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 317f37137765f78e5a587b36e3ecb4898d18e4b011cc3ef67f60d5d0e710c6d8
-  data.tar.gz: 4c9f5e3edf56c6dad2d887e4653d358850255dbf9682e0a6fcc8261e0e3a543f
+  metadata.gz: c4c79a03ffb13bfdd6fd37581cdca30aa3a69712608add26105f51b130b15fcb
+  data.tar.gz: '05079633b4d192a7654dea1f82972ecb735ea634de59c5e83bde843eec73ef42'
 SHA512:
-  metadata.gz: 7526987cc970e87b387154632256c89190b8cb7ec9fb9cfe9f1fe2364e73a46cabe81ecbe6a6707e8d5c7ca2c3a5f1591f2bf27d8b63a4e801ff69fcfefa1f11
-  data.tar.gz: eeb1628660e72e1d655e428c0640b6255ba43794db4704b42293eee6975a7f1a157c345ba6f2e87e8952af4198750d7aa271f7c925c4977d8f50e0f3e8fdb837
+  metadata.gz: f81567fe95bda4102cc1109e8f643043ee9dcb58d0fc81c1c9faee34ff91fcc3ba3d7265f718c473a19eafbdcf852801c6bea803ddf49c7ad74280f8a85cd3dc
+  data.tar.gz: 66fb292f109656d91d97166733ba21f095d0c7f1cfd06a82e580ab87c8b4bb2d28b03eb95dcb02c32ca5eb4a7e2d379a04afa5b9ae419511c927ea9755c1f877

data/.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-20.04, macos-10.15, windows-2019 ]
-        ruby: [ 2.3, 2.6, 2.7, head ]
+        ruby: [ 2.6, 2.7, head ]
 
     steps:
       - name: repo checkout
@@ -33,7 +33,7 @@ jobs:
 
       - name: bundle install
         run:   |
-          bundle install --jobs 4 --retry 3
+          gem install bundler && bundle install --jobs 4 --retry 3
 
       - name: standardrb 
         run: bundle exec standardrb 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpw (1.1.0)
+    rpw (1.2.0)
       cli-ui
       excon
       thor

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 1.2.0
+
+* Actual release version!
+* Greatly streamlined commands
+
 ## 1.1.0 
 
 * sick colors

data/lib/rpw/README.md

@@ -1,6 +1,6 @@
 ## Installation Requirements
 
-This client assumes you're using Ruby 2.3 or later.
+This client assumes you're using Ruby 2.6 or later.
 
 This client assumes you have `tar` installed and available on your PATH.
 
@@ -11,6 +11,11 @@ The way that the client opens files (using `open` or `xdg-open` depending on pla
 
 ## Slack Invite 
 
+The Slack channel is your best resource for questions about Rails Performance
+or other material in the workshop. Nate is almost always monitoring that channel.
+
+If you encounter a **bug or other software problem**, please email support@speedshop.co.
+
 If you purchased the Workshop yourself, you will receive a Slack channel invitation
 shortly. If you are attending the Workshop as part of a group and your license key
 was provided to you, you need to register your key to get an invite:
@@ -21,33 +26,30 @@ $ rpw key register [YOUR_EMAIL_ADDRESS]
 
 Please note you can only register your key once.
 
-The Slack channel is your best resource for questions about Rails Performance
-or other material in the workshop. Nate is almost always monitoring that channel.
-
-If you encounter a **bug or other software problem**, please email support@speedshop.co.
-
 ## Important Commands
 
 Here are some important commands for you to know:
 
 ```
-$ rpw lesson next     | Proceed to the next part of the workshop.
-$ rpw lesson complete | Mark current lesson as complete.
-$ rpw lesson list     | List all workshop lessons. Note each lesson is preceded with an ID.
-$ rpw lesson download | Download all lessons. Useful for offline access.
-$ rpw lesson show     | Show any particular workshop lesson.
-$ rpw progress        | Show where you're currently at in the workshop.
+$ rpw next     | Proceed to the next part of the workshop.
+$ rpw complete | Mark current lesson as complete.
+$ rpw list     | List all workshop lessons. Shows progress.
+$ rpw download | Download all lessons. Useful for offline access.
+$ rpw show     | Show any particular workshop lesson.
+$ rpw current  | Opens the current lesson.
 ```
 
-Generally, you'll just be doing a lot of `$ rpw lesson next`!
+Generally, you'll just be doing a lot of `$ rpw next`! It's basically the same thing as `$ rpw complete && rpw show`.
+
+#### --no-open
 
-By default, `$ rpw lesson next` will try to open the content it downloads. If you 
-either don't like this, or for some reason it doesn't work, use `$ rpw lesson next --no-open`.
+By default, `$ rpw next` (and `$ rpw show` and `$ rpw current`) will try to open the content it downloads. If you 
+either don't like this, or for some reason it doesn't work, use `$ rpw next --no-open`.
 
 ## Working Offline 
 
 By default, the course will download each piece of content as you progress through 
-the course. However, you can use `rpw lesson download all` to download all content
+the course. However, you can use `rpw download` to download all content
 at once, and complete the workshop entirely offline.
 
 Videos in this workshop are generally about 100MB each, which means the entire

data/lib/rpw/cli.rb

@@ -4,8 +4,6 @@ require "rpw"
 require "rpw/cli/bannerlord"
 require "rpw/cli/sub_command_base"
 require "rpw/cli/key"
-require "rpw/cli/lesson"
-require "rpw/cli/progress"
 require "cli/ui"
 
 CLI::UI::StdoutRouter.enable
@@ -16,10 +14,6 @@ module RPW
 
     desc "key register [EMAIL_ADDRESS]", "Change email registered w/Speedshop"
     subcommand "key", Key
-    desc "lesson [SUBCOMMAND]", "View and download lessons"
-    subcommand "lesson", Lesson
-    desc "progress [SUBCOMMAND]", "View and set progress"
-    subcommand "progress", Progress
 
     def self.exit_on_failure?
       true
@@ -60,13 +54,137 @@ module RPW
         exit(0)
       end
 
-      puts ""
+      say ""
       say "Successfully authenticated with the RPW server and saved your key."
-      puts ""
+      say ""
       say "Setup complete!"
-      puts ""
-      say "To learn how to use this command-line client, consult ./README.md, which we just created."
-      say "Once you've read that and you're ready to get going: $ rpw lesson next"
+      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
@@ -77,10 +195,63 @@ module RPW
 
     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 "\

data/lib/rpw/cli/key.rb

@@ -1,9 +1,11 @@
 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)
+      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

data/lib/rpw/cli/sub_command_base.rb

@@ -13,18 +13,6 @@ module RPW
       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

@@ -25,6 +25,11 @@ module RPW
       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"] &&
@@ -75,22 +80,17 @@ module RPW
       end
     end
 
-    def progress
-      completed_lessons = client_data["completed"] || []
-      {
-        completed: completed_lessons.size,
-        total: list.size,
-        current_lesson: list.find { |c| c["position"] == current_position },
-        sections: chart_section_progress(list, completed_lessons)
-      }
-    end
-
-    def set_progress(pos)
+    def set_progress(pos, all_prior: false)
       client_data["completed"] = [] && return if pos.nil?
-      lesson = list.find { |l| l["position"] == pos }
-      raise Error.new("No such lesson - use the IDs in $ rpw lesson list") unless lesson
-      client_data["completed"] += [pos]
-      lesson
+      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?
@@ -146,25 +146,6 @@ module RPW
       @current_position ||= client_data["completed"]&.last || 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"] == current_position
-              "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

data/lib/rpw/version.rb

@@ -1,3 +1,3 @@
 module RPW
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nate Berkopec
@@ -90,8 +90,6 @@ files:
 - lib/rpw/cli.rb
 - lib/rpw/cli/bannerlord.rb
 - lib/rpw/cli/key.rb
-- lib/rpw/cli/lesson.rb
-- lib/rpw/cli/progress.rb
 - lib/rpw/cli/quiz.rb
 - lib/rpw/cli/sub_command_base.rb
 - lib/rpw/client.rb

data/lib/rpw/cli/lesson.rb

@@ -1,129 +0,0 @@
-module RPW
-  class Lesson < SubCommandBase
-    desc "next", "Proceed to the next lesson of the workshop"
-    option :"no-open"
-    def next
-      exit_with_no_key
-      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.complete(content["position"])
-      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
-
-        case lesson["style"]
-        when "video"
-          puts ::CLI::UI.fmt "{{red:#{lesson["title"]}}}"
-        when "quiz"
-          # puts ::CLI::UI.fmt "{{green:#{"  " + lesson["title"]}}}"
-        when "lab"
-          puts ::CLI::UI.fmt "{{yellow:#{"  " + lesson["title"]}}}"
-        when "text"
-          puts ::CLI::UI.fmt "{{magenta:#{"  " + lesson["title"]}}}"
-        else
-          puts ::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)
-        puts "Downloading #{content["title"]} (#{current}/#{total})"
-        client.download_and_extract(content)
-      end
-    end
-
-    desc "show", "Show any individal workshop lesson"
-    option :"no-open"
-    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
-
-    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]}"
-        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 lesson 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
-  end
-end

data/lib/rpw/cli/progress.rb

@@ -1,38 +0,0 @@
-module RPW
-  class Progress < SubCommandBase
-    desc "set [LESSON]", "Set current lesson to a particular lesson"
-    def set(pos)
-      lesson = client.set_progress(pos.to_i)
-      say "Set current progress to #{lesson["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
-
-    desc "show", "Show current workshop progress"
-    def show
-      data = client.progress
-      ::CLI::UI::Frame.open("The Rails Performance Workshop", timing: false, color: :red) do
-        say "You have completed #{data[:completed]} out of #{data[:total]} total sections."
-        say ""
-        say "Current lesson: #{data[:current_lesson]["title"]}" if data[:current_lesson]
-        say ""
-        ::CLI::UI::Frame.open("Progress", timing: false, color: :red) do
-          puts ::CLI::UI.fmt "{{i}} (X == completed, O == current)"
-          say ""
-          data[:sections].each do |section|
-            say "#{section[:title]}: #{section[:progress]}"
-          end
-        end
-      end
-    end
-
-    private
-
-    default_task :show
-  end
-end