cocoadex 1.4 → 1.5

data/views/class.erb

@@ -0,0 +1,35 @@
+
+<%= hrule( type + ": " + name ) %>
+<%= print_origin( origin ) %>
+
+<% if description.empty? %>
+  (no description...)
+<% else %>
+<%= "\n" + description %>
+<% end %>
+<% unless overview.empty? %>
+
+<%= hrule %>
+
+<%= section_header( "Overview:" ) %>
+<%= Bri::Renderer.wrap_row(overview.join("\n\n"), Cocoadex.width) %>
+<% end %>
+
+<%= hrule %>
+
+<% unless class_methods.empty? %>
+<%= section_header( "Class methods:" ) %>
+<%= Bri::Renderer.wrap_list( class_methods.sort ) %>
+
+
+<% end %>
+<% unless instance_methods.empty? %>
+<%= section_header( "Instance methods:" ) %>
+<%= Bri::Renderer.wrap_list( instance_methods.sort ) %>
+
+
+<% end %>
+<% unless properties.empty? %>
+<%= section_header( "Properties:" ) %>
+<%= Bri::Renderer.wrap_list( properties.sort ) %>
+<% end %>

data/views/constant.erb

@@ -0,0 +1,10 @@
+
+<%= hrule( "Constant: " + name ) %>
+<%= print_origin( origin ) %>
+
+<%= hrule %>
+<% if description.empty? %>
+  (no description...)
+<% else %>
+<%= wrap(description) %>
+<% end %>

data/views/constant_group.erb

@@ -0,0 +1,28 @@
+
+<%= hrule( "Constant Group: " + name ) %>
+<%= print_origin( origin ) %>
+
+<%= wrap(declaration) %>
+<%= hrule %>
+<% if abstract.empty? %>
+  (no description...)
+<% else %>
+<%= wrap(abstract) %>
+
+<% end %>
+<% if discussion %>
+<%= section_header( "Discussion:" ) %>
+<%= wrap(discussion) %>
+<% end %>
+
+<% unless constants.empty? %>
+<%   max = constants.map {|c| c.name.length }.max %>
+<%=  section_header( "Constants:" ) %>
+<%   constants.each do |constant| %>
+<%=    inline_title(constant.name, constant.description.split("\n").first, max) %>
+
+<%   end %>
+<% end %>
+<% if declared_in %>
+Declared in <%= declared_in %>
+<% end %>

data/views/data_type.erb

@@ -0,0 +1,47 @@
+
+<%= hrule( "Data Type: " + name ) %>
+<%= print_origin( origin ) %>
+
+
+<% if declaration %>
+<%=  wrap(declaration) %>
+<% end %>
+<%= hrule %>
+<% if abstract.empty? %>
+  (no description...)
+<% else %>
+<%=  wrap(abstract) %>
+<% end %>
+
+<% if considerations %>
+<%=  wrap(considerations) %>
+<% end %>
+
+<% unless fields.empty? %>
+<%=  section_header( "Fields:" ) %>
+<%   fields.each do |param| %>
+
+<%=    h3(Cocoadex.indent(param.name, 2)).strip %>
+<%     wrap(param.description).split("\n").each do |line| %>
+<%=      Cocoadex.indent(line, 4) %>
+<%     end %>
+
+<%   end %>
+
+<% end %>
+<% unless constants.empty? %>
+<%=  section_header( "Constants:" ) %>
+<%   constants.each do |param| %>
+
+<%=    h3(Cocoadex.indent(param.name, 2)).strip %>
+<%     wrap(param.description).split("\n").each do |line| %>
+<%=      Cocoadex.indent(line, 4) %>
+<%     end %>
+
+<%   end %>
+
+<% end %>
+<%= availability %>
+
+
+Declared in <%= declared_in %>

data/views/generic_ref.erb

@@ -0,0 +1,28 @@
+
+<%= hrule( name ) %>
+
+<% unless specs.empty? %>
+<%   max = specs.keys.map {|s| s.length}.max %>
+<%   specs.each do |name,value| %>
+<%=     wrap(inline_title(name,value,max)) %>
+<%   end %>
+<% end %>
+<% unless overview.empty? %>
+<%=  hrule %>
+
+<%=  section_header( "Overview:" ) %>
+<%=  wrap(overview) %>
+<% end %>
+
+<%= hrule %>
+
+<% unless data_types.empty? %>
+<%=  section_header( "Data Types:" ) %>
+<%=  Bri::Renderer.wrap_list( data_types.sort ) %>
+
+
+<% end %>
+<% unless result_codes.empty? %>
+<%=  section_header( "Result Codes:" ) %>
+<%=  Bri::Renderer.wrap_list( result_codes.sort ) %>
+<% end %>

data/views/method.erb

@@ -0,0 +1,34 @@
+
+<%= hrule( type + ": " + name ) %>
+<%= print_origin( origin ) %>
+
+
+<%= Cocoadex.trailing_indent(Bri::Renderer.wrap_row(declaration, Cocoadex.width), 2, 6) %>
+
+<% if return_value %>
+
+<%= wrap('Returns: ' + return_value) %>
+<% end %>
+
+<%= hrule %>
+<% if abstract.empty? %>
+  (no description...)
+<% else %>
+<%= wrap(abstract) %>
+<% end %>
+
+<% unless parameters.empty? %>
+<%= section_header( "Parameters:" ) %>
+<% parameters.each do |param| %>
+
+<%= h3(Cocoadex.indent(param.name, 2)).strip %>
+
+<% wrap(param.description).split("\n").each do |line| %>
+<%= Cocoadex.indent(line, 4) %>
+
+<% end %>
+<% end %>
+
+
+<% end %>
+<%= availability %>

data/views/multiple.erb

@@ -0,0 +1,4 @@
+
+<%= Bri::Templates::Helpers.hrule("Multiple choices:") %>
+
+<%= Bri::Renderer.wrap_list( objects.sort ) %>

data/views/property.erb

@@ -0,0 +1,14 @@
+
+<%= hrule( "Property: "+ name ) %>
+<%= print_origin( origin ) %>
+
+
+<%= Bri::Renderer.wrap_row(declaration, Cocoadex.width) %>
+<%= hrule %>
+<% if abstract.empty? %>
+  (no description...)
+<% else %>
+<%= wrap(abstract) %>
+<% end %>
+
+<%= availability %>

data/views/result_code.erb

@@ -0,0 +1,7 @@
+
+<%= hrule( "Result Code: " + name ) %>
+<%= print_origin( origin ) %>
+
+<%= inline_title("Value", value) %>
+<%= hrule %>
+<%= wrap(description) %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoadex
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  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: bri
   requirement: !ruby/object:Gem::Requirement
@@ -107,12 +123,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A command-line class reference utility Cocoa APIs
+description: CLI for Cocoa documentation reference
 email:
 - iskanamagus@gmail.com
 executables:
 - cocoadex
-- cocoadex_completion.sh
+- cdex_completion
 extensions: []
 extra_rdoc_files:
 - readme.md
@@ -124,21 +140,45 @@ files:
 - changelog.md
 - readme.md
 - bin/cocoadex
-- bin/cocoadex_completion.sh
+- bin/cdex_completion
 - lib/cocoadex.rb
 - lib/cocoadex/docset_helper.rb
+- lib/cocoadex/extensions.rb
 - lib/cocoadex/keyword.rb
-- lib/cocoadex/parser.rb
-- lib/cocoadex/serializer.rb
-- lib/cocoadex/templates.rb
-- lib/cocoadex/version.rb
+- lib/cocoadex/model.rb
+- lib/cocoadex/models/callback.rb
 - lib/cocoadex/models/class.rb
+- lib/cocoadex/models/constant.rb
+- lib/cocoadex/models/data_type.rb
 - lib/cocoadex/models/docset.rb
 - lib/cocoadex/models/element.rb
 - lib/cocoadex/models/entity.rb
+- lib/cocoadex/models/function.rb
+- lib/cocoadex/models/generic_ref.rb
 - lib/cocoadex/models/method.rb
+- lib/cocoadex/models/nested_node_element.rb
+- lib/cocoadex/models/parameter.rb
 - lib/cocoadex/models/property.rb
+- lib/cocoadex/models/result_code.rb
+- lib/cocoadex/models/seq_node_element.rb
+- lib/cocoadex/parser.rb
+- lib/cocoadex/serializer.rb
+- lib/cocoadex/tokenizer.rb
+- lib/cocoadex/tools/completion_helper.rb
+- lib/cocoadex/version.rb
+- lib/ext/xml_element.rb
 - lib/ext/nil.rb
+- lib/ext/string.rb
+- lib/ext/template_helpers.rb
+- views/class.erb
+- views/constant.erb
+- views/constant_group.erb
+- views/data_type.erb
+- views/generic_ref.erb
+- views/method.erb
+- views/multiple.erb
+- views/property.erb
+- views/result_code.erb
 homepage: http://kattrali.github.com/cocoadex
 licenses: []
 post_install_message: 
@@ -162,5 +202,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A command-line class reference utility for Cocoa APIs, based on RI.
+summary: A command-line class reference utility for Cocoa APIs, inspired by RI.
 test_files: []

data/bin/cocoadex_completion.sh

@@ -1,36 +0,0 @@
-#!/usr/bin/env sh
-#
-# cocoadex_completion.sh
-#
-# Bash completion for Cocoa classes
-# Install by adding the following to your .bash_profile:
-#
-# complete -C /path/to/cocoadex_completion.sh -o default cocoadex
-
-/usr/bin/env ruby <<-EORUBY
-
-require 'cocoadex'
-
-class TagCompletion
-  def initialize(command)
-    @command = command
-  end
-
-  def matches
-    tags.select do |tag|
-      tag[0, typed.length] == typed
-    end
-  end
-
-  def typed
-    @command[/\s(.+?)$/, 1] || ''
-  end
-
-  def tags
-    @tags ||= Cocoadex::Keyword.tags
-  end
-end
-
-puts TagCompletion.new(ENV["COMP_LINE"]).matches
-
-EORUBY

data/lib/cocoadex/templates.rb

@@ -1,114 +0,0 @@
-module Cocoadex
-  module Templates
-    MULTIPLE_CHOICES =<<-EOT
-<%= Bri::Templates::Helpers.hrule("Multiple choices:") %>
-
-<%= Bri::Renderer.wrap_list( objects.sort ) %>
-
-    EOT
-
-    CLASS_DESCRIPTION =<<-EOT
-
-<%= hrule( type + ": " + name ) %>
-<%= print_origin( origin ) %>
-
-<% if description.empty? %>
-  (no description...)
-<% else %>
-<%= '\n' + description %>
-<% end %>
-<% unless overview.empty? %>
-<%= hrule %>
-
-<%= section_header( "Overview:" ) %>
-<%= Bri::Renderer.wrap_row(overview.join('\n\n'), Cocoadex.width) %>
-<% end %>
-
-<%= hrule %>
-
-<% unless class_methods.empty? %>
-<%= section_header( "Class methods:" ) %>
-<%= Bri::Renderer.wrap_list( class_methods.sort ) %>
-
-
-<% end %>
-<% unless instance_methods.empty? %>
-<%= section_header( "Instance methods:" ) %>
-<%= Bri::Renderer.wrap_list( instance_methods.sort ) %>
-
-
-<% end %>
-<% unless properties.empty? %>
-<%= section_header( "Properties:" ) %>
-<%= Bri::Renderer.wrap_list( properties.sort ) %>
-
-
-<% end %>
-    EOT
-
-    METHOD_DESCRIPTION =<<-EOT
-
-<%= hrule( name ) %>
-<%= print_origin( origin ) %>
-
-
-<%= Cocoadex.trailing_indent(Bri::Renderer.wrap_row(declaration, Cocoadex.width), 2, 6) %>
-
-<% if return_value %>
-
-<%= 'Returns: ' + return_value %>
-<% end %>
-
-<%= hrule %>
-<% if abstract.empty? %>
-  (no description...)
-<% else %>
-<%= Bri::Renderer.wrap_row(abstract, Cocoadex.width) %>
-<% end %>
-
-<% unless parameters.empty? %>
-<%= section_header( "Parameters:" ) %>
-<% parameters.each do |param| %>
-
-<%= h3(Cocoadex.indent(param.name, 2)).strip %>
-<% Bri::Renderer.wrap_row(param.description, Cocoadex.width).split('\n').each do |line| %>
-<%= Cocoadex.indent(line, 4) %>
-<% end %>
-<% end %>
-
-
-<% end %>
-<%= availability %>
-
-    EOT
-
-    PROPERTY_DESCRIPTION =<<-EOT
-
-<%= hrule( name ) %>
-<%= print_origin( origin ) %>
-
-
-<%= Bri::Renderer.wrap_row(declaration, Cocoadex.width) %>
-<%= hrule %>
-<% if abstract.empty? %>
-  (no description...)
-<% else %>
-<%= Bri::Renderer.wrap_row(abstract, Cocoadex.width) %>
-<% end %>
-
-<%= availability %>
-
-    EOT
-  end
-end
-
-module Bri
-  module Templates
-    module Helpers
-      def h3 text
-        Term::ANSIColor::blue + text + Term::ANSIColor::reset + "\n"
-      end
-      module_function :h3
-    end
-  end
-end