dato_dast 0.0.1

data/lib/dato_dast/nodes/block.rb

@@ -0,0 +1,124 @@
+module DatoDast
+  module Nodes
+    class Block < Base
+      def block_id
+        @node["item"]
+      end
+
+      def block
+        return @block if @block
+
+        @block ||= @blocks.find { |block| block[:id] == block_id }
+      end
+
+      def item_type
+        block[:item_type]
+      end
+
+      def node
+        node_config["node"]
+      end
+
+      def node_config
+        config.blocks[item_type]
+      end
+
+      def children
+        Array.wrap(structure).map do |child|
+          case child["type"]
+          when "field"
+            build_field(child)
+          when "value"
+            build_value(child)
+          when "block"
+            build_block(block[child["field"].to_sym])
+          when "blocks"
+            build_blocks(child)
+          else
+            raise Errors::InvalidBlockStructureType
+          end.merge(extract_tags(child)).compact
+        end.flatten
+      end
+
+      def render_value
+        if node_config["render_value"]
+          node_config["render_value"].call(block)
+        else
+          render_children
+        end
+      end
+
+      def render
+        return super unless node
+
+        begin
+          node.new(block).render
+        rescue NoMethodError => _e
+          raise Errors::BlockNodeMissingRenderFunction.new(["block->#{item_type}"])
+        end
+      end
+
+      private
+
+      def structure
+        node_config["structure"]
+      end
+
+      def extract_tags(child)
+        {
+          "tag" => child["tag"],
+          "css_class" => child["css_class"],
+          "meta" => child["meta"],
+          "wrappers" => child["wrappers"],
+        }.compact
+      end
+
+      def build_field(child)
+        raise Errors::BlockFieldMissing.new(item_type) unless child["field"]
+
+        field = child["field"].to_sym
+        value = block[field]
+
+        {
+          "type" => "span",
+          "value" => value,
+          "marks" => Array.wrap(child["marks"]),
+        }
+      end
+
+      def build_value(child)
+        raise Errors::MissingRenderValueFunction.new(item_type) unless child["render_value"]
+
+        value = child["render_value"].call(block)
+
+        {
+          "type" => "span",
+          "value" => value,
+          "marks" => Array.wrap(child["marks"]),
+        }
+      end
+
+      def build_block(child)
+        @blocks << child
+
+        {
+          "type" => "block",
+          "item" => child[:id],
+        }
+      end
+
+      def build_blocks(child)
+        field = child["field"].to_sym
+
+        parent = {
+          "type" => "generic",
+          "children" => Array.wrap(block[field]).map { |child_block| build_block(child_block) }
+        }
+      end
+
+      def proc_object
+        block
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/blockquote.rb

@@ -0,0 +1,6 @@
+module DatoDast
+  module Nodes
+    class Blockquote < Base
+    end
+  end
+end

data/lib/dato_dast/nodes/code.rb

@@ -0,0 +1,35 @@
+module DatoDast
+  module Nodes
+    class Code < Base
+      def language
+        @node["language"]
+      end
+
+      def code
+        @node["code"]
+      end
+
+      def render
+        if highlighter?
+          highlight
+        else
+          super
+        end
+      end
+
+      def render_value
+        code.gsub(/\n/, "<br/>")
+      end
+
+      private
+
+      def highlighter?
+        config.highlight && defined?(::Middleman::Syntax::SyntaxExtension)
+      end
+
+      def highlight
+        Middleman::Syntax::Highlighter.highlight(code, language, {}).html_safe
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/generic.rb

@@ -0,0 +1,21 @@
+module DatoDast
+  module Nodes
+    class Generic < Base
+      def tag
+        @node["tag"]
+      end
+
+      def css_class
+        @node["css_class"]
+      end
+
+      def wrappers
+        Array.wrap(@node["wrappers"])
+      end
+
+      def meta
+        @node["meta"]
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/heading.rb

@@ -0,0 +1,14 @@
+module DatoDast
+  module Nodes
+    class Heading < Base
+      def level
+        @node["level"]
+      end
+
+      # def tag
+      #   base_tag = super
+      #   base_tag.gsub(/#/, level.to_s)
+      # end
+    end
+  end
+end

data/lib/dato_dast/nodes/inline_item.rb

@@ -0,0 +1,14 @@
+# An inlineItem, similarly to itemLink, links the document to another record but does not specify any inner content (children).
+#
+# It can be used in situations where it is up to the frontend to decide how to present the record (ie. a widget, or an <a> tag pointing to the URL of the record with a text that is the title of the linked record).
+#
+# It does not allow children nodes.
+#
+# type  "inlineItem"  Required
+# item  string  Required
+# The DatoCMS record ID
+#
+# {
+#   "type": "inlineItem",
+#   "item": "74619345"
+# }

data/lib/dato_dast/nodes/item_link.rb

@@ -0,0 +1,29 @@
+module DatoDast
+  module Nodes
+    class ItemLink < Link
+      def item_id
+        @node["item"]
+      end
+
+      def item
+        @links.find { |link| link[:id] == item_id }
+      end
+
+      def url
+        item[url_key]
+      end
+
+      def item_type
+        item[:item_type]
+      end
+
+      private
+
+      def url_key
+        # TODO if the url key does not exist
+
+        config.item_links[item_type]
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/link.rb

@@ -0,0 +1,57 @@
+require "uri"
+
+module DatoDast
+  module Nodes
+    class Link < Base
+      NEW_WINDOW_META = [
+        { "id" => "rel", "value" => "nofollow" },
+        { "id" => "target", "value" => "_blank" },
+      ].freeze
+
+      def url
+        node_url = @node["url"]
+
+        if node_url =~ URI::MailTo::EMAIL_REGEXP
+          "mailto:#{node_url}"
+        else
+          node_url
+        end
+      end
+
+      def meta
+        fields = @node["meta"].dup || []
+        fields.prepend({ "id" => "href", "value" => path })
+
+        new_window? ? (fields + NEW_WINDOW_META).uniq : fields
+      end
+
+      def path
+        local_url || uri.to_s
+      end
+
+      private
+
+      def uri
+        @uri ||= URI(url)
+      end
+
+      def smart_links?
+        config.smart_links
+      end
+
+      def new_window?
+        smart_links? && !local_url
+      end
+
+      def local_url
+        return @local_url if defined?(@local_url)
+
+        @local_url = if uri.host.nil? && !uri.is_a?(URI::MailTo)
+          "/#{uri.to_s}"
+        elsif smart_links? && uri.host == config.host
+          uri.path
+        end
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/list.rb

@@ -0,0 +1,9 @@
+module DatoDast
+  module Nodes
+    class List < Base
+      def style
+        @node["style"]
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/list_item.rb

@@ -0,0 +1,6 @@
+module DatoDast
+  module Nodes
+    class ListItem < Base
+    end
+  end
+end

data/lib/dato_dast/nodes/paragraph.rb

@@ -0,0 +1,6 @@
+module DatoDast
+  module Nodes
+    class Paragraph < Base
+    end
+  end
+end

data/lib/dato_dast/nodes/root.rb

@@ -0,0 +1,6 @@
+module DatoDast
+  module Nodes
+    class Root < Base
+    end
+  end
+end

data/lib/dato_dast/nodes/span.rb

@@ -0,0 +1,21 @@
+module DatoDast
+  module Nodes
+    class Span < Base
+      def marks
+        @node["marks"] || []
+      end
+
+      def value
+        @node["value"].gsub(/\n/, "<br/>")
+      end
+
+      def wrappers
+        Array.wrap(super) + marks.map { |mark| config.marks[mark] }
+      end
+
+      def render_value
+        value
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes/thematic_break.rb

@@ -0,0 +1,9 @@
+module DatoDast
+  module Nodes
+    class ThematicBreak < Base
+      def render
+        "<#{tag}/>\n"
+      end
+    end
+  end
+end

data/lib/dato_dast/nodes.rb

@@ -0,0 +1,29 @@
+require "dato_dast/nodes/base"
+require "dato_dast/nodes/span"
+require "dato_dast/nodes/generic"
+require "dato_dast/nodes/block"
+require "dato_dast/nodes/attributed_quote"
+require "dato_dast/nodes/blockquote"
+require "dato_dast/nodes/code"
+require "dato_dast/nodes/heading"
+require "dato_dast/nodes/inline_item"
+require "dato_dast/nodes/link"
+require "dato_dast/nodes/item_link"
+require "dato_dast/nodes/list"
+require "dato_dast/nodes/list_item"
+require "dato_dast/nodes/paragraph"
+require "dato_dast/nodes/root"
+require "dato_dast/nodes/thematic_break"
+require "dato_dast/nodes/block"
+
+
+module DatoDast
+  module Nodes
+    def self.wrap(value, links = [], blocks = [], config = nil)
+      type = value["type"]
+      configuration = config || DatoDast.configuration
+      node_class = value["node"] || configuration.types[type]["node"]
+      node_class.new(value, links, blocks, config)
+    end
+  end
+end

data/lib/dato_dast/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DatoDast
+  VERSION = "0.0.1"
+end

data/lib/dato_dast.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/array"
+require "active_support/core_ext/string"
+require "active_support/core_ext/object"
+require "active_support/concern"
+require_relative "dato_dast/version"
+require_relative "dato_dast/html_tag"
+require_relative "dato_dast/errors"
+require_relative "dato_dast/marks"
+require_relative "dato_dast/nodes"
+require_relative "dato_dast/configuration"
+
+module DatoDast
+  def self.configuration
+    @configuration ||= DatoDast::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.reset_configuration
+    @configuration = DatoDast::Configuration.new
+  end
+
+  def self.structured_text(item, config = nil)
+    object = item.to_hash
+    document = object[:value]["document"]
+    links = object[:links]
+    blocks = object[:blocks]
+
+    Nodes.wrap(document, links, blocks, config).render
+  end
+end
+
+if defined?(Middleman)
+  require "dato_dast/extensions/middleman"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: dato_dast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John DeWyze
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-10 00:00:00.000000000 Z
+dependencies:
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a way to convert DatoCMS structured text to Html, as
+  well as an extension for Middleman.
+email:
+- john@dewyze.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".projections.json"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- dato_dast.gemspec
+- lib/dato_dast.rb
+- lib/dato_dast/configuration.rb
+- lib/dato_dast/errors.rb
+- lib/dato_dast/errors/block_field_missing.rb
+- lib/dato_dast/errors/block_node_missing_render_function.rb
+- lib/dato_dast/errors/invalid_block_structure_type.rb
+- lib/dato_dast/errors/invalid_blocks_configuration.rb
+- lib/dato_dast/errors/invalid_marks_configuration.rb
+- lib/dato_dast/errors/invalid_nodes.rb
+- lib/dato_dast/errors/invalid_types_configuration.rb
+- lib/dato_dast/errors/missing_render_value_function.rb
+- lib/dato_dast/extensions/middleman.rb
+- lib/dato_dast/html_tag.rb
+- lib/dato_dast/marks.rb
+- lib/dato_dast/nodes.rb
+- lib/dato_dast/nodes/attributed_quote.rb
+- lib/dato_dast/nodes/base.rb
+- lib/dato_dast/nodes/block.rb
+- lib/dato_dast/nodes/blockquote.rb
+- lib/dato_dast/nodes/code.rb
+- lib/dato_dast/nodes/generic.rb
+- lib/dato_dast/nodes/heading.rb
+- lib/dato_dast/nodes/inline_item.rb
+- lib/dato_dast/nodes/item_link.rb
+- lib/dato_dast/nodes/link.rb
+- lib/dato_dast/nodes/list.rb
+- lib/dato_dast/nodes/list_item.rb
+- lib/dato_dast/nodes/paragraph.rb
+- lib/dato_dast/nodes/root.rb
+- lib/dato_dast/nodes/span.rb
+- lib/dato_dast/nodes/thematic_break.rb
+- lib/dato_dast/version.rb
+homepage: https://github.com/dewyze/dato_dast
+licenses: []
+metadata:
+  homepage_uri: https://github.com/dewyze/dato_dast
+  source_code_uri: https://github.com/dewyze/dato_dast
+  changelog_uri: https://github.com/dewyze/dato_dast/blob/main/CHANGELOG.md.
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Gem for converting DatoCMS Structured Text to Html
+test_files: []