vita 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ec3104878bed6bb49429fa0c92603a7620ec376351c446c293715f35ea0e5b
-  data.tar.gz: e81e41f8df895e5f62364df1a42bfc7d44faf40a41815676dd71cad0e38f8e72
+  metadata.gz: 86ecbe16917de241d894f019175d823a4e06606cee81f5d20534210e159ac814
+  data.tar.gz: f497eab7e3b8e2cd4828a9a39f16e792653f2583c4fa4e3b21b6fc6cdb75e806
 SHA512:
-  metadata.gz: 69a47a2d3dd45ac46ab4fe9d807f5b441e667499822c0ee2f61689a7dcafba664879659455bbaf46c0212fafb54cf0697ff5edbc44f2959964d984985c47b466
-  data.tar.gz: 1be52214d2daee544a50fecf7f68295efaf3fae9435a61c37524f66012d26092e6e4adcd0905e4c7610e15534d6d91bcd9ea0fa5bd5015f10408052d472b1b1c
+  metadata.gz: 73a39e21fdfe22f0b143b387e8ed06edc534ed8cd46e519f70a395b7307bc354304780111d05ee9753986393521d6f6202eeb687c99c83d770bebd623a79ffe7
+  data.tar.gz: 5fea8bdbc8437cb18639f6f4bc5f88205ecac87621a75e57245097c95ff8000c41eabd65424ee6660c4cebb59b50a021781b2c9dfd6993d29d077dc9c1a0b4ab

data/README.md

@@ -43,17 +43,31 @@ Vita creates a `publish` folder containing HTML files for publishing to a web se
 
 ## Links between notes
 
-Vita looks for connections between notes.
+Vita looks for connections between notes. When a note's title (or a [synonym](#synonyms)) appears in the content of another note, Vita creates a link between the two.
 
-When a note's content includes the title of another note, Vita creates a link between the two notes.
+When viewing a note, links in the note's content are hyperlinked:
 
-Links are clickable. Wherever a note's title appears in another note's content, clicking on it navigates to that note:
+<img src="doc/outlinks.png" alt="Screenshot of a note in Vita, showing hyperlinks from a note's content to other notes" style="width: 75%">
 
-<img src="doc/outlinks.png" alt="Screenshot of a note in Vita, showing hyperlinks from a note's content to other notes">
+A list of links from other notes to the current note follows the note's content:
 
-Each note lists the other notes that link to it, along with an excerpt from the source note. Clicking on any of these navigates to the source note:
+<img src="doc/backlinks.png" alt="Screenshot of the &quot;links to this note&quot; panel in Vita, showing notes that reference the current note" style="width: 75%">
 
-<img src="doc/backlinks.png" alt="Screenshot of the &quot;links to this note&quot; panel in Vita, showing notes that reference the currently-displayed note">
+Each link includes an excerpt from the other note. Clicking one of these links navigates to the other note.
+
+## Synonyms
+
+Synonyms allow referring to notes using multiple names. Adding synonyms can be helpful when a note's title appears in other notes in different forms or tenses.
+
+For example, notes may refer to a note titled "Cohesion" using terms like "cohesive", "coherent", or "coherence". Adding these words as synonyms to the "Cohesion" note allows Vita to connect the notes with links.
+
+To specify a note's synonyms, add a `Synonyms:` line at the start of the file containing a comma-separated list of alternative names. For example, in a file called `Cohesion.txt`:
+
+```
+Synonyms: cohesive, coherent, coherence
+
+A module is cohesive if the elements in the module are related and the module is coherent as a whole.
+```
 
 ## Home note
 

data/lib/vita/garden.rb

@@ -60,7 +60,9 @@ module Vita
 
     def notes=(notes)
       @notes = notes.map { |note| GardenNote.new(self, note) }.sort_by(&:title)
-      @notes_hash = @notes.map { |note| [note.title.downcase, note] }.to_h
+      @notes_hash = @notes.flat_map { |note|
+        note.all_names.map { |name| [name.downcase, note] }
+      }.to_h
 
       if home_note
         @notes.delete(home_note)

data/lib/vita/garden_note.rb

@@ -12,12 +12,30 @@ module Vita
       @note = note
     end
 
+    # Get this note's primary title.
     def title
       @note.title
     end
 
-    def title_regexp
-      /\b#{Regexp.quote(title)}\b/i
+    # Get alternative names for this note.
+    def synonyms
+      if @note.content.start_with? "Synonyms:"
+        @note.content[9..@note.content.index("\n")].split(",").map(&:strip)
+      else
+        []
+      end
+    end
+
+    # Get all names for this note, including its title and synonyms.
+    def all_names
+      [title, *synonyms]
+    end
+
+    # Get a regular expression that matches any of this note's names surrounded
+    # by word boundaries.
+    def names_regexp
+      elements = all_names.map { |name| /#{Regexp.quote(name)}/i }
+      /\b#{Regexp.union(elements)}\b/
     end
 
     def path
@@ -29,7 +47,11 @@ module Vita
     end
 
     def content
-      @note.content
+      if @note.content.start_with? "Synonyms:"
+        @note.content[@note.content.index("\n") + 1..]
+      else
+        @note.content
+      end
     end
 
     def html
@@ -62,7 +84,7 @@ module Vita
 
     def create_outlinks
       notes = garden.linkable_notes - [self]
-      regexp = Regexp.union(notes.map(&:title_regexp))
+      regexp = Regexp.union(notes.map(&:names_regexp))
       matches = NoteScanner.new(content).scan(regexp)
 
       matches.map do |match|

data/lib/vita/version.rb

@@ -1,3 +1,3 @@
 module Vita
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vita
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alec Cursley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet