commerce_units 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1abedfde0d6bd48016d5daaae8b936b1f6cdb3e5
+  data.tar.gz: 1a9d0c12f33623e6b2065cb2c7f1003a1dc43e2d
+SHA512:
+  metadata.gz: ac8f6d6df3a1cc8c33fc79d28be9af62bb0d816c543d825aa65a2010e5dcd9ebc622785c55f56826ba7436c8ad44d6d1491549608b4ec8434361bc480aa3cc3a
+  data.tar.gz: 379345b2ea3e703311bcf26c24b8608603a7b9834537bc40f618763375207e4ad21e75b105248b0a928fba03e2bf87f87e8a64b93c54fd4ae8424bcbec54b809

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Chen
+
+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,94 @@
+# CommerceUnits
+
+Another units library for Ruby which helps with maintaining consist mathematics. But unlike scientific (SI) units, where we're all agreed to things like 1000g = 1kg, 1 hour = 60 minutes, and whatnot, commerce_units makes no assumptions on what kinds of units there.
+
+Instead, commerical units allows you to define your own conversion rates between different units and operations such as multiply and divide will automatically handle conversions and reductions while addition and subtraction will throw errors if inappropriately dimensioned values are added together.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'commerce_units'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commerce_units
+
+## Usage
+
+### Step 1: generate the migration to create the dimensions
+```shell
+rails generate commerce_units
+```
+What?! This is unit library, yet you demand a database migration? What sort of stupid shit...
+
+Well, the justification is that this is a commerce units library, and, in business, I have no idea what sort of units you might be using to quantify your transactions. In my case, I built this library originally to use for money per weight, and the dimension of money has all sorts of units (dollars, cents, rupies, RMB, yen, pound-sterling, etc.) which even change with time. 
+
+If you think your business is measured in dollars per boxes, then it's up to you to declare dollars with a money dimension and boxes in some other root dimension.
+
+### Step 2: seed the CommerceUnits::Dimension record with the units you'll need
+Declare your units, here's an example
+```ruby
+CommerceUnits::Dimension.create! root_dimension: :money,
+  unit_name: "dollar",
+  multiply_constant: 1.0,
+  unitary_role: :primary
+
+CommerceUnits::Dimension.create! root_dimension: :money,
+  unit_name: "cent",
+  multiply_constant: 100.0 # 100 cents go into 1 us dollar
+
+CommerceUnits::Dimension.create! root_dimension: :money,
+  unit_name: "RMB",
+  multiply_constant: 6.654 # 6.654 RMB go into 1 us dollar
+
+CommerceUnits::Dimension.create! root_dimension: :money,
+  unit_name: "euro",
+  multiply_constant: 12000 # 12000 euros go into 1 us dollar because Yuropoor is poor
+
+CommerceUnits::Dimension.create! root_dimension: :mass,
+  unit_name: 'pound',
+  multiply_constant: 1.0,
+  unitary_role: :primary
+
+CommerceUnits::Dimension.create! root_dimension: :mass,
+  unit_name: 'ton',
+  multiply_constant: 2000 # 2000 pounds go into 1 ton
+
+CommerceUnits::Dimension.create! root_dimension: :mass,
+  unit_name: 'landwhale',
+  multiply_constant: 354 # 354 pounds go into 1 landwhale
+```
+
+### Step 3: Use
+Here's an example
+```ruby
+dollar_per_pound = CommerceUnit::Value.from_params number: 1234, units: "dollar / pound"
+dollar_per_pound.to_s # 1234 dollar / pound
+
+euro_per_ton = CommerceUnit::Value.from_params number: 34, units: "euro / ton"
+dollar_per_pound + euro_per_ton # 1234.00000... dollar / pound
+
+dollar_per_landwhale_squared = CommerceUnit::Value.from_params number: 1, units: "dollar / landwhale / landwhale"
+euro_per_ton + dollar_per_landwhale_squared # throws unit mismatch error
+
+(euro_per_ton / dollar_per_pound ).unitless? # true
+
+```
+## Assumptions
+If "mango" and "chair" are both declared as commerce units of the same dimension, then any amount of mangos can be converted to chairs by a constant multiplication. This necessarily means 0 mangos == 0 chairs
+
+If you specify 0 as the multiply_constant, you'll eat a face full of DivideByZero errors.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/commerce_units/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 new Pull Request

data/Rakefile

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

data/commerce_units.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commerce_units/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "commerce_units"
+  spec.version       = CommerceUnits::VERSION
+  spec.authors       = ["Thomas Chen"]
+  spec.email         = ["foxnewsnetwork@gmail.com"]
+  spec.summary       = %q{Another ruby units library for doing dimensional math, this one to be used with rails, preferrably commerce-related apps}
+  spec.description   = %q{Another ruby units library for doing dimensional math, this one to be used with rails, preferrably commerce-related apps}
+  spec.homepage      = "http://github.com/foxnewsnetwork/commerce_units"
+  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.required_ruby_version = ">= 1.9.2"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "ffaker"
+
+  spec.add_dependency('activemodel', '>= 3.0.0')
+  spec.add_dependency('activerecord', '>= 3.0.0')
+  spec.add_dependency('activesupport', '>= 3.0.0')
+  spec.add_dependency "functional_support", '>= 0.0.6'
+
+end

data/lib/commerce_units/converter.rb

@@ -0,0 +1,56 @@
+class CommerceUnits::Converter
+  class << self
+    def convert(value: value, unit: unit)
+      new.tap do |c|
+        c.target_unit = unit
+        c.origin_value = value
+      end.coerce
+    end
+  end
+  class MismatchDimension < StandardError; end
+  class WrongType < StandardError; end
+  attr_reader :target_unit, :origin_value
+  
+  def coerce
+    return origin_value if target_unit == origin_unit
+    raise MismatchDimension, "Unable to convert #{origin_unit} to #{target_unit}" if _mismatch_dimension?
+    _base_to_target_transform _origin_to_base_transform origin_value
+  end
+
+  def origin_unit
+    origin_value.unit
+  end
+
+  def target_unit=(unit)
+    raise WrongType, "#{unit} should be an instance of CommerceUnits::Unit" unless unit.is_a? CommerceUnits::Unit
+    @target_unit = unit
+  end
+
+  def origin_value=(value)
+    raise WrongType, "#{value} should be an instance of CommerceUnits::Value" unless value.is_a? CommerceUnits::Value
+    @origin_value = value
+  end
+
+  private
+
+  def _origin_to_base_transform(value)
+    _conversion_constants(origin_unit).inject(value) { |v, c| v * c }
+  end
+
+  def _conversion_constants(unit)
+    CommerceUnits.dimensional_database.from_array_of_unit_names!(unit.numerator).map(&:to_converter_value) + 
+      CommerceUnits.dimensional_database.from_array_of_unit_names!(unit.denominator).map(&:to_converter_value).map(&:flip)
+  end
+
+  def _base_to_target_transform(value)
+    _conversion_constants(target_unit).inject(value) { |v,c| v * c }
+  end
+
+  def _mismatch_dimension?
+    not _matching_dimension?
+  end
+
+  def _matching_dimension?
+    target_unit.to_root_dimension == origin_unit.to_root_dimension
+  end
+end

data/lib/commerce_units/dimension.rb

@@ -0,0 +1,102 @@
+# == Schema Information
+#
+# Table name: commerce_units_dimensions
+#
+#  id                :integer          not null, primary key
+#  root_dimension    :string(255)      not null
+#  unit_name         :string(255)      not null
+#  multiply_constant :decimal(15, 5)   default(1.0), not null
+#  unitary_role      :string(255)      default("tertiary"), not null
+#  created_at        :datetime
+#  updated_at        :datetime
+#
+
+class CommerceUnits::Dimension < ActiveRecord::Base
+  class NoPrimaryUnit < StandardError; end
+  KnownRoots = [:money, :mass]
+
+  scope :primary_roles,
+    -> { where "#{self.table_name}.unitary_role = ?", :primary }
+
+  scope :by_roots,
+    -> (root_name) { where "#{self.table_name}.root_dimension = ?", root_name }
+
+  scope :primary_unit_by_roots,
+    -> (root_name) { primary_roles.by_roots(root_name) }
+
+  class << self
+    def from_array_of_unit_names!(names)
+      result = where unit_name: names
+      unless result.count == names.count
+        unfound_names = names.map(&:to_s) - result.map(&:unit_name)
+        raise ActiveRecord::RecordNotFound, "I don't know the following units: #{unfound_names} out of #{names}"
+      end
+      result
+    end
+
+    def create_and_consider_making_primary!(param_hash)
+      dimension = create! param_hash
+      dimension.make_primary! if primary_unit_by_roots(dimension.root_dimension).blank?
+      dimension
+    end
+
+    def find_or_create_and_consider_making_primary!(param_hash)
+      where(param_hash).first || create_and_consider_making_primary!(param_hash)
+    end
+  end
+
+  def to_converter_unit
+    CommerceUnits::Unit.new.tap do |u|
+      u.numerator = [_primary_root_unit_name]
+      u.denominator = [unit_name]
+    end
+  end
+
+  def to_unit
+    CommerceUnits::Unit.new.tap do |u|
+      u.numerator = [unit_name]
+    end
+  end
+
+  def to_converter_value
+    CommerceUnits::Value.new.tap do |v|
+      v.number = multiply_constant
+      v.unit = to_converter_unit
+    end
+  end
+
+  def to_value
+    CommerceUnits::Value.new.tap do |v|
+      v.number = multiply_constant
+      v.unit = to_unit
+    end
+  end
+
+  def make_primary!
+    _shift_primary! if self.class.primary_unit_by_roots(root_dimension).present?
+    _make_primary!
+    self
+  end
+
+  private
+  def _make_primary!
+    update multiply_constant: 1.0,
+      unitary_role: :primary
+  end
+  def _shift_primary!
+    self.class.by_roots(root_dimension).reject do |dim|
+      dim.id == self.id
+    end.each do |dim|
+      dim.update multiply_constant: dim.multiply_constant / multiply_constant,
+        unitary_role: :secondary
+    end
+  end
+  def _primary_unit
+    self.class.primary_unit_by_roots(root_dimension).first
+  end
+  def _primary_root_unit_name
+    d = _primary_unit
+    raise NoPrimaryUnit, "#{root_dimension} does not have a primary unit" if d.blank?
+    d.unit_name
+  end
+end

data/lib/commerce_units/simplifier.rb

@@ -0,0 +1,33 @@
+class CommerceUnits::Simplifier
+  class NotComparable < StandardError; end
+  def initialize(numerator: [], denominator: [])
+    @original_top = numerator.sort
+    @original_bot = denominator.sort
+  end
+
+  def numerator
+    @numerator ||= _reduced_numerator_from top: @original_top, bot: @original_bot
+  end
+
+  def denominator
+    @denominator ||= _reduced_denominator_from top: @original_top, bot: @original_bot
+  end
+
+  private
+  def _reduced_numerator_from(top: [], bot: [])
+    return top if top.blank? or bot.blank?
+    return _reduced_numerator_from(top: top.tail, bot: bot.tail) if top.first == bot.first
+    return _reduced_numerator_from(top: top, bot: bot.tail) if top.first > bot.first
+    return [top.first] + _reduced_numerator_from(top: top.tail, bot: bot) if top.first < bot.first
+    raise NotComparable, "Failed to compare #{top.first} with #{bot.first}"
+  end
+
+  def _reduced_denominator_from(top: [], bot: [])
+    return bot if top.blank? or bot.blank?
+    return _reduced_denominator_from(top: top.tail, bot: bot.tail) if top.first == bot.first
+    return [bot.first] + _reduced_denominator_from(top: top, bot: bot.tail) if bot.first < top.first
+    return _reduced_denominator_from(top: top.tail, bot: bot) if bot.first > top.first
+    raise NotComparable, "Failed to compare #{top.first} with #{bot.first}"
+  end
+
+end

data/lib/commerce_units/terms_reducer.rb

@@ -0,0 +1,63 @@
+class CommerceUnits::TermsReducer
+  attr_accessor :value
+  delegate :number, :unit, to: :value
+  def initialize(value)
+    @value = value
+  end
+
+  def reduce_to_simplest_terms
+    _reducing_terms.reduce(value, &:*)
+  end
+
+  private
+  def _reducing_terms
+    _units_by_dimensions.flat_map do |root_dimension, numerators_and_denominators|
+      numerators_and_denominators[:numerators].zip numerators_and_denominators[:denominators]
+    end.reject do |top_and_bottom|
+      top_and_bottom.first.blank? || top_and_bottom.last.blank?
+    end.map do |top_and_bottom|
+      _value_from_ratio *top_and_bottom
+    end
+  end
+
+  def _units_by_dimensions
+    _special_merge _numerator_by_dimensions, _denominator_by_dimensions  
+  end
+
+  def _special_merge(top_group, bot_group)
+    output = {}
+    top_group.each do |root_dimension, unit_names|
+      output[root_dimension] ||= {}
+      output[root_dimension][:numerators] = unit_names
+    end
+    bot_group.each do |root_dimension, unit_names|
+      output[root_dimension] ||= {}
+      output[root_dimension][:denominators] = unit_names
+    end
+    output
+  end
+
+  def _numerator_by_dimensions
+    unit.numerator.group_by { |unit_name| _get_root_dim unit_name }
+  end
+
+  def _denominator_by_dimensions
+    unit.denominator.group_by { |unit_name| _get_root_dim unit_name }
+  end
+
+  def _value_from_ratio(top, bottom)
+    _get_conversion_value(top) / _get_conversion_value(bottom)
+  end
+
+  def _get_conversion_value(unit_name)
+    _get_dim(unit_name).to_converter_value
+  end
+
+  def _get_dim(unit_name)
+    CommerceUnits.dimensional_database.find_by_unit_name! unit_name
+  end
+
+  def _get_root_dim(unit_name)
+    _get_dim(unit_name).root_dimension
+  end
+end