weight_conversion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07d41f7525499b367a6dda635dc27df551dddc05
+  data.tar.gz: 7421c4f2c701424f9c308153fededad941f35572
+SHA512:
+  metadata.gz: 5c2c723ff471778e0c641c701115653c373d073373a97ebd4b76942ea46a952a895a2d4b4a3ab383d4f58dc17dc93b1fb17b38499ccdc780e05d832be759f67c
+  data.tar.gz: 385a9dffcdb100adf87a635e8da3fe16767860aa41ba6c8b6a88c4b382ca86a567c51669e5a5cb4d53c01972e826aa2fa8177cb2c3f934c7710c06d0903a4371

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - "1.9.2"
+ - "1.9.3"
+ - "2.1.5"
+ - "2.2.3"
+ - rbx
+
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in weight-conversion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# WeightConversion (0.1.0)
+
+* [![Code Climate](https://codeclimate.com/github/pzupan/weight_conversion.png)](https://codeclimate.com/github/pzupan/weight_conversion)
+* [![Build Status](https://api.travis-ci.org/pzupan/weight_conversion.png)](https://travis-ci.org/pzupan/weight_conversion)
+* [![GitHub version](https://badge.fury.io/gh/pzupan%2Fweight_conversion.svg)](https://badge.fury.io/gh/pzupan%2Fweight_conversion)
+
+Weight object for converting from grams, ounces, pounds and kilograms into a common unit.
+
+Based on Anton Shemerey's Weight gem (https://github.com/shemerey/weight)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    $ gem 'weight_conversion'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install weight_conversion
+
+## Usage
+
+### Basic Conversion
+
+```ruby
+ Weight.new(1, :lb).to_kgs # => 0.4536
+ Weight.new(1, :kg).to_mgs # => 1000.0
+ ```
+
+### Basic Math with Weight objects
+
+```ruby
+ Weight.new(1, :kg) + Weight.new(1, :kg) == Weight.new(2, :kg)
+ Weight.new(1, :kg) - Weight.new(1, :kg) == Weight.new(0, :kg)
+
+ Weight.new(1, :kg) * 2 == Weight.new(2, :kg)
+ Weight.new(2, :kg) / 2 == Weight.new(1, :kg)
+```
+
+#### Convert result to the first object unit system
+
+```ruby
+ Weight.new(1, :kg) + Weight.new(1, :lb) # =>   #<Weight: @input_value=1.4536, @input_unit=:kg>
+ Weight.new(1, :lb) + Weight.new(1, :kg) # =>   #<Weight: @input_value=3.2046, @input_unit=:lb>
+```
+
+### Basic comparison with Weight objects
+
+```ruby
+ Weight.new(3, :lb).between?(Weight.new(1, :kg), Weight.new(2, :kg))
+ Weight.new(1, :kg) > Weight.new(2, :lb)
+ Weight.new(1, :lb) <= Weight.new(0.5, :kg)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/weight_conversion/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/weight_conversion.rb

@@ -0,0 +1,138 @@
+require "weight_conversion/version"
+
+class Weight
+
+   include Comparable
+
+   def initialize(value=0.0, unit='lb')
+      self.value = value
+      self.unit = unit
+   end
+
+   def value
+      @input_value
+   end
+
+   def unit
+      @input_unit
+   end
+
+   def to_gms
+      data_in_grams.round(4)
+   end
+
+   def to_ozs
+      (data_in_grams / grams_per_ounce).round(4)
+   end
+
+   def to_lbs
+      (data_in_grams / grams_per_pound).round(4)
+   end
+
+   def to_kgs
+      (data_in_grams / grams_per_kilogram).round(4)
+   end
+
+   def to_i
+      value.round
+   end
+
+   def to_f
+      value.round(4).to_f
+   end
+
+   def +(other)
+      return if is_not_weight?(other)
+      self.class.new(value + other_value(other), unit)
+   end
+
+   def -(other)
+      return if is_not_weight?(other)
+      self.class.new(value - other_value(other), unit)
+   end
+
+   def <=>(other)
+      return if is_not_weight?(other)
+      self.to_gms <=> other.to_gms
+   end
+
+   def ==(other)
+      return if is_not_weight?(other)
+      self.to_gms  == other.to_gms
+   end
+
+   def *(other)
+      raise TypeError, 'You can only multiply by a number' unless other.is_a?(Numeric)
+      self.class.new(value * other, unit)
+   end
+
+   def /(other)
+      raise TypeError, 'You can only divide by a number' unless other.is_a?(Numeric)
+      self.class.new(value / other, unit)
+   end
+
+   private
+
+   def value=(value)
+      raise TypeError, 'Value cannot be negative' if value < 0
+      raise TypeError, 'Value must be Numeric' unless value.is_a? Numeric
+      @input_value = value
+   end
+
+   def unit=(unit)
+      unit = unit.to_s.downcase.to_sym
+      raise ArgumentError, "Allowed unit types #{allowed_units.inspect}" unless allowed_units.include?(unit)
+      @input_unit = unit
+   end
+
+   def allowed_units
+      [:gm, :oz, :lb, :kg]
+   end
+
+   def other_value(other)
+      case unit
+      when :gm
+         other.to_gms
+      when :oz
+         other.to_ozs
+      when :lb
+         other.to_lbs
+      when :kg
+         other.to_kgs
+      end
+   end
+
+   def data_in_grams
+      case unit
+      when :gm
+         value
+      when :oz
+         value * grams_per_ounce
+      when :lb
+         value * grams_per_pound
+      when :kg
+         value * grams_per_kilogram
+      else
+         raise TypeError, 'Unit is not valid.'
+      end
+   end
+
+   def grams_per_ounce
+      28.34952
+   end
+
+   def grams_per_pound
+      453.5923
+   end
+
+   def grams_per_kilogram
+      1000
+   end
+
+   def is_not_weight?(other)
+      return false if other.is_a?(Weight)
+      raise TypeError, 'Not a Weight class.'
+      return true
+   end
+
+end

data/lib/weight_conversion/version.rb

@@ -0,0 +1,3 @@
+module WeightConversion
+   VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'weight_conversion'
+# require 'coveralls'
+
+# Coveralls.wear!
+
+RSpec.configure do |config|
+   # Optional configs
+end

data/spec/weight_conversion_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe Weight do
+
+  let(:one_kg) { Weight.new(1, :kg) }
+  let(:one_lb) { Weight.new(1, :lb) }
+  let(:one_oz) { Weight.new(1, :oz) }
+  let(:one_gm) { Weight.new(1, :gm) }
+
+  it 'should take two options value and unit type' do
+    Weight.new(1, :lb).should be_instance_of(Weight)
+  end
+
+  describe 'math operators' do
+    it 'for minus operator result unit should be equal to first object unit' do
+      (one_kg - one_lb).unit.should == :kg
+    end
+
+    it 'for plus operator result unit should be equal to first object unit' do
+      (one_kg + one_lb).unit.should == :kg
+    end
+
+    it 'minus operator should compute weight objects with different units properly' do
+      (one_kg - one_lb).should > one_lb
+      (one_lb - one_oz).should < one_lb
+    end
+
+    it 'plua operator should compute weight objects with different units properly' do
+      (one_gm + one_oz).should < one_lb
+      (one_oz + one_lb).should > one_lb
+    end
+
+    it 'plus operator should have proper result' do
+      (one_lb + one_lb).should == Weight.new(2, :lb)
+    end
+
+    it 'two objects with the same weight and type should be equal' do
+      one_kg.should == Weight.new(1, :kg)
+    end
+
+    it 'operation resulting in zero is okay' do
+      (one_lb - one_lb).should == Weight.new(0, :lb)
+    end
+
+    it 'times operator should have proper result' do
+      (one_lb * 2).should == Weight.new(2, :lb)
+    end
+
+    it 'operation on something that is not a Weight should raise an error' do
+      expect do
+        (one_lb + 1)
+      end.to raise_error(TypeError)
+    end
+
+    it 'attempting to multiply a weight by another weight should raise an error' do
+      expect do
+        (one_lb * one_lb)
+      end.to raise_error(TypeError)
+    end
+
+    it 'multiplication should have proper result' do
+      (one_kg * 2).should == Weight.new(2, :kg)
+    end
+
+    it 'division should have proper result' do
+      (Weight.new(2, :kg) / 2).should == one_kg
+    end
+
+    it 'attempting to divide a weight by another weight should raise an error' do
+      expect do
+        (one_lb / one_lb)
+      end.to raise_error(TypeError)
+    end
+  end
+
+  describe 'calculation between different units' do
+    it 'should convert 1 kg to 2.2046 lbs' do
+      Weight.new(1, :kg).to_lbs.should == 2.2046
+    end
+
+    it 'should convert 1 lbs to 0.45359 kg' do
+      Weight.new(1, :lb).to_kgs.should == 0.4536
+    end
+
+    it 'should convert 1 kg to 35.2740 ounces' do
+      Weight.new(1, :kg).to_ozs.should == 35.2740
+    end
+
+    it 'should convert 1 kg to 1000 grams' do
+      Weight.new(1, :kg).to_gms.should == 1000
+    end
+
+    it 'should convert 1000 gms to 1 kg' do
+      Weight.new(1000, :gm).to_kgs.should == 1
+    end
+
+    it 'should convert 28.3495 gms to 1 oz' do
+      Weight.new(28.3495, :gm).to_ozs.should == 1
+    end
+
+    it 'should convert 453.5923 gms to 1 lb' do
+      Weight.new(453.5923, :gm).to_lbs.should == 1
+    end
+
+    it 'should convert 0 kgs to 0 lb' do
+      Weight.new(0, 'kg').to_lbs.should == 0.0
+    end
+
+    it 'should raise an error when the weight is negative' do
+      expect do
+        Weight.new(-1, 'kg')
+      end.to raise_error(TypeError)
+    end
+
+    it 'should return the weight in pounds when converted to_f' do
+      Weight.new(0.6, 'lb').to_f.should == 0.6
+    end
+
+    it 'should round 0.6 lbs to 1 lb when converted to_i' do
+      Weight.new(0.6, 'lb').to_i.should == 1
+    end
+
+    it 'should round 0.5 lbs to 1 lb when converted to_i' do
+      Weight.new(0.5, 'lb').to_i.should == 1
+    end
+
+    it 'should round 0.4 lbs to 0 lb when converted to_i' do
+      Weight.new(0.4, 'lb').to_i.should == 0
+    end
+  end
+
+  describe 'comparison of different weights' do
+    it 'two pounds should be more than one' do
+      Weight.new(2, :lb).should be > one_lb
+    end
+
+    it 'two pounds should be greater than or equal to one plus one' do
+      Weight.new(2, :lb) >= one_lb + one_lb
+    end
+
+    it 'one pound should be less than two' do
+      one_lb.should be < Weight.new(2, :lb)
+    end
+
+    it 'attempting to compare a weight to something that is not a weight should raise an error' do
+      expect do
+        (Weight.new(1, :lb) == 1)
+      end.to raise_error(TypeError)
+    end
+  end
+end

data/weight_conversion.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weight_conversion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "weight_conversion"
+  spec.version       = WeightConversion::VERSION
+  spec.authors       = ["Paul Zupan"]
+  spec.email         = ["pzupan@gmail.com"]
+  spec.summary       = %q{Gem to convert measures of weight.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: weight_conversion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Zupan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: ''
+email:
+- pzupan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/weight_conversion.rb
+- lib/weight_conversion/version.rb
+- spec/spec_helper.rb
+- spec/weight_conversion_spec.rb
+- weight_conversion.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Gem to convert measures of weight.
+test_files:
+- spec/spec_helper.rb
+- spec/weight_conversion_spec.rb