cocoadex 1.1 → 1.2

data/bin/cocoadex

@@ -15,7 +15,7 @@ main do |arg|
     logger.error_level = Logger::DEBUG
   end
 
-  if options[:load_docset] and path = File.expand_path(options[:load_docset].first)
+  if options[:'load-docset'] and path = File.expand_path(options[:'load-docset'].first)
     Parser.parse(path)
   end
 

data/changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.2
+
+ - Fix docset loading regression introduced in 1.1
+
+## 1.1
+
+ - Use ERB/bri for output formatting
+
+## 1.0
+
+Initial release

data/lib/cocoadex/keyword.rb

@@ -21,30 +21,31 @@ module Cocoadex
 
     # Search the cache for matching text
     def self.find text
-      if (text.split(//u) & SCOPE_CHARS).size == 1
-        scope = SCOPE_CHARS.detect {|c| text.include? c }
+      if scope = SCOPE_CHARS.detect {|c| text.include? c }
         class_name, term = text.split(scope)
         find_with_scope scope, class_name, term
       else
         keys = datastore.select {|k| k.term.start_with? text }
-        if key = keys.detect {|k| k.term == text}
+        if key = keys.detect {|k| k.term == text }
           keys = [key]
         end
         untokenize(keys)
       end
     end
 
+    # Find matches for term within a given class
     def self.find_with_scope scope, class_name, term
       if class_key = datastore.detect {|k| k.term == class_name }
         klass = untokenize([class_key]).first
-        case scope
-        when CLASS_PROP_DELIM
-          (klass.methods + klass.properties).select {|m| m.name.start_with? term}
-        when CLASS_METHOD_DELIM
-          klass.class_methods.select {|m| m.name.start_with? term}
-        when INST_METHOD_DELIM
-          klass.instance_methods.select {|m| m.name.start_with? term}
+        list  = case scope
+          when CLASS_PROP_DELIM
+            klass.methods + klass.properties
+          when CLASS_METHOD_DELIM
+            klass.class_methods
+          when INST_METHOD_DELIM
+            klass.instance_methods
         end
+        list.select {|m| m.name.start_with? term}
       else
         []
       end
@@ -85,12 +86,8 @@ module Cocoadex
         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
-              klass.methods.detect {|m| m.name == key.term}
-            when :property
-              klass.properties.detect {|m| m.name == key.term}
-            end
+            list = key.type == :method ? klass.methods : klass.properties
+            list.detect {|m| m.name == key.term}
           end
         end
       end
@@ -103,16 +100,12 @@ module Cocoadex
       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
+      {:method => klass.methods, :property => klass.properties}.each do |type,list|
+        list.each do |item|
+          item_key = Keyword.new(item.name, type, docset, path)
+          item_key.fk = id
+          datastore << item_key
+        end
       end
     end
 

data/lib/cocoadex/parser.rb

@@ -21,33 +21,40 @@ module Cocoadex
       (File.basename(path) == 'index.html' && File.exist?(File.join(File.dirname(path),'Reference')))
     end
 
+    def self.class_ref? title
+      title.include? "Class Reference" or title.include? "Protocol Reference"
+    end
+
     def self.parse docset_path
-      logger.debug "Parsing docset..."
+      logger.info "Parsing docset tokens (This may take a moment)..."
       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
+        files.each_with_index do |f,i|
+          index_html(docset,f,i)
         end
 
         logger.info "Tokens Indexed: #{Keyword.datastore.size}"
         Keyword.write
       end
     end
+
+    def self.index_html docset, path, index
+      logger.debug "  Parsing path: #{path}"
+
+      doc = Nokogiri::HTML(IO.read(path))
+      title_nodes = doc.css("#IndexTitle")
+      unless title_nodes.size == 0
+        title = title_nodes.first['content']
+
+        if class_ref? title
+          # logger.info "Caching #{title}"
+          Keyword.tokenize_class docset.name, path, index
+        end
+      end
+    end
   end
 end

data/lib/cocoadex/version.rb

@@ -1,3 +1,3 @@
 module Cocoadex
-  VERSION = "1.1"
+  VERSION = "1.2"
 end

data/readme.md

@@ -12,7 +12,7 @@ Cocoadex parses Cocoa documentation files and creates a keyword index. Queries c
 
  - **View Options:** `cocoadex --help`
 
- - **Loading a DocSet:** `cocoadex --load-docset [path]` (Try `~/Library/Developer/DocSets/[docset name]`)
+ - **Loading a DocSet:** `cocoadex --load-docset [path]` (Try `~/Library/Developer/Shared/Documentation/DocSets/[docset name]`)
 
  - **Look up Documentation:** `cocoadex --search [query]`
    - Valid search terms are Class, method, and property names. Search scope can also be focused using delimiters, such as `ClassName-method` to find instance methods, `Class+method` to find class methods, or `Class.method` to find any matching method or property in `Class`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoadex
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21891660 !ruby/object:Gem::Requirement
+  requirement: &10672660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21891660
+  version_requirements: *10672660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21891100 !ruby/object:Gem::Requirement
+  requirement: &10672100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *21891100
+  version_requirements: *10672100
 - !ruby/object:Gem::Dependency
   name: methadone
-  requirement: &21890500 !ruby/object:Gem::Requirement
+  requirement: &10671500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *21890500
+  version_requirements: *10671500
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &21890060 !ruby/object:Gem::Requirement
+  requirement: &10671060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21890060
+  version_requirements: *10671060
 - !ruby/object:Gem::Dependency
   name: bri
-  requirement: &21889520 !ruby/object:Gem::Requirement
+  requirement: &10670580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21889520
+  version_requirements: *10670580
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &21889020 !ruby/object:Gem::Requirement
+  requirement: &10670020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21889020
+  version_requirements: *10670020
 description: A command-line class reference utility Cocoa APIs
 email:
 - iskanamagus@gmail.com
@@ -86,10 +86,12 @@ executables:
 extensions: []
 extra_rdoc_files:
 - readme.md
+- changelog.md
 files:
 - Gemfile
 - LICENSE
 - LICENSE.txt
+- changelog.md
 - readme.md
 - bin/cocoadex
 - lib/cocoadex.rb