grading_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2292bd3d0df83ef4c8c9b2011f1d4e5d2127aa07852ab8da97fee63cc3c0dc66
+  data.tar.gz: 7daea1c9fe6e4cf517a8028c1afdd651f42b1bb3d39923206be32cefb1c24c17
+SHA512:
+  metadata.gz: 92fd669a680bfdeedc72aa298352395e000b40e11cecc5afa76d1500cf8a2de988e51cc6761e4625cf11afb1f8ddc2220442ef462c0e22f3831e43e4ea951c2c
+  data.tar.gz: 2e03441a59665e03bd00cf1d835eed96ca0e42d9e30981811ee302cf2274c0c861b97a8ab22e15049c22003d2c1eed561c4b23d52b09f9e76ce0d71f9034ad4c

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/IndentationWidth:
+    Width: 4
+
+Bundler/OrderedGems:
+    Enabled: false
+
+Style/ClassAndModuleChildren:
+    Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+    Enabled: false
+
+Style/FrozenStringLiteralComment:
+    Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+    EnforcedStyle: empty_lines
+
+Style/RedundantReturn:
+    Enabled: false
+
+Layout/CaseIndentation:
+    EnforcedStyle: case

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-24
+
+- Initial release of `GradingChecker`.
+- Validates `grading.yml` and `submit.yml` configuration files.
+- Checks for duplicate submission names in `submit.yml`.
+- Ensures a valid `grading.yml` structure in the root directory and subdirectories.
+- Reports errors and provides clear feedback on misconfigurations.
+- Supports command-line execution with an optional directory argument.
+- Added `--help` flag to display usage instructions.
+- Returns appropriate exit codes (`0` for success, `1` for validation errors).

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 Martijn Stegeman
+
+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,49 @@
+# GradingChecker
+
+GradingChecker is a tool designed to validate grading configuration files (`grading.yml` and `submit.yml`) in a given directory.
+It is intended to be used on courseware repositories for the [Course Site](https://github.com/stgm/course-site).
+This tool ensures that submission names are unique and that grading configurations follow the expected structure.
+
+## Features
+
+- Checks for duplicate submission names in `submit.yml` files.
+- Validates the structure of `grading.yml` files in the root and subdirectories.
+- Reports errors and provides clear feedback on misconfigurations.
+- Supports a simple command-line interface.
+
+## Installation
+
+To install the gem:
+
+```sh
+gem install grading_checker
+```
+
+## Usage
+
+Run the command to validate grading configurations:
+
+```sh
+grading_checker [DIRECTORY]
+```
+
+- If no directory is provided, the current directory is used.
+- The tool will scan for `grading.yml` and `submit.yml` files and report any issues.
+
+## 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`. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stgm/grading_checker. 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/stgm/grading_checker/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GradingChecker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/stgm/grading_checker/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/exe/grading_checker

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "grading_checker"
+
+# Usage explanation
+if ARGV.include?("--help") || ARGV.include?("-h")
+    puts <<~HELP
+        Usage: grading_checker [DIRECTORY]
+
+        Validates grading.yml and submit.yml files in the specified DIRECTORY.
+        If no directory is provided, the current working directory is used.
+
+        Checks performed:
+          - Ensures no duplicate submission names in submit.yml files.
+          - Validates the structure of grading.yml files in the root and subdirectories.
+          - Reports errors if any issues are found.
+
+        Exit codes:
+          0 - All checks passed.
+          1 - Validation errors detected.
+
+        Options:
+          -h, --help   Show this help message and exit.
+    HELP
+    exit 0
+end
+
+root_path = ARGV[0] || Dir.pwd
+file_manager = GradingChecker::FileManager.new(root_path)
+validator = GradingChecker::GradingYAMLValidator.new(file_manager)
+validator.validate_duplicate_submit_names!
+validator.validate_root_grading_config!
+validator.validate_subdir_configs!
+validator.report_success("all grading.yml files seem to be valid")

data/lib/grading_checker/version.rb

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

data/lib/grading_checker.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require_relative "grading_checker/version"
+require "rainbow"
+require "yaml"
+require "pathname"
+require "ripper"
+
+module GradingChecker
+
+    class Error < StandardError; end
+
+    class FileManager
+        attr_reader :root_path
+
+        def initialize(root_path)
+            @root_path = Pathname.new(root_path)
+        end
+
+        def load_yaml(file_path)
+            return {} unless file_path.exist?
+
+            YAML.load_file(file_path, aliases: true) || {}
+        rescue StandardError => e
+            abort("Error loading YAML file: #{file_path}\n#{e.message}")
+        end
+
+        def find_grading_ymls
+            @root_path.find.select { |path| path.file? && path.basename.to_s == "grading.yml" }
+        end
+
+        def find_submit_ymls
+            @root_path.find.select { |path| path.file? && path.basename.to_s == "submit.yml" }
+        end
+
+        def merge_configs(grades1, grades2)
+            first_without_grades = grades1.reject { |k, _| %w[templates grades calculation].include?(k) }
+            second_without_grades = grades2.reject { |k, _| %w[templates grades calculation].include?(k) }
+
+            merged_grades = (grades1["grades"] || {}).merge(grades2["grades"] || {})
+            merged_calculation = (grades1["calculation"] || {}).merge(grades2["calculation"] || {})
+            merged_rest = first_without_grades.merge(second_without_grades)
+            merged_rest["grades"] = merged_grades
+            merged_rest["calculation"] = merged_calculation
+
+            merged_rest
+        end
+    end
+
+    class GradingYAMLValidator
+        VALID_GRADE_TYPES = %w[pass float integer points].freeze
+        VALID_SUBGRADE_TYPES = %w[integer pass boolean float].freeze
+        DEFAULT_GRADE_TYPE = "float"
+
+        GREEN = Rainbow(":)").green
+        RED = Rainbow(":(").red
+
+        def initialize(file_manager)
+            @file_manager = file_manager
+        end
+
+        def validate_root_grading_config!
+            @root_config = @file_manager.load_yaml(@file_manager.root_path.join("grading.yml"))
+            validate_yaml_structure(@root_config, "grading.yml")
+        end
+
+        def validate_subdir_configs!
+            @file_manager.find_grading_ymls.each do |path|
+                next if path.dirname == @file_manager.root_path
+
+                merged_config = @file_manager.merge_configs(@root_config, @file_manager.load_yaml(path))
+                validate_yaml_structure(merged_config, path.relative_path_from(@file_manager.root_path).to_s)
+            end
+        end
+
+        def validate_duplicate_submit_names!
+            submit_names = Hash.new { |hash, key| hash[key] = [] }
+
+            submit_ymls = @file_manager.find_submit_ymls
+            submit_ymls.each do |path|
+                submit_config = @file_manager.load_yaml(path)
+                next unless submit_config.is_a?(Hash) && submit_config.key?("name")
+
+                submit_names[submit_config["name"]] << path.relative_path_from(@file_manager.root_path).to_s
+            end
+
+            duplicate_submits = submit_names.select { |_, paths| paths.size > 1 }
+
+            if duplicate_submits.any?
+                report_error("duplicate submit names found in submit.yml:")
+                duplicate_submits.each do |name, paths|
+                    puts "  - #{name} appears in: #{paths.join(", ")}"
+                end
+                exit(1)
+            else
+                report_success("no duplicate submit names found in #{submit_ymls.size} submit.yml configs")
+            end
+        end
+
+        def validate_yaml_structure(config, file_name)
+            validate_section(config, "templates") do |templates|
+                templates.each do |key, value|
+                    unless value.is_a?(Hash) && value.key?("type")
+                        report_error("template #{key} must be a hash with a 'type' key")
+                        exit(1)
+                    end
+                end
+            end
+
+            validate_section(config, "grades") do |grades|
+                grades.each do |grade, details|
+                    grade_type = details["type"] || DEFAULT_GRADE_TYPE
+                    unless VALID_GRADE_TYPES.include?(grade_type)
+                        report_error("grade #{grade} has an invalid type: #{grade_type}. Must be one of #{VALID_GRADE_TYPES.join(", ")}")
+                        exit(1)
+                    end
+                end
+            end
+
+            validate_module_definitions(config)
+
+            validate_section(config, "calculation") do |calculation|
+                calculation.each do |calc, details|
+                    unless details.is_a?(Hash)
+                        report_error("calculation #{calc} must be a hash of weighted components")
+                        exit(1)
+                    end
+                end
+            end
+
+            report_success(file_name)
+        end
+
+        def validate_section(config, section)
+            return unless config.key?(section)
+
+            unless config[section].is_a?(Hash)
+                report_error("#{section.capitalize} section must be a hash")
+                exit(1)
+            end
+            yield(config[section]) if block_given?
+        end
+
+        def validate_module_definitions(config)
+            return unless config.is_a?(Hash)
+
+            grade_keys = config["grades"]&.keys || []
+
+            config.each do |key, value|
+                next unless value.is_a?(Hash) && value.key?("submits")
+
+                unless value["submits"].is_a?(Hash)
+                    report_error("module definition #{key} has an invalid submits section: it must be a hash.")
+                    exit(1)
+                end
+
+                value["submits"].each_key do |submit_key|
+                    unless grade_keys.include?(submit_key)
+                        report_error("module definition #{key} references a non-existent grade: #{submit_key}")
+                        exit(1)
+                    end
+                end
+            end
+        end
+
+        def report_success(message)
+            puts "#{GREEN} #{message}"
+        end
+
+        def report_error(message)
+            puts "#{RED} #{message}"
+        end
+    end
+
+end

data/sig/grading_checker.rbs

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

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: grading_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martijn Stegeman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies: []
+description: For courseware repositories
+email:
+- martijn@stgm.nl
+executables:
+- grading_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/grading_checker
+- lib/grading_checker.rb
+- lib/grading_checker/version.rb
+- sig/grading_checker.rbs
+homepage: https://github.com/stgm/grading_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: Check grading configs
+test_files: []