jekyll-notion 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8a62e0d2b12f5cedd1f405e289e95a974a22a80e8c4ffd9e0798a75806773a
-  data.tar.gz: 4668f71e64ff3604223b664a251b22931ce23d889c535b06e39f735891252074
+  metadata.gz: f85b870a3e8c0aa6ea64575b8ef8541f61183fa25ced6f41570384057a3a36dd
+  data.tar.gz: c66f6d831e8352f029fc1f81608f751aac1ed2b5959b6c2ee19f861eafcdb6f0
 SHA512:
-  metadata.gz: ae19056b6cd4692b327d37803bf2c4a7afda07f6736cf2af660c12908694249a34c5e813191843d6ee2aa230f211a4044fbdca1fb203a827f6629aa3707e9e5c
-  data.tar.gz: a7dd6dea825e2124032ec6900638a913fcc4e05de009798e24b365aa19c41f80fd399316bc6b9f811ea4c8a96e659d9cab11371dff60650752a7bd3aff847df8
+  metadata.gz: 26fda79bcfce19d75fda17e6f3e1a90080089c05132359b50f00ec3a4d54d844e6ef583bb558c961209d5818465c6ada865413a33f22fea15fdf943ecd213d8d
+  data.tar.gz: 430aa7ef405283f1568eacf4062a90a60fc0e086ae6c7d68cd96cd1eac5f8208d57d8cdebc02b0e98c653d0bff62b119c4ec6ceb4af31777c2a4a28121e0eb55

data/README.md

@@ -32,86 +32,87 @@ 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 `id` in your `_config.yml` as follows.
+Once your notion database has been shared, specify the  database `id` in your `_config.yml` as follows.
 
 ```yml
 notion:
-  fetch_on_watch: false
   database:
-    id: b91d5...
-    collection: posts
-    filter: { "property": "Published", "checkbox": { "equals": true } }
-    sort: { "property": "Last ordered", "direction": "ascending" }
-    frontmatter:
-      layout: post
+    id: e42383cd-4975-4897-b967-ce453760499f
 ```
 
-`fetch_on_watch` when set to `true` it allows fetching notion pages on each rebuild. By default is off, pages are only retrieved in the first build.
+### Mutiple dabatases
+
+You can also define multiple databases as follows.
+
+```yml
+collections:
+  - recipes
+  - films
+
+notion:
+  databases:
+    - id: b0e688e1-99af-4295-ae80-b67eb52f2e2f
+    - id: 2190450d-4cb3-4739-a5c8-340c4110fe21
+      collection: recipes
+    - id: e42383cd-4975-4897-b967-ce453760499f 
+      collection: films
+```
+
+When no collection is defined, the `posts` collection is used by default.
+
+### Database options
+
+Each dabatase support the following options.
 
-`database` properties are:
 * `id`: the notion database unique identifier,
 * `collection`: the collection each page belongs to (posts by default),
 * `filter`: the database query filter,
 * `sort`: the database query sort,
-* `frontmatter`: additional frontmatter to append to each page in the collection.
-
-Note: Only one notion database is available.
 
-And that's all. Each page in the notion database will be included in the selected collection.
+```yml
+notion:
+  database:
+    id: e42383cd-4975-4897-b967-ce453760499f
+    collection: posts
+    filter: { "property": "Published", "checkbox": { "equals": true } }
+    sort: { "property": "Last ordered", "direction": "ascending" }
+```
 
-## Notion properties
+### Watch
 
-Below, page notion default properties are set in each page frontmatter.
+By default, databases are only requested during the first build. Subsequent builds use the results from the cache.
 
-Default properties include  `title`, created_time`, `last_edited_time`, `icon` and `cover.
+Set `fetch_on_watch` to true to allow request on each rebuild.
 
-```
----
-id: b2998...
-title: A title
-cover: https://img.bank.sh/an_image.jpg
-date: 2022-01-23T12:31:00.000Z
-icon: \U0001F4A5
----
+```yml
+notion:
+  fetch_on_watch: true
+  database:
+    id: e42383cd-4975-4897-b967-ce453760499f
 ```
 
-Any property provided in the frontmatter config that matches a default property will be overwritten by the default value.
+And that's all. Each page in the notion database will be included in the selected collection.
 
-### Custom properties
+## Notion properties
 
-In addition to default properties, custom properties are also supported.
+Below, default properties per notion page are set for each document front matter.
 
-Custom properties are appended to page frontmatter by default. Every property name is snake-cased.
-For example, two properties named `Multiple Options` and `Tags` will be transformed to `multiple_options` and `tags`, respectively.
+Notion page properties are `id`, `title`, `created_time`, `last_edited_time`, `icon`, `cover` and `archived`.
 
 ```
 ---
-id: b2998...
-title: A title
+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
-tags: tag1, tag2, tag3
-multiple_options: option1, option2
+icon: 💥
+archived: false
 ---
 ```
 
-The supported properties 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/collection_generator.rb

@@ -0,0 +1,67 @@
+module JekyllNotion
+  class CollectionGenerator
+    def initialize(db:, site:)
+      @db = db
+      @site = site
+    end
+
+    def generate
+      @db.pages.each do |page|
+        next if file_exists?(make_path(page))
+
+        collection.docs << make_doc(page)
+        log_new_page(page)
+      end
+      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/generator.rb

@@ -2,81 +2,37 @@
 
 module JekyllNotion
   class Generator < Jekyll::Generator
-    attr_reader :current_page
+    attr_reader :current_page, :current_db
 
     def generate(site)
       @site = site
 
       return unless notion_token? && config?
 
-      if fetch_on_watch? || docs.empty?
+      if fetch_on_watch? || collections.empty?
         read_notion_database
       else
-        collection.docs = docs
+        collections.each_pair { |key, val| @site.collections[key] = val }
       end
     end
 
-    def read_notion_database
-      @db = NotionDatabase.new(:config => config)
-      @db.pages.each do |page|
-        @current_page = page
-        collection.docs << make_page
-        Jekyll.logger.info("Jekyll Notion:", "New notion page at #{collection.docs.last.path}")
-      end
-      @docs = collection.docs
-    end
-
-    def docs
-      @docs ||= []
-    end
-
-    def make_page
-      new_post = DocumentWithoutAFile.new(
-        "#{Dir.pwd}/_#{collection_name}/#{make_filename}",
-        { :site => @site, :collection => collection }
-      )
-      new_post.content = "#{make_frontmatter}\n\n#{make_md}"
-      new_post.read
-      new_post
-    end
-
-    def make_md
-      NotionToMd::Converter.new(:page_id => current_page.id).convert
-    end
+    protected
 
-    def make_frontmatter
-      data = Jekyll::Utils.deep_merge_hashes(config_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 config_frontmatter
-      config.dig("database", "frontmatter") || {}
-    end
-
-    def make_filename
-      if collection_name == "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)
+        new_collection = CollectionGenerator.new(:db => db, :site => @site).generate
+        # Caching current collection
+        collections[db.collection] = new_collection
       end
     end
 
-    def collection_name
-      config.dig("database", "collection") || "posts"
+    def databases
+      config["databases"] || [config["database"]]
     end
 
-    def collection
-      @site.collections[collection_name]
+    def collections
+      @collections ||= {}
     end
 
     def config
@@ -84,7 +40,7 @@ module JekyllNotion
     end
 
     def fetch_on_watch?
-      config["fetch_on_watch"].present?
+      config["fetch_on_watch"] == true
     end
 
     def notion_token?

data/lib/jekyll-notion/notion_database.rb

@@ -11,28 +11,32 @@ module JekyllNotion
       return [] unless id?
 
       @pages ||= @notion.database_query(query)[:results].map do |page|
-        NotionPage.new(:page => page, :layout => config["layout"])
+        NotionToMd::Page.new(:page => page)
       end
     end
 
-    private
-
     def config
-      @config["database"]
+      @config || {}
     end
 
     def filter
-      @config.dig("database", "filter")
+      config["filter"]
     end
 
     def sort
-      @config.dig("database", "sort")
+      config["sort"]
     end
 
     def id
-      @config.dig("database", "id")
+      config["id"]
+    end
+
+    def collection
+      config["collection"] || "posts"
     end
 
+    private
+
     def id?
       if id.nil? || id.empty?
         Jekyll.logger.warn("Jekyll Notion:",

data/lib/jekyll-notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllNotion
-  VERSION = "0.1.6"
+  VERSION = "1.0.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,7 @@ Notion.configure do |config|
 end
 
 module JekyllNotion
+  autoload :CollectionGenerator, "jekyll-notion/collection_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.1.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-17 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,10 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/jekyll-notion.rb
+- lib/jekyll-notion/collection_generator.rb
 - lib/jekyll-notion/document_without_a_file.rb
 - lib/jekyll-notion/generator.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