wikimovia 0.0.4 → 0.0.5

data/lib/wikimovia/formatters/date_formatter.rb

@@ -0,0 +1,26 @@
+module Wikimovia
+  module Formatters
+    class DateFormatter
+      include Wikimovia::Utilities
+      
+      FILM_DATE_PATTERN = /\{\{film date\|(.*)\}\}/m
+      YEAR_PATTERN      = /^\d{4}$/
+
+      # Formats a date string based on the following conditions:
+      # * If it is of the format {film date|year|month|day}, it will return a
+      #   {Date} matching those values.
+      # * If it is a year, it will return the year.
+      # * Otherwise it returns the string as it was.
+      def format(string)
+        case string
+        when YEAR_PATTERN then string.to_i
+        when FILM_DATE_PATTERN
+          string  = extract_pattern(FILM_DATE_PATTERN, string)
+          numbers = string.split('|').map(&:to_i)
+          Date.new(numbers[0], numbers[1], numbers[2])
+        else string
+        end
+      end
+    end
+  end
+end

data/lib/wikimovia/formatters/link_formatter.rb

@@ -0,0 +1,29 @@
+module Wikimovia
+  module Formatters
+    class LinkFormatter
+      include Wikimovia::Utilities
+
+      PATTERN      = /\[\[(.*)\]\]/
+      LINK_PATTERN = /^.*\|(.*)$/
+
+      class <<self
+        def match?(string)
+          string.match(PATTERN) ? true : false
+        end
+      end
+
+      # If the string provided is wrapped in '[[' and ']]', returns the
+      # contents of those wrappers. If it is of the format
+      # [linked article|link name] it will return the link name.
+      def format(string)
+        contents = extract_pattern(PATTERN, string)
+
+        if contents.match(LINK_PATTERN)
+          extract_pattern(LINK_PATTERN, contents)
+        else
+          contents
+        end
+      end
+    end
+  end
+end

data/lib/wikimovia/formatters/plainlist_formatter.rb

@@ -0,0 +1,21 @@
+module Wikimovia
+  module Formatters
+    class PlainlistFormatter
+      include Wikimovia::Utilities
+
+      PATTERN = Wikimovia::Utilities.template_regex('plainlist')
+
+      def self.match?(string)
+        string.match(PATTERN) ? true : false
+      end
+
+      # Returns plainlist items as an array.
+      def format(string)
+        string = extract_pattern(PATTERN, string)
+        string.strip!
+        link_formatter = LinkFormatter.new
+        string.split('*').reject(&:empty?).map(&:strip)
+      end
+    end
+  end
+end

data/lib/wikimovia/formatters/time_formatter.rb

@@ -0,0 +1,19 @@
+module Wikimovia
+  module Formatters
+    class TimeFormatter
+      include Wikimovia::Utilities
+
+      MINUTES_PATTERN = /^(\d+) minutes$/
+
+      # If the string matches the pattern of 'NUMBER minutes', returns NUMBER.
+      # otherwise returns the string.
+      def format(string)
+        case string
+        when MINUTES_PATTERN
+          extract_pattern(MINUTES_PATTERN, string).to_i * 60
+        else string
+        end
+      end
+    end
+  end
+end

data/lib/wikimovia/template_extractor.rb

@@ -0,0 +1,53 @@
+module Wikimovia
+  class TemplateExtractor
+    include Wikimovia::Utilities
+
+    # Given some wikitext syntax, and a :template_name, extracts the first
+    # template with that name it can find and converts it to a {Hash}.
+    def extract_first(string, options = {})
+      pattern = Wikimovia::Utilities.template_regex options[:template_name],
+        use_vertical_bar: false
+
+      wikitext = WikiCloth::Parser.new(data: string).to_wikitext
+      template = extract_pattern(pattern, wikitext)
+
+      if template
+        info_lines     = extract_info_lines(template)
+        split_lines    = split_infolines(info_lines)
+        cleaned_lines  = clean_infolines(split_lines)
+        filtered_lines = filter_infolines(cleaned_lines)
+        hash = Hash[*filtered_lines.flatten]
+        hash.keys.each do |key|
+          hash[(key.to_sym rescue key) || key] = hash.delete(key)
+        end
+        hash
+      end
+    end
+
+    private
+
+    # Get all info lines and reject any empty ones.
+    def extract_info_lines(string)
+      string.split(/\n^\|/).reject(&:empty?)
+    end
+
+    # Take each infoline and split it into an array of [key, value]
+    def split_infolines(info_lines)
+      info_lines.map { |info_line| info_line.split("=") }
+    end
+
+    # Take each info line array and strip each of its values
+    def clean_infolines(info_lines)
+      info_lines.map do |info_line|
+        info_line.map(&:strip)
+      end
+    end
+
+    # Remove any infolines that don't have both a key and a value.
+    def filter_infolines(info_lines)
+      info_lines.
+        reject { |line| line.any?(&:empty?) }.
+        reject { |line| line.size != 2  }
+    end
+  end
+end

data/lib/wikimovia/utilities.rb

@@ -0,0 +1,16 @@
+module Wikimovia
+  module Utilities
+    def self.template_regex(template_name, options = {})
+      options[:use_vertical_bar] = true if options[:use_vertical_bar].nil?
+      if options[:use_vertical_bar]
+        /\{\{#{template_name}.*\|(.*)\n\}\}/m
+      else
+        /\{\{#{template_name}(.*)\n\}\}/m
+      end
+    end
+
+    def extract_pattern(pattern, string)
+      string.scan(pattern).flatten.compact.first
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikimovia
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -49,6 +49,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/wikimovia/formatters/date_formatter.rb
+- lib/wikimovia/formatters/link_formatter.rb
+- lib/wikimovia/formatters/plainlist_formatter.rb
+- lib/wikimovia/formatters/time_formatter.rb
+- lib/wikimovia/template_extractor.rb
+- lib/wikimovia/utilities.rb
 - lib/wikimovia.rb
 homepage: https://github.com/alex-tan/wikimovia
 licenses: []