measure 0.1.0 → 0.2.0

data/COPYING.LIB

@@ -1,154 +1,156 @@
-		   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+= GNU LESSER GENERAL PUBLIC LICENSE
+
+Version:: 3
+Date:: 29 June 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
 
-  This version of the GNU Lesser General Public License incorporates
+This version of the GNU Lesser General Public License incorporates
 the terms and conditions of version 3 of the GNU General Public
 License, supplemented by the additional permissions listed below.
 
-  0. Additional Definitions. 
+== Additional Definitions. 
 
-  As used herein, "this License" refers to version 3 of the GNU Lesser
+As used herein, "this License" refers to version 3 of the GNU Lesser
 General Public License, and the "GNU GPL" refers to version 3 of the GNU
 General Public License.
 
-  "The Library" refers to a covered work governed by this License,
+"The Library" refers to a covered work governed by this License,
 other than an Application or a Combined Work as defined below.
 
-  An "Application" is any work that makes use of an interface provided
+An "Application" is any work that makes use of an interface provided
 by the Library, but which is not otherwise based on the Library.
 Defining a subclass of a class defined by the Library is deemed a mode
 of using an interface provided by the Library.
 
-  A "Combined Work" is a work produced by combining or linking an
+A "Combined Work" is a work produced by combining or linking an
 Application with the Library.  The particular version of the Library
 with which the Combined Work was made is also called the "Linked
 Version".
 
-  The "Minimal Corresponding Source" for a Combined Work means the
+The "Minimal Corresponding Source" for a Combined Work means the
 Corresponding Source for the Combined Work, excluding any source code
 for portions of the Combined Work that, considered in isolation, are
 based on the Application, and not on the Linked Version.
 
-  The "Corresponding Application Code" for a Combined Work means the
+The "Corresponding Application Code" for a Combined Work means the
 object code and/or source code for the Application, including any data
 and utility programs needed for reproducing the Combined Work from the
 Application, but excluding the System Libraries of the Combined Work.
 
-  1. Exception to Section 3 of the GNU GPL.
+== Exception to Section 3 of the GNU GPL.
 
-  You may convey a covered work under sections 3 and 4 of this License
+You may convey a covered work under sections 3 and 4 of this License
 without being bound by section 3 of the GNU GPL.
 
-  2. Conveying Modified Versions.
+== Conveying Modified Versions.
 
-  If you modify a copy of the Library, and, in your modifications, a
+If you modify a copy of the Library, and, in your modifications, a
 facility refers to a function or data to be supplied by an Application
 that uses the facility (other than as an argument passed when the
 facility is invoked), then you may convey a copy of the modified
 version:
 
-   a) under this License, provided that you make a good faith effort to
+a. under this License, provided that you make a good faith effort to
    ensure that, in the event an Application does not supply the
    function or data, the facility still operates, and performs
    whatever part of its purpose remains meaningful, or
 
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
+b. under the GNU GPL, with none of the additional permissions of this
+   License applicable to that copy.
 
-  3. Object Code Incorporating Material from Library Header Files.
+== Object Code Incorporating Material from Library Header Files.
 
-  The object code form of an Application may incorporate material from
+The object code form of an Application may incorporate material from
 a header file that is part of the Library.  You may convey such object
 code under terms of your choice, provided that, if the incorporated
 material is not limited to numerical parameters, data structure
 layouts and accessors, or small macros, inline functions and templates
 (ten or fewer lines in length), you do both of the following:
 
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
+a. Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are covered
+   by this License.
 
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
+b. Accompany the object code with a copy of the GNU GPL and this
+   license document.
 
-  4. Combined Works.
+== Combined Works.
 
-  You may convey a Combined Work under terms of your choice that,
+You may convey a Combined Work under terms of your choice that,
 taken together, effectively do not restrict modification of the
 portions of the Library contained in the Combined Work and reverse
 engineering for debugging such modifications, if you also do each of
 the following:
 
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version. 
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
+a. Give prominent notice with each copy of the Combined Work that the
+   Library is used in it and that the Library and its use are covered
+   by this License.
+
+b. Accompany the Combined Work with a copy of the GNU GPL and this
+   license document.
+
+c. For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among these
+   notices, as well as a reference directing the user to the copies of
+   the GNU GPL and this license document.
+
+d. Do one of the following:
+
+   0. Convey the Minimal Corresponding Source under the terms of this
+      License, and the Corresponding Application Code in a form
+      suitable for, and under terms that permit, the user to recombine
+      or relink the Application with a modified version of the Linked
+      Version to produce a modified Combined Work, in the manner
+      specified by section 6 of the GNU GPL for conveying
+      Corresponding Source.
+
+   1. Use a suitable shared library mechanism for linking with the
+      Library. A suitable mechanism is one that (a) uses at run time a
+      copy of the Library already present on the user's computer
+      system, and (b) will operate properly with a modified version of
+      the Library that is interface-compatible with the Linked
+      Version.
+
+e. Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the GNU
+   GPL, and only to the extent that such information is necessary to
+   install and execute a modified version of the Combined Work
+   produced by recombining or relinking the Application with a
+   modified version of the Linked Version. (If you use option 4d0, the
+   Installation Information must accompany the Minimal Corresponding
+   Source and Corresponding Application Code. If you use option 4d1,
+   you must provide the Installation Information in the manner
+   specified by section 6 of the GNU GPL for conveying Corresponding
+   Source.)
+
+== Combined Libraries
+
+You may place library facilities that are a work based on the
 Library side by side in a single library together with other library
 facilities that are not Applications and are not covered by this
 License, and convey such a combined library under terms of your
 choice, if you do both of the following:
 
-   a) Accompany the combined library with a copy of the same work based
+a. Accompany the combined library with a copy of the same work based
    on the Library, uncombined with any other library facilities,
    conveyed under the terms of this License.
 
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
+b. Give prominent notice with the combined library that part of it is
+   a work based on the Library, and explaining where to find the
    accompanying uncombined form of the same work.
 
-  6. Revised Versions of the GNU Lesser General Public License.
+== Revised Versions of the GNU Lesser General Public License.
 
-  The Free Software Foundation may publish revised and/or new versions
+The Free Software Foundation may publish revised and/or new versions
 of the GNU Lesser General Public License from time to time. Such new
 versions will be similar in spirit to the present version, but may
 differ in detail to address new problems or concerns.
 
-  Each version is given a distinguishing version number. If the
+Each version is given a distinguishing version number. If the
 Library as you received it specifies that a certain numbered version
 of the GNU Lesser General Public License "or any later version"
 applies to it, you have the option of following the terms and
@@ -158,9 +160,8 @@ received it does not specify a version number of the GNU Lesser
 General Public License, you may choose any version of the GNU Lesser
 General Public License ever published by the Free Software Foundation.
 
-  If the Library as you received it specifies that a proxy can decide
+If the Library as you received it specifies that a proxy can decide
 whether future versions of the GNU Lesser General Public License shall
 apply, that proxy's public statement of acceptance of any version is
 permanent authorization for you to choose that version for the
 Library.
-

data/ChangeLog

@@ -1,3 +1,70 @@
+2009-03-10  Kenta Murata  <mrkn@mrkn.jp>
+
+	* lib/measure/support.rb (Measure): add short_form_avaiable? method.
+
+	* lib/measure/support.rb (Measure): rename with_short_form to
+	short_form and add enable_ and disable_short_form methods.
+
+2008-09-04  Kenta Murata  <mrkn@mrkn.jp>
+
+	* spec/measure_spec.rb: modified to avoid warnings ``warning:
+	parenthesize argument(s) for future version'' in 1.8.6.
+
+	* lib/measure/length.rb: add some physical length units.
+
+	* lib/measure/length.rb: enclose unit definitions by ``class
+	Measure / end'' syntax.
+
+	* lib/measure/support.rb (MeasureSupport#method_missing): replace
+	Measure.defined? Measure.has_unit?.
+
+	* lib/measure.rb (def_unit, def_alias, def_conversion): new
+	aliases for short definition form (merged changed by walf443).
+
+2008-08-24  Kenta Murata  <mrkn@mrkn.jp>
+
+	* Rakefile, lib/measure.rb, spec/measure_spec.rb: merge the
+	changes by walf443 for fixing warnings "warning: parenthesize
+	argument(s) for future version" in 1.8.6.
+
+	* spec/measure_spec.rb: some specs are relocated and modified appropriately.
+
+	* spec/measure_spec.rb: replace compatible to direct_compatible.
+
+	* .gitignore: add doc/rdoc.
+
+	* TODO: rdocnize and add some items.
+
+	* COPYING, COPYING.LIB: rdocnize.
+
+	* spec/measure_spec.rb: s/cummutative/commutative/g.
+
+	* Rakefile (rdoc): modify output directory.
+
+	* lib/measure.rb: some documentation comments are written.
+	(Measure.defined?): it is removed.
+	(Measure.resolve_alias): it now raise InvalidUnitError if the
+	given unit is invalid.
+	(Measure.compatible?): it is renamed to more intuitively name
+	`Measure.direct_compatible?', and the original is removed now.
+	(Measure.num_units): it now returns the number of both defined
+	units and aliases.
+	(Measure.define_unit): it method returns Measure class if
+	succeeded.
+	(Measure.define_conversion, Measure.neighbors, Measure#convert):
+	it now supports conversions by Proc objects.
+	(Measure.undefine_unit): it is a new method to undefine an unit.
+	(Measure.find_multi_hop_conversion): it is renamed to more
+	intuitively name `Measure.find_conversion_route', and the original
+	is now an alias.
+	(Measure#*, Measure#/): it now supports operation with values with
+	unit `1'.
+	(Measure#to_i, Measure#to_f): they are removed because of the
+	behavior of Numeric#coerce.
+
+	* lib/measure/version.rb (Measure::VERSION): change development
+	version number to `0.2.0'.
+
 2008-08-11  Kenta Murata  <muraken@gmail.com>
 
 	* Rakefile: replace all Spec::VERSION module to Measure::VERSION.

data/Rakefile

@@ -29,6 +29,7 @@ end
 desc 'Run all specs and store html output in doc/output/report.html'
 Spec::Rake::SpecTask.new('spec_html') do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
+  t.warning    = true
   t.spec_opts = [ '--format html:../../../../doc/output/report.html',
                   '--format progress',
                   '--backtrace' ]
@@ -36,10 +37,11 @@ end
 
 desc 'Generate RDoc'
 rd = Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = File.join('..', 'doc', 'output', 'rdoc')
+  rdoc.rdoc_dir = File.join('doc', 'rdoc')
   rdoc.options << '--title' << 'Measure' << '--line-numbers'
   rdoc.options << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'CHANGES', 'COPYING.LIB', 'lib/**/*.rb')
+  rdoc.rdoc_files.include('README', 'CHANGES', 'COPYING', 'COPYING.LIB',
+                          'lib/**/*.rb')
 end
 
 spec = Gem::Specification.new do |s|
@@ -135,7 +137,7 @@ end
 
 desc 'Publish news on RubyForge'
 task :publish_news => [ :verify_user ] do
-  unless Measure::VERSION::RELEASE_CANDIDATE
+  unless defined? Measure::VERSION::RELEASE_CANDIDATE and Measure::VERSION::RELEASE_CANDIDATE
     require 'meta_project'
     require 'rake/contrib/xforge'
 

data/TODO

@@ -1,13 +1,18 @@
-= Current version
+== TODOs
 
+=== Toward the version 1.0.0
+
+- Defined units should be managed by Hash instead of Array because of search speed.
+- The unit management system should be implemented as thread safe.
 - To write a spec for Measure#convert method with a unit same as receiver's one.
-- To write specs for Measure#to_{a,i,f,s}.
+- To write specs for Measure#to_{a,s}.
 - To write a spec for Measure#coerce.
 - To write specs for binary operation.
 - To write specs for comparison methods.
 - To write RDoc documents.
++ Supports incommutative conversion by Proc objects.
 
-= Future works
+=== Future works
 
 - To support composite dimension.
 - To define well-known physical constants.

data/lib/measure.rb

@@ -20,22 +20,50 @@ class Measure
     end
 
     def has_unit?(unit)
-      unit = resolve_alias unit
-      return @@units.include? unit
+      begin
+        unit = resolve_alias unit
+        return @@units.include?(unit)
+      rescue InvalidUnitError
+        return false
+      end
     end
-    alias defined? has_unit?
 
-    def compatible?(u1, u2)
+    #
+    # Resolves an alias and returns the entity.
+    # The returned unit is NOT invalid always.
+    # InvalidUnitError is raised if a given unit is undefined.
+    #
+    def resolve_alias(unit)
+      # NOTE: mustn't use has_unit? method to avoid infinite recursion
+      return unit if @@units.include? unit
+      unless @@alias_map.has_key? unit
+        raise InvalidUnitError, "unit `#{unit}' is undefined"
+      end
+      while @@alias_map.has_key? unit
+        unit = @@alias_map[unit]
+      end
+      return unit
+    end
+
+    #
+    # Test direct compatibility between two units, u1 and u2.
+    #
+    def direct_compatible?(u1, u2)
       u1 = resolve_alias u1
-      raise InvalidUnitError, "unknown unit: #{u1}" unless self.defined? u1
       u2 = resolve_alias u2
-      raise InvalidUnitError, "unknown unit: #{u2}" unless self.defined? u2
       return true if u1 == u2
-      return true if @@conversion_map.has_key? u1 and @@conversion_map[u1].has_key? u2
-      return true if @@conversion_map.has_key? u2 and @@conversion_map[u2].has_key? u1
+      if @@conversion_map.has_key? u1 and @@conversion_map[u1].has_key? u2
+        return true
+      end
+      if @@conversion_map.has_key? u2 and @@conversion_map[u2].has_key? u1
+        return true unless Proc === @@conversion_map[u2][u1]
+      end
       return false
     end
 
+    #
+    # Clear all defined units.
+    #
     def clear_units
       @@units.clear
       @@dimension_map.clear
@@ -44,15 +72,26 @@ class Measure
       return nil
     end
 
+    #
+    # Returns defined units. If dimension is specified, returning
+    # units are of only the dimension.
+    #
     def units(dimension=nil)
       return @@units.dup if dimension.nil?
       @@dimension_map.select {|k, v| v == dimension }.collect{|k, v| k }
     end
 
+    #
+    # The number of defined units.
+    #
     def num_units
-      return @@units.length
+      return @@units.length + @@alias_map.length
     end
 
+    #
+    # Defines a unit. The default dimension is 1.
+    # Measure::UnitRedefinitionError is raised when the unit is redefined.
+    #
     def define_unit(unit, dimension=1)
       if @@units.include?(unit)
         if self.dimension(unit) != dimension
@@ -61,42 +100,64 @@ class Measure
       else
         @@units << unit
         @@dimension_map[unit] = dimension
+        return self
       end
     end
 
+    alias def_unit define_unit
+
+    #
+    # Defines an alias.
+    # Measure::UnitRedefinitionError is raised when the alias is redefined.
+    # Measure::InvalidUnitError is raised when the base unit is not defined.
+    #
     def define_alias(unit, base)
-      if self.defined?(unit)
+      if self.has_unit?(unit)
         raise UnitRedefinitionError, "unit [#{unit}] is already defined"
       end
-      raise InvalidUnitError, "unknown unit: #{base}" unless self.defined? base
-      @@alias_map[unit] = base
+      @@alias_map[unit] = resolve_alias base
     end
 
-    def define_conversion(base, conversion)
-      base = resolve_alias base
-      raise InvalidUnitError, "unknown unit: #{base}" unless self.defined? base
-      @@conversion_map[base] ||= {}
-      conversion.each {|unit, factor|
-        unit = resolve_alias unit
-        raise InvalidUnitError, "unknown unit: #{unit}" unless self.defined? unit
-        @@conversion_map[base][unit] = factor
+    alias def_alias define_alias
+
+    #
+    # Defines conversions.
+    # 
+    #
+    def define_conversion(origin, conversion)
+      origin = resolve_alias origin
+      @@conversion_map[origin] ||= {}
+      conversion.each {|target, conv|
+        target = resolve_alias target
+        @@conversion_map[origin][target] = conv
       }
       return nil
     end
 
-    def dimension(unit)
-      return @@dimension_map[resolve_alias unit]
+    alias def_conversion define_conversion
+
+    def undefine_unit(unit)
+      if @@units.include? unit
+        @@conversion_map.delete unit
+        @@conversion_map.each {|k, v| v.delete unit }
+        @@units.delete unit
+        return true
+      elsif @@alias_map.has_key? unit
+        @@alias_map.delete unit
+        return true
+      end
+      return false
     end
-    alias dim dimension
 
-    def resolve_alias(unit)
-      while @@alias_map.has_key? unit
-        unit = @@alias_map[unit]
-      end
-      return unit
+    #
+    # 
+    #
+    def dimension(unit)
+      return @@dimension_map[resolve_alias(unit)]
     end
+    alias dim dimension
 
-    def find_multi_hop_conversion(u1, u2)
+    def find_conversion_route(u1, u2)
       visited = []
       queue = [[u1]]
       while route = queue.shift
@@ -108,6 +169,7 @@ class Measure
       end
       return nil
     end
+    alias find_multi_hop_conversion find_conversion_route
 
 #     def encode_dimension(dim)
 #       case dim
@@ -127,10 +189,9 @@ class Measure
 
     def neighbors(unit)
       res = []
-      if @@conversion_map.has_key?(unit)
-        res += @@conversion_map[unit].keys
-      end
-      @@conversion_map.each {|k, v| res << k if v.has_key? unit }
+      res += @@conversion_map[unit].keys if @@conversion_map.has_key?(unit)
+      @@conversion_map.each {|k, v|
+        res << k if v.has_key? unit and not Proc === v[unit] }
       return res
     end
   end # class << self
@@ -174,9 +235,9 @@ class Measure
 
   def ==(other)
     return self.value == other.value if self.unit == other.unit
-    if Measure.compatible? self.unit, other.unit
+    if Measure.direct_compatible? self.unit, other.unit
       return self == other.convert(self.unit)
-    elsif Measure.compatible? other.unit, self.unit
+    elsif Measure.direct_compatible? other.unit, self.unit
       return self.convert(other.unit) == other
     else
       return false
@@ -226,8 +287,9 @@ class Measure
   def *(other)
     case other
     when Measure
-      # TODO: dimension
       return other * self.value if self.unit == 1
+      return Measure(self.value * other.value, self.unit) if other.unit == 1
+      # TODO: dimension
       raise NotImplementedError, "this feature has not implemented yet"
 #       if self.unit == other.unit
 #         return Measure(self.value * other.value, self.unit)
@@ -281,14 +343,6 @@ class Measure
     return "#{self.value} [#{self.unit}]"
   end
 
-  def to_i
-    return self.value.to_i
-  end
-
-  def to_f
-    return self.value.to_f
-  end
-
   def to_a
     return [self.value, self.unit]
   end
@@ -296,12 +350,18 @@ class Measure
   def convert(unit)
     return self if unit == self.unit
     to_unit = Measure.resolve_alias unit
-    raise InvalidUnitError, "unknown unit: #{unit}" unless Measure.defined? unit
+    raise InvalidUnitError, "unknown unit: #{unit}" unless Measure.has_unit? unit
     from_unit = Measure.resolve_alias self.unit
-    if Measure.compatible? from_unit, to_unit
+    if Measure.direct_compatible? from_unit, to_unit
       # direct conversion
       if @@conversion_map.has_key? from_unit and @@conversion_map[from_unit].has_key? to_unit
-        value = self.value * @@conversion_map[from_unit][to_unit]
+        conv = @@conversion_map[from_unit][to_unit]
+        case conv
+        when Proc
+          value = conv[self.value]
+        else
+          value = self.value * conv
+        end
       else
         value = self.value / @@conversion_map[to_unit][from_unit].to_f
       end
@@ -310,7 +370,13 @@ class Measure
       value = self.value
       while u2 = route.shift
         if @@conversion_map.has_key? u1 and @@conversion_map[u1].has_key? u2
-          value *= @@conversion_map[u1][u2]
+          conv = @@conversion_map[u1][u2]
+          case conv
+          when Proc
+            value = conv[vaule]
+          else
+            value *= conv
+          end
         else
           value /= @@conversion_map[u2][u1].to_f
         end