jekyll-rp_logs 0.1.6 → 0.2.0

data/lib/jekyll/rp_logs/rp_parser.rb

@@ -1,114 +1,20 @@
 module Jekyll
   module RpLogs
-
     class Parser
       FORMAT_STR = nil
 
-      class LogLine
-        MAX_SECONDS_BETWEEN_POSTS = 3
-        RP_FLAG = '!RP'
-        OOC_FLAG = '!OOC'
-
-        attr :timestamp, :mode, :sender, :contents
-        attr :flags
-        # Some things depend on the original type of the line (nick format)
-        attr :base_type
-        attr :output_type
-        attr :options
-
-        attr :last_merged_timestamp
-
-        def initialize(timestamp, options = {}, sender:, contents:, flags:, type:, mode: ' ') 
-          @timestamp = timestamp
-          # Initialize to be the same as @timestamp
-          @last_merged_timestamp = timestamp
-          @mode = mode
-          @sender = sender
-          @contents = contents
-          @flags = flags.split(' ')
-
-          @base_type = type
-          @output_type = type
-
-          @options = options
-
-          # This makes it RP by default
-          @output_type = :rp if options[:strict_ooc]
+      # These patterns are reasonably universal.
+      # (?<foo>pattern) is a named group accessible via $LAST_MATCH_INFO[:foo]
 
-          # Check the contents for (
-          @output_type = :ooc if contents.strip[0] == '('
-          
-          # Flags override our assumptions, always
-          if flags.include? RP_FLAG then
-            @output_type = :rp
-          elsif flags.include? OOC_FLAG then
-            @output_type = :ooc
-          end
-        end
+      # IRC mode characters for most IRCds.
+      MODE = /(?<mode>[+%@&~!]?)/
 
-        def output
-          # String used for the timestamp anchors
-          anchor = @timestamp.strftime('%Y-%m-%d_%H:%M:%S')
-          # String used when hovering over timestamps (friendly long-form)
-          title = @timestamp.strftime('%H:%M:%S %B %-d, %Y')
-          # String actually displayed on page
-          display = @timestamp.strftime('%H:%M')
-          ts_out = "<a name=\"#{anchor}\" title=\"#{title}\" href=\"##{anchor}\">#{display}</a>"
+      # The allowable characters in nicks. Errs on the side of being permissive
+      # rather than restrictive
+      NICK = /(?<nick>[\w\-\\\[\]\{\}\^\`\|]+)/
 
-          sender_out = nil
-          case @base_type
-          when :rp
-            sender_out = "  * #{@sender}"
-          when :ooc
-            sender_out = " &lt;#{@mode}#{@sender}&gt;"
-          else
-            # Explode.
-            throw "No known type: #{@base_type}"
-          end
-
-          tag_class = nil
-          tag_close = "</p>"
-          case @output_type
-          when :rp 
-            tag_class = "rp"
-          when :ooc
-            tag_class = "ooc"
-          else
-            # Explode.
-            throw "No known type: #{@output_type}"
-          end
-          tag_open = "<p class=\"#{tag_class}\">"
-
-          "#{tag_open}#{ts_out}#{sender_out} #{@contents}#{tag_close}"
-        end
-
-        def mergeable_with?(next_line)
-          # Only merge posts close enough in time
-          # The difference in time between the post merged into this one, and the next post, must be less than the limit
-          close_enough_time = (next_line.timestamp - @last_merged_timestamp) * 24 * 60 * 60 <= MAX_SECONDS_BETWEEN_POSTS
-          # Only merge posts with same sender
-          same_sender = @sender == next_line.sender
-          # Only merge rp lines
-          is_rp = @output_type == :rp
-          # Merge if next post is rp, or sender has split_to_normal_text property
-          # Only merge if the base type was OOC... otherwise you couldn't force not merging
-          # Maybe a job for !NOTMERGE flag, or similar
-          next_line_is_rp = next_line.output_type == :rp || \
-            (@options[:merge_text_into_rp].include?(@sender) && next_line.base_type == :ooc)
-
-          close_enough_time && same_sender && is_rp && next_line_is_rp
-        end
-
-        def merge!(next_line)
-          @contents += ' ' + next_line.contents
-          @last_merged_timestamp = next_line.timestamp
-        end
-
-        def inspect()
-          "<#{@mode}#{@sender}> (#{@base_type} -> #{@output_type}) #{@content}"
-        end
-      end
+      # Match flags used for forcing the parser to treat the line a certain way
+      FLAGS = /(?<flags>(?:![A-Z]+ )*)/
     end
-
   end
 end

data/lib/jekyll/rp_logs/rp_tag_index.rb

@@ -2,23 +2,22 @@
 
 module Jekyll
   module RpLogs
-
     class TagIndex < Jekyll::Page
       def initialize(site, base, dir, tag, pages)
         @site = site
         @base = base
         @dir = dir
-        @name = 'index.html'
+        @name = "index.html"
 
-        self.process(@name)
+        process(@name)
         # Get tag_index filename
-        tag_index = (site.config['rp_tag_index_layout'] || 'tag_index') + '.html'
-        self.read_yaml(File.join(base, '_layouts'), tag_index)
-        self.data['tag'] = tag # Set which tag this index is for
+        tag_index = (site.config["rp_tag_index_layout"] || "tag_index") + ".html"
+        read_yaml(File.join(base, "_layouts"), tag_index)
+        data["tag"] = tag # Set which tag this index is for
         # Sort tagged RPs by their start date
-        self.data['pages'] = pages.sort_by { |p| p.data['start_date'] }
-        tag_title_prefix = site.config['rp_tag_title_prefix'] || 'Tag: '
-        self.data['title'] = "#{tag_title_prefix}#{tag}"
+        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}"
       end
     end
 
@@ -27,30 +26,29 @@ module Jekyll
       # Needs to run after RpLogGenerator
       priority :low
 
-      def initialize(config) 
-        config['rp_tag_index'] ||= true
-        config['rp_tag_dir'] ||= '/tags'
+      def initialize(config)
+        config["rp_tag_index"] ||= true
+        config["rp_tag_dir"] ||= "/tags"
       end
 
       def generate(site)
-        return unless site.config['rp_tag_index']
-        
-        dir = site.config['rp_tag_dir']
+        return unless site.config["rp_tag_index"]
+
+        dir = site.config["rp_tag_dir"]
         tags = rps_by_tag(site)
-        tags.each_pair { |tag, pages| 
+        tags.each_pair { |tag, pages|
           site.pages << TagIndex.new(site, site.source, File.join(dir, tag.dir), tag, pages)
         }
       end
 
       # Returns a hash of tags => [pages with tag]
-      def rps_by_tag(site) 
+      private def rps_by_tag(site)
         tag_ref = Hash.new { |hash, key| hash[key] = Set.new }
-        site.collections[RpLogGenerator::RP_KEY].docs.each { |page| 
-            page.data['rp_tags'].each { |tag| tag_ref[tag] << page }
+        site.collections[RpLogGenerator.rp_key].docs.each { |page|
+            page.data["rp_tags"].each { |tag| tag_ref[tag] << page }
           }
         return tag_ref
       end
-
     end
   end
 end

data/lib/jekyll/rp_logs/rp_tasks.rb

@@ -1,4 +1,4 @@
-require 'rake'
+require "rake"
 
 module Jekyll
   module RpLogs
@@ -21,7 +21,7 @@ module Jekyll
       # Octopress
       def ask(message, valid_options)
         if valid_options
-          answer = get_stdin("#{message} #{valid_options.to_s.gsub(/"/, '').gsub(/, /,'/')} ") while !valid_options.include?(answer)
+          answer = get_stdin("#{message} #{valid_options.to_s.gsub(/"/, '').gsub(/, /, '/')} ") until valid_options.include?(answer)
         else
           answer = get_stdin(message)
         end
@@ -30,11 +30,10 @@ module Jekyll
 
       def install_tasks
         namespace :rp_logs do
+          directory "_rps"
 
-          directory '_rps'
-
-          desc 'Create a new Jekyll site for RP logs, with the default theme'
-          task :new do |args|
+          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

data/lib/jekyll/rp_logs/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module RpLogs
-    VERSION = "0.1.6"
+    VERSION = "0.2.0"
   end
 end

data/lib/jekyll/rp_logs.rb

@@ -1,18 +1,17 @@
 require "jekyll/rp_logs/version"
-require 'jekyll'
+require "jekyll"
 
 module Jekyll
   module RpLogs
-
   end
 end
 
 # Require the main converter plugin first
-require 'jekyll/rp_logs/rp_log_converter'
-require 'jekyll/rp_logs/rp_tag_index'
+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 }
 
 # Require the rake tasks
-require 'jekyll/rp_logs/rp_tasks'
+require "jekyll/rp_logs/rp_tasks"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rp_logs
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - anrodger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -59,8 +101,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
 - ".themes/default/source/_config.yml.default"
 - ".themes/default/source/_includes/footer.html"
 - ".themes/default/source/_includes/head.html"
@@ -79,6 +124,8 @@ files:
 - ".themes/default/source/css/main.scss"
 - ".themes/default/source/index.html"
 - ".themes/default/source/js/toggle_ooc.js"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -94,6 +141,8 @@ files:
 - lib/jekyll/rp_logs/parse_weechat.rb
 - lib/jekyll/rp_logs/rp_arcs.rb
 - lib/jekyll/rp_logs/rp_log_converter.rb
+- 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_index.rb
 - lib/jekyll/rp_logs/rp_tags.rb
@@ -109,9 +158,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="