grade_runner 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b45590a9a30c53dfa993e986ce49f4bc33696f1a35f0e8587a4d9b54dad3f380
-  data.tar.gz: 76e02456149f91f875c029add83bbdf1d31c7ce4b02fd9dd2729410911cf38b7
+  metadata.gz: 0f0b8b6d8c59749308e3c9dcd6ab96ae9db013bd388961e5ff5029a99a3d0e28
+  data.tar.gz: a1e4d49af97459f0b62b2b74379cbaf1ee21bbce80cf9ddda4562d41e63eaab9
 SHA512:
-  metadata.gz: 25ccf695386404cf691960d213fed68402ba1269361af0ccf0a82a463d3dadb4065766e0380c6beaf83020eadf31241ee6b72a9041a339fd9930155959f3d664
-  data.tar.gz: 31adbef7665e978f6292cbf8663f79bc77bc6828c76a8b9afeb740914d762cbefdf1a5c2f88b6d2495819169f9f1a689b355a110ae44597366983e0c6e84c311
+  metadata.gz: 8b005be1f8ee9db2d9385036e27233acbce5b5fc6d9eb0a6f875d76d5d7da095cf42d5dde54242b270efa2493ff30414d9f292263648d560e1f9305f0a23a2c5
+  data.tar.gz: c8b7c8026a6d880bca7021d36975f9c71eabcfd7375c4efde5821ff42840d045b333ab61c567b76aecdab61f58d2e48fac1199a9d095cbcddbde5d622bebdd93

data/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 gem "activesupport", ">= 2.3.5"
 gem "oj", "~> 3.13.12"
 gem "octokit", "~> 5.0"
+gem "zip"
 gem "faraday-retry", "~> 1.0.3"
 gem "rake", "~> 13"
 # Add dependencies to develop your gem here.

data/Gemfile.lock

@@ -145,6 +145,7 @@ GEM
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
+    zip (2.0.2)
 
 PLATFORMS
   ruby
@@ -166,6 +167,7 @@ DEPENDENCIES
   rdoc (~> 6.1)
   rspec (~> 3.5.0)
   simplecov
+  zip
 
 BUNDLED WITH
    2.1.4

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.13

data/grade_runner.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: grade_runner 0.0.11 ruby lib
+# stub: grade_runner 0.0.13 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "grade_runner".freeze
-  s.version = "0.0.11"
+  s.version = "0.0.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Raghu Betina".freeze, "Jelani Woods".freeze]
-  s.date = "2024-07-09"
+  s.date = "2025-03-17"
   s.description = "This gem runs your RSpec test suite and posts the JSON output to grades.firstdraft.com.".freeze
   s.email = ["raghu@firstdraft.com".freeze, "jelani@firstdraft.com".freeze]
   s.extra_rdoc_files = [
@@ -48,6 +48,7 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency(%q<activesupport>.freeze, [">= 2.3.5"])
     s.add_runtime_dependency(%q<oj>.freeze, ["~> 3.13.12"])
     s.add_runtime_dependency(%q<octokit>.freeze, ["~> 5.0"])
+    s.add_runtime_dependency(%q<zip>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<faraday-retry>.freeze, ["~> 1.0.3"])
     s.add_runtime_dependency(%q<rake>.freeze, ["~> 13"])
     s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
@@ -65,6 +66,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>.freeze, [">= 2.3.5"])
     s.add_dependency(%q<oj>.freeze, ["~> 3.13.12"])
     s.add_dependency(%q<octokit>.freeze, ["~> 5.0"])
+    s.add_dependency(%q<zip>.freeze, [">= 0"])
     s.add_dependency(%q<faraday-retry>.freeze, ["~> 1.0.3"])
     s.add_dependency(%q<rake>.freeze, ["~> 13"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])

data/lib/grade_runner/formatters/hint_formatter.rb

@@ -0,0 +1,11 @@
+RSpec::Support.require_rspec_core "formatters/documentation_formatter"
+
+class HintFormatter < RSpec::Core::Formatters::DocumentationFormatter
+  RSpec::Core::Formatters.register self, :example_failed
+
+  def example_failed(failure)
+    super
+    @output.puts "\n\nHint:  #{failure.example.metadata[:hint][0]}" if failure.example.metadata[:hint].present?
+  end
+
+end

data/lib/grade_runner/formatters/json_output_formatter.rb

@@ -0,0 +1,67 @@
+RSpec::Support.require_rspec_core "formatters/json_formatter"
+require "oj"
+class JsonOutputFormatter < RSpec::Core::Formatters::JsonFormatter
+  RSpec::Core::Formatters.register self, :dump_summary
+
+  def dump_summary(summary)
+    total_points = summary.
+      examples.
+      map { |example| example.metadata.fetch(:points, GradeRunner.default_points).to_i }.
+      sum
+      
+    earned_points = summary.
+      examples.
+      select { |example| example.execution_result.status == :passed }.
+      map { |example| example.metadata.fetch(:points, GradeRunner.default_points).to_i }.
+      sum
+
+    score = (earned_points.to_f / total_points).round(4)
+    score = 0 if score.nan?
+    
+    @output_hash[:summary] = {
+      duration: summary.duration,
+      example_count: summary.example_count,
+      errors_outside_of_examples_count: summary.errors_outside_of_examples_count,
+      failure_count: summary.failure_count,
+      pending_count: summary.pending_count,
+      total_points: total_points,
+      earned_points: earned_points,
+      score: score
+    }
+    result = (@output_hash[:summary][:score] * 100).round(2)
+    
+    if summary.errors_outside_of_examples_count.positive?
+      result = "An error occurred while running tests"
+    else
+      result = result.to_s + "%"
+    end
+    
+    
+    @output_hash[:summary_line] = [
+      "#{summary.example_count} #{summary.example_count == 1 ? "test" : "tests"}",
+      "#{summary.failure_count} failures",
+      "#{earned_points}/#{total_points} points",
+      result,
+    ].join(", ")
+  end
+
+  def close(_notification)
+    output.write  Oj.dump @output_hash
+  end
+  
+  private
+
+  def format_example(example)
+    {
+      description: example.description,
+      full_description: example.full_description,
+      hint: example.metadata[:hint],
+      status: example.execution_result.status.to_s,
+      points: example.metadata.fetch(:points, GradeRunner.default_points),
+      file_path: example.metadata[:file_path],
+      line_number:  example.metadata[:line_number],
+      run_time: example.execution_result.run_time,
+    }
+  end
+
+end

data/lib/grade_runner.rb

@@ -1,2 +1,26 @@
 require "grade_runner/runner"
 require "grade_runner/railtie" if defined?(Rails)
+
+module GradeRunner
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :default_points, :override_local_specs
+
+    def default_points
+      @default_points || 1
+    end
+
+    def override_local_specs
+      if @override_local_specs.nil?
+        true
+      else
+        @override_local_specs
+      end
+    end
+
+    def config
+      yield self
+    end
+  end
+end

data/lib/tasks/grade.rake

@@ -2,6 +2,9 @@ require "active_support/core_ext/object/blank"
 require "grade_runner/runner"
 require "octokit"
 require "yaml"
+require "zip"
+require "fileutils"
+require "open-uri"
 
 desc "Alias for \"grade:next\"."
 task grade: "grade:all" do
@@ -14,10 +17,11 @@ namespace :grade do
     input_token = ARGV[1]
     file_token = nil
 
-    config_dir_name = find_or_create_config_dif
+    config_dir_name = find_or_create_directory(".vscode")
     config_file_name = "#{config_dir_name}/.ltici_apitoken.yml"
     student_config = {}
     student_config["submission_url"] = "https://grades.firstdraft.com"
+    student_config["github_username"] = retrieve_github_username
 
     if File.exist?(config_file_name)
       begin
@@ -47,7 +51,6 @@ namespace :grade do
       while new_personal_access_token == "" do
         print "> "
         new_personal_access_token = $stdin.gets.chomp.strip
-
         if new_personal_access_token!= "" && is_valid_token?(submission_url, new_personal_access_token) == false
           puts "Please enter valid token"
           new_personal_access_token = ""
@@ -67,17 +70,21 @@ namespace :grade do
         student_config["personal_access_token"] = nil
         update_config_file(config_file_name, student_config)
         puts "Your access token looked invalid, so we've reset it to be blank. Please re-run rails grade and, when asked, copy-paste your token carefully from the assignment page."
-      else
-        full_reponame = upstream_repo(submission_url, token)
-        set_upstream_remote(full_reponame)
-        sync_specs_with_source(full_reponame)
+      else 
+        if GradeRunner.override_local_specs
+          resource_info = upstream_repo(submission_url, token)
+          full_reponame = resource_info.fetch("repo_slug")
+          remote_spec_folder_sha = resource_info.fetch("spec_folder_sha")
+          source_code_url = resource_info.fetch("source_code_url")
+          set_upstream_remote(full_reponame)
+          sync_specs_with_source(full_reponame, remote_spec_folder_sha, source_code_url)
+        end
 
         path = File.join(project_root, "/tmp/output/#{Time.now.to_i}.json")
         `bin/rails db:migrate RAILS_ENV=test` if defined?(Rails)
         `RAILS_ENV=test bundle exec rspec --format JsonOutputFormatter --out #{path}`
         rspec_output_json = Oj.load(File.read(path))
-        github_email = `git config user.email`.chomp
-        username = github_username(github_email)
+        username = retrieve_github_username
         reponame = project_root.to_s.split("/").last
         sha = `git rev-parse HEAD`.slice(0..7)
 
@@ -102,12 +109,13 @@ namespace :grade do
 
   desc "Reset access token saved in YAML file."
   task :reset_token do
-    config_dir_name = find_or_create_config_dif
+    config_dir_name = find_or_create_directory(".vscode")
     config_file_name = "#{config_dir_name}/.ltici_apitoken.yml"
     submission_url = "https://grades.firstdraft.com"
 
     student_config = {}
     student_config["submission_url"] = submission_url
+    student_config["github_username"] = retrieve_github_username
     puts "Enter your access token for this project"
     new_personal_access_token = ""
 
@@ -131,34 +139,62 @@ namespace :grade do
 
 end
 
-def sync_specs_with_source(full_reponame)
-  if Octokit.repository?(full_reponame)
-    repo_contents = Octokit.contents(full_reponame)
-    remote_spec_folder = repo_contents.find { |git_object| git_object[:name] == 'spec' }
-    if remote_spec_folder.blank?
-      abort("The project #{full_reponame} does not have specs.")
-    end
-    remote_sha = remote_spec_folder[:sha]
-    # Discard unstaged changes in spec folder
-    `git checkout spec -q`
-    `git clean spec -f -q`
-    local_sha = `git ls-tree HEAD #{project_root.join('spec')}`.chomp.split[2]
-
-    unless remote_sha == local_sha
-      `git fetch upstream -q`
-      # Remove local contents of spec folder
-      `rm -rf spec/*`
-      default_branch = `git remote show upstream | grep 'HEAD branch' | cut -d' ' -f5`.chomp
-      # Overwrite local contents of spec folder with contents from upstream branch
-      `git checkout upstream/#{default_branch} spec/ -q`
-      # Unstage new spec file contents
-      # - if wrong token is used, spec files can be removed properly when unstaged
-      # - spec file changes committed by learner are removed and updated
-      # - we are not committing spec file changes by default to avoid confusing the git history
-      `git restore --staged spec/*`
+def sync_specs_with_source(full_reponame, remote_sha, repo_url)
+  # Unstage staged changes in spec folder
+  `git restore --staged spec/* `
+  # Discard unstaged changes in spec folder
+  `git checkout spec -q`
+  `git clean spec -f -q`
+  local_sha = `git ls-tree HEAD #{project_root.join('spec')}`.chomp.split[2]
+
+  unless remote_sha == local_sha
+    find_or_create_directory("tmp")
+    find_or_create_directory("tmp/backup")
+    files_and_subfolders_inside_specs = Dir.glob("spec/*")
+    # Temporarily move specs
+    FileUtils.mv(files_and_subfolders_inside_specs, "tmp/backup")
+
+    download_file(repo_url, "tmp/spec.zip")
+    extracted_zip_folder = extract_zip("tmp/spec.zip", "tmp")
+    source_directory = extracted_zip_folder.join("spec")
+    overwrite_spec_folder(source_directory)
+
+    FileUtils.rm(project_root.join("tmp/spec.zip"))
+    FileUtils.rm_rf(extracted_zip_folder)
+    FileUtils.rm_rf("tmp/backup")
+    `git add spec/`
+    `git commit spec/ -m "Update spec/ folder to latest version" --author "First Draft <grades@firstdraft.com>"`
+  end
+end
+
+def download_file(url, destination)
+  download = URI.open(url)
+  IO.copy_stream(download, destination)
+end
+
+def extract_zip(folder, destination)
+  extracted_file_path = project_root.join(destination)
+  Zip::File.open(folder) do |zip_file|
+    zip_file.each_with_index do |file, index|
+      # Get name of root folder in zip file
+      if index == 0
+        extracted_file_path = extracted_file_path.join(file.name)
+      end
+      file_path = File.join(destination, file.name)
+      FileUtils.mkdir_p(File.dirname(file_path))
+      file.extract(file_path)
     end
-  else
-    abort("The project #{full_reponame} does not exist.")
+  end
+  extracted_file_path
+end
+
+def overwrite_spec_folder(source_directory)
+  destination_directory = "spec"
+  # Get all files in the source directory
+  files = Dir.glob("#{source_directory}/*")
+  # Move each file to the destination directory
+  files.each do |file|
+    FileUtils.mv(file, destination_directory)
   end
 end
 
@@ -175,10 +211,10 @@ def update_config_file(config_file_name, config)
   File.write(config_file_name, YAML.dump(config))
 end
 
-def find_or_create_config_dif
-  config_dir_name = File.join(project_root, ".vscode")
-  Dir.mkdir(config_dir_name) unless Dir.exist?(config_dir_name)
-  config_dir_name
+def find_or_create_directory(directory_name)
+  directory = File.join(project_root, directory_name)
+  Dir.mkdir(directory) unless Dir.exist?(directory)
+  directory
 end
 
 def is_valid_token?(root_url, token)
@@ -203,20 +239,29 @@ def upstream_repo(root_url, token)
   res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
     http.request(req)
   end
-  result = Oj.load(res.body)
-  result["repo_slug"]
+  Oj.load(res.body)
 rescue => e
   return false
 end
 
-def github_username(primary_email)
-  return "" if primary_email.blank?
-  username = `git config user.name`.chomp
-  search_results = Octokit.search_users("#{primary_email} in:email").fetch(:items)
-  if search_results.present?
-    username = search_results.first.fetch(:login, username)
+def retrieve_github_username
+  config_dir_name = find_or_create_directory(".vscode")
+  config_file_name = "#{config_dir_name}/.ltici_apitoken.yml"
+  if File.exist?(config_file_name)
+    config = YAML.load_file(config_file_name)
+    if config["github_username"].present?
+      return config["github_username"]
+    end
+  else
+    github_email = `git config user.email`.chomp
+    return "" if github_email.blank?
+    username = `git config user.name`.chomp
+    search_results = Octokit.search_users("#{github_email} in:email").fetch(:items)
+    if search_results.present?
+      username = search_results.first.fetch(:login, username)
+    end
+    return username
   end
-  username
 end
 
 def project_root

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grade_runner
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
 platform: ruby
 authors:
 - Raghu Betina
 - Jelani Woods
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-09 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: zip
+  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: faraday-retry
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +269,8 @@ files:
 - VERSION
 - grade_runner.gemspec
 - lib/grade_runner.rb
+- lib/grade_runner/formatters/hint_formatter.rb
+- lib/grade_runner/formatters/json_output_formatter.rb
 - lib/grade_runner/railtie.rb
 - lib/grade_runner/runner.rb
 - lib/tasks/grade.rake
@@ -264,7 +280,7 @@ homepage: http://github.com/firstdraft/grade_runner
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -279,8 +295,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A Ruby client for [firstdraft Grades](https://grades.firstdraft.com)
 test_files: []