rubydictionary 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
 objects
 .DS_Store
 doc
+pkg

data/README.markdown

@@ -10,21 +10,13 @@ You will need latest [*Xcode* developer tools](http://developer.apple.com/).
 
 ## Building dictionary
 
-Create documentation from the source code like you normally would. Only do not forget to pass `--format=rubydictionary` option:
+Run `rubydictionary` in your source code directory. For example for source of Sinatra:
 
-    rdoc --format=rubydictionary ./sourcedir
+    rubydictionary --format=rubydictionary --dict-name=Sinatra --dict-id=com.sinatrarb.Dictionary
 
-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
+If all goes well, you should have Sinatra.dictionary file under ./doc/objects directory. Drop it into `~/Library/Dictionaries/` folder.
 
 # 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,16 +2,6 @@
 
 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?
+ARGV.push('--format=dictionary') 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/{MyInfo.plist → lib/rdoc/generator/template/Dictionary.plist.erb}

@@ -5,15 +5,15 @@
 	<key>CFBundleDevelopmentRegion</key>
 	<string>English</string>
 	<key>CFBundleIdentifier</key>
-	<string>org.ruby-lang.Dictionary</string>
+	<string><%= bundle_identifier %></string>
 	<key>CFBundleName</key>
-	<string>Ruby</string>
+	<string><%= bundle_name %></string>
 	<key>CFBundleShortVersionString</key>
 	<string>1.0</string>
 	<key>DCSDictionaryCopyright</key>
 	<string>Copyright</string>
 	<key>DCSDictionaryManufacturerName</key>
-	<string>Ruby</string>
+	<string><%= bundle_name %></string>
 	<key>DCSDictionaryFrontMatterReferenceID</key>
 	<string>front_back_matter</string>
 	<key>DCSDictionaryDefaultPrefs</key>

data/lib/rubydictionary/generator.rb

@@ -1,37 +1,76 @@
+require 'erb'
 require 'rdoc'
 require 'rdoc/rdoc'
 require 'rdoc/generator'
 
 require 'nokogiri'
 
-class Rubydictionary::Generator
+class RDoc::Options
+  attr_accessor :dictionary_name
+  
+  attr_accessor :dictionary_identifier
+end
+
+class RDoc::Generator::Dictionary
   
   RDoc::RDoc.add_generator self
   
   XMLNS = 'http://www.w3.org/1999/xhtml'
   
   XMLNS_D = 'http://www.apple.com/DTDs/DictionaryService-1.0.rng'
-  
+
+  # TODO: Raise an error when dictionary name is missing
   def self.setup_options(options)
+    options.dictionary_identifier = 'com.priithaamer.Dictionary'
+    
+    opt = options.option_parser
+    opt.separator "Dictionary generator options:"
+    opt.separator nil
+    opt.on('--dict-name=NAME', 'Title that appears in Dictionary.app') do |value|
+      options.dictionary_name = value
+    end
+    opt.on('--dict-id=IDENTIFIER',
+           'Dictionary bundle identifier, such as',
+           'org.rubyonrails.Rails'
+           ) do |value|
+      options.dictionary_identifier = value
+    end
+    opt.separator nil
   end
   
   def initialize(options)
+    @options = options
+    @template_dir = Pathname.new(File.expand_path('../../rdoc/generator/template', __FILE__))
   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)
+          clazz.method_list.each do |mthd|
+            append_method_entry(mthd, xml)
+          end
         end
       end
     end
     
-    puts "Writing into Ruby.xml..."
-    File.open('Ruby.xml', 'w') { |f| f << builder.to_xml }
+    xml_file = 'Dictionary.xml'
+    
+    File.open(File.join(Pathname.pwd, xml_file), 'w') { |f| f << builder.to_xml }
+    
+    dict_src_path = File.join(Pathname.pwd, xml_file)
+    
+    css_path = File.join(@template_dir, 'Dictionary.css')
+    File.open(File.join(Pathname.pwd, 'Dictionary.plist'), 'w') { |f| f.write render_plist(@options.dictionary_name, bundle_identifier) }
+    
+    plist_path = File.join(Pathname.pwd, 'Dictionary.plist')
+    
+    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}}
   end
   
   def class_dir
@@ -52,7 +91,7 @@ class Rubydictionary::Generator
       xml.h1(cls.full_name, :xmlns => XMLNS)
       
       xml.div(:xmlns => XMLNS) do
-        xml.cdata cls.description
+        xml << cls.description
       end
 
       # Link to class methods
@@ -81,19 +120,57 @@ class Rubydictionary::Generator
     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.div(:xmlns => XMLNS) do
+        xml << mthd.description
+      end
+    end
+  end
+  
   def class_id(cls)
-    cls.full_name.downcase.gsub('::', '_')
+    'class_' << cls.object_id.to_s(36)
   end
   
   def class_title(cls)
     cls.full_name
   end
   
+  def method_title(mthd)
+    # TODO: escape <>
+    mthd.name
+  end
+  
   def method_url(mthd)
-    "x-dictionary:r:method_#{method_id(mthd)}:org.ruby-lang.Dictionary"
+    "x-dictionary:r:#{method_id(mthd)}:#{bundle_identifier}"
   end
   
   def method_id(mthd)
-    mthd.name
+    'method_' << mthd.object_id.to_s(36)
+  end
+  
+  def bundle_identifier
+    @options.dictionary_identifier
+  end
+  
+  # Render .plist file from erb template
+  def render_plist(bundle_name, bundle_identifier)
+    ERB.new(File.read(File.join(@template_dir, 'Dictionary.plist.erb'))).result(binding)
   end
 end

data/lib/rubydictionary/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubydictionary
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Priit Haamer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-14 00:00:00 +03:00
+date: 2011-10-03 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -31,13 +31,12 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Makefile
-- MyInfo.plist
 - README.markdown
 - Rakefile
-- Ruby.css
 - 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

data/Makefile

@@ -1,52 +0,0 @@
-#
-# 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)