Add in code to create example reports.

Author: Charlie Savage

LICENSE

@@ -0,0 +1,25 @@
+Copyright (C) 2005 - 2019 Shugo Maeda <shugo@ruby-lang.org>, Charlie Savage <cfis@savagexi.com> and
+                          Stefan Kaes <skaes@railsepxress.de>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

create_examples.rb

@@ -0,0 +1,77 @@
+# A silly little test program that finds prime numbers.  It
+# is intentionally badly designed to show off the use
+# of ruby-prof.
+#
+# Source from http://people.cs.uchicago.edu/~bomb154/154/maclabs/profilers-lab/
+
+require 'ruby-prof'
+require 'fileutils'
+
+def make_random_array(length, maxnum)
+  result = Array.new(length)
+  result.each_index do |i|
+    result[i] = rand(maxnum)
+  end
+
+  result
+end
+
+def is_prime(x)
+  y = 2
+  y.upto(x-1) do |i|
+    return false if (x % i) == 0
+  end
+  true
+end
+
+def find_primes(arr)
+  result = arr.select do |value|
+    is_prime(value)
+  end
+  result
+end
+
+def find_largest(primes)
+  largest = primes.first
+
+  # Intentionally use upto for example purposes
+  # (upto is also called from is_prime)
+  0.upto(primes.length-1) do |i|
+    prime = primes[i]
+    if prime > largest
+      largest = prime
+    end
+  end
+  largest
+end
+
+def run_primes(length=10, maxnum=1000)
+  # Create random numbers
+  random_array = make_random_array(length, maxnum)
+
+  # Find the primes
+  primes = find_primes(random_array)
+
+  # Find the largest primes
+  find_largest(primes)
+end
+
+# Generate example reports
+def generate_reports(result)
+  path = File.join('examples')
+  path = File.expand_path(path)
+  FileUtils.makedirs(path)
+  printer = RubyProf::MultiPrinter.new(result, [:flat, :flat_with_lines, :graph, :graph_html, :call_info, :tree, :stack, :dot])
+  printer.print(:path => path, :profile => 'primes')
+end
+
+def run
+  start = Process.times
+  result = RubyProf.profile do
+    run_primes(10000)
+  end
+
+  generate_reports(result)
+end
+
+run

index.html

@@ -19,7 +19,8 @@
           <li><a href="#performance">Performance</a></li>
           <li><a href="#profiling-rails">Profiling Rails</a></li>
           <li><a href="#version-1.0">Version 1.0</a></li>
-          <li><a href="#license">License</a></li>
+          <li><a href="#api-documentation">API Documentation</a></li>
+          <li><a href="#license"></a><a href="#license">License</a></li>
           <li><a href="#development">Development</a></li>
         </ul>
       </nav>
@@ -526,8 +527,10 @@ <h2><a id="version-1.0">Version 1.0</a></h2>
             specified the link scheme. This features was more confusing then
             helpful.</li>
         </ul>
+        <h2><a id="api-documentation">API Documentation</a></h2>
+        <p>API documenation for each class is <a href="doc/index.html">available</a>.</p>
         <h2><a id="license">License</a></h2>
-        <p>See LICENSE for license information.</p>
+        <p>See <a href="./LICENSE">LICENSE</a> for license information.</p>
         <h2><a id="development">Development</a></h2>
         <p>Code is located at <a href="https://github.com/ruby-prof/ruby-prof">github.com/ruby-prof/ruby-prof</a></p>
         <ul>