learn-lab 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f02fc168601cfde48fab19367a3a9fcb2fa5a88f0c010e507b4c71329e06ecc2
+  data.tar.gz: d3e0e54341575734de538394c133a1b40952cf33dfb9481065a03d518e6e6650
+SHA512:
+  metadata.gz: fda10060c1877e47e94b7d933b5adff5ea921e564732f93631d13d2c05cd06585034f4915df81573607734d9b043b5872da879baf126210386d17bbf8c101b7b
+  data.tar.gz: 0a8df382daa76d1b2ce64e134c30fec8d833620701783be28fdee2224448b98889a70387cf8605a755a2f6a9832e9fcc8944fdbde8ffe05775c08b1db3611e77

data/.circleci/config.yml

@@ -0,0 +1,48 @@
+version: 2.1
+jobs:
+  build:
+    parallelism: 1
+    docker:
+      - image: circleci/ruby:2.6.5-node-browsers
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "learn-lab.gemspec" }}
+          - v1-dependencies-
+      - run:
+          name: Install Dependencies
+          command: |
+            ./bin/setup circleci
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "learn-lab.gemspec" }}
+      - run:
+          name: Run CI Script
+          command: |
+            ./bin/ci
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+workflows:
+  build:
+    jobs:
+      - build
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - build
+experimental:
+  notify:
+    branches:
+      only: master

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/fixtures/**/node_modules/
+/spec/reports/
+/test-results/
+/tmp/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--exclude-pattern spec/fixtures/**/*

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+    NewCops: enable
+    Exclude:
+        - 'Gemfile'
+        - 'Rakefile'
+        - 'bin/*'
+        - 'spec/fixtures/**/*'
+        - 'tmp/**/*'
+        - 'vendor/bundle/**/*'
+    TargetRubyVersion: 2.5
+
+Layout/SpaceAroundEqualsInParameterDefault:
+    EnforcedStyle: no_space
+
+Metrics/BlockLength:
+    ExcludedMethods:
+        - describe
+        - context
+        - it
+
+Layout/LineLength:
+    Max: 89
+
+Style/BlockDelimiters:
+    EnforcedStyle: braces_for_chaining
+
+Style/RaiseArgs:
+    EnforcedStyle: compact
+
+Style/YodaCondition:
+    EnforcedStyle: require_for_equality_operators_only

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+### Changed
+### Removed
+### Fixed
+
+## [0.1.0.rc1]
+Initial version with support for `config` and `test` commands.
+
+[Unreleased]: https://github.com/flatiron-labs/learn-lab/compare/v0.1.0.rc1...HEAD
+[0.1.0]: https://github.com/flatiron-labs/learn-lab/releases/tag/v0.1.0.rc1

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2020 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,72 @@
+# Learn Lab
+
+The command line interface for Flatiron School enterprise.
+
+## Installation
+
+To install the gem, run:
+
+```
+$ gem install learn-lab
+```
+
+then run:
+
+```
+$ learn-lab config
+```
+
+to configure your settings.
+
+## Usage
+
+From within a lesson directory, run:
+
+```
+$ learn-lab [command]
+```
+
+To see a list of available commands, run:
+
+```
+$ learn-lab help
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+This project uses RSpec for tests, and Rubocop for linting code. The default
+Bundler generated scripts provided for both are in the `bin` folder. CI is
+done through
+[CircleCI](https://app.circleci.com/pipelines/github/flatiron-labs/learn-lab). All pushes to any branch will trigger a build that runs specs and lints the code.
+
+### Cutting a New Release
+
+Steps for releasing a new version:
+
+* update the version number in `version.rb`
+* update the CHANGELOG
+  - create a new release heading with the new version number and date
+  - create an empty [Unreleased] section with empty headings
+  - update links at the bottom to reflect new version
+* commit the changes with a message like: "Prepping for release x.x.x"
+* run `bundle exec rake release` -- this will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org)
+* post a message in the `#engineering-all-staff` Slack channel announcing the new release
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+[GitHub](https://github.com/flatiron-labs/learn-lab/issues). To submit a pull request:
+
+1. [Fork](https://github.com/flatiron-labs/learn-lab/fork) the repo
+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
+
+## License
+
+Licensed under the [MIT License](https://github.com/flatiron-labs/learn-lab/blob/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec lint]
+
+desc 'Lint code with Rubocop'
+task :lint do
+  exec('./bin/rubocop .')
+end

data/bin/ci

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+echo "== Running Specs =="
+./bin/rspec --format RspecJunitFormatter --out test-results/rspec/results.xml --format progress
+
+echo "== Linting Code =="
+./bin/rubocop

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "learn_lab"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+if [ "${1-}" = "circleci" ]; then
+    echo "== Installing Bundler =="
+    gem install bundler:2.1.4
+    echo "== Running Bundle Install =="
+    bundle install --jobs=4 --retry=3 --path ./vendor/bundle && bundle clean
+else
+    echo "== Running Bundle Install =="
+    bundle install
+fi
+
+echo "== Running NPM Install for Spec Fixtures =="
+npm install --prefix spec/fixtures/mocha/mocha-app/
+npm install --prefix  spec/fixtures/mocha/mocha-with-failures/

data/exe/learn-lab

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'learn_lab'
+
+LearnLab::CLI.start(ARGV)

data/learn-lab.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/learn_lab/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'learn-lab'
+  spec.version = LearnLab::VERSION
+  spec.authors = ['Flatiron School']
+  spec.email = ['learn@flatironschool.com']
+
+  spec.summary = 'The command line interface for Flatiron School enterprise.'
+  spec.homepage = 'https://github.com/flatiron-labs/learn-lab'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  spec.metadata['changelog_uri'] = 'https://github.com/flatiron-labs/learn-lab/blob/master/CHANGELOG.md'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = ['learn-lab']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'aruba', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+
+  spec.add_runtime_dependency 'git', '~> 1.7'
+  spec.add_runtime_dependency 'thor', '~> 1.0'
+end

data/lib/learn_lab.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'git'
+require 'thor'
+require 'yaml'
+
+require 'learn_lab/configuration'
+require 'learn_lab/errors'
+require 'learn_lab/file_system'
+require 'learn_lab/prompt'
+require 'learn_lab/test/runner'
+require 'learn_lab/test/parsers/mocha'
+require 'learn_lab/test/parsers/null'
+require 'learn_lab/test/parsers/rspec'
+require 'learn_lab/test/strategy'
+require 'learn_lab/test/strategies/mocha'
+require 'learn_lab/test/strategies/none'
+require 'learn_lab/test/strategies/rspec'
+require 'learn_lab/token'
+require 'learn_lab/vcs'
+require 'learn_lab/version'
+
+require 'learn_lab/cli'
+
+# Top-level module
+#
+module LearnLab
+  def self.file_system
+    FileSystem.new
+  end
+end

data/lib/learn_lab/cli.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module LearnLab
+  # Command-line interface.
+  #
+  class CLI < Thor
+    desc 'test', 'Run tests and get a token'
+    long_desc <<-LONG_DESC
+      `learn-lab test` will run your tests and output a token that can be
+      copy/pasted into Canvas.
+    LONG_DESC
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def test
+      configuration = Configuration.open
+      unless configuration.valid?
+        puts 'Please run `learn-lab config` first'
+        exit 0
+      end
+      repo = VCS.new(LearnLab.file_system.pwd)
+      results = LearnLab::Test::Runner.new(repo).run
+      exit 0 unless results[:failure_count].zero?
+      token = Token.new(configuration.email, repo.remote_url)
+      puts "Your token is:\n\n"
+      puts chunk(token.encoded, 30)
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    desc 'config', 'Configure gem'
+    long_desc <<-LONG_DESC
+      `learn-lab config` will configure this gem. It will prompt you for any
+      information it needs and save the configuration to a file in your $HOME directory.
+    LONG_DESC
+    def config
+      configuration = Configuration.open
+      email = configuration.email || '<not set>'
+
+      question = "Enter the email you use to log into Canvas\n" \
+        "(your current email is '#{email}'):"
+
+      prompt = Prompt.new
+
+      # TODO: What kind of email validation do we want here?
+      configuration.email = prompt.ask(question) { |value| !value.empty? }
+
+      configuration.save!
+      puts 'Configuration saved!'
+    end
+
+    private
+
+    def chunk(string, size)
+      string.scan(/.{1,#{size}}/)
+    end
+  end
+end

data/lib/learn_lab/configuration.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module LearnLab
+  # Interface for dealing with persisted configuration file in YAML format.
+  #
+  class Configuration
+    attr_reader :path, :fs
+    attr_accessor :email
+
+    def self.open(filename='enterprise.yml', **options)
+      fs = options.fetch(:fs) { LearnLab.file_system }
+      path = fs.join(fs.home, '.flatiron-school', filename)
+      data = fs.read_yaml_file(path)
+      new(path, data)
+    rescue ConfigurationError
+      path = fs.join(fs.home, '.flatiron-school', 'enterprise.yml')
+      new(path, {})
+    end
+
+    def initialize(path, data, **options)
+      @path = path
+      @fs = options.fetch(:fs) { LearnLab.file_system }
+      @email = data[:email]
+    end
+
+    def save!
+      directory = fs.dirname(path)
+      fs.mkdir(directory) unless fs.directory?(directory)
+      fs.write_yaml_file(path, payload, mode: 'w')
+    end
+
+    def valid?
+      !email.nil?
+    end
+
+    private
+
+    def payload
+      { 'email' => email }
+    end
+  end
+end

data/lib/learn_lab/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module LearnLab
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class MissingDependencyError < Error; end
+end

data/lib/learn_lab/file_system.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module LearnLab
+  # Wraps file system related commands.
+  #
+  class FileSystem
+    def read_file(path)
+      File.read(path)
+    end
+
+    def read_yaml_file(path, fallback: {})
+      data = YAML.load_file(path, fallback: fallback)
+      data.transform_keys(&:to_sym)
+    rescue Errno::ENOENT, Psych::SyntaxError => e
+      raise ConfigurationError.new(e)
+    end
+
+    def read_json_file(path)
+      data = File.exist?(path) ? read_file(path) : '{}'
+      JSON.parse(data, symbolize_names: true)
+    end
+
+    def home
+      Dir.home
+    end
+
+    def pwd
+      FileUtils.pwd
+    end
+
+    def join(*args)
+      File.join(*args)
+    end
+
+    def dirname(path)
+      File.dirname(path)
+    end
+
+    def mkdir(path)
+      FileUtils.mkdir_p(path)
+    end
+
+    def directory?(path)
+      File.directory?(path)
+    end
+
+    def write_yaml_file(path, data, **options)
+      File.write(path, data.to_yaml, **options)
+    end
+
+    def file_exist?(path)
+      File.exist?(path)
+    end
+
+    def dir_exist?(path)
+      Dir.exist?(path)
+    end
+
+    def dir_entries(path)
+      Dir.entries(path)
+    end
+
+    def rm(path)
+      FileUtils.rm(path)
+    end
+  end
+end

data/lib/learn_lab/prompt.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LearnLab
+  # Special prompt that keeps asking for input until it is valid.
+  #
+  class Prompt
+    attr_reader :output
+
+    def initialize(output=$stdout)
+      @output = output
+    end
+
+    def ask(question, &block)
+      input_is_valid = false
+      until input_is_valid
+        output.print("\n#{question} > ")
+        answer = $stdin.gets.chomp
+        input_is_valid = block_given? ? block.call(answer) : true
+      end
+
+      answer
+    end
+  end
+end

data/lib/learn_lab/test/parsers/mocha.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    module Parsers
+      # Parse Mocha test result output
+      #
+      class Mocha
+        attr_reader :output
+
+        def initialize(output)
+          @output = output
+        end
+
+        def framework
+          'mocha'
+        end
+
+        def duration
+          output ? output[:stats][:duration] : 0
+        end
+
+        def example_count
+          output ? output[:stats][:tests] : 1
+        end
+
+        def passing_count
+          output ? output[:stats][:passes] : 0
+        end
+
+        def pending_count
+          output ? output[:stats][:pending] : 0
+        end
+
+        def failure_count
+          output ? output[:stats][:failures] : 1
+        end
+      end
+    end
+  end
+end

data/lib/learn_lab/test/parsers/null.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    module Parsers
+      # Null parser. Used when no test suite has been detected.
+      #
+      class Null
+        attr_reader :output
+
+        def framework
+          'none'
+        end
+
+        def duration
+          0
+        end
+
+        def example_count
+          0
+        end
+
+        def passing_count
+          0
+        end
+
+        def pending_count
+          0
+        end
+
+        def failure_count
+          0
+        end
+      end
+    end
+  end
+end

data/lib/learn_lab/test/parsers/rspec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    module Parsers
+      # Parse RSpec test result output.
+      #
+      class Rspec
+        attr_reader :output
+
+        def initialize(output)
+          @output = output
+        end
+
+        def framework
+          'rspec'
+        end
+
+        def duration
+          output ? output[:summary][:duration] : 0
+        end
+
+        def example_count
+          output ? output[:summary][:example_count] : 1
+        end
+
+        def passing_count
+          example_count - failure_count - pending_count
+        end
+
+        def pending_count
+          output ? output[:summary][:pending_count] : 0
+        end
+
+        def failure_count
+          output ? output[:summary][:failure_count] : 1
+        end
+      end
+    end
+  end
+end

data/lib/learn_lab/test/runner.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    # Runs a test suite. Lifted from the `learn-test` gem without Ironboard
+    # related code.
+    #
+    class Runner
+      attr_reader :repo, :options
+
+      def initialize(repo, options={})
+        @repo = repo
+        @options = options
+      end
+
+      def run
+        strategy.check_dependencies
+        strategy.run
+        results = strategy.results
+        strategy.cleanup unless options.fetch(:keep, false)
+        results
+      end
+
+      def working_directory
+        repo.working_directory
+      end
+
+      def strategy
+        @strategy ||= begin
+          detected = strategies.map { |s| s.new(self) }.detect(&:detect)
+          detected || LearnLab::Test::Strategies::None.new(self)
+        end
+      end
+
+      private
+
+      def strategies
+        [
+          LearnLab::Test::Strategies::Mocha,
+          LearnLab::Test::Strategies::Rspec
+        ]
+      end
+    end
+  end
+end

data/lib/learn_lab/test/strategies/mocha.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    module Strategies
+      # Test strategy for Mocha.
+      #
+      class Mocha < Strategy
+        def check_dependencies
+          msg = 'Please install NodeJS: https://nodejs.org/en/download'
+          raise MissingDependencyError.new(msg) if `which node`.empty?
+        end
+
+        def detect
+          js_dependency?(:mocha) || js_dependency?(:'learn-browser')
+        end
+
+        def run
+          command = if js_dependency?(:'learn-browser') || js_test_script?
+                      'npm test'
+                    else
+                      'node_modules/.bin/mocha -R mocha-multi ' \
+                        "--reporter-options spec=-,json=#{result_filename}"
+                    end
+          system(command)
+        end
+
+        def parser
+          @parser ||= LearnLab::Test::Parsers::Mocha.new(output)
+        end
+
+        private
+
+        def js_package
+          @js_package ||= begin
+            path = fs.join(runner.working_directory, 'package.json')
+            fs.read_json_file(path)
+          end
+        end
+
+        def js_dependency?(dep)
+          %i[dependencies devDependencies].any? do |key|
+            js_package[key] && js_package[key][dep]
+          end
+        end
+
+        def js_test_script?
+          (js_package[:scripts] && js_package[:scripts][:test] || '') \
+            .include?(result_filename)
+        end
+      end
+    end
+  end
+end

data/lib/learn_lab/test/strategies/none.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    module Strategies
+      # Null strategy object used when no test suite is detected.
+      #
+      class None < Strategy
+        def run
+          out.puts <<~MSG
+            This directory doesn't appear to have any specs in it, so
+            there’s no test to run.
+          MSG
+        end
+
+        def parser
+          @parser ||= LearnLab::Test::Parsers::Null.new
+        end
+      end
+    end
+  end
+end

data/lib/learn_lab/test/strategies/rspec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    module Strategies
+      # Test Strategy for RSpec. Mostly lifted from the `learn-test` gem
+      # without Ironboard specific code. Some other refactorings were also
+      # made to improve test coverage and fix Rubocop warnings.
+      #
+      class Rspec < Strategy
+        def detect
+          spec_dir = fs.join(runner.working_directory, 'spec')
+          fs.dir_exist?(spec_dir) && \
+            (fs.dir_entries(spec_dir).include?('spec_helper.rb') || \
+             fs.dir_entries(spec_dir).include?('rails_helper.rb'))
+        end
+
+        def run
+          command_options = [
+            '--format documentation',
+            '--format j',
+            "--out #{result_filename}"
+          ]
+          system("#{bundle_command}rspec #{command_options.join(' ')}")
+        end
+
+        def parser
+          @parser ||= LearnLab::Test::Parsers::Rspec.new(output)
+        end
+
+        private
+
+        def bundle_command
+          bundler? ? 'bundle exec ' : ''
+        end
+
+        def bundler?
+          fs.file_exist?('Gemfile') && \
+            !!fs.read_file('Gemfile').match(/^\s*gem\s*('|")rspec(-[^'"]+)?('|").*$/)
+        end
+      end
+    end
+  end
+end

data/lib/learn_lab/test/strategy.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module LearnLab
+  module Test
+    # Base class for all test tools. Extracted from the `learn-test` gem with
+    # some modifications (i.e. this doesn't talk to Ironboard).
+    #
+    class Strategy
+      attr_reader :runner, :options, :out, :fs
+
+      def initialize(runner, out=$stdout)
+        @runner = runner
+        @options = runner.options
+        @out = out
+        @fs = LearnLab.file_system
+      end
+
+      def check_dependencies; end
+
+      def run
+        raise NotImplementedError.new(
+          'you must implement how this strategy runs its tests'
+        )
+      end
+
+      def parser
+        raise NotImplementedError.new('you must define a parser')
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def results
+        {
+          repo_name: runner.repo,
+          build: {
+            test_suite: [{
+              framework: parser.framework,
+              formatted_output: output,
+              duration: parser.duration
+            }]
+          },
+          example_count: parser.example_count,
+          passing_count: parser.passing_count,
+          pending_count: parser.pending_count,
+          failure_count: parser.failure_count
+        }
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def output
+        return unless result_file?
+
+        fs.read_json_file(result_file_path)
+      end
+
+      def cleanup
+        fs.rm(result_file_path) if result_file?
+      end
+
+      def result_filename
+        '.results.json'
+      end
+
+      private
+
+      def result_file?
+        fs.file_exist?(result_file_path)
+      end
+
+      def result_file_path
+        fs.join(runner.working_directory, result_filename)
+      end
+    end
+  end
+end

data/lib/learn_lab/token.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module LearnLab
+  # Encodable token. Consists of an email, GitHub URL, and timestamp encoded
+  # as a Base64 URL safe string.
+  #
+  class Token
+    attr_reader :email, :url, :timestamp
+
+    def initialize(email, url, timestamp=Time.now.utc)
+      @email = email
+      @url = url
+      @timestamp = timestamp
+    end
+
+    def encoded
+      Base64.urlsafe_encode64(payload.to_json)
+    end
+
+    private
+
+    def payload
+      {
+        lms_email: email,
+        vcs_url: url,
+        timestamp: timestamp
+      }
+    end
+  end
+end

data/lib/learn_lab/vcs.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LearnLab
+  # Adapter for the Version Control System.
+  #
+  class VCS
+    def initialize(directory, &block)
+      @repo = Git.open(directory)
+    rescue StandardError => e
+      msg = "You don't appear to be in a Learn lesson's directory. Please " \
+            'cd to an appropriate directory and try again.'
+
+      block_given? ? block.call(msg, e) : raise(LearnLab::Error.new(msg))
+    end
+
+    def remote_url
+      @repo.remote.url
+    end
+
+    def working_directory
+      @repo.dir.path
+    end
+  end
+end

data/lib/learn_lab/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LearnLab
+  VERSION = '0.1.0.rc1'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: learn-lab
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+platform: ruby
+authors:
+- Flatiron School
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- learn@flatironschool.com
+executables:
+- learn-lab
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ci
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- exe/learn-lab
+- learn-lab.gemspec
+- lib/learn_lab.rb
+- lib/learn_lab/cli.rb
+- lib/learn_lab/configuration.rb
+- lib/learn_lab/errors.rb
+- lib/learn_lab/file_system.rb
+- lib/learn_lab/prompt.rb
+- lib/learn_lab/test/parsers/mocha.rb
+- lib/learn_lab/test/parsers/null.rb
+- lib/learn_lab/test/parsers/rspec.rb
+- lib/learn_lab/test/runner.rb
+- lib/learn_lab/test/strategies/mocha.rb
+- lib/learn_lab/test/strategies/none.rb
+- lib/learn_lab/test/strategies/rspec.rb
+- lib/learn_lab/test/strategy.rb
+- lib/learn_lab/token.rb
+- lib/learn_lab/vcs.rb
+- lib/learn_lab/version.rb
+homepage: https://github.com/flatiron-labs/learn-lab
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  changelog_uri: https://github.com/flatiron-labs/learn-lab/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/flatiron-labs/learn-lab
+  source_code_uri: https://github.com/flatiron-labs/learn-lab
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: The command line interface for Flatiron School enterprise.
+test_files: []