mongoid_markdown_extension 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 98721c11aa15c68da195f8aa13d89a9f3cc2d204
-  data.tar.gz: c2d7b530f4b39fef19e734d881bdcfd20579fc42
+SHA256:
+  metadata.gz: ec8e015b5cfba63e62b5e27e5291363427d405becf26f9b8b798c61e42dcb080
+  data.tar.gz: 535cd7396fb5267661ad155a7f3037d80a03a87fb36db3e1209c097d82609310
 SHA512:
-  metadata.gz: 3406c9a2a958ae0394739e30bdcedd5ea4a369a3ee75819f0c4de6881ed5adfea88bc507107f10e8397b9d893b7263a95710bd95368c0f0fd3f5fe92079717c3
-  data.tar.gz: a22a1a4522e9ce2e022153a8868cf9e78d07891bf3ea87b192e1381588e0c3658e331df1bc2b32f63dc495045918b9413d6fc24aa535709bf235650927cd391f
+  metadata.gz: 2180a3997703c5a2a84624b754a29ffc59a233c82d1ffb328ba5cfd2a70d6e3463958cea22af745071958c95320a50cf4ee40459a39ebd4debe031f895b17599
+  data.tar.gz: f2cf2ea23f98fc0a576c7f9b4d99e3ae97a99a801ac8727358b6668b8ad255239292caf7eb7f70680df4ca7cb8b20dd8278a3b7e6265ed3cd3f0b3df0562d553

data/.ruby-version

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

data/.travis.yml

@@ -11,3 +11,14 @@ notifications:
       - 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.7.2
+      env: MONGOID_VERSION=6
+    - rvm: 2.7.2
+      env: MONGOID_VERSION=7

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+## 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
+
+- Fixed passing configuration to `InlineRenderer`
+
+## 0.1.9
+
+- `#to_stripped_s` removes leading & trailing white-space (null, horizontal tab, line feed, vertical tab, form feed, carriage return, space) using Ruby's `#strip`
+
+## 0.1.8
+
+- Mongoid 7 compatibility

data/Gemfile

@@ -1,4 +1,12 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mongoid_markdown_extension.gemspec
-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/lib/mongoid_markdown_extension.rb

@@ -1,3 +1,5 @@
+require 'mongoid'
+
 require 'mongoid_markdown_extension/inline_renderer'
 require 'mongoid_markdown_extension/markdown'
 require 'mongoid_markdown_extension/version'

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

@@ -3,87 +3,86 @@ require 'redcarpet/render_strip'
 
 module MongoidMarkdownExtension
   class Markdown < String
-    def initialize(str)
-      super str.to_s
-      @str = str.to_s
+    class << self
+      attr_writer :configuration
     end
 
-    def to_s
-      @str
+    def self.configuration
+      @configuration ||= Configuration.new
     end
 
-    def to_html
-      markdown_renderer.render(@str).html_safe
+    def self.reset
+      @configuration = Configuration.new
     end
 
-    def to_inline_html
-      markdown_inline_renderer.render(@str).gsub(/(<br\s?\/?>)+?\Z/, '').html_safe
+    def self.configure
+      yield(configuration)
     end
 
-    def to_stripped_s
-      markdown_stripdown_renderer.render(@str)
+    def self.demongoize(value)
+      Markdown.new(value)
     end
 
-    def mongoize
-      @str
+    def self.mongoize(value)
+      case value
+      when Markdown then value.mongoize
+      else value
+      end
     end
 
-    private # =============================================================
+    def self.evolve(value)
+      case value
+      when Markdown then value.mongoize
+      else value
+      end
+    end
 
-    def markdown_renderer
-      Redcarpet::Markdown.new(
-        self.class.configuration.render_class.new(self.class.configuration.render_options),
-        self.class.configuration.extensions
-      )
+    def initialize(str)
+      super(str.to_s)
     end
 
-    # TODO: how to combine custom render class with the InlineRenderer?
-    def markdown_inline_renderer
-      Redcarpet::Markdown.new(InlineRenderer, tables: false)
+    def to_html
+      markdown_renderer.render(to_s).html_safe
     end
 
-    def markdown_stripdown_renderer
-      Redcarpet::Markdown.new(Redcarpet::Render::StripDown, space_after_headers: true)
+    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 to_stripped_s
+      markdown_stripdown_renderer.render(to_s).try(:strip)
+    end
 
-    class << self
-      attr_accessor :configuration
+    private
 
-      def configure
-        @configuration ||= Configuration.new
-        yield @configuration
-      end
+    def markdown_renderer
+      render_class = MongoidMarkdownExtension::Markdown.configuration.render_class
+      render_options = MongoidMarkdownExtension::Markdown.configuration.render_options
+      extensions = MongoidMarkdownExtension::Markdown.configuration.extensions
 
-      def configuration
-        @configuration ||= Configuration.new
-      end
+      Redcarpet::Markdown.new(render_class.new(render_options), extensions)
+    end
 
-      def demongoize(value)
-        Markdown.new(value)
-      end
+    # 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
 
-      def mongoize(value)
-        case value
-        when Markdown then value.mongoize
-        else value
-        end
-      end
+      Redcarpet::Markdown.new(inline_render_class.new(render_options), extensions)
+    end
 
-      def evolve(value)
-        case value
-        when Markdown then value.mongoize
-        else value
-        end
-      end
+    def markdown_stripdown_renderer
+      Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
     end
   end
 
-  # ---------------------------------------------------------------------
-
   class Configuration
     attr_accessor :extensions
+    attr_accessor :inline_render_class
     attr_accessor :render_class
     attr_accessor :render_options
 
@@ -96,6 +95,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.6'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/mongoid_markdown_extension.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'redcarpet', '>= 3.1.2'
-  spec.add_dependency 'mongoid', '>= 4.0'
+  spec.add_dependency 'redcarpet', '~> 3.4'
+  spec.add_dependency 'mongoid', '>= 4.0', '< 8'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/test/mongoid_markdown_extension/markdown_test.rb

@@ -1,7 +1,5 @@
 require 'test_helper'
 
-# ---------------------------------------------------------------------
-
 class MongoidMarkdownExtensionTest
   include Mongoid::Document
   field :body, type: MongoidMarkdownExtension::Markdown
@@ -29,15 +27,20 @@ module MongoidMarkdownExtension
     let(:string) { 'some text with _italic_' }
     subject { MongoidMarkdownExtension::Markdown.new(string) }
 
+    after(:each) do
+      MongoidMarkdownExtension::Markdown.reset
+    end
+
     describe 'configuration' do
       describe 'setup block' do
         it 'yields self' do
           MongoidMarkdownExtension::Markdown.configure do |config|
-            config.must_be_kind_of 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,
@@ -45,80 +48,105 @@ 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'
       end
-      it 'replaces <p> with <br />' do
-        subject.to_inline_html.must_equal 'some text with <em>italic</em><br /><br />foo'
+
+      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"
       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
     end
   end

data/test/test_helper.rb

@@ -1,10 +1,11 @@
 require 'bundler/setup'
-require 'mongoid'
-require 'mongoid_markdown_extension'
+
 require 'minitest'
 require 'minitest/autorun'
 require 'minitest/spec'
 
+require 'mongoid_markdown_extension'
+
 if ENV['CI']
   require 'coveralls'
   Coveralls.wear!

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_markdown_extension
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,20 +41,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +96,9 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -121,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Custom field type for Mongoid that handles Markdown conversion via Redcarpet