ragerender 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 670837503b9bdfb7e314412c2ad7f3fbed616035c83e231e94afbc1a8461ae7d
+  data.tar.gz: 4642302a27d7a2433267abca12fda09703a5b583593501279f87196f0885aa28
+SHA512:
+  metadata.gz: 6dcfa8001b76f24b00360b52da55889307e2ada02b93b5fe9f1dfa8561b28f3c2cf6939a477977f27c356c43a1e7a596ba7d5007f371a689b9b17b2ccb29e7d1
+  data.tar.gz: 687ccd2273c923d13178dce12e9de7afba951e6bcabe576c9c1fe67e6a2a21b987b99dda8a73bd95897ca930cd05b96e7029af377e48e7387e6fd3f1847892e4

data/README.rdoc

@@ -0,0 +1,221 @@
+= RageRender
+
+A template parser and site generator that can render a webcomic site using
+ComicFury templates, using the Jekyll static site generator.
+
+== What's this?
+
+{ComicFury}[https://comicfury.com] is an excellent no-bullshit webcomic hosting
+site created and maintained by the legend Kyo. You should support them on
+{Patreon}[https://www.patreon.com/comicfury]!
+
+{Jekyll}[https://jekyllrb.com] is a highly regarded and widespread static site
+generator. It builds simple slowly-changing content into HTML files using
+templates.
+
+RageRender allows you to use your ComicFury templates to generate a static
+version of your webcomic site using Jekyll. You just supply your templates,
+comics and blogs, and RageRender will output a site that mimics your ComicFury
+site.
+
+Well, I say "mimics". Output is a static site, which means all of the
+interactive elements of ComicFury don't work. This includes comments,
+subscriptions, search, and comic management.
+
+=== But why?!
+
+RageRender allows those of us who work on making changes to ComicFury site
+templates to test our changes before we put them live.
+
+With RageRender, you can edit your CSS, HTML templates and site settings before
+you upload them to ComicFury. This makes the process of testing changes quicker
+and makes it much more likely that you catch mistakes before any comic readers
+have a chance to see them.
+
+RageRender doesn't compete with the most excellent ComicFury (who's Patreon you
+should contribute to, as I do!) – you should continue to use ComicFury for all
+your day-to-day artistic rage management needs. But if you find yourself making
+changes to a site design, RageRender may be able to help you.
+
+== Getting started
+
+First, you need to have {Ruby}[https://www.ruby-lang.org/] and
+{Bundler}[https://bundle.io/] installed. The Jekyll site has {good guides on how
+to do that}[https://jekyllrb.com/docs/installation/] depending on your operating
+system.
+
+To set up a new site, open a terminal and type:
+
+  mkdir mycomic && cd mycomic
+  bundle init
+  bundle add jekyll
+  bundle add ragerender
+
+Now you can add comics! Add the image into an <tt>images</tt> folder:
+
+  mkdir images
+  cp 'cool comic.jpg' 'images/My first page.jpg'
+
+The file name of the image will be the title of your comic page. And that's it,
+you added your first comic!
+
+If you want to add an author note, create a text file in a folder called
+<tt>_comics</tt> that has the same file name, but with a <tt>.md</tt> extension:
+
+  mkdir _comics
+  echo "Check out my cool comic y'all!" > '_comics/My first page.md'
+
+Generate the site using:
+
+  bundle exec jekyll build
+
+Or start a local website to see it in your browser:
+
+  bundle exec jekyll serve
+  # Now visit http://localhost:4000!
+
+=== Customising your site
+
+You'll notice a few things that might be off about your site, including that the
+webcomic title and author name are probably not what you were expecting.
+
+You can create a configuration file to tell RageRender the important details.
+Put something like this in your webcomic folder and call it
+<tt>_config.yml</tt>:
+
+  title: "My awesome webcomic!"
+  slogan: "It's the best!"
+  description: >
+    My epic story about how him and her
+    fell into a romantic polycule with they and them
+
+  defaults:
+  - scope:
+      path: ''
+    values:
+      author: "John smith"
+
+  theme: ragerender
+
+Your webcomic now has its basic information set up.
+
+=== Adding your layouts
+
+RageRender will use a ComicFury default layout if you don't supply your own
+files.
+
+If you want to keep using the "simple" layout, you can add the details into your
+<tt>_config.yml</tt> too:
+
+  layout:
+
+If you want to use your own layout code, then create a <tt>_layouts</tt>
+directory and put the contents of each of your ComicFury layout tabs in there,
+and then put your CSS in the main folder. You should end up with a full set of
+files like:
+
+  _layouts
+    archive.html
+    blog-archive.html
+    blog-display.html
+    comic-page.html
+    error-page.html
+    overall.html
+    overview.html
+    search.html
+  layout.css
+
+Now when you build your site, your custom templates and styles will be used
+instead.
+
+=== Adding blogs
+
+Add your blogs into a folder called `_posts`:
+
+  cat _posts/2025-05-29-my-new-comic.md
+  Hey guys, welcome to my new comic! It's gonna be so sick!
+
+Note that the name of your blog post has to include the date and the title, or
+it'll be ignored.
+
+=== Customising comics and blogs
+
+You can add {Front Matter}[https://jekyllrb.com/docs/front-matter/] to set the
+details of your author notes and blogs manually:
+
+  ---
+  title: "spooky comic page"
+  date: "2025-03-05 16:20"
+  image: "images/ghost.png"
+  author: "Jane doe"
+  custom:
+    # use yes and no for tickbox settings
+    spooky: yes
+    # use text in quotes for short texts
+    mantra: "live long and prosper"
+    # use indented text for long texts
+    haiku: >
+      Testing webcomics
+      Now easier than ever
+      Thanks to RageRender
+  comments:
+    - author: "Skippy"
+      date: "13 Mar 2025, 3.45 PM"
+      comment: "Wow this is so sick!"
+  ---
+  Your author note still goes at the end, like this!
+
+=== Adding extra pages
+
+You can add extra pages just by adding new HTML files to your webcomic folder.
+The name of the file becomes the URL that it will use.
+
+Pages by default won't be embedded into your 'Overall' layout. You can change
+that and more with optional Front Matter:
+
+  ---
+  # Include this line to set the page title
+  title: "Bonus content"
+  # Include this line to hide the page from the navigation menu
+  hidden: yes
+  # Include this line to embed this page in the overall layout
+  layout: Overall
+  ---
+  <h1>yo check out my bonus content!</h1>
+
+=== Stuff that doesn't work
+
+Here is a probably incomplete list of things you can expect to be different
+about your local site compared to ComicFury:
+
+- Any comments you specify in Front Matter will be present, but you can't add
+  new ones
+- Search doesn't do anything at all
+- Saving and loading your place in the comic isn't implemented
+- GET and POST variables in templates are ignored and will always be blank
+- Random numbers in templates will be random only once per site build, not once
+  per page call
+
+== Without Jekyll
+
+RageRender can also be used without Jekyll to turn ComicFury templates into
+templates in other languages.
+
+E.g:
+
+  gem install ragerender
+  echo "[c:iscomicpage]<div>[f:js|v:comictitle]</div>[/]" > template.html
+  ruby $(gem which ragerender/to_liquid) template.html
+  # {% if iscomicpage   %}<div>{{ comictitle | escape }}</div>{% endif %}
+  ruby $(gem which ragerender/to_erb) template.html
+  # <% if  iscomicpage   %><div><%= js(comictitle) %></div><% end %>
+
+You still need to pass the correct variables to these templates; browse {this
+unofficial documentation}[https://github.com/heyeinin/comicfury-documentation]
+or RageRender::ComicDrop etc. to see which variables work on which templates.
+
+== Get help
+
+That's not a proclamation but an invitation! Reach out if you're having trouble
+by {raising an issue}[https://github.com/simonwo/ragerender/issues] or posting
+in the ComicFury forums.

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test

data/assets/404.html

@@ -0,0 +1,7 @@
+---
+title: No such page
+layout: error-page
+hidden: true
+permalink: "/404.html"
+---
+The page you were trying to access does not exist on this webcomic.

data/assets/archive-comics.html

@@ -0,0 +1,7 @@
+---
+title: Archive
+layout: archive
+hidden: true
+permalink: "/archive/comics/index.html"
+mode: comics
+---

data/assets/archive.html

@@ -0,0 +1,6 @@
+---
+title: Archive
+layout: archive
+hidden: true
+permalink: "/archive/index.html"
+---

data/assets/blog.html

@@ -0,0 +1,6 @@
+---
+title: Blog
+layout: blog-archive
+permalink: "/blog/"
+hidden: true
+---

data/assets/overview.html

@@ -0,0 +1,6 @@
+---
+title: Overview
+layout: overview
+hidden: true
+permalink: "/overview/index.html"
+---

data/assets/search.html

@@ -0,0 +1,6 @@
+---
+title: Search
+layout: search
+hidden: true
+permalink: '/search/'
+---

data/lib/ragerender/date_formats.rb

@@ -0,0 +1,6 @@
+# E.g. 20th Nov 2024, 2:35 PM
+SUFFIXES = {1 => 'st', 2 => 'nd', 3 => 'rd'}
+def comicfury_date time
+  fmt = "%-d#{SUFFIXES.fetch(time.day, 'th')} %b %Y, %-I:%M %p"
+  time.strftime(fmt)
+end

data/lib/ragerender/jekyll/archive.rb

@@ -0,0 +1,147 @@
+require 'jekyll/generator'
+require 'jekyll/drops/drop'
+require_relative 'comics'
+require_relative 'pagination'
+require_relative 'named_data_delegator'
+
+# Pass the right variables to archive pages. Note that this doesn't apply to
+# chapter pages because they are not "pages"
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  if page.data['layout'] == 'archive'
+    payload.merge! RageRender::ArchiveDrop.new(page).to_liquid
+  end
+end
+
+module RageRender
+  COMICS_PER_PAGE = 160
+
+  # Sets the main archive page at '/archive' to be either the chapter index if
+  # chapters are enabled or the comics list if there are no chapters.
+  class MainArchivePageGenerator < Jekyll::Generator
+    def generate site
+      archive = site.pages.detect {|page| page.data['layout'] == 'archive' && !page.data.include?('mode') }
+      archive.data['mode'] = unless site.collections['comics'].docs.any? {|c| c.data.include? 'chapter' }
+        'comics'
+      end
+    end
+  end
+
+  # A simple list of all the comics exists under '/archive/comics',
+  # with one page per 160 comics.
+  class ComicArchivePaginator < Jekyll::Generator
+    include PaginationGenerator
+
+    def source_page site
+      site.pages.detect {|page| page.data['layout'] == 'archive' && page.data['mode'] == 'comics' }
+    end
+
+    def num_pages site
+      site.collections['comics'].docs.each_slice(COMICS_PER_PAGE).size
+    end
+
+    def permalink
+      '/archive/comics/page/:number/index.html'
+    end
+  end
+
+  # Now there is also one page per chapter... but also the chapter pages are
+  # paginated if there are more than 160 comics per chapter. So we have to
+  # handle that pagination manually by calling another paginator for each page
+  # we generate here.
+  class ChapterArchiveGenerator < Jekyll::Generator
+    priority :high
+
+    def generate site
+      site.collections['chapters'].docs.each do |page|
+        page.data['mode'] = 'chapters'
+        ChapterArchivePaginator.new(page).generate(site)
+      end
+    end
+  end
+
+  # Note that this one doesn't descend from Jekyll::Generator, because we don't
+  # want it to be invoked automatically, only when we create a chapter page.
+  class ChapterArchivePaginator
+    include PaginationGenerator
+
+    def initialize chapter
+      @page = chapter
+    end
+
+    def source_page site
+      @page
+    end
+
+    def num_pages site
+      site.collections['comics'].docs.select do |c|
+        c.data['chapter'] == @page.data['slug']
+      end.each_slice(COMICS_PER_PAGE).size
+    end
+
+    def permalink
+      Pathname.new(@page.permalink).join('../').join('page/:number/index.html').to_path
+    end
+  end
+
+  # A Drop that provides all of the page variables for the archive pages.
+  class ArchiveDrop < Jekyll::Drops::Drop
+    private delegate_method_as :data, :fallback_data
+    extend NamedDataDelegator
+
+    def ischapterarchive
+      @obj.type == :chapters
+    end
+
+    def show_comic_list
+      ischapterarchive || @obj.data['mode'] == 'comics'
+    end
+
+    def show_chapter_overview
+      !show_comic_list
+    end
+
+    def chapters
+      unless show_chapter_overview
+        @obj.site.collections['chapters'].docs.map do |page|
+          ChapterDrop.new(page).to_liquid
+        end
+      end
+    end
+
+    def comics_paginated
+      number = @obj.data['number']
+      comics = if number
+        selected_comics.to_a[number - 1]
+      else
+        selected_comics.to_a.flatten
+      end.group_by {|c| c.data['chapter'] }
+
+      comics.map do |chapter, comics|
+        chapter_data = ChapterDrop.new(@obj.site.collections['chapters'].docs.detect {|c| c.data['slug'] == chapter })
+        comics.each_with_index.map do |comic, index|
+          drop = ComicDrop.new(comic)
+          {
+            **ComicDrop::PAGINATION_FIELDS.map {|field| [field, drop[field]] }.to_h,
+            **ChapterDrop::PAGINATION_FIELDS.map {|field| [field, chapter_data[field]] }.to_h,
+            'number' => index + 1,
+            'newchapter' => index == 0,
+            'chapterend' => index == comics.size - 1,
+          }
+        end
+      end.flatten
+    end
+
+    def lastpagenumber
+      selected_comics.size
+    end
+
+    private
+    def selected_comics
+      comics = @obj.site.collections['comics'].docs.reject {|c| SPECIAL_COMIC_SLUGS.include? c.data['slug'] }
+      if @obj.type == :chapters
+        comics = comics.select {|c| c.data['chapter'] == @obj.data['slug'] }
+      end
+      comics.each_slice(COMICS_PER_PAGE)
+    end
+  end
+end

data/lib/ragerender/jekyll/blog.rb

@@ -0,0 +1,37 @@
+require 'jekyll/hooks'
+require 'jekyll/drops/document_drop'
+require_relative '../date_formats'
+require_relative 'named_data_delegator'
+
+Jekyll::Hooks.register :posts, :pre_render do |post, payload|
+  payload.merge! RageRender::BlogDrop.new(post).to_liquid
+end
+
+module RageRender
+  class BlogDrop < Jekyll::Drops::DocumentDrop
+    private delegate_method_as :data, :fallback_data
+    extend NamedDataDelegator
+
+    def_data_delegator :title, :blogtitle
+    def_data_delegator :author, :authorname
+    delegate_method_as :content, :blog
+
+    def posttime
+      comicfury_date @obj.date
+    end
+
+    def prevbloglink
+      @obj.previous_doc&.url
+    end
+
+    def nextbloglink
+      @obj.next_doc&.url
+    end
+
+    def to_liquid
+      super.reject do |k, v|
+        Jekyll::Drops::DocumentDrop::NESTED_OBJECT_FIELD_BLACKLIST.include? k
+      end.to_h
+    end
+  end
+end

data/lib/ragerender/jekyll/blog_archive.rb

@@ -0,0 +1,115 @@
+require 'jekyll/generator'
+require 'jekyll/drops/drop'
+require 'jekyll/drops/document_drop'
+require_relative '../date_formats'
+require_relative 'pagination'
+require_relative 'named_data_delegator'
+
+# Pass the right variables to blog archive pages.
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  if page.data['layout'] == 'blog-archive'
+    payload.merge! RageRender::BlogArchiveDrop.new(page).to_liquid
+  end
+end
+
+module RageRender
+  BLOGS_PER_PAGE = 15
+
+  # Creates each page of the blog archive by copying the root blog page and
+  # updating the page number. Blog archive pages are available under both
+  # '/blog' and '/blogarchive'.
+  class PaginatedBlogsGenerator < Jekyll::Generator
+    include PaginationGenerator
+
+    def source_page site
+      site.pages.detect {|page| page['layout'] == 'blog-archive' }
+    end
+
+    def num_pages site
+      site.posts.docs.each_slice(BLOGS_PER_PAGE).size
+    end
+
+    def permalink
+      '/blog/page/:number/index.html'
+    end
+  end
+
+  # As above.
+  class PaginatedBlogArchiveGenerator < Jekyll::Generator
+    include PaginationGenerator
+
+    def source_page site
+      site.pages.detect {|page| page['layout'] == 'blog-archive' }
+    end
+
+    def num_pages site
+      site.posts.docs.each_slice(BLOGS_PER_PAGE).size
+    end
+
+    def permalink
+      '/blogarchive/page/:number/index.html'
+    end
+  end
+
+  # Data to pass to a blog archive page.
+  class BlogArchiveDrop < Jekyll::Drops::Drop
+    private delegate_method_as :data, :fallback_data
+    data_delegator 'number'
+
+    def blogs_paginated
+      all_blogs[number-1]&.map {|blog| PaginatedBlogDrop.new(blog).to_liquid } || []
+    end
+
+    def lastpagenumber
+      all_blogs.size
+    end
+
+    # Objects used for laying out page numbers.
+    #
+    # The page numbers always include:
+    # - the first page
+    # - the last page
+    # - two pages around the current page
+    def pages
+      [1].chain([1, all_blogs.size, *(number-2..number+2).to_a].uniq).select {|i| i >= 1 && i <= all_blogs.size }.sort.each_cons(2).map do |prev, page|
+        {
+          'page' => page,
+          'pagelink' => File.join(@obj.url, 'page', page.to_s),
+          'is_current' => page == number,
+          'skipped_ahead' => page - prev > 1,
+        }
+      end
+    end
+
+    private
+    def all_blogs
+      @all_blogs = @obj.site.posts.docs.each_slice(BLOGS_PER_PAGE).to_a
+    end
+  end
+
+  # Data representing a single paginated blog entry, as available from
+  # [l:blogs_paginated].
+  class PaginatedBlogDrop < Jekyll::Drops::DocumentDrop
+    extend NamedDataDelegator
+
+    def_data_delegator :title, :blogtitle
+    def_delegator :@obj, :url, :bloglink
+    def_data_delegator :author, :authorname
+    def_delegator :@obj, :content, :blog
+    # TODO profilelink
+
+    private delegate_method_as :data, :fallback_data
+
+    def posttime
+      comicfury_date(@obj.date)
+    end
+
+    def allowcomments
+      @obj.site.config['allowcomments']
+    end
+
+    def comments
+      (@obj.data['comments'] || []).size
+    end
+  end
+end