tsubaki - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #machine-learning #deep-learning #awesome #cli #security #pytorch #mcp #ios #openai #open-source

tsubaki

(★ 68)

My Number & Corporate Number validator

파일 탐색기

최종 버전 다운로드 (.zip)

- - test.yml
- CODEOWNERS
- console
- setup
- - corporate_number.rb
  - corporate_number_validator.rb
  - matchers.rb
  - my_number.rb
  - my_number_validator.rb
  - version.rb
- tsubaki.rb
- - test_model.rb
- - corporate_number_spec.rb
  - corporate_number_validator_spec.rb
  - my_number_spec.rb
  - my_number_validator_spec.rb
- spec_helper.rb
- tsubaki_spec.rb
.gitignore
.rspec
.rubocop.yml
.rubocop_todo.yml
.ruby-version
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE.txt
Rakefile
README.md
tsubaki.gemspec

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/kufu/tsubaki

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd tsubaki

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Ruby

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

$ bundle

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Tsubaki [![Build Status](https://github.com/kufu/tsubaki/actions/workflows/test.yml/badge.svg)](https://github.com/kufu/tsubaki/actions/workflows/test.yml)

![tsubaki_1427x327](https://cloud.githubusercontent.com/assets/2214179/11577574/0f3394d6-9a62-11e5-81ee-7386c29c30e1.png)

Each resident in Japan is notified of his or her own Individual Number (a.k.a. **"My Number"**) beginning in October 2015, and each company is given its own **Corporate Number** likewise.

This gem provides both **My Number** and **Corporate Number** validators which inspect the format and (optionally) the check digit.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'tsubaki'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install tsubaki

## Usage

### My Number

A My Number consists of 12 digits & the last digit is used as a check digit.

To validate the format of an attribute, add the following to your model:

```ruby
# Verifies the format and its check digit with `strict` option:
validates :digits, my_number: { strict: true, allow_blank: true }

# Without strict option, it verifies only the length of the digits:
validates :digits, my_number: true

# Or if a My Number contains any dividers, specify it:
validates :digits, my_number: { strict: true, divider: '-' } # => 4652-8126-6333 should be valid
```

### Corporate Number

A Corporate Number consists of 13 digits & the first digit is used as a check digit.

To validate the format of an attribute, add the following to your model:

```ruby
# Verifies the format and its check digit with `strict` option:
validates :digits, corporate_number: { strict: true, allow_blank: true }

# Without strict option, it verifies only the length of the digits:
validates :digits, corporate_number: true

# Or if a Corporate Number contains any dividers, specify it:
validates :digits, corporate_number: { strict: true, divider: '-' } # => 5-8356-7825-6246 should be valid
```

## Goodies

### Rspec matchers

To ensure appropriate validations are specified, Tsubaki includes rspec matchers.

```ruby
# In spec_helper.rb, you'll need to require the matchers:
require 'tsubaki/matchers'

# And include the module:
RSpec.configure do |config|
  config.include Tsubaki::Shoulda::Matchers
end
```

```ruby
describe User do
  # For My Number validation
  it { should validate_my_number_of(:digits) }

# To ensure options:
  it { should validate_my_number_of(:digits).strict.with_divider('-').allow_blank }
end

describe Company do
  # For Corporate Number validation
  it { should validate_corporate_number_of(:digits) }

# To ensure options:
  it { should validate_corporate_number_of(:digits).strict.with_divider('-') }
end
```

### Random number generators

You can obtain a random yet having valid check digit numbers.
These are useful when creating dummy records.

```ruby
Tsubaki::MyNumber.rand # => 765895492872
Tsubaki::CorporateNumber.rand # => 5868731863533
```

[擬似マイナンバーくん](https://my-number-kun.herokuapp.com/) demonstrates the random number generators.

## 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/kufu/tsubaki.

## Code of Conduct

Everyone interacting in the tsubaki project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kufu/tsubaki/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://github.com/kufu/tsubaki/blob/master/LICENSE.txt)).