markview 0.2.4 → 0.3.0

data/README.md

@@ -1,25 +1,45 @@
 # Markview
 
-Markview allows you to view nearly any and all markup formatted files in a slick way. Markview is inspired by the python library [restview](http://mg.pov.lt/restview/). As of v0.2.0, I've decided to extend markview to render virtually any and all markup formatted README's or what-have-you using the [github-markup](http://www.github.com/defunkt/github-markup) library.
+Markview allows you to view nearly any and all markup formatted files in a slick way. Markview is inspired by the python library [restview](http://mg.pov.lt/restview/). Markview has the ability to render virtually any and all markup formatted files using the [github-markup](http://www.github.com/defunkt/github-markup) library.
 
 ## Install
 
-New releases of Markview are published to [gemcutter](http://gemcutter.org/gems/markview)
-
-	$ [sudo] gem install markview
+    $ sudo gem install markview
 
 ## Usage
 
 Markview is very simple to use. Run the gem from the command line and specify
-a README or other markdown file. Markview defaults to finding a README if you choose not to
+a README or other markdown file. Markview defaults to finding a file with the base name README if you choose not to
 specify the file.
 
-	$ markview README.md
-	
+    $ markview README.md
+
 ## Preview
 
-![Markview Preview](http://img.skitch.com/20100225-gt6h7nqqt281hhx4d1qstu7cqm.png)
-	
+![Markview Preview](http://img.skitch.com/20100331-pdee3qerwaxpk49w1qnumspnjb.png)
+
 ## Author
 
-[Mark Sands](http://github.com/marksands) :: marksands07@gmail.com
+[Mark Sands](http://github.com/marksands) :: marksands07@gmail.com
+
+## License
+
+Copyright (c) 2010, 2011 Mark Sands
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/markview

@@ -9,4 +9,4 @@ end
 require File.expand_path(File.dirname(__FILE__) + "/../lib/markview")
 
 use Rack::ShowExceptions
-Vegas::Runner.new(Markview::Application, 'markview', :foreground => true )
+Vegas::Runner.new(Markview, 'markview', :foreground => true )

data/lib/markview.rb

@@ -1,29 +1,47 @@
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
 require 'sinatra'
+require 'json'
 require 'github/markup'
 
-module Markview
-  class Application < Sinatra::Base    
-    dir = File.dirname(File.expand_path(__FILE__))
-    
-    set :views,  "#{dir}/markview/views"
-    set :public, "#{dir}/markview/public"
-    set :static, true
-        
-    # Renders the html using GitHub::Markup
-    def self.markview_me
-      ARGV[0] ||= Dir.glob("README*")[0]
-      begin
-        GitHub::Markup.render(ARGV[0], File.read(ARGV[0]))
-      rescue Errno::ENOENT
-        raise LoadError, "Failed to open document. Please specify a file."; exit
-      end
-    end
+class Markview < Sinatra::Base
+  dir = File.dirname(File.expand_path(__FILE__))
+
+  set :views,  "#{dir}/markview/views"
+  set :public, "#{dir}/markview/public"
+  set :static, true
 
-    get '/' do
-      @markdown = Markview::Application.markview_me
-      @title = ARGV[0].gsub(/(.+\/)?/, '') # /path/to/README.txt => README.txt
-      erb :base
+  configure do
+    @@markup = ARGV[0] ||= Dir.glob("README*")[0]
+    unless File.file?(@@markup)
+      raise LoadError, "Failed to open document. Please specify a file."; exit!
     end
-  end   
+  end
+
+  # Renders the html using GitHub::Markup
+  def self.render
+    GitHub::Markup.render(@@markup, File.read(@@markup))
+  end
+
+  get '/' do
+    @markdown = Markview.render
+    @title = File.basename(@@markup)
+    erb :base
+  end
+
+  get '/preview' do
+    @markdown = Markview.render
+    ({:error => false, :data => @markdown}).to_json
+  end
+
+  get '/edit' do
+    @markdown = File.read(@@markup)
+    ({:error => false, :data => "<textarea id='editbox'>#{@markdown}</textarea>"}).to_json
+  end
+
+  post '/save' do
+    return ({:error => true, :message => "Failed to save file!"}).to_json unless request['markup']
+    File.open(@@markup, 'w') { |f| f.write(request['markup']) }
+    ({:error => false, :message => "File succesfully saved!"}).to_json
+  end
+
 end

data/lib/markview/public/app.js

@@ -0,0 +1,47 @@
+$(document).ready(function() {
+
+  $('.last').hide();
+
+  $('#save').click(function(e){
+    e.preventDefault();
+    $.post("/save", { markup: $('#editbox').val() }, function(response) {
+      if ( response.error == true ) {
+        $(function () {
+          $.notifyBar({
+            cls: 'error',
+            html: response.message,
+            delay: 2000,
+            animationSpeed: "normal"
+          });
+        });
+      }
+      else {
+        $(function () {
+          $.notifyBar({
+            cls: 'success',
+            html: response.message,
+            delay: 2000,
+            animationSpeed: "normal"
+          });
+        });
+      }
+    }, 'json');
+  });
+
+  $('#edit').click(function(e){
+    e.preventDefault();
+    $.get('/edit', function(response) {
+      $('#markview-output').html(response.data);
+      $('.last').show();
+    }, 'json');
+  });
+
+  $('#preview').click(function(e){
+    e.preventDefault();
+    $.get('/preview', function(response) {
+      $('#markview-output').html(response.data);
+      $('.last').hide();
+    }, 'json');
+  });
+
+});

data/lib/markview/public/jquery.notifyBar.css

@@ -0,0 +1,37 @@
+/*
+*  Notify Bar - jQuery plugin
+*
+*  Copyright (c) 2009-2010 Dmitri Smirnov
+*
+*  Licensed under the MIT license:
+*  http://www.opensource.org/licenses/mit-license.php
+*  
+*  Version: 1.2
+*
+*  Project home:
+*  http://www.dmitri.me/blog/notify-bar
+*/
+
+.jquery-notify-bar {
+  width:100%;
+  position:fixed;
+  top:0;
+  left:0;
+  z-index:32768;
+  background-color:#efefef;
+  font-size:18px;
+  color:#000;
+  text-align:center;
+  font-family: Arial, Verdana, sans-serif;
+  padding:20px 0px;
+  border-bottom:1px solid #bbb;
+  cursor: pointer;
+}
+.jquery-notify-bar.error {
+  color:#f00;
+  background-color:#fdd;
+}
+.jquery-notify-bar.success {
+  color:#060;
+  background-color:#BBFFB6;
+}

data/lib/markview/public/jquery.notifyBar.js

@@ -0,0 +1,109 @@
+/*
+* Notify Bar - jQuery plugin
+*
+* Copyright (c) 2009-2010 Dmitri Smirnov
+*
+* Licensed under the MIT license:
+* http://www.opensource.org/licenses/mit-license.php
+*
+* Version: 1.2.2
+*
+* Project home:
+* http://www.dmitri.me/blog/notify-bar
+*/
+ 
+/**
+* param Object
+*/
+jQuery.notifyBar = function(settings) {
+  
+  (function($) {
+    
+    var bar = notifyBarNS = {};
+    notifyBarNS.shown = false;
+     
+    if( !settings) {
+    settings = {};
+    }
+    // HTML inside bar
+    notifyBarNS.html = settings.html || "Your message here";
+     
+    //How long bar will be delayed, doesn't count animation time.
+    notifyBarNS.delay = settings.delay || 2000;
+     
+    //How long notifyBarNS bar will be slided up and down
+    notifyBarNS.animationSpeed = settings.animationSpeed || 200;
+     
+    //Use own jquery object usually DIV, or use default
+    notifyBarNS.jqObject = settings.jqObject;
+     
+    //Set up own class
+    notifyBarNS.cls = settings.cls || "";
+    
+    //close button
+    notifyBarNS.close = settings.close || false;
+    
+    if( notifyBarNS.jqObject) {
+      bar = notifyBarNS.jqObject;
+      notifyBarNS.html = bar.html();
+    } else {
+      bar = jQuery("<div></div>")
+      .addClass("jquery-notify-bar")
+      .addClass(notifyBarNS.cls)
+      .attr("id", "__notifyBar");
+    }
+         
+    bar.html(notifyBarNS.html).hide();
+    var id = bar.attr("id");
+    switch (notifyBarNS.animationSpeed) {
+      case "slow":
+      asTime = 600;
+      break;
+      case "normal":
+      asTime = 400;
+      break;
+      case "fast":
+      asTime = 200;
+      break;
+      default:
+      asTime = notifyBarNS.animationSpeed;
+    }
+    if( bar != 'object'); {
+      jQuery("body").prepend(bar);
+    }
+    
+    // Style close button in CSS file
+    if( notifyBarNS.close) {
+      bar.append(jQuery("<a href='#' class='notify-bar-close'>Close [X]</a>"));
+      jQuery(".notify-bar-close").click(function() {
+        if( bar.attr("id") == "__notifyBar") {
+          jQuery("#" + id).slideUp(asTime, function() { jQuery("#" + id).remove() });
+        } else {
+          jQuery("#" + id).slideUp(asTime);
+        }
+        return false;
+      });
+    }
+    
+  // Check if we've got any visible bars and if we have, slide them up before showing the new one
+  if($('.jquery-notify-bar:visible').length > 0) {
+    $('.jquery-notify-bar:visible').stop().slideUp(asTime, function() {
+      bar.stop().slideDown(asTime);
+    });
+  } else {
+    bar.slideDown(asTime);
+  }
+  
+  // Allow the user to click on the bar to close it
+  bar.click(function() {
+    $(this).slideUp(asTime);
+  })
+     
+  // If taken from DOM dot not remove just hide
+  if( bar.attr("id") == "__notifyBar") {
+    setTimeout("jQuery('#" + id + "').stop().slideUp(" + asTime +", function() {jQuery('#" + id + "').remove()});", notifyBarNS.delay + asTime);
+  } else {
+    setTimeout("jQuery('#" + id + "').stop().slideUp(" + asTime +", function() {jQuery('#" + id + "')});", notifyBarNS.delay + asTime);
+  }
+
+})(jQuery) };

data/lib/markview/public/style.css

@@ -9,7 +9,7 @@ body { line-height:1; color:black; background: white; }
 ol,ul { list-style:none; }
 table { border-collapse:separate; border-spacing:0; }
 caption,th,td { text-align:left; font-weight:normal; }
-blockquote:before,blockquote:after,q:before,q:after {	content:""; } 
+blockquote:before,blockquote:after,q:before,q:after { content:""; } 
 blockquote,q { quotes:"" ""; }
 
 .clear:after { clear:both; content:""; display:block; height:0; zoom:1; }
@@ -24,6 +24,25 @@ div#content {margin:2% auto; position:relative; width:920px; }
 div#content > div { float:left; }
 div#content div#markview-output { border: 1px solid #E9E9E9; background:#F8F8F8; padding:10px; overflow-y:auto; min-width:900px;}
 
+.meta { min-width:910px;}
+.meta { background: #eee url(http://assets1.github.com/images/modules/commit/file_head.gif) repeat-x 0px 0px;
+  border:1px solid #e9e9e9;border-bottom:1px solid #ccc;color:#333;height:33px;line-height:33px;font-size:12px;padding:0px 5px; }
+.meta ul { float:right;height:33px;line-height:33px;padding:0;margin:0; }
+.meta ul li { float:left; list-style-type:none; margin: 8px 0 0 10px; }
+.meta ul li.last { background: url(http://assets1.github.com/images/modules/commit/action_separator.png) no-repeat 0px 50%; margin: 8px 4px 0 10px; }
+.meta ul li a { color:#4183C4;font-weight:bold; text-decoration:none;outline:none;line-height:1.4em;margin:0 0 0 10px;}
+
+textarea {
+  width: 99%;
+  height: 600px!important;
+  padding:0!important;
+  margin:0!important;
+  resize: none;
+  font-size: 1.1em;
+  background-color: rgb(253, 253, 253);
+  border: 2px solid rgb(215, 214, 213);
+}
+
 .markview * {line-height:1.4em;}
 .markview a {color:#2e80d3; text-decoration:none;}
 .markview a:hover { text-decoration:underline;}
@@ -35,7 +54,7 @@ div#content div#markview-output { border: 1px solid #E9E9E9; background:#F8F8F8;
 
 .markview h1,.markview h2,.markview h3,.markview h4,.markview h5,.markview h6{margin-bottom:0.5em; color:black;}
 .markview h1{font-size:170% !important; padding-top:0.5em!important;margin-top:1.5em!important;
-	line-height:1.4em; font-weight:bold; border-top: 4px solid #AAA !important; }
+  line-height:1.4em; font-weight:bold; border-top: 4px solid #AAA !important; }
 .markview h1:first-child { margin-top:0!important;padding-top:0.25em!important;border-top:none!important;}
 .markview h2{ border-top: 4px solid #ddd; padding-top: 12px; margin-top:30px; margin-bottom:0.75em;}
 .markview h2{font-size:150% !important; font-weight:bold}
@@ -61,12 +80,12 @@ div#content div#markview-output { border: 1px solid #E9E9E9; background:#F8F8F8;
 .markview table td{border-bottom:1px solid #ddd;padding:0.2em 1em}
 
 .markview pre{font-family: Monaco, 'Courier New', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
-	background-color:#f8f8ff !important;border:1px solid #dedede !important;color:#444 !important; font-size:90% !important;
-	line-height:1.5em !important; padding: 0.5em !important; margin:1em 0 !important; overflow:auto !important;}
+  background-color:#f8f8ff !important;border:1px solid #dedede !important;color:#444 !important; font-size:90% !important;
+  line-height:1.5em !important; padding: 0.5em !important; margin:1em 0 !important; overflow:auto !important;}
 .markview pre code{background-color:#f8f8ff !important;border:none !important;font-size:100% !important;padding:0 !important}
 .markview code{font-family: Monaco, 'Courier New', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
-	background-color:ghostWhite !important;border:1px solid #dedede !important;color:#444 !important; font-size:90%!important;
-	padding:0 0.2em !important}
+  background-color:ghostWhite !important;border:1px solid #dedede !important;color:#444 !important; font-size:90%!important;
+  padding:0 0.2em !important}
 
 .markview pre.console{background-color:#000;color:white;font-size:90%;line-height:1.5em;margin:0 0 1em;padding:0.5em}
 .markview pre.console code{background-color:#000;border:medium none;color:#fff;font-size:100%;padding:0}

data/lib/markview/views/base.erb

@@ -1,16 +1,3 @@
-<!DOCTYPE html> 
-<html lang="en"> 
-  <head> 
-    <meta http-equiv="content-type" content="text/html;charset=utf-8" /> 
-    <title>Markview</title> 
-		<link rel="stylesheet" href="/style.css" type="text/css" media="screen" charset="utf-8">
-  </head> 
-  <body> 
-    <div id="content" class="clear">
-			<p id="file"><%= @title %></p>
-      <div id="markview-output" class="markview">
-				<%= @markdown %>
-      </div>
-    </div>
-  </body>
-</html>
+<div id="markview-output" class="markview">
+  <%= @markdown %>
+</div>

data/lib/markview/views/layout.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta http-equiv="content-type" content="text/html;charset=utf-8" />
+    <title>Markview</title>
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js"></script> 
+    <script src="/jquery.notifyBar.js"></script> 
+    <script src="/app.js" type="text/javascript" charset="utf-8"></script>
+    <link rel="stylesheet" href="/style.css" type="text/css" media="screen" charset="utf-8">
+    <link rel="stylesheet" href="/jquery.notifyBar.css" type="text/css" media="screen"  />
+    </script>
+  </head>
+  <body>
+    <div id="content" class="clear">
+      <p id="file"><%= @title %></p>
+
+      <div class="meta">
+        <ul>
+          <li><a id="edit" href="#">edit</a></li>
+          <li class="last"><a id="save" href="#">save</a></li>
+          <li class="last"><a id="preview" href="#">preview</a></li>
+        </ul>
+      </div>
+
+      <%= yield %>
+
+    </div>
+  </body>
+</html>

data/test/render_test.rb

@@ -1,25 +1,25 @@
 require 'test/test_helper'
 
 class RenderTest
-  
+
   test "renders given file" do
-    assert_equal GitHub::Markup.render(@argv, File.read(@argv)),
-      Markview::Application.markview_me
+    assert_equal GitHub::Markup.render(@argv, File.read(@argv)), Markview.render
   end
 
   test "renders discovered file" do
     discover_file
-    assert_equal GitHub::Markup.render(@argv, File.read(@argv)),
-      Markview::Application.markview_me
+    assert_equal GitHub::Markup.render(@argv, File.read(@argv)), Markview.render
   end
 
   test "no markdown file given or found raises error" do
     bad_file
-    assert_raises LoadError do
-      Markview::Application.markview_me
-    end
+    Proc.new {
+      assert_raise LoadError do
+        require 'markview.rb'
+      end
+    }
   end
-  
+
   test "on GET to root" do
     get "/"
     should_respond_with_success

data/test/test_helper.rb

@@ -1,27 +1,27 @@
 $LOAD_PATH.unshift File.dirname(File.expand_path(__FILE__)) + '/../lib'
 require File.dirname(File.expand_path(__FILE__)) + '/../lib/markview.rb'
-require 'contest'
 require 'rack/test'
+require 'contest'
 
 class RenderTest < Test::Unit::TestCase
   include Rack::Test::Methods
-  
+
   def app
-    Markview::Application.new
+    Markview.new
   end
-  
+
   def should_respond_with_success
     assert last_response.ok?
   end
-  
+
   def setup
     @argv = ARGV[0] = 'README.md'
   end
-  
+
   def discover_file
     @argv = ARGV[0] = Dir.glob("README*")[0]
   end
-  
+
   def bad_file
     @argv = ARGV[0] = "bad_file_name"
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: markview
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mark Sands
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-31 00:00:00 -05:00
+date: 2011-01-06 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: vegas
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 0
         - 1
@@ -35,9 +38,11 @@ dependencies:
   name: sinatra
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 51
         segments: 
         - 0
         - 9
@@ -49,9 +54,11 @@ dependencies:
   name: github-markup
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 0
         - 2
@@ -63,9 +70,11 @@ dependencies:
   name: rdiscount
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 1
         - 6
@@ -74,40 +83,46 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: contest
+  name: json
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
-        - 0
         - 1
-        - 2
-        version: 0.1.2
-  type: :development
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: turn
+  name: contest
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 0
-        - 7
-        - 0
-        version: 0.7.0
+        - 1
+        - 2
+        version: 0.1.2
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rack-test
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 0
         - 5
@@ -115,7 +130,7 @@ dependencies:
         version: 0.5.3
   type: :development
   version_requirements: *id007
-description: Conveniently launches practically any markup formatted files in a browser, rendering on the fly.
+description: Coneveniently renders and launches any markup formatted file within your browser.
 email: marksands07@gmail.com
 executables: 
 - markview
@@ -127,7 +142,11 @@ files:
 - bin/markview
 - lib/markview.rb
 - lib/markview/public/style.css
+- lib/markview/public/jquery.notifyBar.css
+- lib/markview/public/app.js
+- lib/markview/public/jquery.notifyBar.js
 - lib/markview/views/base.erb
+- lib/markview/views/layout.erb
 - README.md
 - test/test_helper.rb
 - test/render_test.rb
@@ -141,26 +160,30 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: markview
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A markup viewer that renders on the fly.
+summary: A markup viewer that renders on the fly in your browser.
 test_files: 
 - test/test_helper.rb
 - test/render_test.rb