jekyll-rp_logs 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17dd1b74dd69b9a81d008a8bee295fc4bf70c483
-  data.tar.gz: 61f75839072b83d0da06429c47bfb9ae0ead21db
+  metadata.gz: e50d8d6ccac428c01b48b401c814e37f717a2531
+  data.tar.gz: f06962be3b9c38a50df57c212098f88ec222529f
 SHA512:
-  metadata.gz: 800483262e0d8a34cb63e911146fd0e3d4135f4b898bbb0aae60ecfcaf1b62c42fe2409f37a7b41ebad8f4e1718369b8c90230d5a2879b4b6e90db7fb1231920
-  data.tar.gz: ef89da9dd05867089d6df588614fabafdc839dd9c7aa9428707b82eecdea6c5423f86175604dd30ff4a3238edf0e8dbe8c1f1150b62eb68a61b250e9654c5044
+  metadata.gz: a0bfee379da593428f209f4c8118a00d59d15e55ebe52c5524b497b57963dfe92cffeace97ab0ae73f70dc3ed2205c2be6f69fc15894838d7408d747c8ed9442
+  data.tar.gz: 4d985dd9d69ece28363b0d2e26c1a010ef3524bd698cf1d1fa6e1f577bb945f33ed4a696d129790f08440f673e9934ac14cf52804ca7c8b7848941f09eaf5b08

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.1] - 2015-11-12
+### Changed
+- Certain characters (`#/\`) are replaced with `_` now instead of a word escape.
+
+### Fixed
+- Tag implication and aliasing still work even with `infer_char_tags` turned off. ([#52])
+- Unsafe characters for URLs are replaced with `_` in tags now instead of throwing an exception. ([#48], [#49])
+
 ## [0.3.0] - 2015-11-06
 ### Added
 - Tags are displayed underneath the title of an RP on its page (requires theme update) ([#37])
@@ -66,6 +74,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Set required Ruby version to `~> 2.1` ([#32])
 
 
+[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
 [0.2.1]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.1.6...v0.2.0
@@ -86,3 +95,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [#12]: https://github.com/xiagu/jekyll-rp_logs/issues/12
 [#36]: https://github.com/xiagu/jekyll-rp_logs/issues/36
 [#37]: https://github.com/xiagu/jekyll-rp_logs/issues/37
+[#48]: https://github.com/xiagu/jekyll-rp_logs/issues/48
+[#49]: https://github.com/xiagu/jekyll-rp_logs/issues/49
+[#52]: https://github.com/xiagu/jekyll-rp_logs/issues/52

data/README.md

@@ -9,6 +9,23 @@ This plugin provides support for building prettified versions of raw RP logs. Ex
 
 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)
+    * [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)
+    * [Building the site](#building-the-site)
+    * [Tag implications and aliases](#tag-implications-and-aliases)
+  * [Development](#development)
+  * [Contributing](#contributing)
+
 ## Features
 * Link to a specific post by its timestamp
 * Show and hide OOC chatter at will
@@ -21,6 +38,8 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
 
 ## Installation
 
+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.
+
 ### Bundler (Recommended)
 
 Install the bundle gem with
@@ -52,6 +71,17 @@ Alternatively, install it yourself as:
 
 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.
 
+### Updating
+When a new version of the gem is released, you can update with
+
+    bundle update
+
+If there were any theme updates that you want to install, you'll have to run
+
+    rake rp_logs:new
+
+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.
+
 ## Usage
 
 ### Making a new site
@@ -130,7 +160,9 @@ Optionally, add the `--watch` flag to automatically rebuild if you add more logs
 **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.
 
 ### Tag implications and aliases
-This feature allows you to set up implications, where something tagged with one tag will automatically be tagged with other tags, in a list. The implied tags need to be a list, even if there's only one. Example syntax:
+This feature allows you to set up implications, where something tagged with one tag will automatically be tagged with a list of other tags. The implied tags need to be a list, even if there's only one.
+
+Example syntax (for your `_config.yml`):
 
 ```yaml
 tag_implications:
@@ -138,7 +170,9 @@ tag_implications:
   lorem ipsum: [dolor, sit amet]
 ```
 
-Tag aliases function just like implications, except the original tag is removed. So they effectively convert one tag into another tag. Or tags. Example syntax:
+Tag aliases function just like implications, except the original tag is removed. So they effectively convert one tag into another tag. Or tags.
+
+Example syntax (for your `_config.yml`):
 
 ```yaml
 tag_aliases:
@@ -147,13 +181,15 @@ tag_aliases:
   etaoin: [etaoin shrdlu]
 ```
 
+The [default config file](https://github.com/xiagu/jekyll-rp_logs/blob/1247e4d2cacd7a1cb658828d286bbae049ce2e13/.themes/default/source/_config.yml.default#L41) has these same examples, demonstrating how and where they should be set.
+
 ## Development
 
 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 deploy`. This will do a bunch of things:
+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:
 
 * Create the `dev_site` directory
 * Populate it with a `Gemfile` and `Rakefile` as mentioned in the installation instructions

data/jekyll-rp_logs.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/rp_logs/version'
+require "jekyll/rp_logs/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-rp_logs"
@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
     # 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.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"
 
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "jekyll", "~> 2.5"
   spec.add_runtime_dependency "rake", "~> 10.0"
-  
+
   spec.required_ruby_version = "~> 2.1"
 end

data/lib/jekyll/rp_logs/rp_arcs.rb

@@ -1,11 +1,15 @@
 # Largely inspired by http://brizzled.clapper.org/blog/2010/12/20/some-jekyll-hacks/
+require "forwardable"
 
 module Jekyll
   module RpLogs
     # Holds arc information
     class Arc
+      extend Forwardable
       include Comparable
 
+      def_delegator :@name, :hash
+
       attr_accessor :name, :rps
 
       def initialize(name)
@@ -43,10 +47,6 @@ module Jekyll
           rps == other.rps
       end
 
-      def hash
-        name.hash
-      end
-
       # actually by... start.. date?
       def <=>(other)
         name <=> other.name if self.class == other.class

data/lib/jekyll/rp_logs/rp_log_converter.rb

@@ -162,42 +162,12 @@ module Jekyll
       end
 
       def convert_rp(site, page)
-        options = page.options
-
-        compiled_lines = []
-        page.content.each_line { |raw_line|
-          page[:format].each { |format|
-            log_line = self.class.parsers[format].parse_line(raw_line, options)
-            if log_line
-              compiled_lines << log_line
-              break
-            end
-          }
-        }
-
-        if compiled_lines.length == 0
-          skip_page(site, page, "No lines were matched by any format.")
-          return false
+        msg = catch :skip_page do
+          page.convert_rp(self.class.parsers)
+          return true
         end
-
-        merge_lines! compiled_lines
-        stats = extract_stats compiled_lines
-
-        # A decent amount of this could be moved into Page
-        split_output = compiled_lines.map(&:output)
-        page.content = split_output.join("\n")
-
-        if page[:infer_char_tags]
-          # Turn the nicks into characters
-          nick_tags = stats[:nicks].map! { |n| Tag.new("char:" + n) }
-          page[:rp_tags] = (nick_tags.merge page[:rp_tags]).to_a.sort
-          page.update_tags
-        end
-
-        page[:end_date] = stats[:end_date]
-        page[:start_date] ||= stats[:start_date]
-
-        true
+        skip_page(site, page, msg)
+        false
       end
 
       ##
@@ -207,38 +177,6 @@ module Jekyll
         site.collections[rp_key].docs.delete page.page
         Jekyll.logger.warn "Skipping #{page.basename}: #{message}"
       end
-
-      ##
-      # Consider moving this into Parser or RpLogs::Page
-      # It doesn't really belong here
-      def merge_lines!(compiled_lines)
-        last_line = nil
-        compiled_lines.reject! { |line|
-          if last_line.nil?
-            last_line = line
-            false
-          elsif last_line.mergeable_with? line
-            last_line.merge! line
-            # Delete the current line from output and maintain last_line
-            # in case we need to merge multiple times.
-            true
-          else
-            last_line = line
-            false
-          end
-        }
-      end
-
-      def extract_stats(compiled_lines)
-        nicks = Set.new
-        compiled_lines.each { |line|
-          nicks << line.sender if line.output_type == :rp
-        }
-
-        { nicks: nicks,
-          end_date: compiled_lines[-1].timestamp,
-          start_date: compiled_lines[0].timestamp }
-      end
     end
   end
 end

data/lib/jekyll/rp_logs/rp_page.rb

@@ -45,6 +45,21 @@ module Jekyll
         tags.map(&:to_s)
       end
 
+      def convert_rp(parsers)
+        compiled_lines = convert_all_lines(parsers)
+
+        merge_lines! compiled_lines
+        stats = extract_stats compiled_lines
+
+        # A decent amount of this could be moved into Page
+        split_output = compiled_lines.map(&:output)
+        page.content = split_output.join("\n")
+
+        update_page_properties(stats)
+
+        true
+      end
+
       ##
       # Check this page for errors, using the provided list of supported parse
       # formats
@@ -85,6 +100,86 @@ module Jekyll
         self[:rp_tags] = Tag[self.class.tag_implication_handler.update_tags(tag_strings.to_set)]
         self
       end
+
+      private
+
+      def convert_all_lines(parsers)
+        compiled_lines = []
+        content.each_line do |raw_line|
+          log_line = parse_line(parsers, raw_line)
+          compiled_lines << log_line if log_line
+        end
+
+        if compiled_lines.length == 0
+          throw :skip_page, "No lines were matched by any format."
+        end
+
+        compiled_lines
+      end
+
+      ##
+      # Return the line parsed by the first matching parser, or nil if
+      # there are no matches.
+      def parse_line(parsers, raw_line)
+        self[:format].each do |format|
+          log_line = parsers[format].parse_line(raw_line, options)
+          return log_line if log_line
+        end
+        nil
+      end
+
+      ##
+      # Merge all lines that can be merged. Modifies the list of lines.
+      def merge_lines!(compiled_lines)
+        last_line = nil
+        compiled_lines.reject! do |line|
+          if last_line.nil?
+            last_line = line
+            false
+          elsif last_line.mergeable_with? line
+            last_line.merge! line
+            # Delete the current line from output and maintain last_line
+            # in case we need to merge multiple times.
+            true
+          else
+            last_line = line
+            false
+          end
+        end
+      end
+
+      ##
+      # Returns various stats about the line content:
+      # - nicks: The nicks involved
+      # - end_date: The timestamp of the last post
+      # - start_date: The timestamp of the first post
+      def extract_stats(compiled_lines)
+        nicks = Set.new
+        compiled_lines.each do |line|
+          nicks << line.sender if line.output_type == :rp
+        end
+
+        { nicks: nicks,
+          end_date: compiled_lines[-1].timestamp,
+          start_date: compiled_lines[0].timestamp }
+      end
+
+      ##
+      # Update properties of the page based on statistics.
+      # - Adds tags based on nicks involved, if the infer_char_tags option is
+      #   set to true.
+      # - Updated end and start date.
+      def update_page_properties(stats)
+        if self[:infer_char_tags]
+          # Turn the nicks into characters
+          nick_tags = stats[:nicks].map! { |n| Tag.new("char:" + n) }
+          self[:rp_tags] = (nick_tags.merge self[:rp_tags]).to_a.sort
+        end
+        update_tags
+
+        self[:end_date] = stats[:end_date]
+        self[:start_date] ||= stats[:start_date]
+      end
     end
   end
 end

data/lib/jekyll/rp_logs/rp_tags.rb

@@ -8,13 +8,6 @@ module Jekyll
       CHAR_FLAG = /^char:(?<char_name>.*)/
       META_TAGS = /(safe|questionable|explicit|canon|noncanon|complete|incomplete)/
 
-      TAG_NAME_MAP = {
-        "#"  => "sharp",
-        "/"  => "slash",
-        "\\" => "backslash",
-        " "  => "_"
-      }.freeze
-
       TYPE_CLASSES = {
         character: ["rp-tag-character"],
         meta: ["rp-tag-meta"],
@@ -90,24 +83,10 @@ module Jekyll
 
       private
 
-      # Map a tag to its directory name. Certain characters are escaped,
-      # using the TAG_NAME_MAP constant, above.
+      # Map a tag to its directory name. Unsafe characters are replaced with
+      # underscores. This restricts the dir name to safe characters in URLs.
       def name_to_dir(name)
-        s = ""
-        name.each_char do |c|
-          if c =~ /[-A-Za-z0-9_|\[\]]/
-            s += c
-          else
-            c2 = TAG_NAME_MAP[c]
-            unless c2
-              msg = "Bad character '#{c}' in tag '#{name}'"
-              puts("*** #{msg}")
-              raise Exception.new(msg)
-            end
-            s += "#{c2}"
-          end
-        end
-        s
+        name.gsub(/[^-A-Za-z0-9_|\[\]]/, "_")
       end
     end
   end

data/lib/jekyll/rp_logs/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module RpLogs
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rp_logs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - anrodger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler