pietern-bdoc 0.3.0

data/History.txt

@@ -0,0 +1,70 @@
+== 0.3.0 2009-06-22
+* 1 major rewrite
+  * Searching gems
+  * Searching API for a gem
+  * Multiple rdocs opened at the same time
+
+== 0.2.2 2009-06-08
+
+* 1 new feature from csexton -- Thanks!
+  * Ability to specify an output directory
+
+== 0.2.1 2009-04-06
+
+* 2 bug fixes from vesan
+  * Fix CSS to prevent gem list from blowing up in Safari 4 Beta
+  * HTML escape gem descriptions
+
+== 0.1.9 2009-04-02
+
+* 1 bug fix
+  * more path issues... yet again.
+  
+== 0.1.8 2009-03-30
+
+* 1 bug fix
+  * more path issues... wasn't copying bdoc.css
+
+== 0.1.7 2009-03-30
+
+* 1 bug fix
+  * don't display versions without rdocs
+
+== 0.1.6 2009-03-30
+
+* 1 bug fix
+  * layout issues
+
+== 0.1.5 2009-03-30
+
+* 1 bug fix
+  * file path issues with templates
+
+== 0.1.4 2009-03-30
+
+* 3 minor enhancements
+  * now scans all of the gems installed on your machine not just the
+    default gem path
+  * also shows gems without rdocs
+  * set window title to selected rdoc
+
+== 0.1.3 2009-03-30
+
+* 2 bug fixes:
+  * require json/pure instead of native json parser
+  * changed require statement in bin file
+
+== 0.1.2 2009-03-30
+
+* 1 bug fix:
+  * have to user absolute path when writing out index.html
+
+== 0.1.1 2009-03-29
+
+* 1 bux fix:
+  * forgot to include a stylesheet
+
+== 0.1.0 2009-03-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bdoc.gemspec
+bin/bdoc
+lib/bdoc.rb
+public/app/gdoc.css
+public/app/gdoc.js
+public/app/jquery.js
+public/app/liquidmetal.js
+public/app/screen.css
+public/app/selector.js
+templates/index.html
+test/test_bdoc.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,80 @@
+= Bdoc
+
+Bdoc is a simple replacement for gem server.  All it does is look at all of
+the Gems you have installed locally and creates a nice iframe based
+browser that makes it easy to navigate between gem docs. IT DOES NOT REQUIRE
+A SERVER FOR VIEWING... not like gem server does!
+
+If you use this, I highly suggest also using 
+Hanna[http://github.com/mislav/hanna/tree/master] (a beautiful rdoc theme).
+
+This fork of bdoc uses the LiquidMetal scoring algorithm so you don't have to
+worry about typo's in your search queries (http://github.com/rmm5t/liquidmetal/tree/master).
+
+Other features include:
+* Search your local gems (instead of browsing through a list)
+* Multiple rdocs open simultaneously
+* Search the API of every gem
+
+http://img.skitch.com/20090622-p54f7sd3xn8caiu49yk3pq9ueb.png
+http://img.skitch.com/20090622-faejc7qc4qgi5qme3yd4pdwqf.png
+
+== Install
+
+  [sudo] gem install pietern-bdoc
+
+== Usage
+
+  bdoc
+
+That's it!  This will create an index of all your local gems then launch your 
+default browser.  Enjoy!
+
+== Controls
+
+When bdoc is loaded, press space to search for a gem.
+When a gem is loaded, just start typing to find the file/class/method you're looking for.
+To switch between different tabs use Shift+→ and Shift+←.
+
+=== Specify output directory
+
+Optionally you can specify the output directory on the command line:
+
+  bdoc /path/to/bdoc
+
+=== Hints
+
+For even easier access to the docs of your local gems, create a Fluid.app instance
+for bdoc. Then, edit your <tt>Bdoc.app/Contents/Resources/Config.plist</tt> to point
+to some location on your drive (e.g. <tt>/Users/<yourname>/.bdoc/index.html</tt>) and
+schedule a cronjob to recreate the bdoc index every once in a while. At least, this works
+for me.
+
+== Authors
+* Rich Manalang (original author of bdoc)
+* Pieter Noordhuis
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Rich Manalang
+
+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/bdoc

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/bdoc'
+Bdoc.open

data/lib/bdoc.rb

@@ -0,0 +1,81 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'erb'
+require 'tmpdir'
+require 'launchy'
+require 'json'
+
+module Bdoc
+  VERSION = '0.3.0'
+
+  class << self
+    attr_accessor :output_dir
+    attr_accessor :output_index
+
+    def root
+      File.expand_path File.join(File.dirname(__FILE__),  '..')
+    end
+
+    def rdoc_file(gem_name)
+      File.join(Gem.dir, "doc", gem_name, "rdoc", "index.html")
+    end
+
+    def gems_with_doc_index
+      installed_gems = Gem::SourceIndex.from_installed_gems.gems.map{|k,v|v}
+      gems = installed_gems.map { |g|
+        g.name if g.has_rdoc?
+      }.compact.uniq.sort{|x,y| x.downcase <=> y.downcase}
+      gems = gems.map do |g|
+        gem = installed_gems.find_all{|gem| gem.name == g}.last
+        { :name => g,
+          :description => gem.description,
+          :homepage => gem.homepage,
+          :versions => installed_gems.find_all{|gem|
+            gem.name == g
+            }.map{|gem|
+              rdoc_index = File.join(gem.full_gem_path,"..","..","doc",gem.full_name, "rdoc","index.html")
+              { :version => gem.version.version,
+                :rdoc_index => (File.exist?(rdoc_index) ? rdoc_index : nil)
+              }
+            #removes dups since uniq doesn't work on array of hashes
+            }.compact.sort_by{|g|g[:version]}.inject([]){|result,h|
+              result << h unless result.include?(h)
+              result
+            }
+        }
+      end
+    end
+
+    def render
+      ERB.new(File.read(File.join(File.dirname(__FILE__), '..', "templates","index.html"))).result(binding)
+    end
+
+    def generate_index
+      Dir.mkdir(output_dir) unless File.exists?(output_dir)
+
+      # First just link the path
+      if true
+        Dir[File.join(public_path, '*')].each do |d|
+          symlink_path = File.join(output_dir, File.basename(d))
+          File.symlink(d, symlink_path) unless File.symlink? symlink_path
+        end
+      end
+
+      File.open(output_index,"w") {|f| f.write(render)}
+    end
+
+    def public_path
+      File.join(root, 'public')
+    end
+
+    def open
+      generate_index
+      Launchy::Browser.run(output_index)
+    end
+  end
+
+  self.output_dir = ARGV[0] || File.join(Dir.tmpdir, "bdoc")
+  self.output_index = File.join(@output_dir,"index.html")
+end

data/public/app/gdoc.css

@@ -0,0 +1,210 @@
+body {
+  background-color: #aaa;
+}
+
+#navbar {
+  margin: 4px 5px;
+}
+#navbar strong {
+  background-color: #555;
+  padding: 3px 5px;
+  -moz-border-radius: 3px;
+  -webkit-border-radius: 3px;
+}
+
+#navbar strong a {
+  color: #fff;
+  text-decoration: none;
+}
+
+ul#tabs {
+  position: absolute;
+  top: 6px;
+  right: 0;
+  list-style: none;
+  z-index: 2;
+}
+
+ul#tabs li {
+  display: inline;
+  margin-left: 0.5em;
+}
+
+ul#tabs li > a {
+  background-color: #555;
+  padding: 4px 6px 4px;
+  text-decoration: none;
+  color: #fff;
+  font-weight: bold;
+  -moz-border-radius: 5px;
+  -webkit-border-radius: 5px;
+  -moz-border-radius-bottomleft: 0;
+  -moz-border-radius-bottomright: 0;
+  -webkit-border-bottom-left-radius: 0;
+  -webkit-border-bottom-right-radius: 0;
+}
+
+ul#tabs li.active > a,
+ul#tabs li > a:hover {
+  background-color: #000;
+  color: #fff;
+}
+
+#versionbar {
+  background-color: #000;
+  position: relative;
+  height: 22px;
+}
+
+#versionbar div.g {
+  padding: 2px 0.5em;
+}
+
+#versionbar a.homepage {
+  float: left;
+  color: #fff;
+  text-decoration: none;
+}
+
+#versionbar .versions {
+}
+
+#versionbar .versions a {
+  font-weight: bold;
+  color: #888;
+  margin: 2px 0.5em 0;
+  text-decoration: none;
+}
+
+#versionbar .versions a.active {
+  color: #fff;
+}
+
+#versionbar .versions a.disabled {
+  color: #D40705;
+}
+
+#versionbar .close {
+  float: right;
+  color: #D40705;
+  cursor: pointer;
+}
+
+#frames {
+  clear: both;
+  position: relative;
+  width: 100%;
+}
+
+#frames iframe {
+  border: 0;
+  width: 100%;
+  height: 100%;
+}
+
+#overlay {
+  position: absolute;
+  top: 0;
+  left: 0;
+  background-color: #000;
+  opacity: 0.5;
+  z-index: 2;
+  width: 100%;
+  height: 100%;
+  display: none;
+}
+
+#popup {
+  position: absolute;
+  top: 80px;
+  width: 100%;
+  z-index: 3;
+  display: none;
+}
+
+#popup > div {
+  position: relative;
+  width: 480px;
+  margin: 0 auto;
+
+  background-color: #aaa;
+  -moz-border-radius: 20px;
+  -webkit-border-radius: 20px;
+
+  padding: 10px;
+  text-align: center;
+  display: none;
+}
+
+#popup div.search {
+  background-color: #fff;
+  padding: 20px;
+  -moz-border-radius: 10px;
+  -webkit-border-radius: 10px;
+}
+
+#popup div.search h1 {
+  letter-spacing: 3px;
+}
+
+#popup div.search input {
+  font-size: 17pt;
+  border: 0px;
+  background-color: #ddd;
+  width: 400px;
+  padding: 4px;
+  font-family: Monaco, Courier;
+}
+
+#popup div.results {
+  display: inline-block;
+  margin-top: 4px;
+  height: 150px;
+  width: 400px;
+  overflow-x: hidden;
+  overflow-y: auto;
+}
+
+#popup div.results ul {
+  padding: 0;
+  margin: 0;
+  list-style: none;
+  text-align: left;
+  font-size: 12pt;
+}
+
+#popup div.results li {
+  padding: 0 1em;
+  height: 30px;
+  font-family: Monaco, Courier;
+  overflow: hidden;
+}
+
+#popup div.results li.qs_selected{
+  background-color: #333 !important;
+  color: #fff !important;
+}
+
+#popup div.results li:nth-child(odd) {
+  background-color: #eee;
+}
+
+#popup div#searchapi div.results {
+  height: 200px;
+}
+
+#popup div#searchapi div.results ul {
+  font-size: 9pt;
+}
+
+
+#popup div#searchapi div.results li {
+  height: 20px;
+}
+
+
+/* Facebox-Blueprint fix */
+#facebox table {
+  border-collapse: collapse;
+  width: auto;
+}