jekyll-graph 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed0feb31f2a12640c7ba6611b2768a0d2424fff77a5d6909876e5f1b586abd0
-  data.tar.gz: 856133d37f0c83fc570ea8437edea51a4181d5b43f8e832b310ea17a08966a4c
+  metadata.gz: de4fcabd768803478de94c420777d5c869ef3413cf310fad0a787df5de651291
+  data.tar.gz: dbb8770a7bfd68bde812fc99e45cf048a3f8edef25fc2f02435eaa6aa9047e8a
 SHA512:
-  metadata.gz: 7cff6886e6391bb8920746f0f248fb13ed8f795841c66c714f0c91b158afa0c16253d82249941fee5b2b4e018a2d715af2fd4527509ab3af7d0626f415c52d68
-  data.tar.gz: cbd240e478d07b67f92c8da3d8a31c261e3a3ea58a9052838b7fd4bb30da830dc37092c72453db65e2aab293a9bdf38d022f522cba227008947d3c45bfeb2275
+  metadata.gz: d7c26b4ee6344fb97217275054f1d6882eaaa0d137fbcfd6c76045a1819cdc95d351fd77794f0fb560cc5af44571def099d45c3c1a7d3be5fb05a7541c01cb4d
+  data.tar.gz: 8c020f044a5130b91222e1bc990a95f4fe04ceae3e27a29f7f1adce4fa1cc655acf080bbc87a6545e182ad96f92747627bf2a4da389722dd6c19e639780ffcf1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.0.8] - 2022-03-03
+### Change
+- Update javascript setup instructions in README.
+### Fix
+- Check 'visited' localstorage variable is not null.
 ## [0.0.7] - 2022-01-27
 ### Change
 - Bump jekyll-wikilinks version number (0.0.11).

data/README.md

@@ -37,7 +37,7 @@ Follow the instructions for installing a [jekyll plugin](https://jekyllrb.com/do
 ```javascript
 import JekyllGraph from './jekyll-graph.js';
 
-export default class JekyllGraphSubClass extends JekyllGraph {
+class JekyllGraphSubClass extends JekyllGraph {
 
   constructor() {
     super();
@@ -49,10 +49,27 @@ export default class JekyllGraphSubClass extends JekyllGraph {
 }
 ```
 
-Call `this.drawNetWeb()` and `this.drawTree()` to actually draw the graph. You could do this simply on initialization or on a button click, etc.
+The import should point to the `jekyll-graph.js` javascript file generated by the plugin. Unless otherwise configured (see `path` vars below), the `jekyll-graph.js` file will be generated into `_site/assets/js/`. The sample javascript snippet above is presumed to be generated into `_site/assets/js/` as well.
 
-Unless otherwise configured (see `path` vars below), the `jekyll-graph.js` file will be generated into `_site/assets/js/`.
+4. Create a class instance:
 
+```javascript
+var graph = new JekyllGraphSubClass();
+```
+
+5. Call `drawNetWeb()` and/or `drawTree()` to actually draw the graph. You could do this simply on initialization or on a button click, etc.
+
+```javascript
+// on page load
+(() => {
+  graph.drawNetWeb();
+});
+
+// on button click
+this.graphBtn.addEventListener('click', () => {
+  graph.drawTree();
+});
+```
 ## Configuration
 
 Default configs look like this:
@@ -127,6 +144,8 @@ No configurations are strictly necessary for plugin defaults to work.
 Graph colors are determined by css variables which may be defined like so -- any valid css color works (hex, rgba, etc.):
 
 ```CSS
+/* make sure color vars are attached to the root of the html document */
+html {
   /* nodes */
   /* glow */
   --graph-node-current-glow: yellow;
@@ -142,6 +161,7 @@ Graph colors are determined by css variables which may be defined like so -- any
   --graph-particles-color: grey;
   /* label text */
   --graph-text-color: black;
+}
 ```
 
 ## Data

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

@@ -14,12 +14,12 @@ export default class JekyllGraph {
       // neighbors: replace ids with full object
       data.nodes.forEach(node => {
         let neighborNodes = [];
-        node.neighbors.nodes.forEach(nNodeId => {
-          neighborNodes.push(data.nodes.find(node => node.id === nNodeId));
+        node.neighbors.nodes.forEach(nodeId => {
+          neighborNodes.push(data.nodes.find(node => node.id === nodeId));
         });
         let neighborLinks = [];
-        node.neighbors.links.forEach(nLink => {
-          neighborLinks.push(data.links.find(link => link.source === nLink.source && link.target === nLink.target));
+        node.neighbors.links.forEach(linkIds => {
+          neighborLinks.push(data.links.find(link => link.source === linkIds.source && link.target === linkIds.target));
         });
         node.neighbors.nodes = neighborNodes;
         node.neighbors.links = neighborLinks;
@@ -131,15 +131,15 @@ export default class JekyllGraph {
       data.nodes.forEach(node => {
         // lineage
         let lineageNodes = [];
-        node.lineage.nodes.forEach(nNodeId => {
-          lineageNodes.push(data.nodes.find(node => node.id === nNodeId));
+        node.lineage.nodes.forEach(nodeId => {
+          lineageNodes.push(data.nodes.find(node => node.id === nodeId));
         });
-        let relativeLinks = [];
-        node.lineage.links.forEach(nLink => {
-          relativeLinks.push(data.links.find(link => link.source === nLink.source && link.target === nLink.target));
+        let lineageLinks = [];
+        node.lineage.links.forEach(linkIds => {
+          lineageLinks.push(data.links.find(link => link.source === linkIds.source && link.target === linkIds.target));
         });
         node.lineage.nodes = lineageNodes;
-        node.lineage.links = relativeLinks;
+        node.lineage.links = lineageLinks;
         // siblings
         this.numSiblingsLeft[node.parent] = node.siblings.length;
       });
@@ -227,7 +227,7 @@ export default class JekyllGraph {
   // draw helpers
 
   shiftNodeHeight(node) {
-    if (node.namespace !== 'root' && !this.shifted.includes(node)) {
+    if ((node.namespace !== 'root') && (node.namespace !== 'i.bonsai') && !this.shifted.includes(node)) {
       const padding = 5;
       let areSiblingsLeftEven = (this.numSiblingsLeft[node.parent] % 2) === 1;
       let altrntr = areSiblingsLeftEven ? 1 : -1;
@@ -338,8 +338,10 @@ export default class JekyllGraph {
   isVisitedPage(node) {
     if (!this.isMissingPage(node)) {
       var visited = JSON.parse(localStorage.getItem('visited'));
-      for (let i = 0; i < visited.length; i++) {
-        if (visited[i]['url'] === node.url) return true;
+      if (visited !== null) {
+        for (let i = 0; i < visited.length; i++) {
+          if (visited[i]['url'] === node.url) return true;
+        }
       }
     }
     return false;

data/lib/jekyll-graph/version.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Graph
 
-    VERSION = "0.0.7"
+    VERSION = "0.0.9"
 
   end
 end

data/lib/jekyll-graph.rb

@@ -37,7 +37,7 @@ module Jekyll
           return
         end
         if !$graph_conf.disabled_tree? && !site.respond_to?(:tree)
-          Jekyll.logger.error("Jekyll-Graph: To generate the tree graph, please either add and enable the 'jekyll-namespaces' plugin  or disable the tree in the jekyll-graph config")
+          Jekyll.logger.error("Jekyll-Graph: To generate the tree graph, please either add and enable the 'jekyll-semtree' or 'jekyll-namespaces' plugin, or disable the tree in the jekyll-graph config")
           return
         end
 
@@ -173,7 +173,7 @@ module Jekyll
             #
             @site.link_index.index[doc.url].missing.each do |missing_link_name|
               if net_web_nodes.none? { |node| node[:id] == missing_link_name }
-                Jekyll.logger.warn("Jekyll-Graph: Net-Web node missing: #{missing_link_name}, in: #{doc.data['title']}")
+                Jekyll.logger.warn("Jekyll-Graph: Net-Web node missing: #{missing_link_name}, in: #{File.basename(doc.basename, File.extname(doc.basename))}")
                 net_web_nodes << {
                   id: missing_link_name, # an id is necessary for link targets
                   url: '',
@@ -242,18 +242,24 @@ module Jekyll
         return net_web_nodes, net_web_links
       end
 
+      # used for both plugins:
+      # jekyll-semtree
+      # jekyll-namespace
       def generate_json_tree(node, json_parent="", tree_nodes=[], tree_links=[], level=0)
+        node = node.is_a?(String) ? @site.tree.nodes.detect { |n| n.text == node } : node
         #
         # missing nodes
         #
         if node.missing
-          Jekyll.logger.warn("Jekyll-Graph: Document for tree node missing: ", node.namespace)
+          missing_text = node.namespace ? node.namespace : node.text
+          Jekyll.logger.warn("Jekyll-Graph: Tree node missing: ", missing_text)
 
-          leaf = node.namespace.split('.').pop()
+          if node.namespace
+            leaf = node.namespace.split('.').pop()
+          end
           missing_node = {
-            id: node.namespace,
-            label: leaf.gsub('-', ' '),
-            namespace: node.namespace,
+            id: node.namespace ? node.namespace : node.text,
+            label: node.namespace ? leaf.gsub('-', ' ') : node.text,
             url: "",
             level: level,
             lineage: {
@@ -262,12 +268,15 @@ module Jekyll
             },
             siblings: [],
           }
+          if node.namespace
+            missing_node['namespace'] = node.namespace
+          end
           # non-root handling
           if !json_parent.empty?
             missing_node[:parent] = json_parent[:id]
             tree_links << {
               source: json_parent[:id],
-              target: node.namespace,
+              target: node.namespace ? node.namespace : node.text,
             }
           end
           tree_nodes << missing_node
@@ -279,7 +288,6 @@ module Jekyll
           existing_node = {
             id: node.url,
             label: node.title,
-            namespace: node.namespace,
             url: relative_url(node.url),
             level: level,
             lineage: {
@@ -288,6 +296,9 @@ module Jekyll
             },
             siblings: [],
           }
+          if node.namespace
+            existing_node['namespace'] = node.namespace
+          end
           # non-root handling
           if !json_parent.empty?
             existing_node[:parent] = json_parent[:id]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-graph
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Add d3 graph generation to jekyll.