kramdown-service 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bb6c0ae34cd14bb0e341d06335f2566e2690eab
-  data.tar.gz: d62c7a076b8c362acb2206f2bf536631917e54d8
+  metadata.gz: 41dd07d48ed67c255c39b46e71c8493186055b4b
+  data.tar.gz: e65a3defc5c2df215b1c07bff78eb9171bbafe09
 SHA512:
-  metadata.gz: 1ef87eaf533a9cffa0d49c648465dd28a053b2ee081a95f1bdb6659e492a743b5873fc4161d22ca72e3552b812680ba58ac19f36a2cdbbe1cf30a54a590d4f8a
-  data.tar.gz: 6082b5ea11b37ddfb1310c4afcd9b52e0276d057bf9f2df3b714833464618a8b8b598ebc7e50e0cef58fd85a7e8b4dbe266e7385fb05157085f926189e775464
+  metadata.gz: c5888bbad01662d9f78c436a2fa16910954871b3dcf0dbf730e337df0a8e3bc5f10154f327098c0b9500f804841c450b18725d237c2bf81ca8a210ae3fdbba8d
+  data.tar.gz: 4f34a2085f07012be2e28fa916cd9d943fd8fc6d362f7fcf015d91ccce4e097ca7d4b12c8303b7b4d9db832d204e25ae412609ca4cd0fd1b19ee401f2d3d7360

data/Manifest.txt

@@ -13,13 +13,10 @@ lib/kramdown/service/public/js/lib3rd/jquery-2.0.1.min.js
 lib/kramdown/service/public/js/markdown.note.js
 lib/kramdown/service/public/style.css
 lib/kramdown/service/version.rb
-lib/kramdown/service/views/_about.erb
 lib/kramdown/service/views/_debug.erb
 lib/kramdown/service/views/_editor.erb
 lib/kramdown/service/views/_editor_head.erb
 lib/kramdown/service/views/_editor_setup.erb
-lib/kramdown/service/views/_libs.erb
-lib/kramdown/service/views/_libs_service.erb
 lib/kramdown/service/views/_service.erb
 lib/kramdown/service/views/_version.erb
 lib/kramdown/service/views/debug.erb
@@ -27,3 +24,7 @@ lib/kramdown/service/views/editor.erb
 lib/kramdown/service/views/index.erb
 lib/kramdown/service/views/layout.erb
 lib/kramdown/service/views/service.erb
+test/helper.rb
+test/test_babelmark.rb
+test/test_kramdown.rb
+test/test_markdown.rb

data/README.md

@@ -6,11 +6,34 @@
 * rdoc  :: [rubydoc.info/gems/kramdown-service](http://rubydoc.info/gems/kramdown-service)
 
 
-## Usage - Web Service / HTTP (JSON) API - `GET /markdown`
+## Live Version
 
 Try the `markdown` HTTP (JSON) API running
 on Heroku [`trykramdown.herokuapp.com`](http://trykramdown.herokuapp.com).
 
+Note: If you see an Application Error on Heroku. Sorry. It means "**Free app running time quota exhausted**".
+Please, check back in a day (or use `$ kramup` to run the service on your local machine). Thanks.
+
+
+## Start Your Own Local Version / Service
+
+To start your own local version on your own machine use the bundled command line tool called `kramup`.
+
+Step 0 - Install the gem e.g.
+
+    $ gem install kramdown-service
+
+Step 1 - Start the server / service e.g.
+
+    $ kramup
+    
+Step 2 - Open up the editor page in your browser e.g. use `http://localhost:4567`.
+
+That's it. 
+
+
+## Usage - Web Service / HTTP (JSON) API - `GET /markdown`
+
 
 Example 1 - Converting to Hypertext (HTML):
 

data/lib/kramdown/service.rb

@@ -78,12 +78,12 @@ class Service < Sinatra::Base
   # return hypertext (html)    ## allow /markdown  or /m
   get %r{/(markdown|m)$} do
 
-    text = params.delete('text')
+    text = params.delete('text') || ''      ## if no text param supplied, use empty/blank string
     to   = params.delete('to')   || 'html'  ## optional - default to html
     opts = params_to_opts( params )
  
     if ['latex','l','tex'].include?( to.downcase )
-      content_type 'text/latex'
+      content_type 'text/latex'     ### todo: check if latex content_type exists?
       text_to_latex( text, opts )
     else  ## assume html (default)
       content_type 'text/html'
@@ -98,7 +98,7 @@ class Service < Sinatra::Base
   #  note: defaults (uses) GFM - github-flavored markdown mode/input
   #  note: only supports html for now (e.g. does NOT support to=html|latex option etc.)
   get '/babelmark' do
-    text = params.delete('text')
+    text = params.delete('text') || ''    ## if no text param supplied, use empty/blank string
             
     data = {
       name:   'kramdown',
@@ -110,6 +110,15 @@ class Service < Sinatra::Base
   end
 
 
+  get %r{/(options|opts|o)$} do    ## for debugging/testing "dump" options  
+    content_type 'text/plain'
+  
+    opts = preprocess_opts( params_to_opts( params ))
+    doc = Kramdown::Document.new( '', opts )
+    doc.options.inspect
+  end
+
+
   get '/d*' do
     erb :debug
   end
@@ -156,13 +165,19 @@ private
   def preprocess_opts( opts )
     ### special case for input opt
     ##     always default to gfm (github-flavored markdown) for now
-
+    
     input = opts.delete( 'input' ) || 'GFM'
+
     if ['classic', 'std', 'standard', 'kramdown' ].include?( input.downcase )
        ## skip; "pseudo" input options map to no (zero) standard/classic input
+    elsif ['gfm'].include?( input.downcase )
+      ## note: GFM **MUST** be uppercase (gets converted to a matching ruby parser class)
+      opts[ 'input' ] = 'GFM'
+      ## in gfm mode (auto-)add hard_wrap = false unless set
+      opts['hard_wrap'] = false   if opts['hard_wrap'].nil?
     else
       opts[ 'input' ] = input
-    end
+    end    
 
     puts "opts (preprocessed/effective):"
     pp opts

data/lib/kramdown/service/docs/welcome.md

@@ -4,9 +4,10 @@
 
 ### Heading 3
 
-Welcome to [Markdown](/). We hope you **really** enjoy using this.
+Welcome to the [kramdown Online Editor](/). We hope you **really** enjoy using this.
 
-Just type some [markdown](http://en.wikipedia.org/wiki/Markdown) on the left and see it on the right. *Simple as that.*
+Just type some [markdown](http://en.wikipedia.org/wiki/Markdown)
+on the left and see it on the right. *Simple as that.*
 
 > Quote goes here.
 

data/lib/kramdown/service/public/css/markdown/themes/basic.css

@@ -11,6 +11,11 @@
     text-decoration: underline;
   }
 
+  .markdown a:hover {
+    background-color: gold;
+  }
+
+
   .markdown em {
     background-color: #fffeca;
     padding: 0 0.08em;

data/lib/kramdown/service/public/style.css

@@ -1,15 +1,26 @@
 body {
   font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; }
 
+
 a, a:visited  {
-  color: #8B0000;
+  color: black;     /* was #8B0000; */
   text-decoration: none; }
 
   a:hover {
-    color:  #8B0000;
-    background-color: gold;
+    color: black; /* was #8B0000; */
     text-decoration: underline; }
 
+.header .title a,
+.header .title a:visited {
+  text-decoration: none;
+}
+
+.footer {
+  margin: 10px;
+}
+
+
+
 .params {
   color: green;
   font-style: italic;

data/lib/kramdown/service/version.rb

@@ -3,7 +3,7 @@
 module KramdownService
 
   MAJOR = 0
-  MINOR = 2
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/lib/kramdown/service/views/_debug.erb

@@ -25,3 +25,14 @@
   request.ip              <%= request.ip %>
 </pre>
 
+
+<h4>kramdown opts</h4>
+
+<%
+  doc = Kramdown::Document.new( '', preprocess_opts( params_to_opts( params )) )
+%>
+
+<pre>
+<%= JSON.pretty_generate( doc.options ) %>
+</pre>
+

data/lib/kramdown/service/views/_editor.erb

@@ -1,6 +1,33 @@
 
 <%= erb :'_editor_setup' %>
 
+<table width="100%">
+<tr>
+  <td>
+
+
+    <span>
+      Use <select id='note-lib'></select>
+    </span> 
+
+    <br>
+    <a id='output-update' href='#'>[ Update ]</a>
+
+    <!-- nb: div will break/start new line -->
+    <div id='output-loading'></div>
+
+  </td>
+  
+  <td>
+    <div style="font-size: 80%;">
+      Options: <br>
+        <a id='input-toggle' href='#'>[ Use White Color Theme ]</a>
+        <a id='output-toggle' href='#'>[ Show HTML ]</a>
+    </div>
+  </td>
+<div>
+
+
 
 <table width='100%'>
  <colgroup>
@@ -24,24 +51,4 @@
 
    </td>
  </tr>
- <tr>
-  <td>
-    <!-- first column -->
-
-    <span>
-      Use <select id='note-lib'></select>
-    </span>
-
-    <a id='output-update' href='#'>[ Update ]</a>
-    <a id='input-toggle' href='#'>[ Use White Color Theme ]</a>
-
-     <!-- nb: div will break/start new line -->
-     <div id='output-loading'></div>
-  </td>
-  <td style='vertical-align: top;'>
-     <!-- second column -->
-     <a id='output-toggle' href='#'>[ Show HTML ]</a>
-     
-  </td>
- </tr>
 </table>

data/lib/kramdown/service/views/_service.erb

@@ -14,7 +14,7 @@
  <li><b>text</b> - <em>Required</em> string - The markdown text to render</li>
 </ul>
 <ul>
- <li><b>to</b> - <em>Optional</em> html|latex  string - The format to use</li>
+ <li><b>to</b> - <em>Optional</em>  string - The format to use e.g. html|latex</li>
 </ul>
 
 

data/lib/kramdown/service/views/_version.erb

@@ -1,6 +1,8 @@
 <div class='version'>
   <a href="http://groups.google.com/group/wwwmake">Questions? Comments?</a> |
-  <a href="https://github.com/writekit/kramdown-service">kramdown-service/<%= KramdownService::VERSION %></a> using 
+  <span>
+    <a href="https://github.com/writekit/kramdown-service">kramdown-service/<%= KramdownService::VERSION %></a> using 
+  </span>
   <a href="https://github.com/gettalong/kramdown">kramdown/<%= Kramdown::VERSION %></a> - 
   <span>Ruby/<%= "#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}/#{RUBY_PLATFORM})" %> on</span>
   <span>Sinatra/<%= Sinatra::VERSION %> (<%= ENV['RACK_ENV'] %>)</span>

data/lib/kramdown/service/views/index.erb

@@ -3,14 +3,6 @@
 <%= erb :'_editor' %>
 
 
-<%= erb :'_libs' %>
-
-
-<%= erb :'_service' %>
-
-
-<%= erb :'_about' %>
-
 <!--
 <hr>
 

data/lib/kramdown/service/views/layout.erb

@@ -9,9 +9,29 @@
 </head>
 <body>
 
+
+<table width="100%" class="header">
+  <tr>
+    <td class="title">
+      <h1><a href="/">kramdown Online Editor</a></h1>
+    </td>
+    <td align="right">
+       <a href="/service">HTTP JSON API Service</a>  •
+       <a href="https://github.com/writekit/kramdown-service">About</a>
+    </td>
+  </tr>
+</table>
+
+
 <%= yield %>
 
+
+<div class="footer" align="center">
+    Brought to you by <a href="http://manuscripts.github.io">Manuscripts</a> and friends.
+</div>
+
 <%= erb :'_version' %>
 
+
 </body>
 </html>

data/lib/kramdown/service/views/service.erb

@@ -1,7 +1,6 @@
 
 <%= erb :'_service' %>
 
-<%= erb :'_libs_service' %>
 
 <!--
 <hr>

data/test/helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+# minitest setup
+require 'minitest/autorun'
+
+
+## our own code
+require 'kramdown/service'
+
+

data/test/test_babelmark.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_babelmark.rb
+
+
+ENV['RACK_ENV'] = 'test'   ## move to helper - why? why not??
+
+
+require 'helper'
+
+require 'rack/test'    ## move to helper - why? why not??
+
+
+class TestBabelmark < MiniTest::Test
+  include Rack::Test::Methods
+
+def app
+  Kramdown::Service
+end
+
+def test_hello_world  
+  get '/babelmark', { text: 'Hello, World!' }
+
+  assert last_response.ok?
+  assert_equal 'application/json', last_response.headers['Content-Type']
+
+  data = JSON.parse( last_response.body )
+  pp data
+  
+  html = "<p>Hello, World!</p>\n"
+  
+  assert_equal 'kramdown',        data['name']
+  assert_equal Kramdown::VERSION, data['version']
+  assert_equal html,              data['html']
+  
+end  # method test_hello_world
+
+def test_nil
+
+  get '/babelmark'
+  
+  assert last_response.ok?
+  assert_equal 'application/json', last_response.headers['Content-Type']
+
+  data = JSON.parse( last_response.body )
+  pp data
+  
+  html ="\n"    # note: empty string w/ kramdown becomes empty string w/ newline
+  
+  assert_equal 'kramdown',        data['name']
+  assert_equal Kramdown::VERSION, data['version']
+  assert_equal html,              data['html']
+end  # method test_nil
+
+
+end # class TestBabelmark
+

data/test/test_kramdown.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_kramdown.rb
+
+
+
+require 'helper'
+
+
+class TestKramdown < MiniTest::Test
+
+
+def test_kramdown
+  
+  text = 'Hello, World!'
+  
+  doc = Kramdown::Document.new( text )
+
+  puts "options:"  
+  pp doc.options
+  
+  html  = "<p>Hello, World!</p>\n"
+  latex = "Hello, World!\n\n"
+  
+  assert_equal html,  doc.to_html
+  assert_equal latex, doc.to_latex
+end  # method test_kramdown
+
+
+def test_gfm_w_rouge
+  
+  text = "A Line.\nAnother Line.\n"
+  
+  doc = Kramdown::Document.new( text,
+                                input: 'GFM',
+                                hard_wrap: false,
+                                syntax_highlighter: 'rouge' )
+
+  puts "options:"  
+  pp doc.options
+  
+  html  = "<p>A Line.\nAnother Line.</p>\n"
+  
+  pp doc.to_html
+  
+  assert_equal html,  doc.to_html
+end  # method test_gfm_w_rouge
+
+
+
+end # class TestKramdown
+

data/test/test_markdown.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_markdown.rb
+
+
+ENV['RACK_ENV'] = 'test'   ## move to helper - why? why not??
+
+
+require 'helper'
+
+require 'rack/test'    ## move to helper - why? why not??
+
+
+class TestMarkdown < MiniTest::Test
+  include Rack::Test::Methods
+
+def app
+  Kramdown::Service
+end
+
+def test_hello_world  
+  get '/markdown', { text: 'Hello, World!' }
+
+  assert last_response.ok?
+  assert_equal 'text/html;charset=utf-8', last_response.headers['Content-Type']
+
+  pp last_response.body
+
+  html = "<p>Hello, World!</p>\n"
+  assert_equal html, last_response.body
+end  # method test_hello_world
+
+
+def test_latex_hello_world  
+  get '/markdown', { text: 'Hello, World!', to: 'latex' }
+
+  assert last_response.ok?
+  assert_equal 'text/latex;charset=utf-8', last_response.headers['Content-Type']
+
+  pp last_response.body
+
+  latex = "Hello, World!\n\n"
+  assert_equal latex, last_response.body
+end  # method test_latex_hello_world
+
+
+
+end # class TestMarkdown
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-17 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -107,13 +107,10 @@ files:
 - lib/kramdown/service/public/js/markdown.note.js
 - lib/kramdown/service/public/style.css
 - lib/kramdown/service/version.rb
-- lib/kramdown/service/views/_about.erb
 - lib/kramdown/service/views/_debug.erb
 - lib/kramdown/service/views/_editor.erb
 - lib/kramdown/service/views/_editor_head.erb
 - lib/kramdown/service/views/_editor_setup.erb
-- lib/kramdown/service/views/_libs.erb
-- lib/kramdown/service/views/_libs_service.erb
 - lib/kramdown/service/views/_service.erb
 - lib/kramdown/service/views/_version.erb
 - lib/kramdown/service/views/debug.erb
@@ -121,6 +118,10 @@ files:
 - lib/kramdown/service/views/index.erb
 - lib/kramdown/service/views/layout.erb
 - lib/kramdown/service/views/service.erb
+- test/helper.rb
+- test/test_babelmark.rb
+- test/test_kramdown.rb
+- test/test_markdown.rb
 homepage: https://github.com/writekit/kramdown-service
 licenses:
 - Public Domain

data/lib/kramdown/service/views/_about.erb

@@ -1,26 +0,0 @@
-
-
-<h3>Kramdown Service Gem / About</h3>
-
-<p><b>
-What's the <code>kramdown-service</code> gem?
-</b>
-</b>
-
-The kramdown HTTP JSON API service lets you
-convert markdown to HTML or LaTeX.
-
-<a href='https://github.com/writekit/kramdown-service'>Find out more »</a>
-</p>
-
-
-<p>
-<b>Questions? Comments?</b>  
-Send them along to the <a href='http://groups.google.com/group/wwwmake'>wwwmake forum/mailing list</a>.
-Thanks!
-</p>
-
-<p><b>License</b>
-The kramdown-service scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
-</p>

data/lib/kramdown/service/views/_libs.erb

@@ -1,10 +0,0 @@
-
-<h3>Kramdown Library</h3>
-
-<table>
-<tr>
-  <td>kramdown</td>
-  <td><%= Kramdown::VERSION %></td>
-  <td><!-- defaults to be done --></td>
-</tr>
-</table>

data/lib/kramdown/service/views/_libs_service.erb

@@ -1,24 +0,0 @@
-
-<h3>Kramdown Library / Live Examples</h3>
-
-<table class='api'>
-<tr>
-  <td>kramdown</td>
-  <td> / <%= Kramdown::VERSION %></td>
-  <td> - 
- <code>GET
-     <a href='view-source:<%= url("/markdown?text=Hello+World!") %>'>
-        /markdown?text=<em>Hello+World!</em>
-     </a>
- </code>
-  </td>
-  <td>
- <code>&bull; GET
-     <a href='<%= url("/babelmark?text=Hello+World!") %>'>
-        /babelmark?text=<em>Hello+World!</em>
-     </a>
- </code>
-  </td>
-</tr>
-</table>
-