jekyll-import 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27f5a0ab9d87425b92a6e1a4fbc01c5c87c64626
-  data.tar.gz: 4c3382d2e508f6fd6571fa45f1a01f1c804cf69d
+  metadata.gz: 4e855d9fab183b0627590b601d2773b2c03deab6
+  data.tar.gz: f167d6f4b2a76aa9ccb9d03bf8c263c4f3c0d8e4
 SHA512:
-  metadata.gz: 5ec278c744142928a3db648710bae5313ad6a7c78dfc948a382c50ed30122e4d0c03324a31ddfc41dd9ad99512ea6879fc7ed9a093779c473ea36703a0743aef
-  data.tar.gz: b63caa7a81fc42055d663b94b0f9e9e798bdb2459e9782268bbd938288f8b15b633afba6b1719a58c0f349e21e27bec46ea9413a03cb3e8c00af5cdc4048a44f
+  metadata.gz: 0de306ccd211d7c972362ba8624ff747f3a73e6c4cac5019cdf0c6c8d3253c1ca0fdcdc077ce2bd7372bac297da0ca8f1f16a927b34c2dd6788893f7cb0fff85
+  data.tar.gz: 02fed28e00f8920850e0006d814ad6087a3664332679fd929f38b994bc6bd7941a4319710fcfc478cc98f434161a036d0b2b764259aeb5df88166486a9476ad1

data/lib/jekyll-import.rb

@@ -1,12 +1,14 @@
-$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
-require 'rubygems'
-require 'jekyll'
-require 'jekyll/commands/import'
-require 'colorator'
+# For use/testing when no gem is installed
+$LOAD_PATH.unshift __dir__
 
-require 'jekyll-import/importer'
-require 'jekyll-import/importers'
-require 'jekyll-import/util'
+require "rubygems"
+require "jekyll"
+require "jekyll/commands/import"
+require "colorator"
+
+require "jekyll-import/importer"
+require "jekyll-import/importers"
+require "jekyll-import/util"
 
 module JekyllImport
   # Public: Add the subcommands for each importer

data/lib/jekyll-import/importer.rb

@@ -11,7 +11,7 @@ module JekyllImport
     def self.stringify_keys(hash)
       the_hash = hash.clone
       the_hash.keys.each do |key|
-        the_hash[(key.to_s rescue key) || key] =  the_hash.delete(key)
+        the_hash[(key.to_s rescue key) || key] = the_hash.delete(key)
       end
       the_hash
     end

data/lib/jekyll-import/importers.rb

@@ -1,6 +1,6 @@
 module JekyllImport
   module Importers
-    Dir.chdir(File.expand_path(File.join("importers"), File.dirname(__FILE__))) do
+    Dir.chdir(File.expand_path(File.join("importers"), __dir__)) do
       Dir.entries(".").each do |f|
         next if f[0..0].eql?(".")
         require "jekyll-import/importers/#{f}"

data/lib/jekyll-import/importers/behance.rb

@@ -2,22 +2,22 @@ module JekyllImport
   module Importers
     class Behance < Importer
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           fileutils
           safe_yaml
           date
           time
           behance
-        ])
+        ))
       end
 
       def self.specify_options(c)
-        c.option 'user', '--user NAME', 'The username of the account'
-        c.option 'api_token', '--api_token TOKEN', 'The API access token for the account'
+        c.option "user", "--user NAME", "The username of the account"
+        c.option "api_token", "--api_token TOKEN", "The API access token for the account"
       end
 
       def self.validate(options)
-        %w[user api_token].each do |option|
+        %w(user api_token).each do |option|
           if options[option].nil?
             abort "Missing mandatory option --#{option}."
           end
@@ -31,8 +31,8 @@ module JekyllImport
       #
       # Returns nothing.
       def self.process(options)
-        user  = options.fetch('user')
-        token = options.fetch('api_token')
+        user  = options.fetch("user")
+        token = options.fetch("api_token")
 
         client = fetch_behance(token)
 
@@ -41,21 +41,20 @@ module JekyllImport
         puts "#{user_projects.length} project(s) found. Importing now..."
 
         user_projects.each do |project|
-
-          details = client.project(project['id'])
-          title   = project['name'].to_s
-          formatted_date = Time.at(project['published_on'].to_i).to_date.to_s
+          details = client.project(project["id"])
+          title   = project["name"].to_s
+          formatted_date = Time.at(project["published_on"].to_i).to_date.to_s
 
           post_name = title.split(%r{ |!|/|:|&|-|$|,}).map do |character|
             character.downcase unless character.empty?
-          end.compact.join('-')
+          end.compact.join("-")
 
           name = "#{formatted_date}-#{post_name}"
 
           header = {
-            "layout" => "post",
-            "title" => title,
-            "details" => details
+            "layout"  => "post",
+            "title"   => title,
+            "details" => details,
           }
 
           FileUtils.mkdir_p("_posts")
@@ -63,17 +62,18 @@ module JekyllImport
           File.open("_posts/#{name}.md", "w") do |f|
             f.puts header.to_yaml
             f.puts "---\n\n"
-            f.puts details['description'].to_s
+            f.puts details["description"].to_s
           end
         end
 
         puts "Finished importing."
       end
 
-      private
-
-      def self.fetch_behance(token)
-        ::Behance::Client.new(access_token: token)
+      class << self
+        private
+        def fetch_behance(token)
+          ::Behance::Client.new(:access_token => token)
+        end
       end
     end
   end

data/lib/jekyll-import/importers/blogger.rb

@@ -2,22 +2,22 @@ module JekyllImport
   module Importers
     class Blogger < Importer
       def self.specify_options(c)
-        c.option 'source', '--source NAME', 'The XML file (blog-MM-DD-YYYY.xml) path to import'
-        c.option 'no-blogger-info', '--no-blogger-info', 'not to leave blogger-URL info (id and old URL) in the front matter (default: false)'
-        c.option 'replace-internal-link', '--replace-internal-link', 'replace internal links using the post_url liquid tag. (default: false)'
-        c.option 'comments', '--comments', 'import comments to _comments collection'
+        c.option "source", "--source NAME", "The XML file (blog-MM-DD-YYYY.xml) path to import"
+        c.option "no-blogger-info", "--no-blogger-info", "not to leave blogger-URL info (id and old URL) in the front matter (default: false)"
+        c.option "replace-internal-link", "--replace-internal-link", "replace internal links using the post_url liquid tag. (default: false)"
+        c.option "comments", "--comments", "import comments to _comments collection"
       end
 
       def self.validate(options)
-        if options['source'].nil?
-          raise 'Missing mandatory option: --source'
-        elsif not File.exist?(options['source'])
-          raise Errno::ENOENT, "File not found: #{options['source']}"
+        if options["source"].nil?
+          raise "Missing mandatory option: --source"
+        elsif !File.exist?(options["source"])
+          raise Errno::ENOENT, "File not found: #{options["source"]}"
         end
       end
 
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           rexml/document
           rexml/streamlistener
           rexml/parsers/streamparser
@@ -26,7 +26,7 @@ module JekyllImport
           fileutils
           safe_yaml
           open-uri
-        ])
+        ))
       end
 
       # Process the import.
@@ -37,19 +37,19 @@ module JekyllImport
       #
       # Returns nothing.
       def self.process(options)
-        source = options.fetch('source')
+        source = options.fetch("source")
 
         listener = BloggerAtomStreamListener.new
 
-        listener.leave_blogger_info = ! options.fetch('no-blogger-info', false),
-        listener.comments = options.fetch('comments', false),
+        listener.leave_blogger_info = !options.fetch("no-blogger-info", false),
+        listener.comments = options.fetch("comments", false),
 
-        File.open(source, 'r') do |f|
+        File.open(source, "r") do |f|
           f.flock(File::LOCK_SH)
-          REXML::Parsers::StreamParser.new(f, listener).parse()
+          REXML::Parsers::StreamParser.new(f, listener).parse
         end
 
-        options['original-url-base'] = listener.original_url_base
+        options["original-url-base"] = listener.original_url_base
 
         postprocess(options)
       end
@@ -61,27 +61,27 @@ module JekyllImport
       # Returns nothing.
       def self.postprocess(options)
         # Replace internal link URL
-        if options.fetch('replace-internal-link', false)
-          original_url_base = options.fetch('original-url-base', nil)
+        if options.fetch("replace-internal-link", false)
+          original_url_base = options.fetch("original-url-base", nil)
           if original_url_base
             orig_url_pattern = Regexp.new(" href=([\"\'])(?:#{Regexp.escape(original_url_base)})?/([0-9]{4})/([0-9]{2})/([^\"\']+\.html)\\1")
 
-            Dir.glob('_posts/*.*') do |filename|
+            Dir.glob("_posts/*.*") do |filename|
               body = nil
-              File.open(filename, 'r') do |f|
+              File.open(filename, "r") do |f|
                 f.flock(File::LOCK_SH)
                 body = f.read
               end
 
               body.gsub!(orig_url_pattern) do
                 # for post_url
-                quote = $1
-                post_file = Dir.glob("_posts/#{$2}-#{$3}-*-#{$4.to_s.tr('/', '-')}").first
-                raise "Could not found: _posts/#{$2}-#{$3}-*-#{$4.to_s.tr('/', '-')}" if post_file.nil?
-                " href=#{quote}{{ site.baseurl }}{% post_url #{File.basename(post_file, '.html')} %}#{quote}"
+                quote = Regexp.last_match(1)
+                post_file = Dir.glob("_posts/#{Regexp.last_match(2)}-#{Regexp.last_match(3)}-*-#{Regexp.last_match(4).to_s.tr("/", "-")}").first
+                raise "Could not found: _posts/#{Regexp.last_match(2)}-#{Regexp.last_match(3)}-*-#{Regexp.last_match(4).to_s.tr("/", "-")}" if post_file.nil?
+                " href=#{quote}{{ site.baseurl }}{% post_url #{File.basename(post_file, ".html")} %}#{quote}"
               end
 
-              File.open(filename, 'w') do |f|
+              File.open(filename, "w") do |f|
                 f.flock(File::LOCK_EX)
                 f << body
               end
@@ -110,45 +110,45 @@ module JekyllImport
           @tag_bread.push(tag)
 
           case tag
-          when 'entry'
-            raise 'nest entry element' if @in_entry_elem
-            @in_entry_elem = {:meta => {}, :body => nil}
-          when 'title'
+          when "entry"
+            raise "nest entry element" if @in_entry_elem
+            @in_entry_elem = { :meta => {}, :body => nil }
+          when "title"
             if @in_entry_elem
-              raise 'only <title type="text"></title> is supported' if attrs['type'] != 'text'
+              raise 'only <title type="text"></title> is supported' if attrs["type"] != "text"
             end
-          when 'category'
+          when "category"
             if @in_entry_elem
-              if attrs['scheme'] == 'http://www.blogger.com/atom/ns#'
+              if attrs["scheme"] == "http://www.blogger.com/atom/ns#"
                 @in_entry_elem[:meta][:category] = [] unless @in_entry_elem[:meta][:category]
-                @in_entry_elem[:meta][:category] << attrs['term']
-              elsif attrs['scheme'] == 'http://schemas.google.com/g/2005#kind'
-                kind = attrs['term']
-                kind.sub!(Regexp.new("^http://schemas\\.google\\.com/blogger/2008/kind\\#"), '')
+                @in_entry_elem[:meta][:category] << attrs["term"]
+              elsif attrs["scheme"] == "http://schemas.google.com/g/2005#kind"
+                kind = attrs["term"]
+                kind.sub!(Regexp.new("^http://schemas\\.google\\.com/blogger/2008/kind\\#"), "")
                 @in_entry_elem[:meta][:kind] = kind
               end
             end
-          when 'content'
+          when "content"
             if @in_entry_elem
-              @in_entry_elem[:meta][:content_type] = attrs['type']
+              @in_entry_elem[:meta][:content_type] = attrs["type"]
             end
-          when 'link'
+          when "link"
             if @in_entry_elem
-              if attrs['rel'] == 'alternate' && attrs['type'] == 'text/html'
-                @in_entry_elem[:meta][:original_url] = attrs['href']
-              elsif attrs['rel'] == 'replies' && attrs['type'] == 'text/html'
+              if attrs["rel"] == "alternate" && attrs["type"] == "text/html"
+                @in_entry_elem[:meta][:original_url] = attrs["href"]
+              elsif attrs["rel"] == "replies" && attrs["type"] == "text/html"
                 unless @in_entry_elem[:meta][:original_url]
-                  @in_entry_elem[:meta][:original_url] = attrs['href'].sub(/\#comment-form$/, '')
+                  @in_entry_elem[:meta][:original_url] = attrs["href"].sub(%r!\#comment-form$!, "")
                 end
               end
             end
-          when 'media:thumbnail'
+          when "media:thumbnail"
             if @in_entry_elem
-              @in_entry_elem[:meta][:thumbnail] = attrs['url']
+              @in_entry_elem[:meta][:thumbnail] = attrs["url"]
             end
-          when 'thr:in-reply-to'
+          when "thr:in-reply-to"
             if @in_entry_elem
-              @in_entry_elem[:meta][:post_id] = attrs['ref']
+              @in_entry_elem[:meta][:post_id] = attrs["ref"]
             end
           end
         end
@@ -156,23 +156,23 @@ module JekyllImport
         def text(text)
           if @in_entry_elem
             case @tag_bread.last
-            when 'id'
+            when "id"
               @in_entry_elem[:meta][:id] = text
-            when 'published'
+            when "published"
               @in_entry_elem[:meta][:published] = text
-            when 'updated'
+            when "updated"
               @in_entry_elem[:meta][:updated] = text
-            when 'title'
+            when "title"
               @in_entry_elem[:meta][:title] = text
-            when 'content'
+            when "content"
               @in_entry_elem[:body] = text
-            when 'name'
-              if @tag_bread[-2..-1] == %w[author name]
+            when "name"
+              if @tag_bread[-2..-1] == %w(author name)
                 @in_entry_elem[:meta][:author] = text
               end
-            when 'app:draft'
-              if @tag_bread[-2..-1] == %w[app:control app:draft]
-                @in_entry_elem[:meta][:draft] = true if text == 'yes'
+            when "app:draft"
+              if @tag_bread[-2..-1] == %w(app:control app:draft)
+                @in_entry_elem[:meta][:draft] = true if text == "yes"
               end
             end
           end
@@ -180,20 +180,20 @@ module JekyllImport
 
         def tag_end(tag)
           case tag
-          when 'entry'
-            raise 'nest entry element' unless @in_entry_elem
+          when "entry"
+            raise "nest entry element" unless @in_entry_elem
 
-            if @in_entry_elem[:meta][:kind] == 'post'
+            if @in_entry_elem[:meta][:kind] == "post"
               post_data = get_post_data_from_in_entry_elem_info
 
               if post_data
-                target_dir = '_posts'
-                target_dir = '_drafts' if @in_entry_elem[:meta][:draft]
+                target_dir = "_posts"
+                target_dir = "_drafts" if @in_entry_elem[:meta][:draft]
 
                 FileUtils.mkdir_p(target_dir)
 
-                file_name = URI::decode("#{post_data[:filename]}.html")
-                File.open(File.join(target_dir, file_name), 'w') do |f|
+                file_name = URI.decode("#{post_data[:filename]}.html")
+                File.open(File.join(target_dir, file_name), "w") do |f|
                   f.flock(File::LOCK_EX)
 
                   f << post_data[:header].to_yaml
@@ -201,16 +201,16 @@ module JekyllImport
                   f << post_data[:body]
                 end
               end
-            elsif @in_entry_elem[:meta][:kind] == 'comment' and @comments
+            elsif @in_entry_elem[:meta][:kind] == "comment" && @comments
               post_data = get_post_data_from_in_entry_elem_info
 
               if post_data
-                target_dir = '_comments'
+                target_dir = "_comments"
 
                 FileUtils.mkdir_p(target_dir)
 
-                file_name = URI::decode("#{post_data[:filename]}.html")
-                File.open(File.join(target_dir, file_name), 'w') do |f|
+                file_name = URI.decode("#{post_data[:filename]}.html")
+                File.open(File.join(target_dir, file_name), "w") do |f|
                   f.flock(File::LOCK_EX)
 
                   f << post_data[:header].to_yaml
@@ -227,104 +227,94 @@ module JekyllImport
         end
 
         def get_post_data_from_in_entry_elem_info
-          if (@in_entry_elem.nil? || ! @in_entry_elem.has_key?(:meta) || ! @in_entry_elem[:meta].has_key?(:kind))
+          if @in_entry_elem.nil? || !@in_entry_elem.key?(:meta) || !@in_entry_elem[:meta].key?(:kind)
             nil
-          elsif @in_entry_elem[:meta][:kind] == 'post'
-            timestamp = Time.parse(@in_entry_elem[:meta][:published]).strftime('%Y-%m-%d')
+          elsif @in_entry_elem[:meta][:kind] == "post"
+            timestamp = Time.parse(@in_entry_elem[:meta][:published]).strftime("%Y-%m-%d")
             if @in_entry_elem[:meta][:original_url]
               original_uri = URI.parse(@in_entry_elem[:meta][:original_url])
               original_path = original_uri.path.to_s
-              filename = "%s-%s" %
-                [timestamp,
-                 File.basename(original_path, File.extname(original_path))]
+              filename = format("%s-%s", timestamp, File.basename(original_path, File.extname(original_path)))
 
               @original_url_base = "#{original_uri.scheme}://#{original_uri.host}"
             elsif @in_entry_elem[:meta][:draft]
               # Drafts don't have published urls
               name = @in_entry_elem[:meta][:title]
-              if name.nil?
-                filename = timestamp
-              else
-                filename = "%s-%s" %
-                  [timestamp,
-                   CGI.escape(name.downcase).tr('+','-')]
-              end
+              filename = if name.nil?
+                           timestamp
+                         else
+                           format("%s-%s", timestamp, CGI.escape(name.downcase.tr("+/\\:'\"<>{}?%*|.", "-")))
+                         end
             else
-              raise 'Original URL is missing'
+              raise "Original URL is missing"
             end
 
             header = {
-              'layout' => 'post',
-              'title' => @in_entry_elem[:meta][:title],
-              'date' => @in_entry_elem[:meta][:published],
-              'author' => @in_entry_elem[:meta][:author],
-              'tags' => @in_entry_elem[:meta][:category],
+              "layout" => "post",
+              "title"  => @in_entry_elem[:meta][:title],
+              "date"   => @in_entry_elem[:meta][:published],
+              "author" => @in_entry_elem[:meta][:author],
+              "tags"   => @in_entry_elem[:meta][:category],
             }
-            header['modified_time'] = @in_entry_elem[:meta][:updated] if @in_entry_elem[:meta][:updated] && @in_entry_elem[:meta][:updated] != @in_entry_elem[:meta][:published]
-            header['thumbnail'] = @in_entry_elem[:meta][:thumbnail] if @in_entry_elem[:meta][:thumbnail]
-            header['blogger_id'] = @in_entry_elem[:meta][:id] if @leave_blogger_info
-            header['blogger_orig_url'] = @in_entry_elem[:meta][:original_url] if @leave_blogger_info && @in_entry_elem[:meta][:original_url]
+            header["modified_time"] = @in_entry_elem[:meta][:updated] if @in_entry_elem[:meta][:updated] && @in_entry_elem[:meta][:updated] != @in_entry_elem[:meta][:published]
+            header["thumbnail"] = @in_entry_elem[:meta][:thumbnail] if @in_entry_elem[:meta][:thumbnail]
+            header["blogger_id"] = @in_entry_elem[:meta][:id] if @leave_blogger_info
+            header["blogger_orig_url"] = @in_entry_elem[:meta][:original_url] if @leave_blogger_info && @in_entry_elem[:meta][:original_url]
 
             body = @in_entry_elem[:body]
 
             # body escaping associated with liquid
-            if body =~ /{{/
-              body.gsub!(/{{/, '{{ "{{" }}')
+            if body =~ %r!{{!
+              body.gsub!(%r!{{!, '{{ "{{" }}')
             end
-            if body =~ /{%/
-              body.gsub!(/{%/, '{{ "{%" }}')
+            if body =~ %r!{%!
+              body.gsub!(%r!{%!, '{{ "{%" }}')
             end
 
             { :filename => filename, :header => header, :body => body }
-          elsif @in_entry_elem[:meta][:kind] == 'comment'
-            timestamp = Time.parse(@in_entry_elem[:meta][:published]).strftime('%Y-%m-%d')
+          elsif @in_entry_elem[:meta][:kind] == "comment"
+            timestamp = Time.parse(@in_entry_elem[:meta][:published]).strftime("%Y-%m-%d")
             if @in_entry_elem[:meta][:original_url]
-              if not @comment_seq
+              unless @comment_seq
                 @comment_seq = 1
               end
 
               original_uri = URI.parse(@in_entry_elem[:meta][:original_url])
               original_path = original_uri.path.to_s
-              filename = "%s-%s-%s" %
-                [timestamp,
-                 File.basename(original_path, File.extname(original_path)),
-                 @comment_seq]
+              filename = format("%s-%s-%s", timestamp, File.basename(original_path, File.extname(original_path)), @comment_seq)
 
-              @comment_seq = @comment_seq + 1
+              @comment_seq += 1
 
               @original_url_base = "#{original_uri.scheme}://#{original_uri.host}"
             else
-              raise 'Original URL is missing'
+              raise "Original URL is missing"
             end
 
             header = {
-              'date' => @in_entry_elem[:meta][:published],
-              'author' => @in_entry_elem[:meta][:author],
-              'blogger_post_id' => @in_entry_elem[:meta][:post_id],
+              "date"            => @in_entry_elem[:meta][:published],
+              "author"          => @in_entry_elem[:meta][:author],
+              "blogger_post_id" => @in_entry_elem[:meta][:post_id],
             }
-            header['modified_time'] = @in_entry_elem[:meta][:updated] if @in_entry_elem[:meta][:updated] && @in_entry_elem[:meta][:updated] != @in_entry_elem[:meta][:published]
-            header['thumbnail'] = @in_entry_elem[:meta][:thumbnail] if @in_entry_elem[:meta][:thumbnail]
-            header['blogger_id'] = @in_entry_elem[:meta][:id] if @leave_blogger_info
-            header['blogger_orig_url'] = @in_entry_elem[:meta][:original_url] if @leave_blogger_info && @in_entry_elem[:meta][:original_url]
+            header["modified_time"] = @in_entry_elem[:meta][:updated] if @in_entry_elem[:meta][:updated] && @in_entry_elem[:meta][:updated] != @in_entry_elem[:meta][:published]
+            header["thumbnail"] = @in_entry_elem[:meta][:thumbnail] if @in_entry_elem[:meta][:thumbnail]
+            header["blogger_id"] = @in_entry_elem[:meta][:id] if @leave_blogger_info
+            header["blogger_orig_url"] = @in_entry_elem[:meta][:original_url] if @leave_blogger_info && @in_entry_elem[:meta][:original_url]
 
             body = @in_entry_elem[:body]
 
             # body escaping associated with liquid
-            if body =~ /{{/
-              body.gsub!(/{{/, '{{ "{{" }}')
+            if body =~ %r!{{!
+              body.gsub!(%r!{{!, '{{ "{{" }}')
             end
-            if body =~ /{%/
-              body.gsub!(/{%/, '{{ "{%" }}')
+            if body =~ %r!{%!
+              body.gsub!(%r!{%!, '{{ "{%" }}')
             end
 
             { :filename => filename, :header => header, :body => body }
-          else
-            nil
           end
         end
 
       end
-
     end
   end
 end