strict_money 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb4adcabdacb785a087ea8549695d625fe7df0ebdedda3746c83da04364ee8bc
+  data.tar.gz: f3cc4f0b6fd955857394a27f65eb75a8bd83a772c43a8414106b84576a68dad5
+SHA512:
+  metadata.gz: 5f1314942fb80cea05d8f2fc2eed57cac80eb32b3bd760d4b4144a3a31f0e9a30b226b5e7130ea1b5ae6da2f8fbedaeea540b3fcf1dd7269d69e3482e5122d9a
+  data.tar.gz: 0e7f81ae2133c5b55fda150bbf056dd787d9e6bdbdd3fe42662c5da189834e69005bcef5ece5ed503c953f333305e78b5937ad81d587263b8505c3be613fb8de

data/.circleci/config.yml

@@ -0,0 +1,51 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.1-node-browsers
+      - image: circleci/mongo:3.6.9
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              -r rspec_junit_formatter \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec/results.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.codeclimate.yml

@@ -0,0 +1,38 @@
+version: "2"         # required to adjust maintainability checks
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 250
+  method-complexity:
+    config:
+      threshold: 5
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 25
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: 150
+  identical-code:
+    config:
+      threshold: 75
+plugins:
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+

data/.gitignore

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

data/.reek.yml

@@ -0,0 +1,11 @@
+---
+detectors:
+  DuplicateMethodCall:
+    max_calls: 3
+  MissingSafeMethod:
+    enabled: false
+  UtilityFunction:
+    public_methods_only: true
+
+exclude_paths:
+  - spec

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,75 @@
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/TrailingBlankLines:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: false
+
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'strict_money.gemspec'
+
+# Handled by Reek
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/EmptyMethod:
+  Exclude:
+    - 'spec/**/*'
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RandomWithOffset:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SymbolProc:
+  Exclude:
+    - 'spec/**/*'
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in strict_money.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# StrictMoney
+
+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/strict_money`. 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 'strict_money'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strict_money
+
+## 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 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]/strict_money.

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 "strict_money"
+
+# 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/strict_money.rb

@@ -0,0 +1,32 @@
+require "strict_money/amount"
+require "strict_money/configuration"
+require "strict_money/version"
+require "strict_money/railtie" if defined?(Rails::Railtie)
+require "forwardable"
+
+# Manipulate money and currency with strictness around currencies and time periods.
+module StrictMoney
+  # Exception raised when someone uses a currency that is not supported within
+  # the application.
+  UnsupportedCurrencyError = Class.new(StandardError)
+  # Exception raised when someone uses an invalid currency in a method call.
+  WrongCurrencyError = Class.new(StandardError)
+
+  class << self
+    extend Forwardable
+
+    def_delegators :configuration, :supported_currency?, :supported_currencies
+
+    attr_reader :configuration
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+  end
+end
+
+StrictMoney.reset_configuration

data/lib/strict_money/amount.rb

@@ -0,0 +1,72 @@
+require 'forwardable'
+
+module StrictMoney
+  # A value object to describe an single amount of money with a single
+  # currency.
+  class Amount
+    include Comparable
+    extend Forwardable
+
+    attr_reader :currency
+
+    def initialize(amount, currency)
+      raise IncompleteError unless amount && currency
+      raise StrictMoney::UnsupportedCurrencyError unless StrictMoney.supported_currency?(currency)
+      @amount = amount
+      @currency = currency.upcase
+    end
+
+    def -@
+      Amount.new(-@amount, @currency)
+    end
+
+    def <=>(other)
+      return unless other.is_a?(Amount) && currency == other.currency
+
+      as_float(currency) <=> other.as_float(currency)
+    end
+
+    def +(addend)
+      raise TypeError unless addend.is_a?(Amount)
+      Amount.new(as_float(currency) + addend.as_float(currency), currency)
+    end
+
+    def -(subtrahend)
+      raise TypeError unless subtrahend.is_a?(Amount)
+      self + (subtrahend * -1)
+    end
+
+    def *(multiplier)
+      Amount.new(@amount * multiplier, currency)
+    end
+
+    def /(divisor)
+      if divisor.is_a?(Amount)
+        @amount / divisor.as_float(@currency)
+      else
+        Amount.new(@amount / divisor, @currency)
+      end
+    end
+
+    def as_float(currency)
+      raise WrongCurrencyError unless currency.upcase == @currency
+      @amount.to_f
+    end
+
+    def negative?
+      as_float(@currency) < 0
+    end
+
+    def positive?
+      as_float(@currency) > 0
+    end
+
+    def round(precision)
+      Amount.new(@amount.round(precision), @currency)
+    end
+
+    # Exception raised when somebody tries to instantiate an Amount with
+    # incomplete information.
+    IncompleteError = Class.new(StandardError)
+  end
+end

data/lib/strict_money/configuration.rb

@@ -0,0 +1,18 @@
+module StrictMoney
+  # Store configuration options for StrictMoney overall.
+  class Configuration
+    attr_reader :supported_currencies
+
+    def initialize
+      @supported_currencies = :all
+    end
+
+    def supported_currencies=(sc)
+      @supported_currencies = sc
+    end
+
+    def supported_currency?(currency)
+      (@supported_currencies == :all) || @supported_currencies.include?(currency)
+    end
+  end
+end

data/lib/strict_money/orms/mongoid.rb

@@ -0,0 +1,7 @@
+require "strict_money/orms/mongoid/amount"
+require "strict_money/orms/mongoid/configuration"
+require "strict_money/orms/mongoid/financiality_validator"
+
+class << StrictMoney
+  def_delegators :configuration, :demongoize_amount
+end

data/lib/strict_money/orms/mongoid/amount.rb

@@ -0,0 +1,20 @@
+module StrictMoney
+  module Orms
+    module Mongoid
+      # Extend StrictMoney::Amount to work with Mongoid.
+      module Amount
+        def mongoize
+          {'currency' => @currency, 'amount' => @amount}
+        end
+
+        def self.included(base)
+          def base.demongoize(object)
+            StrictMoney.demongoize_amount(object)
+          end
+        end
+      end
+    end
+  end
+end
+
+StrictMoney::Amount.include(StrictMoney::Orms::Mongoid::Amount)

data/lib/strict_money/orms/mongoid/configuration.rb

@@ -0,0 +1,20 @@
+module StrictMoney
+  module Orms
+    module Mongoid
+      # Extend StrictMoney::Configuration to work with Mongoid.
+      module Configuration
+        def demongoize_amount(object = nil, &block)
+          if block
+            @demongoize_block = block
+          elsif @demongoize_block
+            @demongoize_block.call(object)
+          else
+            StrictMoney::Amount.new(object['amount'], object['currency'])
+          end
+        end
+      end
+    end
+  end
+end
+
+StrictMoney::Configuration.include(StrictMoney::Orms::Mongoid::Configuration)

data/lib/strict_money/orms/mongoid/financiality_validator.rb

@@ -0,0 +1,26 @@
+# Supply validation macros for Mongoid classes that embed StrictMoney::Amount.
+class FinancialityValidator < ActiveModel::EachValidator
+  def check_validity!
+    invalid_keys = options.keys - [:positive, :not_negative]
+    raise "Invalid keys #{invalid_keys.inspect} for financiality validator" if invalid_keys.present?
+  end
+
+  def validate_each(*args)
+    validate_positive(*args) if options[:positive]
+    validate_not_negative(*args) if options[:not_negative]
+  end
+
+  private
+
+  def validate_not_negative(record, attribute, value)
+    if value.present? && value.negative?
+      record.errors.add(attribute, "can't be negative")
+    end
+  end
+
+  def validate_positive(record, attribute, value)
+    if value.present? && !value.positive?
+      record.errors.add(attribute, "must be greater than 0")
+    end
+  end
+end

data/lib/strict_money/railtie.rb

@@ -0,0 +1,9 @@
+module StrictMoney
+  # Initialize StrictMoney inside a Rails application.
+  class Railtie < Rails::Railtie
+    initializer :strict_money do
+      Module.const_defined?(:Mongoid) && \
+        require("strict_money/orms/mongoid")
+    end
+  end
+end

data/lib/strict_money/version.rb

@@ -0,0 +1,3 @@
+module StrictMoney
+  VERSION = "0.2.0".freeze
+end

data/strict_money.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "strict_money/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "strict_money"
+  spec.version       = StrictMoney::VERSION
+  spec.authors       = ["Francis Hwang"]
+  spec.email         = ["sera@fhwang.net"]
+
+  spec.summary       = %q{Manipulate money and currency with strictness around currencies and time periods.}
+  spec.homepage      = "https://github.com/fhwang/strict_money"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fhwang/strict_money"
+
+  # 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('..', __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 = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "mongoid"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: strict_money
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Francis Hwang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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:
+- sera@fhwang.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/strict_money.rb
+- lib/strict_money/amount.rb
+- lib/strict_money/configuration.rb
+- lib/strict_money/orms/mongoid.rb
+- lib/strict_money/orms/mongoid/amount.rb
+- lib/strict_money/orms/mongoid/configuration.rb
+- lib/strict_money/orms/mongoid/financiality_validator.rb
+- lib/strict_money/railtie.rb
+- lib/strict_money/version.rb
+- strict_money.gemspec
+homepage: https://github.com/fhwang/strict_money
+licenses: []
+metadata:
+  homepage_uri: https://github.com/fhwang/strict_money
+  source_code_uri: https://github.com/fhwang/strict_money
+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.6
+signing_key: 
+specification_version: 4
+summary: Manipulate money and currency with strictness around currencies and time
+  periods.
+test_files: []