markdown_views 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c82ec3234bbe6ced6805a71e2fc6599a07e62a888cabd008d138adf2f4468af
-  data.tar.gz: c000f602b7d9cfcfd1a1464ef87cf41dbce160fa183a770ba9411e8e9b74a354
+  metadata.gz: 563ffc66a2741675ca0d8579174a3701e36237ab3d39fd73f5fccd4104706512
+  data.tar.gz: 9730b4130817235c0a52faade6b4df34153ceef1bec554f3da7e4d261a583d17
 SHA512:
-  metadata.gz: 721420b13bee7bc80d6d8aed3534774fac8d5fe8db2184b4ba579e366a7fc90260614607046bd716a80a410ee75844945d0e3b76167a8d8e6b1f63bd164be5d7
-  data.tar.gz: 2979d488ae36e653e8f32b1f11fb19b0d7a5e1ba5d529a912c1de37e0df09081121e53ae9f9d1cd062d1ed38221bd5a4b4c0ac0c37643c6257fe5fa07beff752
+  metadata.gz: 3bac100dcce357cfc2faac72924a10df250cccce481ebfde0e78ddcd3df17fa1ab9f49123b73ef3b94968853aaad4012984c2a6d2a2d7b02e250c9c95a2615f7
+  data.tar.gz: 3d40e4f3a5789467ff6e978bdc2bc003765d5e52062049859780a7d4a885b19808735a22ba9ee80dd79f872065e06a5e47b62bdb4cc908add6b0378e2aa1df7d

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,16 +24,31 @@ module MarkdownViews
         MarkdownViews.rouge_opts[:formatter] || Rouge::Formatters::HTML.new
       end
 
-      # when removing comments, also cleans up leading whitespace.
-      #   if whitespace includes line feeds, leaves 1 behind to 
-      #   avoid breaking markdown adjacent to comment.
+      # 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)
-        # (\s*)   leading whitespace
-        # <!--    start of html comment
-        # .*?     any char, incl linefeed (for multi-line comments)
-        #           lazy (non-greedy): *?
-        # -->     end of html comment
-        input.gsub(/(\s*)<!--.*?-->/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.5'
+  VERSION = '2.2.0'
 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.22'
+  spec.add_dependency 'rails', '>= 5.0', '< 6.1'
   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 "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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown_views
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.2.0
 platform: ruby
 authors:
 - thomas morgan
@@ -19,7 +19,7 @@ dependencies:
         version: 0.18.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
   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.22'
 - !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:
     - - ">="
@@ -64,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !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,6 +144,8 @@ 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
@@ -153,4 +169,6 @@ rubygems_version: 3.0.6
 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