erlapi 0.1.9

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{Searchable erlang api generator}
+    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.9

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,140 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{erlapi}
+  s.version = "0.1.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Rudenko"]
+  s.date = %q{2009-12-13}
+  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.homepage = %q{http://github.com/prepor/erlapi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Searchable erlang api generator}
+  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 = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/erlapi.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'active_support'
+require 'erb'
+require 'ostruct'
+if Gem.available? "json" 
+  gem "json", ">= 1.1.3"
+else
+  gem "json_pure", ">= 1.1.3"
+end
+module Erlapi
+  require 'erlapi/helpers'
+  require 'erlapi/templatable'
+  
+  require 'erlapi/parser'
+  require 'erlapi/generator'
+  
+  class Cmd
+    class << self
+      def start!(options)
+        if !options[:source_dir] || !options[:output_dir]
+          raise "You must define source and output dirs"
+        end
+        
+        pa = Erlapi::Parser::Base.new(options[:source_dir])
+
+        pa.parse
+
+        ge = Erlapi::Generator.new(:data => pa.modules, :output_dir => options[:output_dir])
+
+        options = OpenStruct.new( {:charset => 'utf-8', :title => 'Erlang API'})
+        ge.generate(options)
+        
+        puts 'Generating completed'
+      end
+    end
+  end
+  
+end

data/lib/erlapi/generator.rb

@@ -0,0 +1,194 @@
+require 'pathname'
+class Erlapi::Generator
+  attr_accessor :data, :output_dir, :source_dir
+  
+  GENERATOR_DIRS = [File.join('sdoc', 'generator'), File.join('rdoc', 'generator')]
+  
+  # Used in js to reduce index sizes
+  TYPE_CLASS  = 1
+  TYPE_METHOD = 2
+  TYPE_FILE   = 3
+  
+  
+  TEMPLATE_DIR = Pathname.new(File.dirname(__FILE__)) + 'templates' + 'html' + 'shtml'
+  
+  
+  FILE_DIR = 'files'
+  CLASS_DIR = 'classes'
+  
+  RESOURCES_DIR = 'resources'
+  
+  
+  include ERB::Util
+  include Erlapi::Templatable
+  include Erlapi::Helpers
+  
+  def initialize(options = {})    
+    self.output_dir = Pathname.new(options[:output_dir])
+    
+    self.output_dir.mkdir if !self.output_dir.directory?      
+      
+    self.data = options[:data]
+    define_paths
+  end
+  
+  def define_paths
+    @tree_file = output_dir + 'panel' + 'tree.js'
+    @search_index_file = output_dir + 'panel' + 'search_index.js'
+  end
+  
+  def generate(options = {})
+    @options = options
+    copy_resources
+    generate_search_index
+    generate_class_tree
+    generate_class_files
+    generate_index_file
+  end
+  
+  ### Copy all the resource files to output dir
+  def copy_resources
+    resources_path = File.join(TEMPLATE_DIR, RESOURCES_DIR) + '/.'
+		debug_msg "Copying #{resources_path}/** to #{output_dir}/**"
+    FileUtils.cp_r resources_path.to_s, output_dir.to_s, :preserve => true
+  end
+  
+  ### Generate a documentation file for each class
+	def generate_class_files
+		debug_msg "Generating class documentation in #{output_dir}"
+    templatefile = TEMPLATE_DIR + 'class.rhtml'
+
+		self.data.each do |mod_name, mod|
+		  if mod_name
+  			debug_msg "  working on %s" % [ mod.title]
+  			outfile     = output_dir + (mod.title + '.html')
+        # rel_prefix  = OUTPUT_DIR.relative_path_from( outfile.dirname )
+      
+  			debug_msg "  rendering #{outfile}"
+  			self.render_template( templatefile, binding(), outfile )
+  		end
+		end
+	end
+	
+	### Create index.html with frameset
+	def generate_index_file
+		debug_msg "Generating index file in #{output_dir}"
+    templatefile = TEMPLATE_DIR + 'index.rhtml'
+    outfile      = output_dir + 'index.html'
+	  index_path = self.data.to_a.first[1].title + '.html'
+	  self.render_template( templatefile, binding(), outfile )
+	end
+	
+	### Create class tree structure and write it as json
+  def generate_class_tree
+    debug_msg "Generating class tree"    
+    tree = self.data.map { |mod_name, mod| [mod_name, mod_name + '.html', '', []] }.sort{ |a, b| a[0] <=> b[0] }
+    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
+  end
+  
+  def generate_search_index
+    debug_msg "Generating search index"
+    
+    index = {
+      :searchIndex => [],
+      :longSearchIndex => [],
+      :info => []
+    }
+    
+    add_class_search_index(index)
+    add_method_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
+  end
+  
+  
+  ### Add classes to search +index+ array
+  def add_class_search_index(index)
+    debug_msg "  generating class search index"
+    
+    self.data.each do |mod_name, mod|      
+      index[:searchIndex].push( search_string(mod.title) )
+      index[:longSearchIndex].push( search_string(mod.title) )
+      index[:info].push([
+        mod.title,
+        '',
+        mod.title + '.html',
+        '',       
+        snippet(mod.summary),
+        TYPE_CLASS
+      ])
+    end
+  end
+  
+  ### Add methods to search +index+ array
+  def add_method_search_index(index)
+    debug_msg "  generating method search index"
+    
+    list = self.data.map { |mod_name, mod| 
+      mod.funcs
+    }.flatten
+    
+    list.each do |func|
+      func.short_names.each do |func_name|
+        index[:searchIndex].push( search_string(func.p_module.title + ':' + func_name) + '()' )
+        index[:longSearchIndex].push(search_string(func_name))
+        index[:info].push([
+          func_name, 
+          func.p_module.title + ':' + func_name,
+          func.p_module.title + '.html#' + func.ref,
+          '',        
+          snippet(func.summary),
+          TYPE_METHOD
+        ])
+      end
+    end
+  end
+  
+  
+  
+  ### Build search index key
+  def search_string(string)
+    string ||= ''
+    string.downcase.gsub(/\s/,'')
+  end
+  
+  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
+  
+  ### Output progress information if debugging is enabled
+	def debug_msg( *msg )
+		return unless $DEBUG_DOC
+		$stderr.puts( *msg )
+	end
+	
+	
+end