jekyll-rpg 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1683b40039a1a2bf8df03320da5e0a029c09dc3788fac0352ca84d9835e8b418
-  data.tar.gz: 0f775d00db33397e481c7ba0188629bc6b41284f044c4056633b1e696fbd730b
+  metadata.gz: 4dbaff86bfac3c1c821e36321851b94f3cc5e7dfa293543dc49809dfa3f331b1
+  data.tar.gz: e45e59b1260ae0b3f7c853e1780e436d123df64e604fdefbeac1f75bd1b036d1
 SHA512:
-  metadata.gz: b3d036cfbc7b228dd6ceebff00d3b2e58da286208a2b79a08f7868f84d68b63258e8dc242a5023415f1cbed4f8c6ab35277f0fb9a13b59f7e442714db04b62c5
-  data.tar.gz: 87d5348c1d576dbdf8458db8c1d91b602f078620d88824cb7a826ec6f1b763b992ffe04dfb1a2852219bbbe51182926cd01023867744071aabdd812b140f6775
+  metadata.gz: cf357ffe093de9d47beb3f7d9eb26ebe555c6ae312e10d54f397b81e7c6b0628cb083ef8f5f97bee46997970380531eb1ba7ae5c64411cd8b64cbd9d478f0442
+  data.tar.gz: 645a38316b3b70083c0783c2591f9565fbeca5c81fee926ceba3cbb6c3d6d785a595de74b2a0e74eb5155d62fc9eb50a5a519f303ec2e353435782d2d2c529b7

data/lib/collection_page.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module JekyllRPG
+  # Represents a document that may be in a Jekyll collection
   class CollectionPage
     attr_accessor :name, :collection, :slug, :written
 

data/lib/jekyll-rpg.rb

@@ -3,12 +3,13 @@
 require 'jekyll'
 require_relative 'references'
 
+# Generates reference information for Jekyll Site
 module JekyllRPG
   # Bi-directional page links
   Jekyll::Hooks.register :site, :post_read do |site|
     ref = References.new(site)
 
-    site.data['graph'] = ref.graph
+    site.data['graph'] = ref.hashed_graph
 
     site.data['broken_links'] = ref.broken_links
   end

data/lib/references.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'collection_page'
+require 'pry'
 
 module JekyllRPG
+  # References within Jekyll Collections
   class References
     attr_accessor :collection_keys, :broken_links, :graph
 
@@ -15,7 +17,7 @@ module JekyllRPG
       # Parse references from markdown links
       @collection_keys.each do |collection|
         @site.collections[collection].docs.each do |doc|
-          if doc.data['dm'] && !@site.data['dm_mode']
+          if doc.data['dm'] && !@site.config['dm_mode']
             doc.data['published'] = false
           else
             referent = CollectionPage.new(
@@ -33,18 +35,18 @@ module JekyllRPG
 
       # For each collection page, add where it is referenced
       @collection_keys.each do |collection|
-        site.collections[collection].docs.each do |doc|
+        @site.collections[collection].docs.each do |doc|
           page_refs = {}
 
           # Get the information for every page the current doc is referenced in
           # And push links to an array that represents the collections of those pages
-          referenced_in(collection, doc.data['slug'] ).each do |reference|
+          referenced_in(collection, doc.data['slug']).each do |reference|
             page_refs[reference.collection] = [] unless page_refs.key?(reference.collection)
             page_refs[reference.collection].push(reference.markdown_link)
           end
 
           # Make sure links in collections are unique
-          page_refs.each do |k,v|
+          page_refs.each do |k, v|
             page_refs[k] = v.uniq
           end
 
@@ -58,41 +60,36 @@ module JekyllRPG
         end
       end
 
-      #print broken_links
-
       # Create list of broken links
       unwritten_pages.each do |edge|
-        @broken_links.push({
-          'reference_name' => edge['reference'].name,
-          'reference_collection' => edge['reference'].collection,
-          'reference_slug' => edge['reference'].slug,
-          'reference_link' => edge['reference'].markdown_link,
-          'referent_name' => edge['referent'].name,
-          'referent_collection' => edge['referent'].collection,
-          'referent_slug' => edge['referent'].slug,
-          'referent_link' => edge['referent'].markdown_link,
-        })
+        @broken_links.push(edge_hash(edge))
       end
     end
 
+    # Find all markdown links in document
+    # TODO - fails to find markdown link at very start of doc
+    # due to not finding any character that isn't an exclamation mark
     def markdown_links(doc)
       doc.to_s.scan(%r{(?<=[^!])\[.*?\]\(/.*?/.*?\)})
     end
 
     # returns link text, collection and slug
-    # [0](/1/2)
+    # [0](/1/2) - as a [0, 1, 2]
     def link_components(link)
-      [link[%r{(?<=\[).*?(?=\])}], link[%r{(?<=/).*(?=/)}], link[%r{(?<=/)(?:(?!/).)*?(?=\))}]]
+      [link[/(?<=\[).*?(?=\])/], link[%r{(?<=/).*(?=/)}], link[%r{(?<=/)(?:(?!/).)*?(?=\))}]]
     end
 
+    # Find a document based on its collection and slug
     def find_page(collection, slug)
       @site.collections[collection].docs.find { |doc| doc.data['slug'] == slug }
     end
 
+    # Returns true if document cannot be found in collection
     def page_missing(collection, slug)
       @site.collections[collection].nil? || find_page(collection, slug).nil?
     end
 
+    # Returns a hash of two CollectionPages representing a graph edge
     def edge(referent, reference)
       referenced_name, referenced_collection, referenced_slug = link_components(reference)
       if page_missing(referenced_collection, referenced_slug)
@@ -113,18 +110,22 @@ module JekyllRPG
       }
     end
 
+    # Based on the graph, returns edges that a specific document is the referent of
     def referenced_in(collection, slug)
-      @graph.select {
-        |edge| edge['reference'].collection == collection && edge['reference'].slug == slug
-      }.map { |edge| edge['referent'] }
+      @graph.select do |edge|
+        edge['reference'].collection == collection && edge['reference'].slug == slug
+      end.map { |edge| edge['referent'] }
     end
 
+    # Based on the graph, returns documents that are referenced, but do not exist yet
     def unwritten_pages
-      @graph.select {
-        |edge| !edge['reference'].written
-      }
+      @graph.reject do |edge|
+        edge['reference'].written
+      end
     end
 
+    # Determines if refs table is required based on document,
+    # then collection, then site
     def refs_table_required(doc)
       if doc.data.key?('refs')
         doc.data['refs']
@@ -135,6 +136,29 @@ module JekyllRPG
       end
     end
 
+    # Returns an easily accessible hash representing an edge for Jekyll purposes
+    def edge_hash(edge)
+      {
+        'reference_name' => edge['reference'].name,
+        'reference_collection' => edge['reference'].collection,
+        'reference_slug' => edge['reference'].slug,
+        'reference_link' => edge['reference'].markdown_link,
+        'referent_name' => edge['referent'].name,
+        'referent_collection' => edge['referent'].collection,
+        'referent_slug' => edge['referent'].slug,
+        'referent_link' => edge['referent'].markdown_link
+      }
+    end
+
+    # Returns a graph made up of hashed edges
+    def hashed_graph
+      @graph.map { |edge| edge_hash(edge) }
+    end
+
+    # The following three functions return a HTML table
+    # That for a specific document shows the documents that
+    # reference it
+
     def refs_table(refs)
       table = <<~TABLE
         # Referenced By:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rpg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tom Lockwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email: tom@lockwood.dev
 executables: []