markdown_views 2.1.3 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5df0161956a6cf0a692de3844b8eaabd3839c63a3efeb00e4b5253f4003f0339
-  data.tar.gz: 1a297c19d39d6a69d5111dae58fe7625117a9c2615d52a928a9b68e93d73ddf2
+  metadata.gz: b8226d152dfa2b2d6b58d36ca7166f3b054c2d7ae9e464225d2ce667f53a4c36
+  data.tar.gz: 4f5f16391b55c1f6690f6a24f15e7cc093fcf2eda47c089673b3087e47bd8a10
 SHA512:
-  metadata.gz: f51a26f78fa1e5c559cf7e84e13106bdbbb42e9fc9faa70a29de76bb69a9af277fd0f658b2a4301831c1e619803d05c8bc824e5f1a138d721677a4868e4cc035
-  data.tar.gz: 33f92ccec6e6c8c3d4134c77fd2fe162b5216703cd797e3d188080a1a989a844abacd22ba865a2d345a577d3df7b94b81725f121ad8e8fdf1159d29247ca68ef
+  metadata.gz: e99cc7b66a92d4d99da9d516b78d0302f0c7f30313168bc732a15201f64c1be56a3f2e7e0fee355ccf63321b805317b81519065e268f56a65c4c63079657c3b9
+  data.tar.gz: 89c8f06becaa43ed2449ac8a822fb41ff96e45426a9d9d470a85014e07535c40cd126a53940513ed144f584d02eeeb928862af6b932c0a13beea1a443ff69efd

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 thomas morgan
+Copyright (c) 2014-2021 thomas morgan
 
 MIT License
 

data/Rakefile

@@ -1,4 +1,5 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
 task :generate_stylesheet do
   %w( base16.light base16.dark base16.solarized.light base16.solarized.dark
@@ -9,3 +10,12 @@ task :generate_stylesheet do
     `rougify style #{theme} --scope .rouge-highlight > app/assets/stylesheets/rouge.#{theme}.css`
   end
 end
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/markdown_views.rb

@@ -1,5 +1,6 @@
 require 'action_view'
 require 'commonmarker'
+require 'rails'
 require 'rouge'
 
 %w(config engine handler renderer version).each do |f|

data/lib/markdown_views/renderer.rb

@@ -24,8 +24,31 @@ module MarkdownViews
         MarkdownViews.rouge_opts[:formatter] || Rouge::Formatters::HTML.new
       end
 
+      # removes single & multi-line comments
+      #   if any content besides comment & whitespace is on same line(s), strips just the comment.
+      #   if no other content, strips the lines & whitespace too.
       def strip_comments(input)
-        input.gsub(/[ \t\r\n\f]*<!--(.*?)-->*/m, '')
+        # ^[ \t]*(<!--.*?-->)++[ \t]*\r?\n    lines with just comments
+        # |                                   or
+        # <!--.*?-->                          comments on lines with other content
+        #
+        # ^                 start of line
+        # [ \t]*            optional spaces or tabs
+        # (<!--.*?-->)++
+        #   <!--            start of html comment
+        #   .*?             any char, incl linefeed (for multi-line comments)
+        #                     lazy (non-greedy): *?
+        #   -->             end of html comment
+        #   ++              possessive match - prevents a match across comment boundaries
+        #                     ie: prevent matching this: <!-- a --> keep <!-- b -->
+        #                     explanation: initially .*? will refuse to match --> because it's
+        #                       non-greedy. but, in search of pre/post whitespace, the regex engine
+        #                       could backtrack and ask .*? to match an --> as long as there's
+        #                       another --> later. possessive disables the backtracking.
+        #                     can combine <!-- a --><!-- b --> into one match, which is of no harm.
+        # [ \t]*            optional spaces or tabs
+        # \r?\n             end of line (either unix or windows style)
+        input.gsub(/^[ \t]*(<!--.*?-->)++[ \t]*\r?\n|<!--.*?-->/m, '')
       end
 
       def transform_code_blocks(doc)

data/lib/markdown_views/version.rb

@@ -1,3 +1,3 @@
 module MarkdownViews
-  VERSION = '2.1.3'
+  VERSION = '2.2.2'
 end

data/markdown_views.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'commonmarker', '>= 0.18.2', '< 0.21'
+  spec.add_dependency 'commonmarker', '>= 0.18.2', '< 0.23'
+  spec.add_dependency 'rails', '>= 5.0', '< 6.2'
   spec.add_dependency 'rouge', '~> 3.3'
-  spec.add_dependency 'actionpack', '>= 5.0', '< 6.1'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  # spec.add_development_dependency "bundler", "> 1.5"
+  spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "rake"
 end

data/test/strip_comments_test.rb

@@ -0,0 +1,62 @@
+require "test_helper"
+
+class StripCommentsTest < Minitest::Test
+
+  def test_not_greedy
+    assert_equal "ace", strip_comments("a<!-- b -->c<!-- d -->e")
+    assert_equal "a\nc\nd\nf", strip_comments("a\n<!-- b -->c\nd<!-- e -->\nf")
+  end
+
+  # only comment should vanish, without absorbing any outside whitespace
+  def test_intra_line_comments
+    assert_equal "ac", strip_comments("a<!-- b -->c"), 'no whitespace'
+    assert_equal "\nac\n", strip_comments("\na<!-- b -->c\n"), 'no whitespace, with linefeeds'
+    assert_equal "a c", strip_comments("a <!-- b -->c"), 'left whitespace'
+    assert_equal "a c", strip_comments("a<!-- b --> c"), 'right whitespace'
+    assert_equal "a  c", strip_comments("a <!-- b --> c"), 'double whitespace'
+    assert_equal "ac", strip_comments("a<!--b-->c"), 'comment w/o whitespace'
+    assert_equal "a \nc", strip_comments("a <!-- b -->\nc"), 'trailing comment'
+    assert_equal "a\n c", strip_comments("a\n<!-- b --> c"), 'leading comment'
+  end
+
+  # only comment should vanish, without absorbing outside whitespace
+  def test_shared_line_multi_line_comments
+    assert_equal "14", strip_comments("1<!-- 2\n3 -->4"), 'no whitespace'
+    assert_equal "1  4", strip_comments("1 <!-- 2\n3 --> 4"), 'with whitespace'
+    assert_equal "1\n  4", strip_comments("1\n <!-- 2\n3 --> 4"), 'leading whitespace on comment'
+    assert_equal "1  \n4", strip_comments("1 <!-- 2\n3 --> \n4"), 'trailing whitespace on comment'
+    assert_equal "1 \n 4", strip_comments("1 \n<!-- 2\n3 --> 4"), 'trailing whitespace on line'
+    assert_equal "1 \n 4", strip_comments("1 <!-- 2\n3 -->\n 4"), 'leading whitespace on line'
+  end
+
+  # should make line vanish, including outside whitespace
+  def test_whole_line_single_line_comments
+    assert_equal "1\n3\n", strip_comments("1\n<!-- 2 -->\n3\n"), 'adjacent lines'
+    assert_equal "1\r\n3\r\n", strip_comments("1\r\n<!-- 2 -->\r\n3\r\n"), 'adjacent lines w/windows LF'
+    assert_equal "1\n\n\n3\n", strip_comments("1\n\n<!-- 2 -->\n\n3\n"), 'spaced lines'
+    assert_equal "  1\n  3\n", strip_comments("  1\n  <!-- 2 -->\n  3\n"), 'adjacent lines indented w/spaces'
+    assert_equal "\t1\n\t3\n", strip_comments("\t1\n\t<!-- 2 -->\n\t3\n"), 'adjacent lines indented w/tabs'
+    assert_equal "  1\n\n\n  3\n", strip_comments("  1\n\n  <!-- 2 -->\n\n  3\n"), 'spaced lines indented w/spaces'
+    assert_equal "1  \n  \n4\t\n", strip_comments("1  \n  \n<!-- 2 -->  \n<!--3-->\t\n4\t\n"), 'spaced lines w/trailing whitespace'
+  end
+
+  # should make all lines vanish, including outside whitespace on same lines
+  def test_whole_line_multi_line_comments
+    assert_equal "1\n4\n", strip_comments("1\n<!-- 2\n3 -->\n4\n"), 'adjacent lines'
+    assert_equal "1\n\n\n4\n", strip_comments("1\n\n<!-- 2\n3 -->\n\n4\n"), 'spaced lines'
+    assert_equal "  1\n  4\n", strip_comments("  1\n  <!-- 2\n  3 -->\n  4\n"), 'adjacent lines indented w/spaces'
+    assert_equal "1  \n  \n4\t\n", strip_comments("1  \n  \n<!-- 2  \n3 -->\t\n4\t\n"), 'spaced lines w/trailing whitespace'
+  end
+
+
+  def strip_comments(*args)
+    MarkdownViews::Renderer.strip_comments(*args)
+  end
+
+  # hack to make diffs more understandable
+  # otherwise minitest sometimes truncates multi-lines diffs, making them unusable
+  def mu_pp(obj)
+    super obj.gsub("\n", '\n').gsub("\t", '\t')
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/reporters'
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "markdown_views"
+
+require "minitest/autorun"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_views
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.2
 platform: ruby
 authors:
 - thomas morgan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -19,7 +19,7 @@ dependencies:
         version: 0.18.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,23 +29,9 @@ dependencies:
         version: 0.18.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
-  name: rouge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: actionpack
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,21 +49,35 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
+        version: '3.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,11 +130,13 @@ files:
 - lib/markdown_views/renderer.rb
 - lib/markdown_views/version.rb
 - markdown_views.gemspec
+- test/strip_comments_test.rb
+- test/test_helper.rb
 homepage: https://github.com/zarqman/markdown_views
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +151,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Add .md template handler to Rails.
-test_files: []
+test_files:
+- test/strip_comments_test.rb
+- test/test_helper.rb