dato-rails 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efcf217eb4b7350ff1b1a431add8314ce1353c01c9ce2d5ffef606a0d91aa3e9
-  data.tar.gz: 1006e161f158eff58e2449f43ec8392bd1a6812efe07dfe75b6596af1774f932
+  metadata.gz: 1973ec82f04620deeaf8b94c8b8fe4816c60f5c00cf0ccfba93ab38e938af5fb
+  data.tar.gz: 1f83767d11f764f199b4bf394da6d216a237d22a37fee001542413f5f183ab61
 SHA512:
-  metadata.gz: 40bf39ed3afb39b32d4f3516c4bd795649b4f79eab307b9d9699e262dd91fef7ffc35ced8cf75a2bcf8c2312766d7ef63a00fe8d58235b1c6f942c441a5e4961
-  data.tar.gz: 574dcb125c6539385851c4f0db6aefae191b8d03f7d5695394c4c92f0a7f6a0d86b581e909474c35a7bb4ba5952a0f86f0fe1103811568fffe65eca0d1705511
+  metadata.gz: 69b37b143b7e6f422c28f3b74677991d876a5bd181e3ebf97e9bc93d31165404bc39c32991cdbf3cd635c640fde730cc564a00c002ff4cf725870ec2703282c4
+  data.tar.gz: b9f95b4994a61b6801a781ba3369e679a1dbfc012d356a213de48b30bbab8a54ca2282d33a7754368c3b12b594b8b22ec265dc89b4776c083c0086707cf97dea

data/README.md

@@ -5,7 +5,8 @@ Use [DatoCMS](https://www.datocms.com/) in your Rails application.
 This gem allows you to fetch data using Dato GraphQL APIs and render the content in your Rails app.
 
 👉 See [this simple tutorial to get started on dev.to](https://dev.to/coorasse/datocms-with-ruby-on-rails-3ae5). 👈
-👉 See also [this second tutorial to build a Blog](https://dev.to/coorasse/rails-blog-with-datocms-264j-temp-slug-4336490). 👈
+
+👉 See also [this second tutorial to build a Blog](https://dev.to/coorasse/rails-blog-with-datocms-2h1e). 👈
 
 ## Installation
 
@@ -89,24 +90,7 @@ If you have a responsive image, you can render it with:
 render Dato::ResponsiveImage.new(node.image.responsiveImage)
 ```
 
-To define a custom node, you can create a new `Dato::CustomNode` view component in your application and it will be
-automatically used.
-
-You can also customize how each node type is rendered by specifying the mapping on the single render:
-
-```ruby
-render Dato::StructuredText.new(response.data.homepage.content, overrides: { link: Dato::NotRendered })
-```
-
-or globally:
-
-```
-# config/initializers/dato.rb
-
-Dato::Config.overrides = {
-  link: 'Dato::NotRendered'
-}.with_indifferent_access
-```
+Read more about [StructuredText - Custom Nodes](docs/custom_nodes.md).
 
 ## Preview and live
 
@@ -243,6 +227,7 @@ Dato::Config.configure do |config|
   config.api_token = ENV['DATO_PUBLISH_KEY'] # default: ENV.fetch("DATO_API_TOKEN", Rails.application.credentials.dig(:dato, :api_token))
   config.publish_key = ENV['DATO_PUBLISH_KEY'] # default: ENV.fetch("DATO_PUBLISH_KEY", Rails.application.credentials.dig(:dato, :publish_key))
   config.build_trigger_id = ENV['DATO_BUILD_TRIGGER_ID'] # default: ENV.fetch("DATO_BUILD_TRIGGER_ID", Rails.application.credentials.dig(:dato, :build_trigger_id))
+  config.base_editing_url = ENV['DATO_BASE_EDITING_URL'] # default: ENV.fetch("DATO_BASE_EDITING_URL", Rails.application.credentials.dig(:dato, :base_editing_url))
   config.mount_path = '/dato' # default: '/dato'
 end
 ```
@@ -285,18 +270,20 @@ executing `Dato::Cache.clear!` or running `bin/rails dato:cache:clear`.
 
 You can take advantage of the publish mechanism of Dato CMS to expire the cache.
 
-* Set the `DATO_PUBLISH_KEY` environment variable or in Rails Credentials.
+* Generate a new secret key with `bin/rails secret` and set it as `DATO_PUBLISH_KEY` environment variable or in Rails Credentials as `dato.publish_key`.
 * Create a build trigger with a custom webhook on your Dato CMS project setting.
 * Define the Trigger URL as `https://yourapp.com/dato/publish`
 * Set the `DATO_PUBLISH_KEY` as the Authorization header
 * Copy the build trigger id and set it as `DATO_BUILD_TRIGGER_ID` environment variable.
 
+![docs/build_trigger_configuration.png](docs/build_trigger_configuration.png)
+
 ### Caching of graphQL response / Controller helpers
 
 If you are not using ViewComponents or you need to cache a single GraphQL query, you can still do it using the
 `Dato::Cache` helper.
 
-In your controllers you already have a helper method `execute_dato_query`.
+In your controllers you already have a helper method `execute_dato_query!`.
 You can use it in your controller action and queries results will be automatically cached if:
 
 * You have `Dato` cache enabled
@@ -304,7 +291,7 @@ You can use it in your controller action and queries results will be automatical
 * you are not displaying a preview
 
 ```ruby
-response = execute_dato_query(blog_post_query(params[:slug]), preview: params[:preview])
+response = execute_dato_query!(blog_post_query(params[:slug]), preview: params[:preview])
 @data = response.data
 ```
 
@@ -321,7 +308,6 @@ Completed 200 OK in 365ms (Views: 109.5ms | ActiveRecord: 0.7ms (4 queries, 0 ca
 
 this is useful to identify if the bottleneck is in the fetching of the data from Dato CMS.
 
-
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies.

data/app/components/dato/block.html.erb

@@ -1,13 +1,20 @@
-<% block = blocks.find { |b| b.id == @node.item } %>
-<% if block.__typename.nil? %>
-  In order to render a block, you need to return its <code>__typename</code>.<br>
-  In your GraphQL query, add <code>__typename</code> to the list of fields returned for the blocks.<br>
-  For example:<br><br>
-  <code>
-    blocks {
-      __typename
-    }
-  </code>
+<% block = blocks&.find { |b| b.id == @node.item } %>
+<% if block.nil? %>
+  <%= error_block do %>
+    There is a block with id <code><%= @node.item %></code> that has not been retrieved by the GraphQL Query.<br>
+    It's possible that your query is returning a structured text without blocks.
+  <% end %>
+<% elsif block.__typename.nil? %>
+  <%= error_block do %>
+    In order to render a block, you need to return its <code>__typename</code>.<br>
+    In your GraphQL query, add <code>__typename</code> to the list of fields returned for the blocks.<br>
+    For example:<br><br>
+    <code>
+      blocks {
+        __typename
+      }
+    </code>
+  <% end %>
 <% else %>
-  <%=render class_for_block(block).new(block, root) %>
+  <%= render class_for_block(block).new(block, root) %>
 <% end  %>

data/app/components/dato/dast_node.rb

@@ -13,5 +13,11 @@ module Dato
     def generated_tag
       @type
     end
+
+    private
+
+    def extract_meta(type)
+      @node.meta&.find { |m| m.id == type }&.value
+    end
   end
 end

data/app/components/dato/inline_block.html.erb

@@ -0,0 +1,20 @@
+<% block = blocks&.find { |b| b.id == @node.item } %>
+<% if block.nil? %>
+  <%= error_block do %>
+    There is an inline block with id <code><%= @node.item %></code> that has not been retrieved by the GraphQL Query.<br>
+    It's possible that your query is returning a structured text without blocks.
+  <% end %>
+<% elsif block.__typename.nil? %>
+  <%= error_block do %>
+    In order to render an inline block, you need to return its <code>__typename</code>.<br>
+    In your GraphQL query, add <code>__typename</code> to the list of fields returned for the blocks.<br>
+    For example:<br><br>
+    <code>
+      blocks {
+        __typename
+      }
+    </code>
+  <% end %>
+<% else %>
+  <%= render class_for_block(block).new(block, root) %>
+<% end  %>

data/app/components/dato/inline_block.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Dato::InlineBlock < Dato::DastNode
+  def initialize(node, root)
+    super(node, "inlineBlock", root)
+  end
+end

data/app/components/dato/inline_item.html.erb

@@ -0,0 +1,39 @@
+<% inline_item = links.find { |b| b.id == @node.item } %>
+
+<% if inline_item.present? %>
+  <% if class_for_inline_item(inline_item).present? %>
+    <%= render class_for_inline_item(inline_item).new(inline_item, root) %>
+  <% elsif path_for_inline_item(inline_item).present? %>
+    <%= link_to inline_item.title, path_for_inline_item(inline_item), class: "dato-cms-#{@node.type}" %>
+  <% else %>
+    <%= error_block do %>
+      This is an unknown InlineItem. Here is the content:<br>
+      <pre><%= JSON.pretty_generate(inline_item) %></pre>
+      This is a link, so you have some options:
+      <ul>
+        <li>Define the function to generate path for this item. For example:<br>
+            <code>
+              config.links_mapping = {<br>
+              &nbsp;'<%= inline_item.__typename %>' => ->(inline_item) { blog_post_path(inline_item.slug) }<br>
+              }<br>
+            </code>
+            This will use the default link renderer, and set the href attribute according to your definition.
+        </li>
+        <li>
+          Define a class in your <code>app/components/dato</code> folder. For example:<br>
+          <code>
+            class <%= class_by_type(inline_item.__typename) %> < Dato::Node<br>
+            ...<br>
+            end<br>
+          </code><br>
+        </li>
+        <li>Not render it by excluding it from your GraphQL Query</li>
+        <li>Not render it by using the overrides: <code>{overrides: '<%= @node.__typename %>': Dato::NotRendered }</code></li>
+      </ul>
+    <% end %>
+  <% end %>
+<% else %>
+  <%= error_block do %>
+    I don't know this inline item.
+  <% end %>
+<% end %>

data/app/components/dato/inline_item.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Dato::InlineItem < Dato::Node
+end

data/app/components/dato/item_link.html.erb

@@ -0,0 +1,18 @@
+<% if inline_item.__typename.nil? %>
+  <%= error_block do %>
+    In order to render an item link, you need to return its <code>__typename</code>.<br>
+    In your GraphQL query, add <code>__typename</code> to the list of fields returned for the blocks.<br>
+    For example:<br><br>
+    <code>
+      links {
+      __typename
+      }
+    </code>
+  <% end %>
+<% else %>
+  <%= tag.a(**link_attributes) do -%>
+    <% @node.children&.each do |node| -%>
+      <%= render_node(node) -%>
+    <% end -%>
+  <% end -%>
+<% end  %>

data/app/components/dato/item_link.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Dato::ItemLink < Dato::DastNode
+  def initialize(node, root)
+    super(node, "itemLink", root)
+  end
+
+  def inline_item
+    links.find { |b| b.id == @node.item }
+  end
+
+  def link_attributes
+    attr = {
+      "href" => path_for_inline_item(inline_item),
+      "class" => "dato-cms-#{@node.type}"
+    }
+    %w[rel target].each { |type| attr[type] = extract_meta(type) }
+    attr
+  end
+end

data/app/components/dato/link.rb

@@ -17,10 +17,4 @@ class Dato::Link < Dato::DastNode
     %w[rel target].each { |type| attr[type] = extract_meta(type) }
     attr
   end
-
-  private
-
-  def extract_meta(type)
-    @node.meta&.find { |m| m.id == type }&.value
-  end
 end

data/app/components/dato/node.rb

@@ -17,6 +17,10 @@ module Dato
       root.blocks
     end
 
+    def links
+      root.links
+    end
+
     def overrides
       root.overrides
     end
@@ -39,6 +43,25 @@ module Dato
       end
     end
 
+    def class_for_inline_item(inline_item)
+      class_name = overrides[inline_item.__typename] || Dato::Config.overrides[inline_item.__typename]
+      if class_name.is_a?(String)
+        class_name = class_name.constantize
+      end
+      begin
+        class_name || class_by_type(inline_item.__typename).constantize
+      rescue NameError
+        nil
+      end
+    end
+
+    def path_for_inline_item(inline_item)
+      lambda = Dato::Config.links_mapping[inline_item.__typename]
+      if lambda
+        instance_exec(inline_item, &lambda)
+      end
+    end
+
     def class_for_node(node)
       class_name = overrides[node.type] || Dato::Config.overrides[node.type]
       if class_name.is_a?(String)
@@ -54,5 +77,10 @@ module Dato
     def class_by_type(type)
       "Dato::#{type.classify}"
     end
+
+    def error_block(&block)
+      content = capture(&block)
+      content_tag(:div, content, style: "border: 3px dotted limegreen; display: inline-block; padding: 5px;font-weight: bold")
+    end
   end
 end

data/app/components/dato/paragraph.rb

@@ -6,6 +6,6 @@ class Dato::Paragraph < Dato::DastNode
   end
 
   def generated_tag
-    "p"
+    "div"
   end
 end

data/app/components/dato/structured_text.rb

@@ -13,6 +13,7 @@ class Dato::StructuredText < Dato::Node
     @overrides = overrides.with_indifferent_access
     @structured_text_node = structured_text_node
     @blocks = structured_text_node.blocks
+    @links = structured_text_node.links
   end
 
   def root
@@ -20,6 +21,7 @@ class Dato::StructuredText < Dato::Node
   end
 
   attr_reader :blocks
+  attr_reader :links
 
   attr_reader :overrides
 end

data/app/components/dato/unknown_block.html.erb

@@ -1,17 +1,18 @@
-<div style="border: 3px dotted limegreen; display: inline-block; padding: 5px;">
-  <b>
-    This is an unknown block. Here is the content:<br>
-    <pre><%= JSON.pretty_generate(@node)  %></pre>
-    In order to render it, you need to define a ViewComponent named <code><%=class_by_type(@node.__typename) %></code>.<br>
-    You can define this class in your <code>app/components/dato</code> folder. For example:<br><br>
-    <code>
-      class <%=class_by_type(@node.__typename) %> < Dato::DastNode<br>
-      ...<br>
-      end<br>
-    </code><br>
-    If you don't want to render this block you can:
-    * not return it in your GraphQL query
-    * the component when rendering the root <code>Dato::StructuredText</code> node.<br>
-    <code>Dato::StructuredText.new(content, overrides: { '<%=@node.__typename %>': Dato::NotRendered })</code>
-  </b>
-</div>
+<%= error_block do %>
+  This is an unknown block. Here is the content:<br>
+  <pre><%= JSON.pretty_generate(@node) %></pre>
+  In order to render it, you need to define a ViewComponent named <code><%= class_by_type(@node.__typename) %></code>.
+  <br>
+  You can define this class in your <code>app/components/dato</code> folder. For example:<br><br>
+  <code>
+    class <%= class_by_type(@node.__typename) %> < Dato::Node<br>
+    ...<br>
+    end<br>
+  </code><br>
+  If you don't want to render this block you can:
+  <ul>
+    <li>not return it in your GraphQL query</li>
+    <li>override the component when rendering the root <code>Dato::StructuredText</code> node.<br>
+      <code>Dato::StructuredText.new(content, overrides: { '<%= @node.__typename %>': Dato::NotRendered })</code></li>
+  </ul>
+<% end %>

data/app/components/dato/unknown_node.html.erb

@@ -1,15 +1,15 @@
-<div style="border: 3px dotted limegreen; display: inline-block; padding: 5px;">
-  <b>
-    This is an unknown node of type <code><%=@type %></code>.<br>
-    In order to render it, you need to define a ViewComponent named <code><%=class_by_type(@node.type) %></code>.<br>
-    You can define this class in your <code>app/components/dato</code> folder. For example:<br><br>
-    <code>
-      class <%=class_by_type(@node.type) %> < Dato::DastNode<br>
-        ...<br>
-      end<br>
-    </code><br>
-    If you don't want to render this node, you can override the component when rendering the root <code>Dato::StructuredText</code> node.<br>
-    <code>Dato::StructuredText.new(content, overrides: { link: Dato::NotRendered })</code>
-  </b>
+<%= error_block do %>
+  This is an unknown node of type <code><%= @type %></code>. Here is the content:<br>
+  <pre><%= JSON.pretty_generate(@node) %></pre>
+  In order to render it, you need to define a ViewComponent named <code><%= class_by_type(@node.type) %></code>.<br>
+  You can define this class in your <code>app/components/dato</code> folder. For example:<br><br>
+  <code>
+    class <%= class_by_type(@node.type) %> < Dato::Node<br>
+    ...<br>
+    end<br>
+  </code><br>
+  If you don't want to render this node, you can override the component when rendering the root
+  <code>Dato::StructuredText</code> node.<br>
+  <code>Dato::StructuredText.new(content, overrides: { link: Dato::NotRendered })</code>
   <%= debug_node %>
-</div>
+<% end %>

data/lib/dato/config.rb

@@ -3,12 +3,14 @@ module Dato
     include ActiveSupport::Configurable
 
     config_accessor(:overrides) { {} }
+    config_accessor(:links_mapping) { {} }
     config_accessor(:blocks) { {} }
     config_accessor(:cache) { false }
     config_accessor(:cache_namespace) { "dato-rails" }
     config_accessor(:api_token) { ENV.fetch("DATO_API_TOKEN", Rails.application.credentials.dig(:dato, :api_token)) }
     config_accessor(:publish_key) { ENV.fetch("DATO_PUBLISH_KEY", Rails.application.credentials.dig(:dato, :publish_key)) }
     config_accessor(:build_trigger_id) { ENV.fetch("DATO_BUILD_TRIGGER_ID", Rails.application.credentials.dig(:dato, :build_trigger_id)) }
+    config_accessor(:base_editing_url) { ENV.fetch("DATO_BASE_EDITING_URL", Rails.application.credentials.dig(:dato, :base_editing_url)) }
     config_accessor(:mount_path) { "/dato" }
   end
 end

data/lib/dato/engine.rb

@@ -1,4 +1,6 @@
 module Dato
+  class InvalidGraphqlQuery < StandardError; end
+
   class Engine < ::Rails::Engine
     isolate_namespace Dato
 

data/lib/dato/gql.rb

@@ -2,11 +2,12 @@ module Dato
   class Gql < GQLi::Client
     def initialize(api_token, validate_query, preview, live)
       @api_token = api_token
+      headers = {"Authorization" => @api_token}
+      headers["X-Base-Editing-Url"] = Dato::Config.base_editing_url if Dato::Config.base_editing_url.present?
+
       super(
         "https://graphql#{"-listen" if live}.datocms.com/#{"preview" if preview}",
-        headers: {
-          "Authorization" => @api_token
-        },
+        headers: headers,
         validate_query: validate_query && !live
       )
     end

data/lib/dato/railties/controller_runtime.rb

@@ -5,9 +5,7 @@ module Dato
 
       def execute_dato_query(query, preview: false)
         client = Dato::Client.new(preview: preview)
-        if preview
-          return client.execute!(query)
-        end
+        return client.execute!(query) if preview
 
         key = "#{Digest::MD5.hexdigest(query.to_gql)}-query-#{preview}"
         Dato::Cache.fetch(key) do
@@ -15,6 +13,13 @@ module Dato
         end
       end
 
+      def execute_dato_query!(query, preview: false)
+        response = execute_dato_query(query, preview: preview)
+        raise(InvalidGraphqlQuery, response.errors.first.message) if response.errors&.any?
+
+        response
+      end
+
       module ClassMethods # :nodoc:
         def log_process_action(payload)
           messages = super

data/lib/dato/version.rb

@@ -1,3 +1,3 @@
 module Dato
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dato-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Alessandro Rodi
 bindir: bin
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -186,6 +186,12 @@ files:
 - app/components/dato/heading.rb
 - app/components/dato/image_block_record.html.erb
 - app/components/dato/image_block_record.rb
+- app/components/dato/inline_block.html.erb
+- app/components/dato/inline_block.rb
+- app/components/dato/inline_item.html.erb
+- app/components/dato/inline_item.rb
+- app/components/dato/item_link.html.erb
+- app/components/dato/item_link.rb
 - app/components/dato/link.html.erb
 - app/components/dato/link.rb
 - app/components/dato/list.rb