reverse_markdown 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cffa2a16f5ad4187cb23a2e6a1015121b943f1c83a688308cf0a480ec15d3c49
-  data.tar.gz: 6941ad7c07005ff4d5c115fd894ee2a0cf40a09367833268f4c55c018f30263a
+  metadata.gz: 94eded67b23dcb767fefb6415557b114e9901aa158e96d6de9eebace8e91cdde
+  data.tar.gz: 52e80dad7a9cfdbaa0c22698b7d08b7c977988bd36febc3fc4c3dece596366e6
 SHA512:
-  metadata.gz: 620ce03beae7238accdc6836e025dc7b19fe308a7bcbcd7143dc7472d09e7d25758a3f6c2080d5d75e60fee662bc87ab200f177b5b6f41fa5958bde4b569a49e
-  data.tar.gz: ea69f20a1e70e4f41d6024502af362351ccaf6ec8936b4dcadc2414202e994cdf8ddf08ebbd829c0722c373bbe7e87a223c3c913bf6d845be9308ef418f3be75
+  metadata.gz: c1701257560c201e275587ab769e6965b9c8060918341c97a0ce971ddd4bb9b862e183e278e411aecedcae99515fbec6c3206ff22ccd7be7133e3f15e74d6f4e
+  data.tar.gz: 166e5fc564cbbbbfaae1f4f4bd4c4d9ce01adb92e8b5caadbcf4c78adaf98e17450eb5a0df1ba2055b9e31f72e43d3e79b765ee318dbb05113dd05c7e04b85c3

data/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '2.7', '3.0', '3.1', '3.2', '3.3', 'jruby-9.4' ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec
+
+      - name: Run Code Climate Test Reporter
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+
+      - name: Run tests
+        run: bundle exec rspec
+
+      - name: Upload Code Climate Coverage Report
+        if: matrix.ruby-version == '3.3'
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: |
+          ./cc-test-reporter after-build --exit-code $?

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.5

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 3.0.0 - October 2024
+- BREAKING: Dropped support for ruby 2.6.0 and lower
+- Bugfix for missing newline behind `ol`, thanks @Kevinrob, see #104
+- Add support for `iframe` tags, thanks @gagandeepsinghj, see #102
+- Support for frozen string literals, thanks @pat, see #105
+
 ## 2.1.1 - October 2021
 - Fixes unintentional newline characters within lists with paragraphs, thanks @diogoosorio, see #93
 - Lets \n to be present in <pre> tag. solves #77 #78, thanks @shivabhusal

data/README.md

@@ -2,7 +2,7 @@
 
 Transform html into markdown. Useful for example if you want to import html into your markdown based application.
 
-[![Build Status](https://secure.travis-ci.org/xijo/reverse_markdown.svg?branch=master)](https://travis-ci.org/xijo/reverse_markdown) [![Gem Version](https://badge.fury.io/rb/reverse_markdown.svg)](http://badge.fury.io/rb/reverse_markdown) [![Code Climate](https://codeclimate.com/github/xijo/reverse_markdown.svg)](https://codeclimate.com/github/xijo/reverse_markdown) [![Code Climate](https://codeclimate.com/github/xijo/reverse_markdown/coverage.png)](https://codeclimate.com/github/xijo/reverse_markdown)
+![Build Status](https://github.com/xijo/reverse_markdown/actions/workflows/ci.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/reverse_markdown.svg)](http://badge.fury.io/rb/reverse_markdown) [![Code Climate](https://codeclimate.com/github/xijo/reverse_markdown.svg)](https://codeclimate.com/github/xijo/reverse_markdown) [![Test Coverage](https://api.codeclimate.com/v1/badges/6ce481ba7ae6f57dc4d3/test_coverage)](https://codeclimate.com/github/xijo/reverse_markdown/test_coverage)
 
 ## Changelog
 
@@ -11,7 +11,7 @@ See [Change Log](CHANGELOG.md)
 ## Requirements
 
 1. [Nokogiri](http://nokogiri.org/)
-2. Ruby 2.0.0 or higher
+2. Ruby 2.7.0 or higher
 
 ## Installation
 

data/lib/reverse_markdown/converters/base.rb

@@ -2,7 +2,7 @@ module ReverseMarkdown
   module Converters
     class Base
       def treat_children(node, state)
-        node.children.inject('') do |memo, child|
+        node.children.inject(+'') do |memo, child|
           memo << treat(child, state)
         end
       end
@@ -19,6 +19,10 @@ module ReverseMarkdown
         title = escape_keychars(node['title'].to_s)
         title.empty? ? '' : %[ "#{title}"]
       end
+
+      def extract_src(node)
+        node['src'].to_s.empty? ? '' : node['src'].to_s
+      end
     end
   end
 end

data/lib/reverse_markdown/converters/blockquote.rb

@@ -4,7 +4,7 @@ module ReverseMarkdown
       def convert(node, state = {})
         content = treat_children(node, state).strip
         content = ReverseMarkdown.cleaner.remove_newlines(content)
-        "\n\n> " << content.lines.to_a.join('> ') << "\n\n"
+        +"\n\n> " << content.lines.to_a.join('> ') << "\n\n"
       end
     end
 

data/lib/reverse_markdown/converters/div.rb

@@ -2,7 +2,7 @@ module ReverseMarkdown
   module Converters
     class Div < Base
       def convert(node, state = {})
-        "\n" << treat_children(node, state) << "\n"
+        +"\n" << treat_children(node, state) << "\n"
       end
     end
 

data/lib/reverse_markdown/converters/figcaption.rb

@@ -5,7 +5,7 @@ module ReverseMarkdown
         if node.text.strip.empty?
           ""
         else
-          "\n" << "_#{node.text.strip}_" << "\n"
+          +"\n" << "_#{node.text.strip}_" << "\n"
         end
       end
     end

data/lib/reverse_markdown/converters/iframe.rb

@@ -0,0 +1,11 @@
+module ReverseMarkdown
+  module Converters
+    class Iframe < Base
+      def convert(node, state = {})
+        extract_src(node)
+      end
+    end
+
+    register :iframe, Iframe.new
+  end
+end

data/lib/reverse_markdown/converters/ol.rb

@@ -3,7 +3,7 @@ module ReverseMarkdown
     class Ol < Base
       def convert(node, state = {})
         ol_count = state.fetch(:ol_count, 0) + 1
-        "\n" << treat_children(node, state.merge(ol_count: ol_count))
+        +"\n" << treat_children(node, state.merge(ol_count: ol_count)) << "\n"
       end
     end
 

data/lib/reverse_markdown/converters/p.rb

@@ -2,7 +2,7 @@ module ReverseMarkdown
   module Converters
     class P < Base
       def convert(node, state = {})
-        "\n\n" << treat_children(node, state).strip << "\n\n"
+        +"\n\n" << treat_children(node, state).strip << "\n\n"
       end
     end
 

data/lib/reverse_markdown/converters/pre.rb

@@ -4,9 +4,9 @@ module ReverseMarkdown
       def convert(node, state = {})
         content = treat_children(node, state)
         if ReverseMarkdown.config.github_flavored
-          "\n```#{language(node)}\n" << content.strip << "\n```\n"
+          +"\n```#{language(node)}\n" << content.strip << "\n```\n"
         else
-          "\n\n    " << content.lines.to_a.join("    ") << "\n\n"
+          +"\n\n    " << content.lines.to_a.join("    ") << "\n\n"
         end
       end
 

data/lib/reverse_markdown/converters/table.rb

@@ -2,7 +2,7 @@ module ReverseMarkdown
   module Converters
     class Table < Base
       def convert(node, state = {})
-        "\n\n" << treat_children(node, state) << "\n"
+        +"\n\n" << treat_children(node, state) << "\n"
       end
     end
 

data/lib/reverse_markdown/version.rb

@@ -1,3 +1,3 @@
 module ReverseMarkdown
-  VERSION = '2.1.1'
+  VERSION = '3.0.0'
 end

data/lib/reverse_markdown.rb

@@ -31,6 +31,7 @@ require 'reverse_markdown/converters/table'
 require 'reverse_markdown/converters/td'
 require 'reverse_markdown/converters/text'
 require 'reverse_markdown/converters/tr'
+require 'reverse_markdown/converters/iframe'
 
 module ReverseMarkdown
 

data/reverse_markdown.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'kramdown'
-  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'debug' unless RUBY_ENGINE == 'jruby'
   s.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/assets/iframe.html

@@ -0,0 +1,4 @@
+<h1>Welcome to My Page</h1>
+<p>This is a sample paragraph before the iframe.</p>
+<iframe src="https://www.example.com" width="600" height="400"></iframe>
+<p>This is a sample paragraph after the iframe.</p>

data/spec/assets/lists.html

@@ -95,5 +95,10 @@
       <li>delta</li>
     </ul>
 
+    <ul>
+      <li>item followed with a text</li>
+    </ul>
+    text after the list
+
   </body>
 </html>

data/spec/components/from_the_wild_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe ReverseMarkdown do
-
   let(:input)    { File.read('spec/assets/from_the_wild.html') }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseMarkdown.convert(input) }
@@ -13,5 +12,4 @@ describe ReverseMarkdown do
   it "should not over escape * or _" do
     expect(subject).to include '[![](example.com/foo_bar.png) I\_AM\_HELPFUL](example.com/foo_bar)'
   end
-
 end

data/spec/components/html_fragment_spec.rb

@@ -1,11 +1,9 @@
 require 'spec_helper'
 
 describe ReverseMarkdown do
-
   let(:input)    { File.read('spec/assets/html_fragment.html') }
   let(:document) { Nokogiri::HTML(input) }
   subject { ReverseMarkdown.convert(input) }
 
   it { is_expected.to eq("naked text 1\n\nparagraph text\n\nnaked text 2") }
 end
-

data/spec/components/iframe_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ReverseMarkdown do
+  let(:input)    { File.read('spec/assets/iframe.html') }
+  let(:document) { Nokogiri::HTML(input) }
+  subject { ReverseMarkdown.convert(input) }
+
+  it do
+    expected = <<~MD
+      # Welcome to My Page
+
+      This is a sample paragraph before the iframe.
+
+      https://www.example.com
+
+      This is a sample paragraph after the iframe.
+
+    MD
+
+    expect(subject).to eq expected
+  end
+end

data/spec/components/lists_spec.rb

@@ -65,4 +65,7 @@ describe ReverseMarkdown do
     it { is_expected.to match /\n- delta\n/ }
   end
 
+  context "text following list should have a new line separator" do
+    it { is_expected.to match /\n- item followed with a text\n\n text after the list/ }
+  end
 end

data/spec/lib/reverse_markdown_spec.rb

@@ -36,7 +36,8 @@ describe ReverseMarkdown do
 
     describe 'force_encoding option', jruby: :exclude do
       it 'raises invalid byte sequence in UTF-8 exception' do
-        expect { ReverseMarkdown.convert("hi \255") }.to raise_error(ArgumentError)
+        # Older versions of ruby used to raise ArgumentError here. Remove when we drop support for 3.1.
+        expect { ReverseMarkdown.convert("hi \255") }.to raise_error { [Encoding::CompatibilityError, ArgumentError].include?(_1.class) }
       end
 
       it 'handles invalid byte sequence if option is set' do

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'simplecov'
-# require 'byebug'
+require 'debug' unless RUBY_ENGINE == 'jruby'
 
 SimpleCov.profiles.define 'gem' do
   add_filter '/spec/'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reverse_markdown
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Johannes Opper
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -117,9 +117,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -145,6 +146,7 @@ files:
 - lib/reverse_markdown/converters/figure.rb
 - lib/reverse_markdown/converters/h.rb
 - lib/reverse_markdown/converters/hr.rb
+- lib/reverse_markdown/converters/iframe.rb
 - lib/reverse_markdown/converters/ignore.rb
 - lib/reverse_markdown/converters/img.rb
 - lib/reverse_markdown/converters/li.rb
@@ -167,6 +169,7 @@ files:
 - spec/assets/from_the_wild.html
 - spec/assets/full_example.html
 - spec/assets/html_fragment.html
+- spec/assets/iframe.html
 - spec/assets/lists.html
 - spec/assets/minimum.html
 - spec/assets/paragraphs.html
@@ -179,6 +182,7 @@ files:
 - spec/components/escapables_spec.rb
 - spec/components/from_the_wild_spec.rb
 - spec/components/html_fragment_spec.rb
+- spec/components/iframe_spec.rb
 - spec/components/lists_spec.rb
 - spec/components/paragraphs_spec.rb
 - spec/components/quotation_spec.rb
@@ -203,7 +207,7 @@ homepage: http://github.com/xijo/reverse_markdown
 licenses:
 - WTFPL
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Convert html code into markdown.
 test_files:
@@ -230,6 +234,7 @@ test_files:
 - spec/assets/from_the_wild.html
 - spec/assets/full_example.html
 - spec/assets/html_fragment.html
+- spec/assets/iframe.html
 - spec/assets/lists.html
 - spec/assets/minimum.html
 - spec/assets/paragraphs.html
@@ -242,6 +247,7 @@ test_files:
 - spec/components/escapables_spec.rb
 - spec/components/from_the_wild_spec.rb
 - spec/components/html_fragment_spec.rb
+- spec/components/iframe_spec.rb
 - spec/components/lists_spec.rb
 - spec/components/paragraphs_spec.rb
 - spec/components/quotation_spec.rb

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.2.8.0
-
-notifications:
-  disabled: false
-  recipients:
-    - xijo@pm.me