mongoid_markdown_extension 0.1.10 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7931a4b45d301e84a32199bdeb55c8b88354ab100e03343b471f133f67703efd
-  data.tar.gz: 8add6626be35350d1fb4017baf8239c9d60d31f8ffb9c5218d6f3caebe52d9ff
+  metadata.gz: 5baa9bbdd4bbe2ed9fb1091b8f722d29dd8696a0247ff189af56143034487169
+  data.tar.gz: a8a862d5e19e866ce63a90cc97c7fc8f5fe089243c334b7c0309a8a02929f1f6
 SHA512:
-  metadata.gz: 9ccc13b39c9a1fba48b6e5fb5baf136702dc0f1b9171206389b869be6fbfbc103e4f25c677ac3caefa945e6e28ed16adde1f12248a02f8f95500df49a996728c
-  data.tar.gz: 706bf6154f6c2833bf6da66a7bce54715167593f65e30e8432ff6a4b5194947d529b641e2bc299c41ed6406ecb10c9b07a332572f8e034f1b11efc45394b9a21
+  metadata.gz: 60038ae6b00d87d4629daaab31c88ea752d60b514a2279d805bd54c908d86b99720f2498bfe26c6a0a981391b487d77aa60b5a8e6d22b4b8ec9c3ffabab8646e
+  data.tar.gz: c0c3465ad3b350eef54e5e8925830e5b2d1901ac8828d2c86e5150385278579ad6bbcc330b79985ca411948a5fdc95aa2f460cabbe9ee97d8ce0922666af9145

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+on:
+  pull_request:
+    branches: ["master"]
+  push:
+    branches: ["master"]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile: ["6", "7", "8"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
+        include:
+          - gemfile: "4"
+            ruby: "2.5"
+          - gemfile: "5"
+            ruby: "2.5"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 .DS_Store
+/gemfiles/*.gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.1

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "4" do
+  gem "mongoid", "~> 4.0"
+end
+
+appraise "5" do
+  gem "mongoid", "~> 5.0"
+end
+
+appraise "6" do
+  gem "mongoid", "~> 6.0"
+end
+
+appraise "7" do
+  gem "mongoid", "~> 7.0"
+end
+
+appraise "8" do
+  gem "mongoid", "~> 8.0"
+end

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # CHANGELOG
 
+## 0.2.1
+
+- Mongoid 8 compatibility
+
+## 0.2.0
+
+- Added `linebreaks` option to `to_inline_html`
+- Added `inline_render_class` configuration option
+- Fixed `to_inline_html`
+- Fixed usage of String methods
+
 ## 0.1.10
 
-- FIX: pass configuration to `InlineRenderer` as well
+- Fixed passing configuration to `InlineRenderer`
 
 ## 0.1.9
 

data/Gemfile

@@ -2,11 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mongoid_markdown_extension.gemspec
 gemspec
-
-case version = ENV['MONGOID_VERSION'] || '~> 7.0'
-when /7/ then gem 'mongoid', '~> 7.0'
-when /6/ then gem 'mongoid', '~> 6.0'
-when /5/ then gem 'mongoid', '~> 5.1'
-when /4/ then gem 'mongoid', '~> 4.0'
-else gem 'mongoid', version
-end

data/README.md

@@ -1,6 +1,6 @@
 # Mongoid Markdown Extension
 
-[![Build Status](https://travis-ci.org/tomasc/mongoid_markdown_extension.svg)](https://travis-ci.org/tomasc/mongoid_markdown_extension) [![Gem Version](https://badge.fury.io/rb/mongoid_markdown_extension.svg)](http://badge.fury.io/rb/mongoid_markdown_extension) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid_markdown_extension.svg)](https://coveralls.io/r/tomasc/mongoid_markdown_extension)
+[![Build Status](https://travis-ci.org/tomasc/mongoid_markdown_extension.svg)](https://travis-ci.org/tomasc/mongoid_markdown_extension) [![Gem Version](https://badge.fury.io/rb/mongoid_markdown_extension.svg)](http://badge.fury.io/rb/mongoid_markdown_extension)
 
 [Mongoid](https://github.com/mongoid/mongoid) field extension that returns an object with `to_html` method returning the content converted from Markdown syntax to html. The Markdown conversion is done using the [Redcarpet](https://github.com/vmg/redcarpet) library.
 

data/gemfiles/4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 4.0"
+
+gemspec path: "../"

data/gemfiles/5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 5.0"
+
+gemspec path: "../"

data/gemfiles/6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 6.0"
+
+gemspec path: "../"

data/gemfiles/7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.0"
+
+gemspec path: "../"

data/gemfiles/8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 8.0"
+
+gemspec path: "../"

data/lib/mongoid_markdown_extension/inline_renderer.rb

@@ -40,8 +40,11 @@ module MongoidMarkdownExtension
       nil
     end
 
-    def paragraph(text)
-      text + '<br /><br />'
+    def postprocess(full_document)
+      full_document
+        .gsub(/(<\/p>\s*<p>)+?/, '<br><br>')
+        .gsub(/(<\/?p>)+?/, '')
+        .chop
     end
   end
 end

data/lib/mongoid_markdown_extension/markdown.rb

@@ -5,61 +5,62 @@ module MongoidMarkdownExtension
   class Markdown < String
     class << self
       attr_writer :configuration
-    end
 
-    def self.configuration
-      @configuration ||= Configuration.new
-    end
+      def configuration
+        @configuration ||= Configuration.new
+      end
 
-    def self.reset
-      @configuration = Configuration.new
-    end
+      def reset
+        @configuration = Configuration.new
+      end
 
-    def self.configure
-      yield(configuration)
-    end
+      def configure
+        yield(configuration)
+      end
 
-    def self.demongoize(value)
-      Markdown.new(value)
-    end
+      def demongoize(value)
+        Markdown.new(value)
+      end
 
-    def self.mongoize(value)
-      case value
-      when Markdown then value.mongoize
-      else value
+      def mongoize(value)
+        case value
+        when Markdown then value.mongoize
+        else value
+        end
       end
-    end
 
-    def self.evolve(value)
-      case value
-      when Markdown then value.mongoize
-      else value
+      def evolve(value)
+        case value
+        when Markdown then value.mongoize
+        else value
+        end
       end
     end
 
     def initialize(str)
-      super str.to_s
-      @str = str.to_s
+      super(str.to_s)
     end
 
-    def to_s
-      @str
+    def split(*args)
+      super(*args).map { |str| self.class.new(str) }
     end
 
-    def to_html
-      markdown_renderer.render(@str).html_safe
+    def gsub(*args)
+      self.class.new(super(*args))
     end
 
-    def to_inline_html
-      markdown_inline_renderer.render(@str).gsub(/(<br\s?\/?>)+?\Z/, '').html_safe
+    def to_html
+      markdown_renderer.render(to_s).html_safe
     end
 
-    def to_stripped_s
-      markdown_stripdown_renderer.render(@str).try(:strip)
+    def to_inline_html(line_breaks: false)
+      rendered = markdown_inline_renderer.render(to_s).gsub(/(<br\s?\/?>)+?\z/, '')
+      rendered.gsub!(/(<br\s?\/?>)+?\Z/, '') if !line_breaks
+      rendered.html_safe
     end
 
-    def mongoize
-      @str
+    def to_stripped_s
+      markdown_stripdown_renderer.render(to_s).try(:strip)
     end
 
     private
@@ -74,11 +75,12 @@ module MongoidMarkdownExtension
 
     # TODO: how to combine custom render class with the InlineRenderer?
     def markdown_inline_renderer
+      inline_render_class = MongoidMarkdownExtension::Markdown.configuration.inline_render_class
       render_options = MongoidMarkdownExtension::Markdown.configuration.render_options
       extensions = MongoidMarkdownExtension::Markdown.configuration.extensions
       extensions[:tables] = false
 
-      Redcarpet::Markdown.new(InlineRenderer.new(render_options), extensions)
+      Redcarpet::Markdown.new(inline_render_class.new(render_options), extensions)
     end
 
     def markdown_stripdown_renderer
@@ -88,6 +90,7 @@ module MongoidMarkdownExtension
 
   class Configuration
     attr_accessor :extensions
+    attr_accessor :inline_render_class
     attr_accessor :render_class
     attr_accessor :render_options
 
@@ -100,6 +103,7 @@ module MongoidMarkdownExtension
         strikethrough: true,
         superscript: true
       }
+      @inline_render_class = MongoidMarkdownExtension::InlineRenderer
       @render_class = Redcarpet::Render::HTML
       @render_options = {}
     end

data/lib/mongoid_markdown_extension/version.rb

@@ -1,3 +1,3 @@
 module MongoidMarkdownExtension
-  VERSION = '0.1.10'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/mongoid_markdown_extension.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'redcarpet', '~> 3.4'
-  spec.add_dependency 'mongoid', '>= 4.0', '< 8'
+  spec.add_dependency 'mongoid', '>= 4.0'
 
+  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
 end

data/test/mongoid_markdown_extension/markdown_test.rb

@@ -35,12 +35,12 @@ module MongoidMarkdownExtension
       describe 'setup block' do
         it 'yields self' do
           MongoidMarkdownExtension::Markdown.configure do |config|
-            config.must_be_kind_of MongoidMarkdownExtension::Configuration
+            _(config).must_be_kind_of MongoidMarkdownExtension::Configuration
           end
         end
 
         it 'returns default values' do
-          MongoidMarkdownExtension::Markdown.configuration.extensions.must_equal(
+          _(MongoidMarkdownExtension::Markdown.configuration.extensions).must_equal(
             autolink: true,
             footnotes: true,
             highlight: true,
@@ -48,85 +48,114 @@ module MongoidMarkdownExtension
             strikethrough: true,
             superscript: true
           )
-          MongoidMarkdownExtension::Markdown.configuration.render_class.must_equal Redcarpet::Render::HTML
-          MongoidMarkdownExtension::Markdown.configuration.render_options.must_equal({})
+          _(MongoidMarkdownExtension::Markdown.configuration.inline_render_class).must_equal MongoidMarkdownExtension::InlineRenderer
+          _(MongoidMarkdownExtension::Markdown.configuration.render_class).must_equal Redcarpet::Render::HTML
+          _(MongoidMarkdownExtension::Markdown.configuration.render_options).must_equal({})
         end
       end
     end
 
     describe '#to_s' do
       it 'returns the original value' do
-        subject.to_s.must_equal string
+        _(subject.to_s).must_equal string
       end
     end
 
     describe '#to_html' do
       it 'survives nil' do
-        MongoidMarkdownExtension::Markdown.new(nil).to_html.must_equal ''
+        _(MongoidMarkdownExtension::Markdown.new(nil).to_html).must_equal ''
       end
 
       it 'converts the string to html' do
-        subject.to_html.must_equal Redcarpet::Markdown.new(Redcarpet::Render::HTML).render(string)
+        _(subject.to_html).must_equal Redcarpet::Markdown.new(Redcarpet::Render::HTML).render(string)
       end
     end
 
     describe '#to_inline_html' do
       let(:string) { "some text with _italic_\n\nfoo" }
+      let(:string_with_line_breaks) { "some text with line break  \nfoo" }
 
       it 'survives nil' do
-        MongoidMarkdownExtension::Markdown.new(nil).to_inline_html.must_equal ''
+        _(MongoidMarkdownExtension::Markdown.new(nil).to_inline_html).must_equal ''
       end
 
       it 'converts the string to html' do
-        subject.to_inline_html.wont_include '<p>'
+        _(subject.to_inline_html).wont_include '<p>'
       end
 
-      it 'replaces <p> with <br />' do
-        subject.to_inline_html.must_equal 'some text with <em>italic</em><br /><br />foo'
+      it 'replaces <p> with <br>' do
+        _(subject.to_inline_html).must_equal 'some text with <em>italic</em><br><br>foo'
+      end
+
+      it 'allows line breaks' do
+        inline_html = MongoidMarkdownExtension::Markdown
+          .new(string_with_line_breaks)
+          .to_inline_html(line_breaks: true)
+        _(inline_html).must_equal "some text with line break<br>\nfoo"
       end
     end
 
     describe '#to_stripped_s' do
       it 'survives nil' do
-        MongoidMarkdownExtension::Markdown.new(nil).to_stripped_s.must_equal ''
+        _(MongoidMarkdownExtension::Markdown.new(nil).to_stripped_s).must_equal ''
       end
 
       it 'converts the markdown to stripped string' do
-        subject.to_stripped_s.wont_include '_'
+        _(subject.to_stripped_s).wont_include '_'
       end
 
       it 'removes newlines' do
-        subject.to_stripped_s.wont_include "\n"
+        _(subject.to_stripped_s).wont_include "\n"
       end
     end
 
     describe '#mongoize' do
       it 'returns string' do
-        subject.mongoize.must_equal string
+        _(subject.mongoize).must_equal string
       end
     end
 
     describe '.mongoize' do
       describe 'when passed a string' do
         it 'returns it back' do
-          MongoidMarkdownExtension::Markdown.mongoize(string).must_equal string
+          _(MongoidMarkdownExtension::Markdown.mongoize(string)).must_equal string
         end
       end
 
       describe 'when passed markdown object' do
         it 'returns its string' do
-          MongoidMarkdownExtension::Markdown.mongoize(subject).must_be_kind_of String
+          _(MongoidMarkdownExtension::Markdown.mongoize(subject)).must_be_kind_of String
         end
       end
     end
 
     describe '.demongoize' do
       it 'does not change the value' do
-        MongoidMarkdownExtension::Markdown.demongoize(string).must_equal string
+        _(MongoidMarkdownExtension::Markdown.demongoize(string)).must_equal string
       end
 
       it 'returns markdown object' do
-        MongoidMarkdownExtension::Markdown.demongoize(string).must_be_kind_of MongoidMarkdownExtension::Markdown
+        _(MongoidMarkdownExtension::Markdown.demongoize(string)).must_be_kind_of MongoidMarkdownExtension::Markdown
+      end
+    end
+
+    describe "splitting" do
+      it "returns correctly instantiated markdown objects" do
+        markdown = MongoidMarkdownExtension::Markdown.new("foo\nbar\nfar\nboo")
+        split_markdown = markdown.split("\n")
+
+        _(split_markdown.first).must_be_kind_of MongoidMarkdownExtension::Markdown
+        _(split_markdown.first.to_s).must_equal "foo"
+        _(split_markdown.first.to_html).must_match /<p>foo<\/p>/
+      end
+
+      it "returns correctly instantiated markdown objects" do
+        markdown = MongoidMarkdownExtension::Markdown.new("foo\nbar\nfar\nboo")
+        gsubbed_markdown = markdown.gsub("\n", "bam")
+
+        _(gsubbed_markdown).must_be_kind_of MongoidMarkdownExtension::Markdown
+        _(gsubbed_markdown.to_s).must_equal "foobambarbamfarbamboo"
+        _(gsubbed_markdown.to_html).must_match (/<p>foobambarbamfarbamboo<\/p>/)
       end
     end
   end

data/test/test_helper.rb

@@ -5,8 +5,3 @@ require 'minitest/autorun'
 require 'minitest/spec'
 
 require 'mongoid_markdown_extension'
-
-if ENV['CI']
-  require 'coveralls'
-  Coveralls.wear!
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_markdown_extension
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.1
 platform: ruby
 authors:
 - Tomas Celizna
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -31,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,11 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: Custom field type for Mongoid that handles Markdown conversion via Redcarpet
   gem.
 email:
@@ -94,14 +88,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
+- ".tool-versions"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- gemfiles/4.gemfile
+- gemfiles/5.gemfile
+- gemfiles/6.gemfile
+- gemfiles/7.gemfile
+- gemfiles/8.gemfile
 - lib/mongoid_markdown_extension.rb
 - lib/mongoid_markdown_extension/inline_renderer.rb
 - lib/mongoid_markdown_extension/markdown.rb
@@ -113,7 +114,7 @@ homepage: https://github.com/tomasc/mongoid_markdown_extension
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Custom field type for Mongoid that handles Markdown conversion via Redcarpet
   gem.

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.travis.yml

@@ -1,24 +0,0 @@
-sudo: false
-language: ruby
-script: 'bundle exec rake'
-rvm:
-  - 2.2.5
-before_install:
-  - gem install bundler -v 1.12.5
-notifications:
-  email:
-    recipients:
-      - tomas.celizna@gmail.com
-    on_failure: change
-    on_success: never
-
-matrix:
-  include:
-    - rvm: 2.3.3
-      env: MONGOID_VERSION=4
-    - rvm: 2.3.3
-      env: MONGOID_VERSION=5
-    - rvm: 2.3.3
-      env: MONGOID_VERSION=6
-    - rvm: 2.5.0
-      env: MONGOID_VERSION=7