jekyll-notion 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac8561afc4f42d433ae33d4baafb38e9eaf7a34167513bf628eef849c3e773b7
-  data.tar.gz: 7c55ac94b8490943d981f3c25d36d0b3993680614ba25cdb16be78f07b5e028a
+  metadata.gz: 79520a9f4d598b024d2934fd68140f0f34775e2611ff601b1352ba60f67e9dd3
+  data.tar.gz: bcd325965c4eec49a498fe99c2101fa238f6c67587cb13723927abe0b8e83c1f
 SHA512:
-  metadata.gz: d402be5b38a3dc4cae78daf0e95140ecc0b593db1091ac325f262a68024236f50639c25f1bee42db6cee025122bfb82d2318f312909278509c66f2375062d4d1
-  data.tar.gz: c22e49f752ba7a848c6329e55c57707c6bc9d59e510f5407a112448335a9a36b877c9abe4e94cf30fd383db29defd5fafbba14558742417375c4df4990f91a90
+  metadata.gz: 17ca3742b0b48a22dd7cca185c25f9368565e7af35ccdc3e9add259faa20aa101e908aac961363c1ecf2b0d2f6822153e6b7d4a6bc53a3dc1d49697cb1199bc1
+  data.tar.gz: 0a46f5e5ce29f09bc1966ac4199a080da5eea58cedcaa37062cf5fd3bc77b35a8ad45bbf1067d01d32ca9094e53e36e21223187b8c3d94970ef092eb09ca56d0

data/README.md

@@ -22,16 +22,18 @@ 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_...>
 ```
 
+### 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
@@ -40,12 +42,9 @@ notion:
     id: 5cfed4de3bdc4f43ae8ba653a7a2219b
 ```
 
-After running `jekyll build` (or `serve`) command, the `posts` collection is loaded with pages of the notion database specified in the configuration. 
-
+By default, the notion pages contained in the database will be loaded into the `posts` collection.
 
-### Mutiple dabatases
-
-You can also define multiple databases as follows.
+You can also define __multiple databases__ as follows.
 
 ```yml
 collections:
@@ -61,63 +60,86 @@ notion:
       collection: films
 ```
 
-### Data
+After running `jekyll build` (or `serve`) command, the `posts`, `recipes` and `films` collections will be loaded with pages from the notion databases. 
 
-Instead of storing notion pages in a collection, you can also map to the data object. Use the `data` property instead of `collection`.
+#### Database options
+
+Each dabatase support the following options.
+
+* `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,
 
 ```yml
 notion:
   database:
     id: e42383cd49754897b967ce453760499f
-    data: films
+    collection: posts
+    filter: { "property": "Published", "checkbox": { "equals": true } }
+    sort: { "property": "Last ordered", "direction": "ascending" }
 ```
 
-Page properties and body are stored as a hash data.
+### Pages
 
-As a particular characteristic, the page is stored in a key named `content`.
+Individual Notion pages can also be loaded into Jekyll. Just define the `page` property as follows.
 
-```html
-<p>{{ site.data.films.content }}</p>
+```yml
+notion:
+  page:
+    id: 5cfed4de3bdc4f43ae8ba653a7a2219b
 ```
 
-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.
+As databases, we can set up multiple pages.
 
 ```yaml
 notion:
   pages:
     - id: e42383cd49754897b967ce453760499f
-      data: about
     - id: b0e688e199af4295ae80b67eb52f2e2f
-      data: contact
     - id: 2190450d4cb34739a5c8340c4110fe21
-      data: footer
-
 ```
 
-_This feature is only available for data._
+The filename of the generated page is the notion page title. Check [below](#page-filename) for more info.
 
-### Database options
+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`.
 
-Each dabatase support the following options.
+### Data
 
-* `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,
+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:
-  database:
-    id: e42383cd49754897b967ce453760499f
-    collection: posts
-    filter: { "property": "Published", "checkbox": { "equals": true } }
-    sort: { "property": "Last ordered", "direction": "ascending" }
+  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.
@@ -156,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/{generator_factory.rb → factories/database_factory.rb}

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

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

data/lib/jekyll-notion/{collection_generator.rb → generators/collection_generator.rb}

@@ -57,7 +57,7 @@ module JekyllNotion
         "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/{data_generator.rb → generators/data_generator.rb}

@@ -28,7 +28,7 @@ module JekyllNotion
     # Returns String the converted content.
     def convert(page)
       converters.reduce(page.body) do |output, converter|
-        converter.convert output
+        converter.convert(output)
       rescue StandardError => e
         Jekyll.logger.error "Conversion error:",
                             "#{converter.class} encountered an error while "\
@@ -44,14 +44,16 @@ module JekyllNotion
 
     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
+        data.each { |page| log_page(page, Array.to_s) }
       else
-        Jekyll.logger.info("Jekyll Notion:", "Page => #{data["title"]}")
-        Jekyll.logger.debug("", "Props => #{data.keys.inspect}")
+        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/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.2.0"
+  VERSION = "2.0.0"
 end

data/lib/jekyll-notion.rb

@@ -13,12 +13,15 @@ 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 :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.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -110,15 +110,18 @@ 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/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: