unite_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec93ad7597fc5baf4922ea3e63a6050f3b3b0f23
+  data.tar.gz: 415f40c6eb1d7972dd44a99469b8276b61074b1a
+SHA512:
+  metadata.gz: 630f4b61522c0ead33805d7b13b09cc3c04fef0b223709113ce17724088b48f94baf0f0de559e2daaf542f2610e68d28bfd247a4bbf102c6bd7689d4e6e7a974
+  data.tar.gz: fb8813c51786da75c5936cbc00a4972f1800d1a4e14afcf37b58d4f131fe711c45675d97cf1ba522b50db2e0535c63feebec7b9b9b4f50c4a3571038ba3490d3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Marcelo
+
+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,54 @@
+
+# unite_rb
+
+Brings units to numeric variables in Ruby.
+
+## Getting started
+
+Install gem:
+
+```
+gem install unite_rb
+```
+
+Usage:
+
+```ruby
+require "unite_rb"
+
+s = UniteRb::Scope.new
+s.dimensions  = [:m, :km, :min, :s]
+
+# Define relations between units using 'add', 'sub', 'mul', 'div'
+s.equate(:km, s.mul(:m, 1000))
+s.equate(:s, s.div(:min, 60))
+
+dist_to_iss = s.var(408, :km)
+dist_to_iss2 = s.var(408_000, :m)
+time_to_sun = s.var(4, :min)
+
+# Comparisons
+dist_to_iss == dist_to_iss2 # => true
+dist_to_iss > dist_to_iss2  # => false
+dist_to_iss < time_to_sun # => UniteRb::UnrelatedDimensions: No relation exists between dimensions km and min
+
+# Arithmetic
+puts dist_to_iss + dist_to_iss2 # => 816 km
+
+# Convert
+time_to_sun_in_s = time_to_sun.convert(:s)
+time_to_sun_in_s.dim  # => s
+puts time_to_sun_in_s # => 240 s
+```
+
+## To be done
+
+- Allow dimensions to be multiplied to generate new dimensions (e.g. `s.div(:m, :s)`)
+- Enable complex relations between units, for example:
+  ```ruby
+  s = UniteRb::Scope.new
+  s.dimensions  = [:C, :F]
+
+  s.equate(:C, s.mul(5/9, s.sub(:F, 32))) # C = 5/9(F - 32)
+  ```
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: unite_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Pereira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-03 00:00:00.000000000 Z
+dependencies:
+- !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: |-
+  This module enables attaching units to numeric variables. Relations between units can be specified,
+  which furthers allow variables with different units to be compared, and arithmetic operations to be performed on them.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+homepage: https://github.com/marcper/unite_rb
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/marcper/unite_rb
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Bring units to Ruby variables
+test_files: []