jekyll-graph 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8e8d2c47a467d671a541f0383514514ce1dc661b547384badcf7ff127a7f48
-  data.tar.gz: b71d501a8c8b3eabcc7f5c54534d299bcb31b15459281ec57ee54a72275ddb07
+  metadata.gz: d143e24a47db4dbc9d9792c1eb09223f78d85da5d33adae50187b30331874956
+  data.tar.gz: 126d97994a598c28d4284e54980a3cf49d58b48733bae41c894e2e1172485053
 SHA512:
-  metadata.gz: bc3bb48999037c60980546dbec3192ae9c857b11f73cc36d947370535f0a81e7420b2273af8bbd1ee24fb0fa637354f0dfca8658c5dcae521b78525c928cdf3c
-  data.tar.gz: a397d40e8f56f1968780bc0fcf8573471365746ff59a1ad6f4a2685e09dfb0a5756df1eaaf0141721a6caa9dec78ec91290926f3f7eed504319691656d5a22e7
+  metadata.gz: 07a27ee92832a88f43ebc23eb30285aa6873b394a91b152269d812400a8c69f39dd85c530d5e4f0c399c27d27eb2dac283d2abec0742fe4d56ecb0e985caf0f2
+  data.tar.gz: 7fb96e000d369fcd8004a4ec8e8411ded14e7ee4c1042bf2427add05e412465fbfcd95a1b9af7e01dce13109b34a66d77f84b5dd749efc5260e324b37efa3d3b

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.0.11] - 2023-10-06
+### Change
+- `net-web` -> `web`.
+## [0.0.10] - 2023-09-25
+### Fix
+- Dependencies
+## [0.0.9] - 2023-09-25
+### Change
+- Update plugin to support both `jekyll-namespaces` and `jekyll-semtree`.
 ## [0.0.8] - 2022-03-03
 ### Change
 - Update javascript setup instructions in README.
@@ -13,11 +22,9 @@
 ## [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.
-
 ## [0.0.3] - 2021-11-22
 ### Change
 - Fix javascript inheritance.
@@ -26,11 +33,9 @@
 ### Fix
 - Display log messages related to dependencies (see [#2](https://github.com/manunamz/jekyll-graph/issues/2)).
 - Custom path configs.
-
 ## [0.0.2] - 2021-09-17
 ### Change
 - Liquid tag `force-graph` -> `jekyll_graph`.  
-
 ## [0.0.1] - 2021-09-17
 - Initial release
 ### Added

data/README.md

@@ -7,7 +7,7 @@
 
 ⚠️ Expect breaking changes and surprises until otherwise noted (likely by v0.1.0 or v1.0.0). ⚠️
 
-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-semtree`](https://github.com/wikibonsai/jekyll-semtree) or [`jekyll-namespaces`](https://github.com/manunamz/jekyll-namespaces) and links for the net-web graph from [`jekyll-wikirefs`](https://github.com/wikibonsai/jekyll-wikirefs) [`jekyll-wikilinks`](https://github.com/manunamz/jekyll-wikilinks).
+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-semtree`](https://github.com/wikibonsai/jekyll-semtree) and links for the web graph from [`jekyll-wikirefs`](https://github.com/wikibonsai/jekyll-wikirefs) (legacy versions from [`jekyll-namespaces`](https://github.com/manunamz/jekyll-namespaces) and [`jekyll-wikilinks`](https://github.com/manunamz/jekyll-wikilinks) respectively).
 
 🏡 Build and maintain a treehouze to play in in your [WikiBonsai](https://github.com/wikibonsai/wikibonsai) digital garden.
 
@@ -60,12 +60,12 @@ The import should point to the `jekyll-graph.js` javascript file generated by th
 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.
+5. Call `drawWeb()` 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();
+  graph.drawWeb();
 });
 
 // on button click
@@ -84,7 +84,7 @@ graph:
   path:
     assets: "/assets"
     scripts: "/assets/js"
-  net_web:
+  web:
     enabled: true
     exclude:
       attrs: false
@@ -113,11 +113,11 @@ 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.
+`web.exclude.attrs` and `web.exclude.links`: Determines whether wikilink attributes and/or links are added to the 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.enabled` and `web.enabled`: Toggles on/off the `tree` and `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).
+`tree.force` and `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).
 
 Force values will likely need to be played with depending on the div size and number of nodes. [jekyll-bonsai](https://manunamz.github.io/jekyll-bonsai/) currently uses these values:
 
@@ -131,7 +131,7 @@ graph:
       x_val: 0.9
       strength_y: 0.1
       y_val: 0.9
-  net_web:
+  web:
     force:
       charge: -300
       strength_x: 0.3
@@ -170,10 +170,10 @@ html {
 ## Data
 Graph data is generated in the following format:
 
-For the net-web graph, `graph-net-web.json`,`links` are built from `backlinks` and `attributed` metadata generated in `jekyll-wikilinks`:
+For the web graph, `graph-web.json`,`links` are built from `backlinks` and `attributed` metadata generated in `jekyll-wikilinks`:
 
 ```json
-// graph-net-web.json
+// graph-web.json
 {
   "nodes": [
     {

data/lib/jekyll-graph/config.rb

@@ -6,17 +6,17 @@ module Jekyll
 
     class PluginConfig
 
-      ASSETS_KEY = "assets"
-      ATTRS_KEY = "attrs"
-      CONFIG_KEY = "graph"
+      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"
+      LINKS_KEY   = "links"
+      NET_WEB_KEY = "net_web" # deprecated: 'net_web' -> 'web'
+      PATH_KEY    = "path"
       SCRIPTS_KEY = "scripts"
-      TREE_KEY = "tree"
-      TYPE_KEY = "type"
+      TREE_KEY    = "tree"
+      WEB_KEY     = "web"
 
       def initialize(config)
         @config ||= config
@@ -30,12 +30,17 @@ module Jekyll
         return option(ENABLED_KEY) == false
       end
 
+      def disabled_tree?
+        return option_tree(ENABLED_KEY) == false
+      end
+
+      # deprecated: 'net_web' -> 'web'
       def disabled_net_web?
-        return option_net_web(ENABLED_KEY) == false
+        return option_web(ENABLED_KEY) == false
       end
 
-      def disabled_tree?
-        return option_tree(ENABLED_KEY) == false
+      def disabled_web?
+        option_web(ENABLED_KEY) == false
       end
 
       def excluded?(type)
@@ -52,13 +57,13 @@ module Jekyll
       end
 
       def use_attrs?
-        return true if option_net_web_exclude(ATTRS_KEY).nil?
-        return !option_net_web_exclude(ATTRS_KEY)
+        return true if option_web_exclude(ATTRS_KEY).nil?
+        return !option_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)
+        return true if option_web_exclude(LINKS_KEY).nil?
+        return !option_web_exclude(LINKS_KEY)
       end
 
       # options
@@ -71,12 +76,28 @@ module Jekyll
         @config[CONFIG_KEY] && @config[CONFIG_KEY][PATH_KEY] && @config[CONFIG_KEY][PATH_KEY][key]
       end
 
-      def option_net_web(key)
-        @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]
+      def option_web(key)
+        if @config[CONFIG_KEY]
+          # deprecated: 'net_web' -> 'web'
+          if @config[CONFIG_KEY][NET_WEB_KEY]
+            return @config[CONFIG_KEY][NET_WEB_KEY][key]
+          end
+          if @config[CONFIG_KEY][WEB_KEY]
+            return @config[CONFIG_KEY][WEB_KEY][key]
+          end
+        end
+      end
+
+      def option_web_exclude(key)
+        if @config[CONFIG_KEY]
+          # deprecated: 'net_web' -> 'web'
+          if @config[CONFIG_KEY][NET_WEB_KEY] && @config[CONFIG_KEY][NET_WEB_KEY][EXCLUDE_KEY]
+            return @config[CONFIG_KEY][NET_WEB_KEY][EXCLUDE_KEY][key]
+          end
+          if @config[CONFIG_KEY][WEB_KEY]&& @config[CONFIG_KEY][WEB_KEY][EXCLUDE_KEY]
+            return @config[CONFIG_KEY][WEB_KEY][EXCLUDE_KEY][key]
+          end
+        end
       end
 
       def option_tree(key)

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

@@ -7,9 +7,17 @@ export default class JekyllGraph {
   }
 
   // d3
+
+  // deprecated: 'net_web' -> 'web'
   drawNetWeb () {
+    this.drawWeb(true);
+  }
+
+  drawWeb (legacy = false) {
     let assetsPath = '{{ site.graph.path.assets }}' !== '' ? '{{ site.graph.path.assets }}' : '/assets';
-    fetch(`{{ site.baseurl }}${assetsPath}/graph-net-web.json`).then(res => res.json()).then(data => {
+    // deprecated: 'net-web' -> 'web' in filenames
+    let filename = legacy ? 'graph-net-web.json' : 'graph-web.json';
+    fetch(`{{ site.baseurl }}${assetsPath}/${filename}`).then(res => res.json()).then(data => {
 
       // neighbors: replace ids with full object
       data.nodes.forEach(node => {
@@ -34,13 +42,20 @@ export default class JekyllGraph {
         this.graph._destructor();
       }
 
+      // deprecated: 'net_web' -> 'web' in configs
+      const charge    = legacy ? '{{ site.graph.net_web.force.charge }}'     : '{{ site.graph.web.force.charge }}';
+      const xStrength = legacy ? '{{ site.graph.net_web.force.strength_x }}' : '{{ site.graph.web.force.strength_x }}';
+      const xVal      = legacy ? '{{ site.graph.net_web.force.x_val }}'      : '{{ site.graph.web.force.x_val }}';
+      const yStrength = legacy ? '{{ site.graph.net_web.force.strength_y }}' : '{{ site.graph.web.force.strength_y }}';
+      const yVal      = legacy ? '{{ site.graph.net_web.force.y_val }}'      : '{{ site.graph.web.force.y_val }}';
+
       const Graph = ForceGraph()(this.graphDiv)
         // container
         .height(this.graphDiv.parentElement.clientHeight)
         .width(this.graphDiv.parentElement.clientWidth)
         // node
-        .nodeCanvasObject((node, ctx) => this.nodePaint(node, ctx, hoverNode, hoverLink, "net-web"))
-        // .nodePointerAreaPaint((node, color, ctx, scale) => nodePaint(node, nodeTypeInNetWeb(node), ctx))
+        .nodeCanvasObject((node, ctx) => this.nodePaint(node, ctx, hoverNode, hoverLink, "web"))
+        // .nodePointerAreaPaint((node, color, ctx, scale) => nodePaint(node, nodeTypeInWeb(node), ctx))
         .nodeId('id')
         .nodeLabel('label')
         .onNodeClick((node, event) => this.goToPage(node, event))
@@ -56,15 +71,15 @@ export default class JekyllGraph {
         //                       .links(data.links))
 
          .d3Force('charge',  d3.forceManyBody()
-                               .strength(Number('{{ site.graph.net_web.force.charge }}')))
+                               .strength(Number(charge)))
          // .d3Force('collide', d3.forceCollide())
          // .d3Force('center',  d3.forceCenter())
          .d3Force('forceX',  d3.forceX()
-                               .strength(Number('{{ site.graph.net_web.force.strength_x }}'))
-                               .x(Number('{{ site.graph.net_web.force.x_val }}')))
+                               .strength(Number(xStrength))
+                               .x(Number(xVal)))
          .d3Force('forceY', d3.forceY()
-                              .strength(Number('{{ site.graph.net_web.force.strength_y }}'))
-                              .y(Number('{{ site.graph.net_web.force.y_val }}')))
+                              .strength(Number(yStrength))
+                              .y(Number(yVal)))
 
         // hover
         .autoPauseRedraw(false) // keep redrawing after engine has stopped
@@ -153,7 +168,7 @@ export default class JekyllGraph {
         .width(this.graphDiv.parentElement.clientWidth)
         // node
         .nodeCanvasObject((node, ctx) => this.nodePaint(node, ctx, hoverNode, hoverLink, "tree"))
-        // .nodePointerAreaPaint((node, color, ctx, scale) => nodePaint(node, nodeTypeInNetWeb(node), ctx))
+        // .nodePointerAreaPaint((node, color, ctx, scale) => nodePaint(node, nodeTypeInWeb(node), ctx))
         .nodeId('id')
         .nodeLabel('label')
         // todo-shift: this shiftNodeHeight() always renders, but animatation is choppy
@@ -226,16 +241,16 @@ export default class JekyllGraph {
 
   // draw helpers
 
-  shiftNodeHeight(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;
-      node.fy = node.fy + (altrntr * (this.numSiblingsLeft[node.parent] * padding));
-      this.numSiblingsLeft[node.parent] -= 1;
-      this.shifted.push(node);
-    }
-  }
+  // shiftNodeHeight(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;
+  //     node.fy = node.fy + (altrntr * (this.numSiblingsLeft[node.parent] * padding));
+  //     this.numSiblingsLeft[node.parent] -= 1;
+  //     this.shifted.push(node);
+  //   }
+  // }
 
   nodePaint(node, ctx, hoverNode, hoverLink, gType) {
     // todo-shift: this shiftNodeHeight() animates more smoothly, but suffers from a race condition
@@ -264,9 +279,9 @@ export default class JekyllGraph {
       // hoverNode
       radius *= 2;
       fillText = false; // node label should be active
-    } else if (hoverNode !== null && gType === "net-web" && hoverNode.neighbors.nodes.includes(node)) {
+    } else if (hoverNode !== null && gType === "web" && hoverNode.neighbors.nodes.includes(node)) {
       // neighbor to hoverNode
-    } else if (hoverNode !== null && gType === "net-web" && !hoverNode.neighbors.nodes.includes(node)) {
+    } else if (hoverNode !== null && gType === "web" && !hoverNode.neighbors.nodes.includes(node)) {
       // non-neighbor to hoverNode
       fillText = false;
     } else if (hoverNode !== null && gType === "tree" && hoverNode.lineage.nodes.includes(node)) {

data/lib/jekyll-graph/version.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Graph
 
-    VERSION = "0.0.10"
+    VERSION = "0.0.11"
 
   end
 end

data/lib/jekyll-graph.rb

@@ -32,8 +32,13 @@ module Jekyll
       def generate(site)
         # check what's enabled
         return if $graph_conf.disabled?
+        # deprecated: 'net_web' -> 'web'
         if !$graph_conf.disabled_net_web? && !site.respond_to?(:link_index)
-          Jekyll.logger.error("Jekyll-Graph: To generate the net-web graph, please either add and enable the 'jekyll-wikilinks' plugin or disable the net-web in the jekyll-graph config")
+          Jekyll.logger.error("Jekyll-Graph: To generate the net-web graph, please either add and enable the 'jekyll-wikirefs' or 'jekyll-wikilinks' plugin or disable the net-web in the jekyll-graph config")
+          return
+        end
+        if !$graph_conf.disabled_web? && !site.respond_to?(:link_index)
+          Jekyll.logger.error("Jekyll-Graph: To generate the web graph, please either add and enable the 'jekyll-wikirefs' or 'jekyll-wikilinks' plugin or disable the web in the jekyll-graph config")
           return
         end
         if !$graph_conf.disabled_tree? && !site.respond_to?(:tree)
@@ -66,6 +71,17 @@ module Jekyll
           # create json file
           json_net_web_graph_file = self.new_page($graph_conf.path_assets, "graph-net-web.json", net_web_graph_content)
         end
+        if !$graph_conf.disabled_web?
+          # generate json data
+          json_web_nodes, json_web_links = self.generate_json_net_web()
+          self.set_neighbors(json_web_nodes, json_web_links)
+          web_graph_content = JSON.dump(
+            nodes: json_web_nodes,
+            links: json_web_links,
+          )
+          # create json file
+          json_web_graph_file = self.new_page($graph_conf.path_assets, "graph-web.json", web_graph_content)
+        end
         if !$graph_conf.disabled_tree?
           # generate json data
           json_tree_nodes, json_tree_links = self.generate_json_tree(@site.tree.root)
@@ -161,8 +177,13 @@ module Jekyll
 
       # json generation helpers
 
+      # deprecated: 'net_web' -> 'web'
       def generate_json_net_web()
-        net_web_nodes, net_web_links = [], []
+        return generate_json_web()
+      end
+
+      def generate_json_web()
+        web_nodes, web_links = [], []
 
         @md_docs.each do |doc|
           if !$graph_conf.excluded?(doc.type)
@@ -172,9 +193,9 @@ module Jekyll
             # missing nodes
             #
             @site.link_index.index[doc.url].missing.each do |missing_link_name|
-              if net_web_nodes.none? { |node| node[:id] == missing_link_name }
+              if web_nodes.none? { |node| node[:id] == missing_link_name }
                 Jekyll.logger.warn("Jekyll-Graph: Net-Web node missing: #{missing_link_name}, in: #{File.basename(doc.basename, File.extname(doc.basename))}")
-                net_web_nodes << {
+                web_nodes << {
                   id: missing_link_name, # an id is necessary for link targets
                   url: '',
                   label: missing_link_name,
@@ -183,7 +204,7 @@ module Jekyll
                     links: [],
                   },
                 }
-                net_web_links << {
+                web_links << {
                   source: doc.url,
                   target: missing_link_name,
                 }
@@ -192,7 +213,7 @@ module Jekyll
             #
             # existing nodes
             #
-            net_web_nodes << {
+            web_nodes << {
               # TODO: when using real ids, be sure to convert id to string (to_s)
               id: doc.url,
               url: relative_url(doc.url),
@@ -212,7 +233,7 @@ module Jekyll
                   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 << {
+                    web_links << {
                       source: doc.url,
                       target: linked_doc.first.url,
                     }
@@ -228,7 +249,7 @@ module Jekyll
                 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 << {
+                  web_links << {
                     source: doc.url,
                     target: linked_doc.first.url,
                   }
@@ -239,7 +260,7 @@ module Jekyll
           end
         end
 
-        return net_web_nodes, net_web_links
+        return web_nodes, web_links
       end
 
       # used for both plugins:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-graph
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll