jekyll-notion 0.0.0.beta → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc64ea093044b7a8b5f0f1059e175d439b8b70fc1b4b08a30ea39438b4dc6d46
-  data.tar.gz: 608c37287a98f0ce89184616c27392048c9fdc725ab77f327e0cffb35fa4020b
+  metadata.gz: 7d1ccb2f2f5451b3eaf6d80dd8f8fed62cd2d5fd582d1cce09fbf10a494b54ac
+  data.tar.gz: f651dd2f6e3c5404b33af0abdb11274eacc34296c6301e9d79d76f38ccb8f1e6
 SHA512:
-  metadata.gz: 6c1b27117aee99b01dd988d243d1419b054447aa5afb02e5cffc5ed9120a8acd2e3a0b11759cccf6bd28a8657bc65e147307be501b2140421e961d48920c0f4d
-  data.tar.gz: cb1fbc6a9edb4069fd8019e5a29837bdf80a551c119a9371d7678f48ca10a32e58c5a5da2edbe4c4bff0c41d6d560041db0fbf9a26fdeb0bcf9101cd88d3cabd
+  metadata.gz: f87ce41674b28e289e7b69a0d4a40ac64fc0c9e9384ce5fdfb9b82312ba439ba60c5b7bab2a8ead2d1075adffd4a852bbae7534acc67d5317221c5fe236b52bf
+  data.tar.gz: 9ac472cd2c48b0affd89825b8d08a11fb8e562ac8da05193111bcc85f219196352345f4c6ebd6ff0b9721c847f00e30fc0820190fa8dd6950758355b24aafbd5

data/README.md

@@ -39,21 +39,45 @@ notion:
   database:
     id: b91d5...
     collection: posts
-    layout: post
     filter: { "property": "Published", "checkbox": { "equals": true } }
     sort: { "propery": "Last ordered", "direction": "ascending" }
     frontmatter:
-      prop_1: blabla
-      prop_2: albalb
+      layout: post
 ```
 
 The other properties are:
-* `collection`: what collection each page belongs to,
-* `layout`: the collection layout,
+* `collection`: the collection each page belongs to (posts by default),
 * `filter`: the database query filter,
 * `sort`: the database query sort,
-* `frontmatter`: additonal frontmatter to append to each page in the collection.
+* `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
+---
+```
+
+Any property provided in the frontmatter config that matches a default property will be overwritten by the default value.
+
+## 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,32 +4,27 @@ 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?
+      return unless notion_token? && config?
 
       read_notion_database
     end
 
     def read_notion_database
-      @db = NotionDatabase.new(config: config)
-      @db.pages do |page|
+      @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}")
+        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.dig('database', '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
@@ -37,27 +32,46 @@ 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.dig('database', '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}
----
+      data = Jekyll::Utils.deep_merge_hashes(config_frontmatter, notion_frontmatter)
+      page_frontmatter = data.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
+      <<~CONTENT
+        ---
+        #{page_frontmatter}
+        ---
       CONTENT
     end
 
+    def notion_frontmatter
+      {
+        :id    => current_page.id,
+        :title => current_page.title,
+        :date  => current_page.created_datetime,
+        :cover => current_page.cover,
+      }
+    end
+
+    def config_frontmatter
+      config.dig("database", "frontmatter") || {}
+    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.dig('database', 'collection').to_sym)
+      @collection ||= @site.collections[collection_name]
     end
 
     def config
@@ -65,8 +79,8 @@ cover: #{current_page.cover}
     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.')
+      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
@@ -74,7 +88,7 @@ cover: #{current_page.cover}
 
     def config?
       if config.empty?
-        Jekyll.logger.error('Jekyll Notion:', 'No config provided.')
+        Jekyll.logger.warn("Jekyll Notion:", "No config provided.")
         return false
       end
       true

data/lib/jekyll-notion/notion_database.rb

@@ -8,35 +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']
+      @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.beta'
+  VERSION = "0.0.1"
 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.beta
+  version: 0.0.1
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-01-22 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