learn-open 1.2.20 → 1.2.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f1f69010fe0e78ce9ea308799cc36239e7d77603
-  data.tar.gz: eee935ee7c0a6f6db0d7efbcc76ed290568ac493
+SHA256:
+  metadata.gz: d0d170cc7e2457803701a5055afdd38f3ec5022f23f37b7e1a7d25a994fd5a80
+  data.tar.gz: d598a192eb8111e123d7e9d4fb7b6d82575d86dd48d4c5ca5c40ed1c65aee468
 SHA512:
-  metadata.gz: ded2346040ba1f197e1803afa95d7ddfc405c3f7894c50fde7193e0f42cdb07ece60c747480d359f193048b86d87ae65adf96d18f3f5b592eac1d5a299dec8aa
-  data.tar.gz: 9cd45be0f1435ac08a9fa4a52a38e3c5ee03f8c9fe3a2e0dbc26ae2756f293695930350494420be5126b600c34f097e081f764e990bf05a7b5b39428bbcfba2f
+  metadata.gz: 240272e5222130bc341d4e28de8edf12448fcb9ac2562437e0a0d1f39521274a585c17a222807a27cf36dfa74adbf727791490f11e0304c4ae3f981a25eb90b3
+  data.tar.gz: 79ec8c12d8b4f03048a1ec8def1a08a49b02f1a95b001bc3b195272ae006da4dfbda72828074da245fcb2f34194c2ed56c04b01182d49a2620dadb126f4e6619

data/.gitignore

@@ -13,3 +13,7 @@
 *.a
 *.gem
 mkmf.log
+notes
+*swp
+*swo
+.idea/

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/learn-open.gemspec

@@ -18,7 +18,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "bin"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "fakefs",  "~> 0.14.2"
+  spec.add_development_dependency "pry",     "~> 0.11.1"
+  spec.add_development_dependency "rspec-core","~> 3.7.1"
+  spec.add_development_dependency "rspec-mocks","~> 3.7.0"
+  spec.add_development_dependency "diff-lcs", "~> 1.3"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.0"
 
   spec.add_runtime_dependency "netrc"
   spec.add_runtime_dependency "git"

data/lib/learn_open.rb

@@ -3,10 +3,76 @@ require 'netrc'
 require 'git'
 require 'learn_web'
 require 'timeout'
+require 'json'
 
 require 'learn_open/version'
 require 'learn_open/opener'
 require 'learn_open/argument_parser'
+require 'learn_open/adapters/system_adapter'
+require 'learn_open/adapters/learn_web_adapter'
+require 'learn_open/adapters/io_adapter'
+require 'learn_open/environments'
+require 'learn_open/environments/base_environment'
+require 'learn_open/environments/mac_environment'
+require 'learn_open/environments/linux_environment'
+require 'learn_open/environments/generic_environment'
+require 'learn_open/environments/ide_environment'
+require 'learn_open/environments/jupyter_container_environment'
+require 'learn_open/services/dependency_installers'
+require 'learn_open/services/dependency_installers/base_installer'
+require 'learn_open/services/dependency_installers/gem_installer'
+require 'learn_open/services/dependency_installers/jupyter_pip_installer'
+require 'learn_open/services/dependency_installers/node_package_installer'
+require 'learn_open/services/dependency_installers/pip_installer'
+require 'learn_open/services/lesson_downloader'
+require 'learn_open/services/file_backup_starter'
+require 'learn_open/services/logger'
+require 'learn_open/lessons'
+require 'learn_open/lessons/base_lesson'
+require 'learn_open/lessons/jupyter_lesson'
+require 'learn_open/lessons/readme_lesson'
+require 'learn_open/lessons/ios_lesson'
+require 'learn_open/lessons/lab_lesson'
 
 module LearnOpen
+  def self.learn_web_client
+    @client ||= begin
+      _login, token = Netrc.read['learn-config']
+      LearnWeb::Client.new(token: token)
+    end
+  end
+
+  def self.logger
+    @logger ||= begin
+      home_dir = File.expand_path("~")
+      Logger.new("#{home_dir}/.learn-open-tmp")
+    end
+  end
+
+  def self.default_io
+    LearnOpen::Adapters::IOAdapter.new(input: STDIN, output: Kernel)
+  end
+
+  def self.git_adapter
+    Git
+  end
+
+  def self.environment_vars
+    ENV
+  end
+
+  def self.system_adapter
+    LearnOpen::Adapters::SystemAdapter
+  end
+
+  def self.platform
+    RbConfig::CONFIG['host_os']
+  end
+
+  def self.lessons_directory
+    @lesson_directory ||= begin
+      home_dir = File.expand_path("~")
+      YAML.load(File.read("#{home_dir}/.learn-config"))[:learn_directory]
+    end
+  end
 end

data/lib/learn_open/adapters/io_adapter.rb

@@ -0,0 +1,24 @@
+module LearnOpen
+  module Adapters
+    class IOAdapter
+      attr_reader :input, :output
+
+      def initialize(input:, output:)
+        @input = input
+        @output = output
+      end
+
+      def puts(*message)
+        output.puts(*message)
+      end
+
+      def print(*message)
+        output.print(*message)
+      end
+
+      def gets
+        input.gets
+      end
+    end
+  end
+end

data/lib/learn_open/adapters/learn_web_adapter.rb

@@ -0,0 +1,103 @@
+module LearnOpen
+  module Adapters
+    class LearnWebAdapter
+      attr_reader :client
+
+      def initialize(options = {})
+        @client = options.fetch(:learn_web_client) {LearnOpen.learn_web_client}
+      end
+
+      def fetch_lesson_data(target_lesson: false, fetch_next_lesson: false)
+        if opening_current_lesson?(target_lesson, fetch_next_lesson)
+          load_current_lesson
+          {
+              lesson: current_lesson,
+              id: current_lesson.id,
+              later_lesson: false
+          }
+        elsif opening_next_lesson?(target_lesson, fetch_next_lesson)
+          load_next_lesson
+          {
+              lesson: next_lesson,
+              id: next_lesson.id,
+              later_lesson: false
+          }
+        else
+          lesson = get_lesson(target_lesson)
+          {
+              lesson: lesson,
+              id: lesson.lesson_id,
+              later_lesson: lesson.later_lesson
+          }
+        end
+      end
+
+      def opening_current_lesson?(target_lesson, fetch_next_lesson)
+        !target_lesson && !fetch_next_lesson
+      end
+
+      def opening_next_lesson?(target_lesson, fetch_next_lesson)
+        !target_lesson && fetch_next_lesson
+      end
+
+      def current_lesson
+        @current_lesson ||= client.current_lesson
+      end
+
+      def next_lesson
+        @next_lesson ||= client.next_lesson
+      end
+
+      def load_current_lesson(retries = 3)
+        begin
+          Timeout::timeout(15) do
+            current_lesson
+          end
+        rescue Timeout::Error
+          if retries > 0
+            io.puts "There was a problem getting your lesson from Learn. Retrying..."
+            load_current_lesson(retries - 1)
+          else
+            io.puts "There seems to be a problem connecting to Learn. Please try again."
+            logger.log('ERROR: Error connecting to Learn')
+            exit
+          end
+        end
+      end
+
+      def load_next_lesson(retries = 3)
+        begin
+          Timeout::timeout(15) do
+            next_lesson
+          end
+        rescue Timeout::Error
+          if retries > 0
+            io.puts "There was a problem getting your next lesson from Learn. Retrying..."
+            load_next_lesson(retries - 1)
+          else
+            io.puts "There seems to be a problem connecting to Learn. Please try again."
+            logger.log('ERROR: Error connecting to Learn')
+            exit
+          end
+        end
+      end
+
+      def get_lesson(target_lesson, retries = 3)
+        @correct_lesson ||= begin
+          Timeout::timeout(15) do
+            client.validate_repo_slug(repo_slug: target_lesson)
+          end
+        rescue Timeout::Error
+          if retries > 0
+            io.puts "There was a problem connecting to Learn. Retrying..."
+            get_lesson(target_lesson, retries - 1)
+          else
+            io.puts "Cannot connect to Learn right now. Please try again."
+            logger.log('ERROR: Error connecting to Learn')
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/learn_open/adapters/system_adapter.rb

@@ -0,0 +1,30 @@
+module LearnOpen
+  module Adapters
+    class SystemAdapter
+      def self.open_editor(editor, path:)
+        system("#{editor} .")
+      end
+
+      def self.open_login_shell(shell)
+        exec("#{shell} -l")
+      end
+
+      def self.watch_dir(dir, action)
+        spawn("while inotifywait -qre create,delete,move,close_write #{dir}; do #{action}; done")
+      end
+
+      def self.spawn(command, block: false)
+        pid = Process.spawn(command, [:out, :err] => File::NULL)
+        Process.waitpid(pid) if block
+      end
+
+      def self.run_command(command)
+        system(command)
+      end
+
+      def self.change_context_directory(dir)
+        Dir.chdir(dir)
+      end
+    end
+  end
+end

data/lib/learn_open/environments.rb

@@ -0,0 +1,35 @@
+module LearnOpen
+  module Environments
+    def self.classify(options)
+      environment_vars = options.fetch(:environment_vars, LearnOpen.environment_vars)
+      platform = options.fetch(:platform, LearnOpen.platform)
+      if jupyter_container?(environment_vars)
+        JupyterContainerEnvironment.new(options)
+      elsif ide_environment?(environment_vars)
+        IDEEnvironment.new(options)
+      elsif on_mac?(platform)
+        MacEnvironment.classify(options)
+      elsif on_linux?(platform)
+        LinuxEnvironment.new(options)
+      else
+        GenericEnvironment.new(options)
+      end
+    end
+
+    def self.jupyter_container?(environment_vars)
+      environment_vars['JUPYTER_CONTAINER'] == "true"
+    end
+
+    def self.ide_environment?(environment_vars)
+      environment_vars['IDE_CONTAINER'] == "true"
+    end
+
+    def self.on_mac?(platform)
+      !!platform.match(/darwin/)
+    end
+
+    def self.on_linux?(platform)
+      !!platform.match(/linux/)
+    end
+  end
+end

data/lib/learn_open/environments/base_environment.rb

@@ -0,0 +1,70 @@
+module LearnOpen
+  module Environments
+    class BaseEnvironment
+
+      attr_reader :io, :environment_vars, :system_adapter, :options, :logger
+
+      def initialize(options={})
+        @io = options.fetch(:io) { LearnOpen.default_io }
+        @environment_vars = options.fetch(:environment_vars) { LearnOpen.environment_vars }
+        @system_adapter = options.fetch(:system_adapter) { LearnOpen.system_adapter }
+        @logger = options.fetch(:logger) { LearnOpen.logger }
+        @options = options
+      end
+
+      def open_jupyter_lab(lesson, location, editor)
+        :noop
+      end
+
+      def open_lab(lesson, location, editor)
+        case lesson
+        when LearnOpen::Lessons::IosLesson
+          io.puts "You need to be on a Mac to work on iOS lessons."
+        else
+          download_lesson(lesson, location)
+          open_editor(lesson, location, editor)
+          install_dependencies(lesson, location)
+          notify_of_completion
+          open_shell
+        end
+      end
+
+      def install_dependencies(lesson, location)
+        DependencyInstallers.run_installers(lesson, location, self, options)
+      end
+
+      def download_lesson(lesson, location)
+        LessonDownloader.call(lesson, location, options)
+      end
+
+      def open_editor(lesson, location, editor)
+        io.puts "Opening lesson..."
+        system_adapter.change_context_directory(lesson.to_path)
+        system_adapter.open_editor(editor, path: ".")
+      end
+
+      def start_file_backup(lesson, location)
+        FileBackupStarter.call(lesson, location, options)
+      end
+
+      def open_shell
+        system_adapter.open_login_shell(environment_vars['SHELL'])
+      end
+
+      def notify_of_completion
+        logger.log("Done.")
+        io.puts "Done."
+      end
+
+      def warn_if_necessary(lesson)
+        return unless lesson.later_lesson
+
+        io.puts 'WARNING: You are attempting to open a lesson that is beyond your current lesson.'
+        io.print 'Are you sure you want to continue? [Yn]: '
+
+        warn_response = io.gets.chomp.downcase
+        exit if !['yes', 'y'].include?(warn_response)
+      end
+    end
+  end
+end