jekyll-rp_logs 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ead8952d9f22967672f557f24b4ec9d58bd617
-  data.tar.gz: 77b08ff2e7021cc8925a2b3ef471b33dcd35dc43
+  metadata.gz: 17dd1b74dd69b9a81d008a8bee295fc4bf70c483
+  data.tar.gz: 61f75839072b83d0da06429c47bfb9ae0ead21db
 SHA512:
-  metadata.gz: b240676829e68d51b9e80582282df3dc6c1857dcac4ecd00543c7dbeaa24fa42c6d504720ebb6a49bf9cf239d9e6410b1a907a94e4a2ce2517742a505799340a
-  data.tar.gz: 152cae97b5fcbde92e1e00759abc9c7856914dc6f6a1924af3f2b41387bb60b6531635711922593ab249d7bc1619766956b3f1c1eff5aafb744ccfdacab13896
+  metadata.gz: 800483262e0d8a34cb63e911146fd0e3d4135f4b898bbb0aae60ecfcaf1b62c42fe2409f37a7b41ebad8f4e1718369b8c90230d5a2879b4b6e90db7fb1231920
+  data.tar.gz: ef89da9dd05867089d6df588614fabafdc839dd9c7aa9428707b82eecdea6c5423f86175604dd30ff4a3238edf0e8dbe8c1f1150b62eb68a61b250e9654c5044

data/.themes/default/source/_config.yml.default

@@ -38,6 +38,22 @@ max_seconds_between_posts: 3
 # of strict_ooc and automatically converting OOC emotes to OOC text.
 ooc_start_delimiters: "(["
 
+# This 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.
+tag_implications:
+  # These are just examples, feel free to delete them!
+  apple: [fruit]
+  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.
+tag_aliases:
+  # These are just examples, feel free to delete them!
+  char:John_Smith: ["char:John"] # Needs the quotes because of the :
+  etaoin: [etaoin shrdlu]
+
+
 collections:
   # The RPs must be in a directory named exactly this, prefixed by an underscore.
   # So by default: _rps/
@@ -60,5 +76,6 @@ defaults:
       layout: rp
       merge_text_into_rp: []
       permalink: /:path/
+      rp_tag_implications: true
       rp_tags: ""
       strict_ooc: false

data/.themes/default/source/_layouts/rp.html

@@ -11,7 +11,15 @@ layout: default
   </header>
 
   <article class="post-content">
-    {% if page.start_date %}<p>Started {{ page.start_date | date: "%-d %B %Y" }}</p>{% endif %}
+    <div id="tag-and-date">
+      <div class="tags">
+      {% for t in page.rp_tags %}
+        <a href="{{ site.baseurl }}{{ site.rp_tag_dir }}/{{ t.dir }}" class="rp-tag {{t.classes}}">{{ t.name }}</a>
+      {% endfor %}
+      </div>
+
+      {% if page.start_date %}<p class="start-date"><span class="fa fa-calendar-o"></span> {{ page.start_date | date: "%-d %B %Y" }}</p>{% endif %}
+    </div>
 
 
     <nav id="fixed_menu" class="scroll-nav">

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

@@ -7,7 +7,7 @@
 }
 
 // Temporary fix until baseline is back to normal
-li { 
+li {
   list-style: none;
 }
 
@@ -63,7 +63,7 @@ li {
     }
 
     .rp { color: #DCDCCC; }
-    .ooc { 
+    .ooc {
         color: #A0A090;
         white-space: pre-wrap;
         font-family: monospace;
@@ -132,11 +132,30 @@ a.rp-tag {
     }
 
     &:hover {
-        
+
     }
 }
 
 // Undo a styling for RP and arc titles
 .arc-title>a {
     color: inherit;
-}
+}
+
+/* Display for the tags on an RP page */
+#tag-and-date {
+    display: flex;
+    flex-flow: row wrap;
+    justify-content: flex-end;
+
+    .tags {
+        flex: 1 1 auto;
+
+        .rp-tag {
+            margin-right: 4px;
+        }
+    }
+
+    .start-date {
+        flex: 0 0 auto;
+    }
+}

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

@@ -57,10 +57,10 @@ $on-laptop:        800px;
 
 // Import partials from `sass_dir` (defaults to `_sass`)
 @import
-		"custom-vars",
-        "base",
-        "layout",
-        "syntax-highlighting",
-        "rp",
-        "custom-rules"
+    "custom-vars",
+    "base",
+    "layout",
+    "syntax-highlighting",
+    "rp",
+    "custom-rules"
 ;

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.0] - 2015-11-06
+### Added
+- Tags are displayed underneath the title of an RP on its page (requires theme update) ([#37])
+- Tag implications and tag aliases! ([#12], [#36])
+- Added sample `tag_implications` and `tag_aliases` settings to the default config file
+- A test RP for tag implication and aliasing.
+- `Tag.[]` method for converting an array of strings into Tags, inspired by `Hash`
+- Logs the total number of tag pages generated.
+- Logs the total number of RPs converted after processing them.
+
+
+### Changed
+- Calendar icon instead of the word "Started" for start dates (requires theme update)
+- `Tag#to_s` returns character tags prefixed with `"char:"`. Use `#name` to get the raw name.
+- Cleaned up the tests for `RpLogGenerator` a lot.
+- Logging each individual conversion is now debug level output and not info.
+- Test RPs now use the `.rp` extension instead of `.md`. This keeps them from being run through the Markdown converter, which saves time!
+
+### Fixed
+- Liquid rendering is disabled for RP logs. ([#46])
+- `RpLogs::Page` can be tested on its own, now that it requires `Forwardable`.
+
 ## [0.2.1] - 2015-10-26
 ### Fixed
 - Lines whose contents are completely whitespace are parsed correctly ([#40])
@@ -44,6 +66,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Set required Ruby version to `~> 2.1` ([#32])
 
 
+[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
 
@@ -59,3 +82,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [#7]: https://github.com/xiagu/jekyll-rp_logs/issues/7
 [#4]: https://github.com/xiagu/jekyll-rp_logs/issues/4
 [#40]: https://github.com/xiagu/jekyll-rp_logs/issues/40
+[#46]: https://github.com/xiagu/jekyll-rp_logs/issues/46
+[#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

data/README.md

@@ -17,6 +17,7 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
 * Supports multiple formats per file, for those times where you switched IRC clients in the middle of something. Or moved from IRC to Skype, or vice versa.
 * Infers characters involved in each RP by the nicks speaking
 * Generates a static site that can be hosted anywhere, without needing to run anything more than a web server
+* Tagging and a tag implication/alias system
 
 ## Installation
 
@@ -91,6 +92,7 @@ These are all optional (they have default values, configurable in `_config.yml`)
 * `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`. -
 
 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.
 
@@ -127,6 +129,24 @@ 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:
+
+```yaml
+tag_implications:
+  apple: [fruit]
+  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:
+
+```yaml
+tag_aliases:
+  # Keys with a : in them are fine; only a `: ` is parsed as the separator
+  char:John_Smith: ["char:John"] # Needs the quotes because of the :
+  etaoin: [etaoin shrdlu]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/jekyll/rp_logs/rp_log_converter.rb

@@ -35,6 +35,7 @@ module Jekyll
 
         RpLogGenerator.extract_settings(config)
         LogLine.extract_settings(config)
+        Page.extract_settings(config)
 
         Jekyll.logger.info "Loaded jekyll-rp_logs #{RpLogs::VERSION}"
       end
@@ -44,6 +45,7 @@ module Jekyll
 
         main_index, arc_index = extract_indexes(site)
 
+        disable_liquid_rendering(site)
         # Pull out all the pages that are error-free
         rp_pages = extract_valid_rps(site)
 
@@ -71,6 +73,19 @@ module Jekyll
         site.data["menu_pages"] = [main_index, arc_index]
       end
 
+      ##
+      # Redefine the #render_with_liquid? method for every RP Document. This
+      # speeds up the rendering process a little, and also avoids Liquid
+      # throwing a fit if someone typed {{ in the log.
+      def disable_liquid_rendering(site)
+        site.collections[rp_key].docs.each do |doc|
+          # https://github.com/jekyll/jekyll/blob/6e8fd8cb50eab4dab527eaaa0b23d08593b9972b/lib/jekyll/document.rb#L150
+          def doc.render_with_liquid?
+            false
+          end
+        end
+      end
+
       ##
       # Returns a list of RpLogs::Page objects that are error-free.
       def extract_valid_rps(site)
@@ -107,7 +122,7 @@ module Jekyll
               no_arc_rps << page
             end
 
-            Jekyll.logger.info "Converted #{page.basename}"
+            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}")
@@ -116,6 +131,8 @@ module Jekyll
           end
         end
 
+        Jekyll.logger.info "#{site.collections[rp_key].docs.size} RPs converted."
+
         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|
@@ -137,7 +154,7 @@ module Jekyll
         pages.each do |p|
           if p[:time_line] && !p[:time_line].is_a?(Date)
             Jekyll.logger.error "Malformed time_line #{p[:time_line]} in file #{p.path}"
-            fail "Malformed time_line date"
+            fail "Malformed time_line date, must be in the format YYYY-MM-DD"
           end
         end
         # Sort pages by time_line if present or start_date otherwise
@@ -166,6 +183,7 @@ module Jekyll
         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")
 
@@ -173,6 +191,7 @@ module Jekyll
           # 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]

data/lib/jekyll/rp_logs/rp_page.rb

@@ -1,3 +1,7 @@
+require "forwardable"
+require_relative "rp_tags"
+require_relative "rp_tag_implication_handler"
+
 module Jekyll
   module RpLogs
     class Page
@@ -7,11 +11,19 @@ module Jekyll
       # Jekyll::Page object
       attr_reader :page
 
+      class << self
+        attr_reader :tag_implication_handler
+
+        def extract_settings(config)
+          @tag_implication_handler = TagImplicationHandler.new(config)
+        end
+      end
+
       def initialize(page)
         @page = page
 
         # If the tags exist, try to convert them to a list of Tag objects
-        self[:rp_tags] &&= self[:rp_tags].split(",").map { |t| Tag.new t }
+        self[:rp_tags] = Tag[self[:rp_tags].split(",")] if self[:rp_tags].is_a?(String)
       end
 
       ##
@@ -25,6 +37,14 @@ module Jekyll
         @page.data[key.to_s] = value
       end
 
+      def tags
+        self[:rp_tags]
+      end
+
+      def tag_strings
+        tags.map(&:to_s)
+      end
+
       ##
       # Check this page for errors, using the provided list of supported parse
       # formats
@@ -58,6 +78,13 @@ module Jekyll
           merge_text_into_rp: self[:merge_text_into_rp],
           splits_by_character: self[:splits_by_character] }
       end
+
+      ##
+      # Updates tags with implications and aliases.
+      def update_tags
+        self[:rp_tags] = Tag[self.class.tag_implication_handler.update_tags(tag_strings.to_set)]
+        self
+      end
     end
   end
 end

data/lib/jekyll/rp_logs/rp_tag_implication_handler.rb

@@ -0,0 +1,129 @@
+module Jekyll
+  module RpLogs
+    class TagImplicationHandler
+      class TagImplicationError < StandardError
+      end
+
+      attr_reader :tag_aliases, :tag_implications
+
+      ##
+      # Extract global settings from the config file.
+      def initialize(config)
+        @tag_implications = (config["tag_implications"] || {}).freeze
+        @tag_aliases = (config["tag_aliases"] || {}).freeze
+        validate_tag_rules
+      end
+
+      def update_tags(tag_set, verbose: false)
+        removed_tags = Set.new
+        loop do
+          previous_tags = tag_set.clone
+          cyclical = catch :cyclical_tags do
+            implicate_tags(tag_set, removed_tags, verbose)
+            alias_tags(tag_set, removed_tags)
+            false
+          end
+          if cyclical
+            fail_with "The tag #{cyclical[1]} (from #{cyclical[0]} => #{cyclical[1]}) has been removed before. There is a cycle in the tag aliases and implications."
+          end
+          # Break when there is no change in tags.
+          return tag_set if tag_set == previous_tags
+        end
+      end
+
+      private
+
+      ##
+      # Looks for various loops and other problems in the tag aliases and
+      # implications.
+      def validate_tag_rules
+        # Check for aliases and implications from the same tag
+        dupe = @tag_implications.keys.find { |k| @tag_aliases.key? k }
+        if dupe
+          fail_with "Tag \"#{dupe}\" is both aliased and implied from. Imply from the alias instead."
+        end
+
+        error_for_aliases_that_should_be_implications
+
+        # Check for loooops.
+        starter_tags = @tag_implications.keys.to_set.merge @tag_aliases.keys
+        update_tags(starter_tags, verbose: true)
+      end
+
+      ##
+      # Iteratively adds all implied tags until no more can be implied.
+      # This method won't loop infinitely because there are only a finite
+      # number of tag implications defined, and implications only add tags.
+      # They can't remove tags.
+      def implicate_tags(tag_set, removed_tags, verbose)
+        tags_to_check = tag_set
+        loop do
+          # Because we use this set again as the tags to check we don't want
+          # to clear it.
+          to_add = Set.new
+          tags_to_check.each do |tag|
+            imply = @tag_implications.fetch(tag, [])
+
+            removed, imply = imply.partition { |t| removed_tags.include? t }
+            # It's okay if we want to imply a removed tag. Maybe?
+            if verbose && !removed.empty?
+              string = removed.size == 1 ? "is an aliased tag" : "are aliased tags"
+              Jekyll.logger.warn "#{tag} implies #{removed}, which #{string}. Consider implying the alised tag directly."
+            end
+
+            to_add.merge imply
+          end
+
+          break if to_add.empty?
+          tag_set.merge to_add
+          tags_to_check = to_add
+        end
+      end
+
+      ##
+      # Iteratively apply tag aliases until no more can be applied
+      def alias_tags(tag_set, removed_tags)
+        tags_to_check = tag_set
+        loop do
+          to_add = Set.new
+          tags_to_check.each do |tag|
+            next unless @tag_aliases.key? tag
+
+            aliased = @tag_aliases[tag]
+            aliased.each do |t|
+              next unless removed_tags.include? t
+              throw(:cyclical_tags, [tag, t])
+            end
+
+            # if it's already in the set, something weird happened
+            removed_tags << tag
+            tag_set.delete tag
+            to_add.merge aliased
+          end
+
+          break if to_add.empty?
+          tag_set.merge to_add
+          tags_to_check = to_add
+        end
+      end
+
+      ##
+      # Warn for aliases that include the original tag. They're equivalent to
+      # implications.
+      def error_for_aliases_that_should_be_implications
+        error_messages = []
+        @tag_aliases.each_pair do |k, v|
+          if v.include? k
+            error_messages << "Alias #{k} => #{v} is equivalent to an implication. #{k} will not be removed."
+          end
+        end
+        fail_with error_messages.join("\n") unless error_messages.empty?
+      end
+
+      def fail_with(message)
+        Jekyll.logger.error message
+        fail TagImplicationError, message
+      end
+    end
+  end
+end

data/lib/jekyll/rp_logs/rp_tag_index.rb

@@ -17,7 +17,7 @@ module Jekyll
         # Sort tagged RPs by their start date
         data["pages"] = pages.sort_by { |p| p.data["start_date"] }
         tag_title_prefix = site.config["rp_tag_title_prefix"] || "Tag: "
-        data["title"] = "#{tag_title_prefix}#{tag}"
+        data["title"] = "#{tag_title_prefix}#{tag.name}"
       end
     end
 
@@ -39,6 +39,7 @@ module Jekyll
         tags.each_pair { |tag, pages|
           site.pages << TagIndex.new(site, site.source, File.join(dir, tag.dir), tag, pages)
         }
+        Jekyll.logger.info "#{tags.size} tag pages generated."
       end
 
       # Returns a hash of tags => [pages with tag]

data/lib/jekyll/rp_logs/rp_tags.rb

@@ -2,37 +2,41 @@
 
 module Jekyll
   module RpLogs
-
-    TAG_NAME_MAP = {
-      "#"  => "sharp",
-      "/"  => "slash",
-      "\\" => "backslash",
-      " "  => "_"
-    }
-
     # Holds tag information
     class Tag
-
-      attr_accessor :dir, :name, :type
-
-      TYPES = [:meta, :character, :general]
-      CHAR_FLAG = /char:(.*)/
+      TYPES = [:meta, :character, :general].freeze
+      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'],
-        :general => []
-      }
+        character: ["rp-tag-character"],
+        meta: ["rp-tag-meta"],
+        general: []
+      }.freeze
+
+      attr_accessor :dir, :name, :type
+
+      ##
+      # Inspired by Hash, convert a list of strings to a list of Tags.
+      def self.[](*args)
+        args[0].map { |t| Tag.new t }
+      end
 
       def initialize(name)
         # inspect types
-        name.strip!
-        if (name =~ CHAR_FLAG) == 0 then
-          @name = $1
+        my_name = name.strip
+        if CHAR_FLAG =~ my_name
+          @name = $LAST_MATCH_INFO[:char_name]
           @type = :character
         else
-          @name = name.downcase
+          @name = my_name.downcase
           @type = @name =~ META_TAGS ? :meta : :general
         end
 
@@ -40,25 +44,29 @@ module Jekyll
       end
 
       def to_s
-        self.name
+        if type == :character
+          "char:#{name}"
+        else
+          name
+        end
       end
 
-      def eql?(tag)
-        self.class.equal?(tag.class) && (self.name == tag.name && self.type == tag.type)
+      def eql?(other)
+        self.class.equal?(other.class) && (name == other.name && type == other.type)
       end
 
       def hash
-        self.name.hash
+        name.hash
       end
 
       def <=>(o)
-        if self.class == o.class && self.type == o.type
-          self.name <=> o.name 
-        elsif self.type == :character
+        if self.class == o.class && type == o.type
+          name <=> o.name
+        elsif type == :character
           -1
         elsif o.type == :character
-          1 
-        elsif self.type == :meta
+          1
+        elsif type == :meta
           -1
         elsif o.type == :meta
           1
@@ -73,12 +81,11 @@ module Jekyll
 
       def to_liquid
         # Liquid wants a hash, not an object.
-
-        { "name" => @name, "dir" => @dir, "classes" => self.classes }
+        { "name" => @name, "dir" => @dir, "classes" => classes }
       end
 
-      def classes      
-        TYPE_CLASSES[@type].join ' '
+      def classes
+        TYPE_CLASSES[@type].join " "
       end
 
       private
@@ -88,11 +95,11 @@ module Jekyll
       def name_to_dir(name)
         s = ""
         name.each_char do |c|
-          if (c =~ /[-A-Za-z0-9_|\[\]]/) != nil
+          if c =~ /[-A-Za-z0-9_|\[\]]/
             s += c
           else
             c2 = TAG_NAME_MAP[c]
-            if not c2
+            unless c2
               msg = "Bad character '#{c}' in tag '#{name}'"
               puts("*** #{msg}")
               raise Exception.new(msg)

data/lib/jekyll/rp_logs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rp_logs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - anrodger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,7 @@ files:
 - lib/jekyll/rp_logs/rp_logline.rb
 - lib/jekyll/rp_logs/rp_page.rb
 - lib/jekyll/rp_logs/rp_parser.rb
+- lib/jekyll/rp_logs/rp_tag_implication_handler.rb
 - lib/jekyll/rp_logs/rp_tag_index.rb
 - lib/jekyll/rp_logs/rp_tags.rb
 - lib/jekyll/rp_logs/rp_tasks.rb