jekyll-notion 0.0.0.alpha → 0.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28969fe017d3182ae86953154bef64b2faf3fea5477eea3b315af7b0c6e99def
-  data.tar.gz: 4fe4fdeb77eaaafcadd5adce283e2a77e17ea9bfa57c32464e0c45d467038827
+  metadata.gz: 1a2d58cc88c6a7012d3efc3eb431e9030f6287feec5b1307d731fb2b8a78a6e5
+  data.tar.gz: 939b5e04a4b019fd7a295dfba5c765e4f5fb5bf0f41e1b3527b01d84bf02a2cf
 SHA512:
-  metadata.gz: 30a409cbf940624c5d60556f50c70f19edcdd6d936b969faf375f410cf5ecfaea940eb0441de1ff527717bfdef5f0580a35d7619e41f3e6ff2d75f0851776a55
-  data.tar.gz: dd5ae8d678bc6f6ebeef2703e2722161a36cecef145a275146818bea6fb0abccdb3cb9427bf1020cdd33271912e1c10c75c395eea86d51d371b6fc2fd548fe49
+  metadata.gz: bf6461f39325a08b18dfdd18ac9413e50991bc7c18032c30e59bba013ae00f77cab5b79ddcbf44100d4248cc957b98ccfd0538ddf323e3881f408e7ff5c46762
+  data.tar.gz: d451dfcbe921c165c232fa7a6195471f7da133ab6ddb46feadcc2705771cbc6092462e8ec29fa128b7d1c14db816b77ce84d07c05d2287eb53e93e4da9e7c06c

data/README.md

@@ -1,2 +1,81 @@
 # jekyll-notion
-Import pages from notion.
+
+Import notion pages to a jekyll collection.
+
+## Installation
+
+Use gem to install.
+```bash
+$ gem install 'jekyll-notion'
+```
+
+Or add it to the `Gemfile`.
+```ruby
+# Gemfile
+gem 'jekyll-notion'
+```
+
+And update your jekyll plugins property in `_config.yml`.
+
+```yml
+plugins:
+  - jekyll-notion
+```
+
+## Setup
+
+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`.
+
+```bash
+$ export NOTION_TOKEN=<secret_...>
+```
+
+Once your notion database has been shared, specify the `id` in your `_config.yml` as follows.
+
+```yml
+notion:
+  database:
+    id: b91d5...
+    collection: posts
+    filter: { "property": "Published", "checkbox": { "equals": true } }
+    sort: { "propery": "Last ordered", "direction": "ascending" }
+    frontmatter:
+      layout: post
+```
+
+The other properties are:
+* `collection`: what collection each page belongs to,
+* `filter`: the database query filter,
+* `sort`: the database query sort,
+* `frontmatter`: additional frontmatter to append to each page in the collection.
+
+Note: Only one database is available.
+
+And that's all. Each page in the notion database will be included in the selected collection.
+
+## Notion properties
+
+Below, page notion default properties are set in each page frontmatter.
+
+```
+---
+id: id
+title: properties > Name > title > plain_text
+cover: cover > external > url
+date: created_time
+---
+```
+
+## Page filename
+
+There are two kinds of collections: 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).
+
+```
+YEAR-MONTH-DAY-title.MARKUP
+```
+
+Any other collection, the filename is the page title.

data/lib/jekyll-notion/document_without_a_file.rb

@@ -2,11 +2,11 @@
 
 module JekyllNotion
   class DocumentWithoutAFile < Jekyll::Document
-    def read_content(new_content, **opts)
+    def read_content(_new_content, **_opts)
       if content =~ YAML_FRONT_MATTER_REGEXP
-        self.content = $POSTMATCH
+        self.content = Regexp.last_match.post_match
         data_file = SafeYAML.load(Regexp.last_match(1))
-        merge_data!(data_file, :source => "YAML front matter") if data_file
+        merge_data!(data_file, source: 'YAML front matter') if data_file
       end
     end
   end

data/lib/jekyll-notion/generator.rb

@@ -1,31 +1,30 @@
 # frozen_string_literal: true
 
-require 'active_support/inflector'
-require 'notion'
-require 'notion_to_md'
-require_relative './notion_database'
-
 module JekyllNotion
   class Generator < Jekyll::Generator
     attr_reader :current_page
 
-    def initialize(plugin)
-      super(plugin)
-    end
-
     def generate(site)
       @site = site
+
+      return unless notion_token?
+      return unless config?
+
+      read_notion_database
+    end
+
+    def read_notion_database
       @db = NotionDatabase.new(config: config)
       @db.pages do |page|
         @current_page = page
-        site.posts.docs << make_page
-        Jekyll.logger.info("New page from notion", site.posts.docs.last.path)
+        collection.docs << make_page
+        Jekyll.logger.info('Jekyll Notion:', "New notion page at #{collection.docs.last.path}")
       end
     end
 
     def make_page
       new_post = DocumentWithoutAFile.new(
-        "#{Dir.pwd}/_#{config['collection']}/#{make_filename}",
+        "#{Dir.pwd}/_#{collection_name}/#{make_filename}",
         { site: @site, collection: collection }
       )
       new_post.content = "#{make_frontmatter}\n\n#{make_md}"
@@ -38,27 +37,50 @@ module JekyllNotion
     end
 
     def make_frontmatter
-      <<-CONTENT
-#{config['frontmatter'].to_yaml}
-id: #{current_page.id}
-layout: #{current_page.layout}
-title: #{current_page.title}
-date: #{current_page.created_datetime.to_s}
-cover: #{current_page.cover}
----
+      <<~CONTENT
+        #{config.dig('database', 'frontmatter').to_yaml}
+        id: #{current_page.id}
+        title: #{current_page.title}
+        date: #{current_page.created_datetime}
+        cover: #{current_page.cover}
+        ---
       CONTENT
     end
 
     def make_filename
-      "#{current_page.created_date.to_s}-#{current_page.title.downcase.parameterize}.md"
+      if collection_name == 'posts'
+        "#{current_page.created_date}-#{current_page.title.downcase.parameterize}.md"
+      else
+        "#{current_page.title.downcase.parameterize}.md"
+      end
+    end
+
+    def collection_name
+      config.dig('database', 'collection')
     end
 
     def collection
-      @site.send(config['collection'].to_sym)
+      @site.send(collection_name.to_sym)
     end
 
     def config
-      @config ||= @site.config["notion"] || {}
+      @config ||= @site.config['notion'] || {}
+    end
+
+    def notion_token?
+      if ENV['NOTION_TOKEN'].nil? || ENV['NOTION_TOKEN'].empty?
+        Jekyll.logger.error('Jekyll Notion:', 'NOTION_TOKEN not provided. Cannot read from Notion.')
+        return false
+      end
+      true
+    end
+
+    def config?
+      if config.empty?
+        Jekyll.logger.error('Jekyll Notion:', 'No config provided.')
+        return false
+      end
+      true
     end
   end
 end

data/lib/jekyll-notion/notion_database.rb

@@ -1,4 +1,4 @@
-require_relative './notion_page'
+# frozen_string_literal: true
 
 module JekyllNotion
   class NotionDatabase
@@ -7,18 +7,22 @@ module JekyllNotion
       @config = config
     end
 
-    def pages
+    def pages(&block)
       @pages ||= @notion.database_query(query)[:results].map do |page|
-        NotionPage.new(page: page, layout: @config['layout'])
+        NotionPage.new(page: page, layout: config['layout'])
       end
-      
+
       return @pages unless block_given?
 
-      @pages.each { |page| yield page }
+      @pages.each(&block)
     end
 
     private
 
+    def config
+      @config['database']
+    end
+
     def filter
       @config.dig('database', 'filter')
     end
@@ -31,8 +35,8 @@ module JekyllNotion
       @config.dig('database', 'id')
     end
 
-    def query 
+    def query
       { id: id, filter: filter, sort: sort }
     end
   end
-end
+end

data/lib/jekyll-notion/notion_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllNotion
   class NotionPage
     attr_reader :page, :layout
@@ -30,7 +32,7 @@ module JekyllNotion
     end
 
     def created_datetime
-      DateTime.parse(page["created_time"])
+      DateTime.parse(page['created_time'])
     end
 
     def updated_date
@@ -38,11 +40,11 @@ module JekyllNotion
     end
 
     def updated_datetime
-      DateTime.parse(page["last_edited_time"])
+      DateTime.parse(page['last_edited_time'])
     end
 
     def url
       page[:url]
     end
   end
-end
+end

data/lib/jekyll-notion/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllNotion
-  VERSION = '0.0.0.alpha'
-end
+  VERSION = '0.0.0.beta.1'
+end

data/lib/jekyll-notion.rb

@@ -1,10 +1,20 @@
+# frozen_string_literal: true
+
 require 'jekyll'
 require 'notion'
-require 'notion_to_md/logger'
+require 'notion_to_md'
 require 'logger'
+require 'active_support/inflector'
+require 'jekyll-notion/generator'
 
 NotionToMd::Logger.level = Logger::ERROR
 
 Notion.configure do |config|
-    config.token = ENV['NOTION_TOKEN']
-end
+  config.token = ENV['NOTION_TOKEN']
+end
+
+module JekyllNotion
+  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: 0.0.0.alpha
+  version: 0.0.0.beta.1
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: notion_to_md
+  name: notion-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: notion-ruby-client
+  name: notion_to_md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"