jekyll-notion 2.4.4 → 3.0.0.beta1

data/lib/jekyll-notion/generator.rb

@@ -7,111 +7,121 @@ module JekyllNotion
     def generate(site)
       @site = site
 
-      return unless notion_token? && config?
+      return unless config? && notion_token?
 
+      assert_configuration
       setup
 
-      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
+      @notion_client = Notion::Client.new
+
+      import_notion_databases
+      import_notion_pages
     end
 
-    def config_databases
-      if config["database"]
-        Jekyll.logger.warn("Jekyll Notion:",
-                           "database property is deprecated, use databases instead.")
-      end
+    def config
+      @config ||= @site.config["notion"] || {}
+    end
 
+    def config_databases
       config["databases"] || []
     end
 
     def config_pages
-      if config["page"]
-        Jekyll.logger.warn("Jekyll Notion:",
-                           "page property is deprecated, use pages instead.")
-      end
       config["pages"] || []
     end
 
-    def collections
-      @collections ||= {}
-    end
-
-    def data
-      @data ||= {}
-    end
-
-    def pages
-      @pages ||= []
-    end
-
     protected
 
-    def cache_empty?
-      collections.empty? && pages.empty? && data.empty?
-    end
-
-    def read_notion_databases
+    def import_notion_databases
       config_databases.each do |db_config|
-        db = NotionDatabase.new(:config => db_config)
-        DatabaseFactory.for(:notion_resource => db, :site => @site, :plugin => self).generate
+        next if db_config["id"].nil?
+
+        notion_database = NotionToMd::Database.call(:id => db_config["id"],
+                                                    :notion_client => @notion_client, :filter => db_config["filter"], :sorts => db_config["sorts"], :frontmatter => true)
+        Generators::Collection.call(:config => db_config, :site => @site,
+                                    :notion_pages => notion_database.pages)
       end
     end
 
-    def read_notion_pages
+    def import_notion_pages
       config_pages.each do |page_config|
-        page = NotionPage.new(:config => page_config)
-        PageFactory.for(:notion_resource => page, :site => @site, :plugin => self).generate
-      end
-    end
+        next if page_config["id"].nil?
 
-    def config
-      @config ||= @site.config["notion"] || {}
+        notion_page = NotionToMd::Page.call(:id => page_config["id"], :notion_client => @notion_client,
+                                            :frontmatter => true)
+        Generators::Page.call(:config => page_config, :site => @site,
+                              :notion_pages => [notion_page])
+      end
     end
 
-    def fetch_on_watch?
-      Jekyll.logger.warn("Jekyll Notion:",
-                         "[Warning] The fetch_on_watch feature is deprecated in preference to the cache mechanism. It will be removed in the next major release.")
-
-      config["fetch_on_watch"] == true
+    def notion_token
+      ENV.fetch("NOTION_TOKEN", nil)
     end
 
     def notion_token?
       if ENV["NOTION_TOKEN"].nil? || ENV["NOTION_TOKEN"].empty?
-        Jekyll.logger.warn("Jekyll Notion:",
-                           "Cannot read from Notion becuase NOTION_TOKEN was not provided")
+        Jekyll.logger.warn(
+          "Jekyll Notion:",
+          "Skipping import: NOTION_TOKEN is missing. Please set the NOTION_TOKEN environment variable to enable Notion integration."
+        )
+
         return false
       end
       true
     end
 
     def config?
-      if config.empty?
-        Jekyll.logger.warn("Jekyll Notion:", "No configuration provided")
+      return false unless @site.config.key?("notion")
+
+      if config.empty? || (config_databases.empty? && config_pages.empty?)
+        Jekyll.logger.warn("Jekyll Notion:",
+                           "The `databases` or `pages` configuration are not declared. Skipping import.")
         return false
       end
+
       true
     end
 
     def setup
       # Cache Notion API responses
-      if ENV["JEKYLL_ENV"] != "test" && cache?
-        JekyllNotion::Cacheable.setup(config["cache_dir"])
-        JekyllNotion::CollectionGenerator.prepend(JekyllNotion::Cacheable)
-        JekyllNotion::PageGenerator.prepend(JekyllNotion::Cacheable)
-        JekyllNotion::DataGenerator.prepend(JekyllNotion::Cacheable)
-      end
+      JekyllNotion::Cacheable.configure(
+        :cache_dir     => config["cache_dir"],
+        :cache_enabled => cache?
+      )
     end
 
     def cache?
-      return true if config["cache"].nil?
+      value = if config.key?("cache")
+                config["cache"]
+              else
+                ENV.fetch("JEKYLL_NOTION_CACHE", nil)
+              end
+      value.nil? || !falsy?(value)
+    end
 
-      config["cache"] == true.to_s
+    private
+
+    def falsy?(value)
+      %w(0 false no).include?(value.to_s.downcase)
+    end
+
+    def assert_configuration
+      if config.key?("fetch_on_watch")
+        Jekyll.logger.warn(
+          "Jekyll Notion:",
+          "The `fetch_on_watch` option was removed in v3. Please use the cache mechanism instead: https://github.com/emoriarty/jekyll-notion#cache"
+        )
+      end
+
+      if config.key?("database")
+        Jekyll.logger.warn("Jekyll Notion:",
+                           "The `database` key is deprecated. Please use `databases` instead.")
+      end
+
+      if config["page"]
+        Jekyll.logger.warn("Jekyll Notion:",
+                           "The `page` key is deprecated. Please use `pages` instead.")
+      end
     end
   end
 end

data/lib/jekyll-notion/generators/collection.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  module Generators
+    class Collection < Generator
+      include Collectionable
+
+      def call
+        if config["data"].nil?
+          notion_pages.each { |notion_page| generate_document(notion_page) }
+        else
+          Data.call(:config => config, :site => site,
+                    :notion_pages => notion_pages)
+        end
+      end
+
+      private
+
+      def generate_document(notion_page)
+        return if page_exists?(site_collection.docs, notion_page)
+
+        document = make_doc(notion_page)
+
+        site_collection.docs << document
+
+        log_page(document)
+      end
+
+      def site_collection
+        @site.collections[collection_name]
+      end
+
+      def make_doc(page)
+        new_post = DocumentWithoutAFile.new(
+          make_path(page),
+          { :site => @site, :collection => site_collection }
+        )
+        new_post.content = page.to_md
+        new_post.read
+        new_post
+      end
+
+      def make_path(page)
+        "_#{collection_name}/#{make_filename(page)}"
+      end
+
+      def collection_name
+        config["collection"] || "posts"
+      end
+
+      def make_filename(page)
+        if collection_name == "posts"
+          "#{date_for(page)}-#{Jekyll::Utils.slugify(page.title, :mode => "latin")}.md"
+        else
+          "#{Jekyll::Utils.slugify(page.title, :mode => "latin")}.md"
+        end
+      end
+
+      def date_for(page)
+        # The "date" property overwrites the Jekyll::Document#data["date"] key
+        # which is the date used by Jekyll to set the post date.
+        Time.parse(page.props["date"]).to_date
+      rescue TypeError, NoMethodError
+        # Because the "date" property is not required,
+        # it fallbacks to the created_time which is always present.
+        Time.parse(page.created_time).to_date
+      end
+    end
+  end
+end

data/lib/jekyll-notion/generators/collectionable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  module Generators
+    module Collectionable
+      def page_exists?(collection, notion_page)
+        page_exists = collection.any? do |page|
+          page.data["title"]&.downcase == notion_page.title.downcase
+        end
+
+        if page_exists
+          Jekyll.logger.warn("Jekyll Notion:",
+                             "Page `#{notion_page.title}` exists — skipping Notion import.")
+        end
+
+        page_exists
+      end
+
+      def log_page(page)
+        Jekyll.logger.info("Jekyll Notion:", "Page => #{page.data["title"]}")
+        Jekyll.logger.info("", "URL => #{page.url}")
+        Jekyll.logger.debug("", "Props => #{page.data.keys.inspect}")
+      end
+    end
+  end
+end

data/lib/jekyll-notion/generators/data.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  module Generators
+    class Data < Generator
+      # pages => Array of NotionToMd::Page
+      def call
+        data = if notion_pages.size > 1
+                 notion_pages.map do |page|
+                   page.send(:frontmatter_properties).merge({ "content" => convert(page) })
+                 end
+               else
+                 notion_pages.first.send(:frontmatter_properties).merge({ "content" => convert(notion_pages.first) })
+               end
+
+        @site.data[config["data"]] = data
+
+        log_data(data)
+      end
+
+      protected
+
+      # Convert the notion page body using the site.converters.
+      #
+      # Returns String the converted content.
+      def convert(page)
+        converters.reduce(page.body) do |output, converter|
+          converter.convert(output)
+        rescue StandardError => e
+          Jekyll.logger.error "Conversion error:",
+                              "#{converter.class} encountered an error while " \
+                              "converting notion page '#{page.title}':"
+          Jekyll.logger.error("", e.to_s)
+          raise e
+        end
+      end
+
+      def converters
+        @converters ||= @site.converters.select { |c| c.matches(".md") }.tap(&:sort!)
+      end
+
+      def log_data(data)
+        if data.is_a?(Array)
+          data.each { |page| _log_data(page, Array.to_s) }
+        else
+          _log_data(data, Hash.to_s)
+        end
+      end
+
+      def _log_data(page, type)
+        Jekyll.logger.info("Jekyll Notion:", "Page => #{page["title"]}")
+        Jekyll.logger.info("", "#{type} => site.data.#{config["data"]}")
+        Jekyll.logger.debug("", "Props => #{page.keys.inspect}")
+      end
+    end
+  end
+end

data/lib/jekyll-notion/generators/generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  module Generators
+    # Abstract base class for Notion content generators.
+    #
+    # This class provides a common interface and factory method for creating
+    # Jekyll content from Notion pages. Subclasses must implement the {#call}
+    # method to define their specific generation behavior.
+    #
+    # @abstract Subclass and override {#call} to implement content generation logic
+    class Generator
+      class << self
+        # Factory method to create and execute a generator instance.
+        #
+        # @param config [Hash] Configuration hash for the generator
+        # @param site [Jekyll::Site] The Jekyll site instance
+        # @param notion_pages [Array<NotionToMd::Page>] Array of Notion pages to process
+        # @return [void]
+        def call(config:, site:, notion_pages:)
+          new(:config => config, :site => site,
+              :notion_pages => notion_pages).call
+        end
+      end
+
+      # Initialize a new generator instance.
+      #
+      # @param config [Hash] Configuration hash for the generator
+      # @param site [Jekyll::Site] The Jekyll site instance
+      # @param notion_pages [Array<NotionToMd::Page>] Array of Notion pages to process
+      def initialize(config:, site:, notion_pages:)
+        @notion_pages = notion_pages
+        @config = config
+        @site = site
+      end
+
+      attr_reader :config, :notion_pages, :site
+
+      # Generate Jekyll content from Notion pages.
+      #
+      # @abstract Subclasses must implement this method to define their
+      #   specific content generation logic.
+      # @raise [NotImplementedError] if called on the abstract base class
+      # @return [void]
+      def call
+        raise NotImplementedError, "Subclasses must implement #call"
+      end
+    end
+  end
+end

data/lib/jekyll-notion/generators/page.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module JekyllNotion
+  module Generators
+    class Page < Generator
+      include Collectionable
+
+      def call
+        if config["data"].nil?
+          notion_pages.each { |notion_page| generate_page(notion_page) }
+        else
+          Data.call(:config => config, :site => site,
+                    :notion_pages => notion_pages)
+        end
+      end
+
+      private
+
+      def generate_page(notion_page)
+        return if page_exists?(site.pages, notion_page)
+
+        page = make_page(notion_page)
+
+        site.pages << page
+
+        log_page(page)
+      end
+
+      def make_page(notion_page)
+        JekyllNotion::PageWithoutAFile.new(@site, @site.source, "", "#{notion_page.title}.md",
+                                           notion_page.to_md)
+      end
+    end
+  end
+end

data/lib/jekyll-notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllNotion
-  VERSION = "2.4.4"
+  VERSION = "3.0.0.beta1"
 end

data/lib/jekyll-notion.rb

@@ -14,16 +14,19 @@ Notion.configure do |config|
 end
 
 module JekyllNotion
-  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"
   autoload :Cacheable, "jekyll-notion/cacheable"
+  autoload :CassetteManager, "jekyll-notion/cassette_manager"
+
+  module Generators
+    autoload :Generator, "jekyll-notion/generators/generator"
+    autoload :Collectionable, "jekyll-notion/generators/collectionable"
+    autoload :Data, "jekyll-notion/generators/data"
+    autoload :Page, "jekyll-notion/generators/page"
+    autoload :Collection, "jekyll-notion/generators/collection"
+  end
 end
+
+# Prepend Cacheable module to NotionToMd::Page for instance method caching
+NotionToMd::Page.prepend(JekyllNotion::Cacheable)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 3.0.0.beta1
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-19 00:00:00.000000000 Z
+date: 2025-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -48,16 +48,16 @@ dependencies:
   name: notion_to_md
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 3.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 3.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -73,61 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.3.1
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
+        version: '2.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '2.6'
 description:
 email:
 - emoriarty81@gmail.com
@@ -138,18 +96,15 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/jekyll-notion.rb
-- lib/jekyll-notion/abstract_notion_resource.rb
 - lib/jekyll-notion/cacheable.rb
+- lib/jekyll-notion/cassette_manager.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/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/generators/collection.rb
+- lib/jekyll-notion/generators/collectionable.rb
+- lib/jekyll-notion/generators/data.rb
+- lib/jekyll-notion/generators/generator.rb
+- lib/jekyll-notion/generators/page.rb
 - lib/jekyll-notion/page_without_a_file.rb
 - lib/jekyll-notion/version.rb
 homepage: https://github.com/emoriarty/jekyll-notion
@@ -167,9 +122,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key:

data/lib/jekyll-notion/abstract_notion_resource.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllNotion
-  class AbstractNotionResource
-    def initialize(config:)
-      @notion = Notion::Client.new
-      @config = config
-    end
-
-    def config
-      @config || {}
-    end
-
-    def id
-      config["id"]
-    end
-
-    def fetch
-      raise "Do not use the AbstractNotionResource class. Implement the fetch method in a subclass."
-    end
-
-    def collection_name
-      raise "Do not use the AbstractGenerator class. Implement the collection_name method in a subclass."
-    end
-
-    def data_name
-      raise "Do not use the AbstractGenerator class. Implement the data_name method in a subclass."
-    end
-
-    protected
-
-    def id?
-      if id.nil? || id.empty?
-        Jekyll.logger.warn("Jekyll Notion:",
-                           "Database or page id is not provided. Cannot read from Notion.")
-        return false
-      end
-      true
-    end
-
-    def build_blocks(block_id)
-      NotionToMd::Blocks.build(:block_id => block_id) do |nested_id|
-        @notion.block_children({ :block_id => nested_id })
-      end
-    end
-  end
-end

data/lib/jekyll-notion/factories/database_factory.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllNotion
-  class DatabaseFactory
-    def self.for(notion_resource:, site:, plugin:)
-      if notion_resource.data_name.nil?
-        CollectionGenerator.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/factories/page_factory.rb

@@ -1,14 +0,0 @@
-# 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