jekyll-rpg 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16f14fd9c3d40e94808552f1b4a38813cb1f75e97a50ab5f69acbd57026dadb2
-  data.tar.gz: 770ce2e9837de58c045cf32a2b20272f65b237420f3c733ade1081d6aee6d7b4
+  metadata.gz: c75f941d938f99bcb95405f25776adc34ceba10009d7183eec136145f3eba72b
+  data.tar.gz: 0050b660cb0c708f39e1cc723f65456d6c4e7010b1e0950503aab8ed95250496
 SHA512:
-  metadata.gz: 3e0dd4929f15a759ead437924a0ed5efc49e336a1cdb14474b5b008e060af0300f693c8280e8e7e9f921c8a40eaad10070b7acac786cbcadc0bc5a86ba198018
-  data.tar.gz: 620e850bb614a48458c7b78326af3d3a45f47c620b597d8a4aef217f9ded8106a2be791cb7278224f0f35d892f79c7b72b0fce1a279fa6fefebdeefcbd8f8aad
+  metadata.gz: fe0a31e5458c3744523ca3ddfa188f703b64c056539abecff50bb0971a4c0f1e7e9f42a78822229138d715f58bae51bbe4338841e6712387842628533f996f3c
+  data.tar.gz: b8777aa50b266366be65540da516a90043feeaabda8321e5d4bd751e2550ec3ca2a623bc7343222d76006c8b7f12c51b64782181240db3444f7c70d617f4cc18

data/lib/collection_document.rb

@@ -1,36 +1,44 @@
 # frozen_string_literal: true
 
 module JekyllRPG
-  # Represents a document that may be in a Jekyll collection
+  # Represents a document that may be in a Jekyll collection,
+  # extracted from either a document itself, or a markdown
+  # link.
   class CollectionDocument
-    attr_accessor :name, :collection, :slug, :written
+    attr_accessor :name, :collection, :slug, :viewable
 
     def extract_doc(doc)
       @name = doc.data['name']
       @collection = doc.collection.label
       @slug = doc.data['slug']
-      @written = true
+      @viewable = true
       self
     end
 
     # extracts link text, collection and slug
-    # [@name](/@collection/@slug)
     def extract_markdown(site, link)
-      @collection = link[%r{(?<=/).*(?=/)}]
-      @slug = link[%r{(?<=/)(?:(?!/).)*?(?=\))}]
-      @written = document_exists(site)
-      @name = @written ? find_document(site).data['name'] : link[/(?<=\[).*?(?=\])/]
+      @site = site
+      @collection = link.collection
+      @slug = link.slug
+      @viewable = viewable
+      @name = @viewable ? find_document.data['name'] : link.name
       self
     end
 
     # Checks whether document exists in a site
-    def document_exists(site)
-      !site.collections[@collection].nil? && !find_document(site).nil?
+    def document_exists
+      !@site.collections[@collection].nil? && !find_document.nil?
     end
 
     # Find a document based on its collection and slug
-    def find_document(site)
-      site.collections[@collection].docs.find { |doc| doc.data['slug'] == @slug }
+    def find_document
+      @site.collections[@collection].docs.find { |doc| doc.data['slug'] == @slug }
+    end
+
+    def viewable
+      return unless document_exists
+
+      @site.config['dm_mode'] || !find_document.data['dm']
     end
 
     def markdown_link

data/lib/graph.rb

@@ -35,9 +35,9 @@ module JekyllRPG
     end
 
     # Based on the graph, returns documents that are referenced, but do not exist yet
-    def unwritten
+    def unviewable
       @edges.reject do |edge|
-        edge.reference.written
+        edge.reference.viewable
       end
     end
 

data/lib/jekyll-rpg.rb

@@ -10,7 +10,22 @@ module JekyllRPG
     ref = References.new(site)
 
     site.data['graph'] = ref.graph.hash
-
     site.data['broken_links'] = ref.broken_links
   end
+
+  # DM tag to hide content
+  class RenderDMContent < Liquid::Block
+    def render(context)
+      text = ''
+      if context.registers[:site].config['dm_mode']
+        text += "> # DM Note: \n"
+        super.each_line do |line|
+          text += '>> ' + line
+        end
+      end
+      text
+    end
+  end
 end
+
+Liquid::Template.register_tag('dm', JekyllRPG::RenderDMContent)

data/lib/markdown_link.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module JekyllRPG
+  # A markdown link with components extracted from text
+  # [name](/collection/slug)
+  class MarkdownLink
+    def initialize(link)
+      @link = link
+    end
+
+    def name
+      @link[/(?<=\[).*?(?=\])/]
+    end
+
+    def slug
+      @link[%r{(?<=/)(?:(?!/).)*?(?=\))}]
+    end
+
+    def collection
+      @link[%r{(?<=/).*(?=/)}]
+    end
+  end
+end

data/lib/reference_table.rb

@@ -24,7 +24,7 @@ module JekyllRPG
 
     def refs_table(refs)
       table = <<~TABLE
-        # Referenced By:
+        \n# Referenced By:
         <table>
           <thead>
             <tr>

data/lib/references.rb

@@ -3,6 +3,7 @@
 require 'collection_document'
 require 'edge'
 require 'graph'
+require 'markdown_link'
 require 'reference_table'
 
 module JekyllRPG
@@ -12,6 +13,7 @@ module JekyllRPG
 
     def initialize(site)
       @site = site
+      @dm_mode = @site.config['dm_mode']
       @graph = Graph.new
       @broken_links = []
       @collection_keys = @site.collections.keys - ['posts']
@@ -20,7 +22,7 @@ module JekyllRPG
       referent_pass
 
       # Create list of broken links
-      @graph.unwritten.each do |edge|
+      @graph.unviewable.each do |edge|
         @broken_links.push(edge.hash)
       end
     end
@@ -31,14 +33,31 @@ module JekyllRPG
       collection_documents.each do |doc|
         # Do not publish or reference a page if the site is not in DM Mode
         # And the page is marked as for dms
-        if doc.data['dm'] && !@site.config['dm_mode']
+        doc_dm = doc.data['dm']
+        if doc_dm && !@dm_mode
           doc.data['published'] = false
         else
+          unviewable_links = []
+          # Extract details of the referent from the document
           referent = CollectionDocument.new.extract_doc(doc)
+
+          # make a reference from each link on the page
           markdown_links(doc).each do |link|
-            reference = CollectionDocument.new.extract_markdown(@site, link)
+            md_link = MarkdownLink.new(link)
+            reference = CollectionDocument.new.extract_markdown(@site, md_link)
+
+            # if the reference isn't viewable in the current configuration
+            # append that link to the array of links to strikethrough
+            unviewable_links << reference.markdown_link unless reference.viewable
+
+            # Make a new edge on the graph
             @graph.edges.push(Edge.new(referent, reference))
           end
+
+          # Unviewable links are struck through
+          unviewable_links.uniq.each do |link|
+            doc.content = doc.content.sub! link, "~~#{link}~~"
+          end
         end
       end
     end

metadata

@@ -1,71 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rpg
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Tom Lockwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.6
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.6
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
 description: ''
 email: tom@lockwood.dev
 executables: []
@@ -76,6 +82,7 @@ files:
 - lib/edge.rb
 - lib/graph.rb
 - lib/jekyll-rpg.rb
+- lib/markdown_link.rb
 - lib/reference_table.rb
 - lib/references.rb
 homepage: https://github.com/tomlockwood/jekyll-rpg