jekyll-rp_logs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fda5d0fb28366963c55babf58716626c25b96fc
-  data.tar.gz: 9bf520be1af07225f55a491ce562cfba07b500b8
+  metadata.gz: 1c951a21b0c5b350b1ba6d082873432fdb65ad42
+  data.tar.gz: b2dd0341e66e36f310b17508da6bbdc68a44604b
 SHA512:
-  metadata.gz: 1a8f1b538b33676b75e37dcefce66adc1c37de16f54b61bd06225546f2fc41dfbc6459d3671db8a03063a57a30b45be3c30e5a0598d15611fce92c33e875752c
-  data.tar.gz: b7f69498139d89351abd51645707d8cd8c383633c1afc696085b13563b1d38a4670c1f13e208ebb11285c126327752ebb1283f1a73ee2a0eb8ccbe4e29f91bea
+  metadata.gz: e8403188715e33b12ae311df685cc23d6d649a22ad62c892cad341cde7d7ec87457fd4fb6389975ca4c3cfdd8a9e5f92a89a789d0dba955f038abdb95056942d
+  data.tar.gz: bb681abdba3e83a71c83d19e7ddb27340507fe20baa8729d1bd1995b4438601b070d6fe9b890f8e6653e4b0341071de9bbdeba3f47a67381740537eb2840d877

data/.themes/default/source/_includes/footer.html

@@ -6,11 +6,10 @@
 
     <div class="footer-col-wrapper">
       <div class="footer-col  footer-col-1">
-
+       <p class="text">Generated by <a href="https://github.com/xiagu/jekyll-rp_logs">jekyll-rp_logs</a> v{{ site.rp_logs_version }}</p>
       </div>
 
       <div class="footer-col  footer-col-2">
-
       </div>
 
       <div class="footer-col  footer-col-3">

data/.themes/default/source/_includes/rp_line.html

@@ -0,0 +1,12 @@
+{% assign line = include.line %}
+
+{% if line.base_type == "rp" %}
+  {% capture sender %}{{ line.sender }}{% endcapture %}
+{% else %}
+  {% capture sender %}<{{ line.mode }}{{ line.sender }}>{% endcapture %}
+{% endif %}
+
+{% assign anchor_name = line.timestamp | date: "%Y-%m-%d_%H:%M:%S" %}
+{% assign anchor_title = line.timestamp | date: "%H:%M:%S %B %-d, %Y" %}
+{% assign anchor_display = line.timestamp | date: "%H:%M" %}
+<p class="{{ line.output_type }}"><a name="{{ anchor_name }}" title="{{ anchor_title }}" href="#{{ anchor_name }}">{{ anchor_display }} </a>{{ sender }} {{ line.content }}</p>

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

@@ -57,15 +57,19 @@ li {
 
 /* Undo normal pre styles */
 #log {
-
     p {
         margin: 0;
         margin-top: 0.5em;
     }
 
-    .rp { color: #DCDCCC; }
+    .rp {
+        color: $text-color;
+        & a { color: darken($text-color, 20%); }
+    }
     .ooc {
-        color: #A0A090;
+        color: $dark-text-color;
+        & a { color: darken($dark-text-color, 20%); }
+
         white-space: pre-wrap;
         font-family: monospace;
         font-size: 80%;
@@ -73,7 +77,19 @@ li {
 
     /* timestamps */
     a {
-        color: inherit;
+        /* Set them off to the left */
+        display: inline-block;
+        margin-left: -4rem;
+        /* This is definitely too thin for them but overflow makes it okay */
+        margin-right: 2rem;
+        width: 2rem;
+
+        /* Give it some room to breathe */
+        $laptop-plus: $on-laptop + $base-font-size * 5;
+        @include media-query($laptop-plus) {
+            margin: 0;
+            margin-right: 1rem;
+        }
 
         &:hover {
             text-decoration: underline;

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

@@ -15,6 +15,7 @@ $base-line-height: 1.5;
 $spacing-unit:     30px;
 
 $text-color:       #dcdccc;
+$dark-text-color:  #a0a090;
 $background-color: #3f3f3f;
 $header-color:     #303030;
 $brand-color:      #8cd0d3;

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.5.0] - 2016-01-29
+### Added
+- The default footer has a "Generated by [jekyll-rp_logs](https://github.com/xiagu/jekyll-rp_logs) vX.X.X" blurb in the left column. ([#47])
+
+### Changed
+- Parsers live in `lib/jekyll/rp_logs/parsers/` now. This is purely a development-side change.
+- The default theme's timestamps are in their own column on the left now. They revert to being inline when the page width gets too small. Run `rplogs update` to install this change if you haven't changed the non-custom SASS files. ([#60])
+- Instead of needing a Rakefile, this gem now exposes an `rplogs` executable to perform tasks like setting up a new site scaffold. ([#63])
+  - The `rplogs` program is also used to update your installed theme, with `rplogs update`. ([#69])
+
+### Fixed
+- `main.scss` no longer has its executable bits set. ([#67])
+
 ## [0.4.0] - 2016-01-11
 ### Added
 - Tag descriptions can be set in the config file and show up on each tag's page that lists all RPs with that tag. ([#28])
@@ -82,6 +95,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Set required Ruby version to `~> 2.1` ([#32])
 
 
+[0.5.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.2.1...v0.3.0
@@ -110,3 +124,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [#28]: https://github.com/xiagu/jekyll-rp_logs/issues/28
 [#59]: https://github.com/xiagu/jekyll-rp_logs/issues/59
 [#56]: https://github.com/xiagu/jekyll-rp_logs/issues/56
+[#47]: https://github.com/xiagu/jekyll-rp_logs/issues/47
+[#57]: https://github.com/xiagu/jekyll-rp_logs/issues/57
+[#60]: https://github.com/xiagu/jekyll-rp_logs/issues/60
+[#67]: https://github.com/xiagu/jekyll-rp_logs/issues/67
+[#69]: https://github.com/xiagu/jekyll-rp_logs/issues/69

data/README.md

@@ -7,17 +7,14 @@
 
 This plugin provides support for building prettified versions of raw RP logs. Extra noise is stripped out during the building to keep the process as simple as possible: paste in entire log, add title and tags, and go.
 
-The result of building all the test files can be seen here. http://andrew.rs/projects/jekyll-rp_logs/
+The result of building all the test files can be seen here: http://andrew.rs/projects/jekyll-rp_logs/
 
 ## Table of Contents
 
   * [Features](#features)
-  * [Installation](#installation)
-    * [Bundler (Recommended)](#bundler-recommended)
-    * [Manually](#manually)
+  * [Quick Start](#quick-start)
     * [Updating](#updating)
   * [Usage](#usage)
-    * [Making a new site](#making-a-new-site)
     * [Adding RPs](#adding-rps)
       * [YAML Front Matter](#yaml-front-matter)
       * [Formatting the logs](#formatting-the-logs)
@@ -28,6 +25,7 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
   * [Contributing](#contributing)
 
 ## Features
+
 * Link to a specific post by its timestamp
 * Show and hide OOC chatter at will
 * Responsive layout is readable even on phones
@@ -38,40 +36,62 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
 * Tagging and a tag implication/alias system
 * Tag descriptions
 
-## Installation
+## Quick Start
 
-If you are interested in developing this gem, skip down to the [Development](#development) section instead. This section is for setting up a site that uses the gem.
+Install the gem with
 
-### Bundler (Recommended)
+    gem install jekyll-rp_logs
 
-Install the bundle gem with
+(Installing on Windows will require the [Ruby DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) to build some of the dependencies.)
 
-    gem install bundle
+Create a new bare-bones Jekyll site to run the RpLogs plugin from:
 
-Create a file named `Gemfile` with the following contents:
+    rplogs init path/to/your/new/site
 
-```ruby
-source 'https://rubygems.org'
+This will create that directory (it aborts if the given directory is not empty) and set up basic scaffold for your site. After the command finishes running, you should have a structure like this:
 
-group :jekyll_plugins do
-  gem "jekyll-rp_logs"
-end
+```
+path/to/your/new/site
+├── arcs.html
+├── _config.yml
+├── _config.yml.default
+├── css/
+│   └── main.scss
+├── Gemfile
+├── Gemfile.lock
+├── _includes/
+│   ├── footer.html
+│   ├── header.html
+│   ├── head.html
+│   └── rp.html
+├── index.html
+├── js/
+│   └── toggle_ooc.js
+├── _layouts/
+│   ├── default.html
+│   ├── page.html
+│   ├── post.html
+│   ├── rp.html
+│   └── tag_index.html
+├── _rps/
+└── _sass/
+    ├── _base.scss
+    ├── _custom-rules.scss
+    ├── _custom-vars.scss
+    ├── _layout.scss
+    ├── _rp.scss
+    └── _syntax-highlighting.scss
 ```
 
-(If you already have a Gemfile, just add the three group lines instead.)
-
-And then execute:
-
-    bundle
+Edit `_config.yml` and fill in the needed info for your setup.
 
-The Gemfile group will tell Jekyll to load the gem, and let you keep it up to date easily with Bundler.
+**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.
 
-### Manually
-Alternatively, install it yourself as:
+Now you should be ready to build!
 
-    gem install jekyll-rp_logs
+    bundle exec jekyll build
 
-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.
+Building the site should generate an `index.html` in the `destination` directory you configured, along with all the CSS and JS. There won't be any RPs on the index, but it will exist, and have your title and description on it!
 
 ### Updating
 When a new version of the gem is released, you can update with
@@ -80,36 +100,14 @@ When a new version of the gem is released, you can update with
 
 If there were any theme updates that you want to install, you'll have to run
 
-    rake rp_logs:new
+    rplogs update
 
-again too. This will overwrite any changes you've made to the default SCSS, includes and index files. `_custom-vars.scss` and `_custom-rules.scss` won't be affected.
+in your site directory. This will overwrite any changes you've made to the default SCSS, includes and index files. `_custom-vars.scss` and `_custom-rules.scss` won't be affected.
 
 ## Usage
 
-### Making a new site
-
-To get started with a new site, create a fresh build directory that will be used to hold the Jekyll input files. Here, all of your raw logs, styling, and templates will be stored.
-
-In this directory, create a file named `Rakefile` and require the gem to get access to its exposed tasks like so:
-
-	echo "require 'jekyll/rp_logs'" > Rakefile
-
-To set up a Jekyll site skeleton in the current directory, execute:
-
-	rake rp_logs:new
-
-This will pull in all the necessary files (SASS, `_includes`, default config, etc) for Jekyll to build the site.
-
-*Important:* To allow Jekyll to actually use the plugin, create a Gemfile as specified above in the [Bundler](#bundler-recommended) section and place it into the build directory.
-
-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.
-
-Now you should be ready to build!
-
 ### Adding RPs
-Dump all of the raw logs into the `_rps/` directory of the site.
+Dump all of the raw logs into the `_rps/` directory of the site. The extension doesn't matter; `.rp` or `.txt` is fine. Don't use `.md` or any other Markdown extension, as that will cause Jekyll to run the file through its Markdown parser (which will take a long time).
 
 #### 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:
@@ -123,8 +121,8 @@ These are all optional (they have default values, configurable in `_config.yml`)
 * `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.
-* `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.
-* `time_line` - Used to change the order an RP in an Arc is stored in while keeping the displayed start_date correct. Useful if story RPs were done out of order. Must be a valid YAML date, such as `YYYY-MM-DD`. -
+* `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.
+* `time_line` - Any valid YAML date, such as `YYYY-MM-DD` - Used to change the order an RP in an Arc is stored in while keeping the displayed `start_date` correct. Useful if story RPs were done out of order.
 
 There are also some more options you can toggle. Some are needed for giving the parser more information about oddities in posts, so that it can merge split posts correctly.
 
@@ -155,7 +153,7 @@ These flags can be combined.
 ### Building the site
 Run this command:
 
-	jekyll build
+    bundle exec 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.
 
@@ -202,18 +200,23 @@ After checking out the repo, run `bin/setup` to install dependencies.
 
 To install this gem onto your local machine, run `rake install`.
 
-To install the gem and create, then serve a development site to test your changes, run `rake serve`. This will do a bunch of things:
+To install the gem and create a development site to test your changes, run `rake deploy`. This will do a bunch of things:
 
-* Create the `dev_site` directory
-* Populate it with a `Gemfile` and `Rakefile` as mentioned in the installation instructions
-* Run `bundle` and `rake rp_logs:new`
+* Create the `dev_site/` directory
+* Run the same task that `rplogs init` calls, setting up a basic site scaffold
 * Copy test logs from `test/` into the site's `_rps/` directory
-* Run `jekyll serve` to build and host the site at `localhost:4000` so you can see it!
+
+To additionally serve it at the same time, run `rake serve`, which will:
+
+* Run `rake deploy` and do everything mentioned above
+* Run (in `dev_site/`) `bundle exec jekyll serve` to build and host the site at `localhost:4000` so you can see it!
+
+You can of course run `bundle exec jekyll serve` yourself if weird stuff starts happening.
 
 ## Contributing
 
 1. Fork it ( https://github.com/xiagu/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'`)
+3. Commit your changes (`git commit -av`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request

data/Rakefile

@@ -1,34 +1,16 @@
 require "bundler/gem_tasks"
+require "jekyll/rp_logs"
 require "rake/clean"
 
-directory "dev_site"
+DEV_SITE_DIR = "dev_site"
 
-file "dev_site/Gemfile" => "dev_site" do |tsk|
-  File.open(tsk.name, "w") do |f|
-    f << <<-END.gsub(/^\s+\|/, "")
-      |source "https://rubygems.org"
-      |
-      |group :jekyll_plugins do
-      |  gem "jekyll-rp_logs"
-      |end
-    END
-  end
-end
-
-file "dev_site/Rakefile" => "dev_site" do |tsk|
-  File.open(tsk.name, "w") do |f|
-    f << 'require "jekyll/rp_logs"'
-  end
-end
-
-CLEAN.include("dev_site/*")
+CLEAN.include(DEV_SITE_DIR)
 
 desc "Create and populate the dev_site directory, ready for building or serving"
-task deploy: ["clean", "dev_site", "dev_site/Gemfile", "dev_site/Rakefile", "install"] do
+task deploy: %w(clean install) do
   Bundler.with_clean_env do
-    Dir.chdir("dev_site") do
-      sh "bundle --quiet"
-      sh "bundle exec rake rp_logs:new"
+    Rake::Task["rp_logs:create_new_site"].invoke(DEV_SITE_DIR)
+    Dir.chdir(DEV_SITE_DIR) do
       # Copy test data in!
       cp_r "../test/_rps", "."
     end
@@ -36,9 +18,9 @@ task deploy: ["clean", "dev_site", "dev_site/Gemfile", "dev_site/Rakefile", "ins
 end
 
 desc "Deploys the site to the dev_site directory and serves it for testing"
-task serve: ["deploy"] do
+task serve: :deploy do
   Bundler.with_clean_env do
-    Dir.chdir("dev_site") do
+    Dir.chdir(DEV_SITE_DIR) do
       sh "bundle exec jekyll serve --trace --config _config.yml"
     end
   end

data/exe/rplogs

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "gli"
+require "jekyll/rp_logs"
+require "rake"
+
+# A class to namespace the GLI commands, preventing rake's DSL from conflicting.
+class RpLogsApp
+  extend GLI::App
+
+  program_desc "Create scaffolding/a skeleton for a Jekyll::RpLogs site"
+
+  version Jekyll::RpLogs::VERSION
+
+  subcommand_option_handling :normal
+  arguments :strict
+
+  desc "Create a scaffold for a new Jekyll::RpLogs site"
+  arg_name "path/to/directory"
+  command :init do |c|
+    c.action do |_, _, args|
+      Rake::Task["rp_logs:create_new_site"].invoke(args[0])
+    end
+  end
+
+  desc "Update the theme of an existing Jekyll::RpLogs site"
+  command :update do |c|
+    c.action do
+      Rake::Task["rp_logs:update_theme"].invoke
+    end
+  end
+
+  exit run(ARGV)
+end

data/jekyll-rp_logs.gemspec

@@ -23,13 +23,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
   spec.add_development_dependency "rspec", "~> 3"
   spec.add_development_dependency "simplecov", "~> 0.9"
   spec.add_development_dependency "codeclimate-test-reporter"
 
+  spec.add_runtime_dependency "bundler", "~> 1.8"
   spec.add_runtime_dependency "jekyll", "~> 2.5"
   spec.add_runtime_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "gli", "~> 2.13"
 
   spec.required_ruby_version = "~> 2.1"
 end

data/lib/jekyll/rp_logs.rb

@@ -11,7 +11,7 @@ require "jekyll/rp_logs/rp_log_converter"
 require "jekyll/rp_logs/rp_tag_index"
 
 # Now require all of the parsers
-Gem.find_files("jekyll/rp_logs/parse*.rb").each { |path| require path }
+Gem.find_files("jekyll/rp_logs/parsers/*.rb").each { |path| require path }
 
 # Require the rake tasks
 require "jekyll/rp_logs/rp_tasks"

data/lib/jekyll/rp_logs/rp_log_converter.rb

@@ -43,6 +43,11 @@ module Jekyll
       def generate(site)
         return unless site.config["rp_convert"]
 
+        # There doesn't seem to be a better way to add this to all pages than
+        # by modifying the configuration file, which is added onto the `site`
+        # liquid variable.
+        site.config["rp_logs_version"] = RpLogs::VERSION
+
         main_index, arc_index = extract_indexes(site)
 
         disable_liquid_rendering(site)
@@ -106,49 +111,60 @@ module Jekyll
         # Convert all of the posts to be pretty
         # Also build up our hash of tags
         rp_pages.each do |page|
-          begin
-            # Skip if something goes wrong
-            next unless convert_rp(site, page)
-
-            key = page[:canon] ? "canon" : "noncanon"
-            # Add key for canon/noncanon
-            main_index.data["rps"][key] << page
-            # Add tag for canon/noncanon
-            page[:rp_tags] << (Tag.new key)
-            page[:rp_tags].sort!
-
-            arc_name = page[:arc_name]
-            if arc_name && !arc_name.empty?
-              arc_name.each { |n| arcs[n] << page }
-            else
-              no_arc_rps << page
-            end
-
-            Jekyll.logger.debug "Converted #{page.basename}"
-          rescue
-            # Catch all for any other exception encountered when parsing a page
-            skip_page(site, page, "Error parsing #{page.basename}: #{$ERROR_INFO.inspect}")
-            # Raise exception, so Jekyll prints backtrace if run with --trace
-            raise $ERROR_INFO
-          end
+          convert_page(page, site, main_index, arcs, no_arc_rps)
         end
 
-        Jekyll.logger.info "#{site.collections[rp_key].docs.size} RPs converted."
+        Jekyll.logger.info(
+          "#{site.collections[rp_key].docs.size} RPs converted.")
+
+        sort_arcs(arcs, no_arc_rps, arc_index)
+        sort_chronologically! main_index.data["rps"]["canon"]
+        sort_chronologically! main_index.data["rps"]["noncanon"]
+      end
+
+      def convert_page(page, site, main_index, arcs, no_arc_rps)
+        # Skip if something goes wrong
+        return unless convert_rp(site, page)
+
+        key = page.canon
+        # Add key for canon/noncanon
+        main_index.data["rps"][key] << page
+        # Add tag for canon/noncanon
+        page[:rp_tags] << (Tag.new key)
+        page[:rp_tags].sort!
+
+        arc_name = page[:arc_name]
+        if arc_name && !arc_name.empty?
+          arc_name.each { |n| arcs[n] << page }
+        else
+          no_arc_rps << page
+        end
 
+        Jekyll.logger.debug "Converted #{page.basename}"
+      rescue
+        # Catch all for any other exception encountered when parsing a page
+        skip_page(site, page,
+                  "Error parsing #{page.basename}: #{$ERROR_INFO.inspect}")
+        # Raise exception, so Jekyll prints backtrace if run with --trace
+        raise $ERROR_INFO
+      end
+
+      def sort_arcs(arcs, no_arc_rps, arc_index)
         arcs.each_key { |key| sort_chronologically! arcs[key].rps }
-        combined_rps = no_arc_rps.map { |x| ["rp", x] } + arcs.values.map { |x| ["arc", x] }
-        combined_rps.sort_by! { |type, x|
+        arc_index.data["rps"] = sort_arcs_and_pages(arcs, no_arc_rps)
+      end
+
+      def sort_arcs_and_pages(arcs, no_arc_rps)
+        combined_rps = no_arc_rps.map { |x| ["rp", x] } +
+                       arcs.values.map { |x| ["arc", x] }
+        combined_rps.sort_by! do |type, x|
           case type
           when "rp"
             x[:time_line] || x[:start_date]
           when "arc"
             x.start_date
           end
-        }.reverse!
-        arc_index.data["rps"] = combined_rps
-
-        sort_chronologically! main_index.data["rps"]["canon"]
-        sort_chronologically! main_index.data["rps"]["noncanon"]
+        end.reverse!
       end
 
       def sort_chronologically!(pages)

data/lib/jekyll/rp_logs/rp_logline.rb

@@ -84,15 +84,15 @@ module Jekyll
         title = @timestamp.strftime("%H:%M:%S %B %-d, %Y")
         # String actually displayed on page
         display = @timestamp.strftime("%H:%M")
-        "<a name=\"#{anchor}\" title=\"#{title}\" href=\"##{anchor}\">#{display}</a>"
+        "<a name=\"#{anchor}\" title=\"#{title}\" href=\"##{anchor}\">#{display} </a>"
       end
 
       def output_sender
         case @base_type
         when :rp
-          return "  * #{@sender}"
+          return "#{@sender}"
         when :ooc
-          return " &lt;#{@mode}#{@sender}&gt;"
+          return "&lt;#{@mode}#{@sender}&gt;"
         else
           # Explode.
           fail "No known type: #{@base_type}"

data/lib/jekyll/rp_logs/rp_page.rb

@@ -45,6 +45,10 @@ module Jekyll
         tags.map(&:to_s)
       end
 
+      def canon
+        self[:canon] ? "canon" : "noncanon"
+      end
+
       def convert_rp(parsers)
         compiled_lines = convert_all_lines(parsers)
 

data/lib/jekyll/rp_logs/rp_tasks.rb

@@ -2,52 +2,13 @@ require "rake"
 
 module Jekyll
   module RpLogs
+    ##
+    # Loads the gem's built-in rake tasks from tasks/rp_logs.rake
     class RpTasks
       include Rake::DSL if defined? Rake::DSL
 
-      def copy_unless_exist(from, to, message = nil)
-        unless File.exist?(to)
-          puts message if message
-          cp from, to
-        end
-      end
-
-      # Octopress
-      def get_stdin(message)
-        print message
-        STDIN.gets.chomp
-      end
-
-      # Octopress
-      def ask(message, valid_options)
-        if valid_options
-          answer = get_stdin("#{message} #{valid_options.to_s.gsub(/"/, '').gsub(/, /, '/')} ") until valid_options.include?(answer)
-        else
-          answer = get_stdin(message)
-        end
-        answer
-      end
-
       def install_tasks
-        namespace :rp_logs do
-          directory "_rps"
-
-          desc "Create a new Jekyll site for RP logs, with the default theme"
-          task :new do
-            if File.directory?("_sass")
-              abort("rake aborted!") if ask("A theme is already installed, proceeding will overwrite existing non-custom files. Are you sure?", ['y', 'n']) == 'n'
-            end
-
-            Rake::Task[:_rps].invoke
-            # allow directory specification
-
-            gem_root = Gem::Specification.find_by_name("jekyll-rp_logs").gem_dir
-            cp_r Dir["#{gem_root}/.themes/default/source/*"], "./"
-            copy_unless_exist("_config.yml.default", "_config.yml")
-            touch "_sass/_custom-vars.scss"
-            touch "_sass/_custom-rules.scss"
-          end
-        end
+        load "tasks/rp_logs.rake"
       end
     end
   end

data/lib/jekyll/rp_logs/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module RpLogs
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/tasks/rp_logs.rake

@@ -0,0 +1,82 @@
+Y_OR_N = %w(y n)
+NO = "n"
+
+def copy_unless_exist(from, to, message = nil)
+  return if File.exist?(to)
+  puts message if message
+  cp from, to
+end
+
+# Octopress
+def get_stdin(message)
+  print message
+  STDIN.gets.chomp
+end
+
+# Octopress
+def ask(message, valid_options = Y_OR_N)
+  if valid_options
+    valid_str = valid_options.to_s.delete('"').gsub(/, /, "/")
+    answer = get_stdin("#{message} #{valid_str} ") until valid_options.include?(answer)
+  else
+    answer = get_stdin(message)
+  end
+  answer
+end
+
+namespace :rp_logs do
+  desc "Create a new Jekyll site for RP logs, with the default theme"
+  task :create_new_site, [:dir] => [:site_dir] do |_task, args|
+    Dir.chdir(args[:dir]) do
+      Rake::Task["rp_logs:bundler"].invoke
+      Rake::Task["rp_logs:copy_theme"].invoke
+    end
+  end
+
+  task :site_dir, [:dir] do |_task, args|
+    if Dir.exist? args[:dir]
+      if (Dir.entries(args[:dir]) - %w(. ..)).empty?
+        puts "Using empty directory #{args[:dir]}"
+      else
+        fail "Directory #{args[:dir]} already exists, and is non-empty. Won't overwrite."
+      end
+    else
+      mkdir_p args[:dir]
+    end
+  end
+
+  directory "_rps"
+
+  file "Gemfile" do |tsk|
+    File.open(tsk.name, "w") do |f|
+      f << <<-END.gsub(/^\s+\|/, "")
+        |source "https://rubygems.org"
+        |
+        |group :jekyll_plugins do
+        |  gem "jekyll-rp_logs"
+        |end
+      END
+    end
+  end
+
+  task bundler: "Gemfile" do
+    sh "bundle"
+  end
+
+  task copy_theme: :_rps do
+    gem_root = Gem::Specification.find_by_name("jekyll-rp_logs").gem_dir
+    cp_r Dir["#{gem_root}/.themes/default/source/*"], "./"
+    copy_unless_exist("_config.yml.default", "_config.yml")
+    touch "_sass/_custom-vars.scss"
+    touch "_sass/_custom-rules.scss"
+  end
+
+  task :update_theme do
+    if !File.exist?("_config.yml")
+      abort("Didn't install theme.") if ask("No _config.yml found. This may not be a Jekyll site directory. Install theme anyway?") == NO
+    elsif File.exist?("_sass")
+      abort("Kept existing theme.") if ask("A theme is already installed. Overwrite existing non-custom files?") == NO
+    end
+    Rake::Task["rp_logs:copy_theme"].invoke
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rp_logs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - anrodger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +108,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
 description: 
 email:
 - me@andrew.rs
-executables: []
+executables:
+- rplogs
 extensions: []
 extra_rdoc_files: []
 files:
@@ -111,6 +140,7 @@ files:
 - ".themes/default/source/_includes/head.html"
 - ".themes/default/source/_includes/header.html"
 - ".themes/default/source/_includes/rp.html"
+- ".themes/default/source/_includes/rp_line.html"
 - ".themes/default/source/_layouts/default.html"
 - ".themes/default/source/_layouts/page.html"
 - ".themes/default/source/_layouts/post.html"
@@ -132,13 +162,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/rplogs
 - jekyll-rp_logs.gemspec
 - lib/jekyll/rp_logs.rb
-- lib/jekyll/rp_logs/parse_irssi_xchat.rb
-- lib/jekyll/rp_logs/parse_mirc.rb
-- lib/jekyll/rp_logs/parse_skype_12hour.rb
-- lib/jekyll/rp_logs/parse_skype_24hour.rb
-- lib/jekyll/rp_logs/parse_weechat.rb
+- lib/jekyll/rp_logs/parsers/irssi_xchat.rb
+- lib/jekyll/rp_logs/parsers/mirc.rb
+- lib/jekyll/rp_logs/parsers/skype_12hour.rb
+- lib/jekyll/rp_logs/parsers/skype_24hour.rb
+- lib/jekyll/rp_logs/parsers/weechat.rb
 - lib/jekyll/rp_logs/rp_arcs.rb
 - lib/jekyll/rp_logs/rp_log_converter.rb
 - lib/jekyll/rp_logs/rp_logline.rb
@@ -149,6 +180,7 @@ files:
 - lib/jekyll/rp_logs/rp_tags.rb
 - lib/jekyll/rp_logs/rp_tasks.rb
 - lib/jekyll/rp_logs/version.rb
+- lib/tasks/rp_logs.rake
 homepage: https://github.com/xiagu/jekyll-rp_logs
 licenses:
 - MIT