jekyll-notion 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 043b3ae753a651d756c95dc6372af86589106030dd3d41d8b886ccc95c5d5d7a
-  data.tar.gz: 5a6bf3508185e27978836cd1158ef70a080d53be183c642d7948015f6d7de215
+  metadata.gz: 79520a9f4d598b024d2934fd68140f0f34775e2611ff601b1352ba60f67e9dd3
+  data.tar.gz: bcd325965c4eec49a498fe99c2101fa238f6c67587cb13723927abe0b8e83c1f
 SHA512:
-  metadata.gz: 74e147fe3f6f91a88bafb24f273284bb71d42f39f207c48f85577229aebb6ceb6de6cbe331b48e6f99afb6191466e9f27d436fb45bc710104a0ac3a80e016c6c
-  data.tar.gz: 2257337e331db87e4594e5117739ea7e1082739b3f497a4c63bba7f2dc79d2c173a484fc574ea20eb40d8650c14c84a607c9e17cef9f49174ff97bf79edab73e
+  metadata.gz: 17ca3742b0b48a22dd7cca185c25f9368565e7af35ccdc3e9add259faa20aa101e908aac961363c1ecf2b0d2f6822153e6b7d4a6bc53a3dc1d49697cb1199bc1
+  data.tar.gz: 0a46f5e5ce29f09bc1966ac4199a080da5eea58cedcaa37062cf5fd3bc77b35a8ad45bbf1067d01d32ca9094e53e36e21223187b8c3d94970ef092eb09ca56d0

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
 
@@ -22,29 +22,29 @@ plugins:
   - jekyll-notion
 ```
 
-## Setup
+## Usage
 
 Before using the gem create an integration and generate a secret token. Check [notion getting started guide](https://developers.notion.com/docs/getting-started) to learn more.
 
-Export the notion secret token in an environment variable named `NOTION_TOKEN`.
+Once you have youe secret, export it in an environment variable named `NOTION_TOKEN`.
 
 ```bash
 $ export NOTION_TOKEN=<secret_...>
 ```
 
-Once your notion database has been shared, specify the  database `id` in your `_config.yml` as follows.
+### Databases
+
+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
+By default, the notion pages contained in the database will be loaded into the `posts` collection.
 
-You can also define multiple databases as follows.
+You can also define __multiple databases__ as follows.
 
 ```yml
 collections:
@@ -53,29 +53,16 @@ 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
 ```
 
-In this example, the notion database `b0e688e1-99af-4295-ae80-b67eb52f2e2f` pages are mapped into the posts collection. `recipes` and `films` will contain the database pages `2190450d-4cb3-4739-a5c8-340c4110fe21` and  `e42383cd-4975-4897-b967-ce453760499f`, respectively.
-
-### data
-
-Instead of storing notion pages in a collection, you can also map to the data object. Declare the data property as follows.
-
-```yml
-notion:
-  database:
-    id: e42383cd-4975-4897-b967-ce453760499f
-    data: films
-```
-
-Unlike collections, only the properties of the notion page are assigned to the each data item. The body of the notion page is omitted.
+After running `jekyll build` (or `serve`) command, the `posts`, `recipes` and `films` collections will be loaded with pages from the notion databases. 
 
-### Database options
+#### Database options
 
 Each dabatase support the following options.
 
@@ -87,12 +74,72 @@ 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" }
 ```
 
+### Pages
+
+Individual Notion pages can also be loaded into Jekyll. Just define the `page` property as follows.
+
+```yml
+notion:
+  page:
+    id: 5cfed4de3bdc4f43ae8ba653a7a2219b
+```
+
+As databases, we can set up multiple pages.
+
+```yaml
+notion:
+  pages:
+    - id: e42383cd49754897b967ce453760499f
+    - id: b0e688e199af4295ae80b67eb52f2e2f
+    - id: 2190450d4cb34739a5c8340c4110fe21
+```
+
+The filename of the generated page is the notion page title. Check [below](#page-filename) for more info.
+
+All properties assigned to a notion page will be interpreted by jekyll as front matter. For example, if the [permalink](https://jekyllrb.com/docs/permalinks/#front-matter) property is set to `/about/` in the notion page, jekyll will use it to create the corresponding path at the output directory at `/about/index.html`.
+
+### Data
+
+Instead of storing the notion pages in a collection or in the pages list, you can assign them to the data object.Just declare the `data` property next to the page or database id.
+
+```yml
+notion:
+  databases:
+    - id: b0e688e199af4295ae80b67eb52f2e2f
+    - id: e42383cd49754897b967ce453760499f
+      data: films
+  pages:
+    - id: e42383cd49754897b967ce453760499f
+    - id: b0e688e199af4295ae80b67eb52f2e2f
+      data: about
+```
+
+Page properties and body of the notion page are stored as a hash object.
+
+In the previous example, data objects can be accesses as follows.
+
+```html
+<ul>
+{% for film in site.data.films %}
+  <li>{{ film.title }}</li>
+{% endfor %}
+</ul>
+```
+
+Notice, the page body is stored in the key `content`.
+
+```html
+{{ site.data.about.content }}
+```
+
+The rest of properties are mapped as expected. For more info go to [notion properties](#notion-properties).
+
 ### Watch
 
 By default, databases are only requested during the first build. Subsequent builds use the results from the cache.
@@ -103,7 +150,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.
@@ -131,12 +178,12 @@ Please, refer to the [notion_to_md](https://github.com/emoriarty/notion_to_md/)
 
 ## Page filename
 
-There are two kinds of collections: posts and others.
+There are two kinds of documents in Jekyll: posts and others.
 
-When the collection is posts, the filename format contains the `created_time` property plus the page title as specified in [jekyll docs](https://jekyllrb.com/docs/posts/#creating-posts).
+When the document is a post, the filename format contains the `created_time` property plus the page title as specified in [jekyll docs](https://jekyllrb.com/docs/posts/#creating-posts).
 
 ```
 YEAR-MONTH-DAY-title.MARKUP
 ```
 
-Any other collection, the filename is the page title.
+The filename for any other document is the page title.

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/factories/database_factory.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class DatabaseFactory
+    def self.for(notion_resource:, site:, plugin:)
+      if 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/factories/page_factory.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class PageFactory
+    def self.for(notion_resource:, site:, plugin:)
+      if notion_resource.data_name.nil?
+        PageGenerator.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/generator.rb

@@ -9,17 +9,24 @@ module JekyllNotion
 
       return unless notion_token? && config?
 
-      if fetch_on_watch? || collections.empty?
-        read_notion_database
+      if fetch_on_watch? || cache_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 }
+        pages.each { |page| @site.pages << page }
       end
     end
 
-    def databases
+    def config_databases
       config["databases"] || [config["database"]]
     end
 
+    def config_pages
+      config["pages"] || [config["page"]]
+    end
+
     def collections
       @collections ||= {}
     end
@@ -28,12 +35,27 @@ module JekyllNotion
       @data ||= {}
     end
 
+    def pages
+      @pages ||= []
+    end
+
     protected
 
-    def read_notion_database
-      databases.each do |db_config|
+    def cache_empty?
+      collections.empty? && pages.empty? && data.empty? 
+    end
+
+    def read_notion_databases
+      config_databases.each do |db_config|
         db = NotionDatabase.new(:config => db_config)
-        GeneratorFactory.for(:db => db, :site => @site, :plugin => self).generate
+        DatabaseFactory.for(:notion_resource => db, :site => @site, :plugin => self).generate
+      end
+    end
+
+    def read_notion_pages
+      config_pages.each do |page_config|
+        page = NotionPage.new(:config => page_config)
+        PageFactory.for(:notion_resource => page, :site => @site, :plugin => self).generate
       end
     end
 

data/lib/jekyll-notion/generators/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/{collection_generator.rb → generators/collection_generator.rb}

@@ -3,18 +3,18 @@
 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
       # Caching current collection
-      @plugin.collections[@db.collection] = collection
+      @plugin.collections[@notion_resource.collection_name] = collection
     end
 
     def collection
-      @site.collections[@db.collection]
+      @site.collections[@notion_resource.collection_name]
     end
 
     private
@@ -35,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
@@ -54,10 +54,10 @@ 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}")
+                           "URL => #{collection.docs.last.url}")
       end
       Jekyll.logger.debug("", "Props => #{collection.docs.last.data.keys.inspect}")
     end

data/lib/jekyll-notion/generators/data_generator.rb

@@ -0,0 +1,59 @@
+# 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 { |page| log_page(page, Array.to_s) }
+      else
+        log_page(data, Hash.to_s)
+      end
+    end
+
+    def log_page(page, type)
+      Jekyll.logger.info("Jekyll Notion:", "Page => #{page["title"]}")
+      Jekyll.logger.info("", "#{type} => site.data.#{@notion_resource.data_name}")
+      Jekyll.logger.debug("", "Props => #{page.keys.inspect}")
+    end
+  end
+end

data/lib/jekyll-notion/generators/page_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class PageGenerator < AbstractGenerator
+    def generate
+      notion_page = @notion_resource.fetch
+      unless notion_page.nil?
+        page = make_page(notion_page)
+        @site.pages << page
+        log_page(notion_page)
+        @plugin.pages << page
+      end
+    end
+
+    def make_page(notion_page)
+      JekyllNotion::PageWithoutAFile.new(@site, @site.source, "", "#{notion_page.title}.md",
+                                         make_md)
+    end
+
+    def log_page(notion_page)
+      Jekyll.logger.info("Jekyll Notion:", "Page => #{notion_page.title}")
+      Jekyll.logger.info("", "URL => #{@site.pages.last.url}")
+      Jekyll.logger.debug("", "Props => #{notion_page.props.keys.inspect}")
+    end
+
+    def make_md
+      NotionToMd::Converter.new(:page_id => @notion_resource.id).convert(:frontmatter => true)
+    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,29 +19,16 @@ module JekyllNotion
       config["sort"]
     end
 
-    def id
-      config["id"]
-    end
-
-    def collection
+    def collection_name
       config["collection"] || "posts"
     end
 
-    def data
+    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/page_without_a_file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class PageWithoutAFile < Jekyll::Page
+    def initialize(site, base, dir, name, new_content)
+      self.content = new_content
+      super(site, base, dir, name)
+    end
+
+    def read_yaml(base, name, _opts = {})
+      filename = @path || site.in_source_dir(base, name)
+      Jekyll.logger.debug "Reading:", relative_path
+
+      begin
+        if content =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+          self.content = Regexp.last_match.post_match
+          self.data = SafeYAML.load(Regexp.last_match(1))
+        end
+      rescue Psych::SyntaxError => e
+        Jekyll.logger.warn "YAML Exception reading page #{name}: #{e.message}"
+        raise e if site.config["strict_front_matter"]
+      end
+
+      self.data ||= {}
+
+      validate_data! filename
+      validate_permalink! filename
+
+      self.data
+    end
+  end
+end

data/lib/jekyll-notion/version.rb

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

data/lib/jekyll-notion.rb

@@ -13,10 +13,15 @@ Notion.configure do |config|
 end
 
 module JekyllNotion
-  autoload :GeneratorFactory, "jekyll-notion/generator_factory"
-  autoload :AbstractGenerator, "jekyll-notion/abstract_generator"
-  autoload :CollectionGenerator, "jekyll-notion/collection_generator"
-  autoload :DataGenerator, "jekyll-notion/data_generator"
+  autoload :DatabaseFactory, "jekyll-notion/factories/database_factory"
+  autoload :PageFactory, "jekyll-notion/factories/page_factory"
+  autoload :AbstractGenerator, "jekyll-notion/generators/abstract_generator"
+  autoload :DataGenerator, "jekyll-notion/generators/data_generator"
+  autoload :PageGenerator, "jekyll-notion/generators/page_generator"
+  autoload :CollectionGenerator, "jekyll-notion/generators/collection_generator"
   autoload :DocumentWithoutAFile, "jekyll-notion/document_without_a_file"
+  autoload :PageWithoutAFile, "jekyll-notion/page_without_a_file"
+  autoload :AbstractNotionResource, "jekyll-notion/abstract_notion_resource"
   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.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-03-16 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,13 +110,18 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/jekyll-notion.rb
-- lib/jekyll-notion/abstract_generator.rb
-- lib/jekyll-notion/collection_generator.rb
-- lib/jekyll-notion/data_generator.rb
+- lib/jekyll-notion/abstract_notion_resource.rb
 - lib/jekyll-notion/document_without_a_file.rb
+- lib/jekyll-notion/factories/database_factory.rb
+- lib/jekyll-notion/factories/page_factory.rb
 - lib/jekyll-notion/generator.rb
-- lib/jekyll-notion/generator_factory.rb
+- lib/jekyll-notion/generators/abstract_generator.rb
+- lib/jekyll-notion/generators/collection_generator.rb
+- lib/jekyll-notion/generators/data_generator.rb
+- lib/jekyll-notion/generators/page_generator.rb
 - lib/jekyll-notion/notion_database.rb
+- lib/jekyll-notion/notion_page.rb
+- lib/jekyll-notion/page_without_a_file.rb
 - lib/jekyll-notion/version.rb
 homepage: https://github.com/emoriarty/jekyll-notion
 licenses:

data/lib/jekyll-notion/abstract_generator.rb

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

data/lib/jekyll-notion/data_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllNotion
-  class DataGenerator < AbstractGenerator
-    def generate
-      @site.data[@db.data] = data
-      # Caching current data
-      @plugin.data[@db.data] = data
-    end
-
-    private
-
-    def data
-      @data ||= @db.pages.map(&:props)
-    end
-  end
-end

data/lib/jekyll-notion/generator_factory.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllNotion
-  class GeneratorFactory
-    def self.for(db:, site:, plugin:)
-      if db.data.nil?
-        CollectionGenerator.new(:db => db, :site => site, :plugin => plugin)
-      else
-        DataGenerator.new(:db => db, :site => site, :plugin => plugin)
-      end
-    end
-  end
-end