cocoadex 1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Delisa Mason
+
+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/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Delisa Mason
+
+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/bin/cocoadex

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'methadone'
+require 'nokogiri'
+require 'cocoadex'
+
+include Methadone::Main
+include Methadone::CLILogging
+include Cocoadex
+
+logger.error_level = Logger::ERROR
+
+main do |arg|
+  if options[:verbose]
+    logger.error_level = Logger::DEBUG
+  end
+
+  if options[:docset] and path = File.expand_path(options[:docset].first)
+    Parser.parse(path)
+  end
+
+
+  if options[:search] and text = options[:search].first
+    if Keyword.loaded?
+      logger.debug "Loading index..."
+      Keyword.read
+      search(text)
+    else
+      puts "No DocSets loaded"
+    end
+  end
+end
+
+def search term
+  if term and not term.strip.empty?
+    objects = Keyword.find(term.strip)
+    if objects.size == 0
+      puts "No matches found"
+    elsif objects.size == 1
+      objects.first.print
+    else
+      objects.each_with_index do |obj, index|
+        puts "#{index} #{obj}"
+      end
+      puts "Select:"
+      which = gets
+      begin
+        index = [[which.to_i,0].max,objects.size - 1].min
+        objects[index].print
+      rescue Exception => e
+        puts ":("
+      end
+    end
+  end
+end
+
+version Cocoadex::VERSION
+description 'A Class Reference Utility for Cocoa APIs'
+
+on("--verbose","Be verbose")
+
+on("-d DOCSET","--docset","DocSet",/^(.*)$/)
+on("-s QUERY","--search","Search",/^(.*)$/)
+
+# todo: support --platform, --platform-version, --language, --first, --force
+
+go!

data/cocoadex.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cocoadex/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Delisa Mason"]
+  gem.email         = ["iskanamagus@gmail.com"]
+  gem.description   = %q{A reference utility for Cocoa APIs}
+  gem.summary       = %q{A command-line reference utility for Cocoa APIs.}
+  gem.homepage      = "https://kattrali.github.com/cocoadex"
+
+  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.name          = "cocoadex"
+  gem.require_paths = ["lib"]
+  gem.version       = Cocoadex::VERSION
+  gem.add_development_dependency('bacon')
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('aruba')
+  gem.add_development_dependency('rake','~> 0.9.2')
+  gem.add_dependency('methadone', '~>1.2.1')
+  # gem.add_dependency('term-ansicolor')
+  # gem.add_dependency('sqlite3')
+  gem.add_dependency('nokogiri')
+end

data/lib/cocoadex/keyword.rb

@@ -0,0 +1,94 @@
+
+module Cocoadex
+  class Keyword
+    attr_reader :term, :type, :docset, :url
+    attr_accessor :fk, :id
+
+    DATA_PATH = File.join(File.dirname(__FILE__),"..","..","data","store.yaml")
+
+    def self.datastore
+      @store ||= []
+    end
+
+    def self.find text
+      keys = datastore.select {|k| k.term.start_with? text }
+      if key = keys.detect {|k| k.term == text}
+        keys = [key]
+      end
+      untokenize(keys)
+    end
+
+    def self.loaded?
+      File.exists? DATA_PATH
+    end
+
+    def self.read
+      $/="\n\n"
+      File.open(DATA_PATH, "r").each do |object|
+        datastore << YAML::load(object)
+      end
+    end
+
+    def self.write
+      File.open(DATA_PATH, "w") do |file|
+        datastore.each do |keyword|
+          file.puts(YAML.dump(keyword))
+          file.puts
+        end
+      end
+    end
+
+    def self.untokenize keys
+      keys.map do |key|
+        case key.type
+        when :class
+          Cocoadex::Class.new(key.url)
+        when :method, :property
+          if class_key = datastore.detect {|k| k.id == key.fk}
+            klass = Cocoadex::Class.new(class_key.url)
+            case key.type
+            when :method
+              entity = klass.methods.detect {|m| m.name == key.term}
+            when :property
+              entity = klass.properties.detect {|m| m.name == key.term}
+            end
+
+            entity.class_name = klass.name
+            entity
+          end
+        end
+      end
+    end
+
+    def self.tokenize_class docset, path, id
+      klass = Cocoadex::Class.new(path)
+      class_key = Keyword.new(klass.name, :class, docset, path)
+      class_key.id = id
+      datastore << class_key
+
+      klass.methods.each do |m|
+        mkey = Keyword.new(m.name, :method, docset, path)
+        mkey.fk = id
+        datastore << mkey
+      end
+
+      klass.properties.each do |p|
+        pkey = Keyword.new(p.name, :property, docset, path)
+        pkey.fk = id
+        datastore << pkey
+      end
+    end
+
+    def initialize term, type, docset, url
+      @term, @type, @docset, @url = term, type, docset, url
+    end
+
+    def inspect
+      "<Keyword#{type} @term=#{term}>"
+    end
+
+    def to_s
+      "#{type} => #{term}"
+    end
+  end
+end

data/lib/cocoadex/models/class.rb

@@ -0,0 +1,97 @@
+
+require 'set'
+
+module Cocoadex
+  class Class < Entity
+    attr_reader :name, :description, :overview
+
+    def properties
+      @properties ||=[]
+    end
+
+    def tasks
+      @tasks ||= []
+    end
+
+    def methods
+      @methods ||= ::Set.new
+    end
+
+    def parents
+      @parents ||= []
+    end
+
+    def to_s
+      "Class #{name}"
+    end
+
+    def print
+      puts <<-INFO
+      Class: #{name}
+
+        #{description}
+
+        Inherits From: #{parents.join(' > ')}
+
+        Overview:
+
+          #{overview}
+
+        Properties:
+
+      INFO
+      properties.each do |prop|
+        prop.print
+      end
+      puts <<-INFO
+        Methods:
+      INFO
+      methods.each do |m|
+        m.print
+      end
+    end
+
+    def parse doc
+      @name = doc.css('body a').first['title']
+      @description = doc.css('meta#description').first['content']
+      # @overview = doc.css(".zClassDescription p.abstract").first.text
+      @overview = doc.css(".zClassDescription").first.text.sub("Overview","")
+      @parents = doc.css("div.zSharedSpecBoxHeadList").first.css('a').map {|node| node.text}
+
+      parse_properties(doc)
+      parse_tasks(doc)
+      parse_methods(doc)
+    end
+
+    def parse_methods doc
+      [:class, :instance].each do |selector|
+        nodes = doc.css("div.#{selector}Method")
+        # logger.debug(nodes.inspect)
+        unless nodes.empty?
+          methods.merge(nodes.map {|n| Method.new(selector, n)})
+        end
+      end
+    end
+
+    def parse_properties doc
+      @properties = doc.css("div.propertyObjC").map do |prop|
+        Property.new(prop)
+      end
+    end
+
+    def parse_tasks doc
+      @tasks = {}
+      doc.css('ul.tooltip').each do |list|
+        key = list.previous.text
+        @tasks[key] = []
+        list.css('li span.tooltip').each do |prop|
+          @tasks[key] << {
+            :name => strip(prop.css('a').first.text),
+            :abstract => prop.css('.tooltipicon').first['data-abstract']
+          }
+        end
+      end
+      @tasks
+    end
+  end
+end

data/lib/cocoadex/models/docset.rb

@@ -0,0 +1,34 @@
+
+module Cocoadex
+  class DocSet
+    attr_reader :platform, :version, :name, :description, :path
+
+    def initialize plist_path
+      @doc = Nokogiri::HTML(IO.read(plist_path))
+      @path = plist_path
+      @name = plist_value 'CFBundleName'
+      @platform = plist_value "DocSetPlatformFamily"
+      @version = plist_value "DocSetPlatformVersion"
+      @description = plist_value "DocSetDescription"
+    end
+
+    def inspect
+      "<DocSet #{name} @description=#{description} @path=#{path}>"
+    end
+
+    private
+
+    def plist_value key
+      key_node = @doc.css("dict key").detect do |node|
+        node.text == key
+      end
+
+      if key_node
+        key_node.next.text
+      else
+        logger.iwarn "Node not found: #{key}"
+        nil
+      end
+    end
+  end
+end

data/lib/cocoadex/models/entity.rb

@@ -0,0 +1,23 @@
+
+module Cocoadex
+  class Entity
+
+    def initialize path
+      text     = clean(IO.read(path))
+      document = Nokogiri::HTML(text)
+      parse(document)
+    end
+
+    def print
+      raise "print() not defined for #{self.class}"
+    end
+
+    def clean text
+      text.gsub(/(\n|\t|\r)/, ' ').gsub(/>\s*</, '><').squeeze(' ')
+    end
+
+    def strip text
+      text.gsub("&#xA0;&#xA0;","")
+    end
+  end
+end

data/lib/cocoadex/models/method.rb

@@ -0,0 +1,86 @@
+
+module Cocoadex
+  class Class < Entity
+    class Method
+      attr_reader :name, :abstract, :declaration, :scope,
+        :discussion, :declared_in, :availability, :parameters,
+        :return_value
+
+      attr_accessor :class_name
+
+      class Parameter
+        attr_reader :name, :description
+
+        def initialize name, description
+          @name, @description = name, description
+        end
+
+        def print
+          puts "#{name} - #{description}"
+        end
+      end
+
+      def parameters
+        @parameters ||= []
+      end
+
+      def initialize type, node
+        @type = type
+        @name = node.css("h3.#{type}Method").first.text
+        logger.debug("parsing #{@type} method #{@name}")
+        @abstract = node.css(".abstract").first.text
+        @declaration = node.css(".declaration").first.text
+
+        decl_nodes = node.css(".declaredIn code.HeaderFile")
+        if decl_nodes.size > 0
+          @declared_in = decl_nodes.first.text
+        end
+
+        if discussion_node = node.css(".discussion > p") and discussion_node.length > 0
+          @discussion = discussion_node.first.text
+        end
+
+        if return_nodes = node.css(".return_value p") and return_nodes.size > 0
+          @return_value = return_nodes.first.text
+        end
+
+        ava_nodes = node.css(".availability > ul > li")
+        if ava_nodes.size > 0
+          @availability = ava_nodes.first.text
+        end
+
+        if parameters = node.css(".parameters") and parameters.length > 0
+          @parameters = []
+          parameters.first.css("dt").each do |param|
+            name_nodes = param.css("em")
+            if name_nodes.size > 0
+              name = param.css("em").first.text
+              description = param.next.css("p").first.text
+              @parameters << Parameter.new(name, description)
+            end
+          end
+        end
+      end
+
+      def to_s
+        "Method #{name}"
+      end
+
+      def print
+        puts <<-PRINT
+          Declared in: #{declared_in}
+
+          #{declaration}
+              #{print_parameters}
+            Returns: #{return_value}
+            #{abstract}
+            #{availability}
+        PRINT
+      end
+
+      def print_parameters
+        parameters.map {|pm| pm.print}.join("\n            ") if parameters
+      end
+    end
+  end
+end

data/lib/cocoadex/models/property.rb

@@ -0,0 +1,44 @@
+
+module Cocoadex
+  class Property
+    attr_reader :name, :abstract, :declaration, :discussion, :availability
+
+    attr_accessor :class_name
+
+    def initialize node
+      @name = node.css("h3.method_property").first.text
+      logger.debug("Adding property: #{@name}")
+
+      if abs = node.css(".abstract") and abs.length > 0
+        @abstract = abs.first.text
+      end
+
+      if decl = node.css(".declaration") and decl.length > 0
+        @declaration = decl.first.text
+      end
+
+      if disc = node.css(".discussion > p") and disc.length > 0
+        @discussion = disc.first.text
+      end
+
+      if ava_nodes = node.css(".availability > ul > li") and ava_nodes.size > 0
+        @availability = ava_nodes.first.text
+      end
+    end
+
+    def to_s
+      "Property #{name}"
+    end
+
+    def print
+      puts <<-PRINT
+        Declared in: #{class_name || ''}
+
+        #{name}
+          #{abstract}
+          #{availability}
+
+      PRINT
+    end
+  end
+end

data/lib/cocoadex/parser.rb

@@ -0,0 +1,53 @@
+
+module Cocoadex
+  class Parser
+
+    IGNORED_DIRS = [
+      'codinghowtos', 'qa',
+      'featuredarticles','navigation',
+      'recipes','releasenotes',
+      'samplecode','Conceptual',
+      'technotes','History',
+      'Introduction','GettingStarted'
+    ]
+
+    IGNORED_FILES = [
+      'RevisionHistory','Introduction'
+    ]
+
+    def self.ignored? path
+      (path.split('/') & IGNORED_DIRS).size > 0 or
+      IGNORED_FILES.include?(File.basename(path).sub('.html','')) or
+      (File.basename(path) == 'index.html' && File.exist?(File.join(File.dirname(path),'Reference')))
+    end
+
+    def self.parse docset_path
+      logger.debug "Parsing docset..."
+      plist = File.join(docset_path,"Contents", "Info.plist")
+      if File.exist? plist
+        docset = DocSet.new(plist)
+        logger.info docset.inspect
+        files = Dir.glob(docset_path+"/**/*.html")
+        files.reject! {|f| ignored?(f) }
+
+        files.each_with_index do |f,index|
+          logger.debug "  Parsing path: #{f}"
+          doc = Nokogiri::HTML(IO.read(f))
+          title_nodes = doc.css("#IndexTitle")
+          unless title_nodes.size == 0
+            title = title_nodes.first['content']
+            if title.include? "Deprecated"
+              next
+            elsif title.include? "Class Reference" or title.include? "Protocol Reference"
+              logger.info "    Creating #{title}"
+              Keyword.tokenize_class docset.name, f, index
+            end
+          end
+        end
+
+        logger.info "Tokens Indexed: #{Keyword.datastore.size}"
+        Keyword.write
+      end
+    end
+  end
+end

data/lib/cocoadex/version.rb

@@ -0,0 +1,3 @@
+module Cocoadex
+  VERSION = "1.0"
+end

data/lib/cocoadex.rb

@@ -0,0 +1,15 @@
+
+require 'cocoadex/version'
+require 'cocoadex/models/docset'
+require 'cocoadex/models/entity'
+require 'cocoadex/models/method'
+require 'cocoadex/models/property'
+require 'cocoadex/models/class'
+require 'cocoadex/parser'
+require 'cocoadex/keyword'
+require 'ext/nil'
+require 'nokogiri'
+
+module Cocoadex
+
+end

data/lib/ext/nil.rb

@@ -0,0 +1,18 @@
+
+class NilClass
+  def [] param
+    nil
+  end
+
+  def text
+    ""
+  end
+
+  def css selector
+    nil
+  end
+
+  def next
+    nil
+  end
+end

data/readme.md

@@ -0,0 +1,34 @@
+# THE COCOADEX
+
+Spartan documentation lookup for Cocoa APIs
+
+
+## Installation
+
+    gem install cocoadex
+
+## Usage
+
+ - **View Options:** `cocoadex --help`
+ - **Loading a DocSet:** `cocoadex --docset [path]` (Try `~/Library/Developer/DocSets/[docset name]`)
+ - **Look up:** `cocoadex --search [query]`
+   - Valid search terms are Class, method, and property names
+   - Example:
+
+    $ cocoadex -s tableView:didSelectRow
+          Declared in: UITableView.h
+
+          - (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
+              tableView - A table-view object informing the delegate about the new row selection.
+              indexPath - An index path locating the new selected row in tableView.
+            Returns:
+            Tells the delegate that the specified row is now selected.
+            Available in iOS 2.0 and later.
+
+
+## Todo
+
+ - Improve UX: Some tasteful usage of text formatting wouldn't hurt
+ - Support `--first`, for returning the first result of multiple matches
+ - Support auto-loading DocSets from common locations
+ - Persist object model/datastore using AR

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cocoadex
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Delisa Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-19 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &19750080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19750080
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &19749520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19749520
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &19749100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19749100
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &19733880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *19733880
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: &19733280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *19733280
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &19732840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19732840
+description: A reference utility for Cocoa APIs
+email:
+- iskanamagus@gmail.com
+executables:
+- cocoadex
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- bin/cocoadex
+- cocoadex.gemspec
+- data/_store
+- lib/cocoadex.rb
+- lib/cocoadex/keyword.rb
+- lib/cocoadex/models/class.rb
+- lib/cocoadex/models/docset.rb
+- lib/cocoadex/models/entity.rb
+- lib/cocoadex/models/method.rb
+- lib/cocoadex/models/property.rb
+- lib/cocoadex/parser.rb
+- lib/cocoadex/version.rb
+- lib/ext/nil.rb
+- readme.md
+has_rdoc: true
+homepage: https://kattrali.github.com/cocoadex
+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.6.2
+signing_key: 
+specification_version: 3
+summary: A command-line reference utility for Cocoa APIs.
+test_files: []