jekyll-notion 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f85b870a3e8c0aa6ea64575b8ef8541f61183fa25ced6f41570384057a3a36dd
-  data.tar.gz: c66f6d831e8352f029fc1f81608f751aac1ed2b5959b6c2ee19f861eafcdb6f0
+  metadata.gz: ac8561afc4f42d433ae33d4baafb38e9eaf7a34167513bf628eef849c3e773b7
+  data.tar.gz: 7c55ac94b8490943d981f3c25d36d0b3993680614ba25cdb16be78f07b5e028a
 SHA512:
-  metadata.gz: 26fda79bcfce19d75fda17e6f3e1a90080089c05132359b50f00ec3a4d54d844e6ef583bb558c961209d5818465c6ada865413a33f22fea15fdf943ecd213d8d
-  data.tar.gz: 430aa7ef405283f1568eacf4062a90a60fc0e086ae6c7d68cd96cd1eac5f8208d57d8cdebc02b0e98c653d0bff62b119c4ec6ceb4af31777c2a4a28121e0eb55
+  metadata.gz: d402be5b38a3dc4cae78daf0e95140ecc0b593db1091ac325f262a68024236f50639c25f1bee42db6cee025122bfb82d2318f312909278509c66f2375062d4d1
+  data.tar.gz: c22e49f752ba7a848c6329e55c57707c6bc9d59e510f5407a112448335a9a36b877c9abe4e94cf30fd383db29defd5fafbba14558742417375c4df4990f91a90

data/README.md

@@ -1,6 +1,6 @@
 # jekyll-notion
 
-Import notion pages to a jekyll collection.
+Import notion pages to a jekyll collection or data.
 
 ## Installation
 
@@ -32,14 +32,17 @@ Export the notion secret token in an environment variable named `NOTION_TOKEN`.
 $ export NOTION_TOKEN=<secret_...>
 ```
 
-Once your notion database has been shared, specify the  database `id` in your `_config.yml` as follows.
+Once your [notion database](https://www.notion.so/help/intro-to-databases) has been shared, specify the database `id` in your `_config.yml` as follows.
 
 ```yml
 notion:
   database:
-    id: e42383cd-4975-4897-b967-ce453760499f
+    id: 5cfed4de3bdc4f43ae8ba653a7a2219b
 ```
 
+After running `jekyll build` (or `serve`) command, the `posts` collection is loaded with pages of the notion database specified in the configuration. 
+
+
 ### Mutiple dabatases
 
 You can also define multiple databases as follows.
@@ -51,14 +54,51 @@ collections:
 
 notion:
   databases:
-    - id: b0e688e1-99af-4295-ae80-b67eb52f2e2f
-    - id: 2190450d-4cb3-4739-a5c8-340c4110fe21
+    - id: b0e688e199af4295ae80b67eb52f2e2f
+    - id: 2190450d4cb34739a5c8340c4110fe21
       collection: recipes
-    - id: e42383cd-4975-4897-b967-ce453760499f 
+    - id: e42383cd49754897b967ce453760499f 
       collection: films
 ```
 
-When no collection is defined, the `posts` collection is used by default.
+### Data
+
+Instead of storing notion pages in a collection, you can also map to the data object. Use the `data` property instead of `collection`.
+
+```yml
+notion:
+  database:
+    id: e42383cd49754897b967ce453760499f
+    data: films
+```
+
+Page properties and body are stored as a hash data.
+
+As a particular characteristic, the page is stored in a key named `content`.
+
+```html
+<p>{{ site.data.films.content }}</p>
+```
+
+The rest of properties as mapped as expected.
+
+### Pages
+
+Individual Notion pages can also be mapped to data. Just define the `pages` or `page` property as follows.
+
+```yaml
+notion:
+  pages:
+    - id: e42383cd49754897b967ce453760499f
+      data: about
+    - id: b0e688e199af4295ae80b67eb52f2e2f
+      data: contact
+    - id: 2190450d4cb34739a5c8340c4110fe21
+      data: footer
+
+```
+
+_This feature is only available for data._
 
 ### Database options
 
@@ -72,7 +112,7 @@ Each dabatase support the following options.
 ```yml
 notion:
   database:
-    id: e42383cd-4975-4897-b967-ce453760499f
+    id: e42383cd49754897b967ce453760499f
     collection: posts
     filter: { "property": "Published", "checkbox": { "equals": true } }
     sort: { "property": "Last ordered", "direction": "ascending" }
@@ -88,7 +128,7 @@ Set `fetch_on_watch` to true to allow request on each rebuild.
 notion:
   fetch_on_watch: true
   database:
-    id: e42383cd-4975-4897-b967-ce453760499f
+    id: e42383cd49754897b967ce453760499f
 ```
 
 And that's all. Each page in the notion database will be included in the selected collection.

data/lib/jekyll-notion/abstract_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class AbstractGenerator
+    def initialize(notion_resource:, site:, plugin:)
+      @notion_resource = notion_resource
+      @site = site
+      @plugin = plugin
+    end
+
+    def generate
+      raise "Do not use the AbstractGenerator class. Implement the generate method in a subclass."
+    end
+  end
+end

data/lib/jekyll-notion/abstract_notion_resource.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class AbstractNotionResource
+    def initialize(config:)
+      @notion = Notion::Client.new
+      @config = config
+    end
+
+    def config
+      @config || {}
+    end
+
+    def id
+      config["id"]
+    end
+
+    def fetch
+      raise "Do not use the AbstractNotionResource class. Implement the fetch method in a subclass."
+    end
+
+    def collection_name
+      raise "Do not use the AbstractGenerator class. Implement the collection_name method in a subclass."
+    end
+
+    def data_name
+      raise "Do not use the AbstractGenerator class. Implement the data_name method in a subclass."
+    end
+
+    protected
+
+    def id?
+      if id.nil? || id.empty?
+        Jekyll.logger.warn("Jekyll Notion:",
+                           "Database or page id is not provided. Cannot read from Notion.")
+        return false
+      end
+      true
+    end
+  end
+end

data/lib/jekyll-notion/collection_generator.rb

@@ -1,22 +1,20 @@
-module JekyllNotion
-  class CollectionGenerator
-    def initialize(db:, site:)
-      @db = db
-      @site = site
-    end
+# frozen_string_literal: true
 
+module JekyllNotion
+  class CollectionGenerator < AbstractGenerator
     def generate
-      @db.pages.each do |page|
+      @notion_resource.fetch.each do |page|
         next if file_exists?(make_path(page))
 
         collection.docs << make_doc(page)
         log_new_page(page)
       end
-      collection
+      # Caching current collection
+      @plugin.collections[@notion_resource.collection_name] = collection
     end
 
     def collection
-      @site.collections[@db.collection]
+      @site.collections[@notion_resource.collection_name]
     end
 
     private
@@ -37,11 +35,11 @@ module JekyllNotion
     end
 
     def make_path(page)
-      "_#{@db.collection}/#{make_filename(page)}"
+      "_#{@notion_resource.collection_name}/#{make_filename(page)}"
     end
 
     def make_filename(page)
-      if @db.collection == "posts"
+      if @notion_resource.collection_name == "posts"
         "#{page.created_time.to_date}-#{Jekyll::Utils.slugify(page.title,
                                                               :mode => "latin")}.md"
       else
@@ -56,7 +54,7 @@ module JekyllNotion
     def log_new_page(page)
       Jekyll.logger.info("Jekyll Notion:", "Page => #{page.title}")
       if @site.config.dig(
-        "collections", @db.collection, "output"
+        "collections", @notion_resource.collection_name, "output"
       )
         Jekyll.logger.info("",
                            "Path => #{collection.docs.last.path}")

data/lib/jekyll-notion/data_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class DataGenerator < AbstractGenerator
+    def generate
+      unless data.nil?
+        @site.data[@notion_resource.data_name] = data
+        # Caching current data in Generator instance (plugin)
+        @plugin.data[@notion_resource.data_name] = data
+        log_pages
+      end
+    end
+
+    private
+
+    def data
+      @data ||= if @notion_resource.is_a?(NotionDatabase)
+                  pages = @notion_resource.fetch
+                  pages.map { |page| page.props.merge({ "content" => convert(page) }) }
+                else
+                  page = @notion_resource.fetch
+                  page&.props&.merge({ "content" => convert(page) })
+                end
+    end
+
+    # Convert the notion page body using the site.converters.
+    #
+    # Returns String the converted content.
+    def convert(page)
+      converters.reduce(page.body) do |output, converter|
+        converter.convert output
+      rescue StandardError => e
+        Jekyll.logger.error "Conversion error:",
+                            "#{converter.class} encountered an error while "\
+                            "converting notion page '#{page.title}':"
+        Jekyll.logger.error("", e.to_s)
+        raise e
+      end
+    end
+
+    def converters
+      @converters ||= @site.converters.select { |c| c.matches(".md") }.tap(&:sort!)
+    end
+
+    def log_pages
+      if data.is_a?(Array)
+        data.each do |page|
+          Jekyll.logger.info("Jekyll Notion:", "Page => #{page["title"]}")
+          Jekyll.logger.debug("", "Props => #{page.keys.inspect}")
+        end
+      else
+        Jekyll.logger.info("Jekyll Notion:", "Page => #{data["title"]}")
+        Jekyll.logger.debug("", "Props => #{data.keys.inspect}")
+      end
+    end
+  end
+end

data/lib/jekyll-notion/generator.rb

@@ -9,30 +9,49 @@ module JekyllNotion
 
       return unless notion_token? && config?
 
-      if fetch_on_watch? || collections.empty?
-        read_notion_database
+      if fetch_on_watch? || collections_and_data_empty?
+        read_notion_databases
+        read_notion_pages
       else
         collections.each_pair { |key, val| @site.collections[key] = val }
+        data.each_pair { |key, val| @site.data[key] = val }
       end
     end
 
+    def databases
+      config["databases"] || [config["database"]]
+    end
+
+    def pages
+      config["pages"] || [config["page"]]
+    end
+
+    def collections
+      @collections ||= {}
+    end
+
+    def data
+      @data ||= {}
+    end
+
     protected
 
-    def read_notion_database
+    def collections_and_data_empty?
+      collections.empty? && data.empty?
+    end
+
+    def read_notion_databases
       databases.each do |db_config|
         db = NotionDatabase.new(:config => db_config)
-        new_collection = CollectionGenerator.new(:db => db, :site => @site).generate
-        # Caching current collection
-        collections[db.collection] = new_collection
+        GeneratorFactory.for(:notion_resource => db, :site => @site, :plugin => self).generate
       end
     end
 
-    def databases
-      config["databases"] || [config["database"]]
-    end
-
-    def collections
-      @collections ||= {}
+    def read_notion_pages
+      pages.each do |page_config|
+        page = NotionPage.new(:config => page_config)
+        GeneratorFactory.for(:notion_resource => page, :site => @site, :plugin => self).generate
+      end
     end
 
     def config

data/lib/jekyll-notion/generator_factory.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class GeneratorFactory
+    def self.for(notion_resource:, site:, plugin:)
+      if notion_resource.is_a?(NotionDatabase) && notion_resource.data_name.nil?
+        CollectionGenerator.new(:notion_resource => notion_resource, :site => site,
+                                :plugin => plugin)
+      else
+        DataGenerator.new(:notion_resource => notion_resource, :site => site, :plugin => plugin)
+      end
+    end
+  end
+end

data/lib/jekyll-notion/notion_database.rb

@@ -1,24 +1,16 @@
 # frozen_string_literal: true
 
 module JekyllNotion
-  class NotionDatabase
-    def initialize(config:)
-      @notion = Notion::Client.new
-      @config = config
-    end
-
-    def pages
+  class NotionDatabase < AbstractNotionResource
+    # Returns an empty array or a NotionToMd:Page array
+    def fetch
       return [] unless id?
 
-      @pages ||= @notion.database_query(query)[:results].map do |page|
-        NotionToMd::Page.new(:page => page)
+      @fetch ||= @notion.database_query(query)[:results].map do |page|
+        NotionToMd::Page.new(:page => page, :blocks => @notion.block_children(:id => page.id))
       end
     end
 
-    def config
-      @config || {}
-    end
-
     def filter
       config["filter"]
     end
@@ -27,25 +19,16 @@ module JekyllNotion
       config["sort"]
     end
 
-    def id
-      config["id"]
+    def collection_name
+      config["collection"] || "posts"
     end
 
-    def collection
-      config["collection"] || "posts"
+    def data_name
+      config["data"]
     end
 
     private
 
-    def id?
-      if id.nil? || id.empty?
-        Jekyll.logger.warn("Jekyll Notion:",
-                           "database id is not provided. Cannot read from Notion.")
-        return false
-      end
-      true
-    end
-
     def query
       { :id => id, :filter => filter, :sort => sort }.compact
     end

data/lib/jekyll-notion/notion_page.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class NotionPage < AbstractNotionResource
+    # Returns the nil or a NotionToMd::Page instance
+    def fetch
+      return nil unless id?
+
+      @fetch ||= NotionToMd::Page.new(:page   => @notion.page(query),
+                                      :blocks => @notion.block_children(query))
+    end
+
+    def data_name
+      config["data"]
+    end
+
+    def collection_name
+      nil
+    end
+
+    private
+
+    def query
+      { :id => id }
+    end
+  end
+end

data/lib/jekyll-notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllNotion
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/jekyll-notion.rb

@@ -13,7 +13,12 @@ Notion.configure do |config|
 end
 
 module JekyllNotion
+  autoload :GeneratorFactory, "jekyll-notion/generator_factory"
+  autoload :AbstractGenerator, "jekyll-notion/abstract_generator"
+  autoload :AbstractNotionResource, "jekyll-notion/abstract_notion_resource"
   autoload :CollectionGenerator, "jekyll-notion/collection_generator"
+  autoload :DataGenerator, "jekyll-notion/data_generator"
   autoload :DocumentWithoutAFile, "jekyll-notion/document_without_a_file"
   autoload :NotionDatabase, "jekyll-notion/notion_database"
+  autoload :NotionPage, "jekyll-notion/notion_page"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,10 +110,15 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/jekyll-notion.rb
+- lib/jekyll-notion/abstract_generator.rb
+- lib/jekyll-notion/abstract_notion_resource.rb
 - lib/jekyll-notion/collection_generator.rb
+- lib/jekyll-notion/data_generator.rb
 - lib/jekyll-notion/document_without_a_file.rb
 - lib/jekyll-notion/generator.rb
+- lib/jekyll-notion/generator_factory.rb
 - lib/jekyll-notion/notion_database.rb
+- lib/jekyll-notion/notion_page.rb
 - lib/jekyll-notion/version.rb
 homepage: https://github.com/emoriarty/jekyll-notion
 licenses: