rpw 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee4cd056139ea78d75fc48a6c0337c32c7e9ca958ac0c24716ec7a27abc5617
-  data.tar.gz: 6688f3f8b1edef9c6004af6146d10e4d6b190d103f95ee233902523f73760043
+  metadata.gz: 317f37137765f78e5a587b36e3ecb4898d18e4b011cc3ef67f60d5d0e710c6d8
+  data.tar.gz: 4c9f5e3edf56c6dad2d887e4653d358850255dbf9682e0a6fcc8261e0e3a543f
 SHA512:
-  metadata.gz: 5682fb0676abd4d9a69ecee1193a332ed7d580ea5d8f37919d2925da01d64a4f911cb042ec0ec8e72e39479f75f3cb3fdfac3d640a178dd3d70f3b7c41bdf396
-  data.tar.gz: edc9f5b0994db202b3b9b94838efeec9ecc26f7d52e05e8fc73c35a6c22e10ff969e9065cb66a51c2151c31c93fea9e07f6a6277c420fbd6832ba58fe510f69d
+  metadata.gz: 7526987cc970e87b387154632256c89190b8cb7ec9fb9cfe9f1fe2364e73a46cabe81ecbe6a6707e8d5c7ca2c3a5f1591f2bf27d8b63a4e801ff69fcfefa1f11
+  data.tar.gz: eeb1628660e72e1d655e428c0640b6255ba43794db4704b42293eee6975a7f1a157c345ba6f2e87e8952af4198750d7aa271f7c925c4977d8f50e0f3e8fdb837

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rpw (1.0.1)
+    rpw (1.1.0)
+      cli-ui
       excon
       thor
       thor-hollaback
@@ -10,6 +11,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    cli-ui (1.4.0)
     excon (0.78.0)
     hollaback (0.1.0)
     minitest (5.14.2)

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 1.1.0 
+
+* sick colors
+
 ## 1.0.1 
 
 * Pre-launch bugfix

data/lib/rpw/README.md

@@ -34,8 +34,8 @@ 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 any or all lessons. Use the IDs from "list".
-$ rpw lesson show     | Show any particular workshop lesson. Use the IDs from "list".
+$ 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.
 ```
 

data/lib/rpw/cli.rb

@@ -6,11 +6,13 @@ 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
 
 module RPW
   class CLI < Thor
     class_before :check_version
-    class_before :check_setup
 
     desc "key register [EMAIL_ADDRESS]", "Change email registered w/Speedshop"
     subcommand "key", Key
@@ -28,7 +30,7 @@ module RPW
       warn_if_already_started
 
       print_banner
-      say "Welcome to the Rails Performance Workshop."
+      say "\u{1F48E} Welcome to the Rails Performance Workshop. \u{1F48E}"
       say ""
       say "This is rpw, the command line client for this workshop."
       say ""
@@ -36,14 +38,22 @@ module RPW
       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 ""
-      say "We will create a handful of new files and folders in the current directory."
-      return unless yes? "Is this OK? (y/N) (N will quit)"
-      puts ""
-      say "We'll also create a .rpw_info file at #{File.expand_path("~/.rpw")} to save your purchase key."
-      home_dir_ok = yes?("Is this OK? (y/N) (N will create it in the current directory)")
-      client.directory_setup(home_dir_ok)
 
-      key = ask("Your Purchase Key: ")
+      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."
@@ -73,8 +83,8 @@ module RPW
 
     def warn_if_already_started
       return unless client.setup?
-      exit(0) unless yes? "You have already started the workshop. Continuing "\
-        "this command will wipe all of your current progress. Continue? (y/N)"
+      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
@@ -83,12 +93,5 @@ module RPW
         say "WARNING: Please run `$ gem install rpw`"
       end
     end
-
-    def check_setup
-      unless client.setup? || current_command_chain == [:start]
-        say "WARNING: You do not have a purchase key set. Run `$ rpw start`"
-        exit(0)
-      end
-    end
   end
 end

data/lib/rpw/cli/lesson.rb

@@ -1,10 +1,9 @@
 module RPW
   class Lesson < SubCommandBase
-    class_before :exit_with_no_key
-
     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
 
@@ -28,27 +27,56 @@ module RPW
 
     desc "list", "Show all available workshop lessons"
     def list
-      say "All available workshop lessons:"
-      say "Use [ID] for the show/download command"
-      say "[ID]: Lesson Name"
+      ::CLI::UI::Frame.open("{{*}} {{bold:All Lessons}}", color: :green)
+
+      frame_open = false
       client.list.each do |lesson|
-        puts "[#{lesson["position"]}]:#{"  " * lesson["indent"]} #{lesson["title"]}"
+        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 [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)]
+    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
-      to_download.each { |content| client.download_and_extract(content) }
     end
 
-    desc "show [CONTENT]", "Show any workshop lesson, shows current lesson w/no arguments"
+    desc "show", "Show any individal workshop lesson"
     option :"no-open"
-    def show(content_order = :current)
+    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"])

data/lib/rpw/cli/progress.rb

@@ -1,7 +1,5 @@
 module RPW
   class Progress < SubCommandBase
-    class_before :exit_with_no_key
-
     desc "set [LESSON]", "Set current lesson to a particular lesson"
     def set(pos)
       lesson = client.set_progress(pos.to_i)
@@ -10,7 +8,7 @@ module RPW
 
     desc "reset", "Erase all progress and start over"
     def reset
-      return unless yes? "Are you sure you want to reset your progress? (Y/N)"
+      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
@@ -18,12 +16,18 @@ module RPW
     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]}"
+      ::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
 

data/lib/rpw/cli/quiz.rb

@@ -14,8 +14,8 @@ module RPW
     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)
+      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

data/lib/rpw/client.rb

@@ -44,8 +44,7 @@ module RPW
     end
 
     def show(content_pos)
-      content_pos = current_position if content_pos == :current
-      gateway.get_content_by_position(content_pos)
+      list.find { |l| l["position"] == content_pos }
     end
 
     def directory_setup(home_dir_ok = true)

data/lib/rpw/client_data.rb

@@ -20,8 +20,8 @@ module RPW
       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."
+        # raise Error, "The RPW data at #{filestore_location} is not writable. \
+        # Check your file permissions."
       end
     end
 

data/lib/rpw/gateway.rb

@@ -16,16 +16,6 @@ module RPW
       Excon.get(domain + "/license", user: key).status == 200
     end
 
-    def get_content_by_position(position)
-      response = Excon.get(domain + "/contents/positional?position=#{position}", user: @key)
-      if response.status == 200
-        JSON.parse(response.body)
-      else
-        puts response.inspect
-        raise Error, "There was a problem fetching this content."
-      end
-    end
-
     def list_content
       response = Excon.get(domain + "/contents", user: @key)
       if response.status == 200
@@ -37,21 +27,21 @@ module RPW
     end
 
     def download_content(content, folder:)
-      puts "Downloading #{content["title"]}..."
-      downloaded_file = File.open("#{folder}/#{content["s3_key"]}.partial", "w")
-      streamer = lambda do |chunk, remaining_bytes, total_bytes|
-        downloaded_file.write(chunk)
-        print 13.chr
-        print "Remaining: #{(remaining_bytes.to_f / total_bytes * 100).round(2).to_s.rjust(8)}%" if remaining_bytes
-      end
-      response = Excon.get(content["url"], response_block: streamer)
-      unless response.status == 200
-        puts response.inspect
-        raise Error.new("Server problem: #{response.status}")
+      ::CLI::UI::Progress.progress do |bar|
+        downloaded_file = File.open("#{folder}/#{content["s3_key"]}.partial", "w")
+        streamer = lambda do |chunk, remaining_bytes, total_bytes|
+          downloaded_file.write(chunk)
+          bar.tick(set_percent: 1 - (remaining_bytes.to_f / total_bytes).round(2))
+        end
+        response = Excon.get(content["url"], response_block: streamer)
+        unless response.status == 200
+          puts response.inspect
+          raise Error.new("Server problem: #{response.status}")
+        end
+        downloaded_file.close
+        File.rename(downloaded_file, "#{folder}/#{content["s3_key"]}")
+        bar.tick(set_percent: 1)
       end
-      downloaded_file.close
-      print "\n"
-      File.rename(downloaded_file, "#{folder}/#{content["s3_key"]}")
     end
 
     def latest_version?

data/lib/rpw/version.rb

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

data/rpw.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "thor-hollaback"
   spec.add_dependency "excon"
+  spec.add_dependency "cli-ui"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Nate Berkopec
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - nate@speedshop.co