rubydictionary 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+objects
+.DS_Store
+doc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rubydictionary.gemspec
+gemspec

data/Makefile

@@ -0,0 +1,52 @@
+#
+# Makefile
+#
+#
+#
+
+###########################
+
+# You need to edit these values.
+
+DICT_NAME		=	"Ruby"
+DICT_SRC_PATH		=	Ruby.xml
+CSS_PATH		=	Ruby.css
+PLIST_PATH		=	MyInfo.plist
+
+DICT_BUILD_OPTS		=
+# Suppress adding supplementary key.
+# DICT_BUILD_OPTS		=	-s 0	# Suppress adding supplementary key.
+
+###########################
+
+# The DICT_BUILD_TOOL_DIR value is used also in "build_dict.sh" script.
+# You need to set it when you invoke the script directly.
+
+DICT_BUILD_TOOL_DIR	=	"/Developer/Extras/Dictionary Development Kit"
+DICT_BUILD_TOOL_BIN	=	"$(DICT_BUILD_TOOL_DIR)/bin"
+
+###########################
+
+DICT_DEV_KIT_OBJ_DIR	=	./objects
+export	DICT_DEV_KIT_OBJ_DIR
+
+DESTINATION_FOLDER	=	~/Library/Dictionaries
+RM			=	/bin/rm
+
+###########################
+
+all:
+	"$(DICT_BUILD_TOOL_BIN)/build_dict.sh" $(DICT_BUILD_OPTS) $(DICT_NAME) $(DICT_SRC_PATH) $(CSS_PATH) $(PLIST_PATH)
+	echo "Done."
+
+
+install:
+	echo "Installing into $(DESTINATION_FOLDER)".
+	mkdir -p $(DESTINATION_FOLDER)
+	ditto --noextattr --norsrc $(DICT_DEV_KIT_OBJ_DIR)/$(DICT_NAME).dictionary  $(DESTINATION_FOLDER)/$(DICT_NAME).dictionary
+	touch $(DESTINATION_FOLDER)
+	echo "Done."
+	echo "To test the new dictionary, try Dictionary.app."
+
+clean:
+	$(RM) -rf $(DICT_DEV_KIT_OBJ_DIR)

data/MyInfo.plist

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleIdentifier</key>
+	<string>org.ruby-lang.Dictionary</string>
+	<key>CFBundleName</key>
+	<string>Ruby</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>DCSDictionaryCopyright</key>
+	<string>Copyright</string>
+	<key>DCSDictionaryManufacturerName</key>
+	<string>Ruby</string>
+	<key>DCSDictionaryFrontMatterReferenceID</key>
+	<string>front_back_matter</string>
+	<key>DCSDictionaryDefaultPrefs</key>
+	<dict>
+		<key>pronunciation</key>
+		<string>0</string>
+		<key>display-column</key>
+		<string>1</string>
+		<key>display-picture</key>
+		<string>1</string>
+		<key>version</key>
+		<string>1</string>
+	</dict>
+</dict>
+</plist>

data/README.markdown

@@ -0,0 +1,30 @@
+This gem adds `rubydictionary` formatter to RDoc.
+
+## Prerequisites
+
+You will need latest [*Xcode* developer tools](http://developer.apple.com/).
+
+## Install
+
+    gem install rubydictionary
+
+## Building dictionary
+
+Create documentation from the source code like you normally would. Only do not forget to pass `--format=rubydictionary` option:
+
+    rdoc --format=rubydictionary ./sourcedir
+
+If all goes well, you should have .dictionary file under ./doc directory. Drop it into `~/Library/Dictionaries/` folder.
+
+## TODO
+
+* Set RDoc options from command line:
+** Dictionary name
+** Dictionary title (optional, name is default)
+* Dictinary builder script:
+** Store RDoc results into xml file (into doc/ directory)
+** Prepare .plist file
+
+# Links
+
+* [Dictionary Services programming guide at Apple Developer site](http://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/DictionaryServicesProgGuide/index.html)

data/Rakefile

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

data/Ruby.css

@@ -0,0 +1,42 @@
+@charset "UTF-8";
+@namespace d url(http://www.apple.com/DTDs/DictionaryService-1.0.rng);
+
+d|entry {
+}
+
+h1, h2, h3 {
+	font-family: 'Helvetica Neue', Helvetica, sans-serif;
+	text-shadow: 0px 0px 0px #000;
+}
+
+h1 { font-size: 150%; }
+h1 .classname  { font-size: 80%; }
+h1 .methodtype { font-size: 80%; }
+h1 .visibility { font-size: 70%; font-weight: normal; }
+
+ul.classmethods    li { list-style-type: circle; }
+ul.instancemethods li { list-style-type: disc; }
+ul.attributes      li { list-style-type: none; }
+
+.access  { background-color: #000; color: #fff; border-radius: 5px; padding: 0 0 0 2px; text-align: center; font-size: 70%; margin-right: 5px; }
+.raccess { background-color: #666; }
+
+hr { border: none; border-bottom: 1px solid #ddd; }
+
+tt,
+pre,
+p.signatures {
+	font-family: Monaco;
+	font-size: 12px;
+}
+
+pre {
+	padding: 10px;
+	background-color: #eee;
+	border: 1px solid #ddd;
+}
+
+a {
+	color: #555;
+	text-decoration: none;
+}

data/bin/rubydictionary

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -KU
+
+require File.expand_path('../../lib/rubydictionary', __FILE__)
+
+ARGV.push('--format=rubydictionary') if ARGV.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
+r = RDoc::RDoc.new
+r.document ARGV
+
+# TODO: this below must be moved into special generator class
+dict_name = 'Ruby'
+dict_src_path = File.expand_path('../../doc/Ruby.xml', __FILE__)
+css_path = File.expand_path('../../Ruby.css', __FILE__)
+plist_path = File.expand_path('../../MyInfo.plist', __FILE__)
+
+dict_build_tool = "/Developer/Extras/Dictionary Development Kit/bin/build_dict.sh"
+
+%x{"#{dict_build_tool}" #{dict_name} #{dict_src_path} #{css_path} #{plist_path}}

data/dictionary_generator.rb

@@ -0,0 +1,121 @@
+#!/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/lib/rubydictionary/generator.rb

@@ -0,0 +1,99 @@
+require 'rdoc'
+require 'rdoc/rdoc'
+require 'rdoc/generator'
+
+require 'nokogiri'
+
+class Rubydictionary::Generator
+  
+  RDoc::RDoc.add_generator self
+  
+  XMLNS = 'http://www.w3.org/1999/xhtml'
+  
+  XMLNS_D = 'http://www.apple.com/DTDs/DictionaryService-1.0.rng'
+  
+  def self.setup_options(options)
+  end
+  
+  def initialize(options)
+  end
+  
+  def generate(top_levels)
+    
+    builder = Nokogiri::XML::Builder.new(:encoding => 'utf-8') do |xml|
+      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)
+        end
+      end
+    end
+    
+    puts "Writing into Ruby.xml..."
+    File.open('Ruby.xml', 'w') { |f| f << builder.to_xml }
+  end
+  
+  def class_dir
+    'classes'
+  end
+  
+  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)
+      
+      xml.div(:xmlns => XMLNS) do
+        xml.cdata cls.description
+      end
+
+      # Link to class methods
+      unless cls.class_method_list.empty?
+        xml.h3('Class methods', :xmlns => XMLNS)
+        xml.ul(:xmlns => XMLNS) do
+          cls.class_method_list.each do |mthd|
+            xml.li(:xmlns => XMLNS) do
+              xml.a(mthd.name, :href => method_url(mthd), :xmlns => XMLNS)
+            end
+          end
+        end
+      end
+      
+      # Link to instance methods
+      unless cls.instance_method_list.empty?
+        xml.h3('Instance methods', :xmlns => XMLNS)
+        xml.ul(:xmlns => XMLNS) do
+          cls.instance_method_list.each do |mthd|
+            xml.li(:xmlns => XMLNS) do
+              xml.a(mthd.name, :href => method_url(mthd), :xmlns => XMLNS)
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  def class_id(cls)
+    cls.full_name.downcase.gsub('::', '_')
+  end
+  
+  def class_title(cls)
+    cls.full_name
+  end
+  
+  def method_url(mthd)
+    "x-dictionary:r:method_#{method_id(mthd)}:org.ruby-lang.Dictionary"
+  end
+  
+  def method_id(mthd)
+    mthd.name
+  end
+end

data/lib/rubydictionary/version.rb

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

data/lib/rubydictionary.rb

@@ -0,0 +1,7 @@
+$:.unshift File.dirname(__FILE__)
+require 'rubygems'
+gem 'rdoc', '~> 3'
+
+module Rubydictionary end
+  
+require 'rubydictionary/generator'

data/rubydictionary.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'rubydictionary/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rubydictionary'
+  s.version     = Rubydictionary::VERSION
+  s.authors     = ['Priit Haamer']
+  s.email       = ['priit@fraktal.ee']
+  s.homepage    = 'https://github.com/priithaamer/rubydictionary'
+  s.summary     = %q{Adds "rubydictionary" formatter to RDoc}
+  s.description = %q{Builds dictionary files for Mac OS Dictionary.app of Ruby documentation using RDoc}
+
+  s.rubyforge_project = 'rubydictionary'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/templates/class.erb

@@ -0,0 +1,44 @@
+<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

@@ -0,0 +1,9 @@
+<?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

@@ -0,0 +1,11 @@
+<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>

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: rubydictionary
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Priit Haamer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-14 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Builds dictionary files for Mac OS Dictionary.app of Ruby documentation using RDoc
+email: 
+- priit@fraktal.ee
+executables: 
+- rubydictionary
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Makefile
+- MyInfo.plist
+- README.markdown
+- Rakefile
+- Ruby.css
+- bin/rubydictionary
+- dictionary_generator.rb
+- 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: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rubydictionary
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Adds "rubydictionary" formatter to RDoc
+test_files: []
+