ruby_test_student_grader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8bd58f1dc44191017f6fc9b9a9304b9a236ce205654391884daacdf7cafdf17
+  data.tar.gz: def8f3c53b4a51b078a4f66fd49affa3266771b03c7360277b9af60a129c9716
+SHA512:
+  metadata.gz: 5791506535eea5cd4827ea672992c20d8a702e9932cbf921c2c17cd4836f6ea471a826ecd4b2698376d08dd47c674a01495c57bc0739230825ff523f5898ea97
+  data.tar.gz: 246b0070222d481ad44b78f349540478814dd8bae081dd48a481a1604ffd5eb7d2a356a653ac08b8f0608abfa1d12162cceb6318d8465d662cefe4e3112a03e6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 jtvaldivia
+
+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,256 @@
+
+# ruby_test_student_grader
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/ruby_test_student_grader.svg)](https://badge.fury.io/rb/ruby_test_student_grader)
+
+
+A Ruby gem for generating academic test reports in HTML format. Initially designed for automated grading of university programming assignments, with flexibility to adapt to different testing frameworks.
+
+**Current Status**: Early Development (Beta)  
+**Primary Use**: Automated evaluation of academic coding tasks  
+**Future Goal**: Modular system for diverse testing scenarios
+
+---
+
+## Installation
+
+### Local Development
+Add to your Rails Gemfile:
+```ruby
+gem 'ruby_test_student_grader', path: '/path/to/gem/directory'
+```
+Then run:
+
+```bash
+bundle install
+```
+From RubyGems (Once Published)
+```bash
+gem install ruby_test_student_grader
+```
+## Basic Usage
+Configure in your test helper:
+
+```bash
+ test/test_helper.rb
+```
+```ruby
+
+require 'ruby_test_student_grader'
+
+Minitest.after_run do
+  RubyTestStudentGrader::Reporter.new(
+    total_score,      # Calculated score
+    max_score,        # Maximum possible score
+    failed_tests,     # Array of failed test names
+    automated_feedback # Generated feedback summary
+  ).generate
+end
+```
+Report will be generated at:
+
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/ruby_test_student_grader.svg)](https://badge.fury.io/rb/ruby_test_student_grader)
+
+A Ruby gem for generating academic test reports in HTML format. Initially designed for automated grading of university programming assignments, with flexibility to adapt to different testing frameworks.
+
+**Current Status**: Early Development (Beta)  
+**Primary Use**: Automated evaluation of academic coding tasks  
+**Future Goal**: Modular system for diverse testing scenarios
+
+---
+
+
+## Installation
+
+
+### Local Development
+
+Add to your Rails Gemfile:
+
+```ruby
+gem 'ruby_test_student_grader', path: '/path/to/gem/directory'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+From RubyGems (Once Published):
+
+```bash
+gem install ruby_test_student_grader
+```
+
+
+## Basic Usage
+
+Configure in your test helper:
+
+`test/test_helper.rb`
+
+```ruby
+require 'ruby_test_student_grader'
+
+Minitest.after_run do
+  RubyTestStudentGrader::Reporter.new(
+    total_score,      # Calculated score
+    max_score,        # Maximum possible score
+    failed_tests,     # Array of failed test names
+    automated_feedback # Generated feedback summary
+  ).generate
+end
+```
+
+Report will be generated at:
+
+`public/test_report.html`
+
+## Evaluated Data
+
+
+- Test results (pass/fail)
+- Score calculations
+- Execution metadata
+- Custom feedback
+- Detailed error traces
+
+
+## Development Current Features
+
+
+- [x] HTML Report Generation
+- [x] Academic Grading System
+- [x] Detailed Error Analysis
+- [x] Customizable Templates
+
+
+Planned Features
+
+- [ ] PDF/CSV Export
+- [ ] LMS Integration
+- [ ] Code Similarity Detection
+- [ ] AI-Powered Feedback
+
+
+## Academic Configuration
+
+```ruby
+RubyTestStudentGrader.configure do |config|
+  config.grading_scale = { 
+    passing: 4.0,
+    excellence: 5.5
+  }
+  config.rubric = {
+    code_quality: 30%,
+    coverage: 20%,
+    functionality: 50%
+  }
+end
+```
+
+
+## Architecture
+
+```bash
+lib/
+├── ruby_test_student_grader/
+│   ├── reporter.rb         # Core logic
+│   ├── template.html.erb   # HTML template
+├── ruby_test_student_grader.rb     # Main module
+```
+
+
+## Contributing
+
+We welcome contributions for:
+
+- New report formats
+- Additional framework support
+- Code analysis improvements
+- AI integration modules
+
+
+## License
+
+MIT License - See LICENSE. Requires attribution in academic materials using this software.
+
+Educational assessment tool - Adaptable for diverse pedagogical needs.
+
+**Note**: This project is in very early stage and could have major bugs
+
+## Try the new features
+
+See `README_PROBAR.md` for a step-by-step guide. Quick summary:
+
+```ruby
+# HTML and CSV
+reporter = RubyTestStudentGrader::Reporter.new(5.2, 6.0, ["test_model"], "Good job", course_name: "IIC2143")
+reporter.generate
+reporter.generate_csv("public/test_report.csv")
+
+# PDF (optional, requires prawn)
+reporter.generate_pdf("public/test_report.pdf")
+
+# Multiple students
+students = [ { id: 1, name: "Alice", total_score: 5.2, max_score: 6.0, failed_tests: ["test_model"], feedback: "OK" } ]
+RubyTestStudentGrader::ClassReporter.new(students, course_name: "IIC2143", output_dir: "public/reports").generate_all
+
+# Similarity
+RubyTestStudentGrader::Similarity.jaccard("def a;1;end", "def b;1;end", k: 5)
+```
+
+## Demo script
+
+Use the demo script to verify everything end-to-end.
+
+- Path: `scripts/demo.rb`
+- It will:
+  - Generate HTML and CSV in `public/`
+  - Try to generate PDF (if `prawn` is installed)
+  - Create per-student reports and an index under `public/reports/`
+  - Print a code similarity score
+
+Run:
+
+```bash
+bundle exec ruby scripts/demo.rb
+```
+
+Optional (for PDF):
+
+```bash
+bundle add prawn
+```
+
+Tip: set a course name for the report via env var (optional):
+
+```bash
+export COURSE_NAME="IIC2143"
+```
+
+## Extras
+
+- CSV export: `RubyTestStudentGrader::Reporter#generate_csv("public/test_report.csv")`
+- PDF export (optional, requires prawn): `RubyTestStudentGrader::Reporter#generate_pdf("public/test_report.pdf")`
+- Course name in HTML/CSV/PDF: pass `course_name: "IIC2143"` to the constructor or set `COURSE_NAME` in your environment.
+
+### Reports for multiple students
+
+```ruby
+students = [
+  { id: 1, name: "Alice", total_score: 5.2, max_score: 6.0, failed_tests: ["test_model"], feedback: "Good job" },
+  { id: 2, name: "Bob", total_score: 3.9, max_score: 6.0, failed_tests: ["test_controller"], feedback: "Check controllers" }
+]
+RubyTestStudentGrader::ClassReporter.new(students, course_name: "IIC2143", output_dir: "public/reports").generate_all
+```
+
+### Basic similarity detection
+
+```ruby
+RubyTestStudentGrader::Similarity.jaccard(code_a, code_b, k: 5) # => 0.0..1.0
+```

data/README_PROBAR.md

@@ -0,0 +1,97 @@
+# Try the new features of ruby_test_student_grader
+
+This document helps you quickly try the new features: CSV/PDF export, code similarity, class (multi-student) reports, and course name in the HTML report.
+
+Requirements:
+
+- Ruby >= 3.2
+- Bundler
+- (Optional) PDF: `prawn` gem
+
+## 1) Start the gem console
+
+```bash
+bin/console
+```
+
+Inside the console, you can run the examples below. If you prefer, copy the snippets into a `.rb` script and run with `bundle exec ruby your_script.rb`.
+
+## 2) Single report (HTML/CSV)
+
+```ruby
+require "ruby_test_student_grader"
+
+reporter = RubyTestStudentGrader::Reporter.new(
+  5.2,                 # total_score
+  6.0,                 # max_score
+  ["test_model"],      # failed_tests
+  "Good job",          # feedback
+  course_name: "IIC2143"
+)
+
+reporter.generate # => test_report.html by default (or the path you pass)
+reporter.generate_csv("public/test_report.csv")
+```
+
+By default, the HTML uses the course name passed via `course_name` or, if omitted, the `COURSE_NAME` environment variable.
+
+## 3) PDF (optional)
+
+Install `prawn` if you don't have it:
+
+```bash
+bundle add prawn
+```
+
+Then in Ruby:
+
+```ruby
+reporter.generate_pdf("public/test_report.pdf") # generates a PDF if prawn is installed
+```
+
+If `prawn` isn't available, the call will show a warning and return `nil`.
+
+## 4) Class reports (index + per-student files)
+
+```ruby
+students = [
+  { id: 1, name: "Alice", total_score: 5.2, max_score: 6.0, failed_tests: ["test_model"],      feedback: "Good job" },
+  { id: 2, name: "Bob",   total_score: 3.9, max_score: 6.0, failed_tests: ["test_controller"], feedback: "Check controllers" }
+]
+
+RubyTestStudentGrader::ClassReporter
+  .new(students, course_name: "IIC2143", output_dir: "public/reports")
+  .generate_all
+# Creates public/reports/index.html and one .html and .csv per student
+```
+
+## 5) Basic code similarity (Jaccard)
+
+```ruby
+code_a = "def sum(a,b); a+b; end"
+code_b = "def add(x,y); x + y; end"
+
+RubyTestStudentGrader::Similarity.jaccard(code_a, code_b, k: 5)
+# => 0.0..1.0 (higher means more similar)
+```
+
+## 6) Environment variables
+
+You can set the course via an environment variable to avoid passing `course_name` each time:
+
+```bash
+export COURSE_NAME="IIC2143"
+```
+
+## 7) Output locations
+
+- Default HTML: `test_report.html` (or the path you give)
+- Default CSV: `test_report.csv` (or the path you give)
+- Default PDF: `test_report.pdf` (if `prawn` is available)
+- Class reports: `public/reports/` (configurable with `output_dir`)
+
+## 8) Common issues
+
+- PDF not generated: install `prawn` with `bundle add prawn`.
+- Permissions/paths: create the `public/` or `public/reports/` directory if it doesn't exist.
+- 0% score: ensure `max_score` is > 0.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/ruby_test_student_grader/class_reporter.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RubyTestStudentGrader
+  # Genera reportes para múltiples estudiantes y un índice HTML simple.
+  class ClassReporter
+    # students: Array<Hash> con claves:
+    #   :id, :name, :total_score, :max_score, :failed_tests (Array), :feedback (String)
+    # opts: { course_name?: String, output_dir?: String }
+    def initialize(students, **opts)
+      @students = students
+      @course_name = opts[:course_name] || ENV["COURSE_NAME"] || "Curso"
+      @output_dir = opts[:output_dir] || "reports"
+    end
+
+    def generate_all
+      Dir.mkdir(@output_dir) unless Dir.exist?(@output_dir)
+
+      index_rows = []
+      @students.each do |s|
+        base = safe_slug("#{s[:id]}-#{s[:name]}")
+        html_path = File.join(@output_dir, "#{base}.html")
+        csv_path = File.join(@output_dir, "#{base}.csv")
+
+        reporter = Reporter.new(
+          s[:total_score],
+          s[:max_score],
+          s[:failed_tests] || [],
+          s[:feedback].to_s,
+          course_name: @course_name
+        )
+        reporter.generate_html(html_path)
+        reporter.generate_csv(csv_path)
+
+        percentage = s[:max_score].to_f.zero? ? 0.0 : (s[:total_score].to_f / s[:max_score] * 100)
+        index_rows << {
+          id: s[:id], name: s[:name], html: File.basename(html_path), csv: File.basename(csv_path), percentage: percentage.round(2)
+        }
+      end
+
+      index_file = File.join(@output_dir, "index.html")
+      File.write(index_file, render_index(index_rows))
+  puts "✅ Class index generated at: #{index_file}"
+      index_file
+    end
+
+    private
+
+    def safe_slug(str)
+      str.to_s.downcase.gsub(/[^a-z0-9\-]+/, "-").gsub(/-+/, "-").gsub(/^-|-$|\A\z/, "")
+    end
+
+    def render_index(rows)
+      <<~HTML
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <meta charset="utf-8" />
+            <title>Reporte de Clase - #{@course_name}</title>
+            <style>
+              body { font-family: Arial, sans-serif; margin: 2rem; }
+              table { border-collapse: collapse; width: 100%; }
+              th, td { border: 1px solid #ddd; padding: 8px; }
+              th { background: #f4f4f4; }
+            </style>
+          </head>
+          <body>
+            <h1>Reporte de Clase - #{@course_name}</h1>
+            <table>
+              <thead>
+                <tr>
+                  <th>ID</th>
+                  <th>Nombre</th>
+                  <th>Porcentaje</th>
+                  <th>HTML</th>
+                  <th>CSV</th>
+                </tr>
+              </thead>
+              <tbody>
+                #{rows.map { |r| "<tr><td>#{r[:id]}</td><td>#{r[:name]}</td><td>#{r[:percentage]}%</td><td><a href=\"#{r[:html]}\">Ver</a></td><td><a href=\"#{r[:csv]}\">Descargar</a></td></tr>" }.join}
+              </tbody>
+            </table>
+          </body>
+        </html>
+      HTML
+    end
+  end
+end

data/lib/ruby_test_student_grader/reporter.rb

@@ -0,0 +1,98 @@
+# lib/ruby_test_student_grader/reporter.rb
+require "erb"
+require "csv"
+begin
+  require "prawn"
+rescue LoadError
+  # Prawn es opcional en entorno de desarrollo si no se instaló via gemspec
+end
+
+
+module RubyTestStudentGrader
+  class Reporter
+    TEMPLATE = File.join(File.dirname(__FILE__), "template.html.erb")
+
+    # total_score: Numeric
+    # max_score: Numeric
+    # failed_tests: Array<String>
+    # feedback: String
+    # opts: { course_name?: String }
+    def initialize(total_score, max_score, failed_tests, feedback, **opts)
+      @total_score = total_score
+      @max_score = max_score
+      @failed_tests = failed_tests || []
+      @feedback = feedback.to_s
+      @timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+      @course_name = opts[:course_name] || ENV["COURSE_NAME"] || "Curso"
+      @feedback_class = feedback_class
+    end
+
+    # Conserva compatibilidad: genera HTML por defecto
+    def generate(output_path = "test_report.html")
+      generate_html(output_path)
+    end
+
+    def generate_html(output_path = "test_report.html")
+      template = File.read(TEMPLATE)
+      html = ERB.new(template).result(binding)
+      File.write(output_path, html)
+  puts "✅ HTML report generated at: #{output_path}"
+      output_path
+    end
+
+    def generate_csv(output_path = "test_report.csv")
+      data = {
+        course: @course_name,
+        total_score: @total_score,
+        max_score: @max_score,
+        percentage: (@max_score.to_f.zero? ? 0.0 : (@total_score.to_f / @max_score * 100)).round(2),
+        failed_tests_count: @failed_tests.size,
+        failed_tests: @failed_tests.join("; "),
+        feedback: @feedback,
+        timestamp: @timestamp
+      }
+
+      CSV.open(output_path, "w") do |csv|
+        csv << data.keys
+        csv << data.values
+      end
+  puts "✅ CSV report generated at: #{output_path}"
+      output_path
+    end
+
+    def generate_pdf(output_path = "test_report.pdf")
+      unless defined?(Prawn)
+        warn "Prawn is not available. Make sure the dependency is installed."
+        return nil
+      end
+
+      Prawn::Document.generate(output_path) do |pdf|
+        pdf.text "Reporte de Tests - #{@course_name}", size: 22, style: :bold, align: :center
+        pdf.move_down 20
+        pdf.text "Puntaje: #{@total_score} / #{@max_score}", size: 16
+        percentage = @max_score.to_f.zero? ? 0.0 : (@total_score.to_f / @max_score * 100)
+        pdf.text "Porcentaje: #{percentage.round(2)}%", size: 12
+        pdf.move_down 10
+        pdf.text "Feedback:", style: :bold
+        pdf.text @feedback.to_s
+        unless @failed_tests.empty?
+          pdf.move_down 10
+          pdf.text "Tests Fallidos:", style: :bold
+          @failed_tests.each { |t| pdf.text "• #{t}" }
+        end
+        pdf.move_down 20
+        pdf.text "Generado el: #{@timestamp}", size: 10, align: :right
+      end
+  puts "✅ PDF report generated at: #{output_path}"
+      output_path
+    end
+
+    def feedback_class
+      case @total_score
+      when 5.5..6.0 then "success"
+      when 4.0..5.4 then "warning"
+      else "danger"
+      end
+    end
+  end
+end

data/lib/ruby_test_student_grader/similarity.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RubyTestStudentGrader
+  module Similarity
+    module_function
+
+    # Calcula similitud de Jaccard sobre shingles de tokens simples.
+    # text_a, text_b: String
+    # k: tamaño de shingle (por defecto 5 tokens)
+    def jaccard(text_a, text_b, k: 5)
+      a = shingles(tokenize(text_a.to_s), k)
+      b = shingles(tokenize(text_b.to_s), k)
+      return 1.0 if a.empty? && b.empty?
+      inter = (a & b).size.to_f
+      union = (a | b).size.to_f
+      return 0.0 if union.zero?
+      (inter / union).round(4)
+    end
+
+    def tokenize(text)
+      text.downcase.gsub(/[^a-z0-9_]+/, " ").split
+    end
+
+    def shingles(tokens, k)
+      return [] if tokens.size < k
+      (0..tokens.size - k).map { |i| tokens[i, k].join(" ") }.uniq
+    end
+  end
+end

data/lib/ruby_test_student_grader/template.html.erb

@@ -0,0 +1,48 @@
+<!-- lib/ruby_test_student_grader/template.html.erb -->
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Test Report</title>
+  <style>
+    :root { --color-primary: #2c3e50; --color-success: #27ae60; --color-danger: #e74c3c; }
+    body { font-family: 'Segoe UI', sans-serif; margin: 2rem; }
+    .header { text-align: center; margin-bottom: 2rem; }
+    .score { font-size: 2.5em; font-weight: bold; margin: 1rem 0; }
+    .feedback { padding: 1rem; border-radius: 8px; margin: 1rem 0; }
+    .success { background-color: #e8f5e9; color: var(--color-success); }
+    .warning { background-color: #fff3e0; color: #f39c12; }
+    .danger { background-color: #ffebee; color: var(--color-danger); }
+    .failed-tests { margin-top: 2rem; }
+    .test-list { list-style-type: none; padding: 0; }
+    .test-item { padding: 0.5rem; margin: 0.3rem 0; border-left: 4px solid var(--color-danger); }
+    .timestamp { color: #7f8c8d; font-size: 0.9em; text-align: center; margin-top: 2rem; }
+  </style>
+</head>
+<body>
+  <div class="header">
+    <h1>📊 Test Report</h1>
+    <h3><%= @course_name %></h3>
+    <div class="score">
+      <%= @total_score.round(1) %>/<%= @max_score %>
+    </div>
+    <div class="feedback <%= feedback_class %>">
+      <%= @feedback %>
+    </div>
+  </div>
+
+  <% if @failed_tests.any? %>
+    <div class="failed-tests">
+  <h3>🔴 Failed tests:</h3>
+      <ul class="test-list">
+        <% @failed_tests.each do |test| %>
+          <li class="test-item"><%= test %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="timestamp">
+  Generated at: <%= @timestamp %>
+  </div>
+</body>
+</html>

data/lib/ruby_test_student_grader/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyTestStudentGrader
+  VERSION = "0.1.0"
+end

data/lib/ruby_test_student_grader.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "ruby_test_student_grader/version"
+require_relative "ruby_test_student_grader/reporter"
+require_relative "ruby_test_student_grader/class_reporter"
+require_relative "ruby_test_student_grader/similarity"
+
+module RubyTestStudentGrader
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/ruby_test_student_grader.rbs

@@ -0,0 +1,4 @@
+module RubyTestStudentGrader
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: ruby_test_student_grader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jtvaldivia
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Ruby gem to generate automated test reports for academic assignments
+  with HTML templates, CSV export, optional PDF (via prawn), class-wide reporting,
+  and basic Jaccard code similarity.
+email:
+- josevaldivia9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- README_PROBAR.md
+- Rakefile
+- lib/ruby_test_student_grader.rb
+- lib/ruby_test_student_grader/class_reporter.rb
+- lib/ruby_test_student_grader/reporter.rb
+- lib/ruby_test_student_grader/similarity.rb
+- lib/ruby_test_student_grader/template.html.erb
+- lib/ruby_test_student_grader/version.rb
+- sig/ruby_test_student_grader.rbs
+homepage: https://github.com/jtvaldivia/ruby-grader
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jtvaldivia/ruby-grader
+  source_code_uri: https://github.com/jtvaldivia/ruby-grader
+  changelog_uri: https://github.com/jtvaldivia/ruby-grader/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Generate student test reports (HTML/CSV, optional PDF), class index, and
+  basic code similarity.
+test_files: []