weight 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa6ce855ed5b69b14e47239e204a95bd8f0aa8ee
+  data.tar.gz: 9ae53a6cf99f0cf5d474d49baecd3169e084379e
+SHA512:
+  metadata.gz: 31bbe20390655459046b40bc53428ca9fa1c36447fa306abbe43909cd1b15f1289cdda20ffddfc5eb90dfd93fceb4ef4c90f583a28378f0958a686450a626b76
+  data.tar.gz: c172d0566ba2646a19096a2087316a46c277068adc606b187a845abe7d42cd8bc5d74c7f6665d893617838e58ca369e8118089063243120835b67e6e195954ac

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anton Shemerey
+
+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,66 @@
+# Weight (0.0.1 alpha version)
+
+[![Code Climate](https://codeclimate.com/github/shemerey/weight.png)](https://codeclimate.com/github/shemerey/weight)
+
+It's dead simple Value object, which provides convenient way to work with
+weight in a different unit systems. It could be useful if you have to work with
+different unit system, for example you have to work with :kg as well as :lb for USA
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'weight'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weight
+
+## Configuration
+You could configure default unit system (:kg or :lb)
+
+just put this in your initializer: config/initializers/weight.rb
+
+```ruby
+  # new object in kg by default
+  Weight.new # => <Weight: @input_value=0, @input_unit=:kg>
+
+  Weight::Configuration.configure do |config|
+    config.default_unit = :lb  # by default it uses :kg
+  end
+
+  # Now default object looks like
+  Weight.new # => <Weight: @input_value=0, @input_unit=:lb>
+```
+
+## Usage
+
+### 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)
+```
+
+### 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
+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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/weight.rb

@@ -0,0 +1,136 @@
+require "weight/all"
+
+class Weight
+  include Comparable
+  include Weight::Configuration
+
+  # Class contructor
+  # @param value [Int] The weight of the object
+  # @param unit [String] The unit in which the value is expressed. Currently
+  #   supports 'lb' and 'kg'
+  # @raise [TypeError] When weight is negative
+  def initialize(value = 0, unit = default_unit)
+    self.value, self.unit = value, unit
+  end
+
+  def value
+    @input_value
+  end
+
+  def unit
+    @input_unit
+  end
+
+  # Returns the weight converted to pounds
+  # @return [Float] The weight in pounds
+  def to_kgs
+    raw_data_in_kg.round(4)
+  end
+
+  # Returns the weight converted to kilograms
+  # @return [Float] The weight in kilograms
+  def to_lbs
+    (raw_data_in_kg * pounds_per_kilogram).round(4)
+  end
+
+  # Returns the weight converted to pounds
+  # @return [Float] The weight in pounds
+  def to_f
+    value.to_f.round(4)
+  end
+
+  # Returns the weight in pounds rounded to the closest integer
+  # @return [Int] The weight in pounds rounded
+  def to_i
+    value.round
+  end
+
+  # Addition operation
+  # @param other [Weight] The other weight to add to the current one
+  # @return [Weight] The sum of the two weights
+  # @raise [TypeError] When the argument passed is not a Weight
+  def +(other)
+    raise TypeError, 'You can only add weights' unless other.is_a?(Weight)
+    self.class.new(raw_data_in_kg + other.to_kgs, :kg)
+  end
+
+  # Comparison operator
+  # @param other [Weight] The other weight to compare to the current one
+  # @return [Bool] True if both of the objects have the same weight. False
+  #   otherwise
+  # @raise [TypeError] When the argument passed is not a Weight
+  def ==(other)
+    raise TypeError, 'You can only compare weights' unless other.is_a?(Weight)
+    raw_data_in_kg.round(4) == other.to_kgs
+  end
+
+  # Comparison operator
+  # @param other [Weight] The other weight to compare to the current one
+  # @return [-1,0,1]
+  # @raise [TypeError] When the argument passed is not a Weight
+  def <=>(other)
+    raise TypeError, 'You can only compare weights' unless other.is_a?(Weight)
+    self.to_kgs <=> other.to_kgs
+  end
+
+  # Substract operation
+  # @param other [Weight] The other weight to substract to the current one
+  # @return [Weight] The substraction of the two weights
+  # @raise [TypeError] When the argument passed is not a Weight
+  def -(other)
+    raise TypeError, 'You can only substract weights' unless other.is_a?(Weight)
+    self.class.new(raw_data_in_kg - other.to_kgs, :kg)
+  end
+
+  # Multiplication operation
+  # @param other [Weight] The other weight to multiply by the current one
+  # @return [Weight] The product of the two weights
+  # @raise [TypeError] When the argument passed is not a Weight
+  def *(other)
+    raise TypeError, 'You can only multiply a weight by a number' unless other.is_a?(Numeric)
+    self.class.new(value * other, unit)
+  end
+
+  # Division operation
+  # @param other [Weight] The weight to divide the current one by
+  # @return [Weight] The result of the operation
+  # @raise [TypeError] When the argument passed is not a Weight
+  def /(other)
+    raise TypeError, 'You can only divide a weight by a number' unless other.is_a?(Numeric)
+    self.class.new(value / other, unit)
+  end
+
+  private
+
+  # The weight expressed in kilograms for internal usage
+  # @return [Float] The weight in pounds
+  # @raise [TypeError] When the unit passed was neither kg nor lb
+  def raw_data_in_kg
+    case unit
+    when :kg
+      value
+    when :lb
+      value / pounds_per_kilogram
+    else
+      raise TypeError, 'Unit is neither kg nor lb'
+    end
+  end
+
+  def value=(value)
+    raise TypeError, 'Weight cannot be negative' if value < 0
+    raise TypeError, 'Weight value should be Numeric' unless value.is_a? Numeric
+    @input_value = value
+  end
+
+  def unit=(unit)
+    unit = unit.to_s.downcase.to_sym
+    raise ArgumentError, "You should use one from allowe unit tipes #{allowed_units.inspect}" unless allowed_units.include?(unit)
+    @input_unit = unit
+  end
+
+  # The conversion rate between pounds and kilograms
+  # @return [Float] The number of pounds in a kilogram
+  def pounds_per_kilogram
+    2.2046
+  end
+end

data/lib/weight/all.rb

@@ -0,0 +1,2 @@
+require 'weight/version'
+require 'weight/configuration'

data/lib/weight/configuration.rb

@@ -0,0 +1,21 @@
+module Weight::Configuration
+  module_function
+
+  def self.configure
+    yield self if block_given?
+  end
+
+  def default_unit=(weight_unit_code)
+    default_unit = weight_unit_code.to_s.downcase.to_sym
+    raise ArgumentError unless allowed_units.include?(default_unit)
+    @@default_unit = default_unit
+  end
+
+  def default_unit
+    @@default_unit ||= :kg
+  end
+
+  def allowed_units
+    [:kg, :lb]
+  end
+end

data/lib/weight/version.rb

@@ -0,0 +1,3 @@
+class Weight
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'weight'
+
+RSpec.configure do |config|
+
+end

data/spec/weight/configuration_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Weight::Configuration do
+  describe '#default configuraiton' do
+    it 'should be kilogram by default' do
+      described_class.default_unit.should == :kg
+    end
+  end
+
+  describe 'only :lb, :kg allowed' do
+    it 'raise ArgumentError if default_unit not in allowed list [:kg, :lb]' do
+      expect {
+        described_class.default_unit = 'g'
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#configure default_unit as lb' do
+    ['lb', 'Lb', 'lB', 'LB', :lb, :Lb, :lB, :LB].each do |lb|
+      it "should be lb if we configure it with #{lb} as a default_unit" do
+        described_class.default_unit = lb
+        described_class.default_unit.should == :lb
+      end
+    end
+  end
+
+  describe '#configure default_unit as kg' do
+    ['kg', 'Kg', 'kG', 'KG', :kg, :Kg, :kG, :KG].each do |kg|
+      it "should be kg if we configure it with #{kg} as a default_unit" do
+        described_class.default_unit = kg
+        described_class.default_unit.should == :kg
+      end
+    end
+  end
+end
+

data/spec/weight_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Weight do
+  let(:one_kg) { described_class.new(1, 'kg') }
+  let(:two_kg) { described_class.new(2, 'kg') }
+
+  let(:one_lb) { described_class.new(1, 'lb') }
+  let(:two_lb) { described_class.new(2, 'lb') }
+
+  let(:another_lb) { described_class.new(1, 'lb') }
+
+  it 'should take two options value and unit type' do
+    described_class.new(1, 'lb').should be_instance_of(described_class)
+  end
+
+  describe 'calculation between different units' do
+    it 'should convert 1 kg to 2.2046 lbs' do
+      described_class.new(1, 'kg').to_lbs.should == 2.2046
+    end
+
+    it 'should convert 1 lbs to 0.45359 kg' do
+      described_class.new(1, 'lb').to_kgs.should == 0.4536
+    end
+
+    it 'should convert 0 kgs to 0 lb' do
+      described_class.new(0, 'kg').to_lbs.should == 0.0
+    end
+
+    it 'should convert 0 lbs to 0 kg' do
+      described_class.new(0, 'lb').to_kgs.should == 0.0
+    end
+
+    it 'should raise an error when the weight in kgs is negative' do
+      expect do
+        described_class.new(-1, 'kg')
+      end.to raise_error(TypeError)
+    end
+
+    it 'should raise an error when the weight in lbs is negative' do
+      expect do
+        described_class.new(-1, 'lb')
+      end.to raise_error(TypeError)
+    end
+
+    it 'should return the weight in pounds when converted to_f' do
+      described_class.new(0.6, 'lb').to_f.should == 0.6
+    end
+
+    it 'should round 0.6 lbs to 1 lb when converted to_i' do
+      described_class.new(0.6, 'lb').to_i.should == 1
+    end
+
+    it 'should round 0.5 lbs to 1 lb when converted to_i' do
+      described_class.new(0.5, 'lb').to_i.should == 1
+    end
+
+    it 'should round 0.4 lbs to 0 lb when converted to_i' do
+      described_class.new(0.4, 'lb').to_i.should == 0
+    end
+  end
+
+  describe 'comparison of different weights' do
+    it 'two lb more than two' do
+      two_lb.should be > one_lb
+    end
+
+    it 'two lb more or eql than two' do
+      two_lb.should be >= two_lb
+    end
+
+    it 'one lb less than two' do
+      one_lb.should be < two_lb
+    end
+
+    it '1 lb + 1 lb should be 2 lbs' do
+      (one_lb + one_lb).should == two_lb
+    end
+
+    it 'two objects with the same weight and type should be equal' do
+      one_lb.should == another_lb
+    end
+
+    it '2 lbs - 1 lb should be 1 lb' do
+      (two_lb - one_lb).should == one_lb
+    end
+
+    it '2 times 1 lb should be 2 lbs' do
+      (one_lb * 2).should == two_lb
+    end
+
+    it 'attempting to compare a weight to 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 add a weight to 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 substract from a weight 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 '1 kg multipied by two should be 2 kg' do
+      (one_kg * 2).should == two_kg
+    end
+
+    it '2 kgs divided by two should be 1 kg' do
+      (two_kg / 2).should == one_kg
+    end
+
+    it '2 lbs divided by two should be 1 lbs' do
+      (two_lb / 2).should == one_lb
+    end
+
+    it 'attempting to divide a weight by another weight should raise an error' do
+      expect do
+        (two_lb / two_lb)
+      end.to raise_error(TypeError)
+    end
+  end
+end

data/weight.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weight/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "weight"
+  spec.version       = Weight::VERSION
+  spec.authors       = ["Anton Shemerey"]
+  spec.email         = ["shemerey@gmail.com"]
+  spec.description   = %q{Dead simple value object, with one purpose work with weight}
+  spec.summary       = %q{
+                          It's dead simple Value object, which provides convenient way
+                          to work with weight in a different unit systems. It could be useful
+                          if you have to work with different unit system, for example
+                          you have to work with :kg as well as :lb for USA
+                        }
+  spec.homepage      = "https://github.com/shemerey/weight"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: weight
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Shemerey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dead simple value object, with one purpose work with weight
+email:
+- shemerey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/weight.rb
+- lib/weight/all.rb
+- lib/weight/configuration.rb
+- lib/weight/version.rb
+- spec/spec_helper.rb
+- spec/weight/configuration_spec.rb
+- spec/weight_spec.rb
+- weight.gemspec
+homepage: https://github.com/shemerey/weight
+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.1.10
+signing_key: 
+specification_version: 4
+summary: It's dead simple Value object, which provides convenient way to work with
+  weight in a different unit systems. It could be useful if you have to work with
+  different unit system, for example you have to work with :kg as well as :lb for
+  USA
+test_files:
+- spec/spec_helper.rb
+- spec/weight/configuration_spec.rb
+- spec/weight_spec.rb