ruby-si-units 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ba7d0ae38d0154cb299425afbccd647328cf656
-  data.tar.gz: 6c8a39d238e7cd97ad45657b4589d545994225b7
+  metadata.gz: efa72132c423b8eeebd9edfb7be550c997713b49
+  data.tar.gz: 7efa33641c700b3a2af0bc5d2665e30617e19274
 SHA512:
-  metadata.gz: 07ee599f83021b50b69f12fd4c25c311282e15a3436a123b28658c847a054dfce24e04757be0fa951e3a80fa2afef45a25c9e0ebf027c33dd782b1ea2d723bd7
-  data.tar.gz: ca977de578fd5653e276de3e03800b567c10f9c59a2469e3e9e6a87b5a7c484bfd73ef35bc07ce118a50c7bc24a77f4d196acd7bbe37be039ed773562370595e
+  metadata.gz: af000424f61537a2c24d6bb758ba2f7de023b4e59aa40ff16e95b4b642c377f9de52c94db2271a669e2235ad2e86eb3b929a44724313bfcef9d945f04d7d7ea6
+  data.tar.gz: e655905b2637defa6103898bbcc7c6773bc6ef09fd400274c03001559105c43e91674c1eb813cf6ca844f1c2ad6424ace13e82ea7013bd4a16983ade4cdabbaf

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-si-units (0.0.6)
+    ruby-si-units (0.0.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -28,14 +28,14 @@ Or install it yourself:
 ### Convert absolute value to a unit with prefix SI notation
 
 ```ruby
-unit = SIUnits::Unit.new(10000000)
+unit = SIUnits::Unit.new 10000000
 # => #<SIUnits::Unit:0x0000000283b8a8 @unit_value=10000000, @unit_kind="mega">
 unit.best_scale
 # => "10.0M"
 ```
 
 ```ruby
-unit = SIUnits::Unit.new(0.000000001)
+unit = SIUnits::Unit.new 0.000000001
 # => #<SIUnits::Unit:0x0000000272bb20 @unit_value=1.0e-09, @unit_kind="nano">
 unit.best_scale
 # => "1.0n"
@@ -50,6 +50,26 @@ unit.best_scale
 # => #<SIUnits::Unit:0x000000017406e8 @unit_value=1.0e-09, @unit_kind="nano">
 ```
 
+### Compare units
+
+
+```ruby
+a = SIUnits::Unit.new 10000000
+# => #<SIUnits::Unit:0x0000000283b8a8 @unit_value=10000000, @unit_kind="mega">
+
+b = SIUnits::Unit.new 0.000000001
+# => #<SIUnits::Unit:0x0000000272bb20 @unit_value=1.0e-09, @unit_kind="nano">
+
+a > b
+ => true
+a < b
+ => false
+a <=> b
+ => 1
+a == b
+ => false
+```
+
 ## Contributing
 
 1. Fork it

data/lib/si_units/string.rb

@@ -3,7 +3,7 @@ class String
   # @return (see RubyUnits::Unit#initialize)
   def to_unit
     unit_reduced, prefix = *split_value(self)
-    SIUnits::Unit.new(unit_reduced.to_f).convert_to(prefix)
+    SIUnits::Unit.new(unit_reduced).convert_to(prefix)
   end
 
   def split_value(value)

data/lib/si_units/unit.rb

@@ -7,7 +7,8 @@
 module SIUnits
   class Unit
     include Comparable
-    attr_reader :unit_value
+
+    attr_reader :unit_value, :unit_kind
 
     # Definition of SI Prefix Units, with name, aliases and scale
     UNITS_DEFINITION = {
@@ -43,52 +44,77 @@ module SIUnits
       'yocto'  => [%w{y Yocto yocto},     1e-24],
       'zero'   => [%w{zero},                0.0]
     }
+    UNIT_REGEX = /(\d+\.?\d*)(\w+)/
+
+    # Create a new Unit object.
+    # @return [Unit]
+    # @raise [ArgumentError] if absolute value of a temperature is less than absolute zero
+    # @raise [ArgumentError] if no unit is specified
+    # @raise [ArgumentError] if an invalid unit is specified
+    def initialize(*options)
+
+      raise ArgumentError, "Unit can't be initialized without args" if options[0].nil?
+
+      case options[0]
+      when Numeric
+        # Conversion use a scale
+        @unit_value = options.first
+        @unit_kind = parse_unit
+
+      when String
+        value, prefix = *split_value(options[0])
+        @unit_kind = who_is_my_prefix?(prefix)
+        # Value is absolute, needs convert to scale of prefix
+        @unit_value = value.to_f * unit_scale
 
-    # Create a unit object
-    # Can be initialized with a number
-    # initialize a unit and parse, recognizing the scale of number
-    # @param [Fixnum|Float]
-    # @return Unit
-    def initialize(unit)
-      @unit_value = unit
-      @unit_kind = parse_unit
+      else
+        raise ArgumentError, "Invalid Unit Format"
+      end
     end
 
     # Public call to get a unit best representation
     # @return String
     def best_scale
-      @best_scale ||= best_value_with_scale
+       @best_scale ||= best_value_with_scale
     end
 
-    #
+    # Comparable units
+    # => Compare with scale of kinds
     def <=>(comparison)
-      UNITS_DEFINITION.find_index(@unit_kind) <=> UNITS_DEFINITION.find_index(comparison.unit_kind)
+      UNITS_DEFINITION[unit_kind].last <=> UNITS_DEFINITION[comparison.unit_kind].last
+    end
+
+    def ==(comparison)
+      unit_kind == comparison.unit_kind
     end
 
-    # convert to a specified unit string or to the same units as another Unit
-    def convert_to(prefix)
-      return self if prefix.nil?
-      scalar = prefix_is_defined?(prefix)
-      absolute_unit_value = convert_base_prefix_to_value self.unit_value, scalar
+    # convert to a specified unit string or to the same unit as another Unit
+    def convert_to(other)
+      return self if other.nil?
 
-      SIUnits::Unit.new(absolute_unit_value)
+      case other
+        when Unit
+          return self if other == self
+          target = other
+        when String
+          target = SIUnits::Unit.new(other.to_f)
+        else
+          raise ArgumentError, "Unknown target units"
+      end
     end
 
-    private
+    alias :>> :convert_to
 
-    # Logic to convert the absolute value to a best form of representation
-    # Only aliase if scalar is zero!
-    # => Don't raise a ZeroDivisionError, the zero is defined
-    def best_value_with_scale
-      aliase, scalar = UNITS_DEFINITION[@unit_kind]
-      return aliase.first if scalar == 0
-      [(@unit_value / scalar), aliase.first].join
+    def to_s
+      [best_scale, unit_kind].join(' ')
     end
 
-    # Logic to convert a value with scale
-    # @return Float
-    def convert_base_prefix_to_value(value, scalar)
-      value * scalar
+    private
+
+    # Logic to convert the current unit value to a best form of representation
+    # == Just remove the "e base" from value
+    def best_value_with_scale
+      (unit_value / unit_scale).round(4)
     end
 
     # The parser
@@ -121,14 +147,19 @@ module SIUnits
       end
     end
 
-    # Search on DEFINITIONS if the kind is a element
-    # @return Fixnum with scale of prefix
-    # @raise ArgumentError
-    def prefix_is_defined?(kind)
+    def who_is_my_prefix?(prefix)
       UNITS_DEFINITION.each { |key, value|
-        return value.last if value[0].include?(kind)
+        return key if value[0].include?(prefix)
       }
       raise ArgumentError, "Unknown prefix"
     end
+
+    def unit_scale
+      @unit_scale ||= UNITS_DEFINITION[unit_kind].last
+    end
+
+    def split_value(value)
+      value.scan(UNIT_REGEX).flatten
+    end
   end
 end

data/lib/si_units/version.rb

@@ -1,4 +1,4 @@
 module SIUnits
   # Project Version
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/units/unit_spec.rb

@@ -2,202 +2,49 @@
 require 'spec_helper'
 require "unit"
 
-describe "it's a pico " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e-15) + 0.0000000000001)
-    expect(unit.best_scale).to match(/[p]/)
-  end
-
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e-12)
-    expect(unit.best_scale).to match(/[p]/)
-  end
+describe SIUnits::Unit do
 
-  it "not a pico" do
-    unit = SIUnits::Unit.new((1e-12) + 0.0000000000001)
-    expect(unit.best_scale).to_not match(/[p]/)
-  end
-end
-
-describe "it's a nano " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e-12) + 0.00000000001)
-    expect(unit.best_scale).to match(/[n]/)
-  end
+  context "it's a pico " do
 
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e-9)
-    expect(unit.best_scale).to match(/[n]/)
   end
 
-  it "not a nano" do
-    unit = SIUnits::Unit.new((1e-9) + 0.00000000001)
-    expect(unit.best_scale).to_not match(/[n]/)
-  end
-end
-
-describe "it's a micro " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e-9) + 0.00000000001)
-    expect(unit.best_scale).to match(/[u]/)
-  end
-
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e-6)
-    expect(unit.best_scale).to match(/[u]/)
-  end
+  context "it's a nano " do
 
-  it "not a micro" do
-    unit = SIUnits::Unit.new((1e-6) + 0.000001)
-    expect(unit.best_scale).to_not match(/[u]/)
   end
-end
 
-describe "it's a milli " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e-6) + 0.000001)
-    expect(unit.best_scale).to match(/[m]/)
-  end
+  context "it's a micro " do
 
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e-3)
-    expect(unit.best_scale).to match(/[m]/)
   end
 
-  it "not a milli" do
-    unit = SIUnits::Unit.new((1e-3) + 0.001)
-    expect(unit.best_scale).to_not match(/[m]/)
-  end
-end
+  context "it's a milli " do
 
-describe "it's a centi " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e-3) + 0.001)
-    expect(unit.best_scale).to match(/[c]/)
   end
 
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e-2)
-    expect(unit.best_scale).to match(/[c]/)
-  end
+  context "it's a const " do
 
-  it "not a centi" do
-    unit = SIUnits::Unit.new((1e-2) + 0.001)
-    expect(unit.best_scale).to_not match(/[c]/)
   end
-end
 
-describe "it's a deci " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e-2) + 0.01)
-    expect(unit.best_scale).to match(/[d]/)
+  context "it's a kilo " do
   end
 
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e-1)
-    expect(unit.best_scale).to match(/[d]/)
-  end
+  context "it's a mega " do
 
-  it "not a deci" do
-    unit = SIUnits::Unit.new((1e-1) + 0.01)
-    expect(unit.best_scale).to_not match(/[d]/)
   end
-end
-
-describe "it's a const " do
 
-  it "zero" do
-    unit = SIUnits::Unit.new(0)
-    expect(unit.best_scale).to match(/zero/)
-  end
+  context "it's a giga " do
 
-  it "not a zero" do
-    unit = SIUnits::Unit.new(0.1)
-    expect(unit.best_scale).to_not match(/zero/)
   end
-end
 
-describe "it's a deca " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e2) - 1.0)
-    expect(unit.best_scale).to match(/(da)/)
+  context "Its comparable" do
+    it "Compare with"
   end
 
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e1 + 1.0)
-    expect(unit.best_scale).to match(/(da)/)
+  context "Convert to" do
+    it "Convert to"
   end
 
-  it "not a deca" do
-    unit = SIUnits::Unit.new((1e1) - 1.0)
-    expect(unit.best_scale).to_not match(/da/)
+  context "Convert string to unit" do
+    it "string to unit"
   end
-end
 
-describe "it's a hecto " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e3) - 1.0)
-    expect(unit.best_scale).to match(/[h]/)
-  end
-
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e2 + 1.0)
-    expect(unit.best_scale).to match(/[h]/)
-  end
-
-  it "not a deca" do
-    unit = SIUnits::Unit.new((1e2) - 1.0)
-    expect(unit.best_scale).to_not match(/[h]/)
-  end
-end
-
-describe "it's a kilo " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e6) - 1.0)
-    expect(unit.best_scale).to match(/[k]/)
-  end
-
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e3 + 1.0)
-    expect(unit.best_scale).to match(/[k]/)
-  end
-
-  it "not a deca" do
-    unit = SIUnits::Unit.new((1e3) - 1.0)
-    expect(unit.best_scale).to_not match(/[k]/)
-  end
-end
-
-describe "it's a mega " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e9) - 1.0)
-    expect(unit.best_scale).to match(/[M]/)
-  end
-
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e6 + 1.0)
-    expect(unit.best_scale).to match(/[M]/)
-  end
-
-  it "not a deca" do
-    unit = SIUnits::Unit.new((1e6) - 1.0)
-    expect(unit.best_scale).to_not match(/[M]/)
-  end
-end
-
-describe "it's a giga " do
-  it "max limit" do
-    unit = SIUnits::Unit.new((1e12) - 1.0)
-    expect(unit.best_scale).to match(/[G]/)
-  end
-
-  it "min limit" do
-    unit = SIUnits::Unit.new(1e9 + 1.0)
-    expect(unit.best_scale).to match(/[G]/)
-  end
-
-  it "not a deca" do
-    unit = SIUnits::Unit.new((1e9) - 1.0)
-    expect(unit.best_scale).to_not match(/[G]/)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-si-units
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Kenner Kliemann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,6 @@ files:
 - lib/unit.rb
 - ruby-si-unit.gemspec
 - spec/spec_helper.rb
-- spec/units/string_spec.rb
 - spec/units/unit_spec.rb
 homepage: https://github.com/gnomex/ruby-si-units
 licenses:
@@ -122,11 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.1
 signing_key: 
 specification_version: 4
 summary: A SI prefix unit handling library for ruby
 test_files:
 - spec/spec_helper.rb
-- spec/units/string_spec.rb
 - spec/units/unit_spec.rb

data/spec/units/string_spec.rb

@@ -1,3 +0,0 @@
-# coding: utf-8
-require 'spec_helper'
-require "unit"