vimwiki_markdown 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea0a2a3a06fdc81312423b662f55ba51a29c8042
-  data.tar.gz: 08a9b1299039ad604b01ce28bb49aa54c1dd15f3
+  metadata.gz: a8ab0a8dd31d4b4c7975ec0cca59cf275f3a6b92
+  data.tar.gz: 156a835b645f49cebc85d917ef1c996b45051e5b
 SHA512:
-  metadata.gz: 6718d352d95532346c3906d9e5e77b2a3f08644ec9d2dad3a02a772a7173a34ffcabd7f69082ef84e86b38a36366de11269f2ae5a58aa7c1f7917dbbb774a027
-  data.tar.gz: 466403cd9dd22997cf5e340d6d118f45d6a89202026638810690ca70f1d459bc83be4f28c5db4271a36e7a7c32789c8adfcf3366fa17974c9a079908018d4c72
+  metadata.gz: 70f9c33b1ca3b1db71d9ebd626a7a1cde1e6bffd9ba5a9a3375dfffaf489f01c6fec54a569ae91857bb18a2bba00254bcfe36b6bf0267925976ac40907ba7eba
+  data.tar.gz: d1df0e23ffd043ae42063d9d53d48cda6ff53952e065de6d7c5436ed00dc359c3d0a76c82c3f217d19adba79cbef81292695f9f778c5255118e110bdc0813402

data/README.md

@@ -20,12 +20,6 @@ for the generation of html.  This was added on the master branch in [this commit
 
 Currently you will need to make sure you are running the dev branch of vimwiki, or add that commit in yourself
 
-## Druby
-
-The version 0.1 introduced Druby which we use to greatly speed up the process.  You might want to stick
-with the 0.0.x version if things get interesting.
-
-
 ## Setup
 
 Ensure that your vimiwiki directive in your .vimrc is setup for markdown.  For
@@ -38,6 +32,24 @@ this we use the custom_wiki2html parameter.  My .vimrc looks like this:
 
 The most important part is the *'custom_wiki2html': 'vimwiki_markdown'*
 
+###  Note for ruby 2.2
+This gem doesn't seem to work on 2.2 on osx.. seems to be a github/markup gem issue as near as I can tell.
+For the moment.. use 2.1 or lower if you run into issues.
+
+### Fix for vimwiki links.
+In vimwiki at the moment, it deletes any files in the site_html directory which do not match
+against the markdown files (once they are translated into linked html).  Now, in vimwiki_markdown
+we use ActiveSupports paramaterized method, as it's nicer on links.  If you want to have a
+significant speed up, then you need to patch your vimwiki plugin to not delete files it
+shouldn't be.  Here are links to the relevant bits:
+
+1. [Add this function](https://github.com/patrickdavey/vimwiki-1/blob/9ebca2182fcf10e1bbf61abc8b4a535ce790480d/autoload/vimwiki/html.vim#L242-247)
+2. [Make the is_html_uptodate look like this](https://github.com/patrickdavey/vimwiki-1/blob/9ebca2182fcf10e1bbf61abc8b4a535ce790480d/autoload/vimwiki/html.vim#L224-241)
+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.
+
+
+
 ### VimWiki Template
 
 It is a requirement that your template file contain a placeholder

data/bin/vimwiki_markdown

@@ -1,42 +1,4 @@
-require 'drb/drb'
-require "vimwiki_markdown/options"
+require 'vimwiki_markdown'
 
-def port_open?(ip, port, timeout)
-  start_time = Time.now
-  current_time = start_time
-  while (current_time - start_time) <= timeout
-   begin
-    TCPSocket.new(ip, port)
-    return true
-   rescue Errno::ECONNREFUSED
-    sleep 0.1
-   end
-   current_time = Time.now
-  end
+VimwikiMarkdown.convert_wikimarkdown_to_html
 
-  return false
-end
-
-unless port_open?("127.0.0.1", 8787, 1)
-  server = fork do
-    exec "vimwiki_server"
-  end
-
-  Process.detach(server)
-  sleep(1)
-end
-
-options = VimwikiMarkdown::Options.new
-
-# The URI to connect to
-SERVER_URI="druby://localhost:8787"
-
-# Start a local DRbServer to handle callbacks.
-#
-# Not necessary for this small example, but will be required
-# as soon as we pass a non-marshallable object as an argument
-# to a dRuby call.
-DRb.start_service
-
-vimwiki_service = DRbObject.new_with_uri(SERVER_URI)
-vimwiki_service.generate_html(options)

data/changelog.md

@@ -1,9 +1,16 @@
+## 0.1.1 [April 22nd 2015]
+* Aaaaannnnd reverting that change.  While it totally works, it probably
+  is overkill to have Druby running.  The major issue is that vimwiki
+  deletes the old files as the filenames do not match.  Have added a
+  note in the README to tell people how to make it faster.
+
 ## 0.1.0 [April 18th 2015]
 * Quite a major change, we now spin up a Druby server in the background
   and then send the files across the wire to it.  This is somewhat
   invasive, but, on the plus side, takes the compilation time from
   several minutes down to seconds as we're not having to start
   up and require a whole bunch of files all the time.
+
 ## 0.0.4 [Dec 9th 2014]
 * Use Github::Markup to prerender the markdown
 

data/lib/vimwiki_markdown.rb

@@ -5,16 +5,16 @@ require "vimwiki_markdown/wiki_body"
 require "vimwiki_markdown/exceptions"
 
 module VimwikiMarkdown
-  def self.convert_wikimarkdown_to_html(options = Options.new)
+  def self.convert_wikimarkdown_to_html
     ::I18n.enforce_available_locales = false
 
-    if !options.unmodified?
-      template_html = Template.new(options)
-      body_html = WikiBody.new(options)
-      combined_body_template = template_html.to_s.gsub('%content%', body_html.to_s)
+    options = Options.new
+    template_html = Template.new(options)
+    body_html = WikiBody.new(options)
+    combined_body_template = template_html.to_s.gsub('%content%', body_html.to_s)
+
+    File.write(options.output_fullpath, combined_body_template)
 
-      File.write(options.output_fullpath, combined_body_template)
-    end
   rescue MissingRequiredParamError => e
     warn e.message
     exit(0)

data/lib/vimwiki_markdown/options.rb

@@ -72,13 +72,6 @@ module VimwikiMarkdown
       "#{output_dir}#{title.parameterize}.html"
     end
 
-    def unmodified?
-      return false unless File.exist?(output_fullpath)
-
-      File.mtime(input_file) < File.mtime(output_fullpath)
-    end
-
-
     private
 
     def arguments

data/lib/vimwiki_markdown/version.rb

@@ -1,3 +1,3 @@
 module VimwikiMarkdown
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -3,7 +3,7 @@ require 'vimwiki_markdown/options'
 
 module VimwikiMarkdown
   describe Options do
-    let(:options) { Options.new }
+    subject { Options.new }
 
     context "no options passed" do
       before do
@@ -15,25 +15,5 @@ module VimwikiMarkdown
       its(:output_fullpath) { should eq("#{subject.output_dir}#{subject.title.parameterize}.html") }
       its(:template_filename) { should eq('/home/patrick/vimwiki/templates/default.tpl') }
     end
-
-    context "with an already existing html output" do
-      let(:path) { options.output_fullpath }
-
-      before do
-        allow(Options).to receive(:arguments).and_return(Options::DEFAULTS)
-      end
-
-      it "#unmodified? should return false if the file does not exist" do
-        allow(File).to receive(:exist?).with(path) { false }
-        expect(options.unmodified?).to be(false)
-      end
-
-      it "#unmodified? should return true" do
-        allow(File).to receive(:exist?).with(path) { true }
-        allow(File).to receive(:mtime).with(path) { Date.today }
-        allow(File).to receive(:mtime).with(options.input_file) { Date.today - 1 }
-        expect(options.unmodified?).to be(true)
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vimwiki_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,6 @@ email:
 - patrick.davey@gmail.com
 executables:
 - vimwiki_markdown
-- vimwiki_server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -210,7 +209,6 @@ files:
 - README.md
 - Rakefile
 - bin/vimwiki_markdown
-- bin/vimwiki_server
 - changelog.md
 - example_files/default.tpl
 - lib/vimwiki_markdown.rb

data/bin/vimwiki_server

@@ -1,22 +0,0 @@
-require 'drb/drb'
-require 'vimwiki_markdown'
-
-# The URI for the server to connect to
-URI="druby://localhost:8787"
-
-class VimwikiMarkdownService
-
-  def generate_html(options)
-    VimwikiMarkdown.convert_wikimarkdown_to_html(options)
-  end
-
-end
-
-# The object that handles requests on the server
-FRONT_OBJECT=VimwikiMarkdownService.new
-
-# $SAFE = 1   # disable eval() and friends
-
-DRb.start_service(URI, FRONT_OBJECT)
-# Wait for the drb server thread to finish before exiting.
-DRb.thread.join