date-performance 0.4.6

data/AUTHORS

@@ -0,0 +1 @@
+rtomayko = Ryan Tomayko <rtomayko@gmail.com>

data/BENCHMARKS

@@ -0,0 +1,30 @@
+== WITH EXTENSION ==============================
+comparison
+  0.030000   0.000000   0.030000 (  0.027561)
+greater_than
+  0.030000   0.000000   0.030000 (  0.026667)
+new_civil
+  0.060000   0.000000   0.060000 (  0.063149)
+new_jd
+  0.060000   0.000000   0.060000 (  0.058935)
+strftime
+  0.020000   0.000000   0.020000 (  0.018389)
+strftime_after_new
+  0.080000   0.000000   0.080000 (  0.082086)
+strptime
+  0.070000   0.000000   0.070000 (  0.068235)
+== WITHOUT EXTENSION ===========================
+comparison
+  0.030000   0.000000   0.030000 (  0.027135)
+greater_than
+  0.030000   0.000000   0.030000 (  0.026128)
+new_civil
+  0.300000   0.000000   0.300000 (  0.303737)
+new_jd
+  0.110000   0.000000   0.110000 (  0.110033)
+strftime
+  0.230000   0.000000   0.230000 (  0.231178)
+strftime_after_new
+  0.850000   0.000000   0.850000 (  0.843894)
+strptime
+  3.000000   0.030000   3.030000 (  3.033587)

data/COPYING

@@ -0,0 +1,22 @@
+The MIT License
+===============
+ 
+Date::Performance is Copyright (c) 2007-08, Ryan Tomayko
+
+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.txt

@@ -0,0 +1,134 @@
+Date::Performance
+=================
+
+This package adds some semblance of performance to Ruby's core Date class 
+using a combination of different techniques:
+
+1. Implements various core *Date* methods in C. This is nowhere near a
+   complete rewrite of all *Date* features but many of the hot spots have
+   been replaced with machine code.
+ 
+2. Provide alternate implementations of `strftime` and `strptime` in C.  The stock
+   date formatting and parsing methods are extremely slow compared to their
+   libc counterparts. *Date#sys_strftime* and *Date::sys_strptime* are light
+   facades on top of the system's `strftime(2)` and `strptime(2)`. The system 
+   methods run 10x and 50x (yes, _fifty-ecks_) faster than their Ruby based counterparts, 
+   respectively.  Unfortunately, `strftime(2)` and `strptime(2)` implementations vary from
+   system to system and have various limitations not found in the core Date
+   implementation so can not safely be used as replacements for the core methods.
+
+3. Memoization. The *Date::Memoize* module can be used to speed certain
+   types of repetitive date processing significantly. This file must be 
+   required separately.
+
+Synopsis
+--------
+
+This package is mostly transparent after an initial require:
+
+    require 'date/performance'
+    Date.new 1912, 6, 23
+    # Wow! That was fast!
+
+*Date::Performance* is not used directly but automatically replaces core *Date*
+methods when required.
+
+In addition to the C extension, the *Date::Memoization* module can be used to
+speed things up even further in some cases by making a trade off between space 
+and time:
+
+    require 'date/memoize'
+    Date.new 1912, 6, 23
+    Date.parse '1912-06-23'
+
+Requiring the file automatically replaces *Date::new* / *Date::civil*, *Date::parse*, 
+and *Date::jd* methods with memoized versions.
+
+Installation / Hacking
+----------------------
+
+This package has been tested on the following platforms:
+
+  * FreeBSD 5.4 (x86) and 6.1 (AMD64)
+  * Linux / Fedora Core 6 (x86)
+  * MacOS X (Intel)
+
+The easiest way to install the package is to use RubyGems:
+
+    $ gem install date-performance --source=http://tomayko.com
+
+Old versions and other dist formats are available at:
+
+    http://tomayko.com/dist/date-performance/
+
+A git repository is also available:
+
+    $ git clone git://github.com/rtomayko/date-performance.git
+
+Background
+----------
+
+The *Date* class is often the cause of poor performance in Ruby programs. A frequent
+suggestion is to use the *Time* class, which is much faster, but that solution has 
+correctness problems in a wide range of data typing cases. It is often the case that 
+you want separate *Date*, *Time*, and *DateTime* types.
+
+There are a couple of reasons why *Date* runs slowly when compared with
+*Time*. The common assumption is that this is mostly due to *Time* being
+written in C and *Date* being written in Ruby. While that clearly has an
+impact, I would argue that the reason *Date* is slow is because it's not
+designed to be fast. The code opts for readability over performance in almost
+every case. _This is a feature_.
+
+Have you read the *date.rb* documentation [1]? The implementation is pretty
+hard core; it can handle a lot of weird cases that *Time* [2] does not and
+would appear to be a correct implementation of date handling, which has the
+usual side-effect of being slow.
+
+The *Date* implementation uses a single Astronomical Julian Day (AJD) number
+to represent dates internally. In fact, *Date#initialize* takes a
+single `ajd` argument, which means that all date forms that are commonly used 
+(UNIX timestamp, Civil, etc.) must be converted to an AJD before we can even
+instantiate the thing. 
+
+The real performance hit seems to come from the various rational number
+operations performed on the way from a civil, ordinal, and julian date to 
+an AJD.
+
+When I began writing *Date::Performance*, I was getting pretty big (3x - 4x)
+performance boosts in many places simply by optimizing the Ruby code a bit.
+These boosts came at the expense of readability, however, and so the decision
+was made to go for _maximum unreadability_ and implement the boosts in C.
+
+There's a nice balance here: the Ruby implementation reads like a spec,
+while the C version implements it for quickness.
+
+Memoization
+-----------
+
+In addition to the C extension, this package includes a separate *Date::Memoize*
+module that can further speed up date processing in situations where the range
+of dates being manipulated is fairly dense and the same dates are being
+created repeatedly. Working with databases and flat files are two examples
+where memoization may help significantly.
+
+The *Date::Memoize* module replaces various Date constructor methods (`new`,
+`civil`, and `parse`) with memoized[http://en.wikipedia.org/wiki/Memoization] 
+versions (see *Date::Memoization* for details). The best way to determine 
+whether memoization is right for you is to add it to your project and see 
+what happens.
+
+License
+-------
+
+MIT. See the COPYING file included in the distribution for more 
+information.
+
+See Also
+--------
+
+ * [1] Ruby *Date* Implementation Notes and Documentation:
+   http://www.ruby-doc.org/docs/rdoc/1.9/files/_/lib/date_rb.html
+
+ * [2] Ruby *Time* documentation 
+   http://www.ruby-doc.org/docs/rdoc/1.9/classes/Time.html

data/Rakefile

@@ -0,0 +1,90 @@
+load 'misc/asciidoc.rake'
+load 'misc/project.rake'
+
+Project.new "Date::Performance" do |p|
+  p.package_name = 'date-performance'
+  p.version_file = 'lib/date/performance.rb'
+  p.summary = "Adds some semblance of performance to Ruby's core Date class."
+  p.project_url = "http://tomayko.com/src/date-performance/"
+  p.extra_files.include "ext/**/*.{rb,c,h}", "AUTHORS", "BENCHMARKS"
+  p.configure_package {|spec| spec.extensions = FileList["ext/**/extconf.rb"].to_a }
+  p.author = 'Ryan Tomayko <r@tomayko.com>'
+  p.rubyforge_project = 'wink'
+
+  p.remote_dist_location   = "tomayko.com:/dist/#{p.package_name}"
+  p.remote_branch_location = "tomayko.com:/src/#{p.package_name}.git"
+  p.remote_doc_location    = "tomayko.com:/src/#{p.package_name}"
+end
+
+task :default => [ :compile, :test ]
+
+file 'doc/index.txt' => 'README.txt' do |f|
+  cp 'README.txt', f.name
+end
+
+CLEAN.include [ "ext/*.{o,bundle}", "lib/*.{bundle,so,dll}" ]
+CLOBBER.include [ "ext/Makefile" ]
+
+if File.exist? 'misc/date-1.8.5'
+  desc "Run unit tests with Date from Ruby 1.8.5"
+  Rake::TestTask.new 'test:ruby185' do |t|
+    t.libs << "test"
+    t.libs << "misc/date-1.8.5"
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose = true
+  end
+end
+
+task 'benchmark.without' do |t|
+  verbose false do
+    puts '== WITHOUT EXTENSION ==========================='
+    ruby "-Ilib test/benchmarks.rb"
+  end
+end
+
+task 'benchmark.with' do |t|
+  verbose false do
+    puts '== WITH EXTENSION =============================='
+    ruby "-Ilib -rdate/performance test/benchmarks.rb"
+  end
+end
+
+desc "Run benchmarks"
+task :benchmark => [ 'benchmark.without', 'benchmark.with' ]
+
+# Extension =================================================================
+
+DLEXT = Config::CONFIG['DLEXT']
+
+directory "lib"
+
+desc "Build the extension"
+task "date_performance" => [ "lib/date_performance.#{DLEXT}" ]
+
+file "ext/Makefile" => FileList[ "ext/*.{c,h,rb}" ] do
+  Dir.chdir("ext") { ruby "extconf.rb" }
+end
+
+file "ext/date_performance.#{DLEXT}" => FileList["ext/*.c", "ext/Makefile"] do |f|
+  Dir.chdir("ext") { sh "make" }
+end
+
+file "lib/date_performance.#{DLEXT}" => [ "ext/date_performance.#{DLEXT}" ] do |t|
+  cp "ext/date_performance.#{DLEXT}", t.name
+end
+
+desc "Compiles all extensions"
+task :compile => [ "lib/date_performance.#{DLEXT}" ]
+
+# Rubyforge =================================================================
+
+VERS = Project.current.version
+PKGNAME = "dist/date-performance-#{VERS}"
+
+desc 'Publish new release to rubyforge'
+task :release => [ "#{PKGNAME}.gem", "#{PKGNAME}.tar.gz" ] do |t|
+  sh <<-end
+    rubyforge add_release wink date-performance #{VERS} #{PKGNAME}.gem &&
+    rubyforge add_file    wink date-performance #{VERS} #{PKGNAME}.tar.gz
+  end
+end

data/doc/asciidoc.conf

@@ -0,0 +1,21 @@
+[attributes]
+outfilesuffix=.html
+gt=>
+pagewidth=800
+encoding=UTF-8
+textwidth=70
+newline=\n
+backslash=\
+nbsp= 
+amp=&
+basebackend=html
+quirks
+brvbar=|
+tabsize=4
+pageunits=
+empty=
+stylesdir=stylesheets
+theme=handbookish
+linkcss=yes
+icons=yes
+iconsdir=./images/icons

data/doc/changes.html

@@ -0,0 +1,32 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.2.5" />
+<link rel="stylesheet" href="stylesheets/handbookish.css" type="text/css" />
+<title>Date::Performance ChangeLog</title>
+</head>
+<body>
+<div id="header">
+<h1>Date::Performance ChangeLog</h1>
+<span id="author">Ryan Tomayko</span><br />
+<span id="email"><tt>&lt;<a href="mailto:r@tomayko.com">r@tomayko.com</a>&gt;</tt></span><br />
+</div>
+<div id="preamble">
+<div class="sectionbody">
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight 2.9
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt></tt></pre></div></div>
+</div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2008-07-12 08:15:20 PDT
+</div>
+</div>
+</body>
+</html>

data/doc/changes.txt

@@ -0,0 +1,7 @@
+:author:!
+= {project-name} ChangeLog
+
+[changelog]
+source~~~~~~~~~~~~~~~~~
+include::../ChangeLog[]
+source~~~~~~~~~~~~~~~~~

data/doc/license.html

@@ -0,0 +1,42 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.2.5" />
+<link rel="stylesheet" href="stylesheets/handbookish.css" type="text/css" />
+<title>The MIT License</title>
+</head>
+<body>
+<div id="header">
+<h1>The MIT License</h1>
+<span id="author">Ryan Tomayko</span><br />
+<span id="email"><tt>&lt;<a href="mailto:r@tomayko.com">r@tomayko.com</a>&gt;</tt></span><br />
+</div>
+<div id="preamble">
+<div class="sectionbody">
+<div class="para"><p>Date::Performance is Copyright (c) 2007-08, Ryan Tomayko</p></div>
+<div class="para"><p>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:</p></div>
+<div class="para"><p>The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.</p></div>
+<div class="para"><p>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.</p></div>
+</div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2008-07-12 08:15:21 PDT
+</div>
+</div>
+</body>
+</html>

data/doc/license.txt

@@ -0,0 +1 @@
+include::../COPYING[]

data/doc/stylesheets/handbookish-manpage.css

@@ -0,0 +1,36 @@
+/* Overrides for manpage documents */
+body { 
+  font-family: 'Lucida Console', 'Bitstream Vera Sans Mono', 'Courier New', monospace;
+  color:#555;
+}
+tt { 
+  font-family:'Lucida Console', 'Bitstream Vera Sans Mono', 'Courier New', monospace;
+  font-weight:bold;
+  font-size:100%;                       /* overrides base stylesheet */
+}
+em { 
+  font-style:normal;
+  color:#222;
+}
+dt { font-weight:bold; color:#000 }
+
+h1 {
+  font-size:1.714em;                     /* 24px */
+  line-height:1.666;                     /* 40px */
+  margin:1.666em 0;                      /* 40px */
+  padding: 0.3333em 0;                   /* 8px */
+  border-bottom:0.08333em solid #fff;    /* 2px */
+  border-top:0.08333em solid #fff;       /* 2px */
+  text-align:center;
+}
+h2 {
+  font-size:1.142em;                     /* 16px */
+  line-height:1.25;                      /* 20px baseline */
+  margin:1.25em 0;                       /* 20px */
+  border-bottom:0;                       
+  border-top:0;
+}
+div.sectionbody {
+  margin-left: 5%;
+}
+