github-markdown-server 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0fb00cc94750513ce5f5fc8e415f7701451438e
-  data.tar.gz: 1716202620cb37f2521f38a4ba575014a62ccf6f
+  metadata.gz: 69be47f30baf11233fbbf406bbaedd1c3cf38e50
+  data.tar.gz: 3c52501a7afc9631bce30d01937da20fe7fa14d8
 SHA512:
-  metadata.gz: 83862dda94532d5f09a36e136106067a812595339b56b64d4c6fd2e34d643f3978c4beb92d0a934214a98c18c6fa8b090af42aeccd354112adce26e79d16735d
-  data.tar.gz: 77a06eb4a0140a06643466dc047f27d4bf935744e52698aa8873ba056318002e8569f8ea114662e2a7e996014388faa66e47640d7e57cbfd2386cc604bdc380a
+  metadata.gz: dff3dd5ab3f042f055595ec68496b885c2f8e3da8287942f943d34c8a4a96c008034954d9becb15afda2bae06021903883c322e670f03453a8170a961f21c89e
+  data.tar.gz: 8a6834b4856f7f0cea24d85daf4ed038db6455138c2f4fea16db755e074fce259e8130fc7d0dd2fa583a8a8558ad4243c180ccdf3f18ceb48d0707e4668b9eb1

data/README.md

@@ -10,13 +10,13 @@ github-markdown-server is built on top of [github-markdown-preview](https://gith
 
 ## Installation
 
-```shell
+```bash
 gem install github-markdown-server
 ```
 
 ## Usage
 
-```shell
+```bash
 github-markdown-server README.md
 ```
 
@@ -24,7 +24,7 @@ This will start a server serving in the current directory and all child director
 
 If you are deep down inside a git repository and you want to serve the whole repository (so that relative links will work) then this command will do that for you.
 
-```shell
+```bash
 github-markdown-server -d $(git rev-parse --show-toplevel) somefile.md
 ```
 
@@ -35,3 +35,15 @@ There is a [contrib](contrib/) directory with an emacs lisp file which will star
 ## Contributing
 
 Please feel free to send me pull requests! This is my first Ruby project and it always feels like my first time when I write Emacs Lisp.
+
+## Building
+
+I keep forgetting how to do this...
+
+```bash
+VERSION=$(./bin/github-markdown-server --version | cut -d ' ' -f 3)
+\cp -fv ~/Library/emacs/lisp/github-markdown-server.el ~/mysrc/github-markdown-server/contrib/github-markdown-server.el
+gem build github-markdown-server.gemspec
+gem install github-markdown-server-$VERSION.gem
+gem push github-markdown-server-$VERSION.gem
+```

data/contrib/github-markdown-server.el

@@ -3,6 +3,12 @@
 
 ;;; Commentary:
 
+;;; view-file-in-browser will try and show the current file in the best way in the current browser.
+
+;;; Since I use rvm you'll need rvm.el from here https://github.com/senny/rvm.el
+;;; Uncommenthing this _might_ work (untested)
+;;; (defun rvm-use-default () ".") (provide 'rvm)
+
 ;;; Code:
 
 (require 'cl-lib)
@@ -10,25 +16,48 @@
 (defvar github-markdown-servers '() "The servers we have running.")
 (defvar github-markdown-server-port 7494 "The next available server port.")
 
+;; from the emacs wiki cookbook
+(defun ark-chomp (str)
+  "Chomp leading and trailing whitespace from STR."
+  (replace-regexp-in-string (rx (or (: bos (* (any " \t\n"))) (: (* (any " \t\n")) eos))) "" str))
+
 (defun git-base (&optional file-name)
   "Get the base of a git repository for FILE-NAME (or the current buffer)."
-  (interactive (buffer-file-name))
-  (shell-command-to-string
-    (concat "git -C " (shell-quote-argument (directory-file-name file-name))
-      " rev-parse --show-toplevel 2>/dev/null")))
+  (if (not file-name) (setq file-name (buffer-file-name)))
+  (let* ((dirname (file-name-directory file-name))
+          (cmd (concat "git -C " (shell-quote-argument dirname) " rev-parse --show-toplevel 2>/dev/null")))
+    (ark-chomp (shell-command-to-string cmd))))
+
+(defun github-markdown-server-start (directory port file-name)
+  "Start a github-markdown-server for DIRECTORY on PORT and open FILE-NAME."
+  (let ((cmd (concat
+               "github-markdown-server"
+               " --directory=" (shell-quote-argument directory)
+               " --port=" (number-to-string port)
+               " " (shell-quote-argument file-name))))
+    (call-process-shell-command cmd nil 0)))
 
 (defun github-markdown-serve  (&optional file-name)
   "Get the base of a git repository for FILE-NAME (or the current buffer)."
   (interactive (list (buffer-file-name)))
+  (ark-reuse-or-start-server file-name 'github-markdown-server-start)
+  )
+
+(defun ark-reuse-or-start-server (file-name start-command &optional path-name-fixer)
+  "Reuse a server if we can, otherwise start a new server.
+FILE-NAME what we are serving.
+START-COMMAND the command to start a server."
+  (if (not path-name-fixer) (setq path-name-fixer (lambda (file-name path-name) path-name)))
   (let ((base (git-base file-name)) (server nil) (server-running nil))
     ;;;
     (progn
-      (if (< (length base) 1) (setq base (directory-file-name file-name)))
+      (if (< (length base) 1) (setq base (file-name-directory file-name)))
       ;; find a server that might still be running
-      (setq server (cl-reduce (lambda (a b)
-                             (if (and (string= (car b) (substring base 0 (length (car b))))
-                                   (or (not (car a)) (< (length (car b)) (length (car a)))))
-                               b a)) (cons nil github-markdown-servers)))
+      (setq server
+        (cl-reduce (lambda (a b)
+                     (if (and (string= (car b) (substring base 0 (min (length base) (length (car b)))))
+                           (or (not (car a)) (< (length (car b)) (length (car a)))))
+                       b a)) (cons nil github-markdown-servers)))
       (if (and server
             (progn
               (message (concat "Checking if server running at" (prin1-to-string server)))
@@ -43,58 +72,112 @@
               (shell-quote-argument
                 (concat "http://localhost:"
                   (number-to-string (cdr server))
-                  (substring file-name (length (car server))))))))
+                  (funcall path-name-fixer file-name (substring file-name (length (car server)))))))))
         (progn
           (if server
             (message (concat "re-starting github-markdown-server on port:" (number-to-string (cdr server))))
             (progn
               ;; find the next available port
               (while (< 0 (length (shell-command-to-string
-                       (concat "lsof -n -i4TCP:" (number-to-string github-markdown-server-port) " | grep LISTEN"))))
+                                    (concat "lsof -n -i4TCP:" (number-to-string github-markdown-server-port) " | grep LISTEN"))))
                 (setq github-markdown-server-port (+ github-markdown-server-port 1)))
 
-              (setq server (cons base github-markdown-server-port)))
-              (message (concat "starting github-markdown-server on port:" (number-to-string (cdr server)))))
-          (call-process-shell-command
-            (concat "github-markdown-server"
-              " --directory=" (shell-quote-argument (car server))
-              " --port=" (number-to-string (cdr server))
-              " " (shell-quote-argument file-name))
-            nil 0)
-          (if (not server)
-            (progn
+              (setq server (cons base github-markdown-server-port))
+              (message (concat "starting server on port:" (number-to-string (cdr server))))
               (add-to-list 'github-markdown-servers server)
-              (setq github-markdown-server-port (+ github-markdown-server-port 1))))))
+              (setq github-markdown-server-port (+ github-markdown-server-port 1))))
+          (funcall start-command (car server) (cdr server) file-name)))
       (message ""))))
 
+(defun jekyll-get-permalink-from-file (file-name path-name)
+  "Get a permalink from FILE-NAME or work it out from suggest PATH-NAME."
+  ;;(read-string (concat file-name "   ---   " path-name))
+  (if (not (string= path-name "/"))
+    (with-temp-buffer
+      (insert-file-contents file-name)
+      (goto-char (point-min))
+      (if (= (search-forward-regexp "^---" 6 't) 4)
+        (progn
+          (goto-char (+ (point-min) 3))
+          (if (search-forward-regexp "^---" (point-max) 't)
+            (let ((bound (point)))
+              (goto-char (point-min))
+              (if (search-forward-regexp "^permalink: \\(.*\\)$" bound 't)
+                (setq path-name (match-string 1)))))))))
+  path-name)
+
+(defun jekyll-fix-path-name (file-name path-name)
+  "Work out the pathname that FILE-NAME will be served at (PATH-NAME is our best guess right now)."
+  (setq path-name (replace-regexp-in-string "\\.md$" ".html" path-name))
+  (jekyll-get-permalink-from-file file-name
+    (cond
+      ((string-match "^/_posts/\\([0-9][0-9][0-9][0-9]\\)-\\([0-9][0-9]\\)-[0-9][0-9]-\\(.*\\)" path-name)
+        (concat "/" (match-string 1 path-name) "/" (match-string 2 path-name) "/" (match-string 3 path-name)))
+      ((string-match "^/[^_]" path-name) path-name)
+      ('t "/"))))
+
+(defun jekyll-server-start (directory port file-name)
+  "Start a Jekyll server for DIRECTORY on PORT and open FILE-NAME."
+  (require 'rvm)
+  (rvm-use-default)
+  (let* (
+          (url (concat "http://localhost:" (number-to-string port)
+                 (jekyll-fix-path-name file-name (substring file-name (length directory)))))
+          (cmd (concat
+                 "cd " (shell-quote-argument directory)
+                 ";jekyll serve -q "
+                 " --port " (number-to-string port)
+                 ";open  " (shell-quote-argument url))))
+    (call-process-shell-command cmd nil 0)))
+
+(defun jekyll-file-p (file-name)
+  "Is FILE-NAME part of a jekyll site."
+  (string-match "\.github\.io/" file-name))
+
+(defun jekyll-serve-file (&optional file-name)
+  "Find or start a server to serve FILE-NAME from a jekyll site."
+  (interactive (buffer-file-name))
+  (ark-reuse-or-start-server file-name 'jekyll-server-start 'jekyll-fix-path-name)
+  )
+
+
 (defun view-file-in-browser (&optional file-name)
-  "Open up file on github or via a local markdown server.
+  "Open up file in one of four ways.
+
+1) on a local Jekyll server if the path contains .github.io/ (requires rvm.el)
+2) via a local https://rubygems.org/gems/github-markdown-server
+3) on github (if file is in a github.com repository)
+4) via a file:/// url (last resort)
 FILE-NAME will be current buffer if not specified.
-Prefix arg \[universal-argument] to not run local server for markdown files."
+Prefix arg \[universal-argument] to not run local server and open on github or via file://."
   (interactive (list (buffer-file-name)))
-  (if (and (not current-prefix-arg) (string-match "\.md$" file-name))
-    (github-markdown-serve file-name)
-    (call-process-shell-command
-      ;; open it with the default webbrowser The Mac::InternetConfig stuff)
-      ;; open either on github or a local file (the remove.origin.url stuff)
-      (concat "open -a \"$(VERSIONER_PERL_PREFER_32_BIT=1 "
-        "perl -MMac::InternetConfig -le 'print +(GetICHelper \"http\")[1]')\" \"$("
-        "perl -e 'use File::Basename; $f = shift @ARGV; $d = dirname($f); $b = basename($f); "
-        "$o = `git -C $d config --get remote.origin.url`; "
-        "if ($o =~ qr!git(@|://)github.com[:/]!) { "
-        "  $o =~ s!git(@|://)github.com[:/](.*).git$!https://github.com/$2!; "
-        "} else { $o = \"\" }"
-        "$p = `git -C $d rev-parse --show-prefix`; "
-        "chomp($o, $p); "
-        "if ($o) { print \"$o/blob/master/$p$b\"; } else { print \"file://$f\" }' "
-        (shell-quote-argument (buffer-file-name)) ")#L"
-        (if (region-active-p)
-          (concat
-            (number-to-string (line-number-at-pos (region-beginning))) "-"
-            (number-to-string (line-number-at-pos (region-end))))
-          (number-to-string (line-number-at-pos)))
+  (cond
+    ((and (not current-prefix-arg) (jekyll-file-p file-name))
+      (jekyll-serve-file file-name))
+    ((and (not current-prefix-arg) (string-match "\.md$" file-name))
+      (github-markdown-serve file-name))
+    ('t
+      (call-process-shell-command
+        ;; open it with the default webbrowser The Mac::InternetConfig stuff)
+        ;; open either on github or a local file (the remove.origin.url stuff)
+        (concat "open -a \"$(VERSIONER_PERL_PREFER_32_BIT=1 "
+          "perl -MMac::InternetConfig -le 'print +(GetICHelper \"http\")[1]')\" \"$("
+          "perl -e 'use File::Basename; $f = shift @ARGV; $d = dirname($f); $b = basename($f); "
+          "$o = `git -C $d config --get remote.origin.url`; "
+          "if ($o =~ qr!git(@|://)github.com[:/]!) { "
+          "  $o =~ s!git(@|://)github.com[:/](.*).git$!https://github.com/$2!; "
+          "} else { $o = \"\" }"
+          "$p = `git -C $d rev-parse --show-prefix`; "
+          "chomp($o, $p); "
+          "if ($o) { print \"$o/blob/master/$p$b\"; } else { print \"file://$f\" }' "
+          (shell-quote-argument (buffer-file-name)) ")#L"
+          (if (region-active-p)
+            (concat
+              (number-to-string (line-number-at-pos (region-beginning))) "-"
+              (number-to-string (line-number-at-pos (region-end))))
+            (number-to-string (line-number-at-pos)))
           "\"")
-      nil 0)))
+        nil 0))))
 
 (provide 'github-markdown-server)
 ;;; github-markdown-server ends here

data/lib/github-markdown-server/version.rb

@@ -1,3 +1,3 @@
 module GithubMarkdownServer
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-markdown-server
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alex K (wtwf.com)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-13 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markdown-preview