rubydictionary 0.1.0 → 1.0.1

data/README.markdown

@@ -2,7 +2,13 @@ This gem adds `rubydictionary` formatter to RDoc.
 
 ## Prerequisites
 
-You will need latest [*Xcode* developer tools](http://developer.apple.com/).
+You will need latest [Command Line Tools for Xcode](https://developer.apple.com/downloads/index.action).
+
+### Dictionary Development Kit
+
+Since OS X Mountain Lion, Dictionary Development Kit required to build dictionaries is not included by default with developer tools.
+
+Dictionary Development Kit can be downloaded from [Downloads for Apple Developers](https://developer.apple.com/downloads/index.action) page and it is inside **Auxiliary Tools for Xcode** package. You must copy `Dictionary Development Kit` manually to `/Developer/Extras` folder.
 
 ## Install
 
@@ -12,9 +18,18 @@ 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 --dict-name=Sinatra --dict-id=com.sinatrarb.Dictionary
+    rubydictionary \
+				--dict-name=Sinatra \
+				--dict-id=com.sinatrarb.Dictionary
+
+If everything goes well, you should now have `Sinatra.dictionary` file under `./doc/objects` directory. Drop it into `~/Library/Dictionaries/` folder.
+
+If Dictionary Development Kit is located somewhere else than in `/Developer/Extras` (which is recommended in 10.9+), you can specify the path for it with `--kit-path` option:
 
-If all goes well, you should now have `Sinatra.dictionary` file under `./doc/objects` directory. Drop it into `~/Library/Dictionaries/` folder.
+		rubydictionary \
+				--dict-name=Sinatra \
+				--dict-id=com.sinatrarb.Dictionary \
+				--kit-path=~/Source/DictionaryDevKit
 
 ## Authors
 
@@ -23,4 +38,4 @@ See the [Github contributors page](https://github.com/priithaamer/rubydictionary
 ## 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)
+* [https://github.com/breakpointer/ajax-rdoc](https://github.com/breakpointer/ajax-rdoc)

data/lib/rubydictionary/generator.rb

@@ -9,6 +9,8 @@ class RDoc::Options
   attr_accessor :dictionary_name
   
   attr_accessor :dictionary_identifier
+  
+  attr_accessor :kit_path
 end
 
 class RDoc::Generator::Dictionary
@@ -21,20 +23,18 @@ class RDoc::Generator::Dictionary
 
   # 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|
+    opt.on('--dict-id=IDENTIFIER', 'Dictionary bundle identifier, such as', 'org.rubyonrails.Rails') do |value|
       options.dictionary_identifier = value
     end
+    opt.on('--kit-path=DICTIONARY_KIT_PATH', 'Full path to Dictionary Development Kit') do |value|
+      options.kit_path = value
+    end
     opt.separator nil
   end
   
@@ -50,7 +50,7 @@ class RDoc::Generator::Dictionary
   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
+        xml.parent.namespace = xml.parent.add_namespace_definition('d', XMLNS_D)
         
         RDoc::TopLevel.all_classes_and_modules.each do |clazz|
           unless @class_ids.include?(class_id(clazz))
@@ -79,11 +79,15 @@ class RDoc::Generator::Dictionary
     
     plist_path = File.join(Pathname.pwd, 'Dictionary.plist')
     
-    dict_build_tool = "/Developer/Extras/Dictionary Development Kit/bin/build_dict.sh"
+    dict_build_tool = File.join((@options.kit_path || '/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 file_dir
+    ''
+  end
+  
   def class_dir
     'classes'
   end
@@ -92,14 +96,15 @@ class RDoc::Generator::Dictionary
   
   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.parent.namespace = xml.parent.add_namespace_definition('d', XMLNS_D)
+      xml.index('d:value' => cls.full_name) { xml.parent.namespace = xml.parent.add_namespace_definition('d', XMLNS_D) }
       
       xml.h1(cls.full_name, :xmlns => XMLNS)
       
       xml.div(:xmlns => XMLNS) do
-        xml << cls.description
+        xml << strip_pre_markup(cls.description)
       end
-
+      
       # Link to class methods
       unless cls.class_method_list.empty?
         xml.h3('Class methods', :xmlns => XMLNS)
@@ -128,15 +133,17 @@ class RDoc::Generator::Dictionary
   
   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.parent.namespace = xml.parent.add_namespace_definition('d', XMLNS_D)
+      
+      xml.index('d:value' => mthd.full_name) { xml.parent.namespace = xml.parent.add_namespace_definition('d', XMLNS_D) }
+      xml.index('d:value' => mthd.name) { xml.parent.namespace = xml.parent.add_namespace_definition('d', XMLNS_D) }
       
       xml.h1(mthd.arglists, :xmlns => XMLNS)
       
       xml.p(mthd.full_name, :class => 'method_name', :xmlns => XMLNS)
       
       xml.div(:xmlns => XMLNS) do
-        xml << mthd.description
+        xml << strip_pre_markup(mthd.description)
       end
     end
   end
@@ -161,6 +168,13 @@ class RDoc::Generator::Dictionary
     'method_' << mthd.object_id.to_s(36)
   end
   
+  # Strips ruby markup span elements generated by RDoc
+  def strip_pre_markup(content)
+    content.gsub!(/<pre class="ruby">.*?<\/pre>/m) do |m|
+      '<pre>' + m.gsub(/<\/?[^>]*>/, '') + '</pre>'
+    end
+  end
+  
   def bundle_identifier
     @options.dictionary_identifier
   end

data/lib/rubydictionary/version.rb

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

data/rubydictionary.gemspec

@@ -17,4 +17,8 @@ Gem::Specification.new do |s|
   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']
+  
+  %w(rake).each do |gem|
+    s.add_development_dependency *gem.split(' ')
+  end
 end

metadata

@@ -1,34 +1,41 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rubydictionary
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Priit Haamer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-07 00:00:00 +03:00
-default_executable: 
-dependencies: []
-
-description: Builds dictionary files for Mac OS Dictionary.app of Ruby documentation using RDoc
-email: 
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Builds dictionary files for Mac OS Dictionary.app of Ruby documentation
+  using RDoc
+email:
 - priit@fraktal.ee
-executables: 
+executables:
 - rubydictionary
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.markdown
@@ -40,39 +47,34 @@ files:
 - lib/rubydictionary/generator.rb
 - lib/rubydictionary/version.rb
 - rubydictionary.gemspec
-has_rdoc: true
 homepage: https://github.com/priithaamer/rubydictionary
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1703439815085221063
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1703439815085221063
 requirements: []
-
 rubyforge_project: rubydictionary
-rubygems_version: 1.4.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Adds "rubydictionary" formatter to RDoc
 test_files: []
-