simple_english 0.1.0

data/lib/simple_english.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Lint Markdown prose with the SimpleEnglish Plain-mode rules.
+# Pattern rules run on LanguageTool. Counting rules run here.
+# This file is the composition root. The pieces live in lib/simple_english/.
+
+require_relative "simple_english/finding"
+require_relative "simple_english/markdown"
+require_relative "simple_english/counts"
+require_relative "simple_english/languagetool"
+require_relative "simple_english/install"
+require_relative "simple_english/extractor"
+require_relative "simple_english/annotated_text"
+require_relative "simple_english/suppressions"
+require_relative "simple_english/config"
+require_relative "simple_english/engine"
+require_relative "simple_english/http"
+require_relative "simple_english/client"
+require_relative "simple_english/server"
+
+module SimpleEnglish
+  VERSION = "0.1.0"
+
+  module_function
+
+  # Returns findings, or nil when the daemon is unreachable. The
+  # caller (bin/se) owns the exit status. Diagnostics go to
+  # stderr here.
+  def lint_text(text)
+    return nil unless Client.ensure_up(install: Install.from_env)
+    Client.lint(text)
+  end
+
+  # One entry point for files. Markdown keeps the counting rules. Code
+  # files lint comments through the daemon. nil means unreachable:
+  # the caller decides how fatal that is.
+  def lint_file(path, text = File.read(path))
+    language = Extractor.language_for(path)
+    findings =
+      if language
+        # Comment-free files never reach the daemon. No boot, no POST.
+        return [] if Extractor.comment_spans(text, language).empty?
+        return nil unless Client.ensure_up(install: Install.from_env)
+        result = Client.lint(text, language: language)
+        if result.nil?
+          warn "error: se daemon did not answer. Run `se serve` and read its output."
+        end
+        result
+      else
+        lint_text(text)
+      end
+    return nil unless findings
+    Suppressions.filter(text, findings)
+  end
+
+  def corpus_test
+    pairs = Dir.glob(File.expand_path("../test/corpus/*-before.md", __dir__))
+      .sort
+    failed = pairs.flat_map do |before|
+      after = before.sub(/-before\.md\z/, "-after.md")
+      before_findings = lint_text(File.read(before))
+      after_findings = lint_text(File.read(after))
+      messages = []
+      if before_findings.nil? || after_findings.nil?
+        messages << "#{before}: daemon unreachable"
+      else
+        messages << "#{before}: no findings, the rule set misses this case" if before_findings.empty?
+        unless after_findings.empty?
+          messages << "#{after}: still flagged: #{after_findings.map(&:rule).join(", ")}"
+        end
+      end
+      messages
+    end
+    failed.each { |failure| puts "FAIL #{failure}" }
+    puts "corpus: #{pairs.size} pairs, #{failed.size} failures"
+    failed.empty?
+  end
+end