jekyll-import 0.12.0 → 0.13.0

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

@@ -1,23 +1,23 @@
 module JekyllImport
   module Importers
     class Ghost < Importer
-
       def self.specify_options(c)
-        c.option 'dbfile', '--dbfile', 'Database file (default: ghost.db)'
+        c.option "dbfile", "--dbfile", "Database file (default: ghost.db)"
       end
 
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           rubygems
           sequel
+          sqlite3
           fileutils
           safe_yaml
-        ])
+        ))
       end
 
       def self.process(options)
-        posts = fetch_posts(options.fetch('dbfile', 'ghost.db'))
-        if !posts.empty?
+        posts = fetch_posts(options.fetch("dbfile", "ghost.db"))
+        unless posts.empty?
           FileUtils.mkdir_p("_posts")
           FileUtils.mkdir_p("_drafts")
           posts.each do |post|
@@ -27,40 +27,53 @@ module JekyllImport
       end
 
       private
-      def self.fetch_posts(dbfile)
-        db = Sequel.sqlite(dbfile)
-        query = "SELECT `title`, `slug`, `markdown`, `created_at`, `status` FROM posts"
-        db[query]
-      end
+      class << self
+        def fetch_posts(dbfile)
+          db = Sequel.sqlite(dbfile)
+          query = "SELECT `title`, `slug`, `markdown`, `created_at`, `published_at`, `status`, `page` FROM posts"
+          db[query]
+        end
+
+        def write_post_to_file(post)
+          # detect if the post is a draft
+          draft = post[:status].eql?("draft")
 
-      def self.write_post_to_file(post)
-        # detect if the post is a draft
-        draft = post[:status].eql?('draft')
+          # detect if the post is considered a static page
+          page = post[:page]
 
-        # Ghost saves the time in an weird format with 3 more numbers.
-        # But the time is correct when we remove the last 3 numbers.
-        date = Time.at(post[:created_at].to_i.to_s[0..-4].to_i)
+          # the publish date if the post has been published, creation date otherwise
+          date = Time.at(post[draft ? :created_at : :published_at].to_i)
 
-        # the directory where the file will be saved to. either _drafts or _posts
-        directory = draft ? "_drafts" : "_posts"
+          if page
+            # the filename under which the page is stored
+            filename = "#{post[:slug]}.markdown"
+          else
+            # the directory where the file will be saved to. either _drafts or _posts
+            directory = draft ? "_drafts" : "_posts"
 
-        # the filename under which the post is stored
-        filename = File.join(directory, "#{date.strftime('%Y-%m-%d')}-#{post[:slug]}.markdown")
+            # the filename under which the post is stored
+            filename = File.join(directory, "#{date.strftime("%Y-%m-%d")}-#{post[:slug]}.markdown")
+          end
 
-        # the YAML FrontMatter
-        frontmatter = { 'layout' => 'post', 'title' => post[:title] }
-        frontmatter['date'] =  date if !draft # only add the date to the frontmatter when the post is published
-        frontmatter.delete_if { |k,v| v.nil? || v == '' } # removes empty fields
+          # the YAML FrontMatter
+          frontmatter = {
+            "layout" => page ? "page" : "post",
+            "title"  => post[:title],
+          }
+          frontmatter["date"] = date if !page && !draft # only add the date to the frontmatter when the post is published
+          frontmatter["published"] = false if page && draft # set published to false for draft pages
+          frontmatter.delete_if { |_k, v| v.nil? || v == "" } # removes empty fields
 
-        # write the posts to disk
-        write_file(filename, frontmatter.to_yaml, post[:markdown])
-      end
+          # write the posts to disk
+          write_file(filename, frontmatter.to_yaml, post[:markdown])
+        end
 
-      def self.write_file(filename, frontmatter, content)
-        File.open(filename, "w") do |f|
-          f.puts frontmatter
-          f.puts "---"
-          f.puts content
+        def write_file(filename, frontmatter, content)
+          File.open(filename, "w") do |f|
+            f.puts frontmatter
+            f.puts "---"
+            f.puts content
+          end
         end
       end
     end

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

@@ -2,17 +2,17 @@ module JekyllImport
   module Importers
     class GoogleReader < Importer
       def self.validate(options)
-        if options['source'].nil?
+        if options["source"].nil?
           abort "Missing mandatory option --source."
         end
       end
 
       def self.specify_options(c)
-        c.option 'source', '--source', 'Source XML file of Google Reader export'
+        c.option "source", "--source", "Source XML file of Google Reader export"
       end
 
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           rubygems
           rss
           fileutils
@@ -20,7 +20,7 @@ module JekyllImport
           open-uri
           rexml/document
           date
-        ])
+        ))
       end
 
       # Process the import.
@@ -29,7 +29,7 @@ module JekyllImport
       #
       # Returns nothing.
       def self.process(options)
-        source = options.fetch('source')
+        source = options.fetch("source")
 
         open(source) do |content|
           feed = RSS::Parser.parse(content)
@@ -40,13 +40,13 @@ module JekyllImport
             title = item.title.content.to_s
             formatted_date = Date.parse(item.published.to_s)
             post_name = title.split(%r{ |!|/|:|&|-|$|,}).map do |i|
-              i.downcase if i != ''
-            end.compact.join('-')
+              i.downcase if i != ""
+            end.compact.join("-")
             name = "#{formatted_date}-#{post_name}"
 
             header = {
-              'layout' => 'post',
-              'title' => title
+              "layout" => "post",
+              "title"  => title,
             }
 
             FileUtils.mkdir_p("_posts")

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

@@ -2,7 +2,7 @@ module JekyllImport
   module Importers
     class Joomla < Importer
       def self.validate(options)
-        %w[dbname user].each do |option|
+        %w(dbname user).each do |option|
           if options[option].nil?
             abort "Missing mandatory option --#{option}."
           end
@@ -10,34 +10,35 @@ module JekyllImport
       end
 
       def self.specify_options(c)
-        c.option 'dbname', '--dbname', 'Database name'
-        c.option 'user', '--user', 'Database user name'
-        c.option 'password', '--password', "Database user's password (default: '')"
-        c.option 'host', '--host', 'Database host name'
-        c.option 'section', '--section', 'Table prefix name'
-        c.option 'prefix', '--prefix', 'Table prefix name'
+        c.option "dbname", "--dbname", "Database name"
+        c.option "user", "--user", "Database user name"
+        c.option "password", "--password", "Database user's password (default: '')"
+        c.option "host", "--host", "Database host name"
+        c.option "port", "--port", "Database port"
+        c.option "section", "--section", "Table prefix name"
+        c.option "prefix", "--prefix", "Table prefix name"
       end
 
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           rubygems
           sequel
           mysql2
           fileutils
           safe_yaml
-          mysql
-        ])
+        ))
       end
 
       def self.process(options)
-        dbname  = options.fetch('dbname')
-        user    = options.fetch('user')
-        pass    = options.fetch('password', '')
-        host    = options.fetch('host', "localhost")
-        section = options.fetch('section', '1')
-        table_prefix = options.fetch('prefix', "jos_")
+        dbname  = options.fetch("dbname")
+        user    = options.fetch("user")
+        pass    = options.fetch("password", "")
+        host    = options.fetch("host", "localhost")
+        port    = options.fetch("port", 3306).to_i
+        section = options.fetch("section", "1")
+        table_prefix = options.fetch("prefix", "jos_")
 
-        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")
 
         FileUtils.mkdir_p("_posts")
 
@@ -55,24 +56,23 @@ module JekyllImport
 
           # Construct a slug from the title if alias field empty.
           # Remove illegal filename characters.
-          if !post[:alias] or post[:alias].empty?
-            slug = sluggify(post[:title])
-          else
-            slug = sluggify(post[:alias])
-          end
+          slug = if !post[:alias] || post[:alias].empty?
+                   sluggify(post[:title])
+                 else
+                   sluggify(post[:alias])
+                 end
 
-          name = "%02d-%02d-%02d-%03d-%s.markdown" % [date.year, date.month, date.day,
-                                                 id,slug]
+          name = format("%02d-%02d-%02d-%03d-%s.markdown", date.year, date.month, date.day, id, slug)
 
           # Get the relevant fields as a hash, delete empty fields and convert
           # to YAML for the header.
           data = {
-             'layout' => 'post',
-             'title' => title.to_s,
-             'joomla_id' => post[:id],
-             'joomla_url' => post[:alias],
-             'date' => date
-           }.delete_if { |k,v| v.nil? || v == '' }.to_yaml
+            "layout"     => "post",
+            "title"      => title.to_s,
+            "joomla_id"  => post[:id],
+            "joomla_url" => post[:alias],
+            "date"       => date,
+          }.delete_if { |_k, v| v.nil? || v == "" }.to_yaml
 
           # Write out the data and content to file
           File.open("_posts/#{name}", "w") do |f|
@@ -84,8 +84,8 @@ module JekyllImport
       end
 
       # Borrowed from the Wordpress importer
-      def self.sluggify( title )
-        title = title.downcase.gsub(/[^0-9A-Za-z]+/, " ").strip.gsub(" ", "-")
+      def self.sluggify(title)
+        title.downcase.gsub(%r![^0-9A-Za-z]+!, " ").strip.tr(" ", "-")
       end
     end
   end

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

@@ -2,7 +2,7 @@ module JekyllImport
   module Importers
     class Joomla3 < Importer
       def self.validate(options)
-        %w[dbname user prefix].each do |option|
+        %w(dbname user prefix).each do |option|
           if options[option].nil?
             abort "Missing mandatory option --#{option}."
           end
@@ -10,73 +10,75 @@ module JekyllImport
       end
 
       def self.specify_options(c)
-        c.option 'dbname', '--dbname', 'Database name'
-        c.option 'user', '--user', 'Database user name'
-        c.option 'password', '--password', "Database user's password (default: '')"
-        c.option 'host', '--host', 'Database host name'
-        c.option 'category', '--category', 'ID of the category'
-        c.option 'prefix', '--prefix', 'Table prefix name'
+        c.option "dbname", "--dbname", "Database name"
+        c.option "user", "--user", "Database user name"
+        c.option "password", "--password", "Database user's password (default: '')"
+        c.option "host", "--host", "Database host name"
+        c.option "port", "--port", "Database port"
+        c.option "category", "--category", "ID of the category"
+        c.option "prefix", "--prefix", "Table prefix name"
       end
 
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           rubygems
           sequel
+          mysql2
           fileutils
           safe_yaml
-        ])
+        ))
       end
 
       def self.process(options)
-        dbname  = options.fetch('dbname')
-        user    = options.fetch('user')
-        pass    = options.fetch('password', '')
-        host    = options.fetch('host', "localhost")
-        cid	    = options.fetch('category', 0)
-        table_prefix = options.fetch('prefix', "jos_")
+        dbname  = options.fetch("dbname")
+        user    = options.fetch("user")
+        pass    = options.fetch("password", "")
+        host    = options.fetch("host", "localhost")
+        port    = options.fetch("port", 3306).to_i
+        cid	    = options.fetch("category", 0)
+        table_prefix = options.fetch("prefix", "jos_")
 
-        db = Sequel.mysql(dbname, :user => user, :password => pass, :host => host, :encoding => 'utf8')
+        db = Sequel.mysql2(dbname, :user => user, :password => pass, :host => host, :port => port, :encoding => "utf8")
 
         FileUtils.mkdir_p("_posts")
 
         # Reads a MySQL database via Sequel and creates a post file for each
         # post in #__content that is published.
         query = "SELECT `cn`.`title`, `cn`.`alias`, `cn`.`introtext`, CONCAT(`cn`.`introtext`,`cn`.`fulltext`) AS `content`, "
-		query << "`cn`.`created`, `cn`.`id`, `ct`.`title` AS `category`, `u`.`name` AS `author` "
-		query << "FROM `#{table_prefix}content` AS `cn` JOIN `#{table_prefix}categories` AS `ct` ON `cn`.`catid` = `ct`.`id` "
-		query << "JOIN `#{table_prefix}users` AS `u` ON `cn`.`created_by` = `u`.`id` "
-		query << "WHERE (`cn`.`state` = '1' OR `cn`.`state` = '2') " # Only published and archived content items to be imported
+        query << "`cn`.`created`, `cn`.`id`, `ct`.`title` AS `category`, `u`.`name` AS `author` "
+        query << "FROM `#{table_prefix}content` AS `cn` JOIN `#{table_prefix}categories` AS `ct` ON `cn`.`catid` = `ct`.`id` "
+        query << "JOIN `#{table_prefix}users` AS `u` ON `cn`.`created_by` = `u`.`id` "
+        query << "WHERE (`cn`.`state` = '1' OR `cn`.`state` = '2') " # Only published and archived content items to be imported
 
-		if cid > 0
-			query << " AND `cn`.`catid` = '#{cid}' "
-		else 
-			query << " AND `cn`.`catid` != '2' " #Filter out uncategorized content
-		end
+        query << if cid > 0
+                   " AND `cn`.`catid` = '#{cid}' "
+                 else
+                   " AND `cn`.`catid` != '2' " # Filter out uncategorized content
+                 end
 
         db[query].each do |post|
           # Get required fields and construct Jekyll compatible name.
           title = post[:title]
           slug = post[:alias]
           date = post[:created]
-		  author = post[:author]
-		  category = post[:category]
+          author = post[:author]
+          category = post[:category]
           content = post[:content]
-		  excerpt = post[:introtext]
-          name = "%02d-%02d-%02d-%s.markdown" % [date.year, date.month, date.day,
-                                                 slug]
+          excerpt = post[:introtext]
+          name = format("%02d-%02d-%02d-%s.markdown", date.year, date.month, date.day, slug)
 
           # Get the relevant fields as a hash, delete empty fields and convert
           # to YAML for the header.
           data = {
-             'layout' => 'post',
-             'title' => title.to_s,
-             'joomla_id' => post[:id],
-             'joomla_url' => slug,
-             'date' => date,
-			 'author' => author,
-			 'excerpt' => excerpt.strip.to_s,
-			 'category' => category
-           }.delete_if { |k,v| v.nil? || v == '' }.to_yaml
+            "layout"     => "post",
+            "title"      => title.to_s,
+            "joomla_id"  => post[:id],
+            "joomla_url" => slug,
+            "date"       => date,
+            "author"     => author,
+            "excerpt"    => excerpt.strip.to_s,
+            "category"   => category,
+          }.delete_if { |_k, v| v.nil? || v == "" }.to_yaml
 
           # Write out the data and content to file
           File.open("_posts/#{name}", "w") do |f|

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

@@ -1,20 +1,19 @@
 module JekyllImport
   module Importers
     class Jrnl < Importer
-
       def self.require_deps
-        JekyllImport.require_with_fallback(%w[
+        JekyllImport.require_with_fallback(%w(
           time
           rubygems
           safe_yaml
-        ])
+        ))
       end
 
       def self.specify_options(c)
-        c.option 'file', '--file FILENAME', 'Journal file (default: "~/journal.txt")'
-        c.option 'time_format', '--time_format FORMAT', 'Time format of your journal (default: "%Y-%m-%d %H:%M")'
-        c.option 'extension', '--extension EXT', 'Output extension (default: "md")'
-        c.option 'layout', '--layout NAME', 'Output post layout (default: "post")'
+        c.option "file", "--file FILENAME", 'Journal file (default: "~/journal.txt")'
+        c.option "time_format", "--time_format FORMAT", 'Time format of your journal (default: "%Y-%m-%d %H:%M")'
+        c.option "extension", "--extension EXT", 'Output extension (default: "md")'
+        c.option "layout", "--layout NAME", 'Output post layout (default: "post")'
       end
 
       # Reads a jrnl file and creates a new post for each entry
@@ -24,10 +23,10 @@ module JekyllImport
       # :extension    the extension format of the output files
       # :layout       explicitly set the layout of the output
       def self.process(options)
-        file        = options.fetch('file', "~/journal.txt")
-        time_format = options.fetch('time_format', "%Y-%m-%d %H:%M")
-        extension   = options.fetch('extension', "md")
-        layout      = options.fetch('layout', "post")
+        file        = options.fetch("file", "~/journal.txt")
+        time_format = options.fetch("time_format", "%Y-%m-%d %H:%M")
+        extension   = options.fetch("extension", "md")
+        layout      = options.fetch("layout", "post")
 
         date_length = Time.now.strftime(time_format).length
 
@@ -37,7 +36,7 @@ module JekyllImport
         abort "The jrnl file was not found. Please make sure '#{file}' exists. You can specify a different file using the --file switch." unless File.file?(file)
 
         input = File.read(file)
-        entries = input.split("\n\n");
+        entries = input.split("\n\n")
 
         entries.each do |entry|
           # split dateline and body
@@ -73,7 +72,7 @@ module JekyllImport
 
       # generate slug
       def self.create_slug(title)
-        return title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+        return title.downcase.strip.tr(" ", "-").gsub(%r![^\w-]!, "")
       end
 
       # generate filename
@@ -95,11 +94,11 @@ module JekyllImport
       # Returns array converted to YAML
       def self.create_meta(layout, title, date)
         data = {
-          'layout'        => layout,
-          'title'         => title,
-          'date'          => Time.parse(date).strftime("%Y-%m-%d %H:%M %z")
+          "layout" => layout,
+          "title"  => title,
+          "date"   => Time.parse(date).strftime("%Y-%m-%d %H:%M %z"),
         }.to_yaml
-        return data;
+        return data
       end
 
       # Writes given data to file