jekyll-rp_logs 0.1.3

data/.themes/default/source/_sass/_rp.scss

@@ -0,0 +1,142 @@
+@mixin transition($transition-property, $transition-time, $method) {
+    -webkit-transition: $transition-property $transition-time $method;
+    -moz-transition: $transition-property $transition-time $method;
+    -ms-transition: $transition-property $transition-time $method;
+    -o-transition: $transition-property $transition-time $method;
+    transition: $transition-property $transition-time $method;
+}
+
+// Temporary fix until baseline is back to normal
+li { 
+  list-style: none;
+}
+
+.rp-list li {
+    margin-bottom: 15px;
+}
+
+.rp-entry-container {
+  align-items: baseline;
+  display: flex;
+  flex-wrap: wrap;
+  margin-bottom: .2em;
+  width: 100%;
+}
+
+.rp-entry {
+  flex: 1 1 auto;
+  max-width: 450px;
+}
+
+.rp-title {
+    margin-bottom: 0px;
+}
+
+.rp-metadata-container {
+  // Basis so that content wraps afterwards
+  flex: 1 0 auto;
+  text-align: right;
+
+  .rp-completion {
+    font-size: 1.125em;
+    text-align: center;
+    width: 1.5em;
+  }
+}
+
+.rp-complete { color: $light-green; }
+.rp-incomplete { color: $light-red; }
+
+// Styling for when the screen is too small
+// @include media-query($on-palm) {
+//     .rp-entry {
+//         flex-basis: $on-palm;
+//     }
+// }
+
+/* Undo normal pre styles */
+#log {
+
+    p {
+        margin: 0;
+        margin-top: 0.5em;
+    }
+
+    .rp { color: #DCDCCC; }
+    .ooc { 
+        color: #A0A090;
+        white-space: pre-wrap;
+        font-family: monospace;
+        font-size: 80%;
+    }
+
+    /* timestamps */
+    a {
+        color: inherit;
+
+        &:hover {
+            text-decoration: underline;
+        }
+    }
+}
+
+/* OOC toggling menu */
+.scroll-nav {
+    background: #222;
+    display: block;
+    @include transition(all, 0.25s, ease-in-out);
+    left: 0;
+    right: 0;
+    top: -2.5em;
+    line-height: 2.5em;
+    position: fixed;
+    text-align: center;
+
+    &.shown {
+        top: 0;
+    }
+
+    a,
+    #ooc_label {
+        padding: 0.5em;
+    }
+}
+
+#ooc_toggle {
+    vertical-align: middle;
+}
+
+
+a.rp-tag {
+    background-color: #333;
+    // border: 1px solid $text-color;
+    box-shadow: 0 0 2px 0px darken($text-color, 25%);
+    color: inherit;
+    display: inline-block;
+    margin-bottom: 0.25em;
+    padding: 0 0.25em;
+    white-space: nowrap;
+
+    &.rp-tag-character {
+        background-color: $dark-green;
+        // border: 1px solid $light-green;
+        box-shadow: 0 0 2px 0px darken($light-green, 25%);
+        color: $light-green;
+    }
+
+    &.rp-tag-meta {
+        background-color: $dark-red;
+        // border: 1px solid $light-red;
+        box-shadow: 0 0 2px 0px darken($light-red, 25%);
+        color: $light-red;
+    }
+
+    &:hover {
+        
+    }
+}
+
+// Undo a styling for RP and arc titles
+.arc-title>a {
+    color: inherit;
+}

data/.themes/default/source/_sass/_syntax-highlighting.scss

@@ -0,0 +1,67 @@
+/**
+ * Syntax highlighting styles
+ */
+.highlight {
+    background: #fff;
+    @extend %vertical-rhythm;
+
+    .c     { color: #998; font-style: italic } // Comment
+    .err   { color: #a61717; background-color: #e3d2d2 } // Error
+    .k     { font-weight: bold } // Keyword
+    .o     { font-weight: bold } // Operator
+    .cm    { color: #998; font-style: italic } // Comment.Multiline
+    .cp    { color: #999; font-weight: bold } // Comment.Preproc
+    .c1    { color: #998; font-style: italic } // Comment.Single
+    .cs    { color: #999; font-weight: bold; font-style: italic } // Comment.Special
+    .gd    { color: #000; background-color: #fdd } // Generic.Deleted
+    .gd .x { color: #000; background-color: #faa } // Generic.Deleted.Specific
+    .ge    { font-style: italic } // Generic.Emph
+    .gr    { color: #a00 } // Generic.Error
+    .gh    { color: #999 } // Generic.Heading
+    .gi    { color: #000; background-color: #dfd } // Generic.Inserted
+    .gi .x { color: #000; background-color: #afa } // Generic.Inserted.Specific
+    .go    { color: #888 } // Generic.Output
+    .gp    { color: #555 } // Generic.Prompt
+    .gs    { font-weight: bold } // Generic.Strong
+    .gu    { color: #aaa } // Generic.Subheading
+    .gt    { color: #a00 } // Generic.Traceback
+    .kc    { font-weight: bold } // Keyword.Constant
+    .kd    { font-weight: bold } // Keyword.Declaration
+    .kp    { font-weight: bold } // Keyword.Pseudo
+    .kr    { font-weight: bold } // Keyword.Reserved
+    .kt    { color: #458; font-weight: bold } // Keyword.Type
+    .m     { color: #099 } // Literal.Number
+    .s     { color: #d14 } // Literal.String
+    .na    { color: #008080 } // Name.Attribute
+    .nb    { color: #0086B3 } // Name.Builtin
+    .nc    { color: #458; font-weight: bold } // Name.Class
+    .no    { color: #008080 } // Name.Constant
+    .ni    { color: #800080 } // Name.Entity
+    .ne    { color: #900; font-weight: bold } // Name.Exception
+    .nf    { color: #900; font-weight: bold } // Name.Function
+    .nn    { color: #555 } // Name.Namespace
+    .nt    { color: #000080 } // Name.Tag
+    .nv    { color: #008080 } // Name.Variable
+    .ow    { font-weight: bold } // Operator.Word
+    .w     { color: #bbb } // Text.Whitespace
+    .mf    { color: #099 } // Literal.Number.Float
+    .mh    { color: #099 } // Literal.Number.Hex
+    .mi    { color: #099 } // Literal.Number.Integer
+    .mo    { color: #099 } // Literal.Number.Oct
+    .sb    { color: #d14 } // Literal.String.Backtick
+    .sc    { color: #d14 } // Literal.String.Char
+    .sd    { color: #d14 } // Literal.String.Doc
+    .s2    { color: #d14 } // Literal.String.Double
+    .se    { color: #d14 } // Literal.String.Escape
+    .sh    { color: #d14 } // Literal.String.Heredoc
+    .si    { color: #d14 } // Literal.String.Interpol
+    .sx    { color: #d14 } // Literal.String.Other
+    .sr    { color: #009926 } // Literal.String.Regex
+    .s1    { color: #d14 } // Literal.String.Single
+    .ss    { color: #990073 } // Literal.String.Symbol
+    .bp    { color: #999 } // Name.Builtin.Pseudo
+    .vc    { color: #008080 } // Name.Variable.Class
+    .vg    { color: #008080 } // Name.Variable.Global
+    .vi    { color: #008080 } // Name.Variable.Instance
+    .il    { color: #099 } // Literal.Number.Integer.Long
+}

data/.themes/default/source/arcs.html

@@ -0,0 +1,22 @@
+---
+layout: page
+title: Arc Index
+rp_arcs: true
+---
+
+<ul class="rp-list">
+{% for x in page['rps'] %}
+  {% assign type = x[0] %}
+  {% assign rp = x[1] %}
+  {% if type == 'arc' %}
+    <h3 class="arc-title"><a name="{{ rp.name | slugify }}" href="#{{ rp.name | slugify }}">{{ rp.name }}</a></h3>
+    <ul class="arc-rp-list">
+    {% for arc_rp in rp.rps %}
+      {% include rp.html rp=arc_rp %}
+    {% endfor %}
+    </ul>
+  {% else %}
+    {% include rp.html rp=rp %}
+  {% endif %}
+{% endfor %}
+</ul>

data/.themes/default/source/css/main.scss

@@ -0,0 +1,64 @@
+---
+# Only the main Sass file needs front matter (the dashes are enough)
+layout: nil
+---
+@charset "utf-8";
+
+
+
+// Our variables
+$base-font-family: Helvetica, Arial, sans-serif;
+$base-font-size:   16px;
+$small-font-size:  $base-font-size * 0.875;
+$base-line-height: 1.5;
+
+$spacing-unit:     30px;
+
+$text-color:       #dcdccc;
+$background-color: #3f3f3f;
+$header-color:     #303030;
+$brand-color:      #8cd0d3;
+
+$light-green:      #80d4aa;
+$dark-green:       #313C36;
+$light-red:        #ecbcbc;
+$dark-red:         #41363c;
+
+$link-hover:       #c0bed1;
+$link-visited:     #8c8cbc;
+
+$grey-color:       #8f8f8f;
+// swapped because of dark theme
+$grey-color-light: lighten($grey-color, 25%);
+$grey-color-dark:  lighten($grey-color, 40%);
+
+// Width of the content area
+$content-width:    800px;
+
+$on-palm:          600px;
+$on-laptop:        800px;
+
+
+
+// Using media queries with like this:
+// @include media-query($on-palm) {
+//     .wrapper {
+//         padding-right: $spacing-unit / 2;
+//         padding-left: $spacing-unit / 2;
+//     }
+// }
+@mixin media-query($device) {
+    @media screen and (max-width: $device) {
+        @content;
+    }
+}
+
+
+
+// Import partials from `sass_dir` (defaults to `_sass`)
+@import
+        "base",
+        "layout",
+        "syntax-highlighting",
+        "rp"
+;

data/.themes/default/source/index.html

@@ -0,0 +1,23 @@
+---
+layout: page
+title: All RPs
+rp_index: true
+---
+
+{% if page['rps']['canon'].size > 0 then %}
+<h2 class="arc-title"><a name="canon" href="#canon">Canon</a></h2>
+<ul class="rp-list">
+{% for rp in page['rps']['canon'] %}
+  {% include rp.html rp=rp %}
+{% endfor %}
+</ul>
+{% endif %}
+
+{% if page['rps']['noncanon'].size > 0 %}
+<h2 class="arc-title"><a name="non-canon" href="#non-canon">Non-Canon</a></h2>
+<ul class="rp-list">
+  {% for rp in page['rps']['noncanon'] %}
+    {% include rp.html rp=rp %}
+  {% endfor %}
+</ul>
+{% endif %}

data/.themes/default/source/js/toggle_ooc.js

@@ -0,0 +1,93 @@
+(function() {
+    "use strict";
+    var fixedMenu = $("#fixed_menu");
+    var oocButton = $("#ooc_label");
+    // get window
+    var win = $(window);
+    // use vars to short circuit doing work again
+    var shown = false;
+    var canClose = false;
+    
+    var lastScroll = 0;
+    var minScroll = 200; // how far down in order to show it
+    
+    var timeout;
+    var closeableTimeout;
+
+    var hideMenu = function() {
+        shown = false;
+        fixedMenu.removeClass('shown');
+        clearHideTimer();
+    };
+
+    var showMenu = function() {
+        shown = true;
+        fixedMenu.addClass('shown');
+        resetHideTimer();
+    };
+
+    var allowMenuClose = function() {
+        canClose = true;
+    };
+
+    var resetHideTimer = function() {
+        clearTimeout(timeout);
+        clearTimeout(closeableTimeout);
+        canClose = false;
+        timeout = setTimeout(hideMenu, 2000);
+        closeableTimeout = setTimeout(allowMenuClose, 500);
+    };
+
+    var clearHideTimer = function() {
+        clearTimeout(timeout);
+    };
+
+    win.on("scroll", function() {
+        var curScroll = win.scrollTop();
+        if (!shown && curScroll > minScroll && curScroll < lastScroll) {
+            showMenu();
+        } else if (shown && canClose && (curScroll > lastScroll || curScroll < minScroll)) {
+            // keep it from closing early
+            // have some min time before closing
+            hideMenu();
+        }
+
+        lastScroll = curScroll;
+    });
+
+    win.on("click", function(e) {
+        // Don't hide the button if user clicked a real link or the label
+        if (e.target.tagName === "A" || e.originalEvent.passedThroughFixedMenu) return;
+
+        if (!shown) {
+            showMenu();
+        } else if (shown) {
+            hideMenu();
+        }
+    });
+
+    fixedMenu.click(function(e) {
+        resetHideTimer();
+        e.originalEvent.passedThroughFixedMenu = true;
+    });
+
+    var toggleOOC = function(e) {
+        // var topPost = $("p.rp").withinViewportTop().first();
+        // var topPost = $("p.rp").not(":above-the-top").first();
+        var originalScroll = $(window).scrollTop();
+        var topPost = $("p.rp").filter(function(index, elem) {
+            return $(elem).offset().top >= originalScroll;
+        }).first();
+
+        var originalOffset = topPost.offset();
+
+        // checked == show; not checked == hide
+        var visible = $("#ooc_toggle").is(":checked");
+        $(".ooc").toggle(visible);
+
+        $(window).scrollTop(originalScroll + (topPost.offset().top - originalOffset.top));
+    };
+    toggleOOC();
+
+    $("#ooc_toggle").change(toggleOOC);
+})();

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-rp_logs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Rodgers-Schatz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,92 @@
+# Jekyll::RpLogs
+
+## Installation
+
+### Bundler
+Add these lines to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-rp_logs'
+end
+```
+And then execute:
+
+    $ bundle
+
+The Gemfile group will tell Jekyll to load the gem, and let you keep it up to date easily with Bundler.
+
+### Manually
+Alternatively, install it yourself as:
+
+    $ gem install jekyll-rp_logs
+
+In this case you'll need to tell Jekyll to load the gem somehow, such as option 2 on the [Installing a plugin](http://jekyllrb.com/docs/plugins/#installing-a-plugin) instructions.
+
+## Usage
+
+### Making a new site
+Require the gem in your Rakefile to get access to its exposed tasks:
+
+	echo "require 'jekyll/rp_logs'" >> Rakefile
+
+To set up a new site in the current directory, execute:
+
+	rake rp_logs:new
+
+Then edit `_config.yml` and fill in the needed info for your setup.
+
+**Warning:** Don't tell Jekyll to output to a directory that has anything useful in it -- it deletes anything in the `destination` directory whenever you build the site.
+
+### Building the site
+Run this command: 
+	
+	jekyll build
+
+Optionally, add the `--watch` flag to automatically rebuild if you add more logs. Then get the output to somewhere that's served by a webserver, either by setting your `destination` to something there or by copying it manually.
+
+**Warning again:** Destination folders are cleaned whenever Jekyll builds the site. Seriously, don't tell Jekyll to output to a directory that has anything useful in it.
+
+### Adding RPs
+Dump all of them into the `_rps/` directory of the site.
+
+All joins, parts, and quits are stripped, so you don't have to bother pulling those out. All lines that are emotes (`/me`) are RP, and all other lines are OOC by default. Consecutive posts from the same person with timestamps less than a few seconds apart are merged together.
+
+To flag an OOC line as RP, or vice versa, use
+
+* `!RP ` before the timestamp to manually flag the line as RP
+* `!OOC ` before the timestamp to manually flag the line as OOC
+
+#### YAML Front Matter
+In order to be picked up and parsed by Jekyll, each file needs a [YAML front matter](http://jekyllrb.com/docs/frontmatter/). One field is required:
+
+* `title` - The name of the RP, as shown on its page and in the index
+
+These are all optional (they have default values, configurable in `_config.yml`):
+
+* `start_date` - Any valid YAML date, such as `YYYY-MM-DD`. - Displayed on the RP page, and used to sort in the index. If left blank, will be inferred from the first timestamp.
+* `canon` - true/false - Whether the RP is considered canonical (whatever that means to you). Sorts RPs into one of two categories in the index.
+* `complete` - true/false - Whether the RP is finished, or is still incomplete. Incomplete RPs are flagged as such on the index.
+* `format` - YAML list - What format(s) the logs are in, e.g., `[weechat]`
+* `rp_tags` - comma separated list - A list of tags that describe the contents, such as characters involved or events that occur.
+* `arc_name` - YAML list - names of story arcs that the RP belongs to
+
+There are also some more options you can toggle:
+
+* `strict_ooc` - true/false - If true, only lines beginning with `(` are considered OOC by default.
+* `merge_text_into_rp` - YAML list - A list of nicks whose clients split actions into normal text, like [IRCCloud did for a while](https://twitter.com/XiaguZ/status/590773722593763328).
+* `infer_char_tags` - true/false - If false, don't infer the characters in the RP by the nicks who do emotes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/jekyll-rp_logs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :setup do |t, args|
+	mkdir_p "_rps"
+	cp_n "_config.yml.default" "_config.yml"
+	cp_n "_sass/_custom-vars.scss.default" "_sass/_custom-vars.scss"
+	cp_n "_sass/_custom-rules.scss.default" "_sass/_custom-rules.scss"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/rp_logs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-rp_logs.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/rp_logs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-rp_logs"
+  spec.version       = Jekyll::RpLogs::VERSION
+  spec.authors       = ["anrodger"]
+  spec.email         = ["me@andrew.rs"]
+
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  spec.summary       = %q{Jekyll plugin to turn raw IRC RP logs into pretty pages.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/xiagu/jekyll-rp_logs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+
+  spec.add_runtime_dependency "jekyll", "~> 2.5"
+  spec.add_runtime_dependency "rake", "~> 10.0"
+end

data/lib/jekyll/rp_logs/parse_irssi_xchat.rb

@@ -0,0 +1,47 @@
+module Jekyll
+  module RpLogs
+
+    class IrssiXChatParser < RpLogs::Parser
+
+      # Add this class to the parsing dictionary
+      FORMAT_STR = 'irssi-xchat'
+      RpLogs::RpLogGenerator.add self
+
+      # Stuff
+      class << self
+        MODE = /([+%@&~!]?)/
+        NICK = /([\w\-\\\[\]\{\}\^\`\|]+)/
+        DATE_REGEXP = /(\d\d:\d\d)/
+
+        FLAGS = /((?:![A-Z]+ )*)/
+        # TODO: Update to match join/part/quit format
+        JUNK =  /#{DATE_REGEXP}\t<?-->?\t.*$/ 
+        EMOTE = /^#{FLAGS}#{DATE_REGEXP} {16}\* \| #{NICK}\s+([^\n]*)$/
+        TEXT  = /^#{FLAGS}#{DATE_REGEXP} < *#{MODE}#{NICK}> \| ([^\n]*)$/
+
+        TIMESTAMP_FORMAT = '%H:%M'
+
+        def parse_line(line, options = {}) 
+          case line
+          when JUNK
+            return nil
+          when EMOTE
+            date = DateTime.strptime($2, TIMESTAMP_FORMAT)
+            return Parser::LogLine.new(date, options, sender: $3, contents: $4, \
+              flags: $1, type: :rp)
+          when TEXT
+            date = DateTime.strptime($2, TIMESTAMP_FORMAT)
+            mode = if $3 != '' then $3 else ' ' end
+            return Parser::LogLine.new(date, options, sender: $4, contents: $5, \
+              flags: $1, type: :ooc, mode: mode)
+          else
+            # Only put text and emotes in the log
+            return nil
+          end
+        end
+      end
+
+    end  
+
+  end
+end