article_json 0.2.1 → 0.3.0

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

@@ -0,0 +1,30 @@
+module ArticleJSON
+  module Export
+    module FacebookInstantArticle
+      module Elements
+        class Quote < Base
+          include ArticleJSON::Export::Common::HTML::Elements::Quote
+
+          private
+
+          # @return [Hash]
+          def node_opts
+            {}
+          end
+
+          # HTML tag for the wrapping node
+          # @return [Symbol]
+          def quote_tag
+            :aside
+          end
+
+          # HTML tag for the node containing the caption
+          # @return [Symbol]
+          def caption_tag
+            :cite
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+module ArticleJSON
+  module Export
+    module FacebookInstantArticle
+      module Elements
+        class TextBox < Base
+          include ArticleJSON::Export::Common::HTML::Elements::TextBox
+
+          # Generate a `<div>` node containing all text box elements and
+          # surrounded by an ASCII-art line to the top and bottom
+          # @return [Nokogiri::XML::NodeSet]
+          def export
+            create_element(:div, class: 'text-box') do |div|
+              div.add_child(ascii_art_line_node)
+              @element.content.each do |child_element|
+                div.add_child(base_class.new(child_element).export)
+              end
+              div.add_child(ascii_art_line_node)
+            end
+          end
+
+          private
+
+          # Returns a paragraph with the `ascii_art_line_text_element`. This
+          # gets inserted above and below the text box content
+          # @return [Nokogiri::XML::NodeSet]
+          def ascii_art_line_node
+            create_element(:p) { |p| p.add_child ascii_art_line_text_element }
+          end
+
+          # Returns the delimiter of text boxes. Overwrite this method to have a
+          # custom text box delimiter
+          # @return [String]
+          def ascii_art_line_text_element
+            '────────'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module ArticleJSON
+  module Export
+    module FacebookInstantArticle
+      class Exporter
+        include ArticleJSON::Export::Common::HTML::Exporter
+
+        class << self
+          # Return the module namespace this class is nested in
+          # @return [Module]
+          def namespace
+            ArticleJSON::Export::FacebookInstantArticle
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Base
+          include ArticleJSON::Export::Common::Elements::Base
+
+          # Export the given element. Dynamically looks up the right
+          # export-element-class, instantiates it and then calls the `#export`
+          # method.
+          # Defaults to an empty string, e.g. if no exporter is specified for
+          # the given type.
+          # @return [String]
+          def export
+            super || ''
+          end
+
+          class << self
+            # Return the module namespace this class and its subclasses are
+            # nested in
+            # @return [Module]
+            def namespace
+              ArticleJSON::Export::PlainText::Elements
+            end
+
+            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
+              :plain_text
+            end
+
+            def default_exporter_mapping
+              {
+                text: namespace::Text,
+                paragraph: namespace::Paragraph,
+                heading: namespace::Heading,
+                list: namespace::List,
+                quote: namespace::Quote,
+                image: nil,
+                embed: nil,
+                text_box: nil,
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Embed < Base
+          # Embedded elements are being skipped when rendering plain text.
+          # Therefore, return an empty string.
+          # @return [String]
+          def export
+            ''
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Heading < Base
+          # Headline separated by newlines
+          # @return [String]
+          def export
+            "#{leading_newlines}#{@element.content}\n\n"
+          end
+
+          private
+
+          # String with dynamic number of newlines, depending on heading level.
+          # @return [String]
+          def leading_newlines
+            case @element.level
+            when 1 then "\n\n\n"
+            when 2 then "\n\n"
+            else "\n"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/plain_text/elements/image.rb

@@ -0,0 +1,16 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Image < Base
+          # Images are being skipped when rendering plain text. Therefore,
+          # return an empty string.
+          # @return [String]
+          def export
+            ''
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/plain_text/elements/list.rb

@@ -0,0 +1,50 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class List < Base
+          # List of strings, one per line. If the list type is "ordered" then
+          # each line is preceded with a number, otherwise a dash. Newlines
+          # within a list item are indented accordingly.
+          # @return [String]
+          def export
+            "#{list}\n"
+          end
+
+          private
+
+          # Plain-text list of items using the right prefix
+          # @return [String]
+          def list
+            @element
+              .content
+              &.each_with_index
+              &.map do |content, index|
+                "#{prefix(index)} #{paragraph_exporter.new(content).export}"
+                  .gsub(/\n(?!$)/, newline_with_indention)
+              end&.join || ''
+          end
+
+          # Prefix used for every list item
+          # @param [String] index
+          def prefix(index)
+            @element.list_type == :ordered ? "#{index + 1}." : '-'
+          end
+
+          # Newline followed by the right amount of spaces to align with the
+          # indentation from the prefix
+          # @return [String]
+          def newline_with_indention
+            "\n " + ' ' * prefix(0).length
+          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

data/lib/article_json/export/plain_text/elements/paragraph.rb

@@ -0,0 +1,33 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Paragraph < Base
+          # Plain text from the paragraph. Any formatting is disregarded.
+          # Followed by a newline.
+          # @return [String]
+          def export
+            "#{text}\n"
+          end
+
+          private
+
+          # Plain text of the paragraph
+          # @return [String]
+          def text
+            @element
+              .content
+              &.map { |text_element| text_exporter.new(text_element).export }
+              &.join
+          end
+
+          # Get the exporter class for text elements
+          # @return [ArticleJSON::Export::PlainText::Elements::Base]
+          def text_exporter
+            self.class.exporter_by_type(:text)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Quote < Base
+          # Quotes are just rendered with a preceding blank line. If a caption
+          # is present, it is rendered below the quote indented with two dashes.
+          # @return [String]
+          def export
+            "\n#{quote_text}\n"
+          end
+
+          private
+
+          # Plain text representation of the entire quote
+          # @return [String]
+          def quote_text
+            extract_text(@element.content).tap do |text|
+              if @element.caption&.any?
+                text << " --#{extract_text(@element.caption)}\n"
+              end
+            end
+          end
+
+          # Extract plain text from given element
+          # @param [ArticleJSON::Elements::Base] elements
+          # @return [String]
+          def extract_text(elements)
+            elements.map { |text| base_class.new(text).export }.join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class Text < Base
+          # Text is just returned plain, no formatting or linking is taken into
+          # account.
+          # @return [String]
+          def export
+            @element.content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      module Elements
+        class TextBox < Base
+          # Text boxes are being skipped when rendering plain text. Therefore,
+          # return an empty string.
+          # @return [String]
+          def export
+            ''
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module ArticleJSON
+  module Export
+    module PlainText
+      class Exporter
+        # @param [Array[ArticleJSON::Elements::Base]] elements
+        def initialize(elements)
+          @elements = elements
+        end
+
+        # Generate a string with the plain text representation of all elements
+        # @return [String]
+        def text
+          @text ||=
+            @elements.map do |element|
+              ArticleJSON::Export::PlainText::Elements::Base
+                .build(element)
+                &.export
+            end.join.strip
+        end
+      end
+    end
+  end
+end

data/lib/article_json/import/google_doc/html/shared/caption.rb

@@ -7,7 +7,7 @@ module ArticleJSON
             # Parse the caption node
             # @return [Array[ArticleJSON::Elements::Text]]
             def caption
-              return empty_caption if @caption_node.nil?
+              return [] if no_caption?
               ArticleJSON::Import::GoogleDoc::HTML::TextParser.extract(
                 node: @caption_node,
                 css_analyzer: @css_analyzer
@@ -16,8 +16,9 @@ module ArticleJSON
 
             private
 
-            def empty_caption
-              [ArticleJSON::Elements::Text.new(content: ' ')]
+            def no_caption?
+              @caption_node.nil? ||
+                @caption_node.inner_text.strip == '[no-caption]'
             end
           end
         end

data/lib/article_json/utils/additional_element_placer.rb

@@ -2,64 +2,91 @@ module ArticleJSON
   module Utils
     # This class allows the user to place additional elements within an article.
     # It distributes elements over the whole article and ensures that an
-    # additional element is only ever placed between two paragraph elements. If
-    # there are not enough spaces, the remaining additional elements will be
-    # appended to the existing article elements.
+    # additional element is only ever placed between two paragraph elements or
+    # after a paragraph and before the next headline. If there are not enough
+    # spaces, the remaining additional elements will be appended to the existing
+    # article elements.
     class AdditionalElementPlacer
-      # @param [ArticleJSON::Article] article
+      # @param [Array[ArticleJSON::Article::Elements::Base]] elements
       # @param [Array[Object]] additional_elements
-      def initialize(article, additional_elements)
-        @elements = article.elements.dup
+      def initialize(elements, additional_elements)
+        @elements = elements.dup
         @additional_elements = additional_elements
       end
 
       # Distribute additional elements evenly throughout the article elements
+      #
+      # Outline of the algorithm:
+      # 1. It calculates every how many characters (only considering paragraphs)
+      #    an additional element should be inserted, given the number of
+      #    additional elements provided
+      # 2. It then iterates over the existing elements within the article,
+      #    inserting them into the resulting, merged article
+      # 3. As soon as it has passed the right amount characters, it checks if
+      #    the current position is eligible for inserting an additional element
+      #    (the previous element needs to be a paragraph and the following needs
+      #    to be either a paragraph or a headline)
+      #     a) If so, it inserts the additional element and recalculates in how
+      #        many characters the next element should be inserted, based on the
+      #        remaining number of characters and remaining additional elements
+      #     b) If not, it keeps iterating over the article until it finds an
+      #        eligible position and only then inserts the additional element
+      #        and recalculates the number of characters until the next
+      #        insertion
+      # 4. If there are still additional elements remaining which couldn't be
+      #    inserted (due to not finding enough eligible positions), they are
+      #    appended to the end of the article
+      #
       # @return [Array[ArticleJSON::Elements::Base|Object]]
       def merge_elements
-        indexes = indexes_for_additional_elements
-
-        if indexes.count < @additional_elements.count
-          @elements.push(*@additional_elements[indexes.count..-1])
-        end
-
-        indexes
-          .reverse
-          .zip(@additional_elements[0...indexes.count].reverse)
-          .each { |index, element| @elements.insert(index, element) }
-
+        remaining_elements = @additional_elements.dup
+        next_in = insert_next_element_in(0, remaining_elements)
+        characters_passed = 0
         @elements
+          .each_cons(2)
+          .each_with_object([]) do |(element, next_element), result|
+            result << element
+            characters_passed += element.length if element.respond_to?(:length)
+            next_in -= element.length if element.respond_to?(:length)
+            if insert_here?(next_in, element, next_element)
+              result << remaining_elements.shift
+              next_in = insert_next_element_in(characters_passed,
+                                               remaining_elements)
+            end
+          end
+          .push(@elements.last,      # add last element
+                *remaining_elements) # followed by remaining ads
       end
 
       private
 
-      # Find indexes within article elements where there is a paragraph on the
-      # current and on the next node
-      # @return [Array[Integer]]
-      def indexes_between_paragraphs
-        @elements
-          .each_cons(2) # iterate over elements in consecutive sets of 2
-          .with_index
-          .each_with_object([]) do |((current, following), index), possibilities|
-          if current.type == :paragraph && following.type == :paragraph
-            possibilities << index + 1
-          end
-        end
+      # Calculate in how many characters the next additional element should be
+      # inserted
+      # @param [Integer] characters_passed
+      # @param [Array] left_elements
+      # @return [Integer]
+      def insert_next_element_in(characters_passed, left_elements)
+        (total_length - characters_passed) / (left_elements.size + 1)
       end
 
-      # Return evenly spread indexes of positions to insert a given number of
-      # additional elements
-      # @return [Array[Integer]]
-      def indexes_for_additional_elements
-        indexes = indexes_between_paragraphs
-        insert_every = indexes.count / @additional_elements.count
-
-        # in case there are more elements to add than available positions:
-        insert_every = 1 if insert_every == 0
+      # Return the total length of the given elements
+      # @return [Integer]
+      def total_length
+        @total_length ||= @elements.reduce(0) do |sum, element|
+          sum + (element.respond_to?(:length) ? element.length : 0)
+        end
+      end
 
-        indexes
-          .reject
-          .with_index { |_, index| (index + 1) % insert_every != 0 }
-          .take(@additional_elements.count)
+      # Check if the given position is eligible for inserting an additional
+      # element
+      # @param [Integer] next_in
+      # @param [ArticleJSON::Elements::Base] element
+      # @param [ArticleJSON::Elements::Base] next_element
+      # @return [Boolean]
+      def insert_here?(next_in, element, next_element)
+        next_in <= 0 &&
+          element.type == :paragraph &&
+          %i(paragraph heading).include?(next_element.type)
       end
     end
   end

data/lib/article_json/version.rb

@@ -1,3 +1,3 @@
 module ArticleJSON
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/article_json.rb

@@ -39,6 +39,19 @@ require_relative 'article_json/import/google_doc/html/embedded_slideshare_parser
 require_relative 'article_json/import/google_doc/html/embedded_tweet_parser'
 require_relative 'article_json/import/google_doc/html/parser'
 
+require_relative 'article_json/export/common/elements/base'
+
+require_relative 'article_json/export/plain_text/elements/base'
+require_relative 'article_json/export/plain_text/elements/text'
+require_relative 'article_json/export/plain_text/elements/heading'
+require_relative 'article_json/export/plain_text/elements/paragraph'
+require_relative 'article_json/export/plain_text/elements/list'
+require_relative 'article_json/export/plain_text/elements/image'
+require_relative 'article_json/export/plain_text/elements/text_box'
+require_relative 'article_json/export/plain_text/elements/quote'
+require_relative 'article_json/export/plain_text/elements/embed'
+require_relative 'article_json/export/plain_text/exporter'
+
 require_relative 'article_json/export/common/html/elements/shared/caption'
 require_relative 'article_json/export/common/html/elements/shared/float'
 require_relative 'article_json/export/common/html/elements/base'
@@ -75,4 +88,15 @@ require_relative 'article_json/export/amp/elements/embed'
 require_relative 'article_json/export/amp/custom_element_library_resolver'
 require_relative 'article_json/export/amp/exporter'
 
+require_relative 'article_json/export/facebook_instant_article/elements/base'
+require_relative 'article_json/export/facebook_instant_article/elements/text'
+require_relative 'article_json/export/facebook_instant_article/elements/paragraph'
+require_relative 'article_json/export/facebook_instant_article/elements/list'
+require_relative 'article_json/export/facebook_instant_article/elements/heading'
+require_relative 'article_json/export/facebook_instant_article/elements/quote'
+require_relative 'article_json/export/facebook_instant_article/elements/text_box'
+require_relative 'article_json/export/facebook_instant_article/elements/image'
+require_relative 'article_json/export/facebook_instant_article/elements/embed'
+require_relative 'article_json/export/facebook_instant_article/exporter'
+
 require_relative 'article_json/article'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: article_json
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Sager
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -138,6 +138,7 @@ files:
 - lib/article_json/export/amp/elements/text.rb
 - lib/article_json/export/amp/elements/text_box.rb
 - lib/article_json/export/amp/exporter.rb
+- lib/article_json/export/common/elements/base.rb
 - lib/article_json/export/common/html/elements/base.rb
 - lib/article_json/export/common/html/elements/embed.rb
 - lib/article_json/export/common/html/elements/heading.rb
@@ -150,6 +151,16 @@ files:
 - lib/article_json/export/common/html/elements/text.rb
 - lib/article_json/export/common/html/elements/text_box.rb
 - lib/article_json/export/common/html/exporter.rb
+- lib/article_json/export/facebook_instant_article/elements/base.rb
+- lib/article_json/export/facebook_instant_article/elements/embed.rb
+- lib/article_json/export/facebook_instant_article/elements/heading.rb
+- lib/article_json/export/facebook_instant_article/elements/image.rb
+- lib/article_json/export/facebook_instant_article/elements/list.rb
+- lib/article_json/export/facebook_instant_article/elements/paragraph.rb
+- lib/article_json/export/facebook_instant_article/elements/quote.rb
+- lib/article_json/export/facebook_instant_article/elements/text.rb
+- lib/article_json/export/facebook_instant_article/elements/text_box.rb
+- lib/article_json/export/facebook_instant_article/exporter.rb
 - lib/article_json/export/html/elements/base.rb
 - lib/article_json/export/html/elements/embed.rb
 - lib/article_json/export/html/elements/heading.rb
@@ -160,6 +171,16 @@ files:
 - lib/article_json/export/html/elements/text.rb
 - lib/article_json/export/html/elements/text_box.rb
 - lib/article_json/export/html/exporter.rb
+- lib/article_json/export/plain_text/elements/base.rb
+- lib/article_json/export/plain_text/elements/embed.rb
+- lib/article_json/export/plain_text/elements/heading.rb
+- lib/article_json/export/plain_text/elements/image.rb
+- lib/article_json/export/plain_text/elements/list.rb
+- lib/article_json/export/plain_text/elements/paragraph.rb
+- lib/article_json/export/plain_text/elements/quote.rb
+- lib/article_json/export/plain_text/elements/text.rb
+- lib/article_json/export/plain_text/elements/text_box.rb
+- lib/article_json/export/plain_text/exporter.rb
 - lib/article_json/import/google_doc/html/css_analyzer.rb
 - lib/article_json/import/google_doc/html/embedded_facebook_video_parser.rb
 - lib/article_json/import/google_doc/html/embedded_parser.rb