vita 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ec3104878bed6bb49429fa0c92603a7620ec376351c446c293715f35ea0e5b
-  data.tar.gz: e81e41f8df895e5f62364df1a42bfc7d44faf40a41815676dd71cad0e38f8e72
+  metadata.gz: 1718643c6633bbe89990a662fd29739153a7233dd21352d8784b7af27a74383a
+  data.tar.gz: 89cf60afa27e2b06d8d43251c9ebe64f81a2f7b19ac8c3ecc154acd95af77943
 SHA512:
-  metadata.gz: 69a47a2d3dd45ac46ab4fe9d807f5b441e667499822c0ee2f61689a7dcafba664879659455bbaf46c0212fafb54cf0697ff5edbc44f2959964d984985c47b466
-  data.tar.gz: 1be52214d2daee544a50fecf7f68295efaf3fae9435a61c37524f66012d26092e6e4adcd0905e4c7610e15534d6d91bcd9ea0fa5bd5015f10408052d472b1b1c
+  metadata.gz: 18f962183bc9bf35ca240b8820ca882770b6edc3b82d0a183f3adf6553044c207ec3705dc2f6098e2113618ac9258c0d6e39c8356fd4d383989cf8cb0aed3303
+  data.tar.gz: e129b89cc3194e9eca15fdb1e14a786150df89a53c278fef0f250e0449d520e09f2dad7a2913158bc532736fad5d8f4b24d0bfd24dcd85d6986a7e9e46280cdd

data/README.md

@@ -33,6 +33,8 @@ __   _(_) |_ __ _
 Starting Vita at http://localhost:9000
 ```
 
+Your web browser refreshes as you make changes to your files.
+
 To publish:
 
 ```
@@ -43,17 +45,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 viewing a note, links in the note's content are hyperlinked:
+
+<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%">
+
+A list of links from other notes to the current note follows the note's content:
+
+<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%">
 
-When a note's content includes the title of another note, Vita creates a link between the two notes.
+Each link includes an excerpt from the other note. Clicking one of these links navigates to the other note.
 
-Links are clickable. Wherever a note's title appears in another note's content, clicking on it navigates to that note:
+## Synonyms
 
-<img src="doc/outlinks.png" alt="Screenshot of a note in Vita, showing hyperlinks from a note's content to other notes">
+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.
 
-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:
+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.
 
-<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">
+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

@@ -15,7 +15,11 @@ module Vita
         raise Vita::Error.new("Directory not found at #{root}")
       end
 
-      Dir[File.join(root, "*.*")].map { |filename| Note.new(filename) }
+      Dir[note_filename_pattern(root)].map { |filename| Note.new(filename) }
+    end
+
+    def self.note_filename_pattern(root)
+      File.join(root, "*.*")
     end
 
     def initialize(root, notes)
@@ -56,11 +60,17 @@ module Vita
       links.filter { |link| link.to_note == note }
     end
 
+    def note_filename_pattern
+      self.class.note_filename_pattern(root)
+    end
+
     private
 
     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/server.rb

@@ -1,7 +1,10 @@
 require "sinatra"
+require "sinatra/streaming"
 
 module Vita
   class Server < Sinatra::Base
+    helpers Sinatra::Streaming
+
     def self.await_startup
       sleep 0.1 until settings.running?
     end
@@ -25,6 +28,14 @@ module Vita
       end
     end
 
+    get "/events", provides: "text/event-stream" do
+      stream do |out|
+        Watcher.new(garden).watch do
+          out << "event: change\ndata: {}\n\n"
+        end
+      end
+    end
+
     get "/:path.html" do |path|
       note = garden.note_at_path("#{path}.html")
 

data/lib/vita/version.rb

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

data/lib/vita/watcher.rb

@@ -0,0 +1,13 @@
+require "filewatcher"
+
+module Vita
+  class Watcher
+    def initialize(garden)
+      @garden = garden
+    end
+
+    def watch(&)
+      Filewatcher.new(@garden.note_filename_pattern).watch(&)
+    end
+  end
+end

data/lib/vita.rb

@@ -9,6 +9,7 @@ require "vita/note"
 require "vita/renderer"
 require "vita/rendering_context"
 require "vita/version"
+require "vita/watcher"
 
 module Vita
   BASE_DIRECTORY = File.expand_path("..", __dir__)

data/templates/note.html.erb

@@ -16,6 +16,7 @@
         <script defer src="https://unpkg.com/htmx.org@1.9.10"></script>
     </head>
     <body>
+        <div hx-trigger="sse:change" hx-get="/<%= h note.path %>" hx-target="body">
         <nav class="navbar bg-body-tertiary mb-3">
             <div class="container">
                 <a class="navbar-brand" href="/">
@@ -70,10 +71,14 @@
                 </div>
             </div>
         </div>
+        </div>
         <script defer>
          if (location.protocol !== "file:") {
              document.body.setAttribute('hx-boost', true);
          }
+         if (location.port === "9000") {
+             document.body.setAttribute('hx-sse', 'connect:/events');
+         }
         </script>
     </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vita
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alec Cursley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rackup
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.34.0
+        version: 1.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.34.0
+        version: 1.35.1
 description:
 email:
 - alec@cursley.net
@@ -210,6 +238,7 @@ files:
 - lib/vita/rendering_context.rb
 - lib/vita/server.rb
 - lib/vita/version.rb
+- lib/vita/watcher.rb
 - templates/note.html.erb
 homepage: https://github.com/cursley/vita
 licenses: