ragerender 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aedbeb388659f01299aa3694a3f30bd1368e09e9f729caa31334fff4300c6b7c
-  data.tar.gz: 11e966fefecb160bf9992f6697ae8fc23dbe299095c1bc458af6395fb29903c8
+  metadata.gz: 313e3cd9c0ccd4c11ea547a565e2a1cfa77af1fda5e2fc2219c0da8046c6f27a
+  data.tar.gz: 3911407ca12e719f71396099f73d70c6b19aeee29ccc38f796ef4c45b684d80d
 SHA512:
-  metadata.gz: cbdffe416a3edb68d95c256456341c19199d09d71cbc0ef8d3a2f3b41b362048ec81d67848982beca07d2560d4a164758861c152d9b24d71f76010ee45bfc793
-  data.tar.gz: 266d915e6744dd58bf1f5db3fe795105190f9a09081ed03b596d7c58420e258d0f3ff7e1546c209c051bfb936654583d528c5555835ce5340b2863f0158baf67
+  metadata.gz: 4ca0ef393683e910b68e9ffe41a5909511ec66da604b50bcb99fbd758cad371bdeafdd594e1a27394e461beb3e0e8f41c4c3033a28f4c7692a492b470251f8b2
+  data.tar.gz: 5509097f24aa3df45416be46acb9d2f31710318b4227b190f9413dcec287d6c473793bff0fd08b3ecf7b1cc49617b9437739fc991d1c9bd2a309fcbd61eef199

data/README.rdoc

@@ -105,18 +105,17 @@ 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 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.
 
-If you want to keep using the "simple" layout, you can add the details into your
-<tt>_config.yml</tt> too:
+The easiest way is to go to your Webcomic Management, click "Edit Layout", then
+in the box labelled "Useful", click "Download Layout Backup". Pass this file to
+RageRender, which will <tt>unpack</tt> it for you:
 
-  layout:
+    bundle exec jekyll unpack mycomic-2025-09-13.cflxml
 
-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:
+You should end up with a full set of files like:
 
   _layouts
     archive.html
@@ -134,7 +133,7 @@ instead.
 
 === Adding blogs
 
-Add your blogs into a folder called `_posts`:
+Add your blogs into a folder called <tt>_posts</tt>:
 
   cat _posts/2025-05-29-my-new-comic.md
   Hey guys, welcome to my new comic! It's gonna be so sick!
@@ -201,6 +200,16 @@ You control this by setting a <tt>frontpage</tt> key in your site config.
 - anything else will display the extra page that has the matching
   <tt>slug</tt> in its Front Matter
 
+=== Putting changes on ComicFury
+
+Once you're done making changes, you can <tt>pack</tt> your layout:
+
+    bundle exec jekyll pack
+
+The resulting file can be uploaded to ComicFury by going to your Webcomic
+Management, clicking "Edit Layout", then in the box labelled "Useful", click
+"Restore Layout Backup".
+
 === Stuff that doesn't work
 
 Here is a probably incomplete list of things you can expect to be different

data/lib/ragerender/cflxml.rb

@@ -0,0 +1,105 @@
+require 'pathname'
+require 'rexml'
+require 'base64'
+
+module RageRender
+  HTML_FILES = {
+    overall: 'overall',
+    overview: 'overview',
+    viewblog: 'blog-display',
+    comic: 'comic-page',
+    archive: 'archive',
+    blogarchive: 'blog-archive',
+    error: 'error-page',
+    search: 'search',
+  }
+
+  CSS_FILES = {
+    layoutcss: 'layout'
+  }
+
+  def self.unpack src, html_dest, css_dest
+    doc = REXML::Document.new(src).elements
+    html_dir = Pathname.new(html_dest)
+    css_dir = Pathname.new(css_dest)
+
+    HTML_FILES.each do |(tag, filename)|
+      File.write html_dir.join(filename + '.html'), Base64.decode64(doc["/layout/ldata/#{tag.to_s}/text()"].value)
+    end
+
+    CSS_FILES.each do |(tag, filename)|
+      File.write css_dir.join(filename + '.css'), Base64.decode64(doc["/layout/ldata/#{tag.to_s}/text()"].value)
+    end
+  end
+
+  def self.pack html_srcdir, css_srcdir, dest
+    layout = REXML::Element.new('layout')
+
+    name = REXML::Element.new('name')
+    name.text = "Downloaded ComicFury layout"
+    layout.add name
+
+    version = REXML::Element.new('cfxml')
+    version.text = '1.2'
+    layout.add version
+
+    spage = REXML::Element.new('spage')
+    spage.text = '1'
+    layout.add spage
+
+    ldata = REXML::Element.new('ldata')
+    html_dir = Pathname.new(html_srcdir)
+    css_dir = Pathname.new(css_srcdir)
+
+    HTML_FILES.each do |(tag, filename)|
+      elem = REXML::Element.new tag.to_s
+      elem.text = Base64.strict_encode64 File.read html_dir.join(filename + '.html')
+      ldata.add elem
+    end
+
+    CSS_FILES.each do |(tag, filename)|
+      elem = REXML::Element.new tag.to_s
+      elem.text = Base64.strict_encode64 File.read css_dir.join(filename + '.css')
+      ldata.add elem
+    end
+    layout.add ldata
+
+    # ComicFury will only accept backup files that have:
+    # - A valid XML declaration using double quotes
+    # – A comment as per below
+    # – Tab indentation
+    doc = REXML::Document.new(nil, prologue_quote: :quote)
+    doc.add REXML::XMLDecl.new REXML::XMLDecl::DEFAULT_VERSION, REXML::XMLDecl::DEFAULT_ENCODING
+    doc.add REXML::Comment.new 'This is a ComicFury layout backup, use the import layout function to restore this to a webcomic site. You can access this as follows: Go to your Webcomic Management, click "Edit Layout", then in the Box labelled "Useful", click "Restore Layout Backup"'
+    doc.add layout
+
+    # Pretty print, but *always* make text nodes take up a single line, no
+    # matter how long they are
+    formatter = REXML::Formatters::Pretty.new(1)
+    formatter.compact = true
+    formatter.width = Float::INFINITY
+
+    # Replace the space indentation with tab indentation
+    buf = StringIO.new
+    formatter.write(doc, buf)
+    buf.string.each_line do |line|
+      dest << line.gsub(/^ +/) {|sp| "\t" * sp.size }
+    end
+  end
+end
+
+if __FILE__ == $0
+  case ARGV.shift
+  when 'pack'
+    html_srcdir, css_srcdir, *dest = ARGV
+    RageRender.pack(html_srcdir, css_srcdir, dest.any? ? File.open(dest.first, 'w') : $stdout)
+  when 'unpack'
+    src, html_dest, css_dest = ARGV
+    RageRender.unpack(src == '-' ? $stdin : File.open(src, 'r'), html_dest, css_dest)
+  else
+    raise <<~USAGE
+      Usage: pack html_srcdir css_srcdir dest
+      Usage: unpack src html_dest css_dest
+    USAGE
+  end
+end

data/lib/ragerender/jekyll/archive.rb

@@ -8,6 +8,7 @@ require_relative 'pipettes'
 # chapter pages because they are not "pages"
 Jekyll::Hooks.register :pages, :pre_render do |page, payload|
   if page.data['layout'] == 'archive'
+    RageRender::Pipettes.clean_payload payload
     payload.merge! RageRender::ArchiveDrop.new(page).to_liquid
   end
 end

data/lib/ragerender/jekyll/blog.rb

@@ -4,6 +4,7 @@ require_relative '../date_formats'
 require_relative 'pipettes'
 
 Jekyll::Hooks.register :posts, :pre_render do |post, payload|
+  RageRender::Pipettes.clean_payload payload
   payload.merge! RageRender::BlogDrop.new(post).to_liquid
 end
 

data/lib/ragerender/jekyll/blog_archive.rb

@@ -8,6 +8,7 @@ require_relative 'pipettes'
 # Pass the right variables to blog archive pages.
 Jekyll::Hooks.register :pages, :pre_render do |page, payload|
   if page.data['layout'] == 'blog-archive'
+    RageRender::Pipettes.clean_payload payload
     payload.merge! RageRender::BlogArchiveDrop.new(page).to_liquid
   end
 end

data/lib/ragerender/jekyll/chapter.rb

@@ -21,6 +21,7 @@ Jekyll::Hooks.register :site, :after_init do |site|
 end
 
 Jekyll::Hooks.register :chapters, :pre_render do |chapter, payload|
+  RageRender::Pipettes.clean_payload payload
   payload.merge! RageRender::ChapterDrop.new(chapter).to_liquid
   payload.merge! RageRender::ArchiveDrop.new(chapter).to_liquid
 end
@@ -80,16 +81,13 @@ module RageRender
     extend Forwardable
 
     def_data_delegator :description, :chapterdescription
+    def_data_delegator :image, :image
     def_delegator :@obj, :url, :chapterarchiveurl
 
     def chaptername
       escape @obj.data['title']
     end
 
-    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
@@ -117,24 +115,15 @@ module RageRender
     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_image_metadata :image
 
     def first_comic
       @obj.site.collections['comics'].docs.select {|c| c.data['chapter'] == @obj.data['slug'] }.first
     end
+
+    public
+    alias cover image_url
+    alias cover_height image_height
+    alias cover_width image_width
   end
 end

data/lib/ragerender/jekyll/comics.rb

@@ -5,6 +5,7 @@ require_relative '../date_formats'
 require_relative 'pipettes'
 
 Jekyll::Hooks.register :comics, :pre_render do |page, payload|
+  RageRender::Pipettes.clean_payload payload
   payload.merge! RageRender::ComicDrop.new(page).to_liquid
 end
 
@@ -82,6 +83,7 @@ module RageRender
 
     delegate_method_as :id, :comicid
     def_delegator :@obj, :url, :comicurl
+    def_delegator :@obj, :url, :permalink
     data_delegator 'rating'
     data_delegator 'votecount'
 

data/lib/ragerender/jekyll/error.rb

@@ -2,6 +2,7 @@ require_relative 'pipettes'
 
 Jekyll::Hooks.register :pages, :pre_render do |page, payload|
   if page.data['layout'] == 'error-page'
+    RageRender::Pipettes.clean_payload payload
     payload.merge! RageRender::ErrorDrop.new(page).to_liquid
   end
 end

data/lib/ragerender/jekyll/overview.rb

@@ -6,6 +6,7 @@ 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'
+    RageRender::Pipettes.clean_payload payload
     payload.merge! RageRender::ComicDrop.new(page.site.collections['comics'].docs.last).to_liquid
     payload.merge! RageRender::OverviewDrop.new(page).to_liquid
   end

data/lib/ragerender/jekyll/pipettes.rb

@@ -1,8 +1,16 @@
 # Pipettes help you make drops.
 require 'cgi'
+require 'dimensions'
 
 module RageRender
   module Pipettes
+    def self.clean_payload payload
+      Jekyll.logger.debug("Cleaning payload")
+      sets = Jekyll::Drops::DocumentDrop.subclasses.map(&:invokable_methods)
+      methods = sets.reduce(Set.new) {|s,acc| acc.merge(s)} - Set.new(Jekyll::Drops::DocumentDrop.invokable_methods)
+      payload.send(:fallback_data).delete_if {|k| methods.include? k}
+    end
+
     def def_data_delegator key, aliaz
       define_method(aliaz.to_sym) do
         @obj.data[key.to_s]

data/lib/ragerender/jekyll/search.rb

@@ -1,5 +1,6 @@
 Jekyll::Hooks.register :pages, :pre_render do |page, payload|
   if page.data['layout'] == 'search'
+    RageRender::Pipettes.clean_payload payload
     payload.merge! RageRender::SearchDrop.new(page).to_liquid
   end
 end

data/lib/ragerender/jekyll.rb

@@ -1,11 +1,11 @@
 require 'etc'
 require 'stringio'
 require 'jekyll'
-require 'dimensions'
 require_relative 'language'
 require_relative 'functions'
 require_relative 'to_liquid'
 require_relative 'date_formats'
+require_relative 'cflxml'
 require_relative 'jekyll/archive'
 require_relative 'jekyll/blog'
 require_relative 'jekyll/blog_archive'
@@ -17,6 +17,39 @@ require_relative 'jekyll/search'
 require_relative 'jekyll/pipettes'
 require_relative 'jekyll/setup_collection'
 
+module RageRender
+  class CFLXMLCommands < Jekyll::Command
+    class << self
+      def init_with_program(jekyll)
+        jekyll.command :pack do |pack|
+          pack.syntax 'pack'
+          pack.description 'Create a ComicFury layout backup from this site'
+          pack.action do |args, options|
+            config = configuration_from_options(options)
+            filename = "#{(config['title'] || File.basename(config['source']))} #{Time.now.to_s}.cflxml"
+            puts "Outputting backup file #{filename}"
+            File.open(filename, 'w') do |file|
+              RageRender.pack config['layouts_dir'], config['source'], file
+            end
+          end
+        end
+
+        jekyll.command :unpack do |unpack|
+          unpack.syntax 'unpack <file>'
+          unpack.description 'Overwrite HTML and CSS from a ComicFury layout backup'
+          unpack.action do |args, options|
+            raise ArgumentError, 'unpack requires one cflxml file' unless args.one?
+            config = configuration_from_options(options)
+            File.open(args.first, 'r') do |file|
+              RageRender.unpack file, config['layouts_dir'], config['source']
+            end
+          end
+        end
+      end
+    end
+  end
+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
@@ -84,6 +117,7 @@ Jekyll::Hooks.register :documents, :pre_render do |doc, payload|
 end
 
 Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  RageRender::Pipettes.clean_payload payload
   payload.merge! RageRender::WebcomicDrop.new(page).to_liquid
 end
 
@@ -169,8 +203,6 @@ class RageRender::WebcomicDrop < Jekyll::Drops::Drop
     HTML
   end
 
-  delegate_method_as :url, :permalink
-
   def pagetitle
     escape @obj.data['title']
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ragerender
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Simon Worthington
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-06 00:00:00.000000000 Z
+date: 2025-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsec
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -185,8 +199,15 @@ description: |-
 
   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:
+  and then put your CSS in the main folder.
+
+  The easiest way is to go to your Webcomic Management, click "Edit Layout", then
+  in the box labelled "Useful", click "Download Layout Backup". Pass this file to
+  RageRender, which will <tt>unpack</tt> it for you:
+
+      bundle exec jekyll unpack mycomic-2025-09-13.cflxml
+
+  You should end up with a full set of files like:
 
     _layouts
       archive.html
@@ -204,7 +225,7 @@ description: |-
 
   === Adding blogs
 
-  Add your blogs into a folder called `_posts`:
+  Add your blogs into a folder called <tt>_posts</tt>:
 
     cat _posts/2025-05-29-my-new-comic.md
     Hey guys, welcome to my new comic! It's gonna be so sick!
@@ -271,6 +292,16 @@ description: |-
   - anything else will display the extra page that has the matching
     <tt>slug</tt> in its Front Matter
 
+  === Putting changes on ComicFury
+
+  Once you're done making changes, you can <tt>pack</tt> your layout:
+
+      bundle exec jekyll pack
+
+  The resulting file can be uploaded to ComicFury by going to your Webcomic
+  Management, clicking "Edit Layout", then in the box labelled "Useful", click
+  "Restore Layout Backup".
+
   === Stuff that doesn't work
 
   Here is a probably incomplete list of things you can expect to be different
@@ -322,6 +353,7 @@ files:
 - assets/overview.html
 - assets/search.html
 - lib/ragerender.rb
+- lib/ragerender/cflxml.rb
 - lib/ragerender/date_formats.rb
 - lib/ragerender/functions.rb
 - lib/ragerender/jekyll.rb