vimwiki_markdown 0.2.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f15a379fe2281d0a38bd24c2bdf359017dda45d1
-  data.tar.gz: 513869385056bd8578cb850cd8682f42efd93ecd
+SHA256:
+  metadata.gz: 68815b06a3406acf112329b2df90e5fa3c62c706fad84716995318e0028647cc
+  data.tar.gz: b16e46299ea1b20e449a3558c8b5c2af1bf5bd4985ec183eafe52ebb3125d8df
 SHA512:
-  metadata.gz: a7c9cf57dc30a2f88b88bada446122a0406076d5d1a69f93fb0e3e0d53c9dc18fb714e57b412c024f39b281d782f1d2c411818d63fc8ab3f62eb868a3277f0ab
-  data.tar.gz: 937e1c37ac549bef675e94723fc9c7c1dd51a5aa8540de506dad665d9460cdb253a2495b202bd91f030a9f27191beb1e05dc3499d6fce325bbd7c6010c7139a8
+  metadata.gz: 60836b8d9db398bb67fffeaed1a5941aa009e0a1b3be424ca1aa562d17469ad537a90a344621ee399c87de54884ed16772a211ed8bf172380c88b17196cb56e4
+  data.tar.gz: a77ebf08935ee2921996a379bd730b6c9afbf7aed5270d45a0aaa604563c60b3db3b6fb5e0b7d5cf9764464249cfcd06743f9e4bcc643728ea50f1416e98f71c

data/.travis.yml

@@ -1,3 +1,9 @@
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.3.8
+  - 2.4.2
+  - 2.5.3
+  - 2.6.1

data/README.md

@@ -40,7 +40,8 @@ shouldn't be.  Here are links to the relevant bits:
 3. For the moment, remove the call to deleting files `call s:delete_html_files(path_html)` - will work out a way around that later, not there now.
 4. Might be some other things, check the diff in the above commits or open an issue.
 
-
+### 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 ;)
 
 ### VimWiki Template
 
@@ -59,17 +60,6 @@ to [this commit](https://github.com/patrickdavey/vimwiki_markdown/commit/8645883
 It will get rewritten with the relative path to the root
 of the site (e.g. `./` or `../../` etc)
 
-#### Using Custom Template Tag
-
-Including a line with `%template <template name>` in any of your Vimwiki pages will will force the generator to use `<template name>.tpl` rather than `default.tpl` for that page.
-
-`<template name>` cannot contain any spaces
-
-#### Using Custom Title Tag
-
-Including a line with `%title <title name>` in any of your Vimwiki pages will force the generator to replace `%title%` in your template file with `<title name>` rather than the name of the file itself.
-*You can have spaces in your titles now!*
-
 ## Contributing
 
 Pull requests are very welcome, especially if you want to implement some of the

data/changelog.md

@@ -1,3 +1,25 @@
+## 0.3.1 [March 10 2019]
+Adds the ability to strip the extension correctly from vimwiki files.
+For example, the file index.wiki was converted to index.wiki.html.
+
+Thanks to @bowmanat for the PR.
+
+This may also very likely break existing links, so, watch out there ;)
+
+## 0.3.0 [March 10 2019]
+Rebuilds vimwiki_markdown against the latest versions of Github/Markup etc.
+
+The tools are somewhat different and so it's quite possible there will be breaking changes here, especially if
+you have embedded HTML tags inside your markdown files. With a later version of https://github.com/github/markup
+we should be able to pass options to commonmark and give ourselves more options.
+
+This also uses rouge for syntax highlighting (fenced code blocks). Finding the documentation for that was fun ;)
+
+### Breaking changes with 0.3
+* This removes the title tag functionality which was introduced in 0.2.6 Unfortunately, having spaces in links meant that the new markdown parsing did not see the link as being valid (at least for [foo bar](foo bar) links). This may be reintroduced later.
+* Requires ruby >= 2.3.8
+
+
 ## 0.2.6 [Jan 18 2018]
 Add %template and %title options
 

data/lib/vimwiki_markdown/options.rb

@@ -26,7 +26,7 @@ module VimwikiMarkdown
 
     attr_reader :force, :syntax, :extension, :output_dir,
                 :input_file, :css_file, :template_path,
-                :template_default, :template_ext, :root_path, :tags
+                :template_default, :template_ext, :root_path
 
 =begin  force : [0/1] overwrite an existing file
           syntax : the syntax chosen for this wiki
@@ -54,26 +54,10 @@ module VimwikiMarkdown
       @template_ext = arguments[TEMPLATE_EXT]
       @root_path = arguments[ROOT_PATH]
       @root_path = "./" if @root_path == "-"
-      @tags = pull_tags
       raise "Must be markdown" unless syntax == 'markdown'
     end
 
-    def get_file_contents
-      file = File.open(input_file, "r")
-      file.read
-    end
-
-    def pull_tags
-      tags = Hash.new
-      get_file_contents.split("\n").each do |li|
-        tags['template'] = li.split.last if (li[/%template \S+./])
-        tags['title'] = li.sub(/%title /, '') if (li[/%title .+/])
-      end
-      return tags
-    end
-
     def template_filename
-      return "#{template_path}#{tags['template']}#{template_ext}" if @tags['template']
       "#{template_path}#{template_default}#{template_ext}"
     end
 
@@ -82,12 +66,15 @@ module VimwikiMarkdown
     end
 
     def title
-      return File.basename(tags['title'], ".md").split(/ |\_/).map(&:capitalize).join(" ") if @tags['title']
-      File.basename(input_file, ".md").capitalize
+      File.basename(input_file, "#{extension}").capitalize
+    end
+
+    def output_fullpath
+      "#{output_dir}#{File.basename(input_file, "#{extension}")}.html"
     end
 
     def output_fullpath
-      "#{output_dir}#{File.basename(input_file, ".md")}.html"
+      "#{output_dir}#{File.basename(input_file, "#{extension}")}.html"
     end
 
     private

data/lib/vimwiki_markdown/template.rb

@@ -1,5 +1,4 @@
-require 'pygments.rb'
-
+require 'rouge'
 module VimwikiMarkdown
   class Template
 
@@ -31,7 +30,7 @@ module VimwikiMarkdown
 
     def pygments_wrapped_in_tags
       "<style type=\"text/css\">
-        #{Pygments.css('.highlight')}
+        #{::Rouge::Themes::Github.render(scope: '.highlight')}
       </style>"
     end
 

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.2.6"
+  VERSION = "0.3.1"
 end

data/lib/vimwiki_markdown/wiki_body.rb

@@ -13,13 +13,15 @@ class VimwikiMarkdown::WikiBody
   def to_s
     @markdown_body = get_wiki_markdown_contents
     fixlinks
-    remove_tags
-    github_markup = GitHub::Markup.render('README.markdown', markdown_body)
-    pipeline = HTML::Pipeline.new [
+    html = GitHub::Markup.render_s(
+      GitHub::Markups::MARKUP_MARKDOWN,
+      markdown_body
+    )
+    pipeline = HTML::Pipeline.new([
       HTML::Pipeline::SyntaxHighlightFilter,
       HTML::Pipeline::TableOfContentsFilter
-    ]
-    result = pipeline.call(github_markup)
+    ], { scope: "highlight"})
+    result = pipeline.call(html)
     result[:output].to_s
   end
 
@@ -61,13 +63,4 @@ class VimwikiMarkdown::WikiBody
     end
   end
 
-  def remove_tags
-    @markdown_body.gsub!(/%template \S+/) do
-      ""
-    end
-    @markdown_body.gsub!(/%title \S+/) do
-      ""
-    end
-  end
-
 end

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -3,31 +3,36 @@ require 'vimwiki_markdown/options'
 
 module VimwikiMarkdown
   describe Options do
-    let(:markdown_file_content) {wiki_template_title_markdown}
-    let(:options) { Options.new }
-    subject {options}
+    subject { Options.new }
 
     context "no options passed" do
       before do
-        allow(File).to receive(:open).and_return(StringIO.new("# title \n ## subtitle"))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
       end
 
       its(:force) { should be(true) }
       its(:syntax) { should eq('markdown') }
-      its(:output_fullpath) { should eq("#{subject.output_dir}#{File.basename(subject.input_file, ".md")}.html") }
+      its(:output_fullpath) { should eq("#{subject.output_dir}#{subject.title.parameterize}.html") }
       its(:template_filename) { should eq('~/vimwiki/templates/default.tpl') }
-    end
 
-    context "file with tags in it" do
-      before do
-        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
-        allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
-      end
+      describe "extension" do
+        it "deals with a different wiki extension correctly" do
+          allow(Options).to receive(:arguments).and_return(
+            ["1", #force - 1/0
+             "markdown",
+             "wiki",
+             "~/vimwiki/site_html/",
+             "~/vimwiki/index.wiki",
+             "~/vimwiki/site_html/style.css",
+             "~/vimwiki/templates/",
+             "default",
+             ".tpl",
+             "-"]
+          )
 
-      its(:template_filename) { should eq('~/vimwiki/templates/alt_template.tpl') }
-      its(:title) { should eq('Super Cool Title')}
+          expect(Options.new.title).to eq("Index")
+        end
+      end
     end
-
   end
 end

data/spec/lib/vimwiki_markdown/template_spec.rb

@@ -7,13 +7,11 @@ require 'rspec-html-matchers'
 module VimwikiMarkdown
   describe Template do
     let(:options) { Options.new }
-    let(:markdown_file_content) {wiki_index_markdown}
 
     context "template" do
 
       subject { Template.new(options).to_s }
       before do
-        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
         allow(File).to receive(:open).with(options.template_filename,"r").and_return(StringIO.new(wiki_template))
       end
@@ -24,7 +22,6 @@ module VimwikiMarkdown
 
     context "missing pygments" do
       before do
-        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
       end
 
@@ -36,7 +33,6 @@ module VimwikiMarkdown
 
     context "using %root_path%" do
       before do
-        allow(File).to receive(:open).and_return(StringIO.new(markdown_file_content))
         allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
       end
 

data/spec/lib/vimwiki_markdown/wiki_body_spec.rb

@@ -13,6 +13,7 @@ module VimwikiMarkdown
       allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return(markdown_file_content)
       allow_any_instance_of(VimwikiMarkdown::VimwikiLink).to receive(:vimwiki_markdown_file_exists?).and_return(true)
       expect(wiki_body.to_s).to match(/<a href="books.html">Books<\/a>/)
+      expect(wiki_body.to_s).to match(/<a href="bash-tips.html">Bash Tips<\/a>/)
     end
 
     it "must convert wiki links with separate titles correctly" do
@@ -39,17 +40,12 @@ module VimwikiMarkdown
       expect(wiki_body.to_s).to match(/<a href="there.html">there<\/a>/)
     end
 
-    it "must remove template tags" do
-      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("%template test\n")
-      expect(wiki_body.to_s).not_to match(/%template/)
-      expect(wiki_body.to_s).not_to match(/test/)
-    end
-
-    it "must remove title tags" do
-      allow(wiki_body).to receive(:get_wiki_markdown_contents).and_return("%title test\n")
-      expect(wiki_body.to_s).not_to match(/%title/)
-      expect(wiki_body.to_s).not_to match(/test/)
+    describe "syntax highlighting" do
+      it "must give correct classes" do
+        allow(wiki_body).to receive(:get_wiki_markdown_contents)
+          .and_return("```bash\n  find ./path -type f -exec sed -i 's/find_this/replace_this/g' {} \\;\n```\n")
+        expect(wiki_body.to_s).to match(/highlight/)
+      end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -110,16 +110,6 @@ def wiki_index_markdown
 "
 end
 
-def wiki_template_title_markdown
-"
-%title super cool title\n
-%template alt_template\n
-## Todo\n
-  1. add template functionality\n
-  2. add title functionality\n
-"
-end
-
 def wiki_template
 <<-WIKITEMPLATE
 <!DOCTYPE html>

data/vimwiki_markdown.gemspec

@@ -12,24 +12,24 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Converts a vimwiki markdown file to html.  It parses [[links]] and has support for syntax highlighting.}
   spec.homepage      = "https://github.com/patrickdavey/wimwiki_markdown"
   spec.license       = "MIT"
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.3.8'
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 11.2"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry", ">= 0.9.12"
-  spec.add_development_dependency "rspec-its", "~> 1.1.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  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_runtime_dependency     "activesupport", "~> 4.1.6"
-  spec.add_runtime_dependency     "github-markup", "~> 1.3.0"
-  spec.add_runtime_dependency     "github-markdown", "~> 0.6.8"
-  spec.add_runtime_dependency     "github-linguist", "~> 3.1.5"
-  spec.add_runtime_dependency     "redcarpet", "~> 3.1.2"
-  spec.add_runtime_dependency     "html-pipeline", "~> 1.11.0"
+  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     "html-pipeline", "~> 2.0"
+  spec.add_runtime_dependency     "rouge", "~> 3.3"
+  spec.add_runtime_dependency     "escape_utils", "~> 1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +56,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -114,84 +114,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: github-markdown
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.8
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: github-linguist
+  name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: html-pipeline
+  name: escape_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.2'
 description: Converts a vimwiki markdown file to html.  It parses [[links]] and has
   support for syntax highlighting.
 email:
@@ -237,7 +237,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.