ruby-si-units 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dd9d5852f10c0121151f8beff6f4901a5b9a1d3
-  data.tar.gz: abbf844f0f8bc8aa84dcaec4da99233371793d46
+  metadata.gz: 5f466356845980e98060a4f9570ff9b06f8dad80
+  data.tar.gz: 8a30b37d30f7f7ec6194b5c51539538b82d4eff3
 SHA512:
-  metadata.gz: 0313e3edf342fdb8ec05b7de112f000db5efdfcf93458ef7c2cd3761f8913512398efaf18f474401cddaec493449b1c037eb49c8ca062e54848d5f041adb4670
-  data.tar.gz: 42cd297fbae6c77c2ce0de86c9f584344fd278c1b1033ec46298021724ada10dc24d24231cee39b99923e367a0aca44fe49330c1d06f42a74ec4e6a34662f81b
+  metadata.gz: b7d9d08987f2e2a58989a4c93049154d7755854a0d7ddd471e973da475dc0fc4b23045a7b28c9fadacfbcf4c8446c9bebddfb32b4640d5acc37a3edb5debd8dc
+  data.tar.gz: f3b4c8c2aecd4a40db6ef7f75a1df804df99ee1326eba977df997e8e6425d47c5b9d9a44a39e0126fd09d5ae5d7d1c30603c7f534b0d1978c3812ed4c91b6c2a

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: bundle exec rspec spec
+rvm:
+- 2.0.0
+- 1.9.3
+notifications:
+  email: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-si-units (0.0.1)
+    ruby-si-units (0.0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +14,7 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
+    rake (10.1.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -29,6 +30,8 @@ PLATFORMS
 
 DEPENDENCIES
   awesome_print (~> 1.1.0)
+  bundler (~> 1.3.5)
   pry (~> 0.9.12.2)
+  rake (~> 10.1.0)
   rspec (~> 2.14.1)
   ruby-si-units!

data/README.md

@@ -1,14 +1,62 @@
-SI Prefix Units
-====================
+# SI Prefix Units
 	A SI prefix unit handling library for ruby
 
-How it work's ?
-===
+[![Build Status](https://travis-ci.org/gnomex/ruby-si-units.png?branch=master)](https://travis-ci.org/gnomex/ruby-si-units)
+
+## How it work's ?
 <p>
-	Recognizes the scale and unit presets for a unit
+  Makes a parce of an absolute value and identifies the scale of the unit that belongs SI, returning the unit in better representation along with the unit symbol prefixed
 </p>
 
+## Installation
+
+Add in your application's Gemfile:
+
+    `gem "ruby-si-units", "~> 0.0.3"`
+
+And using blunder, execute:
+
+    `$ bundle install`
+
+Or install it yourself:
+
+    `$ gem install ruby-si-units`
+
+
+## Usage
+
+### Convert absolute value to a unit with prefix SI notation
+
+```ruby
+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)
+# => #<SIUnits::Unit:0x0000000272bb20 @unit_value=1.0e-09, @unit_kind="nano">
+unit.best_scale
+# => "1.0n"
+```
+### Convert string to unit
+
+```ruby
+"10.0k".to_unit
+# => #<SIUnits::Unit:0x0000000175da90 @unit_value=10000.0, @unit_kind="kilo">
+
+"1n".to_unit
+# => #<SIUnits::Unit:0x000000017406e8 @unit_value=1.0e-09, @unit_kind="nano">
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
-Another useful resources
-===
-* (ruby-units)[https://github.com/olbrich/ruby-units]
+## Another useful resources
+* [ruby-units](https://github.com/olbrich/ruby-units)

data/lib/si_units/string.rb

@@ -0,0 +1,13 @@
+class String
+  # make a string into a unit
+  # @return (see RubyUnits::Unit#initialize)
+  def to_unit
+    unit_reduced, prefix = *split_value(self)
+    SIUnits::Unit.new(unit_reduced.to_f).convert_to(prefix)
+  end
+
+  def split_value(value)
+    value.scan(/(\d+\.?\d*)(\w+)/).flatten
+  end
+end
+

data/lib/si_units/unit.rb

@@ -24,7 +24,7 @@ module SIUnits
       'kilo'   => [%w{k kilo},            1e3],
       'hecto'  => [%w{h Hecto hecto},     1e2],
       'deca'   => [%w{da Deca deca deka}, 1e1],
-      '1'      => [%w{const},                 1],
+      '1'      => [%w{const},                1],
       'deci'   => [%w{d Deci deci},       1e-1],
       'centi'  => [%w{c Centi centi},     1e-2],
       'milli'  => [%w{m Milli milli},     1e-3],
@@ -50,6 +50,15 @@ module SIUnits
       UNITS_DEFINITION.find_index(@unit_kind) <=> UNITS_DEFINITION.find_index(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
+
+      SIUnits::Unit.new(absolute_unit_value)
+    end
+
     private
 
     def best_value_with_scale
@@ -57,6 +66,10 @@ module SIUnits
       [(@unit_value / scalar), aliase.first].join
     end
 
+    def convert_base_prefix_to_value(value, scalar)
+      value * scalar
+    end
+
     def parse_unit
       case @unit_value
       when 1e-15..1e-12 then return "pico"
@@ -65,8 +78,7 @@ module SIUnits
       when 1e-6..1e-3 then return "milli"
       when 1e-3..1e-2 then return "centi"
       when 1e-2..1e-1 then return "deci"
-      when 1e-1..0e1 then return "1"
-      when 0e1..1e1 then return "1"
+      when 1e-1..1e1 then return "1"
       when 1e1..1e2 then return "deca"
       when 1e2..1e3 then return "hecto"
       when 1e3..1e6 then return "kilo"
@@ -76,5 +88,11 @@ module SIUnits
       end
     end
 
+    def prefix_is_defined?(kind)
+      UNITS_DEFINITION.each { |key, value|
+        return value.last if value[0].include?(kind)
+      }
+      raise ArgumentError, "Unknown prefix"
+    end
   end
 end

data/lib/si_units/version.rb

@@ -1,3 +1,3 @@
 module SIUnits
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/unit.rb

@@ -1,3 +1,3 @@
+require 'si_units/string'
 require 'si_units/unit'
-require 'si_units/distance'
 require 'si_units/version'

data/ruby-si-unit.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/gnomex/ruby-si-units"
   spec.license       = "MIT"
 
+  spec.add_development_dependency("bundler", "~> 1.3.5")
+  spec.add_development_dependency("rake", "~> 10.1.0")
   spec.add_development_dependency("awesome_print", "~> 1.1.0")
   spec.add_development_dependency("pry", "~> 0.9.12.2")
   spec.add_development_dependency("rspec", "~> 2.14.1")

data/spec/spec_helper.rb

@@ -4,6 +4,9 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/units_shared_example.rb

@@ -0,0 +1,17 @@
+# 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

data/spec/units/unit_spec.rb

@@ -1,2 +1,211 @@
 # coding: utf-8
 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
+
+  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
+
+  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
+
+  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
+
+  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
+
+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
+
+  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]/)
+  end
+
+  it "min limit" do
+    unit = SIUnits::Unit.new(1e-1)
+    expect(unit.best_scale).to match(/[d]/)
+  end
+
+  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
+  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/)
+  end
+
+  xit "not a const" do
+    unit = SIUnits::Unit.new((1e-2) + 0.00000000001)
+    expect(unit.best_scale).to_not match(/const/)
+  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)/)
+  end
+
+  it "min limit" do
+    unit = SIUnits::Unit.new(1e1 + 1.0)
+    expect(unit.best_scale).to match(/(da)/)
+  end
+
+  it "not a deca" do
+    unit = SIUnits::Unit.new((1e1) - 1.0)
+    expect(unit.best_scale).to_not match(/da/)
+  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,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ruby-si-units
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kenner Kliemann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -61,16 +89,18 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
-- lib/si_units/distance.rb
+- lib/si_units/string.rb
 - lib/si_units/unit.rb
 - lib/si_units/version.rb
 - lib/unit.rb
 - ruby-si-unit.gemspec
 - spec/spec_helper.rb
+- spec/support/units_shared_example.rb
 - spec/units/unit_spec.rb
 homepage: https://github.com/gnomex/ruby-si-units
 licenses:
@@ -92,10 +122,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 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/unit_spec.rb

data/lib/si_units/distance.rb

@@ -1,33 +0,0 @@
-module SIUnits
-  class Distance
-    include Comparable
-
-    UNIT_REGEX = /(\d+)(\w+)/
-
-    attr_reader :value, :unit, :distance
-
-    def initialize(distance)
-      @distance = distance
-      @value, @unit = *split_value(distance)
-    end
-
-    def <=>(comparison)
-      u1 = Unit.new(@unit)
-      u2 = Unit.new(comparison.unit)
-
-      if u1 > u2
-        return 1
-      elsif u1 < u2
-        return -1
-      elsif u1 == u2
-        @value.to_i <=> comparison.value.to_i
-      end
-    end
-
-    private
-
-    def split_value(value)
-      value.scan(UNIT_REGEX).flatten
-    end
-  end
-end