iic2143_reporter 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +102 -20
  3. data/lib/iic2143_reporter/version.rb +1 -1
  4. data/lib/iic2143_reporter.rb +11 -0
  5. metadata +13 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 858254e1ee581f9890b48fd507918287307a400d7bef1d342d7674145f6a8d04
4
- data.tar.gz: 83b1f6b794a7bfe266eeaec708c69972dc00b2243c1450865f45d5c9399de23b
3
+ metadata.gz: 8d58fbac2589f3d53486695993896852fb56633511fb6b360ed44d666d2d1543
4
+ data.tar.gz: eb54d2598dcac0ae8bd2c9310d7d90026a561a322e6d70500970a064341dd804
5
5
  SHA512:
6
- metadata.gz: 9b33f9b15eea1c87625ed2fd53cb8ec580be18b49fe1c87acb106e88d6c72b40777ab2a0e081e80d3642f34054e374b0487cbe5b1e7c8437f420c58b6792ed86
7
- data.tar.gz: 268c1849b4175e4223b674df3bfc96588a765277939f9dc241860cbb5c0893c9b06651b4839a77d4d0aa8d32b3dde8ca7c5c90d255df209e23698b4eab7e6c26
6
+ metadata.gz: f3fcc9b9425089c39f56b66c80da10624d279436a0ca82b5df3e0bde38c9dda4cfe4abb272ef7ac6790da2fce907e9ffab450a3ec6dc476efa9fbd1134a2130d
7
+ data.tar.gz: 38bf0486f76ac3a0dc564595e72d033acb3aee63b694ac49c6ac6257440466d9dd2b40a6bb47f30c0c92cbae9ffdc824e42dab1158de5c97b1781a4f8d4100cd
data/README.md CHANGED
@@ -1,43 +1,125 @@
1
- # Iic2143Reporter
1
+ # IIC2143Reporter
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ > Important: This gem is DEPRECATED and has been replaced by 'ruby_test_student_grader'.
4
+ > Reason: the new name is clearer and ongoing development happens there.
5
+ >
6
+ > Recommended: gem install ruby_test_student_grader
7
+ > Learn more: [ruby_test_student_grader on RubyGems](https://rubygems.org/gems/ruby_test_student_grader)
4
8
 
5
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/iic2143_reporter`. To experiment with that code, run `bin/console` for an interactive prompt.
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
10
+ [![Gem Version](https://badge.fury.io/rb/iic2143_reporter.svg)](https://badge.fury.io/rb/iic2143_reporter)
6
11
 
7
- ## Installation
8
12
 
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
13
+ 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.
14
+
15
+ **Current Status**: Early Development (Beta)
16
+ **Primary Use**: Automated evaluation of academic coding tasks
17
+ **Future Goal**: Modular system for diverse testing scenarios
18
+
19
+ ---
10
20
 
11
- Install the gem and add to the application's Gemfile by executing:
21
+ ## Installation
22
+
23
+ ### Local Development
24
+ Add to your Rails Gemfile:
25
+ ```ruby
26
+ gem 'iic2143_reporter', path: '/path/to/gem/directory'
27
+ ```
28
+ Then run:
12
29
 
13
30
  ```bash
14
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
31
+ bundle install
15
32
  ```
33
+ From RubyGems (Once Published)
34
+ ```bash
35
+ gem install iic2143_reporter
36
+ ```
37
+ ## Basic Usage
38
+ Configure in your test helper:
16
39
 
17
- If bundler is not being used to manage dependencies, install the gem by executing:
40
+ ```bash
41
+ test/test_helper.rb
42
+ ```
43
+ ```ruby
44
+ require 'iic2143_reporter'
45
+
46
+ Minitest.after_run do
47
+ IIC2143Reporter::Reporter.new(
48
+ total_score, # Calculated score
49
+ max_score, # Maximum possible score
50
+ failed_tests, # Array of failed test names
51
+ automated_feedback # Generated feedback summary
52
+ ).generate
53
+ end
54
+ ```
55
+ Report will be generated at:
18
56
 
19
57
  ```bash
20
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
58
+ public/test_report.html
21
59
  ```
60
+ ## Evaluated Data:
61
+ ```bash
62
+ Test results (pass/fail)
63
+
64
+ Score calculations
65
+
66
+ Execution metadata
22
67
 
23
- ## Usage
68
+ Custom feedback
24
69
 
25
- TODO: Write usage instructions here
70
+ Detailed error traces
71
+ ```
72
+ ## Development Current Features
73
+
74
+ - [x] HTML Report Generation
75
+ - [x] Academic Grading System
76
+ - [x] Detailed Error Analysis
77
+ - [x] Customizable Templates
78
+
79
+ Planned Features
80
+ - [ ] PDF/CSV Export
81
+ - [ ] LMS Integration
82
+ - [ ] Code Similarity Detection
83
+ - [ ] AI-Powered Feedback
84
+
85
+ ## Academic Configuration
86
+ ```ruby
87
+ IIC2143Reporter.configure do |config|
88
+ config.grading_scale = {
89
+ passing: 4.0,
90
+ excellence: 5.5
91
+ }
92
+ config.rubric = {
93
+ code_quality: 30%,
94
+ coverage: 20%,
95
+ functionality: 50%
96
+ }
97
+ end
98
+ ```
99
+ ## Architecture
100
+ ```bash
101
+ lib/
102
+ ├── iic2143_reporter/
103
+ │ ├── reporter.rb # Core logic
104
+ │ ├── grader.rb # Grading system
105
+ │ └── template.html.erb # HTML template
106
+ ├── iic2143_reporter.rb # Main module
107
+ ```
108
+ ## Contributing
109
+ We welcome contributions for:
26
110
 
27
- ## Development
111
+ New report formats
28
112
 
29
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
113
+ Additional framework support
30
114
 
31
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
115
+ Code analysis improvements
32
116
 
33
- ## Contributing
117
+ AI integration modules
34
118
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iic2143_reporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/iic2143_reporter/blob/master/CODE_OF_CONDUCT.md).
36
119
 
37
120
  ## License
121
+ MIT License - See LICENSE. Requires attribution in academic materials using this software.
38
122
 
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
-
41
- ## Code of Conduct
123
+ Educational assessment tool - Adaptable for diverse pedagogical needs.
42
124
 
43
- Everyone interacting in the Iic2143Reporter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/iic2143_reporter/blob/master/CODE_OF_CONDUCT.md).
125
+ **Note**: This project is in very early stage and could have major bugs
data/lib/iic2143_reporter/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Iic2143Reporter
4
- VERSION = "0.1.1"
4
+ VERSION = "0.1.2"
5
5
  end
data/lib/iic2143_reporter.rb CHANGED
@@ -7,3 +7,14 @@ module IIC2143Reporter
7
7
  class Error < StandardError; end
8
8
  # Your code goes here...
9
9
  end
10
+
11
+ # Deprecation notice at require-time (printed once per process)
12
+ unless defined?(IIC2143_REPORTER_DEPRECATION_WARNED)
13
+ IIC2143_REPORTER_DEPRECATION_WARNED = true
14
+ warn <<~MSG
15
+ [DEPRECATION] 'iic2143_reporter' is deprecated and has been replaced by 'ruby_test_student_grader'.
16
+ Reason: clearer name; active development continues in the new gem.
17
+ Please migrate when you can: gem install ruby_test_student_grader
18
+ Learn more: https://rubygems.org/gems/ruby_test_student_grader
19
+ MSG
20
+ end
metadata CHANGED
@@ -1,18 +1,20 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: iic2143_reporter
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - jtvaldivia
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-03-08 00:00:00.000000000 Z
11
+ date: 2025-08-10 00:00:00.000000000 Z
12
12
  dependencies: []
13
- description: Gem for creation of HTML reports of grades tester fow now in IIC2143
13
+ description: 'This gem is deprecated and has been replaced by ''ruby_test_student_grader''.
14
+ The new name is clearer and future maintenance and improvements will happen there.
15
+ You can still use this gem, but we strongly recommend migrating. More info: https://rubygems.org/gems/ruby_test_student_grader'
14
16
  email:
15
- - jvaldivia@buk.cl
17
+ - josevaldivia9@gmail.com
16
18
  executables: []
17
19
  extensions: []
18
20
  extra_rdoc_files: []
@@ -26,7 +28,12 @@ homepage: https://github.com/tu-usuario/iic2143_reporter
26
28
  licenses:
27
29
  - MIT
28
30
  metadata: {}
29
- post_install_message:
31
+ post_install_message: |
32
+ [DEPRECATION] 'iic2143_reporter' is deprecated and has been replaced by 'ruby_test_student_grader'.
33
+ Reason: the new name is clearer; active development continues in the new gem.
34
+ Please migrate when you can:
35
+ gem install ruby_test_student_grader
36
+ Learn more: https://rubygems.org/gems/ruby_test_student_grader
30
37
  rdoc_options: []
31
38
  require_paths:
32
39
  - lib
@@ -44,5 +51,5 @@ requirements: []
44
51
  rubygems_version: 3.5.22
45
52
  signing_key:
46
53
  specification_version: 4
47
- summary: Generador de reportes HTML para tests IIC2143
54
+ summary: "[DEPRECATED] HTML report generator for IIC2143 tests"
48
55
  test_files: []