doc_to_dash 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Caleb Mingle
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# DocToDash
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doc_to_dash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doc_to_dash
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/doc_to_dash.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doc_to_dash/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "doc_to_dash"
+  gem.version       = DocToDash::VERSION
+  gem.authors       = ["Caleb Mingle"]
+  gem.email         = ["me@caleb.io"]
+  gem.description   = "Converts documentation to a Dash Docset"
+  gem.summary       = "Documentation to Dash Docset Converter"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "sqlite3"
+end

data/lib/doc_to_dash/version.rb

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

data/lib/doc_to_dash/yard_parser.rb

@@ -0,0 +1,39 @@
+module DocToDash
+  class YardParser
+    def initialize(doc_directory)
+      @doc_directory = doc_directory
+    end
+
+    def parse_methods
+      classes_file = File.read(@doc_directory + '/class_list.html')
+      classes_html = Nokogiri::HTML(classes_file)
+      classes      = []
+
+      classes_html.xpath('//li').children.select{|c| c.name == "span"}.each do |method|
+        a     = method.children.first
+        title = a.children.first.to_s.gsub('#', '')
+        href  = a["href"].to_s
+
+        classes << [href, title] unless title == "Top Level Namespace"
+      end
+
+      classes
+    end
+
+    def parse_classes
+      methods_file = File.read(@doc_directory + '/method_list.html')
+      methods_html = Nokogiri::HTML(methods_file)
+      methods      = []
+
+      methods_html.xpath('//li').children.select{|c| c.name == "span"}.each do |method|
+        a     = method.children.first
+        href  = a["href"].to_s
+        name  = a["title"].to_s.gsub(/\((.+)\)/, '').strip! # Strip the (ClassName) and whitespace.
+
+        methods << [href, name]
+      end
+
+      methods
+    end
+  end
+end

data/lib/doc_to_dash.rb

@@ -0,0 +1,145 @@
+require "doc_to_dash/version"
+require "doc_to_dash/yard_parser"
+require 'sqlite3'
+require 'fileutils'
+require 'nokogiri'
+
+module DocToDash
+  class DocsetGenerator
+    def initialize(options = {})
+      @classes      = []
+      @methods      = []
+
+      @options = {
+          :docset_name            => 'DefaultDocset',
+          :docset_output_path     => 'doc/',      # This is where the actual package will be created.
+          :docset_output_filename => lambda {@options[:docset_name] + '.docset' },
+          :icon_path              => nil,                                                         # This is the docset icon that never changes, if you want a default icon just set this to nil.
+          :doc_input_path         => nil,                                                         # This is the actual docs to copy over to the Docset.
+          :doc_save_folder        => 'docs',                                                      # This is the directory name it will store under /Contents/Resources/Documents/{this}
+          :verbose                => true,
+          :parser                 => DocToDash::YardParser
+      }.merge(options)
+
+      @docset_path    = File.expand_path(@options[:docset_output_path]) + '/' + @options[:docset_output_filename].call
+      @doc_directory  = @docset_path + '/Contents/Resources/Documents/' + @options[:doc_save_folder]
+    end
+
+    def run
+      log "Beginning to generate Dash Docset."
+
+      unless check_and_format_options
+        log "Error: " + @error # There was an error of some sort..
+        return false
+      end
+
+      clean_up_files
+      create_structure
+      copy_default_files
+      copy_docs_to_docset
+
+      create_database
+
+      parser = @options[:parser].new(@doc_directory)
+
+      @classes = parser.parse_classes
+      @methods = parser.parse_methods
+
+      load_methods_into_database
+      load_classes_into_database
+
+      log "Docset created."
+
+      @docset_path
+    end
+
+    private
+
+    def log(message)
+      puts "=> #{message}" if @options[:verbose]
+    end
+
+    def check_and_format_options
+      if @options[:doc_input_path].nil?
+        @error = "You must provide a path to your docs. (:doc_input_path)"
+        return false
+      end
+
+      if @options[:doc_save_folder].nil?
+        @error = "You must provide a doc_path_name for us to save under. (:doc_save_folder)"
+        return false
+      end
+
+      @options[:doc_input_path] = File.expand_path(@options[:doc_input_path])
+
+      true
+    end
+
+    def clean_up_files
+      log "Removing old Docset."
+      FileUtils.rm_rf(@docset_path) if Dir.exist?(@docset_path)
+    end
+
+    def create_structure
+      log "Creating new Docset structure."
+
+      FileUtils.mkdir_p(@docset_path)
+      FileUtils.mkdir_p(@docset_path + '/' + 'Contents/Resources/Documents/')
+    end
+
+    def copy_default_files
+      log "Copy default Docset files over."
+
+      FileUtils.cp @options[:icon_path], @docset_path + '/' unless @options[:icon_path].nil?
+      File.open(@docset_path + '/Contents/Info.plist', 'w+') { |file| file.write(default_plist.gsub('{DOCSET_NAME}', @options[:docset_name])) }
+    end
+
+    def copy_docs_to_docset
+      log "Copying documentation to Docset."
+
+      new_doc_path  = @docset_path + '/Contents/Resources/Documents/'
+      FileUtils.cp_r @options[:doc_input_path], new_doc_path
+      FileUtils.mv new_doc_path + File.basename(@options[:doc_input_path]), new_doc_path + @options[:doc_save_folder]
+    end
+
+    def create_database
+      log "Creating Docset index database."
+
+      @db = SQLite3::Database.new(@docset_path + '/Contents/Resources/docSet.dsidx')
+      @db.execute('CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT)')
+    end
+
+    def load_methods_into_database
+      log "Loading methods into database."
+      insert_into_database @methods, 'clm'
+    end
+
+    def load_classes_into_database
+      log "Loading classes into database."
+      insert_into_database @classes, 'cl'
+    end
+
+    def insert_into_database(array, type)
+      array.each { |item| @db.execute("insert into searchIndex (name, type, path) VALUES(?, ?, ?)", item.last, type, @options[:doc_save_folder] + '/' + item.first) }
+    end
+
+    def default_plist
+      return <<XML
+        <?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>CFBundleIdentifier</key>
+          <string>{DOCSET_NAME}</string>
+          <key>CFBundleName</key>
+          <string>{DOCSET_NAME}</string>
+          <key>DocSetPlatformFamily</key>
+          <string>{DOCSET_NAME}</string>
+          <key>isDashDocset</key>
+          <true/>
+        </dict>
+        </plist>
+XML
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: doc_to_dash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Caleb Mingle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Converts documentation to a Dash Docset
+email:
+- me@caleb.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc_to_dash.gemspec
+- lib/doc_to_dash.rb
+- lib/doc_to_dash/version.rb
+- lib/doc_to_dash/yard_parser.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Documentation to Dash Docset Converter
+test_files: []