prelude 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,8 +1,11 @@
 = CHANGELOG
 
-$Id: CHANGELOG 7 2006-09-06 17:03:26Z prelude $
+$Id: CHANGELOG 17 2006-09-17 18:03:15Z prelude $
 
-== 09/06/06 - Release 0.0.2	
+== 09/17/06 - Release 0.0.3
+* Converted List from being functional-like to fully functional, i.e., all its methods return functions.
+
+== 09/06/06 - Release 0.0.2
 
 * Expanded README and moved references from sources into it.
 * Fixed Tuple's implementation.

data/README

@@ -1,6 +1,6 @@
 = Prelude - a Haskell-like functional library
 
-$Id: README 7 2006-09-06 17:03:26Z prelude $
+$Id: README 17 2006-09-17 18:03:15Z prelude $
 
 *WARNING* <tt>The project is still in a very preliminary state. Only
 List was partially implemented. Feel free to contribute.</tt>
@@ -119,7 +119,7 @@ itself, see http://nomaware.com/monads/html/index.html to get
 started. More monadic resources are here:
 http://haskell.org/haskellwiki/Books_and_tutorials#Using_monads
 
-=== What else
+=== What else?
 
 These features will be nice to have in a second release of the library:
 
@@ -127,7 +127,7 @@ These features will be nice to have in a second release of the library:
 
 * Tools for automatic program verification and algebraic proofs
 
-* What else
+* What else?
 
 
 == What's in a name

data/Rakefile

@@ -1,5 +1,5 @@
 #--
-# $Id: Rakefile 7 2006-09-06 17:03:26Z prelude $
+# $Id: Rakefile 18 2006-09-17 23:33:58Z prelude $
 #
 #     This file is part of the Prelude library that provides tools to
 #     enable Haskell style functional programming in Ruby.
@@ -23,6 +23,12 @@
 #     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 #++
 
+#--
+# To run:
+# c:/tools/trunk/ruby-1.8.4_20/bin/rake.bat
+#
+#++
+
 require 'rubygems'
 require 'rake'
 require 'rake/testtask'
@@ -31,6 +37,7 @@ require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'fileutils'
+require 'pp'
 
 require File.join(File.dirname(__FILE__), 'lib', 'prelude')
 
@@ -47,12 +54,13 @@ RUBY_FORGE_USER    = "prelude"
 desc "Default Task"
 task :default => [ :test ]
 
-# Run the unit tests
-Rake::TestTask.new { |t|
-  t.libs << "test"
-  t.test_files = Dir['test/ts_*.rb']
-  t.verbose = true
-}
+task :test do |x|
+  Rake::TestTask.new { |t|
+    t.libs << "test"
+    t.test_files = Dir['test/ts_*.rb']
+    t.verbose = true
+  }
+end # :test
 
 file 'doc/index.html' => ['misc/rdoc_template.rb' ]
 task :rdoc => ['doc/index.html']
@@ -80,31 +88,42 @@ task :gem => [ :clobber, :rdoc ]
 # ~..>tar xvf prelude-0.0.1.gem; gunzip data.tar.gz metadata.gz; tar xvf data.tar; cat metadata
 
 spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = PKG_NAME
-  s.summary = "Haskell-like functional library"
-  s.description = %q{Enables Ruby programmers to use higher-order functions, monads, and other Haskell features.}
-  s.version = PKG_VERSION
-
-  s.author = "Ivan K. and APP Design, Inc."
-  s.email = "prelude@rubyforge.org"
-  s.rubyforge_project = "prelude"
-  s.homepage = "http://prelude.rubyforge.org"
+  s.platform          = Gem::Platform::RUBY
+  s.name              = PKG_NAME
+  s.version           = PKG_VERSION
+  s.summary           = 'Haskell-like functional library'
+  s.description       = 'Enables Ruby programmers to use higher-order functions, monads, and other Haskell features.'
+  s.author            = 'Ivan K. and APP Design, Inc.'
+  s.email             = 'prelude@rubyforge.org'
+  s.rubyforge_project = 'prelude'
+  s.homepage          = 'http://prelude.rubyforge.org'
 
   s.has_rdoc = true
   s.requirements << 'none'
   s.require_path = 'lib'
   s.autorequire = 'prelude'
 
-  s.files  = [ "Rakefile", "README", "TODO", "CHANGELOG", "COPYING" ]
-  s.files += Dir.glob( "doc/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  s.files += Dir.glob( "examples/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  s.files += Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  s.files += Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-
-  s.test_files = Dir.glob( "test/**/ts_*rb" ).delete_if { |item| item.include?( "\.svn" ) }
-
+  [ 
+   "Rakefile", 
+   "README", 
+   "TODO",
+   "CHANGELOG",
+   "COPYING",
+   "doc/**/*",
+   "examples/**/*",
+   "lib/**/*",
+   "test/**/*"
+  ].each do |i|
+    s.files += Dir.glob(i).delete_if do
+      |x| x =~ /.*~/
+    end
+  end
+  puts "Files included into the GEM:"
+  pp s.files
+
+  s.test_files = Dir.glob( "test/**/ts_*rb" )
 end
+
 Rake::GemPackageTask.new(spec) do |p|
   p.gem_spec = spec
   p.need_tar = true

data/doc/classes/Kernel.html

@@ -0,0 +1,198 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Kernel</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Kernel</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/prelude_rb.html">
+                lib/prelude.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000113">caller_method</a>&nbsp;&nbsp;
+      <a href="#M000114">silence_warnings</a>&nbsp;&nbsp;
+      <a href="#M000112">this_method</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000113" class="method-detail">
+        <a name="M000113"></a>
+
+        <div class="method-heading">
+          <a href="#M000113" class="method-signature">
+          <span class="method-name">caller_method</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Method object for the caller of the currently executing method
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000113-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000113-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/prelude.rb, line 118</span>
+118:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">caller_method</span>
+119:     <span class="ruby-identifier">name</span> = (<span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">caller</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/`([^']*)'/</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">$1</span>)
+120:     <span class="ruby-identifier">eval</span> <span class="ruby-node">&quot;self.method(\&quot;#{name}\&quot;.to_sym)&quot;</span>, <span class="ruby-identifier">binding</span>
+121:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000114" class="method-detail">
+        <a name="M000114"></a>
+
+        <div class="method-heading">
+          <a href="#M000114" class="method-signature">
+          <span class="method-name">silence_warnings</span><span class="method-args">() {|| ...}</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Shuts up Ruby&#8217;s warning.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000114-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/prelude.rb, line 124</span>
+124:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">silence_warnings</span>
+125:     <span class="ruby-identifier">old_verbose</span>, <span class="ruby-identifier">$VERBOSE</span> = <span class="ruby-identifier">$VERBOSE</span>, <span class="ruby-keyword kw">nil</span>
+126:     <span class="ruby-keyword kw">yield</span>
+127:   <span class="ruby-keyword kw">ensure</span>
+128:     <span class="ruby-identifier">$VERBOSE</span> = <span class="ruby-identifier">old_verbose</span>
+129:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000112" class="method-detail">
+        <a name="M000112"></a>
+
+        <div class="method-heading">
+          <a href="#M000112" class="method-signature">
+          <span class="method-name">this_method</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Method object for currently executing method
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000112-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000112-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/prelude.rb, line 112</span>
+112:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">this_method</span>
+113:     <span class="ruby-identifier">name</span> = (<span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">caller</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/`([^']*)'/</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">$1</span>)
+114:     <span class="ruby-identifier">eval</span> <span class="ruby-node">&quot;self.method(\&quot;#{name}\&quot;.to_sym)&quot;</span>, <span class="ruby-identifier">binding</span>
+115:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+</body>
+</html>

data/doc/classes/Prelude.html

@@ -88,6 +88,15 @@
 
    </div>
 
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000007">empty_list_error</a>&nbsp;&nbsp;
+      <a href="#M000009">get_proc</a>&nbsp;&nbsp;
+      <a href="#M000008">missing_function_error</a>&nbsp;&nbsp;
+      </div>
+    </div>
 
   </div>
 
@@ -99,8 +108,10 @@
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
 
-      Class <a href="Prelude/List.html" class="link">Prelude::List</a><br />
-Class <a href="Prelude/Monad.html" class="link">Prelude::Monad</a><br />
+      Module <a href="Prelude/List.html" class="link">Prelude::List</a><br />
+Module <a href="Prelude/Monad.html" class="link">Prelude::Monad</a><br />
+Class <a href="Prelude/EmptyListError.html" class="link">Prelude::EmptyListError</a><br />
+Class <a href="Prelude/MissingFunctionError.html" class="link">Prelude::MissingFunctionError</a><br />
 Class <a href="Prelude/Tuple.html" class="link">Prelude::Tuple</a><br />
 
     </div>
@@ -113,7 +124,17 @@ Class <a href="Prelude/Tuple.html" class="link">Prelude::Tuple</a><br />
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">VERSION</td>
           <td>=</td>
-          <td class="context-item-value">'0.0.2'</td>
+          <td class="context-item-value">'0.0.3'</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">Id</td>
+          <td>=</td>
+          <td class="context-item-value">lambda { |x| x }</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+Returns function that returns its argument
+
+</td>
         </tr>
         </table>
       </div>
@@ -125,6 +146,92 @@ Class <a href="Prelude/Tuple.html" class="link">Prelude::Tuple</a><br />
 
 
     <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">empty_list_error</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This is used to handle empty list errors in this library. Re-define to fit.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/prelude.rb, line 39</span>
+39:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">empty_list_error</span>
+40:     <span class="ruby-identifier">raise</span> <span class="ruby-constant">EmptyListError</span>, <span class="ruby-value str">'Illegal operation on an empty list.'</span>
+41:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">get_proc</span><span class="method-args">(f=nil, &amp;block)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+A utility to determine if a function was passed
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/prelude.rb, line 52</span>
+52:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_proc</span>(<span class="ruby-identifier">f</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+53:     <span class="ruby-comment cmt"># Has to be either function 'f' or block</span>
+54:     <span class="ruby-identifier">f</span> = <span class="ruby-identifier">block_given?</span> <span class="ruby-value">? </span><span class="ruby-identifier">block</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">missing_function_error</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">nil?</span>
+55:     <span class="ruby-identifier">f</span>.<span class="ruby-identifier">to_proc</span>
+56:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">missing_function_error</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+This is used to handle missing function errors in this library. Re-define
+to fit.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/prelude.rb, line 47</span>
+47:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">missing_function_error</span>
+48:     <span class="ruby-identifier">raise</span> <span class="ruby-constant">MissingFunctionError</span>, <span class="ruby-value str">'No function or block supplied.'</span>
+49:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
 
 
   </div>