notion_to_html 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3220d57586fd9d5646ad82c30b39b5b1149f567bf70656be6d634ba08c7b3cfa
-  data.tar.gz: d3b643e4a141f1b255e10e0b2308eeaee08366731bddda0acb9ba1676d1d47c5
+  metadata.gz: 66912fd27c7e40e627cb0a8ea32502c5acb6e7aac15da32b1e56116da618c920
+  data.tar.gz: ef9eeadf60a1020d43c221acf31befb23bceebaf19ccd69f954c8f6a21aa0ae6
 SHA512:
-  metadata.gz: 7fd5c79426a2c7c0d3cf9ab49e60d0af78d0aa2546f56d4438c9c967dfdbf751d1667cfbd673e4228700bfe88a74de3c74cbeaacf44fca16c4f39c3d49d857a1
-  data.tar.gz: ce55244767dffd6fc08a79902dc5121cc727efb65286c0e6e58b9a8377eaa05bb300d505dd59908fe720c6d9ce3fc0531f076c730e758b55189378cf15facf48
+  metadata.gz: 23fa1ee940dc6ea3ffa0c5fe4eac56a259f958edb3fb78d6a9a4e0af044f2fc2e9207db09505dcedde6058059f5bf4893a129ec633ad52adadaf7aaf0a70198f
+  data.tar.gz: 3fa52d199dabbb0b7719d478f9017270f2c3d9cc03c1bba1ccc7df38f1b97cc185e85e115eef18aad34616d4b946aea2b44ca55668e9fc288430f799a45506be

data/README.md

@@ -12,10 +12,6 @@ Now you can use Notion to publish your pages directly to your Ruby web page with
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [Setup](#setup)
-  - [Notion Integration](#notion-integration)
-    - [Create your integration in Notion](#create-your-integration-in-notion)
-    - [Get your API secret](#get-your-api-secret)
-    - [Give your integration page permissions](#give-your-integration-page-permissions)
 - [Configuration](#configuration)
 - [Usage](#usage)
   - [Rendering](#rendering)
@@ -23,6 +19,7 @@ Now you can use Notion to publish your pages directly to your Ruby web page with
     - [Specific Page](#specific-page)
     - [Customizing styles](#customizing-styles)
     - [Overriding default styles](#overriding-default-styles)
+    - [Adding data options](#adding-data-options)
   - [Querying](#querying)
     - [Filtering](#filtering)
     - [Sorting](#sorting)
@@ -65,46 +62,16 @@ By default the database should have the following structure:
 
 Once you have the database created you will have to setup a Notion Integration, so the Notion API can communicate with your database. For this you will have to follow the [Create Your Integration In Notion](https://developers.notion.com/docs/create-a-notion-integration#create-your-integration-in-notion) tutorial.
 
-If you wish to just quickly set it up, you can follow the relevant steps below, which are taken from that tutorial.
-
-### Notion Integration
-#### Create your integration in Notion
-The first step to building any integration (internal or public) is to create a new integration in Notion’s integrations dashboard: <https://www.notion.com/my-integrations>.
-1. Click `+ New Integration`.
-![Create integration](/docs/images/new_integration.png)
-2. Enter the integration name and select the associated workspace for the new integration.
-![Select workspace](/docs/images/new_integration_select_workspace.png)
-
-#### Get your API secret
-API requests require an API secret to be successfully authenticated.
-1. Visit the Configuration tab to get your integration’s API secret (or “Internal Integration Secret”).
-![API secret](/docs/images/get_api_key.png)
-**Remember to keep your API secret a secret!**
-Any value used to authenticate API requests should always be kept secret. Use environment variables and avoid committing sensitive data to your version control history.
-If you do accidentally expose it, remember to “refresh” your secret.
-
-#### Give your integration page permissions
-The database that we’re about to create will be added to a parent Notion page in your workspace. For your integration to interact with the page, it needs explicit permission to read/write to that specific Notion page.
-
-To give the integration permission, you will need to:
-1. Go to the page with the database you created above.
-2. Click on the ... More menu in the top-right corner of the page.
-3. Scroll down to + Add Connections.
-4. Search for your integration and select it.
-5. Confirm the integration can access the page and all of its child pages.
-![alt text](/docs/images/permissions.gif)
-6. You can then limit the integrations permission to just `Read Contents`:
-![alt text](/docs/images/permissions.png)
-
-Now you're finally ready to config the gem!
-
-### Configuration
+If you wish to just quickly set it up, you can follow the [notion integration docs](/docs/notion_setup.md), which are taken from that tutorial.
+
+## Configuration
 To configure NotionToHtml, you need to set up your Notion API token and database ID.
 If you're using Rails add an initializer file in your Rails application, such as `config/initializers/notion_to_html.rb`, and include the following configuration block:
 ```ruby
 NotionToHtml.configure do |config|
   config.notion_api_token = 'NOTION_API_TOKEN'
   config.notion_database_id = 'NOTION_DATABASE_ID'
+  config.cache_store = Rails.cache
 end
 ```
 
@@ -120,6 +87,8 @@ To get these values:
 
 Now you should be all setup!
 
+For the full list of configuration settings, see [the configuration module](./lib/notion_to_html.rb).
+
 ## Usage
 ### Rendering
 #### Pages
@@ -151,11 +120,11 @@ NotionToHtml::Service.get_page(page_id)
 You can also specify classes for each type of supported block like this:
 ```ruby
 NotionToHtml::Service.get_page(page_id).formatted_blocks(
-  paragraph: 'text-lg', 
-  heading_1: 'text-3xl md:text-4xl font-bold', 
-  heading_2: 'text-white', 
-  heading_3: 'font-bold', 
-  quote: 'italic', 
+  paragraph: { class: 'text-lg' }, 
+  heading_1: { class: 'text-3xl md:text-4xl font-bold' }, 
+  heading_2: { class: 'text-white' }, 
+  heading_3: { class: 'font-bold' }, 
+  quote: { class: 'italic' }, 
 )
 ```
 #### Overriding default styles
@@ -169,17 +138,29 @@ It also works for `formatted_blocks`:
 NotionToHtml::Service.get_page(page_id)
   .formatted_blocks(
     paragraph: { class: 'text-lg', override_class: true }, 
-    quote: 'italic' 
+    quote: { class: 'italic' } 
+)
+```
+#### Adding data options
+If you want to integrate stimulus you can add data properties by specifying the `data:` option when calling the formatter:
+```ruby
+NotionToHtml::Service.get_page(page_id).formatted_blocks(
+  paragraph: { class: 'text-lg', data: { controller: 'test' } } }, 
+  heading_1: { class: 'text-3xl md:text-4xl font-bold' }, 
+  heading_2: { class: 'text-white', data: { controller: 'click' } }, 
+  heading_3: { class: 'font-bold' }, 
+  quote: { class: 'italic' }, 
 )
 ```
 ### Querying
 By default the `NotionToHtml::Service` is setup to follow the database structure sepcified above. This way it will only return pages that have been marked as `public`.
 
 #### Filtering
-You can filter the results by specifying a tag and/or a specific slug:
+You can filter the results by specifying a name, description, tag and/or a specific slug:
 ```ruby
-NotionToHtml::Service.get_pages(tag: 'web', slug: 'test-slug')
+NotionToHtml::Service.get_pages(name: 'Ruby', description: 'ruby on rails', tag: 'web', slug: 'test-slug')
 ```
+This will return all the pages that have at least one of those specified attributes.
 #### Sorting
 The default sorting is by the `published` Date column in the database
 

data/lib/notion_to_html/base_block.rb

@@ -68,35 +68,43 @@ module NotionToHtml
       @properties = data[@type]
     end
 
+    BLOCK_TYPES.each do |block|
+      define_method("class_for_#{block}") { |options| options.dig(block, :class) }
+      define_method("data_for_#{block}") { |options| options.dig(block, :data) }
+    end
+
     # Renders the block based on its type.
     # @param options [Hash] Additional options for rendering the block.
     # @return [String] The rendered block as HTML.
     def render(options = {})
       case @type
       when 'paragraph'
-        render_paragraph(rich_text, class: options[:paragraph])
+        render_paragraph(rich_text, class: class_for_paragraph(options), data: data_for_paragraph(options))
       when 'heading_1'
-        render_heading_1(rich_text, class: options[:heading_1])
+        render_heading_1(rich_text, class: class_for_heading_1(options), data: data_for_heading_1(options))
       when 'heading_2'
-        render_heading_2(rich_text, class: options[:heading_2])
+        render_heading_2(rich_text, class: class_for_heading_2(options), data: data_for_heading_2(options))
       when 'heading_3'
-        render_heading_3(rich_text, class: options[:heading_3])
+        render_heading_3(rich_text, class: class_for_heading_3(options), data: data_for_heading_3(options))
       when 'table_of_contents'
         render_table_of_contents
       when 'bulleted_list_item'
-        render_bulleted_list_item(rich_text, @siblings, @children, 0, class: options[:bulleted_list_item])
+        render_bulleted_list_item(rich_text, @siblings, @children, 0, class: class_for_bulleted_list_item(options),
+          data: data_for_bulleted_list_item(options))
       when 'numbered_list_item'
-        render_numbered_list_item(rich_text, @siblings, @children, 0, class: options[:numbered_list_item])
+        render_numbered_list_item(rich_text, @siblings, @children, 0, class: class_for_numbered_list_item(options),
+          data: data_for_numbered_list_item(options))
       when 'quote'
-        render_quote(rich_text, class: options[:quote])
+        render_quote(rich_text, class: class_for_quote(options), data: data_for_quote(options))
       when 'callout'
-        render_callout(rich_text, icon, class: options[:callout])
+        render_callout(rich_text, icon, class: class_for_callout(options), data: data_for_callout(options))
       when 'code'
-        render_code(rich_text, class: options[:code], language: @properties['language'])
+        render_code(rich_text, class: class_for_code(options), data: data_for_code(options),
+          language: @properties['language'])
       when 'image', 'embed'
-        render_image(*multi_media, class: options[:image])
+        render_image(*multi_media, class: class_for_image(options), data: data_for_image(options))
       when 'video'
-        render_video(*multi_media, class: options[:video])
+        render_video(*multi_media, class: class_for_video(options), data: data_for_video(options))
       else
         'Unsupported block'
       end

data/lib/notion_to_html/renderers.rb

@@ -127,7 +127,7 @@ module NotionToHtml
     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: css_class_for(:date, options))
+      tag.p(date.to_date.to_fs(:long), **options, class: css_class_for(:date, options))
     end
 
     # Renders a heading 1 block.

data/lib/notion_to_html/version.rb

@@ -2,5 +2,5 @@
 
 module NotionToHtml
   # The current version of the NotionToHtml gem.
-  VERSION = '1.1.6'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_html
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Guillermo Aguirre