notion_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd982bd457f6bd05562e1e957c146e7680f51665498ae33b5127c68a3a34f157
-  data.tar.gz: 79a47c55cd34192ec52def80c4bc2a3f81f65476087b1941344cb2075f9072a1
+  metadata.gz: 95a025ff228890fafa2fd982d108512fa0980fbae091232c6fbfac6ae85667b8
+  data.tar.gz: 8bc99ae3b897b5116ed5e4fe91847a8160db7436490f76360d637c10128df487
 SHA512:
-  metadata.gz: e894d60b980e651fd7c9a91ea48c03852d2f4859a88ea058b5e8926f1fd3b7286f17147db8dcde5057d655af22684cb7ed9bcbcc9edf281765305b8d2f3f0afd
-  data.tar.gz: 22b978b22ec0d744c99a4323528e8d908526f6213dbf9338869945af25fc8b1c1a9eee22189f7715fbc2e2819dff1c51d12870e2128e90431a15f1b2cef95454
+  metadata.gz: bdd4412954a606cccf29b805a4db0c9f4ffcec32b9d1baf64feb7a7724fe48a2a72974e1e5650254bc86d0b5eb467961492c5e49284d1d3f9f7a62f31d072b0a
+  data.tar.gz: 426dee990473e7a39722e81e32f282cd3f3909156884e2a9dd46f64fff0ef4893a235ab8eff6921621603c445a6117932116961d370c423cb393fc88a145c171

data/README.md

@@ -2,7 +2,7 @@
 
 TODO: Delete this and the text below, and describe your gem
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/notion/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/notion_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 

data/lib/notion_rails/base_block.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module NotionRails
+  class BaseBlock
+    include NotionRails::Renderers
+
+    # TODO: validate object type is block
+
+    attr_reader :id,
+      :created_time,
+      :last_edited_time,
+      :created_by,
+      :last_edited_by,
+      :parent,
+      :archived,
+      :has_children,
+      :children,
+      :siblings,
+      :type,
+      :properties
+
+    attr_accessor :children, :siblings
+
+    BLOCK_TYPES = %w[
+      paragraph
+      heading_1
+      heading_2
+      heading_3
+      bulleted_list_item
+      numbered_list_item
+      quote
+      callout
+      code
+      image
+      video
+      table_of_contents
+    ].freeze
+
+    def initialize(data)
+      @id = data['id']
+      @created_time = data['created_time']
+      @last_edited_time = data['last_edited_time']
+      # TODO: handle user object
+      @created_by = data['created_by']
+      @last_edited_by = data['last_edited_by']
+      # TODO: handle page_id type
+      @parent = data['parent']
+      @archived = data['archived']
+      @has_children = data['has_children']
+      @children = []
+      @siblings = []
+      @type = data['type']
+      @properties = data[@type]
+    end
+
+    def render(options = {})
+      case @type
+      when 'paragraph' then render_paragraph(rich_text, class: options[:paragraph])
+      when 'heading_1' then render_heading_1(rich_text, class: options[:heading_1])
+      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'
+        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 'image' then render_image(*multi_media)
+      when 'video' then render_video(*multi_media)
+      else
+        'Error'
+      end
+    end
+
+    def rich_text
+      @properties['rich_text'] || []
+    end
+
+    def icon
+      icon = @properties['icon']
+      @properties['icon'][icon['type']] || []
+    end
+
+    def multi_media
+      case @properties['type']
+      when 'file'
+        [@properties.dig('file', 'url'), @properties.dig('file', 'expiry_time'), @properties['caption'], 'file']
+      when 'external'
+        [@properties.dig('external', 'url'), nil, @properties['caption'], 'external']
+      else
+        [nil, nil, @properties['caption'], nil]
+      end
+    end
+
+    private
+
+    def render_table_of_contents; end
+  end
+end

data/lib/notion_rails/base_page.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module NotionRails
+  class BasePage
+    include NotionRails::Renderers
+
+    # TODO: validate object type is page
+    attr_reader :id,
+      :created_time,
+      :last_edited_time,
+      :created_by,
+      :last_edited_by,
+      :cover,
+      :icon,
+      :parent,
+      :archived,
+      :properties,
+      :published_at,
+      :tags,
+      :title,
+      :slug,
+      :description,
+      :url
+
+    def initialize(data)
+      @id = data['id']
+      @created_time = data['created_time']
+      @last_edited_time = data['last_edited_time']
+      # TODO: handle user object
+      @created_by = data['created_by']
+      @last_edited_by = data['last_edited_by']
+      # TODO: handle external type
+      @cover = data['cover']
+      # TODO: handle emoji type
+      @icon = data['icon']
+      # TODO: handle database_id type
+      @parent = data['parent']
+      @archived = data['archived']
+      # TODO: handle properties object
+      @properties = data['properties']
+      process_properties
+      @url = data['url']
+    end
+
+    def formatted_title(options = {})
+      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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module NotionRails
+  class Page
+    include NotionRails::Renderers
+
+    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
+
+    def formatted_blocks(options = {})
+      @blocks.map { |block| block.render(options) }
+    end
+  end
+end

data/lib/notion_rails/renderers.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module NotionRails
+  module Renderers
+    include ActionView::Helpers::AssetTagHelper
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Context
+
+    def annotation_to_css_class(annotations)
+      classes = annotations.keys.map do |key|
+        case key
+        when 'strikethrough'
+          'line-through' if annotations[key]
+        when 'bold'
+          'font-bold' if annotations[key]
+        when 'code'
+          'inline-code' if annotations[key]
+        when 'color'
+          "text-#{annotations["color"]}-600" if annotations[key] != 'default'
+        else
+          annotations[key] ? key : nil
+        end
+      end
+      classes.compact.join(' ')
+    end
+
+    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} #{options[:class]}"
+          )
+        elsif classes.present?
+          content_tag(:span, rich_text['plain_text'], class: "#{classes} #{options[:class]}")
+        else
+          tag.span(rich_text['plain_text'], class: options[:class])
+        end
+      end.join('').html_safe
+    end
+
+    def render_title(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)
+      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)
+      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)
+      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)
+      end
+    end
+
+    def render_code(rich_text_array, options = {})
+      # TODO: render captions
+      pre_options = options
+      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
+            text_renderer(rich_text_array, options)
+          end
+        end
+      end
+    end
+
+    def render_bulleted_list_item(rich_text_array, siblings, children, options = {})
+      pre_options = options
+      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)
+        end
+        if children.present?
+          res = children.map do |child|
+            render_bulleted_list_item(child.rich_text, child.siblings, child.children, options)
+          end
+          content += res.join('').html_safe
+        end
+        content.html_safe
+      end
+    end
+
+    def render_numbered_list_item(rich_text_array, siblings, children, options = {})
+      pre_options = options
+      pre_options[:class] = "list-decimal #{pre_options[:class]}"
+      content_tag(:ol, pre_options) do
+        render_list_items(:numbered_list_item, rich_text_array, siblings, children, options)
+      end
+    end
+
+    def render_list_items(type, rich_text_array, siblings, children, options = {})
+      content = content_tag(:li, options) do
+        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
+      end
+      if siblings.present?
+        content += siblings.map do |sibling|
+          render_list_items(type, sibling.rich_text, sibling.siblings, sibling.children, options)
+        end.join('').html_safe
+      end
+      content.html_safe
+    end
+
+    def render_quote(rich_text_array, options = {})
+      div_options = options.dup
+      pre_options = options.dup
+      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) do
+          content_tag(:p, pre_options) do
+            text_renderer(rich_text_array)
+          end
+        end
+      end
+    end
+
+    def render_callout(rich_text_array, icon, options = {})
+      pre_options = options
+      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)
+        content
+      end
+    end
+
+    def render_image(src, expiry_time, caption, type, options = {})
+      content_tag(:figure, options) do
+        content = tag.img(src: src, alt: '')
+        content += tag.figcaption(text_renderer(caption))
+        content
+      end
+    end
+
+    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: src, allowfullscreen: true, class: 'w-full aspect-video')
+                  end
+        content += tag.figcaption(text_renderer(caption))
+        content
+      end
+    end
+  end
+end

data/lib/notion_rails/service.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module NotionRails
+  class Service
+    def initialize
+      @client = Notion::Client.new(token: NotionRails.config.notion_api_token)
+    end
+
+    def default_query(tag: nil, slug: nil)
+      query = [
+        {
+          property: 'public',
+          checkbox: {
+            equals: true
+          }
+        }
+      ]
+
+      if slug
+        query.push({
+          property: 'slug',
+          rich_text: {
+            equals: slug
+          }
+        })
+      end
+
+      if tag
+        query.push({
+          property: 'tags',
+          multi_select: {
+            contains: tag
+          }
+        })
+      end
+
+      query
+    end
+
+    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 = 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 = __get_blocks(id)
+      parent_list_block_index = nil
+      results = []
+      blocks['results'].each_with_index do |block, index|
+        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
+          if siblings
+            results[parent_list_block_index].siblings << base_block
+            next
+          else
+            parent_list_block_index = results.length
+          end
+        else
+          parent_list_block_index = nil
+        end
+        results << base_block
+      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.0"
+  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.0
+  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: []
@@ -34,6 +76,11 @@ files:
 - LICENSE.txt
 - README.md
 - lib/notion_rails.rb
+- lib/notion_rails/base_block.rb
+- lib/notion_rails/base_page.rb
+- lib/notion_rails/page.rb
+- lib/notion_rails/renderers.rb
+- lib/notion_rails/service.rb
 - lib/notion_rails/version.rb
 homepage: https://github.com/guillermoap/notion-rails
 licenses:
@@ -41,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
@@ -49,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: []