ruby-units 1.4.0 → 1.4.1

data/CHANGELOG.txt

@@ -1,5 +1,9 @@
 Change Log for Ruby-units
 =========================
+2012-05-13  1.4.1   * Fix issue #40 -- Unit parsing truncates invalid portions of the unit
+                    * Fix issue #41 -- initializing with a nil gives unexpected result
+2012-02-01          * Fix issue #34 -- Time.at takes more than one parameter
+                    * Fix issue #35 -- 'pt' is ambiguous
 2012-01-02  1.4.0   * Fix some definitions that were just wrong (amu, dalton)
                     * Definition uses name of unit if no aliases provided
                     * Refactor definition process.  New units are immediately available

data/README.md

@@ -1,5 +1,7 @@
 # Ruby Units
 
+[![Dependency Status](https://gemnasium.com/olbrich/ruby-units.png)](https://gemnasium.com/olbrich/ruby-units)
+
 Kevin C. Olbrich, Ph.D. 
 
 [Sciwerks.com](http://www.sciwerks.com)
@@ -146,7 +148,7 @@ Conversions are probably better done like this...
     
     Unit('0 tempC') + Unit('100 degC') #=> Unit('100 tempC')
 
-## Defininig Units
+## Defining Units
 
 It is possible to define new units or redefine existing ones.
 

data/RakeFile

@@ -41,16 +41,6 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-begin
-  require 'rcov/rcovtask'
-  desc "Generate code coverage"
-  Rcov::RcovTask.new do |t|
-    t.test_files = FileList['test/test*.rb']
-    #t.verbose = true     # uncomment to see the executed command
-  end
-rescue LoadError
-end
-
 begin
   require 'simplecov'
   desc "code coverage report using simplecov (ruby 1.9+)"
@@ -79,41 +69,23 @@ begin
 rescue LoadError
 end
 
-
-desc "Run unit tests"
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb']
-end
-
 task :specs => :spec
 
-desc "Run tests against several ruby versions, requires rvm"
-task :multitest do
-  rubies = %w{
-      ruby-1.8.7-p352@ruby-units
-      ruby-1.8.7-p352@ruby-units-with-chronic
-      ruby-1.9.2-p290@ruby-units
-      ruby-1.9.2-p290@ruby-units-with-chronic
-      rbx-head@ruby-units
-      jruby-1.6.5@ruby-units
-      }
-  exec "rvm #{rubies.join(',')} do rake tests"
+rubies = {
+      "ruby-1.8.7" => %w{ruby-1.8.7-p357@ruby-units ruby-1.8.7-p357@ruby-units-with-chronic},
+      "ruby-1.9.2" => %w{ruby-1.9.2-p290@ruby-units ruby-1.9.2-p290@ruby-units-with-chronic},
+      "rbx"        => %w{rbx-head@ruby-units},
+      "jruby"      => %w{jruby-1.6.7@ruby-units}
+    }
+
+rubies.each do |name, ruby|
+  desc "Run Spec against #{name}"
+  task "spec:#{name}" do
+    sh "rvm #{ruby.join(',')} do rake spec"
+  end
 end
 
 desc "Run specs against several ruby versions, requires rvm"
-task :multispec do
-  rubies = %w{
-      ruby-1.8.7-p352@ruby-units
-      ruby-1.8.7-p352@ruby-units-with-chronic
-      ruby-1.9.2-p290@ruby-units
-      ruby-1.9.2-p290@ruby-units-with-chronic
-      rbx-head@ruby-units
-      jruby-1.6.5@ruby-units
-      }
-  exec "rvm #{rubies.join(',')} do rake spec"
-end
-
-task :default => :test
+task "spec:all" => rubies.keys.map {|name| "spec:#{name}"}
 
-task :tests => :test
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.1

data/lib/ruby_units/time.rb

@@ -11,13 +11,15 @@ class Time
   
   # Convert a duration to a Time value by considering the duration to be the number of seconds since the 
   # epoch
+  # @param [Time] arg
+  # @param [Integer] ms
   # @return [Unit, Time]
-  def self.at(arg)
+  def self.at(arg,ms=0)
     case arg
     when Unit
-      unit_time_at(arg.convert_to("s").scalar)
+      unit_time_at(arg.convert_to("s").scalar, ms)
     else
-      unit_time_at(arg)
+      unit_time_at(arg, ms)
     end
   end
   

data/lib/ruby_units/unit.rb

@@ -314,6 +314,7 @@ class Unit < Numeric
     @unit_name   = nil
     @signature   = nil
     @output      = {}
+    raise ArgumentError, "Invalid Unit Format" if options[0].nil?
     if options.size == 2
       # options[0] is the scalar
       # options[1] is a unit string
@@ -427,10 +428,6 @@ class Unit < Numeric
   # @return [Boolean]
   def is_base?
     return @is_base if defined? @is_base
-    # return @is_base = true if self.degree? && 
-    #                           self.numerator.size == 1 && 
-    #                           self.denominator == UNITY_ARRAY && 
-    #                           self.units =~ /(?:deg|temp)K/
     @is_base = (@numerator + @denominator).compact.uniq.
                                             map {|unit| Unit.definition(unit)}.
                                             all? {|element| element.unity? || element.base? }
@@ -1436,6 +1433,7 @@ class Unit < Numeric
       return
     end
 
+    # more than one per.  I.e., "1 m/s/s"
     raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") if unit_string.count('/') > 1
     raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") if unit_string.scan(/\s[02-9]/).size > 0
     @scalar, top, bottom = unit_string.scan(UNIT_STRING_REGEX)[0]  #parse the string into parts
@@ -1459,8 +1457,10 @@ class Unit < Numeric
     @numerator = top.scan(Unit.unit_match_regex).delete_if {|x| x.empty?}.compact if top
     @denominator = bottom.scan(Unit.unit_match_regex).delete_if {|x| x.empty?}.compact if bottom
 
-    us = "#{(top || '' + bottom || '')}".to_s.gsub(Unit.unit_match_regex,'').gsub(/[\d\*, "'_^\/\$]/,'')
-    raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") unless us.empty?
+    # eliminate all known terms from this string.  This is a quick check to see if the passed unit
+    # contains terms that are not defined.
+    used = "#{top} #{bottom}".to_s.gsub(Unit.unit_match_regex,'').gsub(/[\d\*, "'_^\/\$]/,'')
+    raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") unless used.empty?
 
     @numerator = @numerator.map do |item|
        @@PREFIX_MAP[item[0]] ? [@@PREFIX_MAP[item[0]], @@UNIT_MAP[item[1]]] : [@@UNIT_MAP[item[1]]]

data/lib/ruby_units/unit_definitions/standard.rb

@@ -71,11 +71,11 @@ end
 
 Unit.define('point') do |point|
   point.definition = Unit('1/72 ft')
-  point.aliases    = %w{pt point points}
+  point.aliases    = %w{point points}
 end
 
 Unit.define('pica') do |pica|
-  pica.definition = Unit('12 pt')
+  pica.definition = Unit('12 point')
   pica.aliases    = %w{P pica picas}
 end
 

data/ruby-units.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby-units"
-  s.version = "1.4.0"
+  s.version = "1.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Olbrich, Ph.D."]
-  s.date = "2012-01-02"
+  s.date = "2012-05-13"
   s.description = "Provides classes and methods to perform unit math and conversions"
   s.email = ["kevin.olbrich+ruby_units@gmail.com"]
   s.extra_rdoc_files = [
@@ -35,7 +35,6 @@ Gem::Specification.new do |s|
     "lib/ruby_units/numeric.rb",
     "lib/ruby_units/object.rb",
     "lib/ruby_units/string.rb",
-    "lib/ruby_units/string/extra.rb",
     "lib/ruby_units/time.rb",
     "lib/ruby_units/unit.rb",
     "lib/ruby_units/unit_definitions.rb",
@@ -49,7 +48,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.post_install_message = "====================\nDeprecation Warning\n====================\n\nSeveral convenience methods that ruby-units added to the string class have\nbeen deprecated in this release.  These methods include String#to, String#from, String#ago, String#before and others.\nIf your code relies on these functions, they can be added back by adding this line to your code.\n\nrequire 'ruby-units/string/extras'\n# note that these methods do not play well with Rails, which is one of the reasons they are being removed.\n\nThe extra functions mostly work the same, but will no longer properly handle cases when they are called with strings..\n\n'min'.from(\"4-1-2011\") # => Exception\n\nPass in a Date, Time, or DateTime object to get the expected result.\n\nThey will go away completely in the next release, so it would be a good idea to refactor your code\nto avoid using them.  They will also throw deprecation warnings when they are used.\n"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "A class that performs unit conversions and unit math"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-units
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157320760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2157320760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2157320240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157320240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2157319660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157319660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-html
-  requirement: &2157319100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157319100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157318340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157318340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157317580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *2157317580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &2157316680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157316680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &2157316020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157316020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: autotest-fsevent
-  requirement: &2157315280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157315280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides classes and methods to perform unit math and conversions
 email:
 - kevin.olbrich+ruby_units@gmail.com
@@ -137,7 +182,6 @@ files:
 - lib/ruby_units/numeric.rb
 - lib/ruby_units/object.rb
 - lib/ruby_units/string.rb
-- lib/ruby_units/string/extra.rb
 - lib/ruby_units/time.rb
 - lib/ruby_units/unit.rb
 - lib/ruby_units/unit_definitions.rb
@@ -204,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A class that performs unit conversions and unit math

data/lib/ruby_units/string/extra.rb

@@ -1,166 +0,0 @@
-require 'time'
-
-#
-# String Extras
-# 
-# These are some extra string syntax sugar methods.  In some cases they conflict with methods defined in other 
-# gems (notably with Rails).  I could make them more compatilble, but honestly they should not be here in the first place.
-#
-# in most cases it is better to do something like
-#
-# @example 
-#   Unit("1 m").convert_to("ft")
-#   instead of
-#   "1 m".convert_to("ft")
-#
-# to use these methods:
-# require 'ruby-units/string/extra'
-class String
-  
-  #needed for compatibility with Rails, which defines a String.from method  
-  if self.public_instance_methods.include? 'from'
-    alias :old_from :from
-  end 
-  
-  # @example 
-  #   "5 min".from("now")
-  # @param [Time] time_point
-  # @return (see Unit#from)
-  # @deprecated
-  def from(time_point = ::Time.now)
-    return old_from(time_point) if self.respond_to?(:old_from) && time_point.instance_of?(Integer)
-    warn Kernel.caller.first + " called ruby-units/string#from, which is deprecated.  Use Unit(string).from(string) instead"
-    self.unit.from(time_point)
-  end
-  
-  alias :after :from
-
-  # @example 
-  #   "5 min".from_now
-  # @return (see Unit#from)
-  # @deprecated
-  def from_now
-    warn Kernel.caller.first + " called ruby-units/string#from_now, which is deprecated.  Use Unit(string).from(Time.now) instead"
-    self.from(Time.now)
-  end
-  
-  # @example 
-  #  "5 min".ago
-  # @return (see Unit#ago)
-  # @deprecated
-  def ago
-    warn Kernel.caller.first + " called ruby-units/string#ago, which is deprecated.  Use Unit(string).ago instead"
-    self.unit.ago
-  end
-  
-  # @example 
-  #  "5 min".before("now")
-  # @param [Time] time_point
-  # @return (see Unit#before)
-  # @deprecated
-  def before(time_point = ::Time.now)
-    warn Kernel.caller.first + " called ruby-units/string#before, which is deprecated.  Use Unit(string).before(Time.now) instead"
-    self.unit.before(time_point)
-  end
-
-  # @example 
-  #  "5 min".before_now
-  # @return (see Unit#before)
-  # @deprecated
-  def before_now
-    warn Kernel.caller.first + " called ruby-units/string#before_now, which is deprecated.  Use Unit(string).before(Time.now) instead"
-    self.before(Time.now)
-  end
-  
-  # @return (see Unit#since)
-  # @deprecated
-  def since(time_point = ::Time.now)
-    warn Kernel.caller.first + " called ruby-units/string#since, which is deprecated.  Use Unit(string).since(Time.now) instead"
-    self.unit.since(time_point)
-  end
-  
-  # @return (see Unit#until)
-  # @deprecated
-  def until(time_point = ::Time.now)
-    warn Kernel.caller.first + " called ruby-units/string#until, which is deprecated.  Use Unit(string).until(Time.now) instead"
-    self.unit.until(time_point)
-  end
-  
-  unless String.instance_methods.include?(:to)
-    # @deprecated
-    # @return (see #convert_to)
-    def to(other)
-      warn "string.to is deprecated, use string.convert_to if you must, but the best would be Unit('unit').convert_to('target unit')"
-      convert_to(other)
-    end
-  end
-  
-  # @deprecated
-  # @return (see #to_time)
-  def time(options = {})
-    self.to_time(options) rescue self.to_datetime(options)
-  end
-  
-  # @deprecated
-  # @return [Time]
-  def to_time(options = {})
-    begin
-      #raises exception when Chronic not defined or when it returns a nil (i.e., can't parse the input)
-      r = Chronic.parse(self,options)
-      raise(ArgumentError, 'Invalid Time String') unless r
-      return r
-    rescue 
-      case
-      when self == "now"
-        Time.now
-      when Time.respond_to?(:parse)
-        Time.parse(self)
-      else
-        Time.local(*ParseDate.parsedate(self))
-      end
-    end
-  end
-  
-  # @deprecated
-  # @return [DateTime]
-  def to_datetime(options = {})
-    begin
-      # raises an exception if Chronic.parse = nil or if Chronic not defined
-      r = Chronic.parse(self,options).send(:to_datetime)
-    rescue NameError  => e
-      r = case
-      when self.to_s == "now"
-        DateTime.now
-      else
-        DateTime.parse(self)
-      end
-    end
-    raise RuntimeError, "Invalid Time String (#{self.to_s})" if r == DateTime.new      
-    return r
-  end
-  
-  # @deprecated
-  # @return [Date]
-  def to_date(options={})
-    begin
-      r = Chronic.parse(self,options).to_date
-    rescue
-      r = case
-      when self == "today" 
-        Date.today
-      when RUBY_VERSION < "1.9"
-        Date.civil(*ParseDate.parsedate(self)[0..5].compact)
-      else
-        Date.parse(self)
-      end
-    end
-    raise RuntimeError, 'Invalid Date String' if r == Date.new
-    return r
-  end
-  
-  # @deprecated
-  # @return (see #to_datetime)
-  def datetime(options = {})
-    self.to_datetime(options) rescue self.to_time(options)
-  end
-end