richunits 0.5.0 → 0.6

data/MANIFEST

@@ -1,40 +1,28 @@
-doc
-lib
-meta
-test
 CHANGES
+COPYING
+MANIFEST
+README
 RELEASE
 TODO
-README
-VERSION
-COPYING
-doc/ads
-doc/index.css
-doc/index.html
-doc/images
-doc/ads/rdoc.html
-doc/images/ruby.png
-doc/images/ruby-md.png
-doc/images/tiger_logo.png
-doc/images/ruby-sm.png
-doc/images/tiger-sm.png
 lib/rich_units.rb
 lib/richunits
 lib/richunits.rb
-lib/richunits/times.rb
+lib/richunits/bytes.rb
 lib/richunits/duration.rb
 lib/richunits/multipliers.rb
+lib/richunits/times.rb
 lib/richunits/weekdays.rb
-lib/richunits/bytes.rb
+meta/abstract
+meta/anthology
+meta/contact
 meta/created
-meta/repository
 meta/homepage
-meta/abstract
+meta/license
+meta/name
+meta/repository
 meta/title
 meta/version
-meta/license
-meta/contact
-test/test_duration.rb
 test/test_bytes.rb
+test/test_duration.rb
 test/test_multipliers.rb
 test/test_times.rb

data/README

@@ -1,52 +1,62 @@
-= Rich Units
+= RichUnits
 
 Easy Units for Ruby
 
-  http://richunits.rubyforge.org
+* http://rubyworks.github.com/richunits/
+* http://richunits.rubyforge.org/ (old site)
 
-== Usage
 
-You only need to require 'rich_units' and all of RichUnit's
-extensions are loaded.
+== DESCRIPTION:
+
+RichUnits is simple units system based on Rich Kilmer's original
+time.rb script, in which different measures of time are represented
+as seconds via extensions to the Numeric class. Later, Ruby on Rails'
+ActiveSupport library adopted this script and expanded upon it.
+RichUnits borrows from their work and a few other renditions this code
+that have made the rounds to create a robust stand-alone version.
+
+Unique to RichUnits' rendition is the Duration class (inspired by Matthew
+Harris' version by the same name). Originally time measures were stored as
+integers representing seconds. The Duration class instead stores the seconds
+as an attribute and adds an optional segements property which can be used to
+select exactly how to segment up the time period (years, week, days, etc.).
+
+
+== SYNOPSIS:
+
+You only need to require 'richunits' and all of RichUnit's functionality
+becomes available.
 
   require 'richunits'
 
   2.hours  #=> 7200
 
-RichUnits also includes a Duration class (inspired by Matthew Harris' version)
-for storing time measures. These measure were originally stored as Integer
-seconds. The Duration class instead stores the seconds as an attribute and
-adds a  an optional segements property which can be used to select exactly
-how to segment up the time period (years, week, days, etc.).
-
 See RDocs for complete API documentation.
 
-== Development
-
-GitHub Repository.
 
-  git://github.com/trans/richunits.git
+== DEVELOPMENT:
 
-This project uses the Reap build system.
+RichUnits utilizes GitHub for development. You will find the git 
+repo under the rubyworks account.
 
-  http://reap.rubyforge.org
+  git://github.com/rubyworks/richunits.git
 
-== TODO
+RichUnits utilizes the Syckle build system.
 
-* Should we rename the Rubyforge project from richunits to rich_units?
 
-== Copying
+== COPYRIGHTS:
 
-Copyright (c) 2008 TigerOps
+Copyright (c) 2008 Thomas Sawyer
 Copyright (c) 2006 Matthew Harris
 Copyright (c) 2004 Rich Kilmer
 
 If you have contributed to this code and feel you deserve mention
-in the copyright notice, please let us know. Since this code has
+in the copyright notice, please let me know. Since this code has
 been through a number of hands and other projects (Facets and
 ActiveSupport among them) it is hard to identify exactly who is
-responsible for what. Nonetheless, Rich Kilmer is the father of
-this code so most of the rights must fall to him.
+responsible for what. Nonetheless, Rich Kilmer is the initiator
+of the whole idea (AFAIK), so I figure much of the rights belong
+to him.
 
 RichUnits is distributed under the terms of the MIT license.
 

data/TODO

@@ -1,5 +1,22 @@
+= TODO List
 
-* Achieve 99.9% drop-in compatability with ActiveSupport.
+== Achieve 99.9% drop-in compatability with ActiveSupport.
 
-* Better TimeZone support.
+* Duration may be the big difficulty here.
+
+
+== Better TimeZone support
+
+* tgzinfo?
+
+
+== Documentation
+
+I was looking through the rdoc at
+
+http://tigerops.rubyforge.org/rich_units/rdoc/index.html
+
+and found that the names generated by rdoc for the bit and byte human readable string methods is out of synch with the examples in the documentation for each of the methods. The actual method names Numeric#strfbits and Numeric#strfbytes work but the method names Numeric#bits_to_s and Numeric#bytes_to_s that are shown in the examples for each method do not work.
+
+(from Larry Baltz)
 

data/lib/richunits/duration.rb

@@ -12,40 +12,51 @@ module RichUnits
 
     SEGMENTS = %w{years weeks days hours minutes seconds}.collect{ |s| s.to_sym }
 
+    # Same as #new
     #
-    def self.[](seconds, *segments)
-      new(seconds, *segments)
+    def self.[](seconds, segmentA=nil, segmentB=nil)
+      new(seconds, segmentA, segmentB)
     end
 
+    # New duration.
     #
-    def initialize(seconds=0, *segments)
+    #   call-seq:
+    #     new(seconds)
+    #     new(seconds, max-period)
+    #     new(seconds, max-period, min-period)
+    #     new(seconds, [period1, period2, ...])
+    #
+    def initialize(seconds=0, segmentA=nil, segmentB=nil)
       @seconds = seconds.to_i
-      reset_segments(*segments)
+      reset_segments(segmentA, segmentB)
     end
 
-    #
+    # List of period segments.
     def segments; @segments; end
 
+    # Reset segments.
+    #
+    #   call-seq:
+    #     reset_segments(max-period)
+    #     reset_segments(max-period, min-period)
+    #     reset_segments([period1, period2, ...])
     #
-    def reset_segments(*segments)
-      case segments.size
-      when 0
+    def reset_segments(segmentA=nil, segmentB=nil)
+      if !segmentA
         @segments = [:days, :hours, :minutes, :seconds]
-      when 1
-        case segments = segments[0]
+      elsif !segmentB
+        case segmentA
         when Array
-          @segments = segments.collect{ |p| (p.to_s.downcase.chomp('s') + 's').to_sym }
+          @segments = segmentA.map{ |p| (p.to_s.downcase.chomp('s') + 's').to_sym }
           raise ArgumentError unless @segments.all?{ |s| SEGMENTS.include?(s) }
         else
-          f = SEGMENTS.index(segments)
+          f = SEGMENTS.index(segmentA)
           @segments = SEGMENTS[f..0]
         end
-      when 2
-        f = SEGMENTS.index(segments[0])
-        t = SEGMENTS.index(segments[1])
+      else # segmentA && segmentB
+        f = SEGMENTS.index(segmentA)
+        t = SEGMENTS.index(segmentB)
         @segments = SEGMENTS[f..t]
-      else
-        raise ArgumentError
       end
     end
 
@@ -130,7 +141,7 @@ module RichUnits
       self.class.new(@seconds - other.to_i, segments)
     end
 
-    def +(other)
+    def *(other)
       self.class.new(@seconds * other.to_i, segments)
     end
 

data/meta/anthology

@@ -0,0 +1 @@
+rubyworks

data/meta/name

@@ -0,0 +1 @@
+richunits

data/meta/repository

@@ -0,0 +1 @@
+git://github.com/rubyworks/richunits.git

data/meta/title

@@ -1 +1 @@
-Rich Kilmer's Units System
+RichUnits

data/meta/version

@@ -1 +1 @@
-0.5.0
+0.6

data/test/test_times.rb

@@ -54,6 +54,21 @@ class TC_Times < Test::Unit::TestCase
     assert_equal( t + 1.day, 1.day.after(t) )
   end
 
+  #
+
+  def test_addition
+    assert_equal(11.minutes, 10.minutes + 1.minute)
+    assert_equal(11.minutes.to_i, (10.minutes + 1.minute).to_i)
+
+    assert_equal(11.minutes, 10.minutes + 60.seconds)
+    assert_equal(11.minutes.to_i, (10.minutes + 60.seconds).to_i)
+  end
+
+  def test_multiplication
+    assert_equal(20.minutes, 10.minutes * 2)
+    assert_equal(20.minutes.to_i, (10.minutes * 2).to_i)
+  end
+
 end
 
 class WeekdaysTest < Test::Unit::TestCase

metadata

@@ -1,20 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: richunits
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: "0.6"
 platform: ruby
-authors: 
-- 7ransUnit <transfire@gmail.com>
+authors: []
+
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-06-01 00:00:00 -04:00
+date: 2009-10-31 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Rich Kilmer's Unit system provides english-esque methods for working with common units, such as days and bytes and multiplers like kilo, or mega. It does so by reducing basic measures to a lower common denominator, such as seconds for time measures and bits for byte measures.
-email: transfire@gmail.com
+description: |-
+  Rich Kilmer's Unit system provides english-esque methods
+  for working with common units, such as days and bytes and
+  multiplers like kilo, or mega. It does so by reducing basic
+  measures to a lower common denominator, such as seconds for
+  time measures and bits for byte measures.
+email: 7ransUnit <transfire@gmail.com>
 executables: []
 
 extensions: []
@@ -25,57 +30,43 @@ extra_rdoc_files:
 - CHANGES
 - RELEASE
 - TODO
-- VERSION
 - COPYING
 files: 
-- doc
-- lib
-- meta
-- test
 - CHANGES
+- COPYING
+- MANIFEST
+- README
 - RELEASE
 - TODO
-- README
-- VERSION
-- COPYING
-- doc/ads
-- doc/index.css
-- doc/index.html
-- doc/images
-- doc/ads/rdoc.html
-- doc/images/ruby.png
-- doc/images/ruby-md.png
-- doc/images/tiger_logo.png
-- doc/images/ruby-sm.png
-- doc/images/tiger-sm.png
 - lib/rich_units.rb
-- lib/richunits
 - lib/richunits.rb
-- lib/richunits/times.rb
+- lib/richunits/bytes.rb
 - lib/richunits/duration.rb
 - lib/richunits/multipliers.rb
+- lib/richunits/times.rb
 - lib/richunits/weekdays.rb
-- lib/richunits/bytes.rb
+- meta/abstract
+- meta/anthology
+- meta/contact
 - meta/created
-- meta/repository
 - meta/homepage
-- meta/abstract
+- meta/license
+- meta/name
+- meta/repository
 - meta/title
 - meta/version
-- meta/license
-- meta/contact
-- test/test_duration.rb
 - test/test_bytes.rb
+- test/test_duration.rb
 - test/test_multipliers.rb
 - test/test_times.rb
-- MANIFEST
 has_rdoc: true
 homepage: http://tigerops.rubyforge.org/richunits
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --title
-- richunits api
+- RichUnits API
 - --main
 - README
 require_paths: 
@@ -95,12 +86,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tigerops
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Rich Kilmer's Unit system provides english-esque methods
 test_files: 
-- test/test_duration.rb
 - test/test_bytes.rb
+- test/test_duration.rb
 - test/test_multipliers.rb
 - test/test_times.rb

data/VERSION

@@ -1 +0,0 @@
-richunits 0.5.0 beta (2009-05-30)

data/doc/ads/rdoc.html

@@ -1,12 +0,0 @@
-<div style="position: absolute; top: 5px; right: 10px;">
-  <script type="text/javascript"><!--
-  google_ad_client = "pub-1126154564663472";
-  //BLOW 234x60
-  google_ad_slot = "6480217558";
-  google_ad_width = 234;
-  google_ad_height = 60;
-  //--></script>
-  <script type="text/javascript"
-  src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-  </script>
-</div>

data/doc/index.css

@@ -1,179 +0,0 @@
-* {
-  padding     : 0;
-  margin      : 0;
-  font-family : sans-serif;
-}
-
-body {
-  color       : black;
-  background  : white;
-  text-align  : center;
-  position    : relative;
-  font-size   : 10px;
-}
-
-p {
-  text-align  : justify;
-  font-size   : 12px;
-  color       : #555;
-  font-weight : normal;
-  margin      : 10px 0px 10px 0px;
-  line-height : 1.5em;
-  letter-spacing: 1px;
-}
-
-/*
-p.intro {
-  font-size: 14px;
-  font-weight: normal;
-  letter-spacing: 1px;
-}
-*/
-
-a {
-  color: #EF0040;
-}
-
-img {
-  border: none;
-}
-
-pre {
-  font-family  : monospace;
-  font-size    : 8pt;
-  color        : #eeeeee;
-  background   : #1f0f0f;
-  margin       : 10px;
-  font-weight  : bold;
-  line-height  : 1.5em;
-  padding-top  : 15px;
-  text-align   : left;
-}
-
-h1 {
-  font-size: 60px;
-}
-
-h2 {
-  font-size: 40px;
-  text-align: left;
-  margin-top: 50px;
-}
-
-h3 {
-  text-align: left;
-  margin-top: 20px;
-}
-
-td {
-  vertical-align: top;
-}
-
-.container {
-  width        : 730px;
-  margin       : 0 auto;
-  position     : relative;
-}
-
-
-.aside {
-  float: left;
-  width: 164px;
-  padding: 20px;
-  margin: 40px;
-  text-align: center;
-  background: black;
-  border: 0px solid gray;
-  margin-top: 40px;
-}
-
-.aside a {
-  color: #EF0040;
-  font-weight: bold;
-}
-
-.aside p {
-  text-align: center;
-}
-
-.header {
-  padding: 70px 40px 50px 60px;
-  background: url(images/ruby-md.png) 500px 30px no-repeat #111111;
-  text-align: left;
-  font-weight: bold;
-  margin-bottom: 20px;
-  border: 1px solid gray;
-}
-
-.title {
-  color: white; font-size: 62px;
-}
-
-.subtitle {
-  color: white;
-  font-size: 16px;
-}
-
-.content {
-  padding: 0 0;
-}
-
-.about {
-  margin: 0 0 20px 0;
-  padding: 20px;
-  text-align: justify;
-  font-size: 20pt;
-  font-weight: bold;
-  background: #BF0020;
-  color: white;
-  border: 1px solid pink;
-}
-
-.menu {
-  width          : 730px;
-  margin         : 0 auto;
-  padding        : 15px 30px;
-  color          : orange;
-  font-size      : 12px;
-  text-align     : left;
-}
-
-.menu a {
-  font-size: 1em;
-  font-weight: bold;
-  color: red;
-  text-decoration: none;
-}
-
-.menu a:hover {
-  text-decoration: underline;
-}
-
-.ad {
-  border      : 0px solid white;
-  text-align  : center;
-}
-
-.invert {
-  text-align   : left;
-  color        : white;
-  margin       : 0;
-  padding      : 15px 15px 15px 15px;
-  background   : black;
-}
-
-.invert p {
-  text-align   : left;
-  color        : white;
-}
-
-.copyright {
-  padding     : 5px;
-  text-align  : center;
-  color       : gray;
-  font-size   : 1.2em;
-  border      : 1px solid gray;
-  background  : #111111;
-  margin      : 20px 1px;
-}
-

data/doc/index.html

@@ -1,163 +0,0 @@
-
-<html>
-
-<head>
-  <title>Rich Units</title>
-
-  <link href="index.css" rel="stylesheet" type="text/css"/>
-  <link href="images/ruby-sm.png" rel="icon"/>
-
-  <META NAME="DESCRIPTION" CONTENT="Rich Units system for the Ruby programming lanaguage.">
-  <META NAME="KEYWORDS" CONTENT="units, ruby, numeric, time">
-</head>
-
-<body>
-
-<div class="menu">
-  <div style="float: right; font-weight: bold;">A <a href="http://tigerops.org">TigerOps</a> PROJECT</div>
-  <!-- &lt;<a href="http://tigerops.rubyforge.org/">Homepage</a>&gt; -->
-  <a href="rdoc/index.html">Documentation</a> &middot;
-  <a href="http://rubyforge.org/frs/?group_id=7034">Download</a> &middot;
-  <a href="http://rubyforge.org/projects/richunits">Development</a>
-</div>
-
-<div class="container">
-
-  <div class="header">
-    <span class="title">Rich Units</span>
-  </div>
-
-  <div class="content">
-
-    <p class="about">
-      RichUnits is a very easy to use unit system for the Ruby programming language.
-      It is essentially the same system popularized by Ruby on Rails.
-    </p>
-
-    <h2>Introduction</h2>
-
-    <p class="intro">Rich Units is a straight-forward units system based-on the original time
-       units work by Rich Kilmer (circa 2002-2004). Rich Units extends core Ruby with conveneice
-       methods for dealing with measures. The methods work by converting those measures to a low
-       common denominator; for instance all durations are stored in seconds.
-    </p>
-
-    <p class="intro">Rich Units provides essentially the same unit system used by
-       <a href="http://www.rubyonrails.org/">Ruby on Rails</a>*. But Rich Units seeks to imporve
-       upon this code, and provides a superset of functionality, partly derived from the
-       <a href="facets.rubyforge.org">Ruby Facets</a> distribution of the same libraries. 
-       Ultimately Rich Units intent is to provide a better system than either of these large
-       projects can provide, by virture of a dedicated development track.
-    </p>
-
-    <p><span style="font-size:0.8em;"> *with the present exception of the timezone extensions (coming soon).</span></p>
-
-    <h2>Examples</h2>
-
-    <p>
-      Primarily Rich Units extends Numeric.
-      Here are some basic examples:
-    </p>
-
-    <pre>
-      require 'rich_units'
-
-      4.days.hence    #=> Tue Apr 01 08:04:17 -0400 2008
-      4.hours.ago     #=> Thu Mar 27 22:03:33 -0400 2008
-
-      10.bytes        #=> 80
-    </pre>
-
-    <p>Rich Units also extends Time.</p>
-
-    <pre>
-      require 'rich_units'
-
-      Time.now                   #=> Fri Mar 28 08:10:40 -0400 2008
-      Time.now.years_hence(4)    #=> Wed Mar 28 08:10:47 -0400 2012
-    </pre>
-
-
-    <h2>Installation</h2>
-
-    <p>
-      Installing the RubyGem is of course straight forward.
-    </p>
-
-    <pre>
-      $ sudo gem install rich_units
-    </pre>
-
-    <p>
-      Manual site_ruby installation is provided via <a href="http://setup.rubyforge.org">Ruby Setup</a>.
-    </p>
-
-    <pre>
-      $ tar -xvzf rich_units-0.4.0.tgz
-      $ cd rich_units-0.4.0
-      $ sudo setup.rb all
-    </pre>
-
-
-    <h2>Development</h2>
-
-    <p>You can use gitweb to browse the 'richunits' repository.</p>
-
-    <h3>Anonymous Repository Access</h3>
-
-    <p>To pull the 'richunits' repository anonymously, use:</p>
-
-    <pre>
-      git clone git://rubyforge.org/richunits.git
-    </pre>
-
-    <h3>Master Developer Repository Access</h3>
-
-    <p>Developers: You can push to the 'richunits' repository using:</p>
-
-    <pre>
-      gitosis@rubyforge.org:richunits.git
-    </pre>  
-
-    <p>Only project developers have access to this repository.
-       Please contact <b>transfire at gmail.com</b> if you'd like to join the development team.
-    </p>
-
-    <h3>Contributor Repository Access</h3>
-
-    <p>This project is also hosted on GitHub at</p>
-
-    <pre>
-      http://github.com/trans/richunits/tree/master
-    </pre>  
-  </div>
-
-  <br/><br/>
-
-  <div style="text-align: center; padding: 20px 0; border-top: 1px solid #ccc;">
-    <script type="text/javascript"><!--
-    google_ad_client = "pub-1126154564663472";
-    /* TIGER 728x90 10/28/08 */
-    google_ad_slot = "2386645975";
-    google_ad_width = 728;
-    google_ad_height = 90;
-    //-->
-    </script>
-    <script type="text/javascript"
-    src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
-    </script>
-    <!-- <iframe src="http://tigerops.org/assets/adverts/banner-900-1.html" scrolling="no"></frame> -->
-  </div>
-
-  <div class="copyright">
-    <br/><br/>
-    <span style="color: #EF0040;">Rich Units</span> Copyright (c) 2007, 2008 <a href="http://tigerops.org">Tiger Ops</a>
-    <br/><br/>
-    Rich Units is distributed under the terms of the MIT license. <br/>
-    <br/><br/>
-  </div>
-
-</div>
-
-</body>
-</html>