ghost_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 618f9df2adceb51cb2af2435782af06a9366418cdf3777dd77e4c27727d5757e
+  data.tar.gz: d408b8924f7122a8fc9910b22a86db11562ad31c90200d825a2afdf71910ecfd
+SHA512:
+  metadata.gz: 9a931262944cf3f4606b2d66286788f8e9ebc0318115df8479c15aabdac6e037029e1726e5aee8e45ab12d41ec71538f9e8c0f519e15393e2c1741a58c465646
+  data.tar.gz: 83b33e59cd6de1de67b2889e6e772de51404f087e05f4f6c1427884e76279e29715af29a50a35f450b1d6b2ecb5ccf24212645fbb09c0997a977a9f07cf667e3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+ghost_parser

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ghost_parser.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "nokogiri"

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    ghost_parser (0.0.1)
+      nokogiri
+      rake (~> 13.0)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.6.2)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ghost_parser!
+  nokogiri
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mathew Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# GhostParser
+
+A ruby plugin used to help evaluate the exported [Ghost](https://ghost.org/) posts
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ghost_parser
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem installghost_parser
+
+## Usage
+
+To parse the export:
+```ruby
+parser = GhostParser.new("path/to/export.json").parse
+
+[
+    {
+        id: "id",
+        title: "title",
+        slug: "slug",
+        html: "html",
+        feature_image: "feature_image",
+        created_at: "created_at",
+        updated_at: "updated_at",
+        published_at: "published_at",
+        status: "status"
+    }, ......
+]
+```
+
+Ghost export content will have their links modified like `__GHOST_URL__/image.jpg`. If you want the content with active links provide your ghost url.
+```ruby
+GhostParser.set_ghost_url("your ghost url")
+```
+
+Instead of getting all the fields we can define the necessary params with necessary keys
+```ruby
+GhostParser.set_config({
+  new_id: "id",
+  name: "title",
+  new_slug: "slug"
+})
+
+parser = GhostParser.new("path/to/export.json").parse
+
+[
+    {
+        new_id: "id",
+        name: "title",
+        new_slug: "slug"
+    }, ......
+]
+
+GhostParser.unset_config # Reverts back to default
+```
+
+Also supports the option of adding extra fields to parsed data
+```ruby
+
+# Using blocks
+parser = GhostParser.new(file_path).parse do |t|
+          t[:user_id] = 12
+        end
+
+[
+    {
+        id: "id",
+        title: "title",
+        slug: "slug",
+        html: "html",
+        feature_image: "feature_image",
+        created_at: "created_at",
+        updated_at: "updated_at",
+        published_at: "published_at",
+        status: "status",
+        user_id: 12
+    }, ......
+]
+
+# Inline
+parser = GhostParser.new(file_path).parse(
+            {param_key: "123"}
+          )
+
+[
+    {
+        id: "id",
+        title: "title",
+        slug: "slug",
+        html: "html",
+        feature_image: "feature_image",
+        created_at: "created_at",
+        updated_at: "updated_at",
+        published_at: "published_at",
+        status: "status",
+        param_key: "123"
+    }, ......
+]
+
+```
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/ghost_parser/json_parser.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+class JsonParser
+  attr_reader :file_content
+
+  def initialize(file_content)
+    @file_content = file_content
+  end
+
+  def call
+    JSON.load(file_content)["db"][0]["data"]["posts"]
+  end
+end

data/lib/ghost_parser.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "ghost_parser/json_parser"
+require "nokogiri"
+
+class GhostParser
+  attr_reader :file_path
+  @@ghost_url = ""
+
+  Default_Config = {
+    id: "id",
+    title: "title",
+    slug: "slug",
+    html: "html",
+    feature_image: "feature_image",
+    created_at: "created_at",
+    updated_at: "updated_at",
+    published_at: "published_at",
+    status: "status"
+  }
+
+  def initialize(file_path)
+    @file_path = file_path
+  end
+
+  def parse(attributes = nil, options = {}, &block)
+    raise "File not found" if !File.exist?(file_path)
+    file = File.read(file_path)
+    json_array = JsonParser.new(file).call
+    result_array = []
+    json_array.each do |json|
+      result = {}
+      config.each do |k, v|
+        result[k] = json[v]
+      end
+      result.merge!(attributes) if !attributes.nil?
+      yield(result) if block_given?
+      result_array << result
+    end
+    return format_result(result_array)
+  end
+
+  def config
+    @@config ||= Default_Config
+  end
+
+  def self.set_config(params = nil)
+    @@config = params
+  end
+
+  def self.set_ghost_url(url)
+    @@ghost_url = url
+  end
+
+  def self.unset_config
+    @@config = Default_Config
+  end
+
+  private
+
+  def format_result(result_array)
+    if (@@ghost_url.nil? || @@ghost_url.empty?)
+      Warning.warn "Ghost url has not been initialized, urls in the export will not be valid"
+    else
+      result_array.each do |result|
+        result[config.key("html")] = format_html_content(result[config.key("html")]) if config.key("html")
+        result[config.key("feature_image")] = format_feature_image(result[config.key("feature_image")]) if config.key("feature_image")
+      end
+    end
+    result_array
+  end
+
+  def format_html_content(content) 
+    doc = Nokogiri::HTML.fragment(content)
+    doc.css("a[href]").each do |link| 
+      link['href'] = replace_url(link['href'])
+    end
+    doc.css("img[src]").each do |img| 
+      img['src'] = replace_url(img['src'])
+    end
+    return doc.to_html
+  end
+
+  def format_feature_image(image)
+    replace_url(image)
+  end
+
+  def replace_url(url)
+    return url&.gsub("__GHOST_URL__", @@ghost_url)
+  end
+end

data/sig/ghost_parser.rbs

@@ -0,0 +1,4 @@
+module GhostParser
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: ghost_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mathew Thomas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mathew1.9thomas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ghost_parser.rb
+- lib/ghost_parser/json_parser.rb
+- sig/ghost_parser.rbs
+homepage: https://github.com/betacraft/ghost_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/betacraft/ghost_parser
+  source_code_uri: https://github.com/betacraft/ghost_parser
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: A ruby plugin used to help evaluate the exported Ghost posts
+test_files: []