kramdown-service 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 495b9daefa7ff13409c0996204dd715c99242ec8
-  data.tar.gz: 40cc00e2fd372db7d07684ee4bfb71d4d22fe56f
+  metadata.gz: 065d0c7fe06c3a2639983020f3a36bf20cf91850
+  data.tar.gz: c93f8547c5059f71d79fbb9bbaae3e2da700026a
 SHA512:
-  metadata.gz: dab21da522d3036036d084dc39d938092ebb1a5416292672be419695b67ada966ce320146ee343740ce06526345b1503ee32f5b937520454568d7b5330427306
-  data.tar.gz: 64524647d259636125214bbb464f58cb84c8b2ab283c4887f1ba7e475ea6271265938705af656a2949fee19a871b2aeeead662fd2773c72afdf2931eb782b117
+  metadata.gz: f55ec265130e94db23e8a3fcee6a5914ac2b270649476f8084ea4e1bb4be6be44b3a176bb78ea68fabb69c0ffd8663764e813dda3b3b729cc0ad6ace42faff3b
+  data.tar.gz: 4d5137c11efb8524a441427803037000cd94e7b5f0c3cd7b63afac9dfa8d931bff388bc07323861001354399bbfc952dcceca43c66a014f5c6fb22804c64b863

data/Manifest.txt

@@ -7,13 +7,9 @@ lib/kramdown/service/docs/welcome.md
 lib/kramdown/service/public/css/markdown/note.css
 lib/kramdown/service/public/css/markdown/themes/basic.css
 lib/kramdown/service/public/i/dots-white.gif
+lib/kramdown/service/public/js/kramdown.js
 lib/kramdown/service/public/js/lib3rd/jquery-2.0.1.min.js
-lib/kramdown/service/public/js/lib3rd/pagedown.js
-lib/kramdown/service/public/js/lib3rd/showdown.min.js
-lib/kramdown/service/public/js/markdown.api.js
-lib/kramdown/service/public/js/markdown.lib.js
 lib/kramdown/service/public/js/markdown.note.js
-lib/kramdown/service/public/note.html
 lib/kramdown/service/public/style.css
 lib/kramdown/service/version.rb
 lib/kramdown/service/views/_about.erb

data/README.md

@@ -11,6 +11,7 @@
 Try the `markdown` HTTP (JSON) API running
 on Heroku [`trykramdown.herokuapp.com`](http://trykramdown.herokuapp.com).
 
+
 Example 1 - Converting to Hypertext (HTML):
 
     GET /markdown?text=Hello+World!
@@ -20,20 +21,11 @@ Example 1 - Converting to Hypertext (HTML):
 
 Example 2 - Converting to LaTeX:
 
-    GET /markdown?text=Hello+World!&format=latex
+    GET /markdown?text=Hello+World!&to=latex
     
     Hello World!
 
-<!-- todo/check:
-    - use format or output ??? for parameter
-  -->
-
-
-
-## Dependencies / Building Blocks
 
-[Markdown Note](https://github.com/writekit/markdown-note) - Another simple single-page, server-less Markdown editor
-in JavaScript & Hypertext.
 
 
 ## License

data/Rakefile

@@ -14,7 +14,8 @@ Hoe.spec 'kramdown-service' do
   self.email   = 'wwwmake@googlegroups.com'
   
   self.extra_deps = [
-    ['kramdown'],
+    ['kramdown'],  ##  markdown converter
+    ['rouge'],     ## syntax highlighter
     ['sinatra'],
   ]
   

data/lib/kramdown/service.rb

@@ -8,17 +8,15 @@
 #   run Kramdown::Service
 
 
+require 'json'
+
+
 # 3rd party libs/gems
 
 require 'sinatra/base'
 
 require 'kramdown'
 
-
-# require 'logutils'
-# require 'logutils/activerecord'
-
-
 # our own code
 
 require 'kramdown/service/version'   # let version always go first
@@ -44,61 +42,66 @@ class Service < Sinatra::Base
   ##############################################
   # Controllers / Routing / Request Handlers
 
-  def welcome_markdown
-    ## todo: rotate welcome / use random number for index
-    # place markdown docs in server/docs
-     text = File.read( "#{KramdownService.root}/lib/markdown/service/docs/welcome.md" )
-     text
-  end
-
 
   get %r{/(service|services|srv|s)$} do
+    ## just a "live" docu page
     erb :service
   end
 
-  get %r{/(note|notes|n)$} do
-    # for testing/debugging use copied sources 1:1 from markdown-notepad repo
-    redirect '/note.html'
-  end
-
   get %r{/(editor|edit|ed|e)$} do
-    # NB: use editor for "ruby-enhanced" parts of note
-    @welcome_markdown = welcome_markdown
-    @welcome_html = Kramdown::Document.new( @welcome_markdown ).to_html
+    # note: allow optional params e.g. text and opts
+    ##  note: for now only html supported on get form/url params
+    text = params.delete('text') || welcome_markdown
+    to   = params.delete('to')   || 'html'  ## optional - default to html
+    opts = params_to_opts( params )
+
+    @welcome_markdown = text
+    @welcome_html     = text_to_html( text, opts )
 
     erb :editor
   end
 
   get '/' do
-    @welcome_markdown = welcome_markdown
-    @welcome_html = Kramdown::Document.new( @welcome_markdown ).to_html
+    # note: allow optional params e.g. text and opts
+    ##  note: for now only html supported on get form/url params
+    text = params.delete('text') || welcome_markdown
+    to   = params.delete('to')   || 'html'  ## optional - default to html
+    opts = params_to_opts( params )
+
+    @welcome_markdown = text
+    @welcome_html     = text_to_html( text, opts )
 
     erb :index
   end
 
-
-  ## todo: use 3rd party services from markdown.yml (lets you configure)
-  #   e.g. http://johnmacfarlane.net/cgi-bin/pandoc-dingus?text=hi
-
-
-  def markdownify( params, opts={} )
-    pp params
-    text = params[:text]
-    lib  = params[:lib]   # optional
-    pp text
-    pp lib
-
-    Kramdown::Document.new( text, opts ).to_html
-  end
+  # return hypertext (html)    ## allow /markdown  or /m
+  get %r{/(markdown|m)$} do
+
+    text = params.delete('text')
+    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'
+      text_to_latex( text, opts )
+    else  ## assume html (default)
+      content_type 'text/html'
+      text_to_html( text, opts )
+    end
+    
+ end
 
 
   # return babelmark2/dingus-style json
-  get '/markdown/dingus' do
-    html = markdownify( params )
+  # return html wrapped in json (follows babelmark2 dingus service api)
+  #  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')
             
     data = {
-      name:    'kramdown',
-      html:    html,
+      name:   'kramdown',
+      html:    Kramdown::Document.new( text, input: 'GFM' ).to_html,
       version: Kramdown::VERSION
     }
     
@@ -106,34 +109,89 @@ class Service < Sinatra::Base
   end
 
 
-  # return hypertext (html)
-  get '/markdown' do
-    content_type 'text/html'
-    markdownify( params )
+  get '/d*' do
+    erb :debug
   end
 
-  # return html wrapped in json (follows babelfish2 dingus service api)
-  get '/dingus' do
-    html = markdownify( params )
+
+private
+
+  def welcome_markdown
+    ## todo: rotate welcome / use random number for index
+    # place markdown docs in server/docs
+     text = File.read( "#{KramdownService.root}/lib/kramdown/service/docs/welcome.md" )
+     text
+  end
+
+  def params_to_opts( params )
+    ## convert (web form) params to kramdown (ruby) opts
+ 
+    puts "params : #{params.class.name}:"
+    pp params
+       
+    opts = {}
+ 
+    ## map true/false strings to boolean
+    params.each do |k,v|
+      puts " k: >#{k}< : #{k.class.name}, v: >#{v}< : #{v.class.name}"
+      
+      ##  skip "built-in" sinatra "internal" params
+      ##   - todo - use splice and whitelist instead - why? why not?
+      next  if ['splat', 'captures'].include?( k )
             
-    data = {
-      name: 'kramdown',
-      html: html,
-      version: Kramdown::Version
-    }
-    
-    json_or_jsonp( data.to_json )
+      if v.is_a?( String ) && ['t', 'true'].include?( v.downcase ) 
+        opts[ k ] = true
+      elsif v.is_a?( String ) && ['f', 'false'].include?( v.downcase )
+        opts[ k ] = false
+      else
+        opts[ k ] = v
+      end
+    end  
+      
+    opts
   end
 
 
-  get '/d*' do
-    erb :debug
+  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
+    else
+      opts[ 'input' ] = input
+    end
+
+    puts "opts (preprocessed/effective):"
+    pp opts
+
+    opts
+  end
+
+  def text_to_html( text, opts={} )
+    puts "text_to_html:"
+    pp text
+    pp opts
+
+    opts = preprocess_opts( opts )   ## defaults to GFM input etc.
+
+    Kramdown::Document.new( text, opts ).to_html
+  end
+
+  def text_to_latex( text, opts={} )
+    puts "text_to_latex:"
+    pp text
+    pp opts
+
+    opts = preprocess_opts( opts )   ## defaults to GFM input etc.
+
+    Kramdown::Document.new( text, opts ).to_latex
   end
 
 
 ### helper for json or jsonp response (depending on callback para)
 
-private
 def json_or_jsonp( json )
   callback = params.delete('callback')
   response = ''

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

@@ -1,8 +1,8 @@
-# Header 1
+# Heading 1
 
-## Header 2
+## Heading 2
 
-### Header 3
+### Heading 3
 
 Welcome to [Markdown](/). We hope you **really** enjoy using this.
 

data/lib/kramdown/service/public/js/kramdown.js

@@ -0,0 +1,64 @@
+
+
+var kramdown_new = function( opts ) {
+
+  var settings;  // NB: defaults + opts merged => settings
+    
+  var defaults = {
+    api_url: 'http://trykramdown.herokuapp.com/markdown'
+  }
+
+
+  function _debug( msg )
+  {
+      if(window.console && window.console.log )
+        window.console.log( "[debug] " + msg );
+  }
+
+
+  function _init( opts ) {
+     settings = $.extend( {}, defaults, opts );    
+  }
+
+  _init( opts );
+
+   
+  function _convert( text, more_params, handler )
+  {
+    var params = $.extend( { text: text }, more_params );  // merge in more params; use text for required param
+    
+    $.get( settings.api_url, params, function( data ) {
+      handler( data ); 
+    });
+  }
+  
+  function convert_to_html( text, handler ) {
+    // note: make gfm (github-flavored markdown) the default parser
+    _convert( text, { to: 'html' }, handler );
+  }
+
+  function convert_to_html_with_syntax_highlighter( text, handler ) {
+    // note: make gfm (github-flavored markdown) the default parser
+    _convert( text, { to: 'html', syntax_highlighter: 'rouge' }, handler );
+  }
+
+  function convert_to_html_with_classic( text, handler ) {
+    // note: use "classic" "standard" kramdown parser/reader
+    _convert( text, { to: 'html', input: 'classic' }, handler );
+  }
+
+
+  
+  function convert_to_latex( text, handler ) {
+    _convert( text, { to: 'latex' }, handler );
+  }
+  
+  return {
+    convert_to_html:  convert_to_html,
+    convert_to_html_with_syntax_highlighter: convert_to_html_with_syntax_highlighter,
+    convert_to_html_with_classic: convert_to_html_with_classic,
+    convert_to_latex: convert_to_latex
+  }
+
+} // fn kramdown_new
+

data/lib/kramdown/service/public/js/markdown.note.js

@@ -4,15 +4,28 @@ var markdown_note_new = function( opts ) {
 
     // use module pattern (see JavaScript - The Good Parts)
 
+        
+    var getUrl  = window.location;
+    // note: host includes hostname + port; yes!
+    var baseUrl = getUrl.protocol + "//" + getUrl.host;
+    
+    console.log( window.location );
+    console.log( baseUrl );
+
+    
+    var kramdown = kramdown_new( { api_url: baseUrl + '/markdown' } );
+    //  e.g. http://localhost:9292/markdown  or http://trykramdown.herokuapp.com/markdown
+    // kramdown api service / engine (see kramdown.js)
+   
     var engines = [
-      { name:    'Standard (Offline)', online: false, markdown: markdown_libs.showdown },
-      { name:    'Standard (Online)',  online: true,  markdown: markdown_apis.ruby  },
-      { name:    'JavaScript - Showdown (Offline)', online: false, markdown: markdown_libs.showdown },
-      { name:    'JavaScript - pagedown (Offline)', online: false, markdown: markdown_libs.pagedown },
-      { name:    'Ruby - kramdown (Online)',  online: true, markdown: markdown_apis.ruby_kramdown },
-      { name:    'Ruby - Redcarpet (Online)', online: true, markdown: markdown_apis.ruby_redcarpet },
-      { name:    'Ruby - Maruku (Online)',    online: true, markdown: markdown_apis.ruby_maruku },
-      { name:    'Ruby - BlueCloth (Online)', online: true, markdown: markdown_apis.ruby_bluecloth }
+      { name:    'kramdown in GitHub-Flavored Markdown (GFM) Mode', format: 'HTML',
+         markdown: kramdown.convert_to_html   },
+      { name:    'kramdown in GitHub-Flavored Markdown (GFM) Mode w/ Syntax Highlighter (rouge)', format: 'HTML',
+         markdown: kramdown.convert_to_html_with_syntax_highlighter   },
+      { name:    'kramdown in "Classic" Mode', format: 'HTML',
+         markdown: kramdown.convert_to_html_with_classic   },
+      { name:    'kramdown in GitHub-Flavored Markdown (GFM) Mode', format: 'LaTeX',
+         markdown: kramdown.convert_to_latex  }
     ];
 
     var welcome = {
@@ -69,7 +82,29 @@ var markdown_note_new = function( opts ) {
 
     var show_html = false;
     var use_white_color_theme = false;
+    var show_latex = false;
+    
+    function show_latex_output() {
+       show_latex = true;
 
+       $output.hide();
+       $output_toggle.hide();   //  hide toggle show html button
+       $output_source.show();
+    }
+    
+    function restore_html_output() {
+       // restore output view to before entering "latex" mode
+       if (show_latex == true) {
+          show_latex = false;
+          
+          $output_toggle.show();
+          if( !show_html ) {    // switch back in "preview" mode ?
+            $output_source.hide();
+            $output.show();
+          }
+       }
+    }
+    
     function toggle_output()
     {
       show_html = !show_html;
@@ -112,13 +147,17 @@ var markdown_note_new = function( opts ) {
 
       var engine = settings.engines[engine_index];
 
-      if( engine.online === true )
-         $output_loading.show();
+      $output_loading.show(); // show progress bar/spinner
 
       engine.markdown( text, function( html ) {
          $output.html( html );
          $output_source.html( html );
          $output_loading.hide();
+         
+         if( engine.format == 'LaTeX' )    // for latex always show source (only)
+           show_latex_output();   
+         else
+           restore_html_output();
       });
     }
 
@@ -126,8 +165,7 @@ var markdown_note_new = function( opts ) {
    function _init( opts )
    {
      settings = $.extend( {}, defaults, opts );
-
-
+     
      $output         = $( settings.output );
      $output_source  = $( settings.output_source );
      $output_update  = $( settings.output_update );
@@ -157,7 +195,7 @@ var markdown_note_new = function( opts ) {
         if( index == 0 ) {
           markdown_opts += 'selected="selected"'
         }
-        markdown_opts += '>' + engine.name + '</option>';
+        markdown_opts += '>' + engine.format + ' - ' + engine.name + '</option>';
         
         _debug( 'add markdown engine [' + index + ']: ' + engine.name );
      });