croc 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-01-17
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/croc
+lib/croc.rb
+public/about.html
+public/index.html
+public/jquery.dimensions.js
+public/jquery.js
+spec/croc_spec.rb
+spec/spec_helper.rb
+tasks/ann.rake
+tasks/bones.rake
+tasks/gem.rake
+tasks/git.rake
+tasks/manifest.rake
+tasks/notes.rake
+tasks/post_load.rake
+tasks/rdoc.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/spec.rake
+tasks/svn.rake
+tasks/test.rake
+test/test_croc.rb

data/README.txt

@@ -0,0 +1,53 @@
+croc
+  by Dan Hensgen
+  http://www.methodhead.com
+
+== DESCRIPTION:
+
+  Croc indexes your locally installed rdocs and generates an HTML page with a
+  quick search box. The search works a bit like gotapi.com.
+
+== FEATURES/PROBLEMS:
+
+* Indexes all locally installed gems
+* Installs missing rdocs when possible
+* Optionally installs Ruby and Standard Library rdocs
+* Untested on everything except Mac
+
+== SYNOPSIS:
+
+  $ croc
+  $ open file:///Users/dan/.croc/index.html
+
+== REQUIREMENTS:
+
+  RubyGems 1.2+
+
+== INSTALL:
+
+  $ sudo gem install croc
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Dan Hensgen
+
+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/Rakefile

@@ -0,0 +1,31 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'croc'
+
+task :default => 'spec:run'
+
+PROJ.name = 'croc'
+PROJ.authors = 'Dan Hensgen'
+PROJ.email = 'dan@methodhead.com'
+PROJ.url = 'https://rubyforge.org/projects/croc/'
+PROJ.version = "1.0.0"
+PROJ.rubyforge.name = 'croc'
+
+PROJ.spec.opts << '--color'
+PROJ.exclude << "bugs" << "\.sw.$" << ".ditz-config"
+
+# EOF

data/bin/croc

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "croc"
+
+$gems = []
+$classes = {}
+$methods = []
+
+install_assets
+
+specs = get_specs
+
+homes = {}
+specs.each do |spec|
+  spec.loaded_from =~ /^(.+)\/specifications/
+  homes[$1] = true
+end
+
+# find gem home
+$home = homes.keys.detect { |home| home !~ /^\/System/ }
+$rdoc_home = File.join($home, "doc")
+$gem_home = File.join($home, "gems")
+$croc_home = File.join(user_home_dir, ".croc")
+
+puts "Indexing gems in #{$gem_home}"
+
+# install system gems
+gems_to_install = specs.select { |spec| spec.loaded_from =~ /^\/System/ }
+
+unless gems_to_install.empty?
+  puts "It looks like you're using a Mac and these gems are installed under /System:"
+  puts
+  puts "  #{gems_to_install.collect {|spec| "#{spec.name}-#{spec.version}"}.join(" ")}"
+  puts
+  puts "Croc can't index these, but installing them in your main gems directory"
+  puts "should solve the problem.  Install them (may require sudo)? (y/n)"
+  if gets.strip == "y"
+    gems_to_install.each do |spec|
+      puts "Installing #{spec.name}-#{spec.version}"
+      `gem install -v #{spec.version} #{spec.name}`
+    end
+  else
+    specs = specs - gems_to_install
+  end
+end
+
+# install rdocs
+rdocs_to_install = specs.select { |spec| !File.exists?(File.join($rdoc_home, "#{spec.name}-#{spec.version}", "rdoc"))}
+
+unless rdocs_to_install.empty?
+  puts "These gems have rdocs, but they're not installed:"
+  puts
+  puts "  #{rdocs_to_install.collect {|spec| "#{spec.name}-#{spec.version}"}.join(" ")}"
+  puts
+  puts "Install them (may require sudo)? (y/n)"
+  if gets.strip == "y"
+    rdocs_to_install.each do |spec|
+      puts "Installing rdocs for #{spec.name}-#{spec.version}"
+      `sudo gem rdoc -v #{spec.version} #{spec.name}`
+    end
+  else
+    specs = specs - rdocs_to_install
+  end
+end
+
+croc_rdoc_dir = File.join($croc_home, "rdoc")
+unless File.exist?(File.join(croc_rdoc_dir, "ruby"))
+  puts "Install Ruby and Stdlib rdocs from www.ruby-doc.org? (y/n)"
+  if gets.strip == "y"
+    install_rdocs("http://www.ruby-doc.org/download/ruby-1.8.6-core-rdocs.tgz", "core-1.8.6_HEAD", "ruby")
+
+    Dir.chdir(croc_rdoc_dir)
+    puts "Installing http://www.ruby-doc.org/download/stdlib/ruby-doc-stdlib-0.10.1.tgz"
+    tgz_file = File.join(croc_rdoc_dir, "dest.tgz")
+    download("http://www.ruby-doc.org/download/stdlib/ruby-doc-stdlib-0.10.1.tgz", tgz_file)
+    `tar xzf #{tgz_file}`
+    src_file = File.join(croc_rdoc_dir, "ruby-doc-stdlib-0.10.1")
+    libdoc_dir = File.join(src_file, "stdlib", "libdoc")
+    Dir.chdir(libdoc_dir)
+    Dir.glob("**/index.html").each do |f|
+      f = File.split(f)[0]
+      move_to = File.split(f)[0].split(File::SEPARATOR).join('-')
+      File.move(File.join(libdoc_dir, f), File.join(croc_rdoc_dir, move_to))
+    end
+    File.delete(tgz_file)
+    FileUtils.rm_r(src_file)
+  else
+    specs = specs - rdocs_to_install
+  end
+end
+
+Dir.chdir(File.join(user_home_dir, ".croc", "rdoc"))
+Dir.glob("*").each do |name|
+  next if name == "." || name == ".."
+  index_rdoc(name, File.join(Dir.pwd, name))
+end
+
+specs.each { |spec| index_rdoc(spec.name, File.join($rdoc_home, "#{spec.name}-#{spec.version}", "rdoc")) }
+
+idx = -1
+File.open(File.join(user_home_dir, ".croc", "data.js"), "w") do |f|
+  f.puts       "objs = ["
+  $gems.each do |gem|
+    f.puts     "  {t: 'g', p: null, n: '#{gem[:name]}', l: '#{gem[:name].downcase}', u: '#{gem[:dir]}'},"
+    idx += 1
+    gidx = idx
+    gem[:classes].each_pair do |key, value|
+      f.puts   "  {t: 'c', p: #{gidx}, n: '#{key}', l: '#{key.downcase}', u: '#{value[:url]}'},"
+      idx += 1
+      cidx = idx
+      value[:methods].each do |method|
+        f.puts "  {t: 'm', p: #{cidx}, n: '#{method[:name]}', l: '#{method[:name].downcase}', u: '#{method[:url]}'},"
+        idx += 1
+      end
+    end
+  end
+  f.puts       "];"
+end
+
+puts "Bookmark file://#{File.join(user_home_dir, ".croc", "index.html")}"

data/lib/croc.rb

@@ -0,0 +1,130 @@
+require "rubygems"
+require "hpricot"
+require "ftools"
+require "net/http"
+
+
+# Figure out where rdocs are installed.
+def find_gem_home
+  if File.exists?("/Library/Ruby/Gems/1.8/gems")
+    return "/Library/Ruby/Gems/1.8/gems"
+  end
+end
+
+# Returns the user's home directory as a string.
+def user_home_dir
+  ENV["HOME"]
+end
+
+# Creates ~/.croc and installs assets from public directory.
+def install_assets
+  croc_dir = File.join(user_home_dir, ".croc")
+  unless File.exists?(croc_dir)
+    Dir.mkdir(croc_dir)
+    Dir.mkdir(File.join(croc_dir, "rdoc"))
+  end
+
+  public_dir = File.join(File.dirname(__FILE__), "..", "public")
+  Dir.new(public_dir).each do |f|
+    next if f == "." || f == ".."
+    File.copy(File.join(public_dir, f), File.join(croc_dir, f))
+  end
+end
+
+# Print installed gems and whether rdocs are available and indeed installed.
+def print_gems
+  Gem.source_index.search(Gem::Dependency.new("", nil)).each do |spec|
+    puts "#{spec.name} #{spec.version} #{spec.has_rdoc? ? "has rdoc" : ""} #{File.exists?(rdoc_dir) ? "and it exists" : "but it doesn't exist"}"
+  end
+end
+
+# Collect specs for most recent version of all installed gems.
+def get_specs
+  specs = {}
+  Gem.source_index.search(Gem::Dependency.new("", nil)).each do |spec|
+    next unless spec.has_rdoc?
+    if specs[spec.name]
+      specs[spec.name] = spec if (spec.version <=> specs[spec.name].version) > 0
+    else
+      specs[spec.name] = spec
+    end
+  end
+  specs.values
+end
+
+def index_rdoc(name, rdoc_dir)
+  unless File.exists?(rdoc_dir)
+    puts "WARN Couldn't find rdoc dir #{rdoc_dir}"
+    return
+  end
+
+  methods_file = File.join(rdoc_dir, "fr_method_index.html")
+  unless File.exists?(methods_file)
+    puts "ERROR Couldn't find #{methods_file}"
+  end
+
+  classes_file = File.join(rdoc_dir, "fr_class_index.html")
+  unless File.exists?(classes_file)
+    puts "ERROR Couldn't find #{classes_file}"
+  end
+
+  # collect gem
+  gem = {:name => name, :dir => rdoc_dir, :classes => {}}
+  $gems << gem
+
+  # collect classes
+  doc = Hpricot(open(classes_file))
+  (doc/"#index-entries a").each do |el|
+    klass = el.inner_html
+  
+    if $classes[klass]
+      puts "Already have class #{klass}"
+    else
+      gem[:classes][klass] = {:name => klass, :url => el["href"], :methods => []}
+    end
+  end
+
+  # collect methods
+  doc = Hpricot(open(methods_file))
+  (doc/"#index-entries a").each do |el|
+    if el.inner_html =~ /(\S+)\s+\((\S+)\)/
+      method = $1
+      if klass = gem[:classes][$2]
+        el["href"] =~ /#(.*)$/
+        url = $1
+        klass[:methods] << {:name => method, :class => klass, :url => url}
+      else
+        # puts %Q(Couldn't find class "#{$2} for method #{method}")
+      end
+    else
+      # puts %Q(Couldn't get method and class from "#{el.inner_html}")
+    end
+  end
+
+  puts "Indexed #{name}"
+end
+
+def download(url, dest)
+  File.open(dest, "w") do |f|
+    url = URI.parse(url)
+    http = Net::HTTP.new(url.host, url.port)
+    http.request_get(url.path) do |resp|
+      resp.read_body do |s|
+        f.write(s)
+      end
+    end
+  end
+end
+
+def install_rdocs(url, src_dir_name, dest_dir_name)
+  croc_rdoc_dir = File.join($croc_home, "rdoc")
+  Dir.chdir(croc_rdoc_dir)
+  puts "Installing #{url}"
+  tgz_file = File.join(croc_rdoc_dir, "dest.tgz")
+  src_file = File.join(croc_rdoc_dir, src_dir_name)
+  dest_file = File.join(croc_rdoc_dir, dest_dir_name)
+  download(url, tgz_file)
+  `tar xzf #{tgz_file}`
+  File.rename(src_file, dest_file)
+  File.delete(tgz_file)
+end

data/public/about.html

@@ -0,0 +1,74 @@
+<html>
+  <head>
+    <style>
+      body, th, td {
+        font: normal 12px sans-serif;
+      }
+
+      #main {
+        width: 640px;
+        margin: auto;
+      }
+
+      th {
+        font-weight: bold;
+        text-align: left;
+      }
+
+      h1 {
+        font-size: 1.7em;
+        color: #800;
+        border-bottom: 1px solid #888;
+        margin: 0 0 2px 0;
+      }
+
+      h2 {
+        font-size: 1.2em;
+        color: #a00;
+      }
+
+      #deck {
+        text-align: right;
+        color: #a00;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="main">
+      <h1>croc</h1>
+      <div id="deck">
+        Quick access to your locally installed rdocs
+      </div>
+
+      <h2>Examples with rspec</h2>
+      <table>
+        <tr>
+          <th>test</th>
+          <td>Gems, classes and methods that contain <em>test</em></td>
+        </tr>
+        <tr>
+          <th>test_finished.</th>
+          <td>Classes and methods named exactly <em>test_finished</em></td>
+        </tr>
+        <tr>
+          <th>rsp test</th>
+          <td>Classes and methods that contain <em>test</em> in gems that contain <em>rsp</em></td>
+        </tr>
+        <tr>
+          <th>rsp test_finished.</th>
+          <td>Classes and methods named exactly <em>test_finished</em> in gems that contain <em>rsp</em></td>
+        </tr>
+      </table>
+
+      <h2>Install your own rdocs</h2>
+      <p>
+        Copy your rdocs directory to ~/.croc/rdoc and make sure it's named
+        something sensible.  Rerun croc.
+      </p>
+
+      <h2>About</h2>
+      Copyright 2008 <a href="http://blog.methodhead.com">Dan Hensgen</a>.
+      Feedback appreciated at <a href="mailto:dan@methodhead.com">dan@methodhead.com</a>.
+    </div>
+  </body>
+</html>

data/public/index.html

@@ -0,0 +1,202 @@
+<html>
+  <head>
+    <title>Croc</title>
+    <script type="text/javascript" src="jquery.js"></script>
+    <script type="text/javascript" src="jquery.dimensions.js"></script>
+    <script type="text/javascript" src="data.js"></script>
+    <script>
+      suggestions = [];
+
+      function find(q) {
+        if (q == null || jQuery.trim(q).length == 0) {
+          return [];
+        }
+
+        gemPart = null;
+        if (q.indexOf(' ') > 0) {
+          a = q.split(/\s+/)
+          gemPart = a[0];
+          q = a[1];
+        }
+
+        var sugs = [];
+        var includedGems = {};
+        var parentGems = {};
+
+        if (gemPart) {
+          for (i in objs) {
+            o = objs[i];
+            if (o.t == "g") {
+              if (o.l.indexOf(gemPart) >= 0) {
+                parentGems[i] = true;
+              }
+            }
+          }
+        }
+
+        for (i in objs) {
+          o = objs[i];
+          if ((q[q.length - 1] == '.' && o.l == q.substr(0, q.length - 1)) || o.l.indexOf(q) >= 0) {
+            if (o.t == "c") {
+              if (!gemPart || parentGems[o.p]) {
+                if (!includedGems[o.p]) {
+                  includedGems[o.p] = true;
+                  sugs.push(objs[o.p]);
+                }
+                sugs.push(o);
+              }
+            }
+            else if (o.t == "m") {
+              if (!gemPart || parentGems[objs[o.p].p]) {
+                if (!includedGems[objs[o.p].p]) {
+                  includedGems[objs[o.p].p] = true;
+                  sugs.push(objs[objs[o.p].p])
+                }
+                sugs.push(o);
+              }
+            }
+            else {
+              if (!gemPart || parentGems[i]) {
+                includedGems[i] = true;
+                sugs.push(o);
+              }
+            }
+
+            if (sugs.length > 50) {
+              sugs.push(0)
+              break;
+            }
+          }
+        }
+
+        return sugs;
+      }
+
+      function resultsToHtml(results) {
+        html = '';
+        jQuery.each(results, function(i, o) {
+          if (o == 0) {
+            html += '<div>...</div>';
+          }
+          else {
+            switch (o.t) {
+              case "g":
+                html += '<div class="gem"><a target="iframe" href="file://' + o.u + '/index.html">' + o.n + '</a></div>'; break;
+              case "c":
+                html += '<div class="class-or-method"><a target="iframe" href="file://' + objs[o.p].u + '/' + o.u + '">' + o.n + '</a></div>'; break;
+              case "m":
+                html += '<div class="class-or-method"><a target="iframe" href="file://' + objs[objs[o.p].p].u + '/' + objs[o.p].u + '#' + o.u + '">' + o.n + '</a>&nbsp;(' + objs[o.p].n + ')</div>'; break;
+            }
+          }
+        });
+
+        return html;
+      }
+
+      function sizeElements() {
+        $('#suggestions').css('top', $('input').position()['top'] + $('input').outerHeight() + 'px');
+        $('#iframe').css('height', $(window).height() - $('input').outerHeight() - 5 + 'px' );
+        $('#iframe').css('width', $(window).width() - 5 + 'px' );
+      }
+
+      $(document).ready(function(){
+        sizeElements();
+
+        $(document).keyup(function(e) {
+          if (e.keyCode == 27) {
+            $('#suggestions').hide();
+          }
+        });
+
+        $('iframe').keyup(function(e) {
+          if (e.keyCode == 27) {
+            $('#suggestions').hide();
+          }
+        });
+
+        // search and update results
+        $('input').keyup(function(e) {
+          if (e.keyCode == 27) {
+            return;
+          }
+
+          matches = find(e.target.value.toLowerCase());
+
+          html = resultsToHtml(matches);
+
+          if (matches.length > 0) {
+            $('#suggestions').html(html).show();
+          }
+          else {
+            $('#suggestions').hide();
+          }
+        });
+
+        // hide suggestions if user clicks on a link
+        $('#suggestions').click(function(e) {
+          if (e.target.nodeName == "A") {
+            $('#suggestions').hide();
+            $('#recents').prepend('&nbsp;&nbsp;<a target="iframe" href="' + e.target.href + '">' + e.target.innerHTML + '</a>');
+          }
+        });
+
+        $('input').focus();
+
+        $('input').focus(function() {
+          if (!$('#suggestions').text().match(/^\s*$/)) {
+            $('#suggestions').show();
+          }
+        });
+      });
+    </script>
+
+    <style>
+      * {
+        margin: 0;
+        font: 9pt sans-serif;
+      }
+      body {
+        margin: 0;
+        padding: 0;
+      }
+      input {
+        float: left;
+        width: 10%
+      }
+
+      #suggestions {
+        border: 1px solid #bbb;
+        position: absolute;
+        background-color: #fff;
+        color: #aaa;
+        padding: 3px;
+      }
+
+      #suggestions div.gem {
+        font-weight: bold;
+      }
+
+      #suggestions div.class-or-method {
+        padding-left: 1em;
+      }
+
+      #recents {
+        float: left;
+        width: 89%;
+        overflow: hidden;
+        padding: 5px 0 0 3px;
+      }
+    </style>
+  </head>
+  <body>
+    <form>
+      <input>
+      <div id="recents"></div>
+      <div id="suggestions" style="display:none">
+        
+      </div>
+    </form>
+    <iframe id="iframe" name="iframe" src="about.html">
+    </iframe>
+  </body>
+</html>