rdoc-view 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rdoc-view.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 tamtam180
+
+MIT License
+
+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/README.rdoc

@@ -0,0 +1,29 @@
+= RDocView
+
+RDocView is a real-time viewer of RDoc/Markdown which used WebSocket.
+
+= Install
+
+   gem install rdoc-view
+
+= Usage
+
+  rdoc-view [-p port] [-o addr] [-t type] filename
+    
+    -p port        set the port (default is 4567)
+    -o addr        set the host (default is 0.0.0.0)
+    -t type        set the document type (rdoc or md)
+                   if omits, judging from the extension
+
+browse http://localhost:4567/
+and edit filename by your favorite editor.
+Change of a file is detected and a rendering is carried out in real time. 
+
+= Support Browser
+- Google Chrome
+- Firefox
+
+= License
+
+- MIT License
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rdoc-view

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'rdoc-view'

data/lib/rdoc-view/version.rb

@@ -0,0 +1,3 @@
+module RDocView
+  VERSION = "0.0.1"
+end

data/lib/rdoc-view.rb

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require "rdoc-view/version"
+
+require "net/https"
+require "uri"
+require "optparse"
+require "rdoc"
+require "rdoc/markup/to_html"
+
+require "sinatra/base"
+require "sinatra-websocket"
+require "fssm"
+
+module RDocView
+  def convert(file, type)
+    html = ""
+    text = open(file){|f|f.read}
+    case type
+    when "md"
+      uri = URI.parse("https://api.github.com/markdown/raw")
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      #https.set_debug_output $stderr
+      https.start do | access |
+        resp = access.post(uri.path, text, {"content-type" => "text/plain"})
+        html = resp.body
+      end
+    else
+      h = RDoc::Markup::ToHtml.new
+      html = h.convert(text)
+    end
+    return html
+  end
+  module_function :convert
+
+  class ViewApp < Sinatra::Base
+   
+    opt_type = nil
+    OptionParser.new { |op |
+      op.on('-p port',   'set the port (default is 4567)')           { |val| set :port, Integer(val) }
+      op.on('-o addr',   'set the host (default is 0.0.0.0)')        { |val| set :bind, val }
+      op.on('-t type',   'set the document type (rdoc or md)',
+                         'if omits, judging from the extension')     { |val| opt_type = val.downcase }
+    }.parse!(ARGV)
+    set :environment, :production
+
+    raise "ARGV is empty." if ARGV.empty?
+    raise "File Not Found:#{ARGV[0]}" unless File.exists?(ARGV[0])
+    
+    set :target_file, ARGV[0]
+    set :server, "thin"
+    set :sockets, []
+
+    support_extensions = ["rdoc", "md"]
+    set :type, opt_type
+    set :type, File.extname(ARGV[0]).downcase().slice(1..-1) unless support_extensions.include?(opt_type)
+
+    send_func = Proc.new do | ws |
+      if File.exists?(settings.target_file) then
+        # convert to html
+        html = RDocView.convert(settings.target_file, settings.type)
+        html.force_encoding("utf-8")
+
+        EM.next_tick do
+          if ws then
+            ws.send(html)
+          else
+            settings.sockets.each do |s|
+              s.send(html)
+            end
+          end
+        end
+      end
+    end
+
+    # blockingしちゃうので。
+    th = Thread.new(send_func) do | send_func |
+      FSSM.monitor(File.dirname(settings.target_file), File.basename(settings.target_file)) do
+        update {|b,r| send_func.call()}
+        delete {|b,r| }
+        create {|b,r| send_func.call()}
+      end
+    end
+
+    # 簡易的なTimer。定期的にPingを飛ばす。
+    th_timer = Thread.new() do
+      while true
+        EM.next_tick do
+          settings.sockets.each do |s|
+            s.ping()
+          end
+        end
+        sleep 5
+      end
+    end
+
+    error 500 do
+      "Error: Internal Server Error."
+    end
+
+    get "/" do
+      erb :index
+    end
+
+    get "/rdoc" do
+      if request.websocket? then
+        request.websocket do | ws |
+          ws.onopen do
+            settings.sockets << ws
+            send_func.call(ws)
+          end
+          ws.onmessage do | msg |
+          end
+          ws.onclose do
+            settings.sockets.delete(ws)
+          end
+          ws.onerror do
+          end
+          ws.onping do
+          end
+          ws.onpong do
+          end
+        end
+      else
+        500
+      end
+    end
+  end
+  ViewApp.run! 
+end
+

data/lib/views/index.erb

@@ -0,0 +1,77 @@
+<!DOCTYPE html>
+<html lang="ja">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>RDoc Document Viewer</title>
+    <link href="http://developer.github.com/css/reset.css" rel="stylesheet" type="text/css" />
+    <link href="http://developer.github.com/css/960.css" rel="stylesheet" type="text/css" />
+    <link href="http://developer.github.com/css/uv_active4d.css" rel="stylesheet" type="text/css" />
+    <link href="http://developer.github.com/shared/css/documentation.css" media="screen" rel="stylesheet" type="text/css">
+    <link href="http://developer.github.com/shared/css/pygments.css" media="screen" rel="stylesheet" type="text/css">
+    <style>
+      .logo {
+        padding-top: 10px;
+        font-size: 48px;
+      }
+      .closed {
+        color: #e91000;
+      }
+      .error {
+        color: #e91000;
+      }
+      .opened {
+        color: #0065e9;
+      }
+    </style>
+    <script src="http://developer.github.com/shared/js/jquery.js" type="text/javascript"></script>
+    <script src="http://developer.github.com/shared/js/documentation.js" type="text/javascript"></script>
+    <script type="text/javascript">
+      var timerId;
+      function ws_connect() {
+        var ws = new WebSocket("ws://" + location.host + "/rdoc")
+        ws.onopen = function() {
+          if (timerId) {
+            clearTimeout(timerId);
+            timerId = undefined;
+          }
+          $("#status").html('<span class="opened">OPENED</span>');
+        };
+        ws.onmessage = function(e) {
+          $("div.content").html(e.data);
+        };
+        ws.onclose = function() {
+          $("#status").html('<span class="closed">CLOSED</span>');
+          // 再接続
+          timerId = setTimeout(function(){
+            ws_connect();
+          }, 5000)
+        };
+        ws.onerror = function(e) {
+          $("#status").html('<span class="error">ERROR</span>');
+        };
+      }
+      $(function() {
+        ws_connect();
+      });
+    </script>
+  </head>
+  <body class="api">
+
+    <div id="header-wrapper">
+      <div id="header">
+        <a class="logo">RDocViewer</a>
+        <ul class="nav">
+          <li id="filename"><%=File.basename(settings.target_file)%></li>
+          <li id="status"></li>
+        </ul>
+      </div>
+    </div>
+
+    <div id="wrapper">
+      <div class="content">
+      </div>
+    </div>
+
+  </body>
+</html>
+

data/rdoc-view.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rdoc-view/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rdoc-view"
+  gem.version       = RDocView::VERSION
+  gem.authors       = ["tamtam180"]
+  gem.email         = ["kirscheless@gmail.com"]
+  gem.description   = %q{Realtime RDoc viewer with WebSocket.}
+  gem.summary       = %q{Realtime RDoc viewer with WebSocket.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/) - %w[.gitignore]
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "sinatra"
+  gem.add_dependency "sinatra-websocket"
+  gem.add_dependency "fssm"
+  gem.add_dependency "rdoc"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rdoc-view
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tamtam180
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fssm
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Realtime RDoc viewer with WebSocket.
+email:
+- kirscheless@gmail.com
+executables:
+- rdoc-view
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/rdoc-view
+- lib/rdoc-view.rb
+- lib/rdoc-view/version.rb
+- lib/views/index.erb
+- rdoc-view.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Realtime RDoc viewer with WebSocket.
+test_files: []