with_tax 0.1.20200414

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '068e82e41ea94b91fae8ff7ae8ca6233a827af0b908f0801ec25121f5beada08'
+  data.tar.gz: 035565bfc702d68afdedf025ded5d0add4f09d661434e2c73b31ffcef5a9b86c
+SHA512:
+  metadata.gz: 420edb711b830e56ffa0e45c120601d016fc1721b7a88d775252af5f2f8dc3efaff8f0a5fa27cff56c40d8edfe8a3a981a8afcc06ce64b57aea1b1a18dea0f39
+  data.tar.gz: df68a47b67ee68fbf2dff2d527245cb9611b592e32d530e64f5dbbebec47847470db0484b2cba6cf7089f1be55418aeffe872f4987177e71ab5bd08fcd9485d0

data/.github/workflows/ruby.yml

@@ -0,0 +1,64 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build2_4:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.4
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.4.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+
+  build2_5:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+
+  build2_6:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+
+  build2_7:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

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,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in with_tax.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "timecop"
+gem "pry-byebug"

data/README.md

@@ -0,0 +1,238 @@
+# WithTax
+
+WithTaxはクラスにextendし、`.attr_with_tax`で属性を指定すると、`#(指定した属性)_with_tax`というメソッドで税込金額を求められるようになります。
+
+## Installation
+
+Gemfileに下のように記述してください。
+
+```ruby
+gem 'with_tax'
+```
+
+それから下を実行してください:
+
+```console
+$ bundle install
+```
+
+または自分でインストールするには:
+
+```console
+$ gem install with_tax
+```
+
+## Usage
+
+### 基本的な使い方
+
+下のように`WithTax`を`extend`し、`attr_with_tax`で対象の属性を指定してください。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+```
+
+そうすると下のように`属性名_with_tax`というメソッドが利用できるようになり、税込み価格が取得できます。小数点以下は切り上げになっています。
+
+```ruby
+sample_item = SampleItem.new('Some item', 123)
+sample_item.price # => 123
+sample_item.price_with_tax #=> 136
+```
+
+### 適用日
+
+税率改定があるときに、計算の基準になる日を指定することもできます。
+
+```ruby
+sample_item = SampleItem.new('Some item', 123)
+sample_item.price # => 123
+sample_item.price_with_tax(Date.parse('2019/09/30')) #=> 132
+```
+
+### 詳細設定
+
+#### 小数の取り扱い
+
+デフォルトでは切り上げになっていますが、`rounding_method`を設定することで切り替えることができます。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price, rounding_method: :floor
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+```
+
+##### 切り捨て
+
+`:floor`を設定すると小数点以下を切り捨てます。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price, rounding_method: :floor
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+
+sample_item1 = SampleItem.new('Sample Item', 123)
+sample_item1.price #=> 123
+sample_item1.price_with_tax #=> 135
+
+sample_item2 = SampleItem.new('Sample Item', 345)
+sample_item2.price #=> 345
+sample_item2.price_with_tax #=> 379
+```
+
+##### 四捨五入
+
+`:round`を設定すると小数点以下を四捨五入します。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price, rounding_method: :round
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+
+sample_item1 = SampleItem.new('Sample Item', 345)
+sample_item1.price #=> 123
+sample_item1.price_with_tax #=> 135
+
+sample_item2 = SampleItem.new('Sample Item', 345)
+sample_item2.price #=> 345
+sample_item2.price_with_tax #=> 380
+```
+
+##### 処理なし
+
+`nil`を設定すると小数点以下を処理しません。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price, rounding_method: nil
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+
+sample_item.price #=> 123
+sample_item.price_with_tax #=> 135.3
+```
+
+#### 軽減税率
+
+デフォルトでは`10%`ですが、`rate_type`に`:reduced`を設定することで軽減税率の8%に切り替えることができます。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price, rate_type: :reduced
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+```
+
+```ruby
+sample_item.price #=> 123
+sample_item.price_with_tax #=> 133
+```
+
+#### 複数のオプション設定
+
+`attr_with_max`は複数のオプションも設定できます。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price
+  attr_with_tax :price, rounding_method: :round, rate_type: :reduced
+
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+end
+```
+
+```ruby
+sample_item.price #=> 123
+sample_item.price_with_tax #=> 133
+```
+
+#### 複数の属性への設定
+
+`attr_with_max`は複数の属性にも設定できます。
+
+```ruby
+class SampleItem
+  extend WithTax
+
+  attr_accessor :name, :price, :price_takeout
+  attr_with_tax :price, rounding_method: :round
+  attr_with_tax :price_takeout, rounding_method: :round, rate_type: :reduced
+
+  def initialize(name, price, price_takeout)
+    @name = name
+    @price = price
+    @price_takeout = price_takeout
+  end
+end
+```
+
+```ruby
+sample_item.price #=> 123
+sample_item.price_with_tax #=> 135
+sample_item.price_takeout #=> 123
+sample_item.price_takeout_with_tax #=> 133
+```
+
+## 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/ken1flan/with_tax.
+

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

@@ -0,0 +1,10 @@
+require 'with_tax/version'
+require 'with_tax/method_definer'
+
+module WithTax
+  class Error < StandardError; end
+
+  def attr_with_tax(attr_name, option = {})
+    WithTax::MethodDefiner.add_method(self, attr_name, option)
+  end
+end

data/lib/with_tax/method_definer.rb

@@ -0,0 +1,19 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+require 'with_tax/rate'
+
+module WithTax
+  class MethodDefiner
+    def self.add_method(klass, attr_name, rounding_method: :ceil, rate_type: :default)
+      klass.class_eval do
+        method_name = "#{attr_name}_with_tax"
+        define_method(method_name) do |effective_date = nil|
+          mag = 1 + WithTax::Rate.rate(effective_date, rate_type)
+          ret = send(attr_name).to_s.to_d * mag
+
+          rounding_method ? ret.send(rounding_method) : ret
+        end
+      end
+    end
+  end
+end

data/lib/with_tax/rate.rb

@@ -0,0 +1,16 @@
+require 'date'
+require 'yaml'
+
+module WithTax
+  class Rate
+    TAX_TABLE = File.open("#{__dir__}/rate.yml") { |f| YAML.safe_load(f) }
+
+    def self.rate(target_date = nil, target_type = nil)
+      t = target_date
+      t ||= Date.today
+      _k, rate = TAX_TABLE.find { |k, _v| Date.parse(k) <= t }
+      rate ||= {}
+      rate[target_type&.to_s] || rate['default'] || 0.0
+    end
+  end
+end

data/lib/with_tax/rate.yml

@@ -0,0 +1,9 @@
+2019/10/01:
+  default: 0.10
+  reduced: 0.08
+2014/04/01:
+  default: 0.08
+1997/04/01:
+  default: 0.05
+1989/04/01:
+  default: 0.03

data/lib/with_tax/version.rb

@@ -0,0 +1,3 @@
+module WithTax
+  VERSION = '0.1.20200414'
+end

data/with_tax.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/with_tax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "with_tax"
+  spec.version       = WithTax::VERSION
+  spec.authors       = ["ken1flan"]
+  spec.email         = ["ken1flan@gmail.com"]
+
+  spec.summary       = %q{Allows you to calculate sales tax without defining a method in a class.}
+  spec.homepage      = "https://github.com/ken1flan/with_tax"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ken1flan/with_tax"
+  spec.metadata["changelog_uri"] = "https://github.com/ken1flan/with_tax/CHANGELOG.md"
+
+  # 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"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: with_tax
+version: !ruby/object:Gem::Version
+  version: 0.1.20200414
+platform: ruby
+authors:
+- ken1flan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- ken1flan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/with_tax.rb
+- lib/with_tax/method_definer.rb
+- lib/with_tax/rate.rb
+- lib/with_tax/rate.yml
+- lib/with_tax/version.rb
+- with_tax.gemspec
+homepage: https://github.com/ken1flan/with_tax
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ken1flan/with_tax
+  source_code_uri: https://github.com/ken1flan/with_tax
+  changelog_uri: https://github.com/ken1flan/with_tax/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Allows you to calculate sales tax without defining a method in a class.
+test_files: []