sequel-units 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b04f1f3670f5c69a64727468e9061c00859c0de5
-  data.tar.gz: e551ec30fc463e77c51d8f6b0a5001f4243422b2
+  metadata.gz: 5515c1978e06ae6b1bebc2b5201f0321fbc1eb8d
+  data.tar.gz: baa3796f2a314d0669eef73c01fe9422457fd6bf
 SHA512:
-  metadata.gz: 1cf74fb1f20ec3b10410675d6fc43c752308311c960276acc4f71653fb540f04dd21f0df60fb00985c74e59e8789f66c63a6b187880bdf3863600e6bdb673a91
-  data.tar.gz: 5843bf27f62df539937a9b46d80f19cb2b913bac2e68cf66d1a7ba23cfcb22f0149ce53fad2377b72c0cd6b5663c7e3f0fa370842e6cbad6b479ea2e2c984a2a
+  metadata.gz: 55d223bb200ea28b7c73c993787dd07131608a671bd5c34e0f0857f00fd8a979a5ab0f4bd9203185b5ed7190e71dfc79e991cb1856df6c8d65b5e2483179793b
+  data.tar.gz: c1be598f4854a418f34cadbae87dd132a00eedf444f6a35b1eebea1c0a8ec5f5de5ea9225084285bd6cf102b99bef3b9c38570fec51ca0c8394b0ae53f9ef69d

data/README.md

@@ -1,15 +1,20 @@
 # Sequel::Units
 
+![stability-wip](https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg)
+[![Build Status](https://travis-ci.org/AkihikoITOH/sequel-units.svg?branch=master)](https://travis-ci.org/AkihikoITOH/sequel-units)
+[![Gem Version](https://badge.fury.io/rb/sequel-units.svg)](https://badge.fury.io/rb/sequel-units)
+[![Dependency Status](https://gemnasium.com/badges/github.com/AkihikoITOH/sequel-units.svg)](https://gemnasium.com/github.com/AkihikoITOH/sequel-units)
+
 Sequel plugin for working with numeric values with unit.
 
 ## Basic usage
 
-Let's say you have a Sequel model `Product` which has a numeric attribute called `quantity` with unit (e.g. "10 kg").
+Let's say you have a Sequel model `Order` which has a numeric attribute called `quantity` with unit (e.g. "10 kg").
 
 Your migration file would look like
 
 ```ruby
-DB.create_table(:products) do
+DB.create_table(:orders) do
   primary_key :id
   column :quantity_scalar, Integer # "{attribute}_scalar" which stands for the scalar value ("10" in this case).
   column :quantity_unit, String # "{attribute}_unit" which stands for the unit ("kg" in this case).
@@ -19,30 +24,72 @@ end
 Your model definition then looks like
 
 ```ruby
-class Product < Sequel::Model
+class Order < Sequel::Model
   plugin :units
   
   value_with_unit :quantity
 end
 ```
 
-Now instances of the model Product have an instance method `#quantity`.
+Now instances of the model Order have an instance method `#quantity`.
 
 ```ruby
-product = Product.new(quantity_scalar: 10, quantity_unit: 'kg')
-# => #<Product @values={:quantity_scalar=>10, :quantity_unit=>"kg"}>
-quantity = product.quantity
+order = Order.new(quantity_scalar: 10, quantity_unit: 'kg')
+# => #<Order @values={:quantity_scalar=>10, :quantity_unit=>"kg"}>
+order.quantity
 # => 10 kg
+order.quantity(in_unit: 'gram')
+# => 10000 gram
 ```
 
-Note `product.quantity` here is an instance of `RubyUnits::Unit`, so you can get the original scalar value or the unit 
+Note `order.quantity` here is an instance of `RubyUnits::Unit`, so you can get the original scalar value or the unit 
 by calling methods `#scalar` or `#units`. 
 See [Ruby Units](https://github.com/olbrich/ruby-units) for more details.
 
 ```ruby
-quantity.scalar
+order.quantity.scalar
 # => 10
-quantity.units
+order.quantity.units
 # => "kg"
 ```
 
+### Custom name for scalar and unit
+
+You can specify your own favorite names for scalar and unit.
+
+```ruby
+class Order < Sequel::Model
+  plugin :units
+  
+  value_with_unit :quantity, scalar: :my_scalar, unit: :my_unit
+end
+
+order = Order.new(my_scalar: 10, my_unit: 'kg')
+# => #<Order @values={:my_scalar=>10, :my_unit=>"kg"}>
+order.quantity
+# => 10 kg
+```
+
+### Inverse unit
+
+Let's say you have a Sequel model `Product`.
+You might want to have price with unit like "5 USD / kg" (price per weight),
+but want to store the weight unit as "kg" instead of "1/kg", separate from the currency.
+
+```ruby
+class Product < Sequel::Model
+  plugin :units
+  
+  value_with_unit :price, inverse_unit: :weight_unit
+end
+
+product = Product.new(price_scalar: 5, price_unit: 'USD', weight_unit: 'kg')
+# => #<Product @values={:price_scalar=>5, :price_unit=>"USD", :weight_unit=>"kg"}>
+product.price
+# => 5 USD/kg
+```
+
+## TODO
+
+- [ ] Specify attributes of associated models.
+- [ ] Define calculations with multiple attributes using [Unit Math](https://github.com/olbrich/ruby-units#unit-math)

data/lib/sequel/plugins/units/class_methods.rb

@@ -2,11 +2,14 @@
 
 module Sequel::Plugins::Units
   module ClassMethods
-    def value_with_unit(method_name)
-      define_method method_name do
-        scalar = _validate_scalar(send("#{method_name}_scalar".to_sym))
-        unit = _validate_unit(send("#{method_name}_unit".to_sym))
-        Unit.new("#{scalar} #{unit}")
+    def value_with_unit(method_name, scalar: nil, unit: nil, inverse_unit: nil)
+      define_method method_name do |in_unit: nil|
+        _generate_units(
+          scalar || "#{method_name}_scalar".to_sym,
+          unit || "#{method_name}_unit".to_sym,
+          inverse_unit,
+          in_unit
+        )
       end
     end
   end

data/lib/sequel/plugins/units/instance_methods.rb

@@ -4,6 +4,14 @@ module Sequel::Plugins::Units
   module InstanceMethods
     private
 
+    def _generate_units(scalar_method, unit_method, inverse_unit_method, target_unit)
+      scalar = _validate_scalar(send(scalar_method))
+      unit = _validate_unit(send(unit_method))
+      inverse_unit = inverse_unit_method ? "#{send(inverse_unit_method)}^-1" : nil
+      new_units = Unit.new("#{scalar} #{unit} #{inverse_unit}".strip)
+      target_unit ? new_units.convert_to(target_unit) : new_units
+    end
+
     def _validate_scalar(scalar)
       raise ArgumentError, "#{scalar} is not a numeric value" unless scalar.is_a?(Numeric)
       scalar

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-units
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Akihiko Itoh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-14 00:00:00.000000000 Z
+date: 2017-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel