prepor-erlapi 0.1.8

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andrew Rudenko
+
+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.rdoc

@@ -0,0 +1,15 @@
+= erlapi
+
+Generate searchable api docs for elang libs.
+
+Based on http://railsapi.com/.
+
+Result for all Erlang OTP sources – http://erlapi.prepor.ru/docs/
+
+== Usage
+
+erlapi -o ~/Docs/erlang -s dir/to/erlang/sources
+
+== Copyright
+
+Copyright (c) 2009 Andrew Rudenko. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "erlapi"
+    gem.summary = %Q{TODO}
+    gem.email = "ceo@prepor.ru"
+    gem.homepage = "http://github.com/prepor/erlapi"
+    gem.authors = ["Andrew Rudenko"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "erlapi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.8

data/bin/erlapi

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/erlapi'
+
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: erlapi -o [output_dir] -s [source_dir]"
+
+  opts.on("-o", "--output OUTPUT_DIR", "Output dir") do |o|
+    options[:output_dir] = o
+  end
+  
+  opts.on("-s", "--source SOURCE_DIR", "Source dir with erlang docs") do |s|
+    options[:source_dir] = s
+  end
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+     puts opts
+     exit
+   end
+  
+end.parse!
+
+Erlapi::Cmd.start!(options)

data/erlapi.gemspec

@@ -0,0 +1,138 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{erlapi}
+  s.version = "0.1.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Rudenko"]
+  s.date = %q{2009-08-08}
+  s.default_executable = %q{erlapi}
+  s.email = %q{ceo@prepor.ru}
+  s.executables = ["erlapi"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/erlapi",
+     "erlapi.gemspec",
+     "lib/erlapi.rb",
+     "lib/erlapi/generator.rb",
+     "lib/erlapi/generator/shtml.rb",
+     "lib/erlapi/generator/template/direct/_context.rhtml",
+     "lib/erlapi/generator/template/direct/class.rhtml",
+     "lib/erlapi/generator/template/direct/file.rhtml",
+     "lib/erlapi/generator/template/direct/index.rhtml",
+     "lib/erlapi/generator/template/direct/resources/apple-touch-icon.png",
+     "lib/erlapi/generator/template/direct/resources/css/main.css",
+     "lib/erlapi/generator/template/direct/resources/css/panel.css",
+     "lib/erlapi/generator/template/direct/resources/css/reset.css",
+     "lib/erlapi/generator/template/direct/resources/favicon.ico",
+     "lib/erlapi/generator/template/direct/resources/i/arrows.png",
+     "lib/erlapi/generator/template/direct/resources/i/results_bg.png",
+     "lib/erlapi/generator/template/direct/resources/i/tree_bg.png",
+     "lib/erlapi/generator/template/direct/resources/js/jquery-1.3.2.min.js",
+     "lib/erlapi/generator/template/direct/resources/js/jquery-effect.js",
+     "lib/erlapi/generator/template/direct/resources/js/main.js",
+     "lib/erlapi/generator/template/direct/resources/js/searchdoc.js",
+     "lib/erlapi/generator/template/direct/resources/panel/index.html",
+     "lib/erlapi/generator/template/merge/index.rhtml",
+     "lib/erlapi/generator/template/shtml/_context.rhtml",
+     "lib/erlapi/generator/template/shtml/class.rhtml",
+     "lib/erlapi/generator/template/shtml/file.rhtml",
+     "lib/erlapi/generator/template/shtml/index.rhtml",
+     "lib/erlapi/generator/template/shtml/resources/apple-touch-icon.png",
+     "lib/erlapi/generator/template/shtml/resources/css/main.css",
+     "lib/erlapi/generator/template/shtml/resources/css/panel.css",
+     "lib/erlapi/generator/template/shtml/resources/css/reset.css",
+     "lib/erlapi/generator/template/shtml/resources/favicon.ico",
+     "lib/erlapi/generator/template/shtml/resources/i/arrows.png",
+     "lib/erlapi/generator/template/shtml/resources/i/results_bg.png",
+     "lib/erlapi/generator/template/shtml/resources/i/tree_bg.png",
+     "lib/erlapi/generator/template/shtml/resources/js/jquery-1.3.2.min.js",
+     "lib/erlapi/generator/template/shtml/resources/js/main.js",
+     "lib/erlapi/generator/template/shtml/resources/js/searchdoc.js",
+     "lib/erlapi/generator/template/shtml/resources/panel/index.html",
+     "lib/erlapi/helpers.rb",
+     "lib/erlapi/merge.rb",
+     "lib/erlapi/parser.rb",
+     "lib/erlapi/shtml.rb",
+     "lib/erlapi/templatable.rb",
+     "lib/erlapi/templates/html/direct/_context.rhtml",
+     "lib/erlapi/templates/html/direct/class.rhtml",
+     "lib/erlapi/templates/html/direct/file.rhtml",
+     "lib/erlapi/templates/html/direct/index.rhtml",
+     "lib/erlapi/templates/html/direct/resources/apple-touch-icon.png",
+     "lib/erlapi/templates/html/direct/resources/css/main.css",
+     "lib/erlapi/templates/html/direct/resources/css/panel.css",
+     "lib/erlapi/templates/html/direct/resources/css/reset.css",
+     "lib/erlapi/templates/html/direct/resources/favicon.ico",
+     "lib/erlapi/templates/html/direct/resources/i/arrows.png",
+     "lib/erlapi/templates/html/direct/resources/i/results_bg.png",
+     "lib/erlapi/templates/html/direct/resources/i/tree_bg.png",
+     "lib/erlapi/templates/html/direct/resources/js/jquery-1.3.2.min.js",
+     "lib/erlapi/templates/html/direct/resources/js/jquery-effect.js",
+     "lib/erlapi/templates/html/direct/resources/js/main.js",
+     "lib/erlapi/templates/html/direct/resources/js/searchdoc.js",
+     "lib/erlapi/templates/html/direct/resources/panel/index.html",
+     "lib/erlapi/templates/html/merge/index.rhtml",
+     "lib/erlapi/templates/html/shtml/_context.rhtml",
+     "lib/erlapi/templates/html/shtml/class.rhtml",
+     "lib/erlapi/templates/html/shtml/file.rhtml",
+     "lib/erlapi/templates/html/shtml/index.rhtml",
+     "lib/erlapi/templates/html/shtml/resources copy/apple-touch-icon.png",
+     "lib/erlapi/templates/html/shtml/resources copy/css/main.css",
+     "lib/erlapi/templates/html/shtml/resources copy/css/panel.css",
+     "lib/erlapi/templates/html/shtml/resources copy/css/reset.css",
+     "lib/erlapi/templates/html/shtml/resources copy/favicon.ico",
+     "lib/erlapi/templates/html/shtml/resources copy/i/arrows.png",
+     "lib/erlapi/templates/html/shtml/resources copy/i/results_bg.png",
+     "lib/erlapi/templates/html/shtml/resources copy/i/tree_bg.png",
+     "lib/erlapi/templates/html/shtml/resources copy/js/jquery-1.3.2.min.js",
+     "lib/erlapi/templates/html/shtml/resources copy/js/main.js",
+     "lib/erlapi/templates/html/shtml/resources copy/js/searchdoc.js",
+     "lib/erlapi/templates/html/shtml/resources copy/panel/index.html",
+     "lib/erlapi/templates/html/shtml/resources/apple-touch-icon.png",
+     "lib/erlapi/templates/html/shtml/resources/css/main.css",
+     "lib/erlapi/templates/html/shtml/resources/css/panel.css",
+     "lib/erlapi/templates/html/shtml/resources/css/reset.css",
+     "lib/erlapi/templates/html/shtml/resources/favicon.ico",
+     "lib/erlapi/templates/html/shtml/resources/i/arrows.png",
+     "lib/erlapi/templates/html/shtml/resources/i/results_bg.png",
+     "lib/erlapi/templates/html/shtml/resources/i/tree_bg.png",
+     "lib/erlapi/templates/html/shtml/resources/js/jquery-1.3.2.min.js",
+     "lib/erlapi/templates/html/shtml/resources/js/jquery-effect.js",
+     "lib/erlapi/templates/html/shtml/resources/js/main.js",
+     "lib/erlapi/templates/html/shtml/resources/js/searchdoc.js",
+     "lib/erlapi/templates/html/shtml/resources/panel/index.html",
+     "test/erlapi_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/prepor/erlapi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "test/erlapi_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/erlapi/generator/shtml.rb

@@ -0,0 +1,353 @@
+require 'rubygems'
+gem "rdoc", ">= 2.4.2"
+if Gem.available? "json" 
+  gem "json", ">= 1.1.3"
+else
+  gem "json_pure", ">= 1.1.3"
+end
+
+require 'iconv'
+require 'json'
+require 'pathname'
+require 'fileutils'
+require 'erb'
+
+require 'rdoc/rdoc'
+require 'rdoc/generator'
+require 'rdoc/generator/markup'
+
+require 'sdoc/github'
+require 'sdoc/templatable'
+require 'sdoc/helpers'
+
+class RDoc::ClassModule
+  def document_self_or_methods
+    document_self || method_list.any?{ |m| m.document_self }
+  end
+  
+  def with_documentation?
+    document_self_or_methods || classes_and_modules.any?{ |c| c.with_documentation? }
+  end
+end
+
+class Erlapi::Generator::SHtml
+  include ERB::Util
+  include Erlapi::Templatable
+  include Erlapi::Helpers
+  
+  GENERATOR_DIRS = [File.join('erlapi', 'generator')]
+  
+  # Used in js to reduce index sizes
+  TYPE_CLASS  = 1
+  TYPE_METHOD = 2
+  TYPE_FILE   = 3
+  
+  TREE_FILE = File.join 'panel', 'tree.js'
+  SEARCH_INDEX_FILE = File.join 'panel', 'search_index.js'
+  
+  FILE_DIR = 'files'
+  CLASS_DIR = 'classes'
+  
+  RESOURCES_DIR = File.join('resources', '.')
+  
+  attr_reader :basedir
+  
+  def self.for(options)
+    self.new(options)
+  end
+  
+  def self.template_dir template
+		$LOAD_PATH.map do |path|
+		  GENERATOR_DIRS.map do |dir|
+  			File.join path, dir, 'template', template
+	    end
+		end.flatten.find do |dir|
+			File.directory? dir
+		end
+  end
+  
+  def initialize(options)
+		@options = options
+		@options.diagram = false
+    @github_url_cache = {}
+    
+		template = @options.template || 'direct'
+
+		templ_dir = self.class.template_dir template
+
+		raise "Could not find template #{template.inspect}" unless
+			templ_dir
+		
+		@template_dir = Pathname.new File.expand_path(templ_dir)
+		@basedir = Pathname.pwd.expand_path
+  end
+  
+  def generate( top_levels )
+		@outputdir = Pathname.new( @options.op_dir ).expand_path( @basedir )
+		@files = top_levels.sort
+		@classes = RDoc::TopLevel.all_classes_and_modules.sort
+
+		# Now actually write the output
+    copy_resources
+    # generate_class_tree
+    generate_search_index
+    # generate_file_files
+    # generate_class_files
+    # generate_index_file
+  end
+  
+	def class_dir
+		CLASS_DIR
+	end
+
+	def file_dir
+		FILE_DIR
+	end
+
+  
+  protected
+	### Output progress information if debugging is enabled
+	def debug_msg( *msg )
+		return unless $DEBUG_RDOC
+		$stderr.puts( *msg )
+	end  
+  
+  ### Create class tree structure and write it as json
+  def generate_class_tree
+    debug_msg "Generating class tree"
+    topclasses = @classes.select {|klass| !(RDoc::ClassModule === klass.parent) } 
+    tree = generate_file_tree + generate_class_tree_level(topclasses)
+    debug_msg "  writing class tree to %s" % TREE_FILE
+    File.open(TREE_FILE, "w", 0644) do |f|
+      f.write('var tree = '); f.write(tree.to_json)
+    end unless $dryrun
+  end
+  
+  ### Recursivly build class tree structure
+  def generate_class_tree_level(classes)
+    tree = []
+    classes.select{|c| c.with_documentation? }.sort.each do |klass|
+      item = [
+        klass.name, 
+        klass.document_self_or_methods ? klass.path : '',
+        klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''), 
+        generate_class_tree_level(klass.classes_and_modules)
+      ]
+      tree << item
+    end
+    tree
+  end
+  
+  ### Create search index for all classes, methods and files
+  ### Wite it as json
+  def generate_search_index
+    debug_msg "Generating search index"
+    
+    index = {
+      :searchIndex => [],
+      :longSearchIndex => [],
+      :info => []
+    }
+    
+    add_class_search_index(index)
+    add_method_search_index(index)
+    add_file_search_index(index)
+    
+    debug_msg "  writing search index to %s" % SEARCH_INDEX_FILE
+    data = {
+      :index => index
+    }
+    File.open(SEARCH_INDEX_FILE, "w", 0644) do |f|
+      f.write('var search_data = '); f.write(data.to_json)
+    end unless $dryrun
+  end
+  
+  ### Add files to search +index+ array
+  def add_file_search_index(index)
+    debug_msg "  generating file search index"
+    
+    @files.select { |file| 
+      file.document_self 
+    }.sort.each do |file|
+      index[:searchIndex].push( search_string(file.name) )
+      index[:longSearchIndex].push( search_string(file.path) )
+      index[:info].push([
+        file.name, 
+        file.path, 
+        file.path, 
+        '', 
+        snippet(file.comment),
+        TYPE_FILE
+      ])
+    end
+  end
+  
+  ### Add classes to search +index+ array
+  def add_class_search_index(index)
+    debug_msg "  generating class search index"
+    
+    @classes.select { |klass| 
+      klass.document_self_or_methods
+    }.sort.each do |klass|
+      index[:searchIndex].push( search_string(klass.name) )
+      index[:longSearchIndex].push( search_string(klass.parent.name) )
+      index[:info].push([
+        klass.name, 
+        klass.parent.full_name, 
+        klass.path, 
+        klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''), 
+        snippet(klass.comment),
+        TYPE_CLASS
+      ])
+    end
+  end
+  
+  ### Add methods to search +index+ array
+  def add_method_search_index(index)
+    debug_msg "  generating method search index"
+    
+    list = @classes.map { |klass| 
+      klass.method_list
+    }.flatten.sort{ |a, b| a.name == b.name ? a.parent.full_name <=> b.parent.full_name : a.name <=> b.name }.select { |method| 
+      method.document_self 
+    }
+    unless @options.show_all
+        list = list.find_all {|m| m.visibility == :public || m.visibility == :protected || m.force_documentation }
+    end
+    
+    list.each do |method|
+      index[:searchIndex].push( search_string(method.name) + '()' )
+      index[:longSearchIndex].push( search_string(method.parent.name) )
+      index[:info].push([
+        method.name, 
+        method.parent.full_name, 
+        method.path, 
+        method.params, 
+        snippet(method.comment),
+        TYPE_METHOD
+      ])
+    end
+  end
+  
+	### Generate a documentation file for each class
+	def generate_class_files
+		debug_msg "Generating class documentation in #@outputdir"
+    templatefile = @template_dir + 'class.rhtml'
+
+		@classes.each do |klass|
+			debug_msg "  working on %s (%s)" % [ klass.full_name, klass.path ]
+			outfile     = @outputdir + klass.path
+			rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+      
+			debug_msg "  rendering #{outfile}"
+			self.render_template( templatefile, binding(), outfile )
+		end
+	end
+
+	### Generate a documentation file for each file
+	def generate_file_files
+		debug_msg "Generating file documentation in #@outputdir"
+    templatefile = @template_dir + 'file.rhtml'
+    
+		@files.each do |file|
+			outfile     = @outputdir + file.path
+			debug_msg "  working on %s (%s)" % [ file.full_name, outfile ]
+			rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+
+			debug_msg "  rendering #{outfile}"
+			self.render_template( templatefile, binding(), outfile )
+		end
+	end
+	
+  def index_file
+    if @options.main_page && file = @files.find { |f| f.full_name == @options.main_page }
+      file
+    else
+      @files.first
+    end
+  end
+
+	### Create index.html with frameset
+	def generate_index_file
+		debug_msg "Generating index file in #@outputdir"
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
+    index_path = index_file.path
+	  
+	  self.render_template( templatefile, binding(), outfile )
+	end
+	
+	### Strip comments on a space after 100 chars
+  def snippet(str)
+    str ||= ''
+    if str =~ /^(?>\s*)[^\#]/
+      content = str
+    else
+      content = str.gsub(/^\s*(#+)\s*/, '')
+    end
+    
+    content = content.sub(/^(.{100,}?)\s.*/m, "\\1").gsub(/\r?\n/m, ' ')
+    
+    begin
+      content.to_json
+    rescue # might fail on non-unicode string
+      begin
+        content = Iconv.conv('latin1//ignore', "UTF8", content) # remove all non-unicode chars
+        content.to_json
+      rescue
+        content = '' # something hugely wrong happend
+      end
+    end
+    content
+  end
+
+  ### Build search index key
+  def search_string(string)
+    string ||= ''
+    string.downcase.gsub(/\s/,'')
+  end
+  
+  ### Copy all the resource files to output dir
+  def copy_resources
+    resoureces_path = @template_dir + RESOURCES_DIR
+		debug_msg "Copying #{resoureces_path}/** to #{@outputdir}/**"
+    FileUtils.cp_r resoureces_path.to_s, @outputdir.to_s, :preserve => true unless $dryrun
+  end
+
+  class FilesTree
+    attr_reader :children
+    def add(path, url)
+      path = path.split(File::SEPARATOR) unless Array === path
+      @children ||= {}
+      if path.length == 1
+        @children[path.first] = url
+      else
+        @children[path.first] ||= FilesTree.new
+        @children[path.first].add(path[1, path.length], url)
+      end
+    end
+  end
+
+  def generate_file_tree
+    if @files.length > 1
+      @files_tree = FilesTree.new
+      @files.each do |file|
+        @files_tree.add(file.relative_name, file.path)
+      end
+      [['', '', 'files', generate_file_tree_level(@files_tree)]]
+    else
+      []
+    end
+  end
+
+  def generate_file_tree_level(tree)
+    tree.children.keys.sort.map do |name|
+      child = tree.children[name]
+      if String === child
+        [name, child, '', []]
+      else
+        ['', '', name, generate_file_tree_level(child)]
+      end
+    end
+  end
+end