vimwiki_markdown 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3645fe30ab3bb81638bf374ee0299069ceee5680889609a6ae65bba411f1b4a6
-  data.tar.gz: 14e2433a0fdd60bb0cda3a424996746f85b3c07a2c8e846c24a0a4573d52d8ce
+  metadata.gz: d897f72d7a0477abd0949c827322a0eb03fdef2e25ef49a81924b553aa9b0735
+  data.tar.gz: a78cb0793eda1cd773a139022bfca5aa1ba60e97f918a3887f76069d5c1c15d7
 SHA512:
-  metadata.gz: e3afa0beac17b69d85c6aba84d2f2bf5f63925d84b0bd9867e2c210d151706416bcc330c58695975fde7abfd16934b702769696d7bacdf07d72ac176406004ca
-  data.tar.gz: 6557dfcd016610ddc5360478be922ffbf14ccc31182f4c1dde589800804a632900c89191a12e50132a42c0cda96c46c0abbf3eb34755366a2b0636fd1d475112
+  metadata.gz: 312339f34d280767d0e34be1ceb4590f1545802145b70b4c4724b9550242e0f36a54021071c1dbc7bfe6c26aba3800c327fe909e4469c7ed75fb0d69fcec80b6
+  data.tar.gz: fd739c1f256ef9ed1997de16f36ec03a77ea1c37e11aced19f9ec0c34b2996b6e72d1de88126c0cb133e5057b75a548ca7a83f860f35f729b148b456a15d7eb0

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Rails/DynamicFindBy:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+     - 'Rakefile'
+     - 'spec/**/*.rb'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 20
+
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 20
+  Exclude:
+  - "spec/**/*"
+

data/README.md

@@ -18,15 +18,18 @@ Install the vimwiki_markdown gem
 
 ## Setup
 
+vimwiki_markdown works best with a recent version of [vimwiki](https://github.com/vimwiki/vimwiki). Use the `dev` branch for best results.
+
 Ensure that your vimiwiki directive in your .vimrc is setup for markdown.  For
 this we use the custom_wiki2html parameter.  My .vimrc looks like this:
 
     let g:vimwiki_list = [{'path': '~/vimwiki', 'template_path': '~/vimwiki/templates/',
               \ 'template_default': 'default', 'syntax': 'markdown', 'ext': '.md',
               \ 'path_html': '~/vimwiki/site_html/', 'custom_wiki2html': 'vimwiki_markdown',
+              \ 'html_filename_parameterization': 1,
               \ 'template_ext': '.tpl'}]
 
-The most important part is the *'custom_wiki2html': 'vimwiki_markdown'*
+The most important parts are the *'custom_wiki2html': 'vimwiki_markdown'* and the *'html_filename_parameterization': 1*. The custom_wiki2html tells vimwiki to use this gem for creating html, the html_filename_parameterization tells vimwiki to match the filenames that vimwiki_markdown produces.
 
 ### Install issues.
 There have been some issues with getting dependencies installed. Before opening an issue, please check if you can use [rvm](http://rvm.io/) to install the gem, as RVM is magic and makes everything work ;)
@@ -68,12 +71,6 @@ more interesting vimwiki links (e.g. :local etc.)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-## Known Issues
-
-In the `vimwiki_markdown` gem, links are written out using Rails' paramaterized method. That is, a link like "my awesome link" is turned into "my-awesome-link". Vimwikis built-in support for
-checking whether a file needs to be re-generated or not uses a mixture of timestamp and whether the output file exists. Unfortunately, vimwiki _doesn't_ paramaterize their output files, so, quite often there's
-a mismatch in terms of whether a file exists. I had patched previous version of vimwiki, but, I haven't done it with the latest version. If you _want_ to look at it, there's [some information in a previous version of this README](https://github.com/patrickdavey/vimwiki_markdown/blob/4cf18a3fb329895e2062a1a56c83074d215e93c4/README.md#fix-for-vimwiki-links), but, you're on your own ;)
-
 ## License
 
 [MIT License](http://opensource.org/licenses/mit-license.php)

data/changelog.md

@@ -1,5 +1,9 @@
+## 0.4.0 [June 16 2019]
+Support HTML tags in markdown content again.
+
 ## 0.3.3 [March 29 2019]
 Support for %date% and %nohtml tags
+Add information about html_filename_parameterization.
 
 ## 0.3.2 [March 28 2019]
 

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/lib/vimwiki_markdown/wiki_body.rb

@@ -15,8 +15,10 @@ class VimwikiMarkdown::WikiBody
     fixlinks
     html = GitHub::Markup.render_s(
       GitHub::Markups::MARKUP_MARKDOWN,
-      markdown_body
+      markdown_body,
+      options: { commonmarker_opts: [:UNSAFE] }
     )
+
     pipeline = HTML::Pipeline.new([
       HTML::Pipeline::SyntaxHighlightFilter,
       HTML::Pipeline::TableOfContentsFilter

data/spec/lib/vimwiki_markdown/wiki_body_spec.rb

@@ -33,6 +33,12 @@ module VimwikiMarkdown
       expect(wiki_body.to_s).to match(/hello/)
     end
 
+    it "must convert html content correctly" do
+      allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
+      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("<p>hello world</p>")
+      expect(wiki_body.to_s).to include("<p>hello world</p>")
+    end
+
     it "must convert multiple links on the same line correctly" do
       allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("[here](here) [there](there)")
       allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)

data/vimwiki_markdown.gemspec

@@ -25,10 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its", "~> 1.1"
   spec.add_development_dependency "rspec-html-matchers", "~> 0.6.1"
   spec.add_development_dependency "guard-rspec", "~> 4.3"
+  spec.add_development_dependency "rubocop"
 
   spec.add_runtime_dependency     "activesupport", "~> 4.1"
   spec.add_runtime_dependency     "github-markup", "~> 3.0"
-  spec.add_runtime_dependency     "commonmarker", "~> 0.18.0"
+  spec.add_runtime_dependency     "commonmarker", "~> 0.20"
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +216,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Guardfile