rpw 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205e752e88029cd06e1c2607e139d65981d676833b5bd5c164e67660bc5aad00
-  data.tar.gz: 756763f53c8284c6e580b65c11a0ebbca90a1f0b8e60da5ec45861afe3551af9
+  metadata.gz: d147256fce52a088acb2caa0043222c16dfc73e09292006929e1b9d40372d70a
+  data.tar.gz: 211b34b2aff01a30220d65ad12120a240042634c2f815d91e2e4e72023a9fbf7
 SHA512:
-  metadata.gz: f40dfd8fd934dc4b6c37702d7e31897651f4f4c8fc172a30cce668408b09d161bf60d9172d9d68a556bf84b7d20c5d92b669ea88bd77ec40490ea7ec4d0b37ec
-  data.tar.gz: 286dcb10eda24b9d9b0c4410317e2a85c10a19d55526682143f28a86f09e96ea64aaf0072fd37704435b2024b04d5f3594c98e5db00e77acfa98240ca281f2bf
+  metadata.gz: d2985f855f66246dd289959e287985011ae11e828a2daeb90c4f3e49a45e99b5ee05ba9b0fa67596c9067ec492cf40f548ecc5649e2c6769c6e366d74f402fb8
+  data.tar.gz: ef3be513985a20e01a16249fd2b71e2a026875327fcfe101a83e8da0d05751b7ccd594fd7f984b046f669fa7b49552969967d922d48d00f29767add9906f7d01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpw (0.0.4)
+    rpw (0.0.5)
       thor
       thor-hollaback
       typhoeus

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 0.0.5
+
+* more bugfixes from beta testers
+
 ## 0.0.4
 
 * bugfixes

data/exe/rpw

@@ -18,6 +18,18 @@ 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
 
@@ -66,12 +78,6 @@ module RPW
     def show(content = :current)
       client.show(content, options[:open])
     end
-
-    private
-
-    def exit_with_no_key
-      exit(1) unless client.setup?
-    end
   end
 
   class Progress < SubCommandBase
@@ -104,10 +110,6 @@ module RPW
 
     private
 
-    def exit_with_no_key
-      exit(1) unless client.setup?
-    end
-
     default_task :show
   end
 
@@ -129,6 +131,8 @@ module RPW
     desc "start", "Tutorial and onboarding"
 
     def start
+      warn_if_already_started
+
       print_banner
       say "Welcome to the Rails Performance Workshop."
       say ""
@@ -138,42 +142,24 @@ 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 ""
-      return unless yes? "Are you in a directory that we can safely add new folders and files to? (y/N)"
+      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 create a .rpw_info file at #{File.expand_path("~/.rpw")} to save your purchase key."
+      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: ")
 
       client.setup(key)
-
       puts ""
-
       say "Successfully authenticated with the RPW server and saved your key."
-
-      puts ""
-
-      say "rpw works by downloading files into the current working directory."
-      say "We're going to (idempotently!) create a few directories in the current working directory."
       puts ""
-      return unless yes? "Is that OK? (y/N)"
-
-      client.directory_setup
-
       say "Setup complete!"
       puts ""
-      say "Here are some important commands for you to know:"
-      say "$ rpw lesson next     | Proceed to the next part of the workshop."
-      say "$ rpw lesson complete | Mark current lesson as complete."
-      say "$ rpw lesson list     | List all workshop lessons. Note each lesson is preceded with an ID."
-      say "$ rpw lesson download | Download any or all lessons."
-      say "$ rpw lesson show     | Show any particular workshop lesson."
-      say "$ rpw progress        | Show where you're currently at in the workshop."
-      say "$ rpw help            | Help! You can also ask in Slack."
-      puts ""
-      say "Generally, you'll just be doing a lot of $ rpw lesson next"
+      say "To learn how to use this command-line client, consult README.md."
       say "Remember to ask on Slack for help if you get stuck or encounter bugs."
-      say "Let's get going! $ rpw lesson next"
+      say "Once you're ready to get going: $ rpw lesson next"
     end
 
     no_commands do
@@ -194,6 +180,11 @@ module RPW
       @client ||= RPW::Client.new
     end
 
+    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)"
+    end
+
     def check_version
       unless client.latest_version?
         say "#{r}WARNING: You are running an old version of rpw."

data/lib/README.md

@@ -0,0 +1,11 @@
+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.
+$ rpw lesson show     | Show any particular workshop lesson.
+$ rpw progress        | Show where you're currently at in the workshop.
+$ rpw help            | Help! You can also ask in Slack.
+
+Generally, you'll just be doing a lot of $ rpw lesson next

data/lib/rpw.rb

@@ -74,12 +74,16 @@ module RPW
       gateway.register_email(email)
     end
 
-    def directory_setup
+    def directory_setup(home_dir_ok = true)
       ["video", "quiz", "lab", "text", "cgrp"].each do |path|
         FileUtils.mkdir_p(path) unless File.directory?(path)
       end
 
-      client_data["completed"] = [] # just to write the file
+      if home_dir_ok
+        ClientData.create_in_home!
+      else
+        ClientData.create_in_pwd!
+      end
 
       unless File.exist?(".gitignore") && File.read(".gitignore").match(/rpw_key/)
         File.open(".gitignore", "a") do |f|
@@ -93,6 +97,10 @@ module RPW
           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 next(open_after = false)
@@ -172,6 +180,8 @@ module RPW
     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
@@ -191,9 +201,16 @@ module RPW
     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
+
     private
 
     def finished_workshop
@@ -243,23 +260,27 @@ module RPW
 
     def display_content(content, open_after)
       puts "\nCurrent 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"]}"
+        location = "lab/#{content["s3_key"][0..-8]}"
       when "text"
         location = "lab/#{content["s3_key"]}"
+        openable = true
       when "cgrp"
         puts "The Complete Guide to Rails Performance has been downloaded and extracted to the ./cgrp directory."
         puts "All source code for the CGRP is in the src directory, PDF and other compiled formats are in the release directory."
       end
       if location
+        puts "This file can be opened automatically if you add the --open flag." if openable && !open_after
         puts "Downloaded to:"
         puts location.to_s
-        if open_after
+        if open_after && openable
           exec "#{open_command} #{location}"
         end
       end
@@ -286,7 +307,6 @@ module RPW
     DOTFILE_NAME = ".rpw_info"
 
     def initialize
-      make_sure_dotfile_exists
       data # access file to load
     end
 
@@ -306,16 +326,29 @@ module RPW
       end
     end
 
+    def self.create_in_pwd!
+      FileUtils.touch(File.expand_path("./" + DOTFILE_NAME))
+    end
+
+    def self.create_in_home!
+      FileUtils.mkdir_p("~/.rpw/") unless File.directory?("~/.rpw/")
+      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("./" + self::DOTFILE_NAME))
-        File.expand_path("./" + + self::DOTFILE_NAME)
+      if File.exist?(File.expand_path("./" + DOTFILE_NAME))
+        File.expand_path("./" + DOTFILE_NAME)
       else
-        File.expand_path("~/.rpw/" + self::DOTFILE_NAME)
+        File.expand_path("~/.rpw/" + DOTFILE_NAME)
       end
     end
 
@@ -325,28 +358,12 @@ module RPW
       self.class.filestore_location
     end
 
-    def create_client_data_directory(path)
-      dirname = File.dirname(path)
-      FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
-    end
-
     def data
       @data ||= begin
         yaml = YAML.safe_load(File.read(filestore_location), permitted_classes: [Time])
         yaml || {}
       end
     end
-
-    def make_sure_dotfile_exists
-      return true if File.exist?(filestore_location)
-      create_client_data_directory(filestore_location)
-      begin
-        FileUtils.touch(filestore_location)
-      rescue
-        raise Error, "Could not create the RPW data file at ~/.rpw/ \
-                      Check your file permissions."
-      end
-    end
   end
 
   require "digest"

data/lib/rpw/version.rb

@@ -1,3 +1,3 @@
 module RPW
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nate Berkopec
@@ -70,6 +70,7 @@ files:
 - README.md
 - Rakefile
 - exe/rpw
+- lib/README.md
 - lib/rpw.rb
 - lib/rpw/version.rb
 - rpw.gemspec