lite-measurements 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dce6204f52df08a3479f361d7f8612d71205c9d80ebda70e7417a35f7f296e3e
+  data.tar.gz: ccbc500e250c208a001959d6724350d4465efff254e9510d9efe072b2b984ccd
+SHA512:
+  metadata.gz: 7364280b98ab082c6c9a4ebb7876d6188bf4126c039ab5eb59a28535d25b2ef9d323875d8080268c4b29c32d71b67577a5523dedf512d9180ab51cf41f5ef3ad
+  data.tar.gz: 74893ab678f85e53957e03ab6e3f59e308470b3282148ec2baf5edc7bf8182e7fec7aaefced5595c1e022bde09db67c4fc7b4b3fc1e2449b999dc90115a9b386

data/.fasterer.yml

@@ -0,0 +1,19 @@
+speedups:
+  block_vs_symbol_to_proc: true
+  each_with_index_vs_while: false
+  fetch_with_argument_vs_block: true
+  for_loop_vs_each: true
+  getter_vs_attr_reader: true
+  gsub_vs_tr: true
+  hash_merge_bang_vs_hash_brackets: true
+  keys_each_vs_each_key: true
+  map_flatten_vs_flat_map: true
+  module_eval: true
+  proc_call_vs_yield: true
+  rescue_vs_respond_to: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  select_last_vs_reverse_detect: true
+  setter_vs_attr_writer: true
+  shuffle_first_vs_sample: true
+  sort_vs_sort_by: true

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,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+LineLength:
+  Max: 100
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/**/*'
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/**/*'
+    - '*.gemspec'
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.5
+- 2.6
+- ruby-head
+matrix:
+  fast_finish: true
+  allow_failures:
+  - rvm: ruby-head
+before_install:
+- gem update --system
+- gem install bundler
+install:
+- bundle install --jobs=3 --retry=3
+script:
+- bundle exec rspec
+- bundle exec rubocop
+- bundle exec fasterer
+notifications:
+  email: false
+  slack:
+    secure: kcnsiwyN/hdAvi6qcR8EtDAp7WB0LCIVTVvewGbiN++k7AhZjpvjxjGD8k5IkZie3EcRWQKrA1MoUrhnro85YzYI6UhAx+rUE2fyZFoMV9B1dfQC0Hk/jGM7ZKelipS1yvEAECrpiAb/lifJyQINHQU+GolgHZ7mzfCA3M3MOxq0u1tPVyt6OaPk2r8tDQARbE3WBba3Cx9jUjxoFhS0qCY8/U7Z0P0p6OCpgJQSQiJ+qQ483jbzV4Guxe295MmlaZvrFhgomj5Wd8K1QLfQUZ60mYjCqUUvsA51hCL16H+kSdi+syhTp9KmJJP6lPA+TJN74BGfnoz7Jwhqyi303KDao/iedcxEhOqCpzyM+OijrfARrvvDRikIzfzt074ZOcl7ujm7KZDMF18TJLGYYp9ZU2KjFq9UL3ZEM72oH33U9NaZj2wf3HB3vxNNNfB4ltIAwcucAZXWoQfTrbf03bZx+bvaV7o3+H4+913gbqdafB+NWYtEddO4qBRTV7ashk+8Bbsd5AdCUbXF8OoMQOywm9BJ9+JavgQdugqwuxX6bCoZp7chhYhJ7vhrvGg+3ateuYqfjbW2chUnooNIEObwToeqWxuRYtSQqZb9tdpbmIYiQhg3jjdtVcEWvEu/dciPgRGmubefgO6TjsTnyv0Ka43PgRT3sq5iIsjlTmw=

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2019-07-19
+### Added
+- Initial project version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at j.gomez@drexed.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lite-measurements.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    lite-measurements (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    builder (3.2.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    fasterer (0.6.0)
+      colorize (~> 0.7)
+      ruby_parser (>= 3.13.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.13.1)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.12.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  fasterer
+  generator_spec
+  lite-measurements!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Juan Gomez
+
+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,73 @@
+# Lite::Measurements
+
+[![Gem Version](https://badge.fury.io/rb/lite-measurements.svg)](http://badge.fury.io/rb/lite-measurements)
+[![Build Status](https://travis-ci.org/drexed/lite-measurements.svg?branch=master)](https://travis-ci.org/drexed/lite-measurements)
+
+Lite::Measurements is a library for converting measurements to different unit sizes or types.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lite-measurements'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lite-measurements
+
+## Table of Contents
+
+* [Configurations](#configurations)
+* [Measurements](#measurements)
+* [Monkey patches](#monkey-patches)
+
+## Configurations
+
+`rails g lite:measurements:install` will generate the following file:
+`../config/initalizers/lite-measurements.rb`
+
+```ruby
+Lite::Measurements.configure do |config|
+  config.monkey_patches = true
+end
+```
+
+## Measurements
+
+* [Digital Storage](https://github.com/drexed/lite-ruby/blob/master/docs/DIGITAL_STORAGE.md)
+* [Length](https://github.com/drexed/lite-ruby/blob/master/docs/LENGTH.md)
+* [Mass](https://github.com/drexed/lite-ruby/blob/master/docs/MASS.md)
+* [Temperature](https://github.com/drexed/lite-ruby/blob/master/docs/TEMPERATURE.md)
+* [Time](https://github.com/drexed/lite-ruby/blob/master/docs/TIME.md)
+
+## Monkey patches
+
+Including monkey patches will give you `Numeric` access to conversions.
+
+```ruby
+2.convert_temperature(from: :fahrenheit, to: :celsius) #=> -16.666666666666668
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/lite-measurements. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lite::Measurements project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lite-measurements/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lite/measurements'
+
+# 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/docs/DIGITAL_STORAGE.md

@@ -0,0 +1,22 @@
+# Digital Storage
+
+Type | Keys
+--- | ---
+Units | `:bytes`, `:kilobytes`, `:megabytes`, `:gigabytes`, `:terabytes`, `:petabytes`, `:exabytes`
+
+Option | Type | Default
+--- | --- | ---
+from, to | symbol | ---
+
+```ruby
+klass = Lite::Measurements::DigitalStorage.new(2)
+klass = klass.convert(from: :bytes, to: :kilobytes)
+
+# - or -
+
+Lite::Measurements::DigitalStorage.convert(2, from: :megabytes, to: :bytes)
+
+# - or -
+
+2.convert_digital_storage(from: :terabytes, to: :petabytes)
+```

data/docs/LENGTH.md

@@ -0,0 +1,23 @@
+# Length
+
+Type | Keys
+--- | ---
+Imperical | `:inches`, `:feet`, `:yards`, `:miles`, `:nautical_miles`
+Metric | `:micrometers`, `:millimeters`, `:centimeters`, `:decimeters`, `:meters`, `:dekameters`, `:hectometers`, `:kilometers`
+
+Option | Type | Default
+--- | --- | ---
+from, to | symbol | ---
+
+```ruby
+klass = Lite::Measurements::Length.new(2)
+klass = klass.convert(from: :inches, to: :yards)
+
+# - or -
+
+Lite::Measurements::Length.convert(2, from: :meters, to: :feet)
+
+# - or -
+
+2.convert_length(from: :miles, to: :millimeters)
+```

data/docs/MASS.md

@@ -0,0 +1,23 @@
+# Mass
+
+Type | Keys
+--- | ---
+Imperical | `:ounces`, `:pounds`, `:stones`, `:us_tons`, `:imperial_tons`
+Metric | `:micrograms`, `:milligrams`, `:centigrams`, `:decigrams`, `:grams`, `:dekagrams`, `:hectograms`, `:kilograms`, `:metric_tons`
+
+Option | Type | Default
+--- | --- | ---
+from, to | symbol | ---
+
+```ruby
+klass = Lite::Measurements::Mass.new(2)
+klass = klass.convert(from: :ounces, to: :pounds)
+
+# - or -
+
+Lite::Measurements::Mass.convert(2, from: :kilograms, to: :us_tons)
+
+# - or -
+
+2.convert_mass(from: :pounds, to: :micrograms)
+```

data/docs/TEMPERATURE.md

@@ -0,0 +1,22 @@
+# Temperature
+
+Type | Keys
+--- | ---
+Units | `:celsius`, `:fahrenheit`, `:kelvin`
+
+Option | Type | Default
+--- | --- | ---
+from, to | symbol | ---
+
+```ruby
+klass = Lite::Measurements::Temperature.new(2)
+klass = klass.convert(from: :fahrenheit, to: :celsius)
+
+# - or -
+
+Lite::Measurements::Temperature.convert(2, from: :celsius, to: :kelvin)
+
+# - or -
+
+2.convert_temperature(from: :kelvin, to: :fahrenheit)
+```

data/docs/TIME.md

@@ -0,0 +1,22 @@
+# Time
+
+Type | Keys
+--- | ---
+Units | `:milliseconds`, `:seconds`, `:minutes`, `:hours`, `:days`, `:weeks`, `:years`, `:decades`, `:centuries`, `:millenniums`
+
+Option | Type | Default
+--- | --- | ---
+from, to | symbol | ---
+
+```ruby
+klass = Lite::Measurements::Time.new(2)
+klass = klass.convert(from: :seconds, to: :minutes)
+
+# - or -
+
+Lite::Measurements::Time.convert(2, from: :centuries, to: :decades)
+
+# - or -
+
+2.convert_time(from: :hours, to: :millenniums)
+```

data/lib/generators/lite/measurements/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Lite
+  module Measurements
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        copy_file('install.rb', 'config/initializers/lite-measurements.rb')
+      end
+
+    end
+  end
+end

data/lib/generators/lite/measurements/templates/install.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Lite::Measurements.configure do |config|
+  config.monkey_patches = true
+end

data/lib/lite/measurements/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    class Base
+
+      attr_accessor :amount
+
+      def initialize(amount)
+        @amount = amount
+      end
+
+      class << self
+
+        def convert(amount, from:, to:)
+          klass = new(amount)
+          klass.convert(from: from, to: to)
+        end
+
+      end
+
+      private
+
+      def assert_all_valid_keys!(from, to, valid_keys)
+        [from, to].each { |key| assert_valid_keys!(key, valid_keys) }
+      end
+
+      # rubocop:disable Style/GuardClause
+      def assert_valid_keys!(key, valid_keys)
+        if valid_keys.empty?
+          raise ArgumentError, 'Missing key: conversion key must be provided'
+        elsif !valid_keys.include?(key)
+          raise ArgumentError,
+                "Invalid key: #{key.inspect}." \
+                "Allowed keys are: #{valid_keys.map(&:inspect).join(', ')}"
+        end
+      end
+      # rubocop:enable Style/GuardClause
+
+    end
+  end
+end

data/lib/lite/measurements/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+
+    class Configuration
+
+      attr_accessor :monkey_patches
+
+      def initialize
+        @monkey_patches = true
+      end
+
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+  end
+end

data/lib/lite/measurements/digital_storage.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    class DigitalStorage < Lite::Measurements::Base
+
+      include Lite::Measurements::Helpers::ShiftHelper
+
+      DIGITAL_STORAGE_UNITS ||= {
+        bytes: 1.0, kilobytes: 1024.0, megabytes: 1024.0**2, gigabytes: 1024.0**3,
+        terabytes: 1024.0**4, petabytes: 1024.05**5, exabytes: 1024**6
+      }.freeze
+
+      def convert(from:, to:)
+        assert_all_valid_keys!(from, to, DIGITAL_STORAGE_UNITS.keys)
+        return amount if equal_units?(from, to)
+
+        shift_units(amount, type: DIGITAL_STORAGE_UNITS, from: from, to: to)
+      end
+
+    end
+  end
+end

data/lib/lite/measurements/helpers/conversion_helper.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    module Helpers
+      module ConversionHelper
+
+        private
+
+        def all_keys
+          [imperical_keys, metric_keys].flatten
+        end
+
+        # rubocop:disable Metrics/LineLength
+        def convert_to_imperical_units(units, from: nil, convert_to:, convert_from:, to: nil)
+          units = shift_units(units, type: klass::METRIC_UNITS, from: from, to: convert_to)
+          shift_units(units / klass::CONVERTER, type: klass::IMPERICAL_UNITS, from: convert_from, to: to)
+        end
+
+        def convert_to_metric_units(units, from: nil, convert_to:, convert_from:, to: nil)
+          units = shift_units(units, type: klass::IMPERICAL_UNITS, from: from, to: convert_to)
+          shift_units(units * klass::CONVERTER, type: klass::METRIC_UNITS, from: convert_from, to: to)
+        end
+        # rubocop:enable Metrics/LineLength
+
+        def convert_to_imperical_units?(from, to)
+          metric_keys.include?(from) && imperical_keys.include?(to)
+        end
+
+        def convert_to_metric_units?(from, to)
+          imperical_keys.include?(from) && metric_keys.include?(to)
+        end
+
+        def klass
+          self.class
+        end
+
+        def imperical_keys
+          @imperical_keys ||= klass::IMPERICAL_UNITS.keys
+        end
+
+        def metric_keys
+          @metric_keys ||= klass::METRIC_UNITS.keys
+        end
+
+        def shift_between_imperical_units?(from, to)
+          imperical_keys.include?(from) && imperical_keys.include?(to)
+        end
+
+        def shift_between_metric_units?(from, to)
+          metric_keys.include?(from) && metric_keys.include?(to)
+        end
+
+      end
+    end
+  end
+end

data/lib/lite/measurements/helpers/shift_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    module Helpers
+      module ShiftHelper
+
+        private
+
+        def change_units(units, type:, from: nil, to: nil)
+          if from
+            units * type[from]
+          else
+            units / type[to]
+          end
+        end
+
+        def equal_units?(from, to)
+          from == to
+        end
+
+        def shift_units(units, type:, from: nil, to: nil)
+          units = change_units(units, type: type, from: from)
+          change_units(units, type: type, to: to)
+        end
+
+      end
+    end
+  end
+end

data/lib/lite/measurements/length.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    class Length < Lite::Measurements::Base
+
+      include Lite::Measurements::Helpers::ConversionHelper
+      include Lite::Measurements::Helpers::ShiftHelper
+
+      CONVERTER ||= 0.0254
+
+      IMPERICAL_UNITS ||= {
+        inches: 1.0, feet: 12.0, yards: 36.0, miles: 63_360.0, nautical_miles: 72_913.386
+      }.freeze
+      METRIC_UNITS ||= {
+        micrometers: 0.000001, millimeters: 0.001, centimeters: 0.01, decimeters: 0.1, meters: 1.0,
+        dekameters: 10.0, hectometers: 100.0, kilometers: 1_000.0
+      }.freeze
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
+      def convert(from:, to:)
+        assert_all_valid_keys!(from, to, all_keys)
+
+        if equal_units?(from, to)
+          amount
+        elsif shift_between_imperical_units?(from, to)
+          shift_units(amount, type: IMPERICAL_UNITS, from: from, to: to)
+        elsif shift_between_metric_units?(from, to)
+          shift_units(amount, type: METRIC_UNITS, from: from, to: to)
+        elsif convert_to_metric_units?(from, to)
+          convert_to_metric_units(amount, from: from, convert_to: :inches, convert_from: :meters, to: to)
+        else
+          convert_to_imperical_units(amount, from: from, convert_to: :meters, convert_from: :inches, to: to)
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
+
+    end
+  end
+end

data/lib/lite/measurements/mass.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    class Mass < Lite::Measurements::Base
+
+      include Lite::Measurements::Helpers::ConversionHelper
+      include Lite::Measurements::Helpers::ShiftHelper
+
+      CONVERTER ||= 28.349523125
+
+      IMPERICAL_UNITS ||= {
+        ounces: 1.0, pounds: 16.0, stones: 224.0, us_tons: 32_000.0, imperial_tons: 35_840.0
+      }.freeze
+      METRIC_UNITS ||= {
+        micrograms: 0.000001, milligrams: 0.001, centigrams: 0.01, decigrams: 0.1, grams: 1.0,
+        dekagrams: 10.0, hectograms: 100.0, kilograms: 1_000.0, metric_tons: 1_000_000.0
+      }.freeze
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
+      def convert(from:, to:)
+        assert_all_valid_keys!(from, to, all_keys)
+
+        if equal_units?(from, to)
+          amount
+        elsif shift_between_imperical_units?(from, to)
+          shift_units(amount, type: IMPERICAL_UNITS, from: from, to: to)
+        elsif shift_between_metric_units?(from, to)
+          shift_units(amount, type: METRIC_UNITS, from: from, to: to)
+        elsif convert_to_metric_units?(from, to)
+          convert_to_metric_units(amount, from: from, convert_to: :ounces, convert_from: :grams, to: to)
+        else
+          convert_to_imperical_units(amount, from: from, convert_to: :grams, convert_from: :ounces, to: to)
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
+
+    end
+  end
+end

data/lib/lite/measurements/monkey_patches.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Numeric
+
+  {
+    digital_storage: Lite::Measurements::DigitalStorage,
+    length: Lite::Measurements::Length,
+    mass: Lite::Measurements::Mass,
+    temperature: Lite::Measurements::Temperature,
+    time: Lite::Measurements::Time
+  }.each do |name, klass|
+    define_method("convert_#{name}") do |from:, to:|
+      klass.convert(self, from: from, to: to)
+    end
+  end
+
+end

data/lib/lite/measurements/temperature.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    class Temperature < Lite::Measurements::Base
+
+      C_FREEZING_POINT ||= 5.0 / 9.0
+      C_INVERSED_POINT ||= 9.0 / 5.0
+      F_FREEZING_POINT ||= 32.0
+      K_FREEZING_POINT ||= 273.15
+
+      VALID_KEYS ||= %i[
+        celsius fahrenheit kelvin
+      ].freeze
+
+      def convert(from:, to:)
+        assert_all_valid_keys!(from, to, VALID_KEYS)
+
+        case to
+        when from then amount
+        when :celsius then send("celsius_from_#{from}")
+        when :fahrenheit then send("fahrenheit_from_#{from}")
+        when :kelvin then send("kelvin_from_#{from}")
+        end
+      end
+
+      private
+
+      def celsius_from_fahrenheit
+        (amount - F_FREEZING_POINT) * C_FREEZING_POINT
+      end
+
+      def celsius_from_kelvin
+        amount - K_FREEZING_POINT
+      end
+
+      def fahrenheit_from_celsius
+        (amount * C_INVERSED_POINT) + F_FREEZING_POINT
+      end
+
+      def fahrenheit_from_kelvin
+        celsius_from_kelvin * C_INVERSED_POINT + F_FREEZING_POINT
+      end
+
+      def kelvin_from_celsius
+        amount + K_FREEZING_POINT
+      end
+
+      def kelvin_from_fahrenheit
+        celsius_from_fahrenheit + K_FREEZING_POINT
+      end
+
+    end
+  end
+end

data/lib/lite/measurements/time.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+    class Time < Lite::Measurements::Base
+
+      include Lite::Measurements::Helpers::ShiftHelper
+
+      TIME_UNITS ||= {
+        milliseconds: 0.001, seconds: 1.0, minutes: 60.0, hours: 3600.0, days: 86_400.0,
+        weeks: 604_800.0, years: 31_557_600.0, decades: 31_557_600.0 * 10.0,
+        centuries: 31_557_600.0 * 100.0, millenniums: 31_557_600.0 * 1_000.0
+      }.freeze
+
+      def convert(from:, to:)
+        assert_all_valid_keys!(from, to, TIME_UNITS.keys)
+        return amount if equal_units?(from, to)
+
+        shift_units(amount, type: TIME_UNITS, from: from, to: to)
+      end
+
+    end
+  end
+end

data/lib/lite/measurements/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Lite
+  module Measurements
+
+    VERSION ||= '1.0.0'
+
+  end
+end

data/lib/lite/measurements.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'lite/measurements/version'
+require 'lite/measurements/configuration'
+require 'lite/measurements/helpers/conversion_helper'
+
+%w[conversion shift].each do |filename|
+  require "lite/measurements/helpers/#{filename}_helper"
+end
+
+%w[base digital_storage length mass temperature time].each do |filename|
+  require "lite/measurements/#{filename}"
+end
+
+require 'lite/measurements/monkey_patches' if Lite::Measurements.configuration.monkey_patches
+
+require 'generators/lite/measurements/install_generator'

data/lite-measurements.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lite/measurements/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'lite-measurements'
+  spec.version = Lite::Measurements::VERSION
+  spec.authors = ['Juan Gomez']
+  spec.email = %w[j.gomez@drexed.com]
+
+  spec.summary = 'Convert measurements to different unit sizes or types'
+  spec.homepage = 'http://drexed.github.io/lite-measurements'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata.merge(
+      'allowed_push_host' => 'https://rubygems.org',
+      'changelog_uri' => 'https://github.com/drexed/lite-measurements/blob/master/CHANGELOG.md',
+      'homepage_uri' => spec.homepage,
+      'source_code_uri' => 'https://github.com/drexed/lite-measurements'
+    )
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the MeasurementsGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 = %w[lib]
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: lite-measurements
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: fasterer
+  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: generator_spec
+  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: '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: rubocop
+  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: rubocop-performance
+  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: rubocop-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'
+description: 
+email:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".fasterer.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- _config.yml
+- bin/console
+- bin/setup
+- docs/DIGITAL_STORAGE.md
+- docs/LENGTH.md
+- docs/MASS.md
+- docs/TEMPERATURE.md
+- docs/TIME.md
+- lib/generators/lite/measurements/install_generator.rb
+- lib/generators/lite/measurements/templates/install.rb
+- lib/lite/measurements.rb
+- lib/lite/measurements/.DS_Store
+- lib/lite/measurements/base.rb
+- lib/lite/measurements/configuration.rb
+- lib/lite/measurements/digital_storage.rb
+- lib/lite/measurements/helpers/conversion_helper.rb
+- lib/lite/measurements/helpers/shift_helper.rb
+- lib/lite/measurements/length.rb
+- lib/lite/measurements/mass.rb
+- lib/lite/measurements/monkey_patches.rb
+- lib/lite/measurements/temperature.rb
+- lib/lite/measurements/time.rb
+- lib/lite/measurements/version.rb
+- lite-measurements.gemspec
+homepage: http://drexed.github.io/lite-measurements
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Convert measurements to different unit sizes or types
+test_files: []