ragerender 0.1.1

data/lib/ragerender/language.rb

@@ -0,0 +1,77 @@
+require 'rsec'
+require 'strscan'
+
+module RageRender
+  module Language
+    extend Rsec::Helpers
+
+    Variable = Struct.new 'Variable', :path
+    Loop = Struct.new 'Loop', :path
+    Conditional = Struct.new 'Conditional', :reversed, :lhs, :operator, :rhs
+    Function = Struct.new 'Function', :name, :params
+    Layout = Struct.new 'Layout', :name
+    EndTag = Struct.new 'EndTag'
+
+    def self.optional p, default=nil
+      p | ''.r.map {|_| default}
+    end
+
+    TEXT = /[^\[\]\|\<\>]+/.r
+
+    # IDENT parses names: 'names' => 'names'
+    # IDENT parses underscores: 'underscore_name' => 'underscore_name'
+    # IDENT parses numbers: 'name_with_1_number' => 'name_with_1_number'
+    # IDENT parses capitals: 'name_with_Capital' => 'name_with_Capital'
+    IDENT = /[a-zA-Z0-9_]+/.r
+
+    # PATH parses names: 'names' => ['names']
+    # PATH parses dotted paths: 'dotted.name' => ['dotted', 'name']
+    PATH = IDENT.join('.'.r).even
+
+    OPERATOR = %w{= != ~ !~ < > <= >= % !%}.map(&:r).reduce {|a, b| a | b }
+
+    # VARIABLE parses names: 'v:name' => Variable.new(['name'])
+    # VARIABLE parses dotted paths: 'v:dotted.name' => Variable.new(['dotted', 'name'])
+    VARIABLE = ('v:'.r >> PATH).map {|path| Variable.new path }
+    LOOP = ('l:'.r >> PATH).map {|path| Loop.new path }
+
+    # CONDITIONAL tests for truthiness: 'c:variable' => Conditional.new(false, Variable.new(['variable']), nil, nil)
+    # CONDITIONAL tests for falsiness: 'c:!variable' => Conditional.new(true, Variable.new(['variable']), nil, nil)
+    # CONDITIONAL tests for equality: 'c:variable=My comic about bees' => Conditional.new(false, Variable.new(['variable']), '=', 'My comic about bees')
+    # CONDITIONAL tests for inequality: 'c:variable!=My comic about bees' => Conditional.new(false, Variable.new(['variable']), '!=', 'My comic about bees')
+    CONDITIONAL = ('c:'.r >> seq_(
+      /!?/.r.map {|c| c == '!' },
+      PATH.map {|p| Variable.new(p) },
+      optional(OPERATOR),
+      optional(VARIABLE | TEXT))
+    ).map {|(reversed, lhs, operator, rhs)| Conditional.new reversed, lhs, operator, rhs }
+
+    # FUNCTION with no arguments: 'f:cowsay' => Function.new("cowsay", [])
+    # FUNCTION with a variable argument: 'f:js|v:foo' => Function.new('js', [Variable.new(['foo'])])
+    # FUNCTION with literal arguments: 'f:add|2|3' => Function.new('add', ['2', '3'])
+    FUNCTION = ('f:'.r >> seq(IDENT, ('|'.r >> (VARIABLE | TEXT)).star)).map {|(name, params)| Function.new name, params }
+
+    # TAG matches variable tags: '[v:value]' => Variable.new(["value"])
+    # TAG matches loop tags: '[l:loop]' => Loop.new(["loop"])
+    # TAG matches conditional tags: '[c:authorname=Simon W]' => Conditional.new(false, Variable.new(['authorname']), '=', 'Simon W')
+    # TAG matches function tags: '[f:js|v:dench]' => Function.new('js', [Variable.new(['dench'])])
+    TAG = '['.r >> (VARIABLE | CONDITIONAL | LOOP | FUNCTION) << ']'.r
+
+    # LAYOUT_TAG with content: '<!--layout:[content]-->' => Layout.new('content')
+    # LAYOUT_TAG with css: '<!--layout:[css]-->' => Layout.new('css')
+    LAYOUT_TAG = ('<!--layout:['.r >> IDENT << ']-->'.r).map {|(name)| Layout.new name }
+
+    # END_TAG matches, er, end tags: '[/]' => EndTag.new
+    END_TAG = '[/]'.r.map {|_| EndTag.new }
+
+    DOCUMENT = (TAG | END_TAG | LAYOUT_TAG | TEXT | /[\[\]\|\<\>]/.r).star.eof
+
+    def self.parse io
+      DOCUMENT.parse! io.read
+    end
+  end
+end
+
+if __FILE__ == $0
+  puts RageRender::Language::parse(ARGF).inspect
+end

data/lib/ragerender/to_erb.rb

@@ -0,0 +1,50 @@
+require_relative 'language'
+
+module RageRender
+  def self.to_erb document
+    document.map do |chunk|
+      case chunk
+      when String
+        chunk
+
+      when Language::Variable
+        "<%= #{chunk.path.join('.')} %>"
+
+      when Language::Conditional
+        rhs = case chunk.rhs
+        when String
+          "\"#{chunk.rhs}\""
+        when Language::Variable
+          chunk.rhs.path.join('.')
+        when nil
+          ""
+        end
+        "<% if #{chunk.reversed ? 'not ' : ''} #{chunk.lhs.path.join('.')} #{chunk.operator} #{rhs} %>"
+
+      when Language::Function
+        params = chunk.params.map do |param|
+          case param
+          when Language::Variable
+            param.path.join('.')
+          else
+            "\"#{param}\""
+          end
+        end
+        "<%= #{chunk.name}(#{params.join(', ')}) %>"
+
+      when Language::Loop
+        "<% for l in #{chunk.path.join('.')} %>"
+
+      when Language::Layout
+        "<%= #{chunk.name} %>"
+
+      when Language::EndTag
+        '<% end %>'
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  puts RageRender.to_erb(RageRender::Language::parse(ARGF)).join
+end

data/lib/ragerender/to_liquid.rb

@@ -0,0 +1,105 @@
+require_relative 'language'
+
+module RageRender
+  LIQUID_FUNCTIONS = {
+    'add' => 'plus',
+    'subtract' => 'minus',
+    'multiply' => 'times',
+    'divide' => 'divided_by',
+    'js' => 'escape', # TODO: check these do the same thing!
+  }
+
+  def self.render_value value
+    case value
+    when String
+      value =~ /^[0-9]+$/ ? value : "\"#{value}\""
+    when Language::Variable
+      if value.path.first == 'l' && value.path.last == 'iteration'
+        'forloop.index0'
+      elsif value.path.first == 'l' && value.path.last == 'aiteration'
+        'forloop.index'
+      else
+        value.path.join('.')
+      end
+    when nil
+      ""
+    end
+  end
+
+  def self.to_liquid document
+    tag_stack = Array.new
+
+    document.map do |chunk|
+      case chunk
+      when String
+        chunk
+
+      when Language::Variable
+        "{{ #{render_value chunk} }}"
+
+      when Language::Conditional
+        tag_stack << (chunk.reversed ? :endunless : :endif)
+
+        lhs = render_value chunk.lhs
+        rhs = render_value chunk.rhs
+        operator = chunk.operator
+
+        if chunk.lhs.is_a?(Language::Variable) && chunk.lhs.path.first == "l"
+          case chunk.lhs.path.last
+          when "is_first", "is_last"
+            lhs = "forloop.#{chunk.lhs.path.last[3..]}"
+          when "is_even", "is_odd"
+            lhs = 'forloop.index0'
+            rhs = '2'
+            operator = (chunk.lhs.path.last == 'is_even' ? '%' : '!%')
+          end
+        end
+
+        output = Array.new
+        case operator
+        when '~', '!~'
+          # case insensitive comparison: we need to manually do this
+          output << "{% assign lhs = #{lhs} | downcase %}"
+          output << "{% assign rhs = #{rhs} | downcase %}"
+          lhs = "lhs"
+          rhs = "rhs"
+          operator = {'~' => '==', '!~' => '!='}[operator]
+        when '%', '!%'
+          # modulo comparison with zero
+          output << "{% assign lhs = #{lhs} | modulo: #{rhs} %}"
+          lhs = "lhs"
+          rhs = "0"
+          operator = {'%' => '==', '!%' => '!='}[operator]
+        end
+
+        operator = (operator == '=' ? '==' : operator)
+        output << "{% #{chunk.reversed ? 'unless' : 'if'} #{lhs} #{operator} #{rhs} %}"
+        output.join
+
+      when Language::Function
+        params = chunk.params.map {|p| render_value p }
+        name = LIQUID_FUNCTIONS.fetch(chunk.name, chunk.name)
+        args = params.drop(1).map {|p| "#{name}: #{p}" }.join(' | ')
+        "{{ #{params.first} | #{args.empty? ? name : args} }}"
+
+      when Language::Loop
+        tag_stack << :endfor
+        "{% for l in #{chunk.path.join('.')} %}"
+
+      when Language::Layout
+        "{{ #{chunk.name} }}"
+
+      when Language::EndTag
+        if tag_stack.empty?
+          '[/]'
+        else
+          "{% #{tag_stack.pop.to_s} %}"
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  puts RageRender.to_liquid(RageRender::Language::parse(ARGF)).join
+end

data/lib/ragerender.rb

@@ -0,0 +1,7 @@
+require_relative 'ragerender/language'
+require_relative 'ragerender/to_liquid'
+require_relative 'ragerender/to_erb'
+
+if defined?(Jekyll)
+  require_relative 'ragerender/jekyll'
+end

metadata

@@ -0,0 +1,348 @@
+--- !ruby/object:Gem::Specification
+name: ragerender
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Simon Worthington
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rsec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: dimensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: |-
+  == 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
+
+  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.
+email:
+- simon@simonwo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- Rakefile
+- assets/404.html
+- assets/archive-comics.html
+- assets/archive.html
+- assets/blog.html
+- assets/overview.html
+- assets/search.html
+- lib/ragerender.rb
+- lib/ragerender/date_formats.rb
+- lib/ragerender/jekyll.rb
+- lib/ragerender/jekyll/archive.rb
+- lib/ragerender/jekyll/blog.rb
+- lib/ragerender/jekyll/blog_archive.rb
+- lib/ragerender/jekyll/chapter.rb
+- lib/ragerender/jekyll/comics.rb
+- lib/ragerender/jekyll/error.rb
+- lib/ragerender/jekyll/named_data_delegator.rb
+- lib/ragerender/jekyll/overview.rb
+- lib/ragerender/jekyll/pagination.rb
+- lib/ragerender/jekyll/search.rb
+- lib/ragerender/language.rb
+- lib/ragerender/to_erb.rb
+- lib/ragerender/to_liquid.rb
+homepage: https://github.com/simonwo/ragerender
+licenses:
+- ''
+metadata:
+  homepage_uri: https://github.com/simonwo/ragerender
+  source_code_uri: https://github.com/simonwo/ragerender
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: A template parser and site generator that can render a webcomic site using
+  ComicFury templates, using the Jekyll static site generator.
+test_files: []