lookup 0.4.1 → 1.0.0.beta1

data/doc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/lookup.rb

@@ -1,9 +1,10 @@
 require 'rubygems'
+require 'bundler'
 require 'net/http'
 
+Bundler.setup
+Bundler.require(:default)
 require 'active_record'
-require 'nokogiri'
-require 'find_by_hash'
 
 module APILookup
 
@@ -12,7 +13,8 @@ module APILookup
       puts "Updating API, this may take a minute or two. Please be patient!"
       [Constant, Entry, Api].map { |klass| klass.delete_all }
       
-      update_api!("Rails", "http://api.rubyonrails.org")
+      update_api!("Rails v3.0.0", "http://api.rubyonrails.org")
+      update_api!("Rails v2.3.8", "http://api.rubyonrails.org/v2.3.8")
       update_api!("Ruby 1.8.7", "http://www.ruby-doc.org/core")
       update_api!("Ruby 1.9", "http://ruby-doc.org/ruby-1.9")
       
@@ -26,16 +28,17 @@ module APILookup
       puts "DONE (with #{name})!"
     end
    
-    def find_constant(name, entry=nil)
+    def find_constant(name, entry=nil, options={})
+      scope = options[:api].constants || Constant
       # Find by specific name.
-      constants = Constant.find_all_by_name(name, :include => "entries")
+      constants = scope.find_all_by_name(name, :include => "entries")
       # search for class methods, which is prolly what we want if we can find it
-      constants = Constant.find_all_by_name("#{name}::ClassMethods", :include => "entries") if constants.empty?
+      constants = scope.find_all_by_name("#{name}::ClassMethods", :include => "entries") if constants.empty?
       # Find by name beginning with <blah>.
-      constants = Constant.all(:conditions => ["name LIKE ?", name + "%"], :include => "entries") if constants.empty?
+      constants = scope.all(:conditions => ["constants.name LIKE ?", name + "%"], :include => "entries") if constants.empty?
       # Find by fuzzy.
       match="%#{name.split("").join("%")}%"
-      constants = Constant.find_by_sql("select * from constants where name LIKE '#{match}'") if constants.empty?
+      constants = scope.find_by_sql("select * from constants where name LIKE '#{match}'") if constants.empty?
       regex=build_regex_from_constant(name)
       constants = constants.select { |x| x.name =~ regex }
       # Narrow it down to the constants that only contain the entry we are looking for.
@@ -76,22 +79,23 @@ module APILookup
     
     # Find an entry.
     # If the constant argument is passed, look it up within the scope of the constant.
-    def find_method(name, constant=nil)
+    def find_method(name, constant=nil, options = {})
+      scope = options[:api].entries || Entry
       methods = []
       # Full match
-      methods = Entry.find_all_by_name(name.to_s)
+      methods = scope.find_all_by_name(name.to_s)
       # Start match
-      methods = Entry.all(:conditions => ["name LIKE ?", name.to_s + "%"]) if methods.empty?
+      methods = scope.all(:conditions => ["entries.name LIKE ?", name.to_s + "%"]) if methods.empty?
       # Wildcard substitution
-      methods = Entry.find_by_sql("select * from entries where name LIKE '#{name.to_s.gsub("*", "%")}'") if methods.empty?
+      methods = scope.find_by_sql("select * from entries where name LIKE '#{name.to_s.gsub("*", "%")}'") if methods.empty?
       # Fuzzy match
-      methods = Entry.find_by_sql("select * from entries where name LIKE '%#{name.to_s.split("").join("%")}%'") if methods.empty?
+      methods = scope.find_by_sql("select * from entries where name LIKE '%#{name.to_s.split("").join("%")}%'") if methods.empty?
       
       # Weight the results, last result is the first one we want shown first
       methods = methods.sort_by(&:weighting)
     
       if constant
-        constants = find_constant(constant)
+        constants = find_constant(constant, nil, options)
         methods = methods.select { |m| constants.include?(m.constant) }
       end
       methods
@@ -101,36 +105,39 @@ module APILookup
       options[:api] ||= if /^1\.9/.match(msg)
         "Ruby 1.9"
       elsif /^1\.8/.match(msg)
-        "Ruby 1.8"
-      elsif /^Rails/i.match(msg)
-        "Rails"
+        "Ruby 1.8.7"
+      elsif /^v([\d\.]{5})/i.match(msg)
+        "Rails v#{$1}"
       end
       
+      options[:api] = Api.find_by_name!(options[:api]) unless options[:api].is_a?(Api)
+      
       msg = msg.gsub(/^(.*?)\s/, "") if options[:api]
       
       splitter = options[:splitter] || "#"
       parts = msg.split(" ")[0..-1].flatten.map { |a| a.split(splitter) }.flatten!
       # It's a constant! Oh... and there's nothing else in the string!
       first = smart_rails_constant_substitutions(parts.first)
+      
       output = if /^[A-Z]/.match(first) && parts.size == 1
-        find_constant(first)
+        find_constant(first, nil, options)
        # It's a method!
       else
         # Right, so they only specified one argument. Therefore, we look everywhere.
         if parts.size == 1
-          o = find_method(parts.last)
+          o = find_method(parts.last, nil, options)
         # Left, so they specified two arguments. First is probably a constant, so let's find that!
         else
-          o = find_method(parts.last, first)
+          o = find_method(parts.last, first, options)
         end
         o
       end
 
-      
       output = search(msg, options.merge(:splitter => ".")) if output.empty? && splitter != "."
-      
-      output = output.select { |m| m.api.name == options[:api] } if options[:api]
-      return output
+      selected_output = output.select { |m| options[:api].name == m.api.name }
+      selected_output = output if selected_output.empty?
+
+      return selected_output
     end
      
   end

data/lib/models.rb

@@ -21,6 +21,7 @@ module APILookup
   class Api < LookupBase
     set_table_name "apis"
     has_many :constants, :class_name => "APILookup::Constant"
+    has_many :entries, :through => :constants
     
     def update_methods!
       entries = []
@@ -29,7 +30,8 @@ module APILookup
       
       # Actual HTML on Ruby doc site is invalid. 
       # This makes it valid.
-      doc = Nokogiri::HTML(doc.gsub(/<a(.*?)>(.*?)<\/a>/) { "<a#{$1}>#{$2.gsub("<", "&lt;").gsub("&gt;", ">")}" })
+      doc = Nokogiri::HTML(doc.gsub(/<a(.*?)>(.*?)<\/a>/m) { "<a#{$1}>#{$2.gsub("<", "&lt;").gsub(">", "&gt;")}" })
+      
       doc.css("a").each do |a|
         names = a.text.split(" ")
         next if names.empty? 
@@ -37,10 +39,10 @@ module APILookup
         constant = names[1].gsub(/[\(|\)]/, "")
         # The same constant can be defined twice in different APIs, be wary!
         url = self.url + "/classes/" + constant.gsub("::", "/") + ".html"
-        constant = self.constants.find_or_create_by_hash(:name => constant, :url => url)
+        constant = self.constants.find_or_create_by_name_and_url(constant, url)
         
         url = self.url + "/" + a["href"]
-        constant.entries.find_or_create_by_hash(:name => method, :url => url)
+        constant.entries.find_or_create_by_name_and_url(method, url)
       end
       
       # entries.each_slice(100) do |methods|