ragerender 0.1.1

data/lib/ragerender/jekyll/chapter.rb

@@ -0,0 +1,132 @@
+require 'jekyll/generator'
+require 'jekyll/drops/document_drop'
+
+# Add default values for the 'unchapter' which is used to hold all comics that
+# don't have a chapter.
+Jekyll::Hooks.register :site, :after_init do |site|
+  site.config['defaults'].prepend({
+    'scope' => {
+      'path' => '_chapters/0.html',
+      'type' => 'chapters',
+    },
+    'values' => {
+      'title' => 'Unchaptered',
+      'description' => 'These comic pages are not part of any chapter',
+    },
+  })
+end
+
+Jekyll::Hooks.register :chapters, :pre_render do |chapter, payload|
+  payload.merge! RageRender::ChapterDrop.new(chapter).to_liquid
+  payload.merge! RageRender::ArchiveDrop.new(chapter).to_liquid
+end
+
+module RageRender
+  # Create chapter objects for any chapters listed in comics but that don't
+  # currently have an explicit page created.
+  class ChapterFromComicsGenerator < Jekyll::Generator
+    priority :high
+
+    def generate site
+      required = Set.new(site.collections['comics'].docs.map {|c| c.data['chapter'] }.reject(&:nil?))
+      existing = Set.new(site.collections['chapters'].docs.map {|c| c.data['slug'] })
+      missing = required - existing
+      missing.each do |slug|
+        filename = Pathname.new(site.collections['chapters'].relative_directory).join("#{slug}.html")
+        chapter = Jekyll::Document.new(filename.to_path, site: site, collection: site.collections['chapters'])
+        chapter.send(:merge_defaults)
+        chapter.data['slug'] ||= slug
+        chapter.data['title'] ||= slug
+        chapter.content = nil
+        site.collections['chapters'].docs << chapter
+      end
+    end
+  end
+
+  # Set the default cover for any chapters that don't have one to be the first
+  # page of the first comic in that chapter.
+  class DefaultCoverSetter < Jekyll::Generator
+    priority :lowest
+
+    def generate site
+      site.collections['chapters'].docs.each do |chapter|
+        chapter.data['image'] ||= default_cover(chapter)
+      end
+    end
+
+    def default_cover chapter
+      Pathname.new('/').join(first_comic(chapter).data['image']).to_path
+    end
+
+    def first_comic chapter
+      chapter.site.collections['comics'].docs.select {|c| c.data['chapter'] == chapter.data['slug'] }.first
+    end
+  end
+
+  # Values to pass to the archive layout when rendering a chapter.
+  class ChapterDrop < Jekyll::Drops::DocumentDrop
+    COVER_MAX_HEIGHT = 420
+    COVER_MAX_WIDTH = 300
+
+    PAGINATION_FIELDS = %w[ chaptername chapterdescription ]
+
+    delegate_method_as :data, :fallback_data
+    extend NamedDataDelegator
+    extend Forwardable
+
+    def_data_delegator :title, :chaptername
+    def_data_delegator :description, :chapterdescription
+    def_delegator :@obj, :url, :chapterarchiveurl
+
+    def cover
+      cover_obj.url
+    end
+
+    def cover_width_small
+      if (cover_height.to_f / COVER_MAX_HEIGHT) > (cover_width.to_f / COVER_MAX_WIDTH)
+        (cover_height_small * cover_width) / cover_height
+      else
+        [COVER_MAX_WIDTH, cover_width].min
+      end
+    end
+
+    def cover_height_small
+      if (cover_height.to_f / COVER_MAX_HEIGHT) > (cover_width.to_f / COVER_MAX_WIDTH)
+        [COVER_MAX_HEIGHT, cover_height].min
+      else
+        (cover_width_small * cover_height) / cover_width
+      end
+    end
+
+    def firstcomicinchapter
+      first_comic&.url
+    end
+
+    def to_liquid
+      super.reject do |k, v|
+        Jekyll::Drops::DocumentDrop::NESTED_OBJECT_FIELD_BLACKLIST.include? k
+      end.to_h
+    end
+
+    private
+    def cover_width
+      cover_obj.data['width'] ||= Dimensions.width cover_obj.path
+    end
+
+    def cover_height
+      cover_obj.data['height'] ||= Dimensions.height cover_obj.path
+    end
+
+    def cover_obj
+      @cover_obj ||= @obj.site.static_files.detect {|f| f.relative_path == cover_relative_path }
+    end
+
+    def cover_relative_path
+      Pathname.new('/').join(@obj.data['image']).to_s
+    end
+
+    def first_comic
+      @obj.site.collections['comics'].docs.select {|c| c.data['chapter'] == @obj.data['slug'] }.first
+    end
+  end
+end

data/lib/ragerender/jekyll/comics.rb

@@ -0,0 +1,230 @@
+require 'jekyll/generator'
+require 'jekyll/document'
+require 'jekyll/drops/document_drop'
+require_relative '../date_formats'
+require_relative 'named_data_delegator'
+
+Jekyll::Hooks.register :comics, :pre_render do |page, payload|
+  payload.merge! RageRender::ComicDrop.new(page).to_liquid
+end
+
+module RageRender
+  SPECIAL_COMIC_SLUGS = %w{frontpage index}
+
+  # Creates comics for each file found in the 'images' directory
+  # that does not already have an associated comic object.
+  class ComicFromImageGenerator < Jekyll::Generator
+    priority :highest
+
+    def generate site
+      images = site.static_files.select {|f| f.relative_path.start_with? '/images' }.map {|f| [f.basename, f] }.to_h
+      comics = site.collections['comics'].docs.map {|c| [c.basename_without_ext, c] }.to_h
+      missing = Set.new(images.keys) - Set.new(comics.keys)
+      missing -= Set.new(comics.map {|k, c| c.data['image'] }.reject(&:nil?).map {|img| File.basename(img, '.*') })
+      missing.each do |slug|
+        comic = Jekyll::Document.new(images[slug].relative_path, site: site, collection: site.collections['comics'])
+        comic.send(:merge_defaults)
+        comic.data['slug'] = slug
+        comic.data['title'] = slug
+        comic.data['date'] = images[slug].modified_time
+        comic.data['image'] = images[slug].relative_path
+        comic.content = nil
+        site.collections['comics'].docs << comic
+      end
+    end
+  end
+
+  # The index for the comics collection is always the latest comic.
+  class LatestComicGenerator < Jekyll::Generator
+    priority :lowest
+
+    def generate site
+      comics = site.collections['comics']
+      index = comics.docs.last.dup
+      index.instance_variable_set(:"@data", index.data.dup)
+      index.data['slug'] = 'index'
+      comics.docs << index
+    end
+  end
+
+  class DefaultImageSetter < Jekyll::Generator
+    priority :normal
+
+    def generate site
+      site.collections['comics'].docs.each do |comic|
+        comic.data['image'] ||= default_image_path(comic)
+      end
+    end
+
+    def default_image_path comic
+      "images/#{comic.data['slug']}.jpg"
+    end
+  end
+
+  # If the image for this comic was inside a subdirectory, set that subdirectory
+  # name to be the chapter slug for this comic, if one is not already set.
+  class ChapterFromDirectorySetter < Jekyll::Generator
+    priority :low
+
+    def generate site
+      site.collections['comics'].docs.each do |comic|
+        components = Pathname.new(comic.data['image']).descend.reduce([]) {|acc, path| acc << path.basename }
+        chapter_slug = components.drop_while {|path| path.root? || path.to_s == 'images' }[...-1].first
+        comic.data['chapter'] ||= chapter_slug.to_s unless chapter_slug.nil?
+      end
+    end
+  end
+
+  class ComicDrop < Jekyll::Drops::DocumentDrop
+    extend NamedDataDelegator
+
+    PAGINATION_FIELDS = %w[ comicurl comictitle posttime ]
+
+    delegate_method_as :id, :comicid
+    def_data_delegator :title, :comictitle
+    def_delegator :@obj, :url, :comicurl
+    data_delegator 'rating'
+    data_delegator 'votecount'
+
+    def posttime
+      comicfury_date(@obj.date)
+    end
+
+    def usechapters
+      all_comics.any? {|comic| comic.data.include? 'chapter' }
+    end
+
+    def haschapter
+      @obj.data.include? 'chapter'
+    end
+
+    def chaptername
+      chapter.data['title']
+    end
+
+    def chapterlink
+      chapter.url
+    end
+
+    def dropdown
+      all_comics.each_with_object([]) do |c, dropdown|
+        new_group = dropdown.last.nil? ? true : dropdown.last['grouplabel'] != c.data['chapter']
+        if new_group && !dropdown.last.nil? && dropdown.last['title'] == c.data['chapter']
+          dropdown.last['endgroup'] = true
+        end
+
+        in_this_chapter = @obj.data['chapter'] == c.data['chapter']
+        if in_this_chapter
+          dropdown << {
+            'is_selected' => @obj == c,
+            'is_disabled' => false,
+            'title' => c.data['title'],
+            'grouplabel' => c.data['chapter'],
+            'newgroup' => new_group,
+            'endgroup' => false,
+            'url' => c.url,
+          }
+        elsif new_group
+          dropdown << {
+            'is_selected' => false,
+            'is_disabled' => false,
+            'title' => c.data['chapter'],
+            'grouplabel' => c.data['chapter'],
+            'newgroup' => false,
+            'endgroup' => false,
+            'url' => c.url, # navigating to chapter just goes to first page
+          }
+        end
+      end
+    end
+
+    def authornotes
+      @obj.data['authornotes'] || [{
+        'is_reply' => false,
+        'comment' => @obj.content,
+        'isguest' => false,
+        'avatar' => nil,
+        'authorname' => @obj.data['author'],
+        'commentanchor' => "comment-#{@obj.date.strftime('%s')}",
+        'posttime' => comicfury_date(@obj.date),
+        'profilelink' => nil, # TODO
+      }]
+    end
+
+    def custom
+      @obj.data.fetch('custom', {}).reject do |k, v|
+        v.nil? || (v.respond_to?(:empty?) && v.empty?)
+      end
+    end
+
+    def isfirstcomic
+      all_comics.first == @obj
+    end
+
+    def islastcomic
+      all_comics.last == @obj
+    end
+
+    def prevcomic
+      @obj.previous_doc&.url
+    end
+
+    def nextcomic
+      @obj.next_doc&.url
+    end
+
+    def comicimageurl
+      File.join (@obj.site.baseurl || ''), image_relative_path
+    end
+
+    def comicwidth
+      image_obj.data['width'] ||= Dimensions.width image_path
+    end
+
+    def comicheight
+      image_obj.data['height'] ||= Dimensions.height image_path
+    end
+
+    # An HTML tag to print for the comic image. If there is a future image, then
+    # this is also a link to the next comic page.
+    def comicimage
+      linkopen = nextcomic ? <<~HTML : ''
+        <a href="#{nextcomic}">
+      HTML
+      image = <<~HTML
+        <img id="comicimage" src="#{comicimageurl}" width="#{comicwidth}" height="#{comicheight}">
+      HTML
+      linkclose = nextcomic ? <<~HTML : ''
+        </a>
+      HTML
+      [linkopen, image, linkclose].join
+    end
+
+    def to_liquid
+      super.reject do |k, v|
+        Jekyll::Drops::DocumentDrop::NESTED_OBJECT_FIELD_BLACKLIST.include? k
+      end.to_h
+    end
+
+    private
+    def all_comics
+      @obj.collection.docs.reject {|c| SPECIAL_COMIC_SLUGS.include? c.data['slug'] }
+    end
+
+    def chapter
+      @obj.site.collections['chapters'].docs.detect {|c| c.data['slug'] == @obj.data['chapter'] }
+    end
+
+    def image_obj
+      @image_obj ||= @obj.site.static_files.detect {|f| f.relative_path == image_relative_path }
+    end
+
+    def image_path
+      image_obj.path
+    end
+
+    def image_relative_path
+      Pathname.new('/').join(@obj.data['image']).to_s
+    end
+  end
+end

data/lib/ragerender/jekyll/error.rb

@@ -0,0 +1,18 @@
+require_relative 'named_data_delegator'
+
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  if page.data['layout'] == 'error-page'
+    payload.merge! RageRender::ErrorDrop.new(page).to_liquid
+  end
+end
+
+module RageRender
+  class ErrorDrop < Jekyll::Drops::Drop
+    private delegate_method_as :data, :fallback_data
+    extend NamedDataDelegator
+    extend Forwardable
+
+    def_data_delegator :title, :errortitle
+    def_delegator :@obj, :content, :errormessage
+  end
+end

data/lib/ragerender/jekyll/named_data_delegator.rb

@@ -0,0 +1,9 @@
+module RageRender
+  module NamedDataDelegator
+    def def_data_delegator key, aliaz
+      define_method(aliaz.to_sym) do
+        @obj.data[key.to_s]
+      end
+    end
+  end
+end

data/lib/ragerender/jekyll/overview.rb

@@ -0,0 +1,22 @@
+require 'jekyll/hooks'
+require 'jekyll/drops/drop'
+require_relative 'comics'
+require_relative 'blog_archive'
+
+# Pass the right variables to overview pages.
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  if page.data['layout'] == 'overview'
+    payload.merge! RageRender::ComicDrop.new(page.site.collections['comics'].docs.last).to_liquid
+    payload.merge! RageRender::OverviewDrop.new(page).to_liquid
+  end
+end
+
+module RageRender
+  class OverviewDrop < Jekyll::Drops::Drop
+    private delegate_method_as :data, :fallback_data
+
+    def latestblogs
+      @obj.site.posts.docs[-5..].map {|post| RageRender::PaginatedBlogDrop.new(post) }
+    end
+  end
+end

data/lib/ragerender/jekyll/pagination.rb

@@ -0,0 +1,29 @@
+module RageRender
+  def self.duplicate_page page
+    Jekyll::Page.new(
+      page.site,
+      page.instance_variable_get(:"@base"),
+      page.instance_variable_get(:"@dir"),
+      page.name,
+    )
+  end
+
+  module PaginationGenerator
+    def handle_page page
+    end
+
+    def generate site
+      archive = source_page site
+      archive.data['number'] = 1
+
+      num_pages(site).times.each do |number|
+        paged_archive = RageRender.duplicate_page archive
+        paged_archive.data['permalink'] = permalink.gsub(/:number/, (number + 1).to_s)
+        paged_archive.data['number'] = number + 1
+        Jekyll.logger.debug 'Paginating:', paged_archive.data['permalink']
+        site.pages << paged_archive
+        handle_page paged_archive
+      end
+    end
+  end
+end

data/lib/ragerender/jekyll/search.rb

@@ -0,0 +1,37 @@
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  if page.data['layout'] == 'search'
+    payload.merge! RageRender::SearchDrop.new(page).to_liquid
+  end
+end
+
+module RageRender
+  class SearchDrop < Jekyll::Drops::Drop
+    private delegate_method_as :data, :fallback_data
+    data_delegator 'searchterm'
+
+    def searched
+      !searchterm.nil?
+    end
+
+    def searchresults
+      return [] unless searched
+      @results ||= @obj.site.collections['comics'].docs.select do |comic|
+        [
+          *comic.data.fetch('tags', []),
+          comic.content,
+          *comic.data.fetch('authornotes', []).flat_map {|n| n['comment'] },
+        ].map(&:downcase).any? {|c| c.include?(searchterm.downcase) }
+      end.map.each_with_index do |comic, index|
+        drop = ComicDrop.new(comic)
+        {
+          'number' => index + 1,
+          **ComicDrop::PAGINATION_FIELDS.map {|f| [f.to_s, drop[f]] }.to_h,
+        }
+      end
+    end
+
+    def foundresults
+      searchresults.any?
+    end
+  end
+end

data/lib/ragerender/jekyll.rb

@@ -0,0 +1,185 @@
+require 'etc'
+require 'stringio'
+require 'jekyll'
+require 'dimensions'
+require_relative 'language'
+require_relative 'to_liquid'
+require_relative 'date_formats'
+require_relative 'jekyll/archive'
+require_relative 'jekyll/blog'
+require_relative 'jekyll/blog_archive'
+require_relative 'jekyll/comics'
+require_relative 'jekyll/chapter'
+require_relative 'jekyll/overview'
+require_relative 'jekyll/error'
+require_relative 'jekyll/search'
+require_relative 'jekyll/named_data_delegator'
+
+def setup_collection site, label, permalink, **kwargs
+  site.config['collections'][label.to_s] = {
+    'output' => true,
+    'permalink' => permalink,
+  }
+
+  site.config['defaults'].prepend({
+    'scope' => {
+      'path' => '',
+      'type' => label.to_s,
+    },
+    'values' => {
+      'permalink' => permalink,
+      **kwargs.map do |k, v|
+        [k.to_s, v]
+      end.to_h,
+    },
+  })
+end
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  # This is obviously quite naughty for many reasons,
+  # but it's the only way to get the theme selected
+  # without requiring the user to write a config file
+  site.config['theme'] ||= 'ragerender'
+  site.config['title'] ||= File.basename(site.source)
+  site.config['search'] ||= true
+  site.config = site.config
+
+  setup_collection site, :comics, '/:collection/:slug/', layout: 'comic-page', chapter: '0'
+  setup_collection site, :posts, '/blogarchive/:slug/', layout: 'blog-display'
+  setup_collection site, :chapters, '/archive/:slug/', layout: 'archive'
+
+  site.config['defaults'].push({
+    'scope' => {
+      'path' => '',
+    },
+    'values' => {
+      'author' => Etc.getlogin,
+    }
+  })
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  site.layouts.each do |(name, layout)|
+    layout.data['layout'] = 'overall' unless name == 'overall'
+    layout.content = RageRender.to_liquid(RageRender::Language.parse(StringIO.new(layout.content))).join
+  end
+end
+
+# The index for the site can be set by configuration
+class RageRender::FrontpageGenerator < Jekyll::Generator
+  priority :lowest
+
+  def generate site
+    comics = site.collections['comics']
+    frontpage = site.config.fetch('frontpage', 'latest')
+    index = case frontpage
+    when 'latest'
+      collection = site.collections['comics'].docs
+      comics.docs.last
+    when 'first'
+      collection = site.collections['comics'].docs
+      comics.docs.first
+    when 'chapter'
+      collection = site.collections['comics'].docs
+      chapter = comics.docs.last.data['chapter']
+      comics.docs.detect {|c| c.data['chapter'] == chapter }
+    when 'overview'
+      collection = site.pages
+      site.pages.detect {|p| p.data["permalink"] == '/overview/index.html' }
+    else
+      collection = site.pages
+      site.pages.detect {|p| p.data["slug"] == frontpage }
+    end.dup
+    index.instance_variable_set(:"@destination", {site.dest => File.join(site.dest, 'index.html')})
+    index.instance_variable_set(:"@data", index.data.dup)
+    index.data['slug'] = 'frontpage'
+    collection << index
+  end
+end
+
+Jekyll::Hooks.register :documents, :pre_render do |doc, payload|
+  payload.merge! RageRender::WebcomicDrop.new(doc).to_liquid
+end
+
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  payload.merge! RageRender::WebcomicDrop.new(page).to_liquid
+end
+
+class RageRender::WebcomicDrop < Jekyll::Drops::Drop
+  extend Forwardable
+  extend RageRender::NamedDataDelegator
+
+  def self.def_config_delegator source, target
+    define_method(target) { @obj.site.config[source.to_s] }
+  end
+
+  def_config_delegator :title, :webcomicname
+  def_config_delegator :description, :webcomicslogan
+  def_config_delegator :search, :searchon
+  %w{bannerads allowratings showpermalinks showcomments allowcomments}.each do |var|
+    def_config_delegator var, var
+  end
+
+  def webcomicurl
+    @obj.site.baseurl
+  end
+
+  def lastupdatedmy
+    Time.now.strftime('%d/%m/%Y')
+  end
+
+  def copyrights
+    @obj.site.config['copyrights'].gsub('[year]', Date.today.year.to_s)
+  end
+
+  def banner
+    Pathname.new(@obj.site.baseurl || '/').join(@obj.site.config['banner'] || '').to_path
+  end
+
+  def webcomicavatar
+    Pathname.new(@obj.site.baseurl || '/').join(@obj.site.config['webcomicavatar'] || '').to_path
+  end
+
+  def hasblogs
+    @obj.site.posts.docs.any?
+  end
+
+  def hidefromhost
+    false
+  end
+
+  def extrapages
+    @obj.site.pages.reject {|page| page.data['hidden'] }.map do |page|
+      {'link' => page.url, 'title' => page.data['title']}
+    end
+  end
+
+  def cfscriptcode
+    <<~HTML
+      <script type="text/javascript">
+        function jumpTo(place) { window.location = place; }
+      </script>
+    HTML
+  end
+
+  def css
+    css_files = @obj.site.static_files.select {|f| f.extname == '.css'}.map(&:path).to_a
+    css_files << Pathname.new(@obj.site.theme.includes_path).join('layout.css') unless css_files.any?
+    css_files.map {|f| File.read f }.join
+  end
+
+  delegate_method_as :url, :permalink
+  def_data_delegator :title, :pagetitle
+
+  def iscomicpage
+    @obj.type == :comics
+  end
+
+  def isextrapage
+    @obj.type == :pages && @obj.data['hidden'] != true
+  end
+
+  def fallback_data
+    {}
+  end
+end