learn-open 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b1416ac2cc4269301b050a0cadf8cde655a72d3
+  data.tar.gz: 64abe5d3070fcc33cdc1d118b8123bd166eda402
+SHA512:
+  metadata.gz: 19374d28e259f3aef1ee701e8dd3d3df8a1e58c09638af93c71fd223ce10694ff363aab58c541b063aab463d91d8cf3ff8855ea26869da56e0edbab4867f1971
+  data.tar.gz: 76f77515c889ea771a953b91daa7a23742893219a2ef8942034be0c13a27c403aadaf39dd5204bd21d6849ad3aab56554d0201879cb18e828dd0a0a8728491a2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in learn-open.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Flatiron School
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# learn-open
+
+Open Learn lessons locally
+
+## Installation
+
+Install with:
+
+```
+$ gem install learn-open
+```
+
+Alternatively, add this line to your application's Gemfile:
+
+```ruby
+gem 'learn-open'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Run:
+
+```
+$ learn-open lesson-name [--editor=editor-binary]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/flatiron-labs/learn-open/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/learn-open

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'learn_open'
+
+lesson, editor_specified = LearnOpen::ArgumentParser.new(ARGV).execute
+
+LearnOpen::Opener.run(lesson: lesson, editor_specified: editor_specified)

data/learn-open.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'learn_open/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "learn-open"
+  spec.version       = LearnOpen::VERSION
+  spec.authors       = ["Flatiron School"]
+  spec.email         = ["learn@flatironschool.com"]
+  spec.summary       = %q{Open Learn lessons locally}
+  spec.homepage      = "https://learn.co"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "bin"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "netrc"
+  spec.add_runtime_dependency "git"
+  spec.add_runtime_dependency "learn-web", ">= 1.0.0"
+end

data/lib/learn_open/argument_parser.rb

@@ -0,0 +1,29 @@
+module LearnOpen
+  class ArgumentParser
+    attr_reader :args
+
+    def initialize(args)
+      @args = args
+    end
+
+    def execute
+      config_path = File.expand_path('~/.learn-config')
+      editor_data = YAML.load(File.read(config_path))[:editor]
+      lesson = nil
+
+      configured_editor = !(editor_data.empty? || editor_data.nil?) ? editor_data : nil
+      editor_specified = ARGV.detect {|arg| arg.start_with?('--editor=')}.match(/\-\-editor=(.+)/) || configured_editor
+      open_after = !!editor_specified
+
+      if !ARGV[0].start_with?('--editor=')
+        lesson = ARGV[0]
+      end
+
+      if open_after
+        editor_specified = editor_specified.is_a?(String) ? editor_specified : editor_specified[1]
+      end
+
+      [lesson, editor_specified]
+    end
+  end
+end

data/lib/learn_open/opener.rb

@@ -0,0 +1,234 @@
+module LearnOpen
+  class Opener
+    attr_reader   :editor, :client, :lessons_dir
+    attr_accessor :lesson, :repo_dir, :lesson_is_lab, :lesson_id
+
+    def self.run(lesson:, editor_specified:)
+      new(lesson, editor_specified).run
+    end
+
+    def initialize(lesson, editor)
+      _login, token = Netrc.read['learn-config']
+      @client       = LearnWeb::Client.new(token: token)
+
+      @lesson       = lesson
+      @editor       = editor
+      @lessons_dir  = YAML.load(File.read(File.expand_path('~/.learn-config')))[:learn_directory]
+    end
+
+    def run
+      set_lesson
+
+      if lesson_is_readme?
+        open_readme
+      else
+        fork_repo
+        clone_repo
+        open_with_editor
+        cd_to_lesson
+      end
+    end
+
+    private
+
+    def set_lesson
+      if !lesson
+        puts "Getting current lesson..."
+        self.lesson        = get_current_lesson_forked_repo
+        self.lesson_is_lab = current_lesson.lab
+        self.lesson_id     = current_lesson.id
+      else
+        puts "Looking for lesson..."
+        self.lesson        = ensure_correct_lesson.repo_slug
+        self.lesson_is_lab = correct_lesson.lab
+        self.lesson_id     = correct_lesson.lesson_id
+      end
+
+      self.repo_dir = lesson.split('/').last
+    end
+
+    def current_lesson
+      @current_lesson ||= client.current_lesson
+    end
+
+    def get_current_lesson_forked_repo(retries=3)
+      begin
+        Timeout::timeout(15) do
+          current_lesson.forked_repo
+        end
+      rescue Timeout::Error
+        if retries > 0
+          puts "There was a problem getting your lesson from Learn. Retrying..."
+          get_current_lesson_forked_repo(retries-1)
+        else
+          puts "There seems to be a problem connecting to Learn. Please try again."
+          exit
+        end
+      end
+    end
+
+    def ensure_correct_lesson
+      correct_lesson
+    end
+
+    def correct_lesson(retries=3)
+      @correct_lesson ||= begin
+        Timeout::timeout(15) do
+          client.validate_repo_slug(repo_slug: lesson)
+        end
+      rescue Timeout::Error
+        if retries > 0
+          puts "There was a problem connecting to Learn. Retrying..."
+          correct_lesson(retries-1)
+        else
+          puts "Cannot connect to Learn right now. Please try again."
+          exit
+        end
+      end
+    end
+
+    def fork_repo(retries=3)
+      if !repo_exists?
+        puts "Forking lesson..."
+        begin
+          Timeout::timeout(15) do
+            client.fork_repo(repo_name: repo_dir)
+          end
+        rescue Timeout::Error
+          if retries > 0
+            puts "There was a problem forking this lesson. Retrying..."
+            fork_repo(retries-1)
+          else
+            puts "There is an issue connecting to Learn. Please try again."
+            exit
+          end
+        end
+      end
+    end
+
+    def clone_repo(retries=3)
+      if !repo_exists?
+        puts "Cloning lesson..."
+        begin
+          Timeout::timeout(15) do
+            Git.clone("git@github.com:#{lesson}.git", repo_dir, path: lessons_dir)
+          end
+        rescue Timeout::Error
+          if retries > 0
+            puts "There was a problem cloning this lesson. Retrying..."
+            clone_repo(retries-1)
+          else
+            puts "Cannot clone this lesson right now. Please try again."
+            exit
+          end
+        end
+      end
+    end
+
+    def repo_exists?
+      File.exists?("#{lessons_dir}/#{repo_dir}")
+    end
+
+    def open_with_editor
+      if ios_lesson?
+        open_ios_lesson
+      elsif editor
+        system("cd #{lessons_dir}/#{repo_dir} && #{editor} .")
+      end
+    end
+
+    def ios_lesson?
+      languages   = YAML.load(File.read("#{lessons_dir}/#{repo_dir}/.learn"))['languages']
+      ios_lang    = languages.any? {|l| ['objc', 'swift'].include?(l)}
+
+      ios_lang || xcodeproj_file? || xcworkspace_file?
+    end
+
+    def open_ios_lesson
+      if can_open_ios_lesson?
+        open_xcode
+      else
+        puts "You need to be on a Mac to work on iOS lessons."
+        exit
+      end
+    end
+
+    def can_open_ios_lesson?
+      on_mac?
+    end
+
+    def open_xcode
+      if xcworkspace_file?
+        system("cd #{lessons_dir}/#{repo_dir} && open *.xcworkspace")
+      elsif xcodeproj_file?
+        system("cd #{lessons_dir}/#{repo_dir} && open *.xcodeproj")
+      end
+    end
+
+    def xcodeproj_file?
+      Dir.glob("#{lessons_dir}/#{repo_dir}/*.xcodeproj").any?
+    end
+
+    def xcworkspace_file?
+      Dir.glob("#{lessons_dir}/#{repo_dir}/*.xcworkspace").any?
+    end
+
+    def cd_to_lesson
+      puts "Opening lesson..."
+      Dir.chdir("#{lessons_dir}/#{repo_dir}")
+      bundle_install
+      puts "Done."
+      exec(ENV['SHELL'])
+    end
+
+    def bundle_install
+      # TODO: Don't bundle for other types of labs either
+      if !ios_lesson?
+        puts "Bundling..."
+        system("bundle install &>/dev/null")
+      end
+    end
+
+    def lesson_is_readme?
+      !lesson_is_lab
+    end
+
+    def open_readme
+      if can_open_readme?
+        puts "Opening readme..."
+        launch_browser
+      else
+        puts "You need to be running this on a Mac to open a Readme from the command line."
+        exit
+      end
+    end
+
+    def launch_browser
+      if chrome_installed?
+        open_chrome
+      else
+        open_safari
+      end
+    end
+
+    def chrome_installed?
+      File.exists?('/Applications/Google Chrome.app')
+    end
+
+    def open_chrome
+      system("open -a 'Google Chrome' https://learn.co/lessons/#{lesson_id}")
+    end
+
+    def open_safari
+      system("open -a Safari https://learn.co/lessons/#{lesson_id}")
+    end
+
+    def can_open_readme?
+      on_mac?
+    end
+
+    def on_mac?
+      !!RUBY_PLATFORM.match(/darwin/)
+    end
+  end
+end

data/lib/learn_open/version.rb

@@ -0,0 +1,3 @@
+module LearnOpen
+  VERSION = '1.0.0'
+end

data/lib/learn_open.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+require 'netrc'
+require 'git'
+require 'learn_web'
+require 'timeout'
+
+require 'learn_open/version'
+require 'learn_open/opener'
+require 'learn_open/argument_parser'
+
+module LearnOpen
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: learn-open
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Flatiron School
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  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'
+- !ruby/object:Gem::Dependency
+  name: git
+  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'
+- !ruby/object:Gem::Dependency
+  name: learn-web
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email:
+- learn@flatironschool.com
+executables:
+- learn-open
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/learn-open
+- learn-open.gemspec
+- lib/learn_open.rb
+- lib/learn_open/argument_parser.rb
+- lib/learn_open/opener.rb
+- lib/learn_open/version.rb
+homepage: https://learn.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Open Learn lessons locally
+test_files: []