convertable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16f51bd062c3c1d298ce8c4c0d29cd05892a0ad7bc6bfe1120a23e518fbc839e
+  data.tar.gz: 0f73afa024d8f4a4aef30b95bbda68c669621509ccaf14c399841c3ac8b80d29
+SHA512:
+  metadata.gz: bf31d8d146c223840dcec77487ba5153369cbf510212a5b2beaa149820e00ccbf18cff8fbdeea191cdd93d6fcebb0e00964b642bb3efd7e8d17d820d86524763
+  data.tar.gz: 5d8583dc12f4c8dc3410349d112e9e3a3217743b80c53a4ea138bdb39c0d0efc1635fe61cf0cda0e995d133578afd8631f76074db76c84c074459359dff5c314

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    convertable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.16)
+  convertable!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,145 @@
+# Convertable
+
+![Convertable](http://www.clker.com/cliparts/H/f/Z/C/p/v/convertible-sports-car-md.png)
+
+*Convertible* was taken, and *convertable* was close enough.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'convertable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install convertable
+
+## Usage
+
+Convertable is composed of two main ideas:
+
+### Units
+
+Units are the basic building blocks of the library. There are two types of units, simple and composed. They both know how to convert to other units with `convert_to(magnitude, new_unit)`. Composed units can be any permutation of multiple simple units. All units are namespaced under `Convertable::Units`.
+
+*e.g. convert 1.0 square meter to square feet*
+
+```ruby
+Convertable::Units::SquareMeter.convert_to(1.0, Convertable::Units::SquareFoot)
+=> 10.7639
+```
+
+If a unit does not know how to convert to another unit an exception is raised
+
+```ruby
+Convertable::Units::SquareMeter.convert_to(1.0, Convertable::Units::Year)
+=> Convertable::Units::UnsupportedConversion (Convertable::Units::UnsupportedConversion)
+```
+
+*Simple Units*
+
+* Year
+* Month
+* SquareFoot
+* SquareMeter
+* Currency (Usd, Eur, Gbp)
+
+*Composed Units*
+```ruby
+Convertable::Units::ComposedUnit.new("Usd/SquareFoot/Year").inspect
+
+ => <Convertable::Units::ComposedUnit:0x00007fa4819c7638
+      @multiplying_unit=Convertable::Units::Usd,
+      @dividing_units=[Convertable::Units::SquareFoot, Convertable::Units::Year]
+    >
+```
+
+```ruby
+currency = Convertable::Units::Usd
+area = Convertable::Units::SquareFoot
+period = Convertable::Units::Year
+Convertable::Units::ComposedUnit.new("#{currency}/#{area}/#{period}").inspect
+
+ => <Convertable::Units::ComposedUnit:0x00007fa4819c7638
+      @multiplying_unit=Convertable::Units::Usd,
+      @dividing_units=[Convertable::Units::SquareFoot, Convertable::Units::Year]
+    >
+```
+
+### Measures
+
+ A measure is a standardized representation of a real-life physical quantity relative to some reference, called unit of measurement.  It is described by its class name (UsdPerAreaPerYear) and has two components
+
+* Magnitude - numeric value - 20.5
+* Unit - one of the units above - `Convertable::Units::ComposedUnit.new('Usd/SquareFoot/Year')`
+
+All Convertable are namespaced under `Convertable::Measures`.
+
+*e.g. $20.5 / square foot / year*
+
+```ruby
+magnitude = 20.5
+unit = Convertable::Units::ComposedUnit.new('Usd/SquareFoot/Year')
+measure = Convertable::Measures::MoneyPerAreaPerPeriod.new(magnitude, unit)
+```
+##### Unit Conversions
+Measures can be converted to different units with `Measure#in(new_unit)`:
+
+*$/sf/year => $/sm/year*
+
+```ruby
+measure.in(Convertable::Units::ComposedUnit.new('Usd/SquareMeter/Year')).inspect
+
+=> <Convertable::Measures::MoneyPerAreaPerPeriod:0x00007fbcb32dcf40
+     @magnitude=220.65994999999998,
+     @unit=Convertable::Units::ComposedUnit.new('Usd/SquareMeter/Year')
+   >
+```
+
+*$/sf/year => $/sf/month*
+
+```ruby
+measure.in(Convertable::Units::ComposedUnit.new('Usd/SquareFoot/Month')).inspect
+
+=> <Convertable::Measures::MoneyPerAreaPerPeriod:0x00007fbcaefc07e8
+     @magnitude=1.7083333333333333,
+     @unit=Convertable::Units::ComposedUnit.new('Usd/SquareFoot/Month')
+   >
+```
+
+##### Measure Conversions
+
+Measures can be converted to other measures provided a measure:
+
+*provided sf we can convert $/year to $/sf/year*
+
+```ruby
+unit = Convertable::Units::MoneyPerYear
+magnitude = 200.0
+measure = Convertable::Measures::MoneyPerPeriod.new(magnitude, unit)
+
+magnitude = 50.0
+area = Convertable::Measures::Area.new(magnitude, Convertable::Units::SquareFoot)
+measure.to_money_per_area_per_period(area)
+
+=> <Convertable::Measures::MoneyPerAreaPerPeriod:0x00007fc0551720d8
+     @magnitude=4.0,
+     @unit=Convertable::Units::ComposedUnit.new('Usd/SquareFoot/Year')
+   >
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/viewthespace/convertable.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "convertable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/convertable.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "convertable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "convertable"
+  spec.version       = Convertable::VERSION
+  spec.authors       = ["Alex Wheeler"]
+  spec.email         = ["aw@viewthespace.com"]
+
+  spec.summary       = %q{Units of measure made easy.}
+  spec.description   = %q{Convert between units SquareFoot -> SquareMeter and Measures $/SquareFoot/Year -> $/SquareMeter/Month.}
+  spec.homepage      = "https://www.github.com/viewthespace/convertable"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/convertable.rb

@@ -0,0 +1,8 @@
+require "convertable/version"
+require "convertable/measure"
+require "convertable/measures"
+require "convertable/units"
+
+module Convertable
+  # Your code goes here...
+end

data/lib/convertable/measure.rb

@@ -0,0 +1,21 @@
+module Convertable
+  class Measure
+    attr_reader :magnitude, :unit
+
+    def initialize(magnitude, unit)
+      @magnitude = magnitude
+      @unit = unit
+    end
+
+    def in(new_unit)
+      return self if new_unit == unit
+
+      new_magnitude = unit.convert_to(magnitude, new_unit)
+      self.class.new(new_magnitude, new_unit)
+    end
+
+    def ==(other_measure)
+      magnitude == other_measure.magnitude && unit == other_measure.unit
+    end
+  end
+end

data/lib/convertable/measures.rb

@@ -0,0 +1,40 @@
+module Convertable
+  module Measures
+    class Area < Measure
+    end
+
+    class Period < Measure
+    end
+
+    class MoneyPerPeriod < Measure
+      def to_money_per_period(_area)
+        self
+      end
+
+      def to_money_per_area_per_period(area)
+        area_unit = area.unit.to_s
+        currency = self.unit.multiplying_unit
+        period = self.unit.dividing_units[0]
+
+        new_unit = Convertable::Units::ComposedUnit.new("#{currency}/#{area_unit}/#{period}")
+        MoneyPerAreaPerPeriod.new(magnitude / area.magnitude, new_unit)
+      end
+    end
+
+    class MoneyPerAreaPerPeriod < Measure
+      def to_money_per_area_per_period(_area)
+        self
+      end
+
+      def to_money_per_period(area)
+        area_unit = self.unit.dividing_units[0]
+        period = self.unit.dividing_units[1]
+        converted_area = area.in(area_unit)
+
+        new_unit = Convertable::Units::ComposedUnit.new("#{self.unit.multiplying_unit}/#{period}")
+
+        MoneyPerPeriod.new(magnitude * converted_area.magnitude, new_unit)
+      end
+    end
+  end
+end

data/lib/convertable/units.rb

@@ -0,0 +1,124 @@
+module Convertable
+  module Units
+    def self.find(unit)
+      if const_defined?(unit.camelize)
+        const_get(unit.camelize)
+      else
+        raise UnsupportedUnit.new(unit.camelize)
+      end
+    end
+
+    class UnsupportedConversion < StandardError
+    end
+
+    class UnsupportedUnit < StandardError
+    end
+
+    class SimpleUnit
+      def self.to_json
+        name
+      end
+    end
+
+    class SquareFoot < SimpleUnit
+      def self.convert_to(magnitude, new_unit)
+        if new_unit == SquareFoot
+          magnitude
+        elsif new_unit == SquareMeter
+          magnitude / 10.7639
+        else
+          raise UnsupportedConversion
+        end
+      end
+    end
+
+    class SquareMeter < SimpleUnit
+      def self.convert_to(magnitude, new_unit)
+        if new_unit == SquareMeter
+          magnitude
+        elsif new_unit == SquareFoot
+          magnitude * 10.7639
+        else
+          raise UnsupportedConversion
+        end
+      end
+    end
+
+    class Year < SimpleUnit
+      def self.convert_to(magnitude, new_unit)
+        if new_unit == Month
+          magnitude * 12
+        elsif new_unit == Year
+          magnitude
+        else
+          raise UnsupportedConversion
+        end
+      end
+    end
+
+    class Month < SimpleUnit
+      def self.convert_to(magnitude, new_unit)
+        if new_unit == Month
+          magnitude
+        elsif new_unit == Year
+          magnitude / 12
+        else
+          raise UnsupportedConversion
+        end
+      end
+    end
+
+    class Currency < SimpleUnit
+      def self.convert_to(magnitude, new_unit)
+        if new_unit == self
+          magnitude
+        else
+          raise UnsupportedConversion
+        end
+      end
+    end
+
+    class Usd < Currency
+    end
+
+    class Gbp < Currency
+    end
+
+    class ComposedUnit
+      attr_reader :multiplying_unit, :dividing_units
+
+      def initialize(units)
+        @multiplying_unit, *@dividing_units = units.split("/").map { |unit| Convertable::Units.find(unit) }
+      end
+
+      def convert_to(magnitude, new_composed_unit)
+        raise UnsupportedConversion unless new_composed_unit.is_a?(ComposedUnit)
+
+        magnitude * conversion_factor_to(new_composed_unit)
+      end
+
+      def ==(other_composed_unit)
+        multiplying_unit == other_composed_unit.multiplying_unit &&
+          dividing_units == other_composed_unit.dividing_units
+      end
+
+      def to_json
+        name
+      end
+
+      private
+
+      def conversion_factor_to(other_composed_unit)
+        conversion_factor = 1
+
+        conversion_factor *= multiplying_unit.convert_to(1.0, other_composed_unit.multiplying_unit)
+
+        dividing_units.each_with_index do |dividing_unit, index|
+          conversion_factor /= dividing_unit.convert_to(1.0, other_composed_unit.dividing_units[index])
+        end
+
+        conversion_factor
+      end
+    end
+  end
+end

data/lib/convertable/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: convertable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Wheeler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Convert between units SquareFoot -> SquareMeter and Measures $/SquareFoot/Year
+  -> $/SquareMeter/Month.
+email:
+- aw@viewthespace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- convertable.gemspec
+- lib/convertable.rb
+- lib/convertable/measure.rb
+- lib/convertable/measures.rb
+- lib/convertable/units.rb
+- lib/convertable/version.rb
+homepage: https://www.github.com/viewthespace/convertable
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Units of measure made easy.
+test_files: []