ruby-si-units 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f466356845980e98060a4f9570ff9b06f8dad80
-  data.tar.gz: 8a30b37d30f7f7ec6194b5c51539538b82d4eff3
+  metadata.gz: 86b3b3a059205dfbff5012f1a149d91fee0a7b8f
+  data.tar.gz: 6c35073b01b66dff3a23cfd95dcf3af7b88afde2
 SHA512:
-  metadata.gz: b7d9d08987f2e2a58989a4c93049154d7755854a0d7ddd471e973da475dc0fc4b23045a7b28c9fadacfbcf4c8446c9bebddfb32b4640d5acc37a3edb5debd8dc
-  data.tar.gz: f3b4c8c2aecd4a40db6ef7f75a1df804df99ee1326eba977df997e8e6425d47c5b9d9a44a39e0126fd09d5ae5d7d1c30603c7f534b0d1978c3812ed4c91b6c2a
+  metadata.gz: 1c2f66e138184bfa1c1d3494c30734f02964a03b63f056c19240e0acaba046080e9323840737c510184a8c7479931f93f7511af748c8172734b46d28438b1f3b
+  data.tar.gz: d9857e86333565c89cb4245f6bf196b066dd46eaa9f8922b4b466a80823659a293e6449a2cc764b5e140c217c8ffe9b7ea4d168a232f43461d7906957cc33e75

data/Gemfile.lock

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

data/lib/si_units/unit.rb

@@ -1,9 +1,15 @@
+#coding: utf-8
+# = SIUnits
+# A SI prefix unit handling library for ruby
+#
+# @author Kenner Kliemann
+# @see https://github.com/gnomex/ruby-si-units
 module SIUnits
   class Unit
     include Comparable
     attr_reader :unit_value
 
-    #SI Prefix Units
+    # Definition of SI Prefix Units, with name, aliases and scale
     UNITS_DEFINITION = {
       'googol' => [%w{googol},            1e100],
       'yebi'   => [%w{Yi Yebi yebi},      2**80],
@@ -34,18 +40,27 @@ module SIUnits
       'femto'  => [%w{f Femto femto},     1e-15],
       'atto'   => [%w{a Atto atto},       1e-18],
       'zepto'  => [%w{z Zepto zepto},     1e-21],
-      'yocto'  => [%w{y Yocto yocto},     1e-24]
+      'yocto'  => [%w{y Yocto yocto},     1e-24],
+      'zero'   => [%w{zero},                0.0]
     }
 
+    # 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
     end
 
+    # Public call to get a unit best representation
+    # @return String
     def best_scale
       @best_scale ||= best_value_with_scale
     end
 
+    #
     def <=>(comparison)
       UNITS_DEFINITION.find_index(@unit_kind) <=> UNITS_DEFINITION.find_index(comparison.unit_kind)
     end
@@ -61,17 +76,28 @@ module SIUnits
 
     private
 
+    #Logic to convert the absolute value to a best form of representation
     def best_value_with_scale
       aliase, scalar = UNITS_DEFINITION[@unit_kind]
       [(@unit_value / scalar), aliase.first].join
     end
 
+    # Logic to convert a value with scale
+    # @return Float
     def convert_base_prefix_to_value(value, scalar)
       value * scalar
     end
 
+    # The parser
+    # => Finds that the number range is contained
+    # @return String with the name of representation
+    # @raise ArgumentError
     def parse_unit
       case @unit_value
+      when 0 then return "zero"
+      when 1e-24..1e-21 then return "yocto"
+      when 1e-21..1e-18 then return "atto"
+      when 1e-18..1e-15 then return "femto"
       when 1e-15..1e-12 then return "pico"
       when 1e-12..1e-9 then return "nano"
       when 1e-9..1e-6 then return "micro"
@@ -84,10 +110,17 @@ module SIUnits
       when 1e3..1e6 then return "kilo"
       when 1e6..1e9 then return "mega"
       when 1e9..1e12 then return "giga"
-      else raise "Unit out of range"
+      when 1e12..1e15 then return "tera"
+      when 1e15..1e18 then return "peta"
+      when 1e18..1e21 then return "exa"
+      when 1e21..1e24 then return "zetta"
+      else raise ArgumentError, "Unit out of range"
       end
     end
 
+    # Search on DEFINITIONS if the kind is a element
+    # @return Fixnum with scale of prefix
+    # @raise ArgumentError
     def prefix_is_defined?(kind)
       UNITS_DEFINITION.each { |key, value|
         return value.last if value[0].include?(kind)

data/lib/si_units/version.rb

@@ -1,3 +1,4 @@
 module SIUnits
-  VERSION = "0.0.4"
+  # Project Version
+  VERSION = "0.0.5"
 end

data/spec/units/string_spec.rb

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

data/spec/units/unit_spec.rb

@@ -105,23 +105,15 @@ describe "it's a deci " do
 end
 
 describe "it's a const " do
-  xit "max limit" do
-    unit = SIUnits::Unit.new((1e-1) + 0.1)
-    expect(unit.best_scale).to match(/const/)
-  end
-
-  xit "zero" do
-
-  end
 
-  xit "min limit" do
-    unit = SIUnits::Unit.new(1e1)
-    expect(unit.best_scale).to match(/cost/)
+  it "zero" do
+    unit = SIUnits::Unit.new(0)
+    expect(unit.best_scale).to match(/zero/)
   end
 
-  xit "not a const" do
-    unit = SIUnits::Unit.new((1e-2) + 0.00000000001)
-    expect(unit.best_scale).to_not match(/const/)
+  it "not a zero" do
+    unit = SIUnits::Unit.new(0.1)
+    expect(unit.best_scale).to_not match(/zero/)
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-si-units
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Kenner Kliemann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ files:
 - lib/unit.rb
 - ruby-si-unit.gemspec
 - spec/spec_helper.rb
-- spec/support/units_shared_example.rb
+- spec/units/string_spec.rb
 - spec/units/unit_spec.rb
 homepage: https://github.com/gnomex/ruby-si-units
 licenses:
@@ -128,5 +128,5 @@ specification_version: 4
 summary: A SI prefix unit handling library for ruby
 test_files:
 - spec/spec_helper.rb
-- spec/support/units_shared_example.rb
+- spec/units/string_spec.rb
 - spec/units/unit_spec.rb

data/spec/support/units_shared_example.rb

@@ -1,17 +0,0 @@
-# coding: utf-8
-require 'spec_helper'
-
-shared_examples_for "is unit of" do |unit, expected_prefix|
-
-  it "is max limit on range" do
-    expect(:unit.to_s).to eql(expected_prefix)
-  end
-
-  it "is min limit on range" do
-    expect(:unit.to_s).to eql(expected_prefix)
-  end
-
-  it "out of unit range" do
-    expect(:unit.to_s).to_not eql(expected_prefix)
-  end
-end