jekyll-graph 0.0.5 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16fc54d9f258c71e879a2b65b3d642e2c6ba0a30efaec85fb036941bffdf5c49
-  data.tar.gz: 052f0d8c7c64150116e7205f66f8d0052433713f0f012eac3ce229f9f48001fd
+  metadata.gz: 66875092a5dcc753a34bb074f399ec0e5de3cbaa9a25fa154fc585420bce6007
+  data.tar.gz: '0423681fcf78d2fc0487d318c02d52b8cfe9f93d4be79747bfa72b7a3ae00be5'
 SHA512:
-  metadata.gz: 1a4e8ea1b69e907907d5d384f7352dc4bc7f9cc1511c0e3a731cea9f43138074aa24f17691bc740a09979c34605add2838334b1ddf6ce8d96066597386c4ea70
-  data.tar.gz: 7ca4c585d6f999fb4a4dbf24801b7165fee27b67f01334e9d3dc66eb06f638889fc0276feeef71a5d632424c51a23c62445f667be74abbb255902936c63f7b2c
+  metadata.gz: d2439f89e5287ab1c298e9e4e42563b43961debe93200b69c2cf9f2768bb70ce97c9084c58c34f14ad331e1f3f414d07b54f66688047ff8764cebccba846addb
+  data.tar.gz: 4b9eec6d0e335d670714fb128736f2883d53d38d2c066acb3f2901fb3ba002d854276778c35ab18b4c707ae7ef74c34eaa66e47f667fb887c3c5127a7f29082e

data/CHANGELOG.md

@@ -1,12 +1,24 @@
+## [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).
+## [0.0.6] - 2022-01-24
+### Change
+- Move jekyll patch files to patch/ dir.
+- Bump jekyll-wikilinks version number (0.0.10).
 ## [0.0.5] - 2021-11-23
 ### Change
 - 'relatives' -> 'lineage' for tree nodes.
 
-## [0.0.4] 2021-11-22
+## [0.0.4] - 2021-11-22
 ### Fix
 - Custom path config related fix in scripts.
 
-## [0.0.3] 2021-11-22
+## [0.0.3] - 2021-11-22
 ### Change
 - Fix javascript inheritance.
 - Decrement missing node log messages from 'warn' to 'debug'.

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 gem "jekyll", "~> 4.2.0"
 gem "jekyll-namespaces", "~> 0.0.3"
-gem "jekyll-wikilinks", "~> 0.0.8"
+gem "jekyll-wikilinks", "~> 0.0.11"
 
 gem "rake", "~> 13.0.3"
 gem "rspec", "~> 3.10"

data/README.md

@@ -6,7 +6,7 @@
 
 Jekyll-Graph generates data and renders a graph that allows visitors to navigate a jekyll site by clicking nodes in the graph. Nodes are generated from the site's markdown files. Links for the tree graph are generated from [`jekyll-namespaces`](https://github.com/manunamz/jekyll-namespaces) and links for the net-web graph from [`jekyll-wikilinks`](https://github.com/manunamz/jekyll-wikilinks).
 
-This gem is part of the [jekyll-bonsai](https://manunamz.github.io/jekyll-bonsai/) project. 🎋
+This gem is part of the [jekyll-bonsai](https://jekyll-bonsai.netlify.app/) project. 🎋
 
 ## Installation
 
@@ -37,20 +37,39 @@ 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();
+    // access graph with 'this.graph'
     // access graph div with 'this.graphDiv'
   }
   
   // ...
 }
 ```
-Call `this.drawNetWeb()` and `this.drawTree()` to actually draw the graph. You could do this simply on initialization or on a button click, etc.
 
-Unless otherwise defined, the `jekyll-graph.js` file will be generated into `_site/assets/js/`.
+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.
 
+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:

data/jekyll-graph.gemspec

@@ -30,11 +30,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "jekyll", "~> 4.2.0"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 
   spec.add_runtime_dependency "jekyll-namespaces", "~> 0.0.3"
-  spec.add_runtime_dependency "jekyll-wikilinks", "~> 0.0.8"
+  spec.add_runtime_dependency "jekyll-wikilinks", "~> 0.0.11"
 end

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;
@@ -130,16 +130,16 @@ export default class JekyllGraph {
       // lineage: replace ids with full objects
       data.nodes.forEach(node => {
         // lineage
-        let relativeNodes = [];
-        node.lineage.nodes.forEach(nNodeId => {
-          relativeNodes.push(data.nodes.find(node => node.id === nNodeId));
+        let lineageNodes = [];
+        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 = relativeNodes;
-        node.lineage.links = relativeLinks;
+        node.lineage.nodes = lineageNodes;
+        node.lineage.links = lineageLinks;
         // siblings
         this.numSiblingsLeft[node.parent] = node.siblings.length;
       });
@@ -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.5"
+    VERSION = "0.0.8"
 
   end
 end

data/lib/jekyll-graph.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 require "jekyll"
 
-require_relative "jekyll-graph/context"
-require_relative "jekyll-graph/page"
+require_relative "jekyll-graph/patch/context"
+require_relative "jekyll-graph/patch/page"
 require_relative "jekyll-graph/version"
 
 # setup config

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-graph
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.8
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: jekyll-namespaces
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.0.11
 description:
 email:
 - manunamz@pm.me
@@ -59,9 +73,9 @@ files:
 - jekyll-graph.gemspec
 - lib/jekyll-graph.rb
 - lib/jekyll-graph/config.rb
-- lib/jekyll-graph/context.rb
 - lib/jekyll-graph/jekyll-graph.js
-- lib/jekyll-graph/page.rb
+- lib/jekyll-graph/patch/context.rb
+- lib/jekyll-graph/patch/page.rb
 - lib/jekyll-graph/tags.rb
 - lib/jekyll-graph/version.rb
 homepage: https://github.com/manunamz/jekyll-graph