rubydex 0.3.0 → 0.4.1

data/rust/rubydex/src/bin/generate_ruby_rules.rs

@@ -0,0 +1,94 @@
+use rubydex::diagnostic::{Rule, Severity};
+use std::collections::HashSet;
+use std::path::Path;
+use std::{env, fs};
+
+// Takes the built-in diagnostic rules and generates Ruby classes for them in `lib/rubydex/rules`.
+fn main() {
+    let root = Path::new(env!("CARGO_MANIFEST_DIR")).join("..").join("..");
+    let directory = root.join("lib").join("rubydex").join("rules");
+    let mut generated_files = HashSet::new();
+
+    for rule in Rule::all().iter().copied() {
+        write_rule(&directory, rule, &mut generated_files);
+    }
+
+    // Remove stale rules
+    for entry in fs::read_dir(&directory).unwrap() {
+        let entry = entry.unwrap();
+        let path = entry.path();
+
+        if path.is_file() {
+            let file_name = path.file_name().unwrap().to_string_lossy();
+
+            if !generated_files.contains(&file_name.to_string()) {
+                fs::remove_file(path).unwrap();
+            }
+        }
+    }
+}
+
+fn write_rule(dir: &Path, rule: Rule, generated_files: &mut HashSet<String>) {
+    let documentation = rule
+        .documentation()
+        .iter()
+        .map(|line| format!("    #{line}").trim_end().to_owned())
+        .collect::<Vec<String>>()
+        .join("\n");
+
+    let contents = format!(
+        "# typed: strict
+# frozen_string_literal: true
+
+# This file is generated by `generate_ruby_rules.rs`. Do not edit this manually.
+
+module Rubydex
+  module Rules
+{documentation}
+    class {name} < Rule
+      class << self
+        # @override
+        #: -> singleton(Severity::Base)
+        def default_severity
+          {severity}
+        end
+      end
+    end
+  end
+end
+",
+        name = rule.name(),
+        severity = to_ruby_severity(rule.default_severity()),
+    );
+
+    let file_name = format!("{}.rb", snake_case(rule.name()));
+    fs::write(dir.join(&file_name), contents).unwrap();
+    generated_files.insert(file_name);
+}
+
+fn to_ruby_severity(severity: Severity) -> &'static str {
+    match severity {
+        Severity::Error => "Severity::Error",
+        Severity::Warning => "Severity::Warning",
+        Severity::Information => "Severity::Information",
+        Severity::Hint => "Severity::Hint",
+    }
+}
+
+fn snake_case(name: &str) -> String {
+    let mut result = String::with_capacity(name.len() + 4);
+
+    for (index, character) in name.char_indices() {
+        if character.is_uppercase() {
+            if index != 0 {
+                result.push('_');
+            }
+
+            result.extend(character.to_lowercase());
+        } else {
+            result.push(character);
+        }
+    }
+
+    result
+}