article_json 0.1.0 → 0.2.0

data/lib/article_json/export/amp/elements/quote.rb

@@ -0,0 +1,11 @@
+module ArticleJSON
+  module Export
+    module AMP
+      module Elements
+        class Quote < Base
+          include ArticleJSON::Export::Common::HTML::Elements::Quote
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/amp/elements/text.rb

@@ -0,0 +1,11 @@
+module ArticleJSON
+  module Export
+    module AMP
+      module Elements
+        class Text < Base
+          include ArticleJSON::Export::Common::HTML::Elements::Text
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/amp/elements/text_box.rb

@@ -0,0 +1,11 @@
+module ArticleJSON
+  module Export
+    module AMP
+      module Elements
+        class TextBox < Base
+          include ArticleJSON::Export::Common::HTML::Elements::TextBox
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/amp/exporter.rb

@@ -0,0 +1,36 @@
+module ArticleJSON
+  module Export
+    module AMP
+      class Exporter
+        include ArticleJSON::Export::Common::HTML::Exporter
+
+        # List of all used custom element tags, e.g. `[:'amp-iframe']`
+        # @return [Array[Symbol]]
+        def custom_element_tags
+          return @custom_element_tags if defined? @custom_element_tags
+          @custom_element_tags =
+            element_exporters
+              .flat_map { |element| element.custom_element_tags }
+              .uniq
+        end
+
+        # Return an array with all the javascript libraries needed for some
+        # special AMP tags (like amp-facebook or amp-iframe)
+        # @return [Array<String>]
+        def amp_libraries
+          return @amp_libraries if defined? @amp_libraries
+          @amp_libraries =
+            CustomElementLibraryResolver.new(custom_element_tags).script_tags
+        end
+
+        class << self
+          # Return the module namespace this class is nested in
+          # @return [Module]
+          def namespace
+            ArticleJSON::Export::AMP
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/base.rb

@@ -0,0 +1,111 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Base
+            # Extend `base` class with `ClassMethods` upon inclusion
+            def self.included(base)
+              base.extend ClassMethods
+            end
+
+            # @param [ArticleJSON::Elements::Base] element
+            def initialize(element)
+              @element = element
+            end
+
+            # Export a HTML node out of the given element
+            # Dynamically looks up the right export-element-class, instantiates it
+            # and then calls the #build method.
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              exporter.export unless exporter.nil?
+            end
+
+            private
+
+            # Create a Nokogiri NodeSet wrapping a Node with the given `tag`
+            # @param [Symbol] tag - type of the created element
+            # @param [*Object] args - additional arguments for the element
+            # @yield [Nokogiri::XML::Element] Optional block can be passed, will
+            #                                 be executed with the generated
+            #                                 element as a parameter
+            # @return [Nokogiri::XML::NodeSet] Generated main element wrapped in a
+            #                                  NodeSet
+            def create_element(tag, *args)
+              document = Nokogiri::HTML.fragment('').document
+              element = document.create_element(tag.to_s, *args)
+              yield(element) if block_given?
+              wrap_in_node_set([element], document)
+            end
+
+            # Wrap a given list of Nokogiri Nodes in NodeSets
+            # @param [Array[Nokogiri::XML::Node]] elements
+            # @param [Nokogiri::HTML::Document] document
+            # @return [Nokogiri::XML::NodeSet]
+            def wrap_in_node_set(elements, document)
+              Nokogiri::XML::NodeSet.new(document).tap do |node_set|
+                elements.each { |element| node_set.push(element) }
+              end
+            end
+
+            # Get the right exporter class for the given element
+            # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+            def exporter
+              @exporter ||=
+                self.class.base_class? ? self.class.build(@element) : self
+            end
+
+            # Return the base class for the current element instance
+            # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+            def base_class
+              self.class.namespace::Base
+            end
+
+            module ClassMethods
+              # Instantiate the correct sub class for a given element
+              # @param [ArticleJSON::Elements::Base] element
+              # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+              def build(element)
+                klass = exporter_by_type(element.type)
+                klass.new(element) unless klass.nil?
+              end
+
+              # Look up the correct exporter class based on the element type
+              # @param [Symbol] type
+              # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+              def exporter_by_type(type)
+                key = type.to_sym
+                custom_class = ArticleJSON.configuration.element_exporter_for(
+                  export_format, key
+                )
+                custom_class || default_exporter_mapping[key]
+              end
+
+              # Check if the current class is the base class a child class.
+              # Since this common module is in a different namespace, a simple
+              # `self == Base` check does not work.
+              # @return [Boolean]
+              def base_class?
+                self == namespace::Base
+              end
+
+              def default_exporter_mapping
+                {
+                  text: namespace::Text,
+                  paragraph: namespace::Paragraph,
+                  heading: namespace::Heading,
+                  list: namespace::List,
+                  quote: namespace::Quote,
+                  image: namespace::Image,
+                  embed: namespace::Embed,
+                  text_box: namespace::TextBox,
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/embed.rb

@@ -0,0 +1,34 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Embed
+            include ArticleJSON::Export::Common::HTML::Elements::Shared::Caption
+
+            # Generate the embedded element node
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              create_element(:figure) do |figure|
+                figure.add_child(embed_node)
+                figure.add_child(caption_node(:figcaption))
+              end
+            end
+
+            private
+
+            def embed_node
+              create_element(:div, class: 'embed') do |div|
+                div.add_child(embedded_object)
+              end
+            end
+
+            def embedded_object
+              Nokogiri::HTML.fragment(@element.oembed_data[:html])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/heading.rb

@@ -0,0 +1,23 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Heading
+            # Generate the heading element with the right text
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              create_element(tag_name, @element.content)
+            end
+
+            private
+
+            def tag_name
+              "h#{@element.level}".to_sym
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/image.rb

@@ -0,0 +1,36 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Image
+            include ArticleJSON::Export::Common::HTML::Elements::Shared::Caption
+            include ArticleJSON::Export::Common::HTML::Elements::Shared::Float
+
+            # Generate the `<figure>` node containing the image and caption
+            # @return [Nokogiri::XML::Element]
+            def export
+              create_element(:figure, node_opts) do |figure|
+                figure.add_child(image_node)
+                figure.add_child(caption_node(:figcaption))
+              end
+            end
+
+            private
+
+            # @return [Nokogiri::XML::NodeSet]
+            def image_node
+              create_element(:img, src: @element.source_url)
+            end
+
+            # @return [Hash]
+            def node_opts
+              return if floating_class.nil?
+              { class: floating_class }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/list.rb

@@ -0,0 +1,36 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module List
+            # Generate the list node with its elements
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              create_element(tag_name) do |list|
+                @element.content.each do |child_element|
+                  list_item_wrapper = create_element(:li) do |item|
+                    item.add_child(paragraph_exporter.new(child_element).export)
+                  end
+                  list.add_child(list_item_wrapper)
+                end
+              end
+            end
+
+            private
+
+            def tag_name
+              @element.list_type == :ordered ? :ol : :ul
+            end
+
+            # Get the exporter class for paragraph elements
+            # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+            def paragraph_exporter
+              self.class.exporter_by_type(:paragraph)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/paragraph.rb

@@ -0,0 +1,29 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Paragraph
+            # Generate the paragraph node with its containing text elements
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              create_element(:p) do |p|
+                @element.content.each do |child_element|
+                  p.add_child(text_exporter.new(child_element).export)
+                end
+              end
+            end
+
+            private
+
+            # Get the exporter class for text elements
+            # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+            def text_exporter
+              self.class.exporter_by_type(:text)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/quote.rb

@@ -0,0 +1,32 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Quote
+            include ArticleJSON::Export::Common::HTML::Elements::Shared::Caption
+            include ArticleJSON::Export::Common::HTML::Elements::Shared::Float
+
+            # Generate the quote node with all its containing text elements
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              create_element(:div, node_opts) do |div|
+                @element.content.each do |child_element|
+                  div.add_child(base_class.new(child_element).export)
+                end
+                div.add_child(caption_node(:small))
+              end
+            end
+
+            private
+
+            # @return [Hash]
+            def node_opts
+              { class: ['quote', floating_class].compact.join(' ') }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/shared/caption.rb

@@ -0,0 +1,32 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Shared
+            module Caption
+              # Generate the caption node
+              # @param [String] tag_name
+              # @return [Nokogiri::XML::NodeSet]
+              def caption_node(tag_name)
+                create_element(tag_name) do |caption|
+                  @element.caption.each do |child_element|
+                    caption.add_child(text_exporter.new(child_element).export)
+                  end
+                end
+              end
+
+              private
+
+              # Get the exporter class for text elements
+              # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+              def text_exporter
+                self.class.exporter_by_type(:text)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/shared/float.rb

@@ -0,0 +1,19 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Shared
+            module Float
+              # The element's floating class, if necessary
+              # @return [String]
+              def floating_class
+                "float-#{@element.float}" unless @element.float.nil?
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/text.rb

@@ -0,0 +1,57 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module Text
+            # Generate a Nokogiri node or simple text node, depending on the text
+            # options
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              return bold_and_italic_node if @element.bold && @element.italic
+              return bold_node if @element.bold
+              return italic_node if @element.italic
+              content_node
+            end
+
+            private
+
+            # @return [Nokogiri::XML::NodeSet]
+            def italic_node
+              create_element(:em) { |em| em.add_child(content_node) }
+            end
+
+            # @return [Nokogiri::XML::NodeSet]
+            def bold_node
+              create_element(:strong) do |strong|
+                strong.add_child(content_node)
+              end
+            end
+
+            # @return [Nokogiri::XML::NodeSet]
+            def bold_and_italic_node
+              create_element(:strong) do |strong|
+                strong.add_child(italic_node)
+              end
+            end
+
+            # @return [Nokogiri::XML::NodeSet]
+            def content_node
+              return create_text_nodes(@element.content) if @element.href.nil?
+              create_element(:a, href: @element.href) do |a|
+                a.add_child(create_text_nodes(@element.content))
+              end
+            end
+
+            # @param [Nokogiri::XML::NodeSet] text
+            def create_text_nodes(text)
+              Nokogiri::HTML
+                .fragment(text.gsub(/\n/, '<br>'))
+                .children
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/elements/text_box.rb

@@ -0,0 +1,29 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Elements
+          module TextBox
+            include ArticleJSON::Export::Common::HTML::Elements::Shared::Float
+
+            # Generate a `<div>` node containing all text box elements
+            # @return [Nokogiri::XML::NodeSet]
+            def export
+              create_element(:div, node_opts) do |div|
+                @element.content.each do |child_element|
+                  div.add_child(base_class.new(child_element).export)
+                end
+              end
+            end
+
+            private
+
+            def node_opts
+              { class: ['text-box', floating_class].compact.join(' ') }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/common/html/exporter.rb

@@ -0,0 +1,31 @@
+module ArticleJSON
+  module Export
+    module Common
+      module HTML
+        module Exporter
+          # @param [Array[ArticleJSON::Elements::Base]] elements
+          def initialize(elements)
+            @elements = elements
+          end
+
+          # Generate a string with the HTML representation of all elements
+          # @return [String]
+          def html
+            doc = Nokogiri::HTML.fragment('')
+            element_exporters.each do |element_exporter|
+              doc.add_child(element_exporter.export)
+            end
+            doc.to_html(save_with: 0)
+          end
+
+          private
+
+          def element_exporters
+            @element_exporters ||=
+              @elements.map { |e| self.class.namespace::Elements::Base.build(e) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/html/elements/base.rb

@@ -3,53 +3,24 @@ module ArticleJSON
     module HTML
       module Elements
         class Base
-          # @param [ArticleJSON::Elements::Base] element
-          def initialize(element)
-            @element = element
-          end
-
-          # Export a HTML node out of the given element
-          # Dynamically looks up the right export-element-class, instantiates it
-          # and then calls the #build method.
-          # @return [Nokogiri::HTML::Node]
-          def export
-            exporter = self.class == Base ? self.class.build(@element) : self
-            exporter.export unless exporter.nil?
-          end
-
-          private
-
-          def create_element(tag, *args)
-            Nokogiri::HTML.fragment('').document.create_element(tag.to_s, *args)
-          end
-
-          def create_text_node(text)
-            Nokogiri::HTML.fragment(text).children.first
-          end
+          include ArticleJSON::Export::Common::HTML::Elements::Base
 
           class << self
-            # Instantiate the correct sub class for a given element
-            # @param [ArticleJSON::Elements::Base] element
-            # @return [ArticleJSON::Export::HTML::Elements::Base]
-            def build(element)
-              klass = exporter_by_type(element.type)
-              klass.new(element) unless klass.nil?
+            # Return the module namespace this class and its subclasses are
+            # nested in
+            # @return [Module]
+            def namespace
+              ArticleJSON::Export::HTML::Elements
             end
 
-            # Look up the correct exporter class based on the element type
-            # @param [Symbol] type
-            # @return [ArticleJSON::Export::HTML::Elements::Base]
-            def exporter_by_type(type)
-              {
-                text: Text,
-                paragraph: Paragraph,
-                heading: Heading,
-                list: List,
-                image: Image,
-                text_box: TextBox,
-                quote: Quote,
-                embed: Embed,
-              }[type.to_sym]
+            private
+
+            # The format this exporter is returning. This is used to determine
+            # which custom element exporters should be applied from the
+            # configuration.
+            # @return [Symbol]
+            def export_format
+              :html
             end
           end
         end

data/lib/article_json/export/html/elements/embed.rb

@@ -3,24 +3,7 @@ module ArticleJSON
     module HTML
       module Elements
         class Embed < Base
-          include Shared::Caption
-
-          def export
-            create_element(:figure).tap do |figure|
-              figure.add_child(embed_node)
-              figure.add_child(caption_node(:figcaption))
-            end
-          end
-
-          private
-
-          def embed_node
-            create_element(:div, embedded_object, class: 'embed')
-          end
-
-          def embedded_object
-            "Embedded Object: #{@element.embed_type}-#{@element.embed_id}"
-          end
+          include ArticleJSON::Export::Common::HTML::Elements::Embed
         end
       end
     end

data/lib/article_json/export/html/elements/heading.rb

@@ -3,15 +3,7 @@ module ArticleJSON
     module HTML
       module Elements
         class Heading < Base
-          def export
-            create_element(tag_name, @element.content)
-          end
-
-          private
-
-          def tag_name
-            "h#{@element.level}".to_sym
-          end
+          include ArticleJSON::Export::Common::HTML::Elements::Heading
         end
       end
     end