learn-co 1.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc8b9c2023ac3e8a100f64fe06afaefc9f76c993
-  data.tar.gz: 22e8f9e293483fae528242e0b959ef2738e31ebc
+  metadata.gz: 9a64ace8ff6539b15f4dbeb1bdfc5dc7f17eb76e
+  data.tar.gz: ec0653a2d7c6fda5e05b8ac1280b0df391f6bc5b
 SHA512:
-  metadata.gz: 67ac18038bfb615cf0a7984684d0570c4eff0f76b63ce4a2c0fa4ba7dae098269699740bb55f934396aa1aa8616c946eadd9e8c2aefc75166ff0bd1ed6f8f909
-  data.tar.gz: 8eb3e6460c650ce66ee5cfbc50a84507329236bb7c1d4a20edbc4eb52de6fa1cc06388b011087ca24763755a7dc0f243214ee4966140e802420eb96d3f1103b1
+  metadata.gz: f3ee1598f566ba6907ca05689db27a194faa6225f790ed3a9ffc836e79681403e7b75e785202ea41e69a32799052aa8732bfd7d5e7388cb8a6362d13e2d47019
+  data.tar.gz: 35c6ea59f7140dfd6b10aab704572ce9c26feb616d28710b3f20f1bab4d45cec8197481fb4275d74c48bf57ec37b7ce744e3e47176eda1bd3b9b90d6fb341065

data/Gemfile

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

data/LICENSE.txt

@@ -20,4 +20,3 @@ 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

@@ -1,6 +1,6 @@
 # learn-co
 
-Runs RSpec, Jasmine, and Python Unit Test test suites and uploads the results to Learn.
+The command line interface to Learn.co.
 
 ## Installation
 
@@ -22,17 +22,16 @@ And then execute:
 
 ## Usage
 
-From within a directory with an RSpec, Jasmine, or Python Unit Test test suite, run:
+From within a Learn.co lesson directory, run:
 
 ```
-$ learn
+$ learn [command]
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/flatiron-labs/learn-gem/fork )
+1. Fork it ( https://github.com/flatiron-labs/learn-co/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

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

data/bin/learn

@@ -1,78 +1,20 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
 require 'learn'
 
-SERVICE_URL = 'http://ironbroker.flatironschool.com'
+NON_PRE_CONFIG_COMMANDS = [
+  'reset', 'whoami', 'directory', 'help', 'version', '--version', '-v'
+]
 
-spec_type = Learn::SpecTypeParser.new.spec_type
-
-unless spec_type == 'jasmine'
-  username = Learn::UsernameParser.get_username
-  user_id = Learn::UserIdParser.get_user_id
+if ['-v', '--version'].include?(ARGV.first)
+  puts Learn::VERSION
+  exit
 end
 
-repo = ARGV.include?("--test") ? "git@github.com:flatiron-school/a-sample-repo.git" : Learn::RepoParser.get_repo
-
-if spec_type == "jasmine"
-  SERVICE_ENDPOINT = '/e/flatiron_jasmine/build/ironboard'
-
-  options = {}
-  OptionParser.new do |opts|
-    opts.banner = "Usage: learn [options]"
-
-    opts.on("-n", "--[no-]color", "Turn off color output") do |c|
-      options[:color] = c
-    end
-
-    opts.on("-l", "--local", "Don't push results to Flatiron LMS") do |l|
-      options[:local] = l
-    end
-
-    opts.on("-b", "--browser", "Run tests in browser") do |b|
-      options[:browser] = b
-    end
-
-    opts.on("-o", "--out FILE") do |o|
-      options[:out] = o
-    end
+Learn::OptionsSanitizer.new(ARGV).sanitize!
 
-    opts.on("-s", "--skip") do |s|
-      options[:skip] = s
-    end
-
-    opts.on("-t", "--test") do |t|
-      options[:test] = t
-    end
-  end.parse!
-
-  if ARGV.any? { |arg| arg == "init" }
-    Learn::Jasmine::Initializer.run
-  else
-    if !options[:skip]
-      Learn::Jasmine::PhantomChecker.check_installation
-      username = Learn::UsernameParser.get_username
-      user_id = Learn::UserIdParser.get_user_id
-    else
-      username = "jasmine-flatiron"
-      user_id = "none"
-    end
-
-    Learn::Jasmine::Runner.run(username, user_id, repo, options)
-  end
-elsif spec_type == "rspec"
-  SERVICE_ENDPOINT = '/e/flatiron_rspec/build/ironboard'
-
-  runner = Learn::RSpec::Runner.new(username, user_id, repo, ARGV)
-  runner.run
-elsif spec_type == 'python_unittest'
-  SERVICE_ENDPOINT = '/e/flatiron_unittest/build/ironboard'
-
-  Learn::PythonUnittest::RequirementsChecker.check_installation
-  Learn::PythonUnittest::NoseInstaller.install
-
-  runner = Learn::PythonUnittest::Runner.new(username, user_id, repo, ARGV)
-  runner.run
-else
-  puts "This directory doesn't appear to have any specs in it."
+if !(NON_PRE_CONFIG_COMMANDS.include?(ARGV[0]))
+  system('learn-config')
 end
+
+Learn::CLI.start(ARGV)

data/learn-co.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name          = "learn-co"
   spec.version       = Learn::VERSION
   spec.authors       = ["Flatiron School"]
-  spec.email         = ["info@flatironschool.com"]
-  spec.summary       = %q{Runs RSpec, Jasmine, and Python Unit Test builds and pushes JSON output to Learn.}
-  spec.homepage      = "http://learn.co"
+  spec.email         = ["learn@flatironschool.com"]
+  spec.summary       = %q{The command line interface to Learn.co.}
+  spec.homepage      = "https://learn.co"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,12 +19,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_runtime_dependency "rspec", "~> 3.0"
-  spec.add_runtime_dependency "netrc"
-  spec.add_runtime_dependency "git", "~> 1.2"
-  spec.add_runtime_dependency "oj", "~> 2.9"
-  spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "crack"
-  spec.add_runtime_dependency "jasmine"
-end
+  spec.add_development_dependency "pry"
 
+  spec.add_runtime_dependency "learn-test", ">= 1.2.2"
+  spec.add_runtime_dependency "learn-config", ">= 1.0.5"
+  spec.add_runtime_dependency "learn-open", ">= 1.1.2"
+  spec.add_runtime_dependency "learn-submit", ">= 1.0.9"
+  spec.add_runtime_dependency "thor"
+end

data/lib/learn.rb

@@ -1,26 +1,9 @@
-require 'fileutils'
-require 'faraday'
-require 'oj'
+require 'thor'
 
 require 'learn/version'
-require 'learn/netrc_interactor'
-require 'learn/github_interactor'
-require 'learn/user_id_parser'
-require 'learn/username_parser'
-require 'learn/repo_parser'
-require 'learn/file_finder'
-require 'learn/spec_type_parser'
-
-require 'learn/rspec/runner'
-
-require 'learn/jasmine/phantom_checker'
-require 'learn/jasmine/initializer'
-require 'learn/jasmine/runner'
-
-require 'learn/python_unittest/requirements_checker'
-require 'learn/python_unittest/nose_installer'
-require 'learn/python_unittest/runner'
+require 'learn/cli'
+require 'learn/options_sanitizer'
+require 'learn/lab/parser'
 
 module Learn
 end
-

data/lib/learn/cli.rb

@@ -0,0 +1,78 @@
+module Learn
+  class CLI < Thor
+    desc '[test] [options]', "Run a lesson's test suite"
+    long_desc <<-LONGDESC
+      `learn [test] [options]` will run your lesson's test suite.
+
+      You can supply the following options when running Jasmine tests:
+
+      --no-color            # Turn off color output
+      \x5 -l, --local       # Don't push results to Learn
+      \x5 -b, --browser     # Run tests in browser
+      \x5 -o, --out FILE    # Specify an output file
+      \x5 -s, --skip        # Don't run dependency checks
+
+      When running an RSpec test suite, all normal RSpec options can be
+      passed in.
+    LONGDESC
+    def test(*opts)
+      system("learn-test #{opts.join(' ')}")
+    end
+
+    desc 'version, -v, --version', 'Display the current version of the Learn gem'
+    def version
+      puts Learn::VERSION
+    end
+
+    desc 'submit ["message"]', 'Submit your completed lesson'
+    long_desc <<-LONGDESC
+      `learn submit ["message"]` will submit your lesson to Learn.
+
+      It will add your changes, commit them, push to GitHub, and issue a pull request.
+    LONGDESC
+    def submit(*opts)
+      system("learn-submit #{opts.join(' ')}")
+    end
+
+    desc "open [lesson-name] [--editor=editor-binary]", "Open your current lesson [or the given lesson] [with your editor]"
+    long_desc <<-LONGDESC
+      `learn open [lesson-name] [--editor=editor-binary]` will open a Learn lesson locally.
+
+      If given no lesson name, it will open your current lesson. By default, it will open
+      using the editor specified in ~/.learn-config.
+
+      If the lesson is an iOS lab, it will open in Xcode. If it is a README, it will open the lesson
+      in your browser.
+    LONGDESC
+    option :editor, required: false, type: :string, aliases: ['e']
+    def open(*lab_name)
+      lab_name = Learn::Lab::Parser.new(lab_name.join(' ')).parse!
+      editor = options[:editor]
+
+      system("learn-open #{lab_name} --editor=#{editor}")
+    end
+
+    desc "next [--editor=editor-binary]", "Open your next lesson [with your editor]"
+    option :editor, required: false, type: :string, aliases: ['e']
+    def next
+      editor = options[:editor]
+
+      system("learn-open --next --editor=#{editor}")
+    end
+
+    desc 'whoami', 'Display your Learn gem configuration information'
+    def whoami
+      system('learn-config --whoami')
+    end
+
+    desc 'reset', 'Reset your Learn gem configuration'
+    def reset
+      system('learn-config --reset')
+    end
+
+    desc 'directory', 'Set your local Learn directory. Defaults to ~/Development/code'
+    def directory
+      system('learn-config --set-directory')
+    end
+  end
+end

data/lib/learn/lab/parser.rb

@@ -0,0 +1,25 @@
+module Learn
+  module Lab
+    class Parser
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def parse!
+        if name.chars.include?(' ')
+          slugify_name!
+        else
+          name.downcase.strip
+        end
+      end
+
+      private
+
+      def slugify_name!
+        name.downcase.gsub(' ', '-').strip
+      end
+    end
+  end
+end

data/lib/learn/options_sanitizer.rb

@@ -0,0 +1,164 @@
+module Learn
+  class OptionsSanitizer
+    attr_reader :args
+
+    SANITIZE_LIST = {
+      '-e' => '--editor'
+    }
+
+    KNOWN_COMMANDS = [
+      'test',
+      'help',
+      'version',
+      '-v',
+      '--version',
+      'submit',
+      'open',
+      'reset',
+      'whoami',
+      'directory',
+      'next'
+    ]
+
+    KNOWN_TEST_FLAGS = [
+      '--no-color',
+      '-b',
+      '--browser',
+      '-s',
+      '--skip'
+    ]
+
+    def initialize(args)
+      @args = args
+    end
+
+    def sanitize!
+      sanitize_editor_arg!
+      sanitize_test_args!
+    end
+
+    private
+
+    # Sanitization methods
+    def sanitize_editor_arg!
+      args.map! do |arg|
+        SANITIZE_LIST[arg] ? SANITIZE_LIST[arg] : arg
+      end
+    end
+
+    def sanitize_test_args!
+      if missing_or_unknown_args?
+        handle_missing_or_unknown_args
+      elsif has_test_command_and_invalid_flag?
+        exit_with_invalid_flag
+      elsif has_test_command_and_output_flag?
+        check_for_output_file(add_test_command: false)
+      end
+    end
+
+    # Arg manipulation methods
+    def handle_missing_or_unknown_args
+      if first_arg_not_a_flag?
+        exit_with_unknown_command
+      elsif has_output_flag?
+        check_for_output_file
+      elsif only_has_flag_arguments?
+        add_test_command
+      else
+        exit_with_cannot_understand
+      end
+    end
+
+    def check_for_output_file(add_test_command: true)
+      index = args.index('-o') || args.index('--out')
+
+      if output_file_specified?(index)
+        initial_arg_index = add_test_command ? 0 : 1
+        out_arg = "#{args[index]} #{args[index+1]}"
+        delete_output_file_args!(index)
+
+        if only_has_known_test_flags?(initial_arg_index)
+          rebuild_args!(output_file_arg: out_arg, add_test_command: add_test_command)
+        else
+          exit_with_unknown_flags
+        end
+      else
+        exit_with_missing_output_file
+      end
+    end
+
+    def delete_output_file_args!(index)
+      args.delete_at(index+1)
+      args.delete_at(index)
+    end
+
+    def rebuild_args!(output_file_arg:, add_test_command:)
+      args.unshift('test') if add_test_command
+      args.push(output_file_arg)
+    end
+
+    def add_test_command
+      args.unshift('test')
+    end
+
+    # Arg check methods
+    def missing_or_unknown_args?
+      args.empty? || !KNOWN_COMMANDS.include?(args[0])
+    end
+
+    def first_arg_not_a_flag?
+      args[0] && !args[0].start_with?('-')
+    end
+
+    def has_output_flag?
+      args.any? {|arg| ['-o', '--out'].include?(arg)}
+    end
+
+    def only_has_known_test_flags?(start_index)
+      args[start_index..-1].all? {|arg| KNOWN_TEST_FLAGS.include?(arg)}
+    end
+
+    def output_file_specified?(index)
+      args[index+1] && !args[index+1].start_with?('-')
+    end
+
+    def only_has_flag_arguments?
+      args.all? {|arg| arg.start_with?('-')}
+    end
+
+    def has_test_command_and_invalid_flag?
+      args[0] == 'test' && args[1] && !args[1].start_with?('-')
+    end
+
+    def has_test_command_and_output_flag?
+      args[0] == 'test' && args.any? {|arg| ['-o', '--out'].include?(arg)}
+    end
+
+    # Exit methods
+    def exit_with_invalid_flag
+      puts "Invalid flag: #{args[1]}"
+      exit
+    end
+
+    def exit_with_unknown_command
+      puts "Unknown command: #{args[0]}. Type `learn help` to see what you can do."
+      exit
+    end
+
+    def exit_with_cannot_understand
+      puts "Sorry, I can't understand what you're trying to do. Type `learn help` for help."
+      exit
+    end
+
+    def exit_with_unknown_flags
+      unknown_flags = args.select {|arg| !KNOWN_TEST_FLAGS.include?(arg)}
+      puts "Unknown #{unknown_flags.count > 1 ? 'flags' : 'flag'}: #{unknown_flags.join(', ')}"
+      exit
+    end
+
+    def exit_with_missing_output_file
+      puts "Must specify an output file when using the -o, --out flag."
+      exit
+    end
+  end
+end