smerp-common 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c8ba3a20a3dc040be402897ca0ecc74f140388ceb426ca6c1ea85123df40fc3
+  data.tar.gz: 153946e9f44cefdd2f1904dfea72bdda168bc17a1736313b6c2c9f5aa43e2b93
+SHA512:
+  metadata.gz: 9ba1252b8545157d8018406d8b6524087412dd1c415af08c330f3d5595461dd83b8c1892f6d361df1d7142e75cbd081307e57103d76b579c19d623823d22c90e
+  data.tar.gz: f39883f0b8c80587da4bf0fb8fbe590e3a99727063d673ed672882de218f5faad39fa42dde00dde92f9e05578dffe1a2cc0bf60c090d5028a4211d58ac038d33

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in smerp-common.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    smerp-common (0.1.0)
+      teLogger
+      toolrack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base58 (0.2.3)
+    devops_assist (0.3.0)
+      git_cli
+      git_cli_prompt
+      gvcs
+      teLogger
+      toolrack
+      tty-prompt
+    diff-lcs (1.5.0)
+    git_cli (0.10.0)
+      gvcs
+      ptools (~> 1.4.0)
+      teLogger
+      toolrack
+    git_cli_prompt (0.3.1)
+      teLogger
+      toolrack
+      tty-prompt
+    gvcs (0.1.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    ptools (1.4.2)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    teLogger (0.2.0)
+    toolrack (0.19.1)
+      base58
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devops_assist
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  smerp-common!
+
+BUNDLED WITH
+   2.2.28

data/README.md

@@ -0,0 +1,35 @@
+# Smerp::Common
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smerp/common`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smerp-common'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install smerp-common
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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]/smerp-common.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "smerp/common"
+
+# 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/lib/smerp/common/currency_conversion.rb

@@ -0,0 +1,125 @@
+
+
+module Smerp
+  module Common
+    module CurrencyConversion
+
+      class CurrencyConversionError < StandardError; end
+
+      class ConversionContext
+        include TR::CondUtils
+
+        attr_accessor :from_currency, :to_currency
+
+        def initialize(value)
+          @value = value
+        end
+
+        def from(bc)
+          @from_currency = bc 
+          self
+        end
+
+        def to(tc)
+          @to_currency = tc
+
+          @from_currency = CConverter.instance.home_currency if is_empty?(@from_currency)
+
+          if CConverter.instance.is_home_currency?(@from_currency)
+            rate = CConverter.instance.rate(@to_currency)
+            @value * rate
+          elsif CConverter.instance.is_home_currency?(@to_currency)
+            rate = CConverter.instance.rate(@from_currency)
+            @value / rate
+          else
+
+            raise CurrencyConversionError, "From currency '#{@from_currency}' rate is not defined" if not CConverter.instance.is_rate_defined?(@from_currency)
+            raise CurrencyConversionError, "To currency '#{@to_currency}' rate is not defined" if not CConverter.instance.is_rate_defined?(@to_currency)
+
+            # both from and to is not home currency
+            # use local currency as intermediary
+            hc = CConverter.instance.home_currency
+            fcc = ConversionContext.new(@value) 
+            mv = fcc.from(@from_currency).to(hc)
+
+            tcc = ConversionContext.new(mv)
+            tcc.from(hc).to(@to_currency)
+
+          end
+
+        end
+      end
+
+      class CConverter
+        include Singleton
+        include TR::CondUtils
+
+        attr_accessor :home_currency
+
+        def conversion=(val)
+          raise CurrencyConversionError, "Home currency must set first" if is_empty?(@home_currency)
+          raise CurrencyConversionError, "Hash is expected" if not val.is_a?(Hash)
+
+          val.each do |k,v|
+            v = 1 if is_empty?(v)
+            rate_table[k] = v.to_f
+          end
+        end
+
+        def rate(currency)
+          rate = rate_table[currency]
+          rate = 1.0 if is_empty?(rate)
+          rate
+        end
+
+        def is_rate_defined?(currency)
+          not_empty?(rate_table[currency])
+        end
+
+        def set_rate_table(hash)
+          @rate = hash if not hash.nil?
+        end
+
+        def is_home_currency?(sym)
+          @home_currency == sym
+        end
+
+        private
+        def rate_table
+          if @rate.nil?
+            @rate = {}
+          end
+          @rate
+        end
+
+      end # Cconverter
+
+      module CurrencyUtils
+
+        def cconvert
+          ConversionContext.new(self.to_f)
+        end
+
+        def to_other_currency(country)
+          self * CurrencyConversion::CConverter.instance.rate(country)
+        end
+
+        def to_home_currency(country)
+          self / CurrencyConversion::CConverter.instance.rate(country)
+        end
+
+
+      end
+      
+    end
+  end
+end
+
+class Integer
+  include Smerp::Common::CurrencyConversion::CurrencyUtils
+end
+
+class Float
+  include Smerp::Common::CurrencyConversion::CurrencyUtils
+end
+

data/lib/smerp/common/fin_utils.rb

@@ -0,0 +1,253 @@
+
+
+module Smerp
+  module Common
+    
+    module FinUtils
+
+      ## 
+      # Number Representation
+      # A integer/decimal/bigdecimal can be a raw value or a percentage value
+      #
+      module NumberRep
+        attr_accessor :type, :value
+      end
+      class RawValue 
+        include NumberRep
+
+        def initialize(value, type)
+          @value = value
+          @type = type
+        end
+
+        def is_percent?
+          false
+        end
+        alias_method :is_percentage?, :is_percent?
+
+        def is_value?
+          true
+        end
+
+        def rep_value
+          case @type
+          when :int
+            @value.to_i 
+          when :float, :bigDec
+            @value.to_f
+          else
+            @value
+          end
+        end
+      end
+
+      class Percent
+        include NumberRep
+        def initialize(value)
+          @type = :percent
+          @value = value
+        end
+
+        def is_percent?
+          true
+        end
+        alias_method :is_percentage?, :is_percent?
+
+        def is_value?
+          false
+        end
+        
+        def rep_value
+          @value / 100.0
+        end
+      end
+      ## 
+      # End Number Representation
+      ##
+
+      ## 
+      # Start mixin methods for included class
+      # Designed to be included into class
+      # - Integer
+      # - Float
+      # - BigDecimal
+      #
+      def percentage_equals?(percent)
+        if is_empty?(percent)
+          false
+        else
+          if percent.is_percent?
+            self.send(:percent).rep_value == percent.rep_value
+          else
+            false
+          end
+        end
+      end
+
+      def percent
+        Percent.new(self.to_f)
+      end
+
+      def value
+        case self
+        when Integer
+          RawValue.new(self.to_f, :int)
+        when Float
+          RawValue.new(self.to_f, :float)
+        when BigDecimal
+          RawValue.new(self.to_f, :bigDec)
+        else
+          raise FinUtilError, "Unsupported type '#{self.class}'"
+        end
+      end
+
+      def percent_of(val, rounding = 0)
+        vv = self.to_f / val.to_f * 100.0
+        if rounding > 0
+          vv.round(rounding)
+        else
+          vv
+        end
+      end
+
+      ## End mixin methods
+
+
+      # 
+      # Markup is % from cost
+      #
+      module Markup
+        include TR::CondUtils
+
+        def markup(percentage)
+          val = self.to_f
+
+          case percentage
+          when NumberRep
+            if percentage.is_percentage?
+              res = val * (1+percentage.rep_value) 
+            elsif percentage.is_value?
+              res = val + percentage.rep_value
+            else
+              res = val + percentage.to_i
+            end
+          else
+            res = val + percentage.to_i
+          end
+
+          res
+        end
+
+        def markup_percentage_from_base(cost)
+          cost = cost.to_f
+          price = self.to_f
+          per = ((price - cost) / cost) * 100.0
+          per
+        end
+
+      end # markup
+
+      # 
+      # Margin is % from price
+      #
+      module Margin
+        include TR::CondUtils
+
+        def margin(percentage)
+          val = self.to_f
+
+          case percentage
+          when NumberRep
+            if percentage.is_percentage?
+              res = val/(1-percentage.rep_value)
+            elsif percentage.is_value?
+              res = val+percentage.rep_value
+            else
+              res = val + percentage.to_i
+            end
+          else
+            res = val + percentage.to_i
+          end
+
+          res
+        end
+
+        def margin_percentage_from_base(cost)
+          cost = cost.to_f
+          price = self.to_f
+          per = ((price - cost) / price) * 100.0
+          per
+        end
+
+      end # margin 
+
+      ## 
+      # Rounding info
+      ##
+      class RoundingInfo
+        attr_accessor :original_value, :rounding_param, :rounded_value
+      end
+      # make the rounding operation more humanize
+      module RoundingHelper
+
+        #include TeLogger::TeLogHelper
+        #teLogger_tag :rounding
+
+        def round_to_nearest(val = 0)
+
+          v = "#{val}"
+          if v.include?(".")
+            rv = v.split(".")[1].length
+          else
+            rv = (v.length-1)*-1
+          end
+
+          res = RoundingInfo.new
+          res.original_value = self.to_f
+          res.rounding_param = val
+          res.rounded_value = self.to_f.round(rv)
+
+          # rounding in financial is not the same as mathematical rounding
+          if rv < 0 and res.rounded_value > 0 and res.rounded_value < res.original_value
+
+            # adjusted base value
+            abv = "1#{"0"*(rv*-1)}"
+            # - means left of .
+            # - - become +
+            vv = res.original_value + abv.to_f
+            res.rounded_value = vv.to_f.round(rv)
+          end
+
+          res
+        end
+
+      end # Rounding Helper
+
+      ## End Rounding Info
+
+    end
+
+  end
+end
+
+class Integer
+  include Smerp::Common::FinUtils
+  include Smerp::Common::FinUtils::Markup
+  include Smerp::Common::FinUtils::Margin
+  include Smerp::Common::FinUtils::RoundingHelper
+end
+
+class Float
+  include Smerp::Common::FinUtils
+  include Smerp::Common::FinUtils::Markup
+  include Smerp::Common::FinUtils::Margin
+  include Smerp::Common::FinUtils::RoundingHelper
+end
+
+class BigDecimal
+  include Smerp::Common::FinUtils
+  include Smerp::Common::FinUtils::Markup
+  include Smerp::Common::FinUtils::Margin
+  include Smerp::Common::FinUtils::RoundingHelper
+end
+

data/lib/smerp/common/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Smerp
+  module Common
+    VERSION = "0.1.0"
+  end
+end

data/lib/smerp/common.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'teLogger'
+require 'toolrack'
+
+require_relative "common/version"
+
+require_relative 'common/fin_utils'
+require_relative 'common/currency_conversion'
+
+module Smerp
+  module Common
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/smerp-common.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/smerp/common/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smerp-common"
+  spec.version       = Smerp::Common::VERSION
+  spec.authors       = ["Ian"]
+  spec.email         = ["cameronian0@protonmail.com"]
+
+  spec.summary       = ""
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.required_ruby_version = ">= 2.4.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'teLogger'
+  spec.add_dependency 'toolrack'
+
+  spec.add_development_dependency "devops_assist"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: smerp-common
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: teLogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: toolrack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devops_assist
+  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:
+- cameronian0@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smerp/common.rb
+- lib/smerp/common/currency_conversion.rb
+- lib/smerp/common/fin_utils.rb
+- lib/smerp/common/version.rb
+- smerp-common.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []