ya_kansuji 0.1.0.pre.1 → 0.1.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cda61967cf509cb1681946b6ff0c7c82afa4f48fd307311f5a274a2e33dcc7a
-  data.tar.gz: 222c8e0a384159879eb9590ab25b6977daadc7f612ad42011368f920349d1960
+  metadata.gz: 1e5a2d3c5ef4a6e85650ee610c2229d4a38bc6cc3de114dbfd72ee6b45a56193
+  data.tar.gz: c2149b79c9bf353a65a114f0b8ff956507d8af4be218513a1231a2b8f302e43f
 SHA512:
-  metadata.gz: b69375378cb7bba1ba645714dee0798d9173d0cbbee8a5316088321f358b33990715a6812a0772a49bde7f48be5e354cdc3759d7c178187ac626e2c0471e97ad
-  data.tar.gz: 045e09e2fb3646791414a80453554745efaab69474f0ffd6644d3fd70e3545e77c10b2630daa2fd5cfd789fb521ccc184b55f44b766fbbc1e77a93d12b050de0
+  metadata.gz: d7d64bc09467ec751d93a46b48d5713eba82487dfdeecfd670b101bb0c9894c93e62b94e14a1d5807de244c9854357bf763a346d30d947851f9d944005a6119d
+  data.tar.gz: 450015e6531cbc12abe862bc3c15bab180d5a0ad24c60f18301b9b03fe9119569ea45174695b71281520ea26b4653cdf26a770b02e3aac47125c41f81ec090c2

data/README.md

@@ -1,27 +1,31 @@
-# TODO: THIS GEM IS ALPHA VERSION, NOW.
+# TODO: THIS GEM IS STILL ALPHA VERSION.
 
 # YaKansuji - もう一つの (やりすぎ) ruby 漢数字ライブラリ
 
+[<img src="https://badge.fury.io/rb/ya_kansuji.svg" alt="Gem Version" />](https://badge.fury.io/rb/ya_kansuji)
+[<img src="https://travis-ci.org/sugi/ya_kansuji.svg?branch=master" alt="Build Status" />](https://travis-ci.org/sugi/ya_kansuji)
+[<img src="https://coveralls.io/repos/sugi/ya_kansuji/badge.svg?branch=master&service=github" alt="Coverage Status" />](https://coveralls.io/github/sugi/ya_kansuji?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/007f79c6f7f6e82daa20/maintainability)](https://codeclimate.com/github/sugi/ya_kansuji/maintainability)
+
 Yet another (ultimate) Japanese Kansuji library for ruby.
 
-YaKansuji は ruby 用の日本語の漢数字ライブラリです。 和暦ライブラリの [wareki](https://github.com/sugi/wareki) から派生していますが、アラビア数字混じりの漢数字表記など、かなり多彩な表現を数値と相互変換することができます。
+YaKansuji は ruby 用の日本語の漢数字ライブラリです。 和暦ライブラリの [wareki](https://github.com/sugi/wareki) から派生していますが、アラビア数字混じりの漢数字表記など、もう少し多彩な表現を数値と相互変換することができます。
 
 日本語以外の漢数字に関しては一切サポートしていません。
 
 ## 機能 / Features
 
 * 読み取り: 以下の混在したテキストを数値に変換出来ます
-  * 漢数字
-  * 全角数字 ()
-  * 単位なし (
-  * ゼロ ()
-  * 位取り (2億0010万, 千〇〇二)
-  * 大字 (
-  * カンマ表現
+  * 漢数字 (二万三千五百六十七)
+  * 全角数字 (１２３４)
+  * 単位なし / ゼロ (一六九〇)
+  * 位取り (2億0010万 / 千〇〇二)
+  * 大字 (千皕卅肆)
+  * カンマ表現 (12,345 / 5億3,456万 / 二万、五十 )
 * 数値から漢数字, 漢字混じり数値文字列フォーマット
   * 複数のビルトインフォーマッタ
   * フォーマッタプラグイン機構
-* 標準の String, Number クラスの拡張 (必要があれば)
+* (オプション) 標準の String, Interger クラスの拡張
 
 ## インストール / Installation
 
@@ -35,30 +39,93 @@ gem 'ya_kansuji'
 
     $ gem install ya_kansuji
 
-## 使い方 / Usage
+## 使い方
+
+### 読み取り (漢数字 →  数値)
 
-### ビルトインクラス拡張
+`YaKansuji#to_i` に文字を渡すと数値に変換できます。読み取りに関してはオプションはありません。
 
-標準ではビルトインクラスの拡張をしません。
+```ruby
+YaKansuji.to_i("一〇二四") # => 1024
+```
 
-bundle でない場合は
+### フォーマット (数値 → 漢数字)
+
+`YaKansuji#to_kan` に数値を渡すことで、漢数字や漢字混じりの文字列に変換します。
 
 ```ruby
+YaKansuji.to_kan(12345)  # => 一万二千三百四十五
+```
+
+このさい、2つめの引数にシンボルを渡すことにより、フォーマッタを切り替えることができます(TODO: 予定)。
 
+```ruby
+YaKansuji.to_kan(12340005, :simple)  # => "千二百三十四万五"
+YaKansuji.to_kan(12340005, :gov)     # => "1234万, 5"
+YaKansuji.to_kan(12340005, :lawyer)  # => "1,234万5"
+YaKansuji.to_kan(12340005, :judic_v) # => "一二三四万〇〇〇五"
+YaKansuji.to_kan(12340005, :judic_h) # => "１２３４万０００５"
 ```
 
+現在あるフォーマッタは以下のとおりです。
+
+ * simple - 標準 (例: 千二百三十四万五)
+ * TODO ~~gov - 「公用文作成の要領」方式 (100億, 30万円 / 5,000)~~
+ * TODO ~~lawyer - 行政司法協会方式 (1,200億 / 2億58万6,300)~~
+ * TOD ~~judic_v - 裁判判例縦書き方式 (一二万〇〇五六)~~
+ * TODO ~~judic_h - 最高裁判例横書き方式 (５万０５３９)~~
+
+#### 独自フォーマッタ
+
+`YaKansuji#register_formatter` を使うと独自のフォーマッタを登録できます。
+`call` を持つオブジェクトなら何でも渡せます。第1引数に数字、第2引数にオプションが渡ります。
+
+```ruby
+YaKansuji.register_formatter :hoge, -> (num, opts = {}) {
+  if num == 0;    ""
+  elsif num == 1; "いち"
+  elsif num == 2; "に"
+  else;           "たくさん"
+  end
+}
+YaKansuji.to_kan(2,   :hoge)   # => "に"
+YaKansuji.to_kan(123, :hoge)   # => "たくさん"
+```
 
-### 読み取り (漢数字 →  数値) / Parse kansuji
+### 標準クラス拡張
 
-TODO: Write usage instructions here
+標準では YaKansuji のクラスメソッドを直接呼ぶことで使用できますが、短く書く場合、必要応じてビルトインクラス (String, Integer) の拡張を使うことができます。
 
-### フォーマット (数値 → 漢数字) /
+クラス拡張では `String#to_i` を置き換え、 `Integer#to_kan` を追加します。
+このさい、Refinements と直接拡張の好きな方を選択できます。
 
-## Development
+#### Refinements による拡張
 
-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.
+`YaKansuji::CoreRefine` を using すると、 `String#to_i` を置き換え、 `Integer#to_kan` を追加します。
 
-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).
+```ruby
+puts "二万".to_i     # => 0
+
+using YaKansuji::CoreRefine
+
+puts "二万".to_i     # => 20000
+puts 20000.to_kan   #= > "二万"
+```
+
+#### メソッド上書き
+
+Refinements をいちいち使わずに、全域でビルトインクラスを上書きしたい場合は `ya_kansuji/core_ext` を読み込んでください。
+上書きや提供されるメソッドは Refinements と同じです。
+
+```ruby
+require 'ya_kansuji/core_ext'
+```
+
+bundler を使っている場合は、 `Gemfile` 中で以下のようにできます。
+
+```ruby
+gem 'ya_kansuji', require: 'ya_kansuji/core_ext'
+```
 
 ## Contributing
 
@@ -71,3 +138,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Author
 
 Tatsuki Sugiura <sugi@nemui.org>
+\\

data/lib/ya_kansuji/core_ext.rb

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
+
 require 'ya_kansuji'
 
 # Core extension by kansuji
 class String
-  def to_number
-    YaKansuji.to_i self
-  end
+  alias _to_i_ya_kansuji_orig to_i unless defined?(_to_i_ya_kansuji_orig)
 
-  def to_num
-    YaKansuji.to_i self
+  def to_i(base = nil)
+    if base.nil? || base == :kan
+      YaKansuji.to_i self
+    else
+      _to_i_ya_kansuji_orig(base)
+    end
   end
 end
 
 # Core extension by kansuji
 class Integer
-  def to_kansuji
-    YaKansuji.to_kan self
-  end
-
   def to_kan
     YaKansuji.to_kan self
   end

data/lib/ya_kansuji/core_refine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ya_kansuji'
+
+# String and Integer refinements with YaKansuji
+module YaKansuji
+  module CoreRefine
+    refine String do
+      alias_method :_to_i_ya_kansuji_orig, :to_i unless defined?(_to_i_ya_kansuji_orig)
+      def to_i(base = nil)
+        if base.nil? || base == :kan || base == :kansuji
+          YaKansuji.to_i self
+        else
+          _to_i_ya_kansuji_orig base
+        end
+      end
+    end
+
+    refine Integer do
+      def to_kan(formatter = :simple)
+        YaKansuji.to_kan self, formatter
+      end
+    end
+  end
+end

data/lib/ya_kansuji/version.rb

@@ -1,3 +1,3 @@
 module YaKansuji
-  VERSION = '0.1.0.pre.1'.freeze
+  VERSION = '0.1.0.pre.3'.freeze
 end

data/lib/ya_kansuji.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ya_kansuji/version'
+require 'ya_kansuji/core_refine'
 
 # Yet another Kansuji library for ruby.
 module YaKansuji
@@ -22,10 +23,17 @@ module YaKansuji
   module_function
 
   def to_i(str)
-    matched = REGEXP.match(str.to_s.tr(NUM_ALT_CHARS, NUM_NORMALIZED_CHARS)) or return 0
+    str = str.to_s.tr(NUM_ALT_CHARS, NUM_NORMALIZED_CHARS)
+    str.gsub!(/[,，、:space:]/, '')
+    matched = REGEXP.match(str) or return 0
     ret3 = 0
     ret4 = 0
     curnum = nil
+    if str.respond_to? :_to_i_ya_kansuji_orig
+      to_i_meth = :_to_i_ya_kansuji_orig
+    else
+      to_i_meth = :to_i
+    end
     matched[0].scan(REGEXP_PART).each do |c|
       case c
       when '1', '2', '3', '4', '5', '6', '7', '8', '9'
@@ -34,7 +42,7 @@ module YaKansuji
         else
           curnum = 0
         end
-        curnum += c.to_i
+        curnum += c.public_send(to_i_meth)
       when '0'
         curnum and curnum *= 10
       when '卄', '廿'
@@ -72,16 +80,16 @@ module YaKansuji
 
   def register_formatter(sym, proc = nil, &block)
     if block_given?
-      @@formatters[sym.to_sym] = block
+      @@formatters[sym] = block
     elsif proc.respond_to? :call
-      @@formatters[sym.to_sym] = proc
+      @@formatters[sym] = proc
     else
       raise ArgumentError, 'Registering invalid formatter.'
     end
   end
 
   def formatter(sym)
-    @@formatters[sym.to_sym]
+    @@formatters[sym]
   end
 
   def formatters
@@ -89,11 +97,11 @@ module YaKansuji
   end
 
   def to_kan(num, formatter = :simple, options = {})
-    num = num.to_i
+    num = num.respond_to?(:_to_i_ya_kansuji_orig) ? num._to_i_ya_kansuji_orig : num.to_i
     if formatter.respond_to? :call
       formatter.call num, options
-    elsif @@formatters[formatter.to_sym]
-      @@formatters[formatter.to_sym].call num, options
+    elsif @@formatters[formatter]
+      @@formatters[formatter].call num, options
     else
       raise ArgumentError, "Unable to find formatter #{formatter}"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ya_kansuji
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.1
+  version: 0.1.0.pre.3
 platform: ruby
 authors:
 - Tatsuki Sugiura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - README.md
 - lib/ya_kansuji.rb
 - lib/ya_kansuji/core_ext.rb
+- lib/ya_kansuji/core_refine.rb
 - lib/ya_kansuji/formatter/simple.rb
 - lib/ya_kansuji/version.rb
 homepage: https://github.com/sugi/ya_kansuji