yard-medoosa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a9aafb3def317dbf7e7f5259184d680c5f32b582f84d4c6ee93780b124b330f
+  data.tar.gz: 5ad2dc042c73e4f978fd5fce7d96cf8617ffb8580da6f2a0c19ae09d82796621
+SHA512:
+  metadata.gz: 2f9cb843b309cb15f360ce9ae088b4bfd71207ce53516579d1e7f5b2e2b8c829ec65a147fbea7c7d85458e8b6db00bb244d30c9f669d463ddc4d5f9a62f6ea15
+  data.tar.gz: ddbca4431c1d454d161c1746a4e96c7b9a4a3acbb854afe7d85ccc66909f2ed1e4d53295d032cd2098977baaf9598f3ed9607c6b93f76471d3adea0d84085925

data/bin/yard-medoosa

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "yard-medoosa"
+puts "Sorry, standalone script not working yet; use:"
+puts "  yard doc --plugin medoosa"

data/lib/yard/medoosa.rb

@@ -0,0 +1,71 @@
+require "yard"
+require "fileutils"
+require "graphviz"
+
+module YARD
+  # Enhance YARD documentation by generating class diagrams
+  module Medoosa
+    def module_children(namespace)
+      namespace.children.find_all do |code_object|
+        case code_object
+        when YARD::CodeObjects::ModuleObject, YARD::CodeObjects::ClassObject
+          true
+        end
+      end
+    end
+
+    # @param graph [Graphviz::Graph]
+    # @param all_nodes [Hash{String => Graphviz::Node}] (filled by the method)
+    # @param namespace [YARD::CodeObjects::NamespaceObject]
+    def add_clusters(graph, all_nodes, namespace)
+      children = module_children(namespace)
+      if children.empty?
+        href = namespace.path.gsub("::", "/") + ".html"
+        n = graph.add_node(namespace.path,
+                           label: namespace.name, shape: "box", href: href)
+        all_nodes[namespace.path] = n
+      else
+        if namespace.is_a? YARD::CodeObjects::RootObject
+          sg = graph
+        else
+          sg = graph.add_subgraph(cluster: true)
+          sg.attributes[:name] = namespace.path
+          sg.attributes[:label] = namespace.name
+        end
+        children.each do |c|
+          add_clusters(sg, all_nodes, c)
+        end
+      end
+    end
+
+    # @param basepath Where the YARD output goes
+    def generate_medoosa(basepath)
+      YARD::Registry.load!
+
+      g = Graphviz::Graph.new
+      all_nodes = {}
+      add_clusters(g, all_nodes, YARD::Registry.root)
+
+      YARD::Registry.all(:class).each do |code_object|
+        sup = YARD::Registry.resolve(nil, code_object.superclass)
+        next if sup.nil?
+
+        n = all_nodes.fetch(code_object.path)
+        n_sup = all_nodes.fetch(sup.path)
+        n_sup.connect(n, arrowtail: "onormal", dir: "back")
+      end
+
+      base_fn = "#{basepath}/medoosa-nesting"
+
+      File.open("#{base_fn}.f.dot", "w") do |f|
+        g.dump_graph(f)
+      end
+
+      system "unflatten -l5 -c5 -o#{base_fn}.dot #{base_fn}.f.dot"
+      system "dot -Tpng -o#{base_fn}.png #{base_fn}.dot"
+      system "dot -Tsvg -o#{base_fn}.svg #{base_fn}.dot"
+
+      "#{base_fn}.svg"
+    end
+  end
+end

data/lib/yard-medoosa.rb

@@ -0,0 +1,22 @@
+require "yard/medoosa"
+
+module YARD
+  module CLI
+    # Monkey patch YARD to hook into `yard doc`
+    class Yardoc
+      include Medoosa
+
+      def run_generate_with_medoosa(*args)
+        run_generate_without_medoosa(*args)
+        fname = generate_medoosa(options.serializer.basepath)
+        options.files << CodeObjects::ExtraFileObject.new(fname)
+        # FIXME: what, do we really run it twice?!
+        # yes, until I figure out a better place to hook generate_medoosa in
+        run_generate_without_medoosa(*args)
+      end
+
+      alias run_generate_without_medoosa run_generate
+      alias run_generate run_generate_with_medoosa
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: yard-medoosa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Vidner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Enhance YARD documentation by generating class diagrams.
+email: martin@vidner.net
+executables:
+- yard-medoosa
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/yard-medoosa
+- lib/yard-medoosa.rb
+- lib/yard/medoosa.rb
+homepage: https://rubygems.org/gems/yard-medoosa
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: YARD class diagrams
+test_files: []