jekyll_ghost_importer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6efbcdcc0c92d880bb0109f84ccee340dd54cce8
-  data.tar.gz: 349ae207909497df123de057efe2624b030fda85
+SHA256:
+  metadata.gz: 793f7694612eae2a10c876897f4213b77f1211e80cab15086733d9d3457c6e47
+  data.tar.gz: d8a413bf79bfcadfada7399ae93b3152e9e06129d955bf960512f7e85885a576
 SHA512:
-  metadata.gz: 3365d9b8c06daed3c14017a49c8caee73e1c1227da7ece77d0afab2a05da4f9670e5c06b2033de749bd1292a0ffddd22caad4a607e1488fb46373abab2e3667d
-  data.tar.gz: d28969705c02a254503accfc8409a86d70f976de9b4d6d141ba33f70f89311b69dd0f46018908b1bf09b60f4f748b809f8073864347df507a0c4bba717702b4d
+  metadata.gz: e65416ad56707d31d1e8bf850dc7de6d61301885bd7a92bcea2dd9934568a819d55a95e687c6442204f773b266a0ae11843d2f1dfe3844374cac171144939d01
+  data.tar.gz: f0ee9fa32ba49407cb4a7152db3512ebf17add35c5290f67ad02e934cfa4b18b4e6e0181669a0140a36655c524f5c2d404736a21a651d0ebae7e7e697d1e934b

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog], and this project adheres to
+[Semantic Versioning].
+
+  [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+  [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
+
+## [Unreleased]
+
+## [1.1.0] - 2018-02-01
+
+### Added
+
+-   Add support for exports with mobiledoc without any markdown card.
+
+### Changed
+
+-   Add new dependency on `reverse_markdown`.

data/README.md

@@ -9,7 +9,7 @@ This program let you import your post on [ghost][1] to [jekyll][2]. It uses a
 
  [1]: https://ghost.org/about/
  [2]: http://jekyllrb.com/
- [3]: http://support.ghost.org/import-and-export-my-ghost-blog-settings-and-data/
+ [3]: https://help.ghost.org/hc/en-us/articles/224112927-Import-Export-Data
 
 ## Installation
 

data/bin/jekyll_ghost_importer

@@ -20,42 +20,21 @@ require 'fileutils'
 require 'json'
 require 'date'
 require 'yaml'
+require 'ostruct'
+require 'reverse_markdown'
 
-FileUtils.mkdir_p("_posts")
-FileUtils.mkdir_p("_drafts")
-
-$json = JSON.parse File.read(ARGV.pop), symbolize_names: true
-
-unless $json[:data].nil?
-  posts = $json[:data][:posts]
-else
-  posts = $json[:db].first[:data][:posts]
-end
-
-def there_are_tags?
-  @tags ||=
-    $json[:db] &&
-    $json[:db].first[:data][:posts_tags] &&
-    $json[:db].first[:data][:tags]
-end
-
-@imported = Hash.new(0)
-
-class Post
-  # the source of the post
-  attr_reader :post
-
-  def initialize post
-    @post = post
-  end
-
+class Post < OpenStruct
   def import
     puts "Importing #{ filename }"
     File.write filename, full_body
   end
 
   def draft?
-    post[:status] == 'draft'
+    status == 'draft'
+  end
+
+  def tags
+    @tags ||= []
   end
 
   private
@@ -69,63 +48,48 @@ class Post
   end
 
   def date
-    case post[:published_at]
+    case published_at
     when String
-      DateTime.parse(post[:published_at])
+      DateTime.parse(published_at)
     when Integer
-      Time.at(post[:published_at] / 1000).utc.to_datetime
+      Time.at(published_at / 1000).utc.to_datetime
     end
   end
 
   def front_matter
     front_matter_hash = {
       'layout' => "post",
-      'title'  => post[:title]
+      'title'  => title
     }
-    
-    front_matter_hash['featured'] = true if post[:featured] == 1
-    front_matter_hash['image'] = post[:image] if post[:image] != nil
-    
-    unless draft?
-      front_matter_hash['date'] = date.strftime('%Y-%m-%d %H:%M:%S') if date
-    end
-    front_matter_hash['tags'] = tags if tags && !tags.empty?
-    front_matter_hash
-  end
 
-  def slug
-    post[:slug]
-  end
+    front_matter_hash['featured'] = true if featured == 1
+    front_matter_hash['image'] = image if image != nil
 
-  def tags
-    if there_are_tags?
-      post_tags = $json[:db].first[:data][:posts_tags].select do |pt|
-        pt[:post_id] == post[:id]
-      end
-      tags_ids = post_tags.map { |pt| pt[:tag_id] }
-      tags = $json[:db].first[:data][:tags].select do |t|
-        tags_ids.include? t[:id]
-      end
-      tags.map { |t| t[:slug] }
-    end
+    front_matter_hash['date'] = date.strftime('%Y-%m-%d %H:%M:%S') if !draft? && date
+    front_matter_hash['tags'] = tags if tags.any?
+    front_matter_hash
   end
 
   def full_body
-    front_matter.to_yaml + "---\n\n" + markdown
+    front_matter.to_yaml + "---\n\n" + markdown_body
   end
 
-  def markdown
-    if post[:markdown]
-      post[:markdown]
-    elsif post[:mobiledoc]
-      mobiledoc = JSON.parse post[:mobiledoc], symbolize_names: true
-      card = mobiledoc[:cards].find { |c| c.first == "card-markdown" }
-      card.last[:markdown]
+  def markdown_body
+    if markdown
+      markdown
+    elsif mobiledoc
+      mobiledoc_data = JSON.parse mobiledoc, symbolize_names: true
+      markdown_card = mobiledoc_data[:cards].find { |c| c.first == "card-markdown" }
+      markdown_card ? markdown_card.last[:markdown] : markdown_from_html
     else
       ""
     end
   end
 
+  def markdown_from_html
+    ReverseMarkdown.convert html
+  end
+
   def basename
     if draft?
       "#{ slug }.markdown"
@@ -135,11 +99,50 @@ class Post
   end
 end
 
-posts.each do |post|
-  post = Post.new post
-  post.import
-  @imported[:posts] += 1
-  @imported[:drafts] += 1 if post.draft?
+class PostRepository
+  attr_reader :posts
+
+  def initialize json
+    @json = json
+    @posts = (data[:posts] || []).map { |post_json| Post.new(post_json) }
+    @tags = data[:tags] || []
+    @posts_tags = data[:posts_tags] || []
+    assign_tags_to_posts
+  end
+
+  def drafts
+    @posts.select &:draft?
+  end
+
+  private
+
+  def assign_tags_to_posts
+    @posts_tags.each do |post_tag|
+      post = get_post(post_tag[:post_id])
+      tag = get_tag(post_tag[:tag_id])
+      post && tag && post.tags << tag[:slug]
+    end
+  end
+
+  def get_post id
+    @posts.detect { |post| post.id == id }
+  end
+
+  def get_tag id
+    @tags.detect { |tag| tag[:id] == id }
+  end
+
+  def data
+    @json[:data] ? @json[:data] : @json[:db].first[:data]
+  end
 end
 
-puts "#{ @imported[:posts] } posts imported ( #{ @imported[:drafts] } draft )"
+FileUtils.mkdir_p("_posts")
+FileUtils.mkdir_p("_drafts")
+
+json = JSON.parse File.read(ARGV.pop), symbolize_names: true
+
+repository = PostRepository.new(json)
+repository.posts.map &:import
+
+puts "#{ repository.posts.count } posts imported ( #{ repository.drafts.count } draft )"

data/features/fixtures/version-004.json

@@ -0,0 +1,88 @@
+{
+  "db": [
+    {
+      "meta": {
+        "version": "2.6.0"
+      },
+      "data": {
+        "posts": [
+          {
+            "id": "5c424716e9286b0021583e8d",
+            "uuid": "dc097038-8688-4825-90d9-5c438580c233",
+            "title": "The Maker's Guide to the Zombie Apocalypse",
+            "slug": "the-makers-guide-to-the-zombie-apocalypse",
+            "mobiledoc": "{\"version\":\"0.3.1\",\"atoms\":[],\"cards\":[],\"markups\":[[\"a\",[\"href\",\"http://amzn.to/1spRddk\"]],[\"a\",[\"href\",\"http://amzn.to/1spRqwW\"]]],\"sections\":[]}",
+            "html": "<p><a href=\"http://amzn.to/1spRddk\">The Maker's Guide to the Zombie Apocalypse</a>, a book written by Simon Monk (who I gather is quite well known within the maker community, having <a href=\"http://amzn.to/1spRqwW\">authored various books</a> on the Arduino and Raspberry Pi)</p>",
+            "comment_id": "2",
+            "plaintext": "The Maker's Guide to the Zombie Apocalypse",
+            "feature_image": "//d1a0j00khen1nw.cloudfront.net/2018/02/IMG_0695-1-.jpg",
+            "featured": 0,
+            "page": 0,
+            "status": "published",
+            "locale": null,
+            "visibility": "public",
+            "meta_title": null,
+            "meta_description": null,
+            "author_id": "1",
+            "created_at": "2016-05-31T19:54:06.000Z",
+            "created_by": "1",
+            "updated_at": "2018-11-22T12:47:51.000Z",
+            "updated_by": "1",
+            "published_at": "2016-05-31T20:03:23.000Z",
+            "published_by": "1",
+            "custom_excerpt": "The Maker's Guide to the Zombie Apocalypse, a book written by Simon Monk is clearly something that knows how to motivate me...",
+            "codeinjection_head": null,
+            "codeinjection_foot": null,
+            "og_image": null,
+            "og_title": null,
+            "og_description": null,
+            "twitter_image": null,
+            "twitter_title": null,
+            "twitter_description": null,
+            "custom_template": ""
+          }
+        ],
+        "posts_authors": [
+          {
+            "id": "5c424716e9286b0021583eb3",
+            "post_id": "5c424716e9286b0021583e8d",
+            "author_id": "1",
+            "sort_order": 0
+          }
+        ],
+        "posts_tags": [
+          {
+            "id": "5c424716e9286b0021583eaf",
+            "post_id": "5c424716e9286b0021583e8d",
+            "tag_id": "5c42470be9286b0021583aec",
+            "sort_order": 0
+          }
+        ],
+        "tags": [
+          {
+            "id": "5c42470be9286b0021583aec",
+            "name": "The Maker's Guide to the Zombie Apocalypse",
+            "slug": "the-makers-guide-to-the-zombie-apocalypse",
+            "description": null,
+            "feature_image": "//d1a0j00khen1nw.cloudfront.net/2018/02/IMG_0695-1-.jpg",
+            "parent_id": null,
+            "visibility": "public",
+            "meta_title": null,
+            "meta_description": null,
+            "created_at": "2018-02-14T10:44:20.000Z",
+            "created_by": "1",
+            "updated_at": "2018-10-11T21:35:26.000Z",
+            "updated_by": "1"
+          }
+        ],
+        "users": [
+          {
+            "id": "1",
+            "name": "DH",
+            "slug": "daniel"
+          }
+        ]
+      }
+    }
+  ]
+}

data/features/import_posts.feature

@@ -295,6 +295,30 @@ Feature: Import posts
     Something here
     """
 
+  Scenario: Import a backup file with version 004
+    Given a ghost backup file version 004 with some sample posts
+    When I run `jekyll_ghost_importer GhostBackup.json`
+    Then it should pass with:
+    """
+    Importing _posts/2016-05-31-the-makers-guide-to-the-zombie-apocalypse.markdown
+    1 posts imported ( 0 draft )
+    """
+    And a directory named "_posts" should exist
+    And the following files should exist:
+      | _posts/2016-05-31-the-makers-guide-to-the-zombie-apocalypse.markdown |
+    And the file "_posts/2016-05-31-the-makers-guide-to-the-zombie-apocalypse.markdown" should contain:
+    """
+    ---
+    layout: post
+    title: The Maker's Guide to the Zombie Apocalypse
+    date: '2016-05-31 20:03:23'
+    tags:
+    - the-makers-guide-to-the-zombie-apocalypse
+    ---
+
+    [The Maker's Guide to the Zombie Apocalypse](http://amzn.to/1spRddk), a book written by Simon Monk (who I gather is quite well known within the maker community, having [authored various books](http://amzn.to/1spRqwW) on the Arduino and Raspberry Pi)
+    """
+
   Scenario: Import a draft with an invalid published_at date
     Given a file named "draft_with_invalid_date.json" with:
     """

data/jekyll_ghost_importer.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "jekyll_ghost_importer"
-  spec.version       = "1.0.0"
+  spec.version       = "1.1.0"
   spec.authors       = ["Eloy Espinaco"]
   spec.email         = ["eloyesp@gmail.com"]
   spec.summary       = %q{Import your posts from a ghost backup file.}
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "reverse_markdown", '~> 1.1'
   spec.add_development_dependency "cucumber", '~> 1.3'
   spec.add_development_dependency "aruba",    '~> 0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_ghost_importer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eloy Espinaco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - COPYING
 - Gemfile
 - Guardfile
@@ -55,6 +70,7 @@ files:
 - Rakefile
 - bin/jekyll_ghost_importer
 - features/fixtures/version-003.json
+- features/fixtures/version-004.json
 - features/import_posts.feature
 - features/step_definitions/backup_files.rb
 - features/support/requires.rb
@@ -80,12 +96,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Import your posts from a ghost backup file.
 test_files:
 - features/fixtures/version-003.json
+- features/fixtures/version-004.json
 - features/import_posts.feature
 - features/step_definitions/backup_files.rb
 - features/support/requires.rb