jekyll-notion 0.0.0.alpha.2 → 0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c85349b9010ff1ccbbc88b83e46315f8e31bc9b489943dce0c75c7a503820db3
-  data.tar.gz: f0ae3ebe202b1cd3d184fe232d350b6024148a2bffe298a771c9221e1ac0684b
+  metadata.gz: 72643f8e9760b1f45a30fd87a8448cf16b1f85a63bcec6c83b4d4b3dea8b4c21
+  data.tar.gz: 95b0c61bdfc5e7c6dc018798474dcd40e6ec0728c0836d552249b9b7da8213bf
 SHA512:
-  metadata.gz: 1c98f9f772b8290d78e0ab393c5dbd55b419518a9f9baccd84906218e6a650d903027f10b85f120a779c71364f9a3d3ec2d8bd88fddf284f59fe2ffc80c1e3de
-  data.tar.gz: 0fe7d15ad3c33de0929072ad7ba7df7f8c0ed22cb4aefb9084bfc868a2aa23641c08d3f1d8f6c22b8ac35b765b938a2e2798f02a028a2c37e4d41d4bfa51fca0
+  metadata.gz: daf22fba12e6385aaa5842103c390ee6f58c093bf5ee1b199700c769a45d7736f04600f71cc0bcdedd77018a547024f8bdaf517a842cd88d58f13af4a77d57c9
+  data.tar.gz: 4d28a3d8319345e1a936ac3112009568a1d693cbd3314783fdea12d4c1cca38da33f701b25d870eb1cebf0fc11347f849979fcfee94a9d98173d33e376e50bec

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`: 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 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,9 +2,9 @@
 
 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
       end

data/lib/jekyll-notion/generator.rb

@@ -4,24 +4,27 @@ module JekyllNotion
   class Generator < Jekyll::Generator
     attr_reader :current_page
 
-    def initialize(plugin)
-      super(plugin)
-    end
-
     def generate(site)
       @site = site
-      @db = NotionDatabase.new(config: config)
-      @db.pages do |page|
+
+      return unless notion_token? && config?
+
+      read_notion_database
+    end
+
+    def read_notion_database
+      @db = NotionDatabase.new(:config => config)
+      @db.pages.each 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}",
-        { site: @site, collection: collection }
+        "#{Dir.pwd}/_#{collection_name}/#{make_filename}",
+        { :site => @site, :collection => collection }
       )
       new_post.content = "#{make_frontmatter}\n\n#{make_md}"
       new_post.read
@@ -29,31 +32,59 @@ module JekyllNotion
     end
 
     def make_md
-      NotionToMd::Converter.new(page_id: current_page.id).convert
+      NotionToMd::Converter.new(:page_id => current_page.id).convert
     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
+        ---
+        id: #{current_page.id}
+        title: #{current_page.title}
+        date: #{current_page.created_datetime}
+        cover: #{current_page.cover}
+        #{frontmatter}
+        ---
       CONTENT
     end
 
+    def frontmatter
+      config.dig("database", "frontmatter").to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
+    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") || "posts"
     end
 
     def collection
-      @site.send(config['collection'].to_sym)
+      @collection ||= @site.collections[collection_name]
     end
 
     def config
       @config ||= @site.config["notion"] || {}
     end
+
+    def notion_token?
+      if ENV["NOTION_TOKEN"].nil? || ENV["NOTION_TOKEN"].empty?
+        Jekyll.logger.warn("Jekyll Notion:", "NOTION_TOKEN not provided. Cannot read from Notion.")
+        return false
+      end
+      true
+    end
+
+    def config?
+      if config.empty?
+        Jekyll.logger.warn("Jekyll Notion:", "No config provided.")
+        return false
+      end
+      true
+    end
   end
 end

data/lib/jekyll-notion/notion_database.rb

@@ -8,31 +8,42 @@ module JekyllNotion
     end
 
     def pages
+      return [] unless id?
+
       @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 }
     end
 
     private
 
+    def config
+      @config["database"]
+    end
+
     def filter
-      @config.dig('database', 'filter')
+      @config.dig("database", "filter")
     end
 
     def sort
-      @config.dig('database', 'sort')
+      @config.dig("database", "sort")
     end
 
     def id
-      @config.dig('database', 'id')
+      @config.dig("database", "id")
+    end
+
+    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 }
+    def query
+      { :id => id, :filter => filter, :sort => sort }
     end
   end
 end

data/lib/jekyll-notion/notion_page.rb

@@ -10,7 +10,7 @@ module JekyllNotion
     end
 
     def title
-      page.dig(:properties, :Name, :title).inject('') do |acc, slug|
+      page.dig(:properties, :Name, :title).inject("") do |acc, slug|
         acc + slug[:plain_text]
       end
     end

data/lib/jekyll-notion/version.rb

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

data/lib/jekyll-notion.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require 'jekyll'
-require 'notion'
-require 'notion_to_md'
-require 'logger'
-require 'active_support/inflector'
-require 'jekyll-notion/generator'
+require "jekyll"
+require "notion"
+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']
+  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'
+  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.2
+  version: 0.0.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-19 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:
     - - "~>"
@@ -86,6 +86,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 description:
 email:
 - emoriarty81@gmail.com
@@ -116,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project:
 rubygems_version: 2.7.3