bridgetown_notion 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e86e10243ccaea80727bc54084c1c071d407c49d4a7fac41a4c9aa5983321b7
-  data.tar.gz: 61973da5ac8daf87996a88d826d03be727255431c2e4ed8a5304047186ed5f92
+  metadata.gz: 54259116b5b744f64ed97d979eb96a7b5fc32908e101ebceb966e5ff850f2614
+  data.tar.gz: 6766dd525ac714f6cdc49410148204f124a34bd21a600bd591cb2aff54e37d64
 SHA512:
-  metadata.gz: 6bb6f9beecc295140d9bc4edda7019891aeb50b77c151d7be34075adec1a36fd3b92924ae70f94bb1640eb81c4141397217d29e19e0768468ceb3c35686a3abe
-  data.tar.gz: e2416855fad78e9f31d437fa539ca9ac1e447cf89906147a773d5d5ba231b7ed56cbef71285a2f4404e6934a7021d6ca8b87a55dcda392366a537d62ed799a83
+  metadata.gz: d5d2d274bc28e7965666163509781ebf62f92f10911f4d2ad0b909240531fc7a16e814c6dc687fdb7733c22a28c42134b57129317bee2414f8344401616da0e1
+  data.tar.gz: '04903b167f5f58f59ef1f2558c4a296212d15138236dc4ef5b3e5c965979c5ca652ce1f0151d9cea6c60dcda25abd4c7103b1a42f13eeefec3d561116be04f7b'

data/.gitignore

@@ -18,6 +18,7 @@ Gemfile.lock
 .bundle
 .ruby-version
 .tool-versions
+.solargraph.yml
 
 # Node
 node_modules

data/CHANGELOG.md

@@ -7,7 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-- 
+## [0.2.0] - 2023-03-13
+
+### Added
+
+- Add new initializer config, backwards compatible with previous env implementation.
+- Add activesupport dependecy for help with changing letter cases.
+
+### Fixed
+
+- Fix invalid URI bug. By returning a slug property from the posts factory we can ensure
+that we don't attempt to create posts with spaces in the file name.
 
 ## [0.1.0] - 2023-02-04
 

data/Gemfile

@@ -6,7 +6,10 @@ gemspec
 gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
 
 group :test do
+  gem "debug", ">= 1.0.0"
   gem "minitest"
   gem "minitest-reporters"
   gem "shoulda"
+  gem "timecop"
+  gem "webmock"
 end

data/README.md

@@ -1,34 +1,51 @@
-# Sample plugin for Bridgetown
+# Bridgetown Notions CMS Plugin
 
-_NOTE: This isn't a real plugin! Copy this sample code and use it to create your own Ruby gem! [Help guide here…](https://www.bridgetownrb.com/docs/plugins)_ 😃
+A Bridgetown plugin to pull content directly out of a Notion database. Each page in the 
+Notion database is added to your posts collection in Bridgetown.
 
-_You can run_ `bridgetown plugins new` _to easily set up a customized verison of this starter repo._
-
-A Bridgetown plugin to [fill in the blank]…
 
 ## Installation
 
-Run this command to add this plugin to your site's Gemfile:
+1. Run this command to add this plugin to your site's Gemfile:
 
 ```shell
-$ bundle add my-awesome-plugin -g bridgetown_plugins
+$ bundle add bridgetown_notion
 ```
 
-Or if there's a `bridgetown.automation.rb` automation script, you can run that instead for guided setup:
+2. Add the following to your site's `config/initializers.rb`:
 
-```shell
-$ bin/bridgetown apply https://github.com/username/my-awesome-plugin
+```ruby
+Bridgetown.configure do |config|
+  init :bridgetown_notion do
+    notion_key '<your-notion-connection-key>'
+    notion_db_id '<your-notion-db-id>'
+  end
+end
 ```
 
+You should consider using environment variables to store the `notion_key` and `notion_db_id`.
+It is generally a bad practice to store credentials in version control.
+
 ## Usage
 
-The plugin will…
+### Notion Setup
+
+[bridgetown_notion](https://github.com/fbuys/bridgetown_notion) assumes that you have a Notion
+database table with the following fileds:
 
-### Optional configuration options
+| Field | Type |
+|-|-|
+| title (required | Title |
+| published_at (required) | Date |
+| published | Checkbox  |
+| categories | Multi-selet | 
+| tags | Multi-selet | 
+| author | Select |
 
-The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+Note the case of the fields as this is important.
 
-…
+You would also need to create a Notion connection that provides read access to the specific
+database. You can find the [instructions for adding a connection over here](https://www.notion.so/help/add-and-manage-connections-with-the-api).
 
 ## Testing
 

data/bridgetown_notion.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bridgetown", ">= 1.0", "< 2.0"
   spec.add_dependency "notion-ruby-client",  ">= 1.0", "< 2.0"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", ">= 13.0"

data/lib/bridgetown_notion/builder.rb

@@ -1,78 +1,21 @@
 # frozen_string_literal: true
 
+require "bridgetown_notion/notion_posts_factory"
+
 module BridgetownNotion
   class Builder < Bridgetown::Builder
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
     def build
-      Notion.configure do |config|
-        config.token = ENV.fetch("NOTION_KEY")
-      end
-
-      client = Notion::Client.new
-
-      client.database_query(database_id: ENV.fetch("NOTION_DB_ID")) do |posts_page|
-        posts_page.results.each do |post|
-          title = post.dig("properties", "title", "title", 0, "text", "content")
-          categories = (post.dig("properties", "categories", "multi_select") || [])
-            .map { |c| c["name"] }.join(" ")
-          tags = (post.dig("properties", "tags", "multi_select") || [])
-            .map { |t| t["name"] }.join(" ")
-          is_published = post["properties"]["published"]["checkbox"]
-          published_at = post.dig("properties", "published_at", "date", "start")
-          content = ""
-
-          next if published_at.nil? || title.nil?
-
-          client.block_children(block_id: post.id) do |blocks_page|
-            blocks_page.results.each do |block|
-              content += extract_content(block)
-            end
-          end
-
-          add_resource :posts, "#{published_at}-#{title}.md" do
-            categories categories
-            content content
-            layout :post
-            published is_published
-            tags tags
-            title title
-          end
+      BridgetownNotion::NotionPostsFactory.create_posts(config.bridgetown_notion).each do |post|
+        add_resource :posts, "#{post[:slug]}.md" do
+          categories post[:categories]
+          content post[:content]
+          layout :post
+          published post[:is_published]
+          tags post[:tags]
+          title post[:title]
         end
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
-
-    private
-
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    def extract_content(block)
-      result = block.dig("heading_1", "rich_text", 0, "text", "content")
-      return "# #{result}\n" if result
-
-      result = block.dig("heading_2", "rich_text", 0, "text", "content")
-      return "## #{result}\n" if result
-
-      result = block.dig("heading_3", "rich_text", 0, "text", "content")
-      return "### #{result}\n" if result
-
-      result = block.dig("heading_4", "rich_text", 0, "text", "content")
-      return "#### #{result}\n" if result
-
-      result = block.dig("heading_5", "rich_text", 0, "text", "content")
-      return "##### #{result}\n" if result
-
-      result = block.dig("heading_6", "rich_text", 0, "text", "content")
-      return "###### #{result}\n" if result
-
-      result = block.dig("paragraph", "rich_text", 0, "text", "content")
-      return "#{result}\n" if result
-
-      result = block.dig("bulleted_list_item", "rich_text", 0, "text", "content")
-      return "- #{result}\n" if result
-
-      "\n"
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   end
 end
 

data/lib/bridgetown_notion/markdown_generators/bulleted_list_item_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class BulletedListItemMarkdownGenerator
+      def self.generate(text)
+        "- #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/heading_1_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class Heading1MarkdownGenerator
+      def self.generate(text)
+        "# #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/heading_2_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class Heading2MarkdownGenerator
+      def self.generate(text)
+        "## #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/heading_3_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class Heading3MarkdownGenerator
+      def self.generate(text)
+        "### #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/heading_4_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class Heading4MarkdownGenerator
+      def self.generate(text)
+        "#### #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/heading_5_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class Heading5MarkdownGenerator
+      def self.generate(text)
+        "##### #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/heading_6_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class Heading6MarkdownGenerator
+      def self.generate(text)
+        "###### #{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/markdown_generators/paragraph_markdown_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module MarkdownGenerators
+    class ParagraphMarkdownGenerator
+      def self.generate(text)
+        "#{text}\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/notion_posts_factory.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  class NotionPostsFactory
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def self.create_posts(config)
+      notion_key = config.notion_key
+      notion_db_id = config.notion_db_id
+
+      Notion.configure do |notion|
+        notion.token = notion_key
+      end
+
+      notion_client = Notion::Client.new
+
+      result = []
+
+      notion_client.database_query(database_id: notion_db_id) do |posts_page|
+        posts_page.results.each do |post|
+          notion_client.block_children(block_id: post.id) do |blocks_page|
+            post["blocks"] = [*post["blocks"], *blocks_page.results]
+          end
+
+          parsed_post = BridgetownNotion::Parsers::PostParser.parse(post)
+
+          next if parsed_post.published_at.nil? || parsed_post.title.nil?
+
+          result.push({
+            categories: parsed_post.categories,
+            content: parsed_post.content,
+            is_published: parsed_post.is_published,
+            slug: parsed_post.slug,
+            tags: parsed_post.tags,
+            title: parsed_post.title,
+          })
+        end
+      end
+
+      result
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/bridgetown_notion/parsers/block_parser.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class BlockParser
+      def self.parse(block)
+        for_each_block_type do |block_type|
+          content = block.dig(block_type, "rich_text", 0, "text", "content")
+          return [block_type, content] if content
+        end
+        []
+      end
+
+      private_class_method def self.for_each_block_type
+        pattern = %r{(?<block_type>\w+)(?!.*/)_markdown_generator.rb}
+        markdown_generator_files = Dir[
+          "#{File.dirname(__FILE__)}/../markdown_generators/**/*_markdown_generator.rb"
+        ]
+        markdown_generator_files.each do |file|
+          yield file.match(pattern)[:block_type].to_s
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/categories_parser.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class CategoriesParser
+      def self.parse(post)
+        categories = (post.dig("properties", "categories", "multi_select") || [])
+        categories.map { |c| c["name"] }.join(" ")
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/content_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+
+module BridgetownNotion
+  module Parsers
+    class ContentParser
+      def self.parse(post)
+        content = ""
+        blocks = post.fetch("blocks", [])
+        blocks.each do |block|
+          content += get_content(block)
+        end
+        content
+      end
+
+      private_class_method def self.get_content(block)
+        block_type, content = BridgetownNotion::Parsers::BlockParser.parse(block)
+        Object.const_get(
+          "BridgetownNotion::MarkdownGenerators::#{block_type.camelize}MarkdownGenerator"
+        ).generate(content)
+      rescue StandardError
+        "\n"
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/is_published_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class IsPublishedParser
+      def self.parse(post)
+        post.dig("properties", "published", "checkbox") || false
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/post_parser.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+
+module BridgetownNotion
+  module Parsers
+    class PostParser
+      def initialize(post)
+        @post = post
+      end
+
+      def self.parse(post)
+        new(post)
+      end
+
+      def method_missing(method_name)
+        parser = method_name.to_s.camelize
+        Object.const_get("BridgetownNotion::Parsers::#{parser}Parser").parse(@post)
+      end
+
+      def respond_to_missing?(method_name)
+        Dir["./**/*_parser.rb"].each do |f|
+          return true if f.include?(method_name)
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/published_at_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class PublishedAtParser
+      def self.parse(post)
+        post.dig("properties", "published_at", "date", "start")
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/slug_parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class SlugParser
+      def self.parse(post)
+        published_at = BridgetownNotion::Parsers::PublishedAtParser.parse(post)
+        title = BridgetownNotion::Parsers::TitleParser.parse(post)
+        "#{published_at}-#{title}".downcase.strip.tr(" ", "-").gsub(%r/[^\w-]/, "")
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/tags_parser.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class TagsParser
+      def self.parse(post)
+        tags = (post.dig("properties", "tags", "multi_select") || [])
+        tags.map { |t| t["name"] }.join(" ")
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/parsers/title_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownNotion
+  module Parsers
+    class TitleParser
+      def self.parse(post)
+        post.dig("properties", "title", "title", 0, "text", "content")
+      end
+    end
+  end
+end

data/lib/bridgetown_notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownNotion
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/bridgetown_notion.rb

@@ -3,3 +3,15 @@
 require "bridgetown"
 require "bridgetown_notion/builder"
 require "notion-ruby-client"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+Bridgetown.initializer :bridgetown_notion do |config, notion_key:, notion_db_id:|
+  config.bridgetown_notion ||= {}
+  config.bridgetown_notion.notion_key ||= notion_key || ENV.fetch("NOTION_KEY")
+  config.bridgetown_notion.notion_db_id ||= notion_db_id || ENV.fetch("NOTION_DB_ID")
+
+  config.builder BridgetownNotion::Builder
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown_notion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Francois Buys
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,24 @@ files:
 - bridgetown_notion.gemspec
 - lib/bridgetown_notion.rb
 - lib/bridgetown_notion/builder.rb
+- lib/bridgetown_notion/markdown_generators/bulleted_list_item_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/heading_1_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/heading_2_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/heading_3_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/heading_4_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/heading_5_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/heading_6_markdown_generator.rb
+- lib/bridgetown_notion/markdown_generators/paragraph_markdown_generator.rb
+- lib/bridgetown_notion/notion_posts_factory.rb
+- lib/bridgetown_notion/parsers/block_parser.rb
+- lib/bridgetown_notion/parsers/categories_parser.rb
+- lib/bridgetown_notion/parsers/content_parser.rb
+- lib/bridgetown_notion/parsers/is_published_parser.rb
+- lib/bridgetown_notion/parsers/post_parser.rb
+- lib/bridgetown_notion/parsers/published_at_parser.rb
+- lib/bridgetown_notion/parsers/slug_parser.rb
+- lib/bridgetown_notion/parsers/tags_parser.rb
+- lib/bridgetown_notion/parsers/title_parser.rb
 - lib/bridgetown_notion/version.rb
 homepage: https://github.com/fbuys/bridgetown_notion
 licenses: