jekyll-import 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a826b9d776a9cefe30d3b508c1c43b2df20f547747347dc19977bf874d78990
-  data.tar.gz: d71199a3e140201b618fc50dafea0c9e88c1017cc8bc1c641ea0fe74a6df764a
+  metadata.gz: 5dc36b6cb2508c37bc5af40022d3a56f75c5ccaf1ae60ab631db9986f4d0a799
+  data.tar.gz: c0ab3fd214f121e75e5388143344a2c5501d2e81e1205db004c8510c01e2ae1c
 SHA512:
-  metadata.gz: 24ca8cf7716b0affb0e5f33298728c1c66d3767a18d7997c96c70ee7c36fac23aedc4545277a0f74e3d26478c460a5d28d39a8cc331499cfa6d633871f5124b6
-  data.tar.gz: 7817b54acf9f131dfe7ed1896ea616e89d8b0818be7db9a39f42e73be9bb822fc4ce16d68bf0c0d8ffc00700d1e7e271b14db8d5a061567fa53379fcd757fa30
+  metadata.gz: c0701c36d3cf270e612e1d8292447b870e3c6a3db0904d57b8f3c5a4fedb195fa6586aa840e666b325fc291f15fca95d1a17fe05e6556a95ef59c7128784e732
+  data.tar.gz: 5355d89fbe103c753cc9b48ac6d3f398e6a980a1a86a0e19e69ba0e8cc3967a188db6ba45eb515e3a711a2e55b23f768c3b3583534b6ec8760010828bc855c8b

data/lib/jekyll-import.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # For use/testing when no gem is installed
 $LOAD_PATH.unshift __dir__
 

data/lib/jekyll-import/importer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllImport
   class Importer
     def self.inherited(base)
@@ -18,9 +20,9 @@ module JekyllImport
 
     def self.run(options = {})
       opts = stringify_keys(options)
-      self.require_deps
-      self.validate(opts) if self.respond_to?(:validate)
-      self.process(opts)
+      require_deps
+      validate(opts) if respond_to?(:validate)
+      process(opts)
     end
   end
 end

data/lib/jekyll-import/importers.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module JekyllImport
   module Importers
     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}"
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllImport
   module Importers
     class Behance < Importer
@@ -12,15 +14,13 @@ module JekyllImport
       end
 
       def self.specify_options(c)
-        c.option "user", "--user NAME", "The username of 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|
-          if options[option].nil?
-            abort "Missing mandatory option --#{option}."
-          end
+          abort "Missing mandatory option --#{option}." if options[option].nil?
         end
       end
 
@@ -38,7 +38,7 @@ module JekyllImport
 
         user_projects = client.user_projects(user)
 
-        puts "#{user_projects.length} project(s) found. Importing now..."
+        Jekyll.logger.info "#{user_projects.length} project(s) found. Importing now..."
 
         user_projects.each do |project|
           details = client.project(project["id"])
@@ -66,11 +66,12 @@ module JekyllImport
           end
         end
 
-        puts "Finished importing."
+        Jekyll.logger.info "Finished importing."
       end
 
       class << self
         private
+
         def fetch_behance(token)
           ::Behance::Client.new(:access_token => token)
         end

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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 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)
@@ -41,8 +43,8 @@ module JekyllImport
 
         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|
           f.flock(File::LOCK_SH)
@@ -78,6 +80,7 @@ module JekyllImport
                 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
 
@@ -106,12 +109,13 @@ module JekyllImport
         attr_reader :original_url_base
 
         def tag_start(tag, attrs)
-          @tag_bread = [] unless @tag_bread
+          @tag_bread ||= []
           @tag_bread.push(tag)
 
           case tag
           when "entry"
             raise "nest entry element" if @in_entry_elem
+
             @in_entry_elem = { :meta => {}, :body => nil }
           when "title"
             if @in_entry_elem
@@ -129,9 +133,7 @@ module JekyllImport
               end
             end
           when "content"
-            if @in_entry_elem
-              @in_entry_elem[:meta][:content_type] = attrs["type"]
-            end
+            @in_entry_elem[:meta][:content_type] = attrs["type"] if @in_entry_elem
           when "link"
             if @in_entry_elem
               if attrs["rel"] == "alternate" && attrs["type"] == "text/html"
@@ -143,13 +145,9 @@ module JekyllImport
               end
             end
           when "media:thumbnail"
-            if @in_entry_elem
-              @in_entry_elem[:meta][:thumbnail] = attrs["url"]
-            end
+            @in_entry_elem[:meta][:thumbnail] = attrs["url"] if @in_entry_elem
           when "thr:in-reply-to"
-            if @in_entry_elem
-              @in_entry_elem[:meta][:post_id] = attrs["ref"]
-            end
+            @in_entry_elem[:meta][:post_id] = attrs["ref"] if @in_entry_elem
           end
         end
 
@@ -167,9 +165,7 @@ module JekyllImport
             when "content"
               @in_entry_elem[:body] = text
             when "name"
-              if @tag_bread[-2..-1] == %w(author name)
-                @in_entry_elem[:meta][:author] = text
-              end
+              @in_entry_elem[:meta][:author] = text if @tag_bread[-2..-1] == %w(author name)
             when "app:draft"
               if @tag_bread[-2..-1] == %w(app:control app:draft)
                 @in_entry_elem[:meta][:draft] = true if text == "yes"
@@ -184,7 +180,7 @@ module JekyllImport
             raise "nest entry element" unless @in_entry_elem
 
             if @in_entry_elem[:meta][:kind] == "post"
-              post_data = get_post_data_from_in_entry_elem_info
+              post_data = post_data_from_in_entry_elem_info
 
               if post_data
                 target_dir = "_posts"
@@ -202,7 +198,7 @@ module JekyllImport
                 end
               end
             elsif @in_entry_elem[:meta][:kind] == "comment" && @comments
-              post_data = get_post_data_from_in_entry_elem_info
+              post_data = post_data_from_in_entry_elem_info
 
               if post_data
                 target_dir = "_comments"
@@ -226,7 +222,7 @@ module JekyllImport
           @tag_bread.pop
         end
 
-        def get_post_data_from_in_entry_elem_info
+        def post_data_from_in_entry_elem_info
           if @in_entry_elem.nil? || !@in_entry_elem.key?(:meta) || !@in_entry_elem[:meta].key?(:kind)
             nil
           elsif @in_entry_elem[:meta][:kind] == "post"
@@ -264,20 +260,14 @@ module JekyllImport
             body = @in_entry_elem[:body]
 
             # body escaping associated with liquid
-            if body =~ %r!{{!
-              body.gsub!(%r!{{!, '{{ "{{" }}')
-            end
-            if body =~ %r!{%!
-              body.gsub!(%r!{%!, '{{ "{%" }}')
-            end
+            body.gsub!(%r!{{!, '{{ "{{" }}') if body =~ %r!{{!
+            body.gsub!(%r!{%!, '{{ "{%" }}') if body =~ %r!{%!
 
             { :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")
             if @in_entry_elem[:meta][:original_url]
-              unless @comment_seq
-                @comment_seq = 1
-              end
+              @comment_seq ||= 1
 
               original_uri = URI.parse(@in_entry_elem[:meta][:original_url])
               original_path = original_uri.path.to_s
@@ -303,17 +293,12 @@ module JekyllImport
             body = @in_entry_elem[:body]
 
             # body escaping associated with liquid
-            if body =~ %r!{{!
-              body.gsub!(%r!{{!, '{{ "{{" }}')
-            end
-            if body =~ %r!{%!
-              body.gsub!(%r!{%!, '{{ "{%" }}')
-            end
+            body.gsub!(%r!{{!, '{{ "{{" }}') if body =~ %r!{{!
+            body.gsub!(%r!{%!, '{{ "{%" }}') if body =~ %r!{%!
 
             { :filename => filename, :header => header, :body => body }
           end
         end
-
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module JekyllImport
   module Importers
@@ -12,7 +12,7 @@ module JekyllImport
       end
 
       def self.specify_options(c)
-        c.option "file", "--file NAME", 'The CSV file to import (default: "posts.csv")'
+        c.option "file",            "--file NAME",       'The CSV file to import (default: "posts.csv")'
         c.option "no-front-matter", "--no-front-matter", "Do not add the default front matter to the post body"
       end
 
@@ -27,6 +27,7 @@ module JekyllImport
 
         ::CSV.foreach(file) do |row|
           next if row[0] == "title" # header
+
           posts += 1
           write_post(CSVPost.new(row), options)
         end
@@ -82,12 +83,12 @@ module JekyllImport
       def self.write_frontmatter(f, post, options)
         no_frontmatter = options.fetch("no-front-matter", false)
         unless no_frontmatter
-          f.puts YAML.dump({
+          f.puts YAML.dump(
             "layout"    => "post",
             "title"     => post.title,
             "date"      => post.published_at.to_s,
-            "permalink" => post.permalink,
-          })
+            "permalink" => post.permalink
+          )
           f.puts "---"
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll-import/importers/drupal_common"
 
 module JekyllImport
@@ -6,11 +8,11 @@ module JekyllImport
       include DrupalCommon
       extend DrupalCommon::ClassMethods
 
-      def self.build_query(prefix, types, engine)
+      def self.build_query(prefix, types, _engine)
         types = types.join("' OR n.type = '")
         types = "n.type = '#{types}'"
 
-        query = <<EOS
+        query = <<SQL
                 SELECT n.nid,
                        n.title,
                        nr.body,
@@ -26,9 +28,9 @@ module JekyllImport
                 WHERE (#{types})
                   AND n.vid = nr.vid
                 GROUP BY n.nid
-EOS
+SQL
 
-        return query
+        query
       end
 
       def self.aliases_query(prefix)
@@ -45,7 +47,7 @@ EOS
           "categories" => tags.split("|"),
         }
 
-        return data, content
+        [data, content]
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll-import/importers/drupal_common"
 
 module JekyllImport
@@ -10,21 +12,21 @@ module JekyllImport
         types = types.join("' OR n.type = '")
         types = "n.type = '#{types}'"
 
-        if engine == "postgresql"
-          tag_group = <<EOS
+        tag_group = if engine == "postgresql"
+                      <<POSTGRESQL
             (SELECT STRING_AGG(td.name, '|')
-            FROM taxonomy_term_data td, taxonomy_index ti
+            FROM #{prefix}taxonomy_term_data td, #{prefix}taxonomy_index ti
             WHERE ti.tid = td.tid AND ti.nid = n.nid) AS tags
-EOS
-        else
-          tag_group = <<EOS
+POSTGRESQL
+                    else
+                      <<SQL
             (SELECT GROUP_CONCAT(td.name SEPARATOR '|')
-            FROM taxonomy_term_data td, taxonomy_index ti
+            FROM #{prefix}taxonomy_term_data td, #{prefix}taxonomy_index ti
             WHERE ti.tid = td.tid AND ti.nid = n.nid) AS 'tags'
-EOS
-        end
+SQL
+                    end
 
-        query = <<EOS
+        query = <<QUERY
                 SELECT n.nid,
                        n.title,
                        fdb.body_value,
@@ -37,9 +39,9 @@ EOS
                 LEFT JOIN #{prefix}field_data_body AS fdb
                   ON fdb.entity_id = n.nid AND fdb.entity_type = 'node'
                 WHERE (#{types})
-EOS
+QUERY
 
-        return query
+        query
       end
 
       def self.aliases_query(prefix)
@@ -56,7 +58,7 @@ EOS
           "categories" => tags.split("|"),
         }
 
-        return data, content
+        [data, content]
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "date"
 
 module JekyllImport
@@ -16,18 +18,21 @@ module JekyllImport
           "password" => "",
           "host"     => "localhost",
           "prefix"   => "",
+          "port"     => "3306",
           "types"    => %w(blog story article),
         }.freeze
 
         def specify_options(c)
-          c.option "engine", "--engine [mysql|postgresql]", "Database engine (default: #{DEFAULTS["engine"].inspect})"
-          c.option "dbname", "--dbname DB", "Database name"
-          c.option "user", "--user USER", "Database user name"
-          c.option "password", "--password PW", "Database user's password (default: #{DEFAULTS["password"].inspect})"
-          c.option "host", "--host HOST", "Database host name (default: #{DEFAULTS["host"].inspect})"
-          c.option "prefix", "--prefix PREFIX", "Table prefix name (default: #{DEFAULTS["prefix"].inspect})"
-          c.option "types", "--types TYPE1[,TYPE2[,TYPE3...]]", Array,
-            "The Drupal content types to be imported  (default: #{DEFAULTS["types"].join(",")})"
+          c.option "engine",   "--engine [mysql|postgresql]", "Database engine (default: #{DEFAULTS["engine"].inspect})"
+          c.option "dbname",   "--dbname DB",                 "Database name"
+          c.option "user",     "--user USER",                 "Database user name"
+          c.option "password", "--password PW",               "Database user's password (default: #{DEFAULTS["password"].inspect})"
+          c.option "host",     "--host HOST",                 "Database host name (default: #{DEFAULTS["host"].inspect})"
+          c.option "port",     "--port PORT",                 "Database port name (default: #{DEFAULTS["port"].inspect})"
+          c.option "prefix",   "--prefix PREFIX",             "Table prefix name (default: #{DEFAULTS["prefix"].inspect})"
+
+          c.option "types",    "--types TYPE1[,TYPE2[,TYPE3...]]", Array,
+                   "The Drupal content types to be imported  (default: #{DEFAULTS["types"].join(",")})"
         end
 
         def require_deps
@@ -42,21 +47,22 @@ module JekyllImport
         end
 
         def process(options)
-          engine = options.fetch("engine")
+          engine = options.fetch("engine", DEFAULTS["engine"])
           dbname = options.fetch("dbname")
           user   = options.fetch("user")
           pass   = options.fetch("password", DEFAULTS["password"])
           host   = options.fetch("host",     DEFAULTS["host"])
+          port   = options.fetch("port",     DEFAULTS["port"])
           prefix = options.fetch("prefix",   DEFAULTS["prefix"])
           types  = options.fetch("types",    DEFAULTS["types"])
 
           if engine == "postgresql"
             db = Sequel.postgres(dbname, :user => user, :password => pass, :host => host, :encoding => "utf8")
           else
-            db = Sequel.mysql2(dbname, :user => user, :password => pass, :host => host, :encoding => "utf8")
+            db = Sequel.mysql2(dbname, :user => user, :password => pass, :host => host, :port => port, :encoding => "utf8")
           end
 
-          query = self.build_query(prefix, types, engine)
+          query = build_query(prefix, types, engine)
 
           conf = Jekyll.configuration({})
           src_dir = conf["source"]
@@ -74,20 +80,21 @@ module JekyllImport
           # Create the refresh layout
           # Change the refresh url if you customized your permalink config
           File.open(File.join(dirs[:_layouts], "refresh.html"), "w") do |f|
-            f.puts <<-HTML
-<!DOCTYPE html>
-<html>
-<head>
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
-<meta http-equiv="refresh" content="0;url={{ page.refresh_to_post_id }}.html" />
-</head>
-</html>
-HTML
+            f.puts <<~HTML
+              <!DOCTYPE html>
+              <html>
+              <head>
+              <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+              <meta http-equiv="refresh" content="0;url={{ page.refresh_to_post_id }}.html" />
+              <link rel="canonical" href="{{ page.refresh_to_post_id }}.html" />
+              </head>
+              </html>
+            HTML
           end
 
           db[query].each do |post|
             # Get required fields
-            data, content = self.post_data(post)
+            data, content = post_data(post)
 
             data["layout"] = post[:type]
             title = data["title"] = post[:title].strip.force_encoding("UTF-8")
@@ -95,7 +102,7 @@ HTML
 
             # Get the relevant fields as a hash and delete empty fields
             data = data.delete_if { |_k, v| v.nil? || v == "" }.each_pair do |_k, v|
-              ((v.is_a? String) ? v.force_encoding("UTF-8") : v)
+              v.is_a?(String) ? v.force_encoding("UTF-8") : v
             end
 
             # Construct a Jekyll compatible file name
@@ -114,19 +121,39 @@ HTML
 
             # Make a file to redirect from the old Drupal URL
             next unless is_published
-            alias_query = self.aliases_query(prefix)
+
+            alias_query = aliases_query(prefix)
             type = post[:type]
 
-            aliases = db[alias_query, "#{type}/#{node_id}"].all
+            aliases_type = db[alias_query, "#{type}/#{node_id}"].all
+            aliases_node = db[alias_query, "node/#{node_id}"].all
+            aliases = aliases_type.concat aliases_node
 
             aliases.push(:alias => "#{type}/#{node_id}")
+            aliases.push(:alias => "node/#{node_id}")
 
             aliases.each do |url_alias|
-              FileUtils.mkdir_p url_alias[:alias]
-              File.open("#{url_alias[:alias]}/index.md", "w") do |f|
+              redirect_prefix = ""
+              categories = data["categories"]
+              unless categories.nil? || categories.length.zero?
+                first_category = categories[0]
+                redirect_prefix = "#{first_category}/"
+              end
+
+              partition = url_alias[:alias].rpartition("/")
+              dir = ""
+              file = partition.last
+
+              if partition.first.length.positive?
+                dir = "#{partition.first}/"
+                FileUtils.mkdir_p partition.first
+              end
+
+              File.open("#{dir}#{file}.md", "w") do |f|
                 f.puts "---"
                 f.puts "layout: refresh"
-                f.puts "refresh_to_post_id: /#{Time.at(time).to_datetime.strftime("%Y/%m/%d/") + slug}"
+                f.puts "permalink: #{dir}#{file}/"
+                f.puts "refresh_to_post_id: /#{redirect_prefix}#{Time.at(time).to_datetime.strftime("%Y/%m/%d/") + slug}"
                 f.puts "---"
               end
             end
@@ -152,12 +179,9 @@ HTML
 
       def validate(options)
         %w(dbname user).each do |option|
-          if options[option].nil?
-            abort "Missing mandatory option --#{option}."
-          end
+          abort "Missing mandatory option --#{option}." unless options.key?(option)
         end
       end
-
     end
   end
 end