rubydictionary 0.0.2 → 0.1.0

data/README.markdown

@@ -12,11 +12,15 @@ You will need latest [*Xcode* developer tools](http://developer.apple.com/).
 
 Run `rubydictionary` in your source code directory. For example for source of Sinatra:
 
-    rubydictionary --format=rubydictionary --dict-name=Sinatra --dict-id=com.sinatrarb.Dictionary
+    rubydictionary --dict-name=Sinatra --dict-id=com.sinatrarb.Dictionary
 
-If all goes well, you should have Sinatra.dictionary file under ./doc/objects directory. Drop it into `~/Library/Dictionaries/` folder.
+If all goes well, you should now have `Sinatra.dictionary` file under `./doc/objects` directory. Drop it into `~/Library/Dictionaries/` folder.
 
-# Links
+## Authors
+
+See the [Github contributors page](https://github.com/priithaamer/rubydictionary/contributors).
+
+## Links
 
 * [Dictionary Services programming guide at Apple Developer site](http://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/DictionaryServicesProgGuide/index.html)
 * [https://github.com/breakpointer/ajax-rdoc](https://github.com/breakpointer/ajax-rdoc)

data/bin/rubydictionary

@@ -2,6 +2,6 @@
 
 require File.expand_path('../../lib/rubydictionary', __FILE__)
 
-ARGV.push('--format=dictionary') if ARGV.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
+ARGV.unshift('--format=dictionary') if ARGV.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
 r = RDoc::RDoc.new
 r.document ARGV

data/lib/rdoc/generator/template/Dictionary.css

@@ -6,10 +6,9 @@ d|entry {
 
 h1, h2, h3 {
 	font-family: 'Helvetica Neue', Helvetica, sans-serif;
-	text-shadow: 0px 0px 0px #000;
 }
 
-h1 { font-size: 150%; }
+h1 { font-size: 130%; }
 h1 .classname  { font-size: 80%; }
 h1 .methodtype { font-size: 80%; }
 h1 .visibility { font-size: 70%; font-weight: normal; }
@@ -23,20 +22,35 @@ ul.attributes      li { list-style-type: none; }
 
 hr { border: none; border-bottom: 1px solid #ddd; }
 
+p.method_name {
+  color: #666;
+  font-family: 'Helvetica Neue', Helvetica, sans-serif;
+  font-size: 90%;
+  font-weight: bold;
+}
+
+dl.rdoc-list dt {
+  font-weight: bold;
+}
+
 tt,
 pre,
 p.signatures {
-	font-family: Monaco;
+	font-family: Inconsolata, Monaco;
 	font-size: 12px;
 }
 
 pre {
-	padding: 10px;
-	background-color: #eee;
-	border: 1px solid #ddd;
+  background: rgb(254,251,243);
+  border: 1px solid rgba(0,0,0,0.2);
+  color: rgb(5, 75, 125);
+  line-height: 16px;
+  padding: 9px;
+  -webkit-border-radius: 3px;
+  -webkit-box-shadow: 0 1px 2px rgba(0,0,0,0.1);
 }
 
 a {
-	color: #555;
+  color: rgb(41, 113, 167);
 	text-decoration: none;
 }

data/lib/rubydictionary/generator.rb

@@ -41,6 +41,10 @@ class RDoc::Generator::Dictionary
   def initialize(options)
     @options = options
     @template_dir = Pathname.new(File.expand_path('../../rdoc/generator/template', __FILE__))
+    
+    # Keep the track of methods and classes already rendered and avoid duplication
+    @class_ids = []
+    @method_ids = []
   end
   
   def generate(top_levels)
@@ -48,10 +52,17 @@ class RDoc::Generator::Dictionary
       xml.send('dictionary', 'xmlns' => XMLNS, 'xmlns:d' => XMLNS_D) do
         xml.parent.namespace = xml.parent.namespace_definitions.first
         
-        RDoc::TopLevel.all_classes.each do |clazz|
-          append_class_entry(clazz, xml)
-          clazz.method_list.each do |mthd|
-            append_method_entry(mthd, xml)
+        RDoc::TopLevel.all_classes_and_modules.each do |clazz|
+          unless @class_ids.include?(class_id(clazz))
+            append_class_entry(clazz, xml)
+            @class_ids << class_id(clazz)
+            
+            clazz.method_list.each do |mthd|
+              unless @method_ids.include?(method_id(mthd))
+                append_method_entry(mthd, xml)
+                @method_ids << method_id(mthd)
+              end
+            end
           end
         end
       end
@@ -70,7 +81,7 @@ class RDoc::Generator::Dictionary
     
     dict_build_tool = "/Developer/Extras/Dictionary Development Kit/bin/build_dict.sh"
     
-    %x{"#{dict_build_tool}" #{@options.dictionary_name} #{dict_src_path} #{css_path} #{plist_path}}
+    %x{"#{dict_build_tool}" "#{@options.dictionary_name}" #{dict_src_path} #{css_path} #{plist_path}}
   end
   
   def class_dir
@@ -79,14 +90,9 @@ class RDoc::Generator::Dictionary
   
   private
   
-  # <d:entry id="activerecord_base" d:title="ActiveRecord::Base">
-  #     <d:index d:value="ActiveRecord::Base"/>
-  #     <d:index d:value="Base"/>
-  #     <h1>ActiveRecord::Base</h1>
   def append_class_entry(cls, xml)
     xml.entry('id' => class_id(cls), 'd:title' => class_title(cls)) do
       xml.index('d:value' => cls.full_name)
-      # xml.index('d:value' => class_index_name(clazz))
       
       xml.h1(cls.full_name, :xmlns => XMLNS)
       
@@ -120,23 +126,14 @@ class RDoc::Generator::Dictionary
     end
   end
   
-  # <d:entry id="method_method_id" d:title="method-Name">
-  #     <d:index d:value="method full name"/>
-  #     <d:index d:value="method name"/>
-  #     <h1><a href="x-dictionary:r:class_id:org.ruby-lang.Dictionary">class full name</a> <span class="methodtype"> <%= @method.singleton ? '::' : '#' %> </span> <%= @method.name.escape %> <span class="visibility">(<%= @method.visibility %>)</span></h1>
-  #     <% unless @method.arglists.nil? %><p class="signatures"><%= @method.arglists.escape %></p><% end %>
-  #     <% unless !@method.respond_to?(:aliases) || @method.aliases.empty? %><p>Aliases: <%= @method.aliases.map {|a| a.new_name }.join(", ").escape %></p><% end %>
-  #     <% unless !@method.respond_to?(:is_alias_for) || @method.is_alias_for.nil? %><p>Alias for: <%= @method.is_alias_for.escape %></p><% end %>
-  #     <% unless @description.empty? %>
-  #     <%= @description %>
-  #     <% end %>
-  # </d:entry>
   def append_method_entry(mthd, xml)
     xml.entry('id' => method_id(mthd), 'd:title' => method_title(mthd)) do
       xml.index('d:value' => mthd.full_name)
       xml.index('d:value' => mthd.name)
       
-      xml.h1(mthd.full_name, :xmlns => XMLNS)
+      xml.h1(mthd.arglists, :xmlns => XMLNS)
+      
+      xml.p(mthd.full_name, :class => 'method_name', :xmlns => XMLNS)
       
       xml.div(:xmlns => XMLNS) do
         xml << mthd.description
@@ -153,7 +150,6 @@ class RDoc::Generator::Dictionary
   end
   
   def method_title(mthd)
-    # TODO: escape <>
     mthd.name
   end
   

data/lib/rubydictionary/version.rb

@@ -1,3 +1,3 @@
 module Rubydictionary
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Priit Haamer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 +03:00
+date: 2011-10-07 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -34,16 +34,12 @@ files:
 - README.markdown
 - Rakefile
 - bin/rubydictionary
-- dictionary_generator.rb
 - lib/rdoc/generator/template/Dictionary.css
 - lib/rdoc/generator/template/Dictionary.plist.erb
 - lib/rubydictionary.rb
 - lib/rubydictionary/generator.rb
 - lib/rubydictionary/version.rb
 - rubydictionary.gemspec
-- templates/class.erb
-- templates/dictionary.erb
-- templates/method.erb
 has_rdoc: true
 homepage: https://github.com/priithaamer/rubydictionary
 licenses: []

data/dictionary_generator.rb

@@ -1,121 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'erb'
-require 'rubygems'
-require 'iconv'
-
-gem 'rdoc', '>= 0'
-require 'rdoc/ri'
-require 'rdoc/ri/store'
-require 'rdoc/ri/paths'
-require 'rdoc/markup'
-require 'rdoc/markup/formatter'
-require 'rdoc/text'
-
-class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
-  def self.gen_relative_url(path, target)
-    nil
-  end
-end
-
-class String
-  def escape
-    gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;").gsub("'", "&apos;").gsub("\"", "&quot;")
-  end
-  def to_id
-    downcase.gsub('::', '_')
-  end
-end
-
-def get_template(file)
-  erb = ''
-  File.open("./templates/#{file}", 'r') { |f| erb = f.read }
-  ERB.new(erb)
-end
-
-class_template = get_template('class.erb')
-
-def render_class(klass)
-  tpl = get_template('class.erb')
-  @class = klass
-  @class_methods = klass.method_list.reject{ |m| !m.singleton }.sort{ |a,b| a.name <=> b.name }
-  @instance_methods = klass.method_list.reject{ |m| m.singleton }.sort{ |a,b| a.name <=> b.name }
-  begin
-    @description = @iconv.iconv(klass.comment.accept(@formatter))
-  rescue
-    @description = ""
-  end
-  tpl.result(binding)
-end
-
-def render_class_method(klass, method)
-  tpl = get_template('method.erb')
-  @klass = klass
-  @method = method
-  begin
-    @description = @iconv.iconv(method.comment.accept(@formatter))
-  rescue
-    @description = ""
-  end
-  tpl.result(binding)
-end
-
-puts "Loading Ruby documentation"
-
-classes = {}
-class_methods    = {}
-instance_methods = {}
-stores = []
-class_count = 0
-count = 0
-
-@formatter = RDoc::Markup::ToHtml.new
-@iconv = Iconv.new('UTF-8//IGNORE', 'UTF-8')
-
-RDoc::RI::Paths.each(true, true, true, true) do |path, type|
-  $stderr.puts path
-  store = RDoc::RI::Store.new(path, type)
-  store.load_cache
-  stores << store
-  class_count += store.modules.count
-end
-
-stores.each do |store|
-  store.modules.each do |name|
-    count += 1
-    $stderr << "Parse [#{count}/#{class_count}]...\r"
-    klass = store.load_class(name)
-    oldklass = classes[name]
-    unless oldklass.nil? || oldklass.method_list.count < klass.method_list.count
-      $stderr.puts "Skipping #{name}..."
-      next
-    end
-    classes[name] = klass
-    klass.method_list.each_index do |index|
-      method = klass.method_list[index]
-      begin
-        method = store.load_method(name, "#{method.singleton ? '::' : '#'}#{method.name}")
-        klass.method_list[index] = method
-      rescue Errno::ENOENT => e
-        $stderr.puts e
-      end
-    end
-  end
-end
-
-puts "Building XML files from sources"
-
-@classes = []
-@methods = []
-count = 0
-
-classes.each do |name, klass|
-  count += 1
-  $stderr << "Render [#{count}/#{class_count}]...\r"
-  @classes << render_class(klass)
-  klass.method_list.each { |method| @methods << render_class_method(klass, method) }
-end
-
-File.open('./Ruby.xml', 'w') { |file| file.puts get_template('dictionary.erb').result(binding) }
-
-puts "Dictionary XML file generation complete"

data/templates/class.erb

@@ -1,44 +0,0 @@
-<d:entry id="class_<%= @class.object_id.to_s(36) %>" d:title="<%= @class.full_name.escape %>">
-    <d:index d:value="<%= @class.full_name.escape %>"/>
-    <d:index d:value="<%= @class.name.escape %>"/>
-    <h1><%= @class.full_name.escape %></h1>
-    <% unless @description.empty? %>
-    <%= @description %>
-    <% end %>
-
-    <% unless @class_methods.empty? %>
-    <h3>Class methods</h3>
-    <ul class="classmethods">
-      <% for method in @class_methods %>
-      <li><a href="x-dictionary:r:method_<%= method.object_id.to_s(36) %>:org.ruby-lang.Dictionary"><%= method.name.escape %></a></li>
-      <% end %>
-    </ul>
-    <% end %>
-    
-    <% unless @instance_methods.empty? %>
-    <h3>Instance methods</h3>
-    <ul class="instancemethods">
-      <% for method in @instance_methods %>
-      <li><a href="x-dictionary:r:method_<%= method.object_id.to_s(36) %>:org.ruby-lang.Dictionary"><%= method.name.escape %></a></li>
-      <% end %>
-    </ul>
-    <% end %>
-    
-    <% unless @class.constants.empty? %>
-    <h3>Constants</h3>
-    <ul class="constants">
-    <% for constant in @class.constants %>
-      <li><tt><%= constant.name.escape %><% unless constant.value.nil? %>= <%= constant.value.escape %><% end %></tt> <% if constant.comment.respond_to?(:accept) %><%= @iconv.iconv(constant.comment.accept(@formatter)) %><% end %></li>
-    <% end %>
-    </ul>
-    <% end %>
-    
-    <% unless @class.attributes.empty? %>
-    <h3>Attributes</h3>
-    <ul class="attributes">
-    <% for attrib in @class.attributes %>
-      <li><span class="access <%= attrib.rw.downcase %>access"> <%= attrib.rw %> </span> <%= attrib.name.escape %> <% if attrib.comment.respond_to?(:accept) %><%= @iconv.iconv(attrib.comment.accept(@formatter)) %><% end %></li>
-    <% end %>
-    </ul>
-    <% end %>
-</d:entry>

data/templates/dictionary.erb

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<d:dictionary xmlns="http://www.w3.org/1999/xhtml" xmlns:d="http://www.apple.com/DTDs/DictionaryService-1.0.rng">
-<% for cls in @classes %>
-<%= cls %>
-<% end %>
-<% for mthd in @methods %>
-<%= mthd %>
-<% end %>
-</d:dictionary>

data/templates/method.erb

@@ -1,11 +0,0 @@
-<d:entry id="method_<%= @method.object_id.to_s(36) %>" d:title="<%= @method.name.escape %>">
-    <d:index d:value="<%= @method.full_name.escape %>"/>
-    <d:index d:value="<%= @method.name.escape %>"/>
-    <h1><a href="x-dictionary:r:class_<%= @class.object_id.to_s(36) %>:org.ruby-lang.Dictionary"><%= @class.full_name.escape %></a> <span class="methodtype"> <%= @method.singleton ? '::' : '#' %> </span> <%= @method.name.escape %> <span class="visibility">(<%= @method.visibility %>)</span></h1>
-    <% unless @method.arglists.nil? %><p class="signatures"><%= @method.arglists.escape %></p><% end %>
-    <% unless !@method.respond_to?(:aliases) || @method.aliases.empty? %><p>Aliases: <%= @method.aliases.map {|a| a.new_name }.join(", ").escape %></p><% end %>
-    <% unless !@method.respond_to?(:is_alias_for) || @method.is_alias_for.nil? %><p>Alias for: <%= @method.is_alias_for.escape %></p><% end %>
-    <% unless @description.empty? %>
-    <%= @description %>
-    <% end %>
-</d:entry>