jekyll-notion 0.2.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c220aa475033e8ddb50ef928b9104c3b8d5da793bbe777062783eb5fbd1491e
-  data.tar.gz: c99b1e1b3cebbc00420d8b857e545fa9ae6ac83aad4da110fabf780a0c42a816
+  metadata.gz: 043b3ae753a651d756c95dc6372af86589106030dd3d41d8b886ccc95c5d5d7a
+  data.tar.gz: 5a6bf3508185e27978836cd1158ef70a080d53be183c642d7948015f6d7de215
 SHA512:
-  metadata.gz: 74c1c36de04d025b121fce5634bfdd739796880208114e1dcdac9f49ec2302b16188f54abb1f8bafc07b3911627a2753e6e6c8d750559384ea9bfb94f1c25cb0
-  data.tar.gz: a42ae853c9371cd60ffd6e4cd00cc47e02c9eee64d44579ec1ea88f1e4c0e64208a536cec7bc2fea0c6ab1b6ea00b6dcdde23d5aa1110190b48e7e3b6bceabc3
+  metadata.gz: 74e147fe3f6f91a88bafb24f273284bb71d42f39f207c48f85577229aebb6ceb6de6cbe331b48e6f99afb6191466e9f27d436fb45bc710104a0ac3a80e016c6c
+  data.tar.gz: 2257337e331db87e4594e5117739ea7e1082739b3f497a4c63bba7f2dc79d2c173a484fc574ea20eb40d8650c14c84a607c9e17cef9f49174ff97bf79edab73e

data/README.md

@@ -40,6 +40,8 @@ notion:
     id: e42383cd-4975-4897-b967-ce453760499f
 ```
 
+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.
@@ -58,7 +60,20 @@ notion:
       collection: films
 ```
 
-When no collection is defined, the `posts` collection is used by default.
+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.
 
 ### Database options
 
@@ -68,7 +83,6 @@ Each dabatase support the following options.
 * `collection`: the collection each page belongs to (posts by default),
 * `filter`: the database query filter,
 * `sort`: the database query sort,
-* `frontmatter`: additional front matter to append to each page in the collection.
 
 ```yml
 notion:
@@ -77,12 +91,8 @@ notion:
     collection: posts
     filter: { "property": "Published", "checkbox": { "equals": true } }
     sort: { "property": "Last ordered", "direction": "ascending" }
-    frontmatter:
-      layout: post
 ```
 
-Note that you can also use [front matter defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) to declare common key value pairs per collection.
-
 ### Watch
 
 By default, databases are only requested during the first build. Subsequent builds use the results from the cache.
@@ -102,7 +112,7 @@ And that's all. Each page in the notion database will be included in the selecte
 
 Below, default properties per notion page are set for each document front matter.
 
-Notion properties include page `id`, `title`, `created_time`, `last_edited_time`, `icon` and `cover`.
+Notion page properties are `id`, `title`, `created_time`, `last_edited_time`, `icon`, `cover` and `archived`.
 
 ```
 ---
@@ -110,47 +120,14 @@ id: e42383cd-4975-4897-b967-ce453760499f
 title: An amazing post
 cover: https://img.bank.sh/an_image.jpg
 date: 2022-01-23T12:31:00.000Z
-icon: \U0001F4A5
----
-```
-
-Default properties prevail over custom properties declared in the front matter config.
-
-### Custom properties
-
-In addition to default properties, custom properties are also supported.
-
-Custom properties are appended to the page frontmatter by default. Every property name are downcased and snake-cased.
-For example, two properties named `Multiple Options` and `Tags` will be transformed to `multiple_options` and `tags`, respectively.
-
-```
----
-id: 2190450d-4cb3-4739-a5c8-340c4110fe21
-title: A title
-cover: https://img.bank.sh/an_image.jpg
-date: 2022-01-23T12:31:00.000Z
-icon: \U0001F4A5
-tags: tag1, tag2, tag3
-multiple_options: option1, option2
+icon: 💥
+archived: false
 ---
 ```
 
-The supported property types are:
-
-* `number`
-* `select`
-* `multi_select`
-* `date`
-* `people`
-* `files`
-* `checkbox`
-* `url`
-* `email`
-* `phone_number`
-
-`created_by`, `last_edited_by`, `rich_text` as advanced types like `formula`, `relation` and `rollup` are not supported.
+In addition to default properties, custom properties are also appended to front matter.
 
-Check notion documentation about [property values](https://developers.notion.com/reference/property-value-object#all-property-values).
+Please, refer to the [notion_to_md](https://github.com/emoriarty/notion_to_md/) gem to learn more.
 
 ## Page filename
 

data/lib/jekyll-notion/abstract_generator.rb

@@ -0,0 +1,15 @@
+# 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/collection_generator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  class CollectionGenerator < AbstractGenerator
+    def generate
+      @db.pages.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
+    end
+
+    def collection
+      @site.collections[@db.collection]
+    end
+
+    private
+
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
+      File.exist? @site.in_source_dir(file_path)
+    end
+
+    def make_doc(page)
+      new_post = DocumentWithoutAFile.new(
+        make_path(page),
+        { :site => @site, :collection => collection }
+      )
+      new_post.content = make_md(page)
+      new_post.read
+      new_post
+    end
+
+    def make_path(page)
+      "_#{@db.collection}/#{make_filename(page)}"
+    end
+
+    def make_filename(page)
+      if @db.collection == "posts"
+        "#{page.created_time.to_date}-#{Jekyll::Utils.slugify(page.title,
+                                                              :mode => "latin")}.md"
+      else
+        "#{page.title.downcase.parameterize}.md"
+      end
+    end
+
+    def make_md(page)
+      NotionToMd::Converter.new(:page_id => page.id).convert(:frontmatter => true)
+    end
+
+    def log_new_page(page)
+      Jekyll.logger.info("Jekyll Notion:", "Page => #{page.title}")
+      if @site.config.dig(
+        "collections", @db.collection, "output"
+      )
+        Jekyll.logger.info("",
+                           "Path => #{collection.docs.last.path}")
+      end
+      Jekyll.logger.debug("", "Props => #{collection.docs.last.data.keys.inspect}")
+    end
+  end
+end

data/lib/jekyll-notion/data_generator.rb

@@ -0,0 +1,17 @@
+# 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.rb

@@ -16,23 +16,6 @@ module JekyllNotion
       end
     end
 
-    protected
-
-    def read_notion_database
-      databases.each do |db_config|
-        @current_db = NotionDatabase.new(:config => db_config)
-        @current_db.pages.each do |page|
-          @current_page = page
-          next if file_exists?(make_path)
-
-          current_collection.docs << make_page
-          log_new_page
-        end
-        # Store current collection
-        collections[current_db.collection] = current_collection
-      end
-    end
-
     def databases
       config["databases"] || [config["database"]]
     end
@@ -41,62 +24,25 @@ module JekyllNotion
       @collections ||= {}
     end
 
-    # Checks if a file already exists in the site source
-    def file_exists?(file_path)
-      File.exist? @site.in_source_dir(file_path)
-    end
-
-    def make_page
-      new_post = DocumentWithoutAFile.new(
-        make_path,
-        { :site => @site, :collection => current_collection }
-      )
-      new_post.content = "#{make_frontmatter}\n\n#{make_md}"
-      new_post.read
-      new_post
+    def data
+      @data ||= {}
     end
 
-    def make_path
-      "_#{current_db.collection}/#{make_filename}"
-    end
+    protected
 
-    def make_filename
-      if current_db.collection == "posts"
-        "#{current_page.created_date}-#{Jekyll::Utils.slugify(current_page.title,
-                                                              :mode => "latin")}.md"
-      else
-        "#{current_page.title.downcase.parameterize}.md"
+    def read_notion_database
+      databases.each do |db_config|
+        db = NotionDatabase.new(:config => db_config)
+        GeneratorFactory.for(:db => db, :site => @site, :plugin => self).generate
       end
     end
 
-    def make_md
-      NotionToMd::Converter.new(:page_id => current_page.id).convert
-    end
-
-    def make_frontmatter
-      data = Jekyll::Utils.deep_merge_hashes(current_db.frontmatter, page_frontmatter)
-      frontmatter = data.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
-      <<~CONTENT
-        ---
-        #{frontmatter}
-        ---
-      CONTENT
-    end
-
-    def page_frontmatter
-      Jekyll::Utils.deep_merge_hashes(current_page.custom_props, current_page.default_props)
-    end
-
-    def current_collection
-      @site.collections[current_db.collection]
-    end
-
     def config
       @config ||= @site.config["notion"] || {}
     end
 
     def fetch_on_watch?
-      config["fetch_on_watch"].present?
+      config["fetch_on_watch"] == true
     end
 
     def notion_token?
@@ -114,16 +60,5 @@ module JekyllNotion
       end
       true
     end
-
-    def log_new_page
-      Jekyll.logger.info("Jekyll Notion:", "Page => #{current_page.title}")
-      if @site.config.dig(
-        "collections", current_db.collection, "output"
-      )
-        Jekyll.logger.info("",
-                           "Path => #{current_collection.docs.last.path}")
-      end
-      Jekyll.logger.debug("", "Props => #{page_frontmatter.keys.inspect}")
-    end
   end
 end

data/lib/jekyll-notion/generator_factory.rb

@@ -0,0 +1,13 @@
+# 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

data/lib/jekyll-notion/notion_database.rb

@@ -11,7 +11,7 @@ module JekyllNotion
       return [] unless id?
 
       @pages ||= @notion.database_query(query)[:results].map do |page|
-        NotionPage.new(:page => page, :layout => layout)
+        NotionToMd::Page.new(:page => page)
       end
     end
 
@@ -31,16 +31,12 @@ module JekyllNotion
       config["id"]
     end
 
-    def frontmatter
-      config["frontmatter"] || {}
-    end
-
     def collection
       config["collection"] || "posts"
     end
 
-    def layout
-      config["layout"]
+    def data
+      config["data"]
     end
 
     private

data/lib/jekyll-notion/version.rb

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

data/lib/jekyll-notion.rb

@@ -4,8 +4,6 @@ require "jekyll"
 require "notion"
 require "notion_to_md"
 require "logger"
-require "active_support/inflector"
-require "active_support/core_ext/object/blank"
 require "jekyll-notion/generator"
 
 NotionToMd::Logger.level = Logger::ERROR
@@ -15,7 +13,10 @@ 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 :DocumentWithoutAFile, "jekyll-notion/document_without_a_file"
   autoload :NotionDatabase, "jekyll-notion/notion_database"
-  autoload :NotionPage, "jekyll-notion/notion_page"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -124,10 +110,13 @@ 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/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:

data/lib/jekyll-notion/notion_page.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllNotion
-  class NotionPage
-    attr_reader :page, :layout
-
-    def initialize(page:, layout:)
-      @page = page
-      @layout = layout
-    end
-
-    def title
-      page.dig(:properties, :Name, :title).inject("") do |acc, slug|
-        acc + slug[:plain_text]
-      end
-    end
-
-    def cover
-      page.dig(:cover, :external, :url)
-    end
-
-    def icon
-      page.dig(:icon, :emoji)
-    end
-
-    def id
-      page[:id]
-    end
-
-    def created_date
-      created_datetime.to_date
-    end
-
-    def created_datetime
-      DateTime.parse(page["created_time"])
-    end
-
-    def updated_date
-      updated_datetime.to_date
-    end
-
-    def updated_datetime
-      DateTime.parse(page["last_edited_time"])
-    end
-
-    def url
-      page[:url]
-    end
-
-    def custom_props
-      @custom_props ||= page.properties.each_with_object({}) do |prop, memo|
-        name = prop.first
-        value = prop.last # Notion::Messages::Message
-        type = value.type
-
-        next memo unless CustomProperty.respond_to?(type.to_sym)
-
-        memo[name.parameterize.underscore] = CustomProperty.send(type, value)
-      end.reject { |_k, v| v.presence.nil? }
-    end
-
-    def default_props
-      @default_props ||= {
-        "id"           => id,
-        "title"        => title,
-        "date"         => created_datetime,
-        "cover"        => cover,
-        "icon"         => icon,
-        "updated_date" => updated_datetime,
-      }
-    end
-
-    class CustomProperty
-      class << self
-        def multi_select(prop)
-          multi_select = prop.multi_select.map(&:name).join(", ")
-          "[#{multi_select}]"
-        end
-
-        def select(prop)
-          prop["select"].name
-        end
-
-        def people(prop)
-          people = prop.people.map(&:name).join(", ")
-          "[#{people}]"
-        end
-
-        def files(prop)
-          files = prop.files.map { |f| f.file.url }.join(", ")
-          "[#{files}]"
-        end
-
-        def phone_number(prop)
-          prop.phone_number
-        end
-
-        def number(prop)
-          prop.number
-        end
-
-        def email(prop)
-          prop.email
-        end
-
-        def checkbox(prop)
-          prop.checkbox.to_s
-        end
-
-        # date type properties not supported:
-        # - end
-        # - time_zone
-        def date(prop)
-          prop.date.start
-        end
-
-        def url(prop)
-          prop.url
-        end
-      end
-    end
-  end
-end