j-law-ruby 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2e37cfa4515c19a9ab8330f6cf37dec2e9e4a202383542c779c90ac525b3953
+  data.tar.gz: b3e3500018a5ecc1795d5e24b47079f8a254625997ca3cf380bdf2a3a92d7f2e
+SHA512:
+  metadata.gz: ad62d52287bef5395b8b5c29527d3fbe16d8bce8789eb2f3c18d1e0fb3cf9400dfe7eda7bc3a3b1c1eeb9e3a0012b3cfbf986ad2d12715ff06d56173182ba285
+  data.tar.gz: 9e9dabffff57a7b307b446dfd20a4e7a79d90edfc3af90e1ad599dc22f080b281c2b04f0de13960ca87608e4b9a499ac4cb1a039dd6fa5b0dbd3ee48f425b063

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "ffi"
+gem "minitest"

data/README.md

@@ -0,0 +1,109 @@
+# j_law_ruby
+
+日本法令計算の PoC を Ruby から試すためのバインディングです。
+
+内部では `j-law-c-ffi` の C ABI を `ffi` gem 経由で呼び出し、Rust コアの整数演算ロジックを Ruby から利用します。
+
+> [!WARNING]
+> **PoC / アルファ版に関する注意事項**
+>
+> - 本ライブラリは現在 **`v0.0.1` のアルファ版**です。API と配布形態は予告なく変更される場合があります。
+> - この binding が返す計算結果について、法的正確性、完全性、最新性、個別事案への適合性は保証しません。
+> - コードの一部には **AI 生成 / AI 補助**による実装が含まれ、人手による全面レビューは完了していません。
+> - 税務申告や契約実務の唯一の根拠として使用せず、一次資料と専門家で検証してください。
+> - 詳細は [プロジェクトステータスと免責](../../docs/project-status.md) を参照してください。
+
+## 対応機能
+
+- `JLawRuby::ConsumptionTax.calc_consumption_tax`
+- `JLawRuby::RealEstate.calc_brokerage_fee`
+- `JLawRuby::IncomeTax.calc_income_tax`
+- `JLawRuby::IncomeTax.calc_income_deductions`
+- `JLawRuby::IncomeTax.calc_income_tax_assessment`
+- `JLawRuby::StampTax.calc_stamp_tax`
+- `JLawRuby::WithholdingTax.calc_withholding_tax`
+
+## インストール
+
+CI と publish workflow で検証している Ruby の範囲は `3.1` から `4.0` です。
+RubyGems では `linux/x86_64` `linux/aarch64` `macos/x86_64` `macos/arm64` `windows/amd64`
+向けの build 済み platform gem を配布します。これらの環境では Rust toolchain は不要です。
+その他の環境では source gem にフォールバックし、`gem install` 時に Rust `1.94.0`
+toolchain を使って `j-law-c-ffi` をビルドします。
+
+```sh
+gem install j_law_ruby
+```
+
+source gem を明示的に使う場合は次を実行します。
+
+```sh
+gem install j_law_ruby --platform ruby
+```
+
+開発環境では次を実行します。
+
+```sh
+cd crates/j-law-ruby
+bundle install
+bundle exec rake compile
+bundle exec rake test
+```
+
+## クイックスタート
+
+```ruby
+require "date"
+require "j_law_ruby"
+
+date = Date.new(2024, 8, 1)
+
+puts JLawRuby::ConsumptionTax.calc_consumption_tax(100_000, Date.new(2024, 1, 1), false).tax_amount
+puts JLawRuby::RealEstate.calc_brokerage_fee(5_000_000, date, false, false).total_with_tax
+
+assessment = JLawRuby::IncomeTax.calc_income_tax_assessment(
+  8_000_000,
+  Date.new(2024, 1, 1),
+  social_insurance_premium_paid: 600_000
+)
+puts assessment.tax.total_tax
+
+puts JLawRuby::StampTax.calc_stamp_tax(:article1_real_estate_transfer, 5_000_000, date).tax_amount
+
+puts JLawRuby::WithholdingTax.calc_withholding_tax(
+  1_500_000,
+  Date.new(2026, 1, 1),
+  :professional_fee
+).tax_amount
+```
+
+## API メモ
+
+- すべての金額は整数円です。
+- すべての API は `Date` / `DateTime` を受け取り、型不一致は `TypeError` を送出します。
+- 法令適用外日付や入力不正は `RuntimeError` を送出します。
+- `calc_stamp_tax()` の `document_code` / `flags` は `Symbol` または `String` を受け取ります。
+- `calc_withholding_tax()` の `category` は `:manuscript_and_lecture` / `:professional_fee` / `:exclusive_contract_fee` などを指定します。
+
+## Gem ビルド
+
+```sh
+cd crates/j-law-ruby
+bundle install
+bundle exec rake build_source_gem
+bundle exec rake build_binary_gem
+```
+
+`rake build` は `build_source_gem` のエイリアスです。
+`build_source_gem` は source gem 用に必要な Rust ソースを `vendor/rust/` へ同期してから gem を生成します。
+`build_binary_gem` は共有ライブラリを事前にビルドして、platform gem に同梱します。
+
+## 関連ドキュメント
+
+- [プロジェクトステータスと免責](../../docs/project-status.md)
+- [リポジトリ README](../../README.md)
+- [利用ガイド](../../docs/usage.md)
+
+## ライセンス
+
+[MIT License](../../LICENSE)

data/Rakefile

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+require_relative "lib/j_law_ruby/build_support"
+require_relative "rake_support/vendor_rust"
+
+def with_unbundled_env
+  if defined?(Bundler)
+    Bundler.with_unbundled_env { yield }
+  else
+    yield
+  end
+end
+
+def gem_root
+  File.expand_path(__dir__)
+end
+
+def prepare_vendor_rust
+  JLawRuby::VendorRust.prepare!(gem_root)
+end
+
+def clean_native_library
+  rm_rf "lib/j_law_ruby/native"
+end
+
+def compile_native_library
+  prepare_vendor_rust
+
+  Dir.chdir("ext/j_law_ruby") do
+    ruby "extconf.rb"
+    sh JLawRuby::BuildSupport.make_command
+  end
+end
+
+task :vendor_rust do
+  prepare_vendor_rust
+end
+
+task :clean_native do
+  clean_native_library
+end
+
+task :compile do
+  compile_native_library
+end
+
+task :build_source_gem do
+  prepare_vendor_rust
+  clean_native_library
+
+  with_unbundled_env do
+    sh "gem", "build", "j_law_ruby.gemspec"
+  end
+end
+
+task :build_binary_gem do
+  compile_native_library
+
+  with_unbundled_env do
+    sh(
+      { JLawRuby::BuildSupport::BINARY_GEM_ENV => "1" },
+      "gem", "build", "j_law_ruby.gemspec"
+    )
+  end
+end
+
+task :clean do
+  rm_rf "vendor/rust"
+  rm_rf "lib/j_law_ruby/native"
+  rm_f FileList["*.gem"]
+
+  next unless File.exist?("ext/j_law_ruby/Makefile")
+
+  Dir.chdir("ext/j_law_ruby") do
+    sh JLawRuby::BuildSupport.make_command, "clean"
+  end
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end
+
+task build: :build_source_gem
+task test: :compile
+task default: :test

data/ext/j_law_ruby/extconf.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "mkmf"
+require_relative "../../lib/j_law_ruby/build_support"
+
+gem_root = File.expand_path("../..", __dir__)
+packaged_library = JLawRuby::BuildSupport.packaged_shared_library_path(gem_root)
+
+unless JLawRuby::BuildSupport.should_build_shared_library?(gem_root)
+  puts "Using packaged j-law-c-ffi shared library at #{packaged_library}"
+  JLawRuby::BuildSupport.write_stub_makefile("Makefile")
+  exit 0
+end
+
+manifest_path = JLawRuby::BuildSupport.manifest_path(gem_root)
+
+abort "Cargo workspace for j-law-c-ffi was not found." if manifest_path.nil?
+
+profile = JLawRuby::BuildSupport.cargo_profile
+cargo_command = ["cargo", "build", "-p", "j-law-c-ffi", "--manifest-path", manifest_path]
+cargo_command << "--release" if profile == "release"
+
+puts "Building j-law-c-ffi (#{profile}) via #{manifest_path}"
+abort "cargo build failed" unless system(*cargo_command)
+
+built_library = JLawRuby::BuildSupport.built_shared_library_path(manifest_path, profile)
+abort "built shared library was not found: #{built_library}" unless File.file?(built_library)
+
+native_dir = JLawRuby::BuildSupport.native_dir(gem_root)
+FileUtils.mkdir_p(native_dir)
+FileUtils.cp(built_library, packaged_library)
+
+JLawRuby::BuildSupport.write_stub_makefile("Makefile")

data/lib/j_law_ruby/build_support.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+
+module JLawRuby
+  module BuildSupport
+    module_function
+
+    BINARY_GEM_ENV = "JLAW_RUBY_BINARY_GEM"
+    FORCE_CARGO_BUILD_ENV = "JLAW_RUBY_FORCE_CARGO_BUILD"
+
+    def cargo_profile
+      ENV.fetch("JLAW_RUBY_CARGO_PROFILE", "release")
+    end
+
+    def binary_gem_build?
+      ENV[BINARY_GEM_ENV] == "1"
+    end
+
+    def force_cargo_build?
+      ENV[FORCE_CARGO_BUILD_ENV] == "1"
+    end
+
+    def gem_platform
+      require "rubygems/platform"
+
+      Gem::Platform.local
+    end
+
+    def make_command
+      RbConfig::CONFIG.fetch("MAKE", "make")
+    end
+
+    def shared_library_filename
+      case RbConfig::CONFIG["host_os"]
+      when /mswin|mingw|cygwin/
+        "j_law_c_ffi.dll"
+      when /darwin/
+        "libj_law_c_ffi.dylib"
+      else
+        "libj_law_c_ffi.so"
+      end
+    end
+
+    def native_dir(gem_root)
+      File.join(gem_root, "lib", "j_law_ruby", "native")
+    end
+
+    def packaged_shared_library_path(gem_root)
+      File.join(native_dir(gem_root), shared_library_filename)
+    end
+
+    def packaged_shared_library?(gem_root)
+      File.file?(packaged_shared_library_path(gem_root))
+    end
+
+    def vendored_workspace_root(gem_root)
+      File.join(gem_root, "vendor", "rust")
+    end
+
+    def vendored_manifest_path(gem_root)
+      File.join(vendored_workspace_root(gem_root), "Cargo.toml")
+    end
+
+    def repo_workspace_root(gem_root)
+      File.expand_path("../..", gem_root)
+    end
+
+    def repo_manifest_path(gem_root)
+      File.join(repo_workspace_root(gem_root), "Cargo.toml")
+    end
+
+    def manifest_path(gem_root)
+      vendored_manifest = vendored_manifest_path(gem_root)
+      return vendored_manifest if File.file?(vendored_manifest)
+
+      repo_manifest = repo_manifest_path(gem_root)
+      return repo_manifest if File.file?(repo_manifest)
+
+      nil
+    end
+
+    def built_shared_library_path(manifest_path, profile)
+      File.join(File.dirname(manifest_path), "target", profile, shared_library_filename)
+    end
+
+    def shared_library_candidates(gem_root)
+      candidates = []
+      env_path = ENV["JLAW_RUBY_C_FFI_LIB"]
+      candidates << env_path unless env_path.nil? || env_path.empty?
+      candidates << packaged_shared_library_path(gem_root)
+
+      [vendored_manifest_path(gem_root), repo_manifest_path(gem_root)].each do |manifest|
+        next unless File.file?(manifest)
+
+        candidates << built_shared_library_path(manifest, "release")
+        candidates << built_shared_library_path(manifest, "debug")
+      end
+
+      candidates.uniq
+    end
+
+    def resolve_shared_library_path(gem_root)
+      shared_library_candidates(gem_root).find { |path| File.file?(path) }
+    end
+
+    def should_build_shared_library?(gem_root)
+      return true if force_cargo_build?
+
+      !packaged_shared_library?(gem_root)
+    end
+
+    def write_stub_makefile(path = "Makefile")
+      File.write(
+        path,
+        <<~MAKEFILE
+          all:
+          \t@true
+
+          install:
+          \t@true
+
+          clean:
+          \t@true
+        MAKEFILE
+      )
+    end
+  end
+end