ragerender 0.1.7 → 0.1.9

data/lib/ragerender/jekyll/comics.rb

@@ -7,8 +7,15 @@ require 'jekyll/document'
 require 'jekyll/drops/drop'
 require 'jekyll/drops/document_drop'
 require_relative '../date_formats'
+require_relative 'chapter'
+require_relative 'image'
+require_relative 'setup_collection'
 require_relative 'pipettes'
 
+Jekyll::Hooks.register :site, :after_init do |site|
+  setup_collection site, :comics, '/:collection/:slug/', layout: 'comic-page', chapter: '0'
+end
+
 Jekyll::Hooks.register :comics, :pre_render do |page, payload|
   RageRender::Pipettes.clean_payload payload
   payload.merge! RageRender::ComicDrop.new(page).to_liquid
@@ -19,16 +26,40 @@ module RageRender
 
   BASE_DIR = File.join(File.dirname(__FILE__), '..', '..', '..')
 
+  # If there are any HTML pages in the /images directory, we treat these as
+  # HTML-comics where the author has specified their own HTML to use instead of
+  # a comic image. We turn these into static files so that they don't appear as
+  # extra pages.
+  class ComicHTMLToStaticFileGenerator < Jekyll::Generator
+    priority :highest
+
+    def generate site
+      site.pages.select {|f| f.relative_path.start_with? 'images' }.each do |html|
+        site.pages.delete html
+        static_file = Jekyll::StaticFile.new(
+          site,
+          html.instance_variable_get(:"@base"),
+          # Jekyll::Pages have their leading slash removed, but we need it
+          html.instance_variable_get(:"@dir").gsub(/^([^\/])/) {|s| '/' + s},
+          html.instance_variable_get(:"@name"),
+        )
+        static_file.data['content'] = html.content
+        static_file.defaults['published'] = false
+        site.static_files.append static_file
+      end
+    end
+  end
+
   # 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
+    priority :high
 
     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 -= Set.new(comics.flat_map {|k, c| (c.data['images'] || []) + [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)
@@ -65,12 +96,16 @@ module RageRender
 
     def generate site
       site.collections['comics'].docs.each do |comic|
-        comic.data['image'] ||= default_image_path(comic)
+        comic.data['image'] ||= default_image_path(site, comic)
       end
     end
 
-    def default_image_path comic
-      "images/#{comic.data['slug']}.jpg"
+    def images site
+      @images ||= site.static_files.select {|f| f.relative_path.start_with? '/images' }.map {|f| [f.basename, f] }.to_h
+    end
+
+    def default_image_path site, comic
+      images(site)[comic.data['slug']].relative_path
     end
   end
 
@@ -88,27 +123,99 @@ module RageRender
     end
   end
 
-  class ComicDrop < Jekyll::Drops::DocumentDrop
+  class PaginatedComicDrop < Jekyll::Drops::DocumentDrop
     extend Pipettes
 
-    PAGINATION_FIELDS = %w[ comicurl comictitle posttime ]
+    THUMBNAIL_MAX_HEIGHT = 420
+    THUMBNAIL_MAX_WIDTH = 400
+    THUMBNAIL_SMALL_MAX_HEIGHT = 210
+    THUMBNAIL_SMALL_MAX_WIDTH = 200
+
+    def initialize obj, all
+      super(obj)
+      @all = all
+    end
+
+    def_delegators :comicdrop, :comicurl, :comictitle, :posttime
+    def_safe_delegator :chapterdrop, :chaptername, :chaptername
+    def_safe_delegator :chapterdrop, :chapterdescription, :chapterdescription
+    def_safe_delegator :chapterdrop, :chapterid, :chapterid
+
+    def number
+      @all.index(@obj) + 1
+    end
+
+    def newchapter
+      @all.select {|c| c.data['chapter'] == @obj.data['chapter'] }.first == @obj
+    end
+
+    def chapterend
+      @all.select {|c| c.data['chapter'] == @obj.data['chapter'] }.last == @obj
+    end
+
+    def_delegator :comicdrop, :comicimageurl, :thumbnail_url
+
+    def thumbnail_width
+      scaled_width(comicdrop.comicwidth, comicdrop.comicheight, THUMBNAIL_MAX_WIDTH, THUMBNAIL_MAX_HEIGHT) || 0
+    end
+
+    def thumbnail_height
+      scaled_height(comicdrop.comicwidth, comicdrop.comicheight, THUMBNAIL_MAX_WIDTH, THUMBNAIL_MAX_HEIGHT) || 0
+    end
+
+    def thumbnail_width_small
+      scaled_width(comicdrop.comicwidth, comicdrop.comicheight, THUMBNAIL_SMALL_MAX_WIDTH, THUMBNAIL_SMALL_MAX_HEIGHT) || 0
+    end
+
+    def thumbnail_height_small
+      scaled_height(comicdrop.comicwidth, comicdrop.comicheight, THUMBNAIL_SMALL_MAX_WIDTH, THUMBNAIL_SMALL_MAX_HEIGHT) || 0
+    end
+
+    private
+    def comicdrop
+      @comicdrop ||= ComicDrop.new(@obj)
+    end
+
+    def chapterdrop
+      comicdrop.send(:chapterdrop)
+    end
+
+    def index
+      @index ||= chapterdrop.send(:comics).index(@obj)
+    end
+  end
+
+  class ComicDrop < Jekyll::Drops::DocumentDrop
+    extend Pipettes
 
     delegate_method_as :id, :comicid
     def_delegator :@obj, :url, :comicurl
-    def_delegator :@obj, :url, :permalink
     data_delegator 'rating'
     data_delegator 'votecount'
 
+    def permalink
+      URI.join(@obj.site.config["url"], @obj.site.baseurl || '/', @obj.url).to_s
+    end
+    data_delegator 'comments'
+
     def comictitle
       escape @obj.data['title']
     end
 
-    def comicnumber
-      1 + all_comics.index(@obj)
+    def comicdescription
+      escape @obj.data['description']
     end
 
-    def comicsnum
-      all_comics.size
+    def transcript
+      escape @obj.data['transcript']
+    end
+
+    def comickeywords
+      (@obj.data['keywords'] || []).map {|k| escape k }.join(', ')
+    end
+
+    def comicnumber
+      1 + all_comics.index(@obj)
     end
 
     def posttime
@@ -123,20 +230,24 @@ module RageRender
       @obj.date.month
     end
 
-    def usechapters
-      all_comics.any? {|comic| comic.data.include? 'chapter' }
-    end
-
     def haschapter
       @obj.data.include? 'chapter'
     end
 
-    def chaptername
-      escape(chapter.data['title']) rescue nil
+    def_safe_delegator :chapterdrop, :chapterid, :chapterid
+    def_safe_delegator :chapterdrop, :chaptername, :chaptername
+    def_safe_delegator :chapterdrop, :chapterdescription, :chapterdescription
+    def_safe_delegator :chapter, :url, :chapterlink
+
+    def_safe_delegator :prevchapterdrop, :url, :prevchapter
+    def_safe_delegator :nextchapterdrop, :url, :nextchapter
+
+    def isfirstcomicinchapter
+      (chapterdrop&.send(:comics) || []).first == @obj
     end
 
-    def chapterlink
-      chapter&.url
+    def islastcomicinchapter
+      (chapterdrop&.send(:comics) || []).last == @obj
     end
 
     def_loop :dropdown, :is_selected, :is_disabled, :title, :grouplabel, :newgroup, :endgroup, :url
@@ -204,41 +315,67 @@ module RageRender
       all_comics.last == @obj
     end
 
-    def prevcomic
-      @obj.previous_doc&.url
+    def_safe_delegator :prevcomicdrop, :url, :prevcomic
+    def_safe_delegator :prevcomicdrop, :permalink, :prevcomicpermalink
+    def_safe_delegator :prevcomicdrop, :title, :prevcomictitle
+
+    def_safe_delegator :nextcomicdrop, :url, :nextcomic
+    def_safe_delegator :nextcomicdrop, :permalink, :nextcomicpermalink
+    def_safe_delegator :nextcomicdrop, :title, :nextcomictitle
+
+    def prevcomicbychapter
+      if isfirstcomicinchapter
+        (prevchapterdrop&.send(:comics) || []).last
+      else
+        (chapterdrop&.send(:comics) || []).each_cons(2).detect {|_, this| this == @obj }&.first
+      end&.url
+    end
+
+    def nextcomicbychapter
+      if islastcomicinchapter
+        nextchapterdrop&.send(:first_comic)
+      else
+        (chapterdrop&.send(:comics) || []).each_cons(2).detect {|this, _| this == @obj }&.last
+      end&.url
     end
 
-    def prevcomicpermalink
-      unless @obj.previous_doc.nil?
-        URI.join(@obj.site.config["url"], @obj.site.baseurl || '/', @obj.previous_doc&.url).to_s
+    def comicimagetype
+      if imagedrops.size > 1
+        'multiimage'
+      elsif imagedrop.send(:image_obj).extname == '.html'
+        'html'
+      else
+        'image'
       end
     end
 
-    def nextcomic
-      @obj.next_doc&.url
+    def isimage
+      comicimagetype == 'image'
     end
 
-    def nextcomicpermalink
-      unless @obj.next_doc.nil?
-        URI.join(@obj.site.config["url"], @obj.site.baseurl || '/', @obj.next_doc&.url).to_s
-      end
+    def_loop :comicparts, *(RageRender::ImageDrop.invokable_methods - Jekyll::Drops::DocumentDrop.invokable_methods)
+    def comicparts
+      imagedrops.map(&:to_liquid)
     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
+      if comicimagetype == 'multiimage'
+        <<~HTML
+          <div class="comicsegments">
+            #{imagedrops.map(&:html).join}
+          </div>
+        HTML
+      else
+        imagedrop.html
+      end
     end
 
+    def_safe_delegator :imagedrop, :imageurl, :comicimageurl
+    def_safe_delegator :imagedrop, :width, :comicwidth, default=0
+    def_safe_delegator :imagedrop, :height, :comicheight, default=0
+
     def keys
       super.reject {|k| private_methods.include? k.to_sym }
     end
@@ -258,13 +395,40 @@ module RageRender
       @obj.site.collections['chapters'].docs.detect {|c| c.data['slug'] == @obj.data['chapter'] }
     end
 
+    def nextcomicdrop
+      @obj.next_doc.nil? ? nil : ComicDrop.new(@obj.next_doc)
+    end
+
+    def prevcomicdrop
+      @obj.previous_doc.nil? ? nil : ComicDrop.new(@obj.previous_doc)
+    end
+
+    def chapterdrop
+      chapter.nil? ? nil : ChapterDrop.new(chapter)
+    end
+
+    def prevchapterdrop
+      chapter&.previous_doc.nil? ? nil : ChapterDrop.new(chapter.previous_doc)
+    end
+
+    def nextchapterdrop
+      chapter&.next_doc.nil? ? nil : ChapterDrop.new(chapter.next_doc)
+    end
+
+    data_delegator 'images'
     data_delegator 'image'
-    def_image_metadata :image
-    private :image, :image_url, :image_width, :image_height
 
-    public
-    alias comicimageurl image_url
-    alias comicwidth image_width
-    alias comicheight image_height
+    def imagedrops
+      paths = (images || []) + [image]
+      paths.reject(&:nil?).map do |image|
+        relative_path = Pathname.new('/').join(image).to_path
+        obj = @obj.site.static_files.detect {|f| f.relative_path == relative_path }
+        (paths.size > 1 ? MultiImageDrop : ImageDrop).new(obj, self)
+      end
+    end
+
+    def imagedrop
+      imagedrops.first
+    end
   end
 end

data/lib/ragerender/jekyll/image.rb

@@ -0,0 +1,78 @@
+require 'forwardable'
+require 'jekyll/drops/drop'
+require_relative 'pipettes'
+
+module RageRender
+  class ImageDrop < Jekyll::Drops::Drop
+    extend Forwardable
+    extend Pipettes
+
+    def initialize(obj, comicdrop)
+      super(obj)
+      @comic = comicdrop
+      @image_obj = obj
+    end
+
+    # an <img> tag containing the image, without surrounding link
+    def imageonlyhtml
+      filehtml || <<~HTML
+        <img id="comicimage" src="#{imageurl}" alt="#{comictitle}"
+             width="#{width}" height="#{height}"
+             title="#{comicdescription}">
+      HTML
+    end
+
+    # the html contents of this loop iteration. this includes stuff like a
+    # surrounding link to the next page
+    def html
+      filehtml || [
+        nextcomic ? "<a href=\"#{nextcomic}\">" : '',
+        imageonlyhtml,
+        nextcomic ? '</a>' : '',
+      ].join
+    end
+
+    private
+    def image
+      @obj.relative_path
+    end
+
+    def filehtml
+      image_obj.data['content']
+    end
+
+    def_delegators :@comic, :nextcomic, :comictitle, :comicdescription
+    private :nextcomic, :comictitle, :comicdescription
+
+    def_image_metadata :image
+    private :image_url, :image_width, :image_height
+
+    def imageurl
+      image_url unless filehtml
+    end
+
+    alias width image_width
+    alias height image_height
+    public :imageurl, :width, :height
+
+    def fallback_data; {}; end
+  end
+
+  class MultiImageDrop < ImageDrop
+    def imageonlyhtml
+      <<~HTML
+        <img src="#{imageurl}" alt="#{comictitle}"
+             width="#{width}" height="#{height}"
+             title="#{comicdescription}" class="comicsegmentimage">
+      HTML
+    end
+
+    def html
+      <<~HTML
+        <div class="segmentcontainer">
+          #{super}
+        </div>
+      HTML
+    end
+  end
+end

data/lib/ragerender/jekyll/pagination.rb

@@ -1,3 +1,5 @@
+require_relative 'pipettes'
+
 module RageRender
   module PaginationGenerator
     def handle_page page
@@ -27,4 +29,30 @@ module RageRender
       end
     end
   end
+
+  class PaginatedPageDrop < Jekyll::Drops::Drop
+    extend Pipettes
+
+    def initialize obj, current_page, prev_page
+      super(obj)
+      @current = current_page
+      @prev = prev_page
+    end
+
+    def page
+      @obj.data['number']
+    end
+
+    def pagelink
+      @obj.permalink
+    end
+
+    def is_current
+      page == @current.data['number']
+    end
+
+    def skipped_ahead
+      page - @prev.data['number'] > 1
+    end
+  end
 end

data/lib/ragerender/jekyll/pipettes.rb

@@ -1,6 +1,7 @@
 # Pipettes help you make drops.
 require 'cgi'
 require 'dimensions'
+require 'jekyll/drops/document_drop'
 
 module RageRender
   module Pipettes
@@ -11,6 +12,16 @@ module RageRender
       payload.send(:fallback_data).delete_if {|k| methods.include? k}
     end
 
+    def own_methods
+      invokable_methods - Jekyll::Drops::DocumentDrop.invokable_methods
+    end
+
+    def def_safe_delegator obj, key, aliaz, default=nil
+      define_method(aliaz.to_sym) do
+        send(obj.to_sym)&.send(key.to_sym) || default
+      end
+    end
+
     def def_data_delegator key, aliaz
       define_method(aliaz.to_sym) do
         @obj.data[key.to_s]
@@ -35,6 +46,28 @@ module RageRender
         Pathname.new(@obj.path).extname != '.html' ?  escape(str) : str
       end
       mod.send(:private, :maybe_escape)
+
+      mod.define_method(:scaled_width) do |width, height, max_width, max_height|
+        return nil if width.nil? || height.zero?
+
+        if (height.to_f / max_height) > (width.to_f / max_width)
+          (scaled_height(width, height, max_width, max_height) * width) / height
+        else
+          [max_width, width].min
+        end
+      end
+      mod.send(:private, :scaled_width)
+
+      mod.define_method(:scaled_height) do |width, height, max_width, max_height|
+        return nil if height.nil? || width.zero?
+
+        if (height.to_f / max_height) > (width.to_f / max_width)
+          [max_height, height].min
+        else
+          (scaled_width(width, height, max_width, max_height) * height) / width
+        end
+      end
+      mod.send(:private, :scaled_height)
     end
 
     def def_image_metadata prefix
@@ -44,7 +77,8 @@ module RageRender
       private :"#{prefix}_relative_path"
 
       define_method(:"#{prefix}_url") do
-        File.join (@obj.site.baseurl || ''), send(:"#{prefix}_relative_path")
+        site = @obj.instance_variable_get(:"@site") || @obj.send(:site)
+        File.join (site.baseurl || ''), send(:"#{prefix}_relative_path")
       end
 
       define_method(:"#{prefix}_obj") do
@@ -68,5 +102,28 @@ module RageRender
         send(:"#{prefix}_obj") && (send(:"#{prefix}_obj").data['height'] ||= Dimensions.height(send(:"#{prefix}_path")) rescue nil)
       end
     end
+
+    def def_pages all_pages
+      define_method(:lastpagenumber) do
+        send(all_pages).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
+      define_method(:pages) do
+        pages = send(all_pages)
+        [1].chain([1, pages.size, *(number-2..number+2).to_a].uniq).select {|i| i >= 1 && i <= pages.size }.sort.map do |i|
+          pages[i-1]
+        end.each_cons(2).map do |prev, page|
+          PaginatedPageDrop.new(page, @obj, prev)
+        end
+      end
+
+      def_loop :pages, *PaginatedBlogDrop.own_methods
+    end
   end
 end

data/lib/ragerender/jekyll/search.rb

@@ -1,3 +1,7 @@
+require 'jekyll/generator'
+require 'jekyll/drops/drop'
+require_relative 'pagination'
+
 Jekyll::Hooks.register :pages, :pre_render do |page, payload|
   if page.data['layout'] == 'search'
     RageRender::Pipettes.clean_payload payload
@@ -6,36 +10,87 @@ Jekyll::Hooks.register :pages, :pre_render do |page, payload|
 end
 
 module RageRender
+  RESULTS_PER_PAGE = 60
+
+  class SearchPaginationGenerator < Jekyll::Generator
+    priority :low
+
+    def generate site
+      site.pages.select {|p| p.data['layout'] == 'search' }.each do |page|
+        SearchPaginator.new(page).generate(site)
+      end
+    end
+  end
+
+  class SearchPaginator
+    include PaginationGenerator
+
+    def initialize page
+      @page = page
+    end
+
+    def source_page site
+      @page
+    end
+
+    def searchterm
+      @page.data['searchterm']
+    end
+
+    def num_pages site
+      RageRender::search(site, searchterm).each_slice(RESULTS_PER_PAGE).size
+    end
+
+    def permalink
+      "/search/id/#{searchterm.hash}/:number"
+    end
+  end
+
+  def self.search site, searchterm
+    return [] unless searchterm
+    site.collections['comics'].docs.reject {|c| SPECIAL_COMIC_SLUGS.include? c.data['slug'] }.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
+  end
+
   class SearchDrop < Jekyll::Drops::Drop
     extend Pipettes
 
     private delegate_method_as :data, :fallback_data
     data_delegator 'searchterm'
+    data_delegator 'number'
+    private :number
 
     def searched
       !searchterm.nil?
     end
 
-    def_loop :searchresults, :number, *ComicDrop::PAGINATION_FIELDS
+    def_loop :searchresults, *PaginatedComicDrop.own_methods
     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,
-        }
+      comics = all_results[number-1]
+      comics.map do |comic|
+        PaginatedComicDrop.new(comic, comics)
       end
     end
 
     def foundresults
       searchresults.any?
     end
+
+    def_pages :all_pages
+
+    private
+    def all_results
+      @all_results ||= RageRender::search(@obj.site, searchterm).each_slice(RESULTS_PER_PAGE).to_a
+    end
+
+    def all_pages
+      @obj.site.pages.select {|p| p.data['searchterm'] == searchterm && p.permalink =~ /id/ }
+    end
   end
 end