Update docs generation script

f-moya · f-moya · commit 17d33bf5cb72 · 2021-09-14T19:16:38.000-03:00
diff --git a/Dockerfile b/Dockerfile
@@ -35,16 +35,18 @@ RUN composer install --no-dev && \
     chown -R app:app . && \
     rm -r ~/.composer
 
+
 # Build Content
 COPY bin/build-content ./bin/build-content
-RUN apk add --no-cache ruby ruby-json ruby-bigdecimal && \
-    gem install rdoc httparty --no-document && \
+RUN apk add --no-cache ruby ruby-json ruby-bigdecimal ruby-nokogiri ruby-dev build-base libxml2-dev libxslt-dev libffi-dev && \
+    gem install rdoc nokogiri httparty --no-document && \
     ./bin/build-content && \
-    chown -R app:app content && \
-    gem uninstall rdoc httparty && \
-    rm -rf $( gem environment gemdir ) && \
-    apk del --purge ruby ruby-json ruby-bigdecimal && \
-    rm -r /var/cache/* ~/.gem
+    chown -R app:app content
+    #chown -R app:app content && \
+    #gem uninstall rdoc httparty && \
+    #rm -rf $( gem environment gemdir ) && \
+    #apk del --purge ruby ruby-json ruby-bigdecimal && \
+    #rm -r /var/cache/* ~/.gem
 
 COPY . ./
 
diff --git a/bin/build-content b/bin/build-content
@@ -1,58 +1,69 @@
 #!/usr/bin/env ruby
 
-require 'httparty'
-require 'fileutils'
+require "httparty"
+require "fileutils"
+require "nokogiri"
 
 CONTENT_DIR = "./content"
-FILE_NAME_OVERRIDES = {
-  "excessiveclasscomplexity" => "weightedmethodcount",
-}
-
-categories = {
-  cleancode: "http://phpmd.org/rules/cleancode.txt",
-  codesize: "http://phpmd.org/rules/codesize.txt",
-  controversial: "http://phpmd.org/rules/controversial.txt",
-  design: "http://phpmd.org/rules/design.txt",
-  naming: "http://phpmd.org/rules/naming.txt",
-  unused: "http://phpmd.org/rules/unusedcode.txt"
-}
+CATEGORIES = %w(cleancode codesize controversial design naming unusedcode)
 
-FileUtils.rm_rf(CONTENT_DIR)
-FileUtils.mkdir_p(CONTENT_DIR)
+class Rule
+  attr_accessor :name, :since, :source, :description, :example
+end
 
-def file_name(header)
-  file_name = header.gsub(" ", "_").downcase
-  FILE_NAME_OVERRIDES.fetch(file_name, file_name)
+def fetch_category_rules(category)
+  base_url = "https://raw.githubusercontent.com/phpmd/phpmd/master/src/main/resources/rulesets"
+  HTTParty.get("#{base_url}/#{category}.xml").body
 end
 
-categories.each do |category, url|
-  text = HTTParty.get(url).body
+def process_category_rules(xml_rules)
+  rules = []
+  rules_node_set =  Nokogiri::XML.parse(xml_rules).children.children
+  rules_node_set.each do |node|
+    next unless node.name.eql?("rule")
+    rule = Rule.new
+    rule.name = node.get_attribute("name")
+    rule.since = node.get_attribute("since")
+    rule.source = node.get_attribute("externalInfoUrl")
+    node.children.each do |child_node|
+      if child_node.name.eql?("description")
+        rule.description = child_node.text.strip
+      end
+      if child_node.name.eql?("example")
+        rule.example = child_node.text
+      end
+    end
+    rules << rule
+  end
+  rules
+end
 
-  matches = text.split(/=+\n.*?\n=+/, 2).pop
-  matches = matches.split(/^=+\n$/)
+FileUtils.rm_rf(CONTENT_DIR)
+FileUtils.mkdir_p(CONTENT_DIR)
 
-  sections = matches.each_with_object([]) do |match, array|
-    split = match.split(/\n/)
-    title = split.pop
-    body = split.join("\n")
+rules = []
 
-    body.gsub!(/(?<=Example:) ::/, "\n\n```php")
-    body = body.split(/This rule.*/).shift
-    body += "\n```"
+CATEGORIES.each do |category|
+  raw_xml_rules = fetch_category_rules(category)
+  category_rules = process_category_rules(raw_xml_rules)
+  rules.concat(category_rules)
+end
 
-    array << body
-    array << title
-  end
+rules.each do |rule|
+  File.open("#{CONTENT_DIR}/#{rule.name.downcase}.txt", "w") do |file|
+    md = <<~MARKDOWN
+      # #{rule.name}
+      #{"### Since: " if rule.since } #{rule.since if rule.since}
 
-  sections.shift
-  sections.pop
+      #{rule.description}
 
-  sections.each_slice(2) do |(header, body)|
-    next if header == "Remark"
+      ## Example
+      ```php
+      #{rule.example}
+      ```
 
-    File.open("#{CONTENT_DIR}/#{file_name(header)}.txt", "w") do |file|
-      file.write(body)
-      file.write("\n\nSource: #{url}")
-    end
+      ## Source #{rule.source}
+    MARKDOWN
+    file.write(md)
   end
 end
