vimwiki_markdown 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f189d3c34ff57222d67797a78f3128fef429d34
-  data.tar.gz: aeac3deaea9af1d8cf4354faf8ac04f3202c47ff
+  metadata.gz: ea0a2a3a06fdc81312423b662f55ba51a29c8042
+  data.tar.gz: 08a9b1299039ad604b01ce28bb49aa54c1dd15f3
 SHA512:
-  metadata.gz: 2944bc41ac7329606d3a09fd93302e63bd2cf707c6b690e3f67a762e0be86eed755464d64ff981540e0ac21b51acf7f60edd0a8be86b8ee92aefa25b34e0dc85
-  data.tar.gz: 32bfaa7451342d1f1ea17d4e45ec9b11c03a1d57cbb114b7a79e85826766344abe86ac4b01fc064b4df0ffe47bbfe7048106adfbd484110f02e694a918e59317
+  metadata.gz: 6718d352d95532346c3906d9e5e77b2a3f08644ec9d2dad3a02a772a7173a34ffcabd7f69082ef84e86b38a36366de11269f2ae5a58aa7c1f7917dbbb774a027
+  data.tar.gz: 466403cd9dd22997cf5e340d6d118f45d6a89202026638810690ca70f1d459bc83be4f28c5db4271a36e7a7c32789c8adfcf3366fa17974c9a079908018d4c72

data/README.md

@@ -20,6 +20,12 @@ 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

data/bin/vimwiki_markdown

@@ -1,4 +1,42 @@
-require 'vimwiki_markdown'
+require 'drb/drb'
+require "vimwiki_markdown/options"
 
-VimwikiMarkdown.convert_wikimarkdown_to_html
+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
 
+  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/bin/vimwiki_server

@@ -0,0 +1,22 @@
+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

data/changelog.md

@@ -1,3 +1,9 @@
+## 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/options.rb

@@ -72,6 +72,13 @@ 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.0.5"
+  VERSION = "0.1.0"
 end

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
+  def self.convert_wikimarkdown_to_html(options = Options.new)
     ::I18n.enforce_available_locales = false
 
-    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)
+    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)
 
+      File.write(options.output_fullpath, combined_body_template)
+    end
   rescue MissingRequiredParamError => e
     warn e.message
     exit(0)

data/spec/lib/vimwiki_markdown/options_spec.rb

@@ -3,7 +3,7 @@ require 'vimwiki_markdown/options'
 
 module VimwikiMarkdown
   describe Options do
-    subject { Options.new }
+    let(:options) { Options.new }
 
     context "no options passed" do
       before do
@@ -15,5 +15,25 @@ 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.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Patrick Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,6 +198,7 @@ email:
 - patrick.davey@gmail.com
 executables:
 - vimwiki_markdown
+- vimwiki_server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -209,6 +210,7 @@ files:
 - README.md
 - Rakefile
 - bin/vimwiki_markdown
+- bin/vimwiki_server
 - changelog.md
 - example_files/default.tpl
 - lib/vimwiki_markdown.rb
@@ -242,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Converts a github flavoured markdown vimwiki file into html.