jekyll-graph 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f64a2319cdd80cdb634a4afb7ca8d3acd865256e433b605ec1b12ad8ea3bd90
-  data.tar.gz: d4c26ae5b3275d7895efd9c86b51217d049b91e9a5e5979e17098c89325bd3d7
+  metadata.gz: 16fc54d9f258c71e879a2b65b3d642e2c6ba0a30efaec85fb036941bffdf5c49
+  data.tar.gz: 052f0d8c7c64150116e7205f66f8d0052433713f0f012eac3ce229f9f48001fd
 SHA512:
-  metadata.gz: 6e1bd089641de720a3eeb8c94d584ea4dc8c860a7b40e9fb450b3c3f3b908a9c2306b10aabe54d759a5bf2ab17c2f557bc2694a1e4c73f754b9ff77c381c1bad
-  data.tar.gz: a8b70f66a8f12b02b6cdffbd34b168b3fcc1db401f702af58a44c3f492a51501df0d469ab490fb52873367d35569ab3314b5af362de5d2b6aa8d4d140898c192
+  metadata.gz: 1a4e8ea1b69e907907d5d384f7352dc4bc7f9cc1511c0e3a731cea9f43138074aa24f17691bc740a09979c34605add2838334b1ddf6ce8d96066597386c4ea70
+  data.tar.gz: 7ca4c585d6f999fb4a4dbf24801b7165fee27b67f01334e9d3dc66eb06f638889fc0276feeef71a5d632424c51a23c62445f667be74abbb255902936c63f7b2c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.0.5] - 2021-11-23
+### Change
+- 'relatives' -> 'lineage' for tree nodes.
+
 ## [0.0.4] 2021-11-22
 ### Fix
 - Custom path config related fix in scripts.

data/README.md

@@ -64,6 +64,9 @@ graph:
     scripts: "/assets/js"
   net_web:
     enabled: true
+    exclude:
+      attrs: false
+      links: false
     force:
       charge:
       strength_x:
@@ -88,6 +91,8 @@ graph:
 
 `path.scripts`: An optional custom scripts location for the graph scripts to generate into. Location is relative to the assets location in the `_site/` directory (If `assets_path` is set, but `scripts_path` is not, the location will default to `_site/<assets_path>/js/`).
 
+`net_web.exclude.attrs` and `net_web.exclude.links`: Determines whether wikilink attributes and/or links are added to the net-web graph from the link index.
+
 `tree.enabled` and `net_web.enabled`: Toggles on/off the `tree` and `net_web` graphs, respectively. Be sure to disable graphs that are not in use.
 
 `tree.force` and `net_web.force`: These are force variables from d3's simulation forces. You can check out the [docs for details](https://github.com/d3/d3-force#simulation_force).
@@ -175,11 +180,11 @@ For the tree graph, `graph-tree.json`, `links` are built from a tree data struct
   "nodes": [
     {
       "id": "<some-id>",
-      "url": "<relative-url>", // site.baseurl wil be handled for you here
+      "url": "<lineage-url>", // site.baseurl wil be handled for you here
       "label": "<note's-title>",
-      "relatives": {
-          "nodes": [<relative-node-id>, ...],
-          "links": [<relative-link-id>, ...],
+      "lineage": {
+          "nodes": [<lineage-node-id>, ...],
+          "links": [<lineage-link-id>, ...],
       }
     },
     ...

data/lib/jekyll-graph/config.rb

@@ -7,9 +7,11 @@ module Jekyll
     class PluginConfig
 
       ASSETS_KEY = "assets"
+      ATTRS_KEY = "attrs"
       CONFIG_KEY = "graph"
       ENABLED_KEY = "enabled"
       EXCLUDE_KEY = "exclude"
+      LINKS_KEY = "links"
       NET_WEB_KEY = "net_web"
       PATH_KEY = "path"
       SCRIPTS_KEY = "scripts"
@@ -22,7 +24,7 @@ module Jekyll
         Jekyll.logger.debug("Excluded jekyll types in graph: ", option(EXCLUDE_KEY)) unless disabled?
       end
 
-      # options
+      # descriptors
 
       def disabled?
         return option(ENABLED_KEY) == false
@@ -49,6 +51,18 @@ module Jekyll
         return option_path(SCRIPTS_KEY)
       end
 
+      def use_attrs?
+        return true if option_net_web_exclude(ATTRS_KEY).nil?
+        return !option_net_web_exclude(ATTRS_KEY)
+      end
+
+      def use_links?
+        return true if option_net_web_exclude(LINKS_KEY).nil?
+        return !option_net_web_exclude(LINKS_KEY)
+      end
+
+      # options
+
       def option(key)
         @config[CONFIG_KEY] && @config[CONFIG_KEY][key]
       end
@@ -61,6 +75,10 @@ module Jekyll
         @config[CONFIG_KEY] && @config[CONFIG_KEY][NET_WEB_KEY] && @config[CONFIG_KEY][NET_WEB_KEY][key]
       end
 
+      def option_net_web_exclude(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][NET_WEB_KEY] && @config[CONFIG_KEY][NET_WEB_KEY][EXCLUDE_KEY] && @config[CONFIG_KEY][NET_WEB_KEY][EXCLUDE_KEY][key]
+      end
+
       def option_tree(key)
         @config[CONFIG_KEY] && @config[CONFIG_KEY][TREE_KEY] && @config[CONFIG_KEY][TREE_KEY][key]
       end

data/lib/jekyll-graph/jekyll-graph.js

@@ -127,19 +127,19 @@ export default class JekyllGraph {
       let hoverNode = null;
       let hoverLink = null;
 
-      // relatives: replace ids with full objects
+      // lineage: replace ids with full objects
       data.nodes.forEach(node => {
-        // relatives
+        // lineage
         let relativeNodes = [];
-        node.relatives.nodes.forEach(nNodeId => {
+        node.lineage.nodes.forEach(nNodeId => {
           relativeNodes.push(data.nodes.find(node => node.id === nNodeId));
         });
         let relativeLinks = [];
-        node.relatives.links.forEach(nLink => {
+        node.lineage.links.forEach(nLink => {
           relativeLinks.push(data.links.find(link => link.source === nLink.source && link.target === nLink.target));
         });
-        node.relatives.nodes = relativeNodes;
-        node.relatives.links = relativeLinks;
+        node.lineage.nodes = relativeNodes;
+        node.lineage.links = relativeLinks;
         // siblings
         this.numSiblingsLeft[node.parent] = node.siblings.length;
       });
@@ -188,8 +188,8 @@ export default class JekyllGraph {
           highlightLinks.clear();
           if (node) {
             highlightNodes.add(node);
-            node.relatives.nodes.forEach(node => highlightNodes.add(node));
-            node.relatives.links.forEach(link => highlightLinks.add(link));
+            node.lineage.nodes.forEach(node => highlightNodes.add(node));
+            node.lineage.links.forEach(link => highlightLinks.add(link));
           }
           hoverNode = node || null;
         })
@@ -269,9 +269,9 @@ export default class JekyllGraph {
     } else if (hoverNode !== null && gType === "net-web" && !hoverNode.neighbors.nodes.includes(node)) {
       // non-neighbor to hoverNode
       fillText = false;
-    } else if (hoverNode !== null && gType === "tree" && hoverNode.relatives.nodes.includes(node)) {
+    } else if (hoverNode !== null && gType === "tree" && hoverNode.lineage.nodes.includes(node)) {
       // neighbor to hoverNode
-    } else if (hoverNode !== null && gType === "tree" && !hoverNode.relatives.nodes.includes(node)) {
+    } else if (hoverNode !== null && gType === "tree" && !hoverNode.lineage.nodes.includes(node)) {
       // non-neighbor to hoverNode
       fillText = false;
     } else if ((hoverNode === null && hoverLink !== null) && (hoverLink.source === node || hoverLink.target === node)) {

data/lib/jekyll-graph/version.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Graph
 
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
 
   end
 end

data/lib/jekyll-graph.rb

@@ -69,7 +69,7 @@ module Jekyll
         if !$graph_conf.disabled_tree?
           # generate json data
           json_tree_nodes, json_tree_links = self.generate_json_tree(@site.tree.root)
-          self.set_relatives(json_tree_nodes, json_tree_links)
+          self.set_lineage(json_tree_nodes, json_tree_links)
           tree_graph_content = JSON.dump(
             nodes: json_tree_nodes,
             links: json_tree_links,
@@ -138,20 +138,20 @@ module Jekyll
         end
       end
 
-      def set_relatives(json_nodes, json_links)
+      def set_lineage(json_nodes, json_links)
         # TODO: json nodes have relative_url, but node.id's/urls are doc urls.
         json_nodes.each do |json_node|
-          # set relatives
+          # set lineage
 
-          ancestor_node_ids, descendent_node_ids = @site.tree.get_all_relative_ids(json_node[:id])
-          relative_node_ids = ancestor_node_ids.concat(descendent_node_ids)
-          json_node[:relatives][:nodes] = relative_node_ids if !relative_node_ids.nil?
+          ancestor_node_ids, descendent_node_ids = @site.tree.get_all_lineage_ids(json_node[:id])
+          lineage_node_ids = ancestor_node_ids.concat(descendent_node_ids)
+          json_node[:lineage][:nodes] = lineage_node_ids if !lineage_node_ids.nil?
 
           # include current node when filtering for links along entire relative lineage
-          lineage_ids = relative_node_ids.concat([json_node[:id]])
+          lineage_ids = lineage_node_ids.concat([json_node[:id]])
 
-          json_relative_links = json_links.select { |l| lineage_ids.include?(l[:source]) && lineage_ids.include?(l[:target]) }
-          json_node[:relatives][:links] = json_relative_links if !json_relative_links.nil?
+          json_lineage_links = json_links.select { |l| lineage_ids.include?(l[:source]) && lineage_ids.include?(l[:target]) }
+          json_node[:lineage][:links] = json_lineage_links if !json_lineage_links.nil?
 
           # set siblings
 
@@ -203,10 +203,27 @@ module Jekyll
               },
             }
             # TODO: this link calculation ends up with duplicates -- re-visit this later.
-            @site.link_index.index[doc.url].attributes.each do |link| # link = { 'type' => str, 'urls' => [str, str, ...] }
-              # TODO: Header + Block-level wikilinks
-              link['urls'].each do |lu|
-                link_no_anchor = lu.match(/([^#]+)/i)[0]
+            if $graph_conf.use_attrs?
+              @site.link_index.index[doc.url].attributes.each do |link| # link = { 'type' => str, 'urls' => [str, str, ...] }
+                # TODO: Header + Block-level wikilinks
+                link['urls'].each do |lu|
+                  link_no_anchor = lu.match(/([^#]+)/i)[0]
+                  link_no_baseurl = @site.baseurl.nil? ? link_no_anchor : link_no_anchor.gsub(@site.baseurl, "")
+                  linked_doc = @md_docs.select{ |d| d.url == link_no_baseurl }
+                  if !linked_doc.nil? && linked_doc.size == 1 && !$graph_conf.excluded?(linked_doc.first.type)
+                    # TODO: add link['type'] to d3 graph
+                    net_web_links << {
+                      source: doc.url,
+                      target: linked_doc.first.url,
+                    }
+                  end
+                end
+              end
+            end
+            if $graph_conf.use_links?
+              @site.link_index.index[doc.url].forelinks.each do |link| # link = { 'type' => str, 'url' => str }
+                # TODO: Header + Block-level wikilinks
+                link_no_anchor = link['url'].match(/([^#]+)/i)[0]
                 link_no_baseurl = @site.baseurl.nil? ? link_no_anchor : link_no_anchor.gsub(@site.baseurl, "")
                 linked_doc = @md_docs.select{ |d| d.url == link_no_baseurl }
                 if !linked_doc.nil? && linked_doc.size == 1 && !$graph_conf.excluded?(linked_doc.first.type)
@@ -218,19 +235,6 @@ module Jekyll
                 end
               end
             end
-            @site.link_index.index[doc.url].forelinks.each do |link| # link = { 'type' => str, 'url' => str }
-              # TODO: Header + Block-level wikilinks
-              link_no_anchor = link['url'].match(/([^#]+)/i)[0]
-              link_no_baseurl = @site.baseurl.nil? ? link_no_anchor : link_no_anchor.gsub(@site.baseurl, "")
-              linked_doc = @md_docs.select{ |d| d.url == link_no_baseurl }
-              if !linked_doc.nil? && linked_doc.size == 1 && !$graph_conf.excluded?(linked_doc.first.type)
-                # TODO: add link['type'] to d3 graph
-                net_web_links << {
-                  source: doc.url,
-                  target: linked_doc.first.url,
-                }
-              end
-            end
 
           end
         end
@@ -252,7 +256,7 @@ module Jekyll
             namespace: node.namespace,
             url: "",
             level: level,
-            relatives: {
+            lineage: {
               nodes: [],
               links: [],
             },
@@ -278,7 +282,7 @@ module Jekyll
             namespace: node.namespace,
             url: relative_url(node.url),
             level: level,
-            relatives: {
+            lineage: {
               nodes: [],
               links: [],
             },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-graph
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-namespaces