notion_rails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca08751cb4669bed3cd0ad791b3242ba6c2f873e3272310750beaa940eb17151
-  data.tar.gz: fe85cdedfe168e670b5cd2588cb03d514347408ac24396e1dec60e3df8c2bdf6
+  metadata.gz: 95a025ff228890fafa2fd982d108512fa0980fbae091232c6fbfac6ae85667b8
+  data.tar.gz: 8bc99ae3b897b5116ed5e4fe91847a8160db7436490f76360d637c10128df487
 SHA512:
-  metadata.gz: '052119acf124d0543367b3bbbc14d762eb08132428f3c1b92242b4069f8f3e8c9665f7fbd1db79f3e5a6915eec853531417853af72096fcd83e18e0fdf39669f'
-  data.tar.gz: '09a7d8478a722c303e6f22782069dbf74ad83cad14a0949f1fe84453ba4e29dc3703a25de7ab31f4943b6258ab3f5fb471b421f638be2b97f8b780bdbc4533f5'
+  metadata.gz: bdd4412954a606cccf29b805a4db0c9f4ffcec32b9d1baf64feb7a7724fe48a2a72974e1e5650254bc86d0b5eb467961492c5e49284d1d3f9f7a62f31d072b0a
+  data.tar.gz: 426dee990473e7a39722e81e32f282cd3f3909156884e2a9dd46f64fff0ef4893a235ab8eff6921621603c445a6117932116961d370c423cb393fc88a145c171

data/lib/notion_rails/base_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NotionRails
   class BaseBlock
     include NotionRails::Renderers
@@ -58,11 +60,13 @@ module NotionRails
       when 'heading_2' then render_heading_2(rich_text, class: options[:heading_2])
       when 'heading_3' then render_heading_3(rich_text, class: options[:heading_3])
       when 'table_of_contents' then render_table_of_contents
-      when 'bulleted_list_item' then render_bulleted_list_item(rich_text, @siblings, @children, class: options[:bulleted_list_item])
-      when 'numbered_list_item' then render_numbered_list_item(rich_text, @siblings, @children, class: options[:numbered_list_item])
+      when 'bulleted_list_item'
+        render_bulleted_list_item(rich_text, @siblings, @children, class: options[:bulleted_list_item])
+      when 'numbered_list_item'
+        render_numbered_list_item(rich_text, @siblings, @children, class: options[:numbered_list_item])
       when 'quote' then render_quote(rich_text, class: options[:quote])
       when 'callout' then render_callout(rich_text, icon, class: options[:callout])
-      when 'code' then render_code(rich_text, class: "#{options[:code]} language-#{@properties['language']}")
+      when 'code' then render_code(rich_text, class: "#{options[:code]} language-#{@properties["language"]}")
       when 'image' then render_image(*multi_media)
       when 'video' then render_video(*multi_media)
       else
@@ -92,7 +96,6 @@ module NotionRails
 
     private
 
-    def render_table_of_contents
-    end
+    def render_table_of_contents; end
   end
 end

data/lib/notion_rails/base_page.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module NotionRails
   class BasePage
     include NotionRails::Renderers
+
     # TODO: validate object type is page
     attr_reader :id,
       :created_time,
@@ -12,9 +15,11 @@ module NotionRails
       :parent,
       :archived,
       :properties,
+      :published_at,
       :tags,
       :title,
       :slug,
+      :description,
       :url
 
     def initialize(data)
@@ -41,12 +46,22 @@ module NotionRails
       render_title(@title, options)
     end
 
+    def formatted_description(options = {})
+      render_paragraph(@description, options)
+    end
+
+    def formatted_published_at(options = {})
+      render_date(@published_at, options)
+    end
+
     private
 
     def process_properties
       @tags = @properties['tags']
       @title = @properties.dig('name', 'title')
       @slug = @properties['slug']
+      @published_at = @properties.dig('published', 'date', 'start')
+      @description = @properties.dig('description', 'rich_text')
     end
   end
 end

data/lib/notion_rails/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NotionRails
   class Page
     include NotionRails::Renderers
@@ -5,14 +7,16 @@ module NotionRails
     attr_reader :metadata, :blocks
 
     delegate :formatted_title, to: :metadata
+    delegate :formatted_description, to: :metadata
+    delegate :formatted_published_at, to: :metadata
 
     def initialize(base_page, base_blocks)
-	  	@metadata = base_page
-		  @blocks = base_blocks
-  	end
+      @metadata = base_page
+      @blocks = base_blocks
+    end
 
-		def formatted_blocks(options = {})
-			@blocks.map { |block| block.render(options) }
-		end
+    def formatted_blocks(options = {})
+      @blocks.map { |block| block.render(options) }
+    end
   end
 end

data/lib/notion_rails/renderers.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
 module NotionRails
   module Renderers
     include ActionView::Helpers::AssetTagHelper
@@ -15,7 +19,7 @@ module NotionRails
         when 'code'
           'inline-code' if annotations[key]
         when 'color'
-          "text-#{annotations['color']}-600" if annotations[key] != 'default'
+          "text-#{annotations["color"]}-600" if annotations[key] != 'default'
         else
           annotations[key] ? key : nil
         end
@@ -23,61 +27,65 @@ module NotionRails
       classes.compact.join(' ')
     end
 
-    def text_renderer(properties)
+    def text_renderer(properties, options = {})
       properties.map do |rich_text|
         classes = annotation_to_css_class(rich_text['annotations'])
         if rich_text['href']
           link_to(
             rich_text['plain_text'],
             rich_text['href'],
-            class: "link #{classes}"
+            class: "link #{classes} #{options[:class]}"
           )
         elsif classes.present?
-          content_tag(:span, rich_text['plain_text'], class: classes)
+          content_tag(:span, rich_text['plain_text'], class: "#{classes} #{options[:class]}")
         else
-          rich_text['plain_text']
+          tag.span(rich_text['plain_text'], class: options[:class])
         end
-      end
+      end.join('').html_safe
     end
 
     def render_title(title, options = {})
-      render_paragraph(title, options)
+      render_heading_1(title, options)
+    end
+
+    def render_date(date, options = {})
+      # TODO: handle end and time zone
+      # date=end=, start=2023-07-13, time_zone=, id=%5BsvU, type=date
+      tag.p(date.to_date.to_fs(:long), class: options[:class])
     end
 
     def render_paragraph(rich_text_array, options = {})
       content_tag(:p, options) do
-        text_renderer(rich_text_array).join('').html_safe
+        text_renderer(rich_text_array)
       end
     end
 
     def render_heading_1(rich_text_array, options = {})
-        content_tag(:h1, class: 'mb-4 mt-6 text-3xl font-semibold', **options) do
-          text_renderer(rich_text_array).join('').html_safe
-        end
+      content_tag(:h1, class: 'mb-4 mt-6 text-3xl font-semibold', **options) do
+        text_renderer(rich_text_array)
+      end
     end
 
     def render_heading_2(rich_text_array, options = {})
-        content_tag(:h2, class: 'mb-4 mt-6 text-2xl font-semibold', **options) do
-          text_renderer(rich_text_array).join('').html_safe
-        end
+      content_tag(:h2, class: 'mb-4 mt-6 text-2xl font-semibold', **options) do
+        text_renderer(rich_text_array)
+      end
     end
 
     def render_heading_3(rich_text_array, options = {})
-        content_tag(:h3, class: 'mb-2 mt-6 text-xl font-semibold', **options) do
-          text_renderer(rich_text_array).join('').html_safe
-        end
+      content_tag(:h3, class: 'mb-2 mt-6 text-xl font-semibold', **options) do
+        text_renderer(rich_text_array)
+      end
     end
 
     def render_code(rich_text_array, options = {})
       # TODO: render captions
       pre_options = options
-      pre_options[:class] = "p-6 rounded #{pre_options[:class]}"
+      pre_options[:class] = "border-2 p-6 rounded #{pre_options[:class]}"
       content_tag(:div, class: 'mt-4', data: { controller: 'highlight' }) do
         content_tag(:div, data: { highlight_target: 'source' }) do
           content_tag(:pre, pre_options) do
-            content_tag(:code, options) do
-              text_renderer(rich_text_array).join('').html_safe
-            end
+            text_renderer(rich_text_array, options)
           end
         end
       end
@@ -88,7 +96,7 @@ module NotionRails
       pre_options[:class] = "list-disc break-words #{pre_options[:class]}"
       content_tag(:ul, pre_options) do
         content = content_tag(:li, options) do
-          text_renderer(rich_text_array).join('').html_safe
+          text_renderer(rich_text_array)
         end
         if children.present?
           res = children.map do |child|
@@ -110,13 +118,13 @@ module NotionRails
 
     def render_list_items(type, rich_text_array, siblings, children, options = {})
       content = content_tag(:li, options) do
-        text_renderer(rich_text_array).join('').html_safe
+        text_renderer(rich_text_array)
       end
       if children.present?
-          res = children.map do |child|
-            render_numbered_list_item(child.rich_text, child.siblings, child.children)
-          end
-          content += res.join('').html_safe
+        res = children.map do |child|
+          render_numbered_list_item(child.rich_text, child.siblings, child.children)
+        end
+        content += res.join('').html_safe
       end
       if siblings.present?
         content += siblings.map do |sibling|
@@ -132,8 +140,10 @@ module NotionRails
       div_options[:class] = "mt-4 #{options[:class]}"
       content_tag(:div, div_options) do
         pre_options[:class] = "border-l-4 border-black px-5 py-1 #{options[:class]}"
-        content_tag(:cite, pre_options) do
-          text_renderer(rich_text_array).join('').html_safe
+        content_tag(:cite) do
+          content_tag(:p, pre_options) do
+            text_renderer(rich_text_array)
+          end
         end
       end
     end
@@ -143,15 +153,15 @@ module NotionRails
       pre_options[:class] = "p-4 rounded bg-neutral-200 mt-4 #{pre_options[:class]}"
       content_tag(:div, pre_options) do
         content = tag.span(icon, class: 'pr-2')
-        content += text_renderer(rich_text_array).join('').html_safe
+        content += text_renderer(rich_text_array)
         content
       end
     end
 
     def render_image(src, expiry_time, caption, type, options = {})
       content_tag(:figure, options) do
-        content = tag.img(src:, alt: '')
-        content += tag.figcaption(text_renderer(caption).join('').html_safe)
+        content = tag.img(src: src, alt: '')
+        content += tag.figcaption(text_renderer(caption))
         content
       end
     end
@@ -159,11 +169,11 @@ module NotionRails
     def render_video(src, expiry_time, caption, type, options = {})
       content_tag(:figure, options) do
         content = if type == 'file'
-          video_tag(src, controls: true)
-        elsif type == 'external'
-          tag.iframe(src:, allowfullscreen: true, class: 'w-full aspect-video')
-        end
-        content += tag.figcaption(text_renderer(caption).join('').html_safe)
+                    video_tag(src, controls: true)
+                  elsif type == 'external'
+                    tag.iframe(src: src, allowfullscreen: true, class: 'w-full aspect-video')
+                  end
+        content += tag.figcaption(text_renderer(caption))
         content
       end
     end

data/lib/notion_rails/service.rb

@@ -1,78 +1,77 @@
+# frozen_string_literal: true
+
 module NotionRails
   class Service
     def initialize
-      @client = Notion::Client.new
+      @client = Notion::Client.new(token: NotionRails.config.notion_api_token)
     end
 
-    def get_articles(tag: nil, slug: nil)
+    def default_query(tag: nil, slug: nil)
       query = [
         {
           property: 'public',
           checkbox: {
             equals: true
           }
-        },
-        {
+        }
+      ]
+
+      if slug
+        query.push({
           property: 'slug',
           rich_text: {
-            is_not_empty: true
+            equals: slug
           }
-        }
-      ]
+        })
+      end
 
-      query.push({
-        property: 'slug',
-        rich_text: {
-          equals: slug,
-        }
-      }) if slug
+      if tag
+        query.push({
+          property: 'tags',
+          multi_select: {
+            contains: tag
+          }
+        })
+      end
 
-      query.push({
-        property: 'tags',
-        multi_select: {
-          contains: tag,
-        }
-      }) if tag
+      query
+    end
 
-      pages = @client.database_query(
-        database_id: Rails.application.credentials.notion.database_id,
-        sorts: [
-          {
-            property: 'published',
-            direction: 'descending'
-          }
-        ],
-        filter: {
-          'and': query
-        }
-      )
-      pages['results'].map { |page| Notion::BasePage.new(page) }
+    def default_sorting
+      {
+        property: 'published',
+        direction: 'descending'
+      }
+    end
+
+    def get_articles(tag: nil, slug: nil, page_size: 10)
+      __get_articles(tag: tag, slug: slug, page_size: page_size)['results'].map do |page|
+        NotionRails::BasePage.new(page)
+      end
     end
 
     def get_article(id)
-      base_page = Notion::BasePage.new(@client.page(page_id: id))
-      base_blocks = get_blocks(id)
-      Notion::Page.new(base_page, base_blocks)
+      base_page = NotionRails::BasePage.new(__get_page(id))
+      base_blocks = NotionRails.config.cache_store.fetch(id) { get_blocks(id) }
+      NotionRails::Page.new(base_page, base_blocks)
     end
 
     def get_blocks(id)
-      blocks = @client.block_children(block_id: id)
+      blocks = __get_blocks(id)
       parent_list_block_index = nil
       results = []
       blocks['results'].each_with_index do |block, index|
-        base_block = Notion::BaseBlock.new(block)
-        if base_block.has_children
-          base_block.children = get_blocks(base_block.id)
-        end
+        base_block = NotionRails::BaseBlock.new(block)
+        base_block.children = get_blocks(base_block.id) if base_block.has_children
         # Notion returns same list items as different blocks so we have to do some processing to have them be related
         # TODO: Separate this into a function, add support for bulleted items.
         #       Currently bulleted items render fine, but they do it in separate ul blocks
         #       Make them appear in the same ul block as numbered_items appear in the same ol block
         if %w[numbered_list_item].include? base_block.type
           siblings = !parent_list_block_index.nil? &&
-                      index != parent_list_block_index &&
-                      base_block.type == results[parent_list_block_index]&.type &&
-                      base_block.parent == results[parent_list_block_index]&.parent
+                     index != parent_list_block_index &&
+                     base_block.type == results[parent_list_block_index]&.type &&
+                     base_block.parent == results[parent_list_block_index]&.parent
           if siblings
             results[parent_list_block_index].siblings << base_block
             next
@@ -86,5 +85,28 @@ module NotionRails
       end
       results
     end
+
+    private
+
+    def __get_articles(tag: nil, slug: nil, page_size: 10)
+      @client.database_query(
+        database_id: NotionRails.config.notion_database_id,
+        sorts: [
+          default_sorting
+        ],
+        filter: {
+          'and': default_query(tag: tag, slug: slug)
+        },
+        page_size: page_size
+      )
+    end
+
+    def __get_page(id)
+      @client.page(page_id: id)
+    end
+
+    def __get_blocks(id)
+      @client.block_children(block_id: id)
+    end
   end
 end

data/lib/notion_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NotionRails
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

data/lib/notion_rails.rb

@@ -1,3 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "notion_rails/version"
+require 'notion_rails/renderers'
+require 'notion_rails/base_block'
+require 'notion_rails/base_page'
+require 'notion_rails/page'
+require 'notion_rails/service'
+require 'dry-configurable'
+
+module NotionRails
+  extend Dry::Configurable
+
+  setting :notion_api_token
+  setting :notion_database_id
+  setting :cache_store, default: ActiveSupport::Cache::MemoryStore.new
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: notion_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Guillermo Aguirre
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2024-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -24,9 +24,51 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: notion-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 description: Simple gem to render Notion blocks as HTML using Rails
 email:
-- guillermoaguirre1@gmail.com
+- guillermoaguirre@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -46,7 +88,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/guillermoap/notion-rails
   source_code_uri: https://github.com/guillermoap/notion-rails
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -54,15 +96,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Notion HTML renderer for Rails
 test_files: []