vimwiki_markdown 0.6.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94fcdf721504210b46ed56769e3529838982092414094c950ccddaa747086f9f
-  data.tar.gz: 219b35ea5da34b1cf75f962432073a8f97c972a62d14403b35dfae442f98b794
+  metadata.gz: 7c9f4165d6c964688b29b13f05378ad2d7f8aa04621121e718e3bf25a9832ecc
+  data.tar.gz: d76fa5a6a5081ff3cde0e8d556bca8e45e90f25618ad4b623e0949c88ed18e5b
 SHA512:
-  metadata.gz: 5c51b9de26115ee93f512404af7e84544088406df98a4c0861095da736dd78821f12e59b40e639f7bbea13f20bc460eb14bf9b4daa911c3bd00202ccd587f1e9
-  data.tar.gz: 5ccfb995fa5e7966379fc34dc40a0799614bf59b59d780fc0932a413a3876bebccdbc3bf4166cbda209a9e8bbc78593673816a44b4a5768cc90a80e6fc33f958
+  metadata.gz: 909ccbcc5420b3da2b2c62d40bf5e6f8223afdd2044386f33809598d741cb19ae197d728f22bff724fd99c2d109feb917fc862287a61ab22004ee50486b0ce93
+  data.tar.gz: 1ed5e03a0811ce63df21004ae8f10020a6d8fd758280d6cc0e6dca353ab49431190cf9f23d9ff230713e9285cf69231d314a7bfcd7fa8e681e889d2ba6b634af

data/.travis.yml

@@ -4,6 +4,8 @@ before_install:
 language: ruby
 rvm:
   - 2.3.8
-  - 2.4.2
-  - 2.5.3
-  - 2.6.1
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0

data/README.md

@@ -6,6 +6,15 @@ to be converted to HTML.
 
 It is currently a work in progress (but working for me ;)
 
+## Example
+It turns this:
+
+![markdown](A.png)
+
+into
+
+![finished](B.png)
+
 ## Requirements
 
 Ruby installed on your computer & up to date version of vimwiki

data/changelog.md

@@ -1,3 +1,21 @@
+## 0.8.2 [22 June 2022]
+Remove deprecation warning for EscapeUtils.escape_html
+see https://github.com/patrickdavey/vimwiki_markdown/pull/43
+
+## 0.8.1 [March 7 2022]
+Update commonmarker version, fixes security issue!
+
+## 0.8.0 [March 7 2022]
+Fixes an issue where VimwikiTOC generated table of contents where there are duplicate heading names did not match the output HTML from the Github pipeline.
+
+This means any generated (dupliate) bookmarks are going to be broken though, so, this is backwardly incompatible
+
+see https://github.com/patrickdavey/vimwiki_markdown/pull/39
+
+## 0.7.0 [July 8 2021]
+Fixes an issue whereby non english filenames were being replaced with empty strings
+see https://github.com/patrickdavey/vimwiki_markdown/pull/35
+
 ## 0.6.0 [April 26 2020]
 Support for todo lists with enhanced state options. Thanks to @primercuervo
 

data/lib/vimwiki_markdown/options.rb

@@ -70,7 +70,8 @@ module VimwikiMarkdown
     end
 
     def output_fullpath
-      "#{output_dir}#{title.parameterize}.html"
+      filename = title.parameterize =~ /^\s*$/ ? title : title.parameterize
+      "#{output_dir}#{filename}.html"
     end
 
 

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.6.0"
+  VERSION = "0.8.2"
 end

data/lib/vimwiki_markdown/vimwiki_link.rb

@@ -34,7 +34,12 @@ module VimwikiMarkdown
     def rewrite_local_links!
       if vimwiki_markdown_file_exists?
         path = Pathname.new(uri)
-        @uri = "#{path.dirname + path.basename(markdown_extension).to_s.parameterize}.html"
+
+        link_path = path.basename(markdown_extension).to_s.parameterize
+
+        link_path = path.basename(markdown_extension).to_s if link_path.match(/^\s*$/)
+
+        @uri = "#{path.dirname + link_path}.html"
         @fragment = fragment.parameterize.prepend("#") unless fragment.empty?
       elsif  /^file:/.match(uri)
         # begins with file: -> force absolute path if file exists

data/lib/vimwiki_markdown/vimwiki_toc_filter.rb

@@ -0,0 +1,34 @@
+require "cgi"
+
+class VimwikiTOCFilter < HTML::Pipeline::TableOfContentsFilter
+  def call
+    result[:toc] = String.new('')
+
+    headers = Hash.new(1)
+    doc.css('h1, h2, h3, h4, h5, h6').each do |node|
+      text = node.text
+      id = ascii_downcase(text)
+      id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
+      id.tr!(' ', '-') # replace spaces with dash
+
+      uniq = headers[id] > 1 ? "-#{headers[id]}" : ''
+      headers[id] += 1
+      if header_content = node.children.first
+        result[:toc] << %(<li><a href="##{id}#{uniq}">#{CGI.escape_html(text)}</a></li>\n)
+        header_content.add_previous_sibling(%(<a id="#{id}#{uniq}" class="anchor" href="##{id}#{uniq}" aria-hidden="true">#{anchor_icon}</a>))
+      end
+    end
+    result[:toc] = %(<ul class="section-nav">\n#{result[:toc]}</ul>) unless result[:toc].empty?
+    doc
+  end
+
+  if RUBY_VERSION >= '2.4'
+    def ascii_downcase(str)
+      str.downcase(:ascii)
+    end
+  else
+    def ascii_downcase(str)
+      str.downcase
+    end
+  end
+end

data/lib/vimwiki_markdown/wiki_body.rb

@@ -3,6 +3,7 @@ require 'github/markup'
 require 'html/pipeline'
 require 'pathname'
 require "vimwiki_markdown/vimwiki_link"
+require "vimwiki_markdown/vimwiki_toc_filter"
 
 class VimwikiMarkdown::WikiBody
 
@@ -23,7 +24,7 @@ class VimwikiMarkdown::WikiBody
 
     pipeline = HTML::Pipeline.new([
       HTML::Pipeline::SyntaxHighlightFilter,
-      HTML::Pipeline::TableOfContentsFilter
+      VimwikiTOCFilter
     ], { scope: "highlight"})
     @result = pipeline.call(html)
     @result = @result[:output].to_s

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -43,6 +43,11 @@ module VimwikiMarkdown
           expect(Options.new.output_fullpath).to eq("#{subject.output_dir}name-with-spaces.html")
         end
 
+        it "must not change filenames if paramteriezed returns an empty string" do
+          allow_any_instance_of(Options).to receive(:input_file) { "~/foo/世界.md" }
+          expect(Options.new.output_fullpath).to eq("#{subject.output_dir}世界.html")
+        end
+
         it "must correctly deal with filenames with capitalization issues" do
           allow_any_instance_of(Options).to receive(:input_file) { "~/foo/NAME WITH SPACES.md" }
           expect(Options.new.output_fullpath).to eq("#{subject.output_dir}name-with-spaces.html")

data/spec/lib/vimwiki_markdown/vimwiki_link_spec.rb

@@ -68,6 +68,17 @@ module VimwikiMarkdown
         expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html#wiki-heading)")
       end
 
+      context "with chinese or unparamaterizable chars" do
+        let(:existing_file) { "世界#{markdown_extension}" }
+
+        it "must convert same-directory markdown links without paramaterization correctly" do
+          markdown_link = "[test](#{existing_file_no_extension})"
+
+          link = VimwikiLink.new(markdown_link, source_filepath, markdown_extension, root_path, output_dir)
+          expect(link.to_s).to eq("[test](#{existing_file_no_extension}.html)")
+        end
+      end
+
       context "subdirectory linked files" do
         let(:existing_file) { "subdirectory/test.md" }
 

data/vimwiki_markdown.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.12"
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency     "activesupport", "~> 4.1"
   spec.add_runtime_dependency     "github-markup", "~> 3.0"
-  spec.add_runtime_dependency     "commonmarker", "~> 0.20"
+  spec.add_runtime_dependency     "commonmarker", "~> 0.23.4"
   spec.add_runtime_dependency     "html-pipeline", "~> 2.0"
   spec.add_runtime_dependency     "rouge", "~> 3.3"
   spec.add_runtime_dependency     "escape_utils", "~> 1.2"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Patrick Davey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.23.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.23.4
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- A.png
+- B.png
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -234,6 +236,7 @@ files:
 - lib/vimwiki_markdown/template.rb
 - lib/vimwiki_markdown/version.rb
 - lib/vimwiki_markdown/vimwiki_link.rb
+- lib/vimwiki_markdown/vimwiki_toc_filter.rb
 - lib/vimwiki_markdown/wiki_body.rb
 - spec/lib/vimwiki_markdown/options_spec.rb
 - spec/lib/vimwiki_markdown/template_spec.rb
@@ -245,7 +248,7 @@ homepage: https://github.com/patrickdavey/wimwiki_markdown
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +263,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.
 test_files: