article_json 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 561ba1f1fff25cba3e32eea10bdff57757ab6776a688bc78f85ec4eafeb62b32
-  data.tar.gz: e72e2425f7008d24be098be9024a27f493c2f13c99577ec71d7dda953564bcef
+  metadata.gz: 7bf4d22d73f1d9380b282867e7f55ac90aae0cacbf235f26c3aaee678e4adfc5
+  data.tar.gz: 250276366fce15b87e51cd62f05d53b90eaff29949c6681b9962b0ccdb127a16
 SHA512:
-  metadata.gz: 14e75d7a01ad409337b79b98075063807de0d18dd911980c7ef816668ddf4adc6f02211fb36ed54a530962bf0839628b217cfd6c849ff6153575c9e9274500b2
-  data.tar.gz: a2a1eac1de2d0d8b0379c1d1bbc85a7af99e33c44ebdc544d88de7983597be878e59c9bc90a2a1a4958b4dcb1ea26d4bc5817fb6944e04e02224d1af8fd52353
+  metadata.gz: 5915080736fd29499a73f73cdb39d5e3f1af1c54da3a6a114be2a546de35f1d7824da407d76eac255e2b38eee00040dc3534a78a702e78eebbc025bab666b82b
+  data.tar.gz: fa283f7167ca908145d6c2b2420865e9b08ca91fbe9a417bf20713eda2e02fe10e3664bbbc22e8718c3c5676dbc8ed61861dc15b367089a491ce3cd7991535f8

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Changelog
+
+## 0.5.0 - WIP
+
+**Removes**:
+Support for Facebook Instant Articles, as they are no longer supported by Facebook.
+
 ## 0.4.0 - 2024/01/17
+
 In this fourth release we **added support for Apple News**:
 **New**:
 Support for Apple News Format, specifically the following elements:
+
 - text
 - text boxes
 - lists
@@ -17,13 +25,15 @@ Support for Ruby 3.2
 Support for Ruby 2.3
 
 **Refactoring**:
+
 - Rubocop autocorrections
 
 **Fix:**
-- Fix failing rspec tests
 
+- Fix failing rspec tests
 
 ## 0.3.8 - 2020/7/31
+
 - **Improvements:**
 - Add a script to update oembed stubs fixtures.
 - Support for `alt` attribute in images.
@@ -31,65 +41,84 @@ Support for Ruby 2.3
 - **Fix:** Fix a bug when using the `[image-link-to: ]` tag.
 
 ## 0.3.7 - 2019/8/21
+
 - **Fix:** Only use https for soundcloud oembed api
 
 ## 0.3.6 - 2019/8/6
+
 - **Improvement** Add tags support in text_box element.
 
 ## 0.3.5 - 2018/12/12
+
 - **Improvements** to import and export image links from Google Docs
 - Import image `href` from caption text using a custom tag
 - Export the image element href attribute as a link
 
 ## 0.3.4 - 2018/5/10
+
 - **Fix:** Only include slug from the soundcloud URL in google doc parser
 
 ## 0.3.3 - 2018/4/12
+
 - Support embedding SoundCloud
 
 ## 0.3.2 - 2017/12/06
+
 - Another **fix** to prevent `nil` elements when placing additional elements on articles that end with empty paragraphs
 
 ## 0.3.1 - 2017/11/29
+
 - **Fix:** prevent `nil` elements when placing additional element on empty articles
 
 ## 0.3.0 - 2017/11/21
+
 In this third bigger release we **added support**:
+
 - For exporting articles in the Facebook Instant Article format
 - For exporting articles in a plain text format
 - To all exporters for `caption` elements that are an empty array
 - For `[no-caption]` text in _Google Documents_ below elements (like images or embed URLs), this now returns empty caption for element
 
 **Improvements** were done regarding additional element placement:
+
 - Rework algorithm to place additional elements to better support placing a single element
 - Improve behavior of multiple calls to `Article#place_additional_elements`
 
 One potentially **breaking change** was added:
+
 - Remove deprecated `#register_html_element_exporter`, use `#register_element_exporters` instead
 
 **Fixes**:
+
 - Fix AMP export of Twitter tweets
 
 ## 0.2.1 - 2017/11/08
+
 **Fix**: Handle non-successful OEmbed responses by rendering message
 
 ## 0.2.0 - 2017/11/03
+
 In this second release we **added support** to:
+
 - Export AMP along with required libraries for AMP rendering
 - Configure custom HTML and AMP element exporters
 - Resolve oembed elements in HTML export
 
 One potentially **breaking change** was added:
+
 - Export quotes as `<div>` instead of `<aside>`
 
 **Fixes**:
+
 - Support Vimeo videos with old flash player URLs
 - Make Google Parser more fault tolerant
 - Respect linebreaks when importing Google Docs
 - Export linebreaks in JSON to `<br>` tags in HTML / AMP
 
 ## 0.1.0 - 2017/09/20
+
 This is the very first release, with the following functionality:
+
 - article-json format that supports several basic elements; like headings,
   paragraphs, images or lists
 - Resolving of embedded elements like videos or tweets via OEmbed standard

data/README.md

@@ -1,13 +1,14 @@
 # article_json
+
 The `article_json` gem is a Ruby library designed to simplify the conversion and manipulation of structured articles in various formats, allowing easy importing, manipulation and export of content across different platforms and environments.
 
 It takes an article from a Google Doc and creates a JSON version of it.
 
 From there it can export the article:
+
 - as HTML
 - as AMP
 - as Apple News Format (ANF)
-- as Facebook Instant Article HTML
 - as plain text
 - as JSON
 
@@ -16,6 +17,7 @@ It also provides functionalities to parse content from Google Document HTML expo
 ---
 
 ## Status
+
 [![Gem Version](https://badge.fury.io/rb/article_json.svg)](https://badge.fury.io/rb/article_json)
 [![Check Google Doc](https://github.com/Devex/article_json/workflows/Check%20Google%20Doc/badge.svg)](https://github.com/Devex/article_json/actions/workflows/check-google-doc.yml)
 [![RSpec](https://github.com/Devex/article_json/workflows/rspec/badge.svg)](https://github.com/Devex/article_json/actions/workflows/rspec.yml)
@@ -23,10 +25,12 @@ It also provides functionalities to parse content from Google Document HTML expo
 [![Coverage Status](https://coveralls.io/repos/github/Devex/article_json/badge.svg?branch=master)](https://coveralls.io/github/Devex/article_json?branch=master)
 
 ## Usage
+
 First, install the gem with `gem install article_json` or add it to your Gemfile
 via `gem 'article_json'`.
 
 ### Ruby
+
 ```ruby
 require 'article_json'
 
@@ -50,9 +54,6 @@ puts article.amp_exporter.amp_libraries
 # export article as Apple News Format (ANF)
 puts article.to_apple_news
 
-# export article as Facebook Instant Article HTML
-puts article.to_facebook_instant_article
-
 # export article as plain text
 puts article.to_plain_text
 
@@ -61,7 +62,8 @@ puts article.to_json
 ```
 
 ### CLI
-To load, parse and export the latest (amp/ apple news/ facebook/ html) version of the reference document, run the following:
+
+To load, parse and export the latest (amp / apple news / html) version of the reference document, run the following:
 
 ```bash
 $ export DOC_ID=1E4lncZE2jDkbE34eDyYQmXKA9O26BHUiwguz4S9qyE8
@@ -71,11 +73,11 @@ $ ./bin/article_json_export_google_doc.rb $DOC_ID \
     ## OR
     # | ./bin/article_json_export_amp.rb
     # | ./bin/article_json_export_apple_news.rb
-    # | ./bin/article_json_export_facebook.rb
     # | ./bin/article_json_export_plain_text.rb
 ```
 
 Alternatively, you can concatenate your command line commands, like so:
+
 ```bash
 $ ./bin/article_json_export_google_doc.rb $DOC_ID > test_ref_doc.html
 $ cat test_ref_doc.html | bin/article_json_parse_google_doc.rb > \
@@ -84,10 +86,10 @@ $ cat test_ref_doc_parsed_apple.json | bin/article_json_export_apple_news.rb > \
     test_ref_doc_exported_apple.json
 ```
 
-You can also update _all_ the different exported versions of the reference document _(amp, apple_news, facebook, google_doc, html and plain_text)_ by running the following command:
+You can also update _all_ the different exported versions of the reference document _(amp, apple_news, google_doc, html and plain_text)_ by running the following command:
 
 ```
-$ ./bin/update_reference_document.sh
+./bin/update_reference_document.sh
 ```
 
 When running the tests, we use some fixtures to mock the responses for oembed requests, but these may change over time.
@@ -95,10 +97,11 @@ When running the tests, we use some fixtures to mock the responses for oembed re
 To update them, run:
 
 ```
-$ ./bin/update_oembed_request-stubs.sh
+./bin/update_oembed_request-stubs.sh
 ```
 
 ### Configuration
+
 Some configuration options allow a more tailored usage of the `article_json` gem.
 
 The following code snippet gives an example for every available setting:
@@ -128,17 +131,17 @@ ArticleJSON.configure do |config|
     image: ArticleJSON::Export::HTML::Elements::ScaledImage
   )
 
-  # It works the same way for custom AMP, FacebookInstantArticle, or PlainText
-  # exporters:
+  # It works the same way for custom AMP, Apple News, or PlainText exporters:
   config.register_element_exporters(
-    :amp, # Or change this for `:facebook_instant_article` or `:plain_text`
+    :amp, # Or change this for `:apple_news` or `:plain_text`
     image: ArticleJSON::Export::AMP::Elements::ScaledImage
   )
 end
 ```
 
 ### Facebook Oembed
-Facebook deprecated its public endpoints for embeddable Facebook content in 2020 (See https://developers.facebook.com/docs/plugins/oembed-legacy for more info).
+
+Facebook deprecated its public endpoints for embeddable Facebook content in 2020 (See <https://developers.facebook.com/docs/plugins/oembed-legacy> for more info).
 
 You now need to use a Facebook token to access the new oembed endpoints. You can configure the gem to use this token so:
 
@@ -153,13 +156,17 @@ end
 Find more info about the access token [here](https://developers.facebook.com/docs/plugins/oembed#access-tokens).
 
 ## Format
+
 A [full example of the format](https://github.com/Devex/article_json/blob/master/spec/fixtures/reference_document_parsed.json) can be found in the test fixtures.
 
 ## Import
+
 ### Google Document Parser
+
 This [reference document](https://docs.google.com/document/d/1E4lncZE2jDkbE34eDyYQmXKA9O26BHUiwguz4S9qyE8/editusp=sharing) contains all the supported formatting along with some descriptions.
 
 ## Add custom elements
+
 Sometimes you might want to place additional elements into the article, like e.g. advertisements. `article_json` supports this via `article.place_additional_elements`, which accepts an array of elements that you can define in your code.
 
 Each element that is added this way will directly get placed in between paragraphs of the article. The method ensures that an additional element is never added before or after any node other than paragraphs (e.g. an image). The elements are added in the order you pass them into the method.
@@ -174,6 +181,7 @@ If the objects you pass in are instances of elements defined within this gem (e.
 If you pass in an instance of a custom class (e.g. `MyAdvertisement`), make sure to register an exporter for this type (check the _Configuration_ section for more details).
 
 Example using only existing elements:
+
 ```ruby
 # Create your article instance as you normally do
 article = ArticleJSON::Article.from_hash(parsed_json)
@@ -209,6 +217,7 @@ article.to_html # this will now include the custom elements
 ```
 
 Example with custom advertisement elements:
+
 ```ruby
 # Define your custom element class
 class MyAdvertisement
@@ -253,10 +262,13 @@ article.to_html
 ```
 
 ## Export
+
 ### HTML
+
 The HTML exporter generates an HTML string for a list of elements. An example of the HTML export for the parsed reference document can be found [here](https://github.com/Devex/article_json/blob/master/spec/fixtures/reference_document_exported.html).
 
 ### AMP
+
 The AMP exporter generates an AMP HTML representation of the elements.
 
 AMP uses [custom HTML tags](https://www.ampproject.org/docs/reference/components), some of which require additional Javascript libraries.
@@ -265,17 +277,14 @@ If you have an `article` (see code example in _Usage_ section), you can get a li
 
 An example of the AMP HTML export for the parsed reference document can be found [here](https://github.com/Devex/article_json/blob/master/spec/fixtures/reference_document_exported.amp.html).
 
-### Facebook Instant Articles
-The `FacebookInstantArticle` exporter generates a custom HTML string for a list of elements. An example of the Facebook Instant Article export for the parsed reference document can be found [here](https://github.com/Devex/article_json/blob/master/spec/fixtures/reference_document_exported.html).
-
-To learn more about the Facebook Instant Article HTML format see have a look at the [Facebook Developer Documentation](https://developers.facebook.com/docs/instant-articles/guides/format-overview).
-
 ### Plain Text
+
 As the name suggests, this exporter generates a plain text version of the article. Rich text elements like images, embeds or even text boxes are not being rendered.
 
 The reference document rendered as plain text can be found [here](https://github.com/Devex/article_json/blob/master/spec/fixtures/reference_document_exported.txt).
 
 Usage:
+
 ```ruby
 # Create your article instance as you normally do
 article = ArticleJSON::Article.from_hash(parsed_json)
@@ -285,6 +294,7 @@ article.to_plain_text
 ```
 
 ## Contributing
+
 - Fork this repository
 - Implement your feature or fix including tests
 - Update the [change log](CHANGELOG.md)
@@ -297,9 +307,11 @@ See the
 [list of contributors](https://github.com/Devex/article_json/contributors).
 
 ## Tests
+
 For the whole test suite, run `bundle exec rspec`.
 
 For individual tests, run `bundle exec rspec spec/article_json/version_spec.rb`.
 
 ## License
+
 MIT License, see the [license file](LICENSE).

data/bin/update_reference_document.sh

@@ -8,7 +8,6 @@ SOURCE_HTML_FILE="spec/fixtures/reference_document.html"
 JSON_FILE="spec/fixtures/reference_document_parsed.json"
 HTML_EXPORT_FILE="spec/fixtures/reference_document_exported.html"
 AMP_EXPORT_FILE="spec/fixtures/reference_document_exported.amp.html"
-FACEBOOK_EXPORT_FILE="spec/fixtures/reference_document_exported.facebook.html"
 APPLE_NEWS_EXPORT_FILE="spec/fixtures/reference_document_exported.apple_news.json"
 PLAIN_TEXT_EXPORT_FILE="spec/fixtures/reference_document_exported.txt"
 
@@ -24,9 +23,6 @@ PLAIN_TEXT_EXPORT_FILE="spec/fixtures/reference_document_exported.txt"
 # convert the JSON export to AMP
 ./bin/article_json_export_amp.rb < ${JSON_FILE} > ${AMP_EXPORT_FILE}
 
-# convert the JSON export to Facebook Instant Article
-./bin/article_json_export_facebook.rb < ${JSON_FILE} > ${FACEBOOK_EXPORT_FILE}
-
 # convert the JSON export to Apple News
 ./bin/article_json_export_apple_news.rb < ${JSON_FILE} > ${APPLE_NEWS_EXPORT_FILE}
 

data/lib/article_json/article.rb

@@ -74,18 +74,6 @@ module ArticleJSON
       apple_news_exporter.to_json
     end
 
-    # Exporter instance for FacebookInstantArticle
-    # @return [ArticleJSON::Export::FacebookInstantArticle::Exporter]
-    def facebook_instant_article_exporter
-      ArticleJSON::Export::FacebookInstantArticle::Exporter.new(elements)
-    end
-
-    # FacebookInstantArticle export of the article
-    # @return [String]
-    def to_facebook_instant_article
-      facebook_instant_article_exporter.html
-    end
-
     # Exporter instance for plain text
     # @return [ArticleJSON::Export::PlainText::Exporter]
     def plain_text_exporter

data/lib/article_json/configuration.rb

@@ -31,7 +31,7 @@ module ArticleJSON
     # @param [Symbol] exporter
     # @param [Hash[Symbol => Class]] type_class_mapping
     def register_element_exporters(exporter, type_class_mapping)
-      valid_exporters = %i(html amp facebook_instant_article plain_text)
+      valid_exporters = %i(html amp apple_news plain_text)
       unless valid_exporters.include?(exporter)
         raise ArgumentError, '`exporter` needs to be one of ' \
                              "#{valid_exporters} but is `#{exporter.inspect}`"
@@ -39,8 +39,9 @@ module ArticleJSON
       if !type_class_mapping.is_a?(Hash) ||
           type_class_mapping.keys.any? { |key| !key.is_a? Symbol } ||
           type_class_mapping.values.any? { |value| !value.is_a? Class }
-        raise ArgumentError, '`type_class_mapping` has to be a Hash with '\
-                             'symbolized keys and classes as values but is '\
+
+        raise ArgumentError, '`type_class_mapping` has to be a Hash with ' \
+                             'symbolized keys and classes as values but is ' \
                              "`#{type_class_mapping.inspect}`"
       end
 
@@ -57,4 +58,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/heading.rb

@@ -34,4 +34,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/image.rb

@@ -46,4 +46,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/list.rb

@@ -34,4 +34,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/paragraph.rb

@@ -36,6 +36,7 @@ module ArticleJSON
       # @return [Integer]
       def length
         return 0 if empty?
+
         @content.reduce(0) do |sum, element|
           sum + (element.respond_to?(:length) ? element.length : 0)
         end
@@ -52,4 +53,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/quote.rb

@@ -38,4 +38,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/text.rb

@@ -44,6 +44,7 @@ module ArticleJSON
       # @return [Integer]
       def length
         return 0 if blank?
+
         content.length
       end
       alias size length
@@ -63,4 +64,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/text_box.rb

@@ -38,4 +38,3 @@ module ArticleJSON
     end
   end
 end
-

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

@@ -54,4 +54,3 @@ module ArticleJSON
     end
   end
 end
-

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

@@ -42,18 +42,22 @@ module ArticleJSON
 
           # @return [Nokogiri::XML::Element]
           def youtube_node
-            create_element('amp-youtube',
-                           'data-videoid' => @element.embed_id,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-youtube',
+              'data-videoid' => @element.embed_id,
+              width: default_width,
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
           def vimeo_node
-            create_element('amp-vimeo',
-                           'data-videoid' => @element.embed_id,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-vimeo',
+              'data-videoid' => @element.embed_id,
+              width: default_width,
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
@@ -61,42 +65,50 @@ module ArticleJSON
             # The embed_id of a tweet is stored as "<handle>/<tweet_id>" but
             # the `amp-twitter` tag only takes the `tweet_id` part
             tweet_id = @element.embed_id.split('/').last
-            create_element('amp-twitter',
-                           'data-tweetid': tweet_id,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-twitter',
+              'data-tweetid': tweet_id,
+              width: default_width,
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
           def facebook_node
             url = "#{@element.oembed_data[:author_url]}/videos/#{@element.embed_id}"
-            create_element('amp-facebook',
-                           'data-embedded-as' => 'video',
-                           'data-href' => url,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-facebook',
+              'data-embedded-as' => 'video',
+              'data-href' => url,
+              width: default_width,
+              height: default_height
+            )
           end
 
           def soundcloud_node
             src = Nokogiri::HTML(@element.oembed_data[:html])
-              .xpath('//iframe/@src').first.value
-            track_id = src.match(/tracks%2F(\d+)/)[1]
-            create_element('amp-soundcloud',
-                           layout: 'fixed-height',
-                           'data-trackid': track_id,
-                           'data-visual': true,
-                           width: 'auto',
-                           height: default_height)
+                          .xpath('//iframe/@src').first.value
+            track_id = src.match(%r{tracks%2F(\d+)})[1]
+            create_element(
+              'amp-soundcloud',
+              layout: 'fixed-height',
+              'data-trackid': track_id,
+              'data-visual': true,
+              width: 'auto',
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
           def iframe_node
             node = Nokogiri::HTML(@element.oembed_data[:html]).xpath('//iframe')
-            create_element('amp-iframe',
-                           src: node.attribute('src').value,
-                           width: node.attribute('width').value,
-                           height: node.attribute('height').value,
-                           frameborder: '0',)
+            create_element(
+              'amp-iframe',
+              src: node.attribute('src').value,
+              width: node.attribute('width').value,
+              height: node.attribute('height').value,
+              frameborder: '0'
+            )
           end
 
           # @return [String]

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

@@ -9,11 +9,13 @@ module ArticleJSON
 
           # @return [Nokogiri::HTML::NodeSet]
           def image_node
-            create_element('amp-img',
-                           src: @element.source_url,
-                           width: default_width,
-                           height: default_height,
-                           layout: :responsive)
+            create_element(
+              'amp-img',
+              src: @element.source_url,
+              width: default_width,
+              height: default_height,
+              layout: :responsive
+            )
           end
 
           def default_width

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

@@ -8,10 +8,11 @@ module ArticleJSON
         # @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
+            .flat_map { |element| element.custom_element_tags }
+            .uniq
         end
 
         # Return an array with all the javascript libraries needed for some
@@ -19,6 +20,7 @@ module ArticleJSON
         # @return [Array<String>]
         def amp_libraries
           return @amp_libraries if defined? @amp_libraries
+
           @amp_libraries =
             CustomElementLibraryResolver.new(custom_element_tags).script_tags
         end

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

@@ -51,7 +51,7 @@ module ArticleJSON
           def text
             @element.caption.map do |child_element|
               text_exporter.new(child_element)
-                .export
+                           .export
             end.join
           end
 

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

@@ -10,6 +10,7 @@ module ArticleJSON
           end
 
           private
+
           # Image
           # @return [Hash]
           def image
@@ -48,7 +49,7 @@ module ArticleJSON
           def text
             @element.caption.map do |child_element|
               text_exporter.new(child_element)
-                .export
+                           .export
             end.join
           end
         end

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

@@ -26,7 +26,7 @@ module ArticleJSON
           def text
             @element.content.map do |child_element|
               text_exporter.new(child_element)
-                .export
+                           .export
             end.join
           end
         end

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

@@ -6,8 +6,21 @@ module ArticleJSON
           include ArticleJSON::Export::Common::HTML::Elements::Base
           include ArticleJSON::Export::Common::HTML::Elements::Text
 
-          UNSUPPORTED_HTML_TAGS = %w[title meta script noscript style link applet object iframe
-            noframes form select option optgroup
+          UNSUPPORTED_HTML_TAGS = %w[
+            title
+            meta
+            script
+            noscript
+            style
+            link
+            applet
+            object
+            iframe
+            noframes
+            form
+            select
+            option
+            optgroup
           ].freeze
 
           # A Nokogiri object is returned with`super`, which is is then