jekyll-activitypub-static 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be774c7c697b0956a7a038e106e7f814d367c57eae4549fe5ba95d6103310c3f
-  data.tar.gz: f21b6ae140379d76aa89392c366b98948e3167f896e82722c71ad623ba9978da
+  metadata.gz: b1c1766dd68f2800d25fc7df592437c35feea85078a1854844da1c9bcf002b64
+  data.tar.gz: 52d1e9fb21652a79c4a64cd443cb07d93b1134a68915aad2ec42b2c589940ccc
 SHA512:
-  metadata.gz: 2fc3c85e7ae70b2fd9b700e95141412cd09883c15661f47662e237af65322c42450a64c8629015d86b1d79c41de4685365e75a313dd93e14f23f1dbbbeef628e
-  data.tar.gz: 4bd2f60d33815a5c3e0e0c89917e74825eb2b32c57a98e2d073acf74ef83291e7285ff36460a7f5fee335ca9837fcd878cb0cf928e8a4f67c058ac57d516d305
+  metadata.gz: e38b2f34411400d648d35436f2ac8b89d9392c3b6ff46461919fde42a5748b5b0ed0a893dd950a82183ed6f74df2b7f7a36ed7e488d38ac37bc59f476509cca7
+  data.tar.gz: 506f812d26892654489b856ef34fa913c63f99e779a81ffa57f9d2e2061ab9409c7062e26ad123257626926999f6b710c4c7d747ad890d4e68c867071e86e268

data/README.md

@@ -1,6 +1,6 @@
 # jekyll-activitypub-static
 
-This is a plugin for Jekyll to generate a static ActivityPoll feed, the read-only polling subset of ActivityPub defined by FEP-b06c.
+A Jekyll plugin that generates a static ActivityPoll feed, the read-only polling subset of ActivityPub defined by FEP-b06c.
 
 ## Install
 
@@ -8,7 +8,7 @@ To build from source:
 
 ```bash
 gem build jekyll-activitypub-static.gemspec
-gem install ./jekyll-activitypub-static-0.7.1.gem
+gem install ./jekyll-activitypub-static-0.7.3.gem
 ```
 
 ## Usage

data/lib/jekyll/activitypub_static/generator.rb

@@ -4,6 +4,24 @@ require "uri"
 
 module Jekyll
   module ActivityPubStatic
+    class JsonStaticFile < Jekyll::StaticFile
+      def initialize(site, dir, name, content)
+        super(site, site.source, dir, name)
+        @content = content
+      end
+
+      def modified?
+        true
+      end
+
+      def write(dest)
+        dest_path = destination(dest)
+        FileUtils.mkdir_p(File.dirname(dest_path))
+        File.write(dest_path, JSON.pretty_generate(@content))
+        true
+      end
+    end
+
     class Generator < Jekyll::Generator
       safe true
       priority :low
@@ -37,17 +55,16 @@ module Jekyll
           ]
         }
 
-        path = File.join(site.dest, ".well-known", "webfinger")
-        FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, JSON.pretty_generate(webfinger))
+        sf = JsonStaticFile.new(site, ".well-known", "webfinger", webfinger)
+        site.static_files << sf
+
+        Jekyll.logger.info LOG_TAG, "Added webfinger as #{sf.path}"
       end
 
       def generate_actor(site)
         Jekyll.logger.info LOG_TAG, "Generating actor.jsonld"
         actor = build_actor(site)
-        path = File.join(site.dest, "actor.jsonld")
-        FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, JSON.pretty_generate(actor))
+        site.static_files << JsonStaticFile.new(site, "", "actor.jsonld", actor)
       end
 
       def generate_inbox(site)
@@ -69,21 +86,18 @@ module Jekyll
           "totalItems": 0,
           "orderedItems": []
         }
-        path = File.join(site.dest, output_path, "inbox.jsonld")
-        FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, JSON.pretty_generate(inbox))
+
+        site.static_files << JsonStaticFile.new(site, output_path, "inbox.jsonld", inbox)
       end
 
       def generate_articles(site)
         url = site.config["url"]
         output_path = site.config.dig("activitypub", "output_path") || "activitypub"
-        output_dir = File.join(site.dest, output_path, "posts")
-        FileUtils.mkdir_p(output_dir)
+        output_dir = File.join(output_path, "posts")
 
         site.posts.docs.each do |post|
           slug = post.basename_without_ext.sub(/^\d{4}-\d{2}-\d{2}-/, "")
           filename = "#{slug}.jsonld"
-          path = File.join(output_dir, filename)
 
           article_id = "#{url}/#{output_path}/posts/#{slug}.jsonld"
 
@@ -98,16 +112,14 @@ module Jekyll
             "to" => "as:Public"
           }
 
-          File.write(path, JSON.pretty_generate(article))
-          Jekyll.logger.info LOG_TAG, "Wrote article to #{path}"
+          site.static_files << JsonStaticFile.new(site, output_dir, filename, article)
         end
       end
 
       def generate_activities(site)
         url = site.config["url"]
         output_path = site.config.dig("activitypub", "output_path") || "activitypub"
-        output_dir = File.join(site.dest, output_path, "activities")
-        FileUtils.mkdir_p(output_dir)
+        output_dir = File.join(output_path, "activities")
 
         site.posts.docs.each do |post|
           slug = post.basename_without_ext.sub(/^\d{4}-\d{2}-\d{2}-/, "")
@@ -132,7 +144,7 @@ module Jekyll
             "to" => "as:Public"
           }
 
-          File.write(path, JSON.pretty_generate(activity))
+          site.static_files << JsonStaticFile.new(site, output_dir, filename, activity)
           Jekyll.logger.info LOG_TAG, "Wrote activity to #{path}"
         end
       end
@@ -140,7 +152,7 @@ module Jekyll
       def generate_outbox_pages(site)
         url = site.config["url"]
         output_path = site.config.dig("activitypub", "output_path") || "activitypub"
-        output_dir = File.join(site.dest, output_path, "outbox")
+        output_dir = File.join(output_path, "outbox")
 
         page_number = 1
         page = build_page(site, page_number)
@@ -152,9 +164,7 @@ module Jekyll
           activity_id = "#{url}/#{output_path}/activities/create-#{slug}.jsonld"
 
           if page["orderedItems"].length >= PAGE_SIZE
-            path = File.join(output_dir, "page-#{page_number}.jsonld")
-            FileUtils.mkdir_p(File.dirname(path))
-            File.write(path, JSON.pretty_generate(page))
+            site.static_files << JsonStaticFile.new(site, output_dir, "page-#{page_number}.jsonld", page)
             page_number += 1
             page = build_page(site, page_number)
           end
@@ -175,8 +185,9 @@ module Jekyll
 
         if page["orderedItems"].any?
           path = File.join(output_dir, "page-#{page_number}.jsonld")
-          FileUtils.mkdir_p(File.dirname(path))
-          File.write(path, JSON.pretty_generate(page))
+
+          site.static_files << JsonStaticFile.new(site, output_dir, "page-#{page_number}.jsonld", page)
+          Jekyll.logger.info LOG_TAG, "Wrote outbox page #{page_number} to #{path}"
         end
       end
 
@@ -203,9 +214,8 @@ module Jekyll
           "first": ("#{url}/#{output_path}/outbox/page-#{page_count}.jsonld" if total_items > 0)
         }
 
-        path = File.join(site.dest, output_path, "outbox.jsonld")
-        FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, JSON.pretty_generate(outbox))
+        site.static_files << JsonStaticFile.new(site, output_path, "outbox.jsonld", outbox)
+        Jekyll.logger.info LOG_TAG, "Wrote outbox to #{File.join(site.dest, output_path, "outbox.jsonld")}"
       end
 
       def build_actor(site)

data/lib/jekyll/activitypub_static/version.rb

@@ -1,6 +1,6 @@
 # lib/jekyll/activitypub_static/version.rb
 module Jekyll
   module ActivityPubStatic
-    VERSION = "0.7.1"
+    VERSION = "0.7.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-activitypub-static
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Evan Prodromou
@@ -37,8 +37,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.65'
-description: A Jekyll plugin that outputs JSON-LD ActivityPoll content for posts,
-  feeds, and actors.
+description: A Jekyll plugin that generates a static ActivityPub feed with ActivityPoll,
+  from FEP-b06c.
 email:
 - evanp@socialwebfoundation.org
 executables: []
@@ -70,5 +70,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Generate a static ActivityPoll feed from your Jekyll site.
+summary: A Jekyll plugin that generates a static ActivityPub feed
 test_files: []