CPF/CNPJ 验证、生成与格式化库使用教程

CPF/CNPJ 验证、生成与格式化库使用教程

1. 项目目录结构及介绍

以下是 cpf_cnpj 库的基本目录结构：

.
├── bin       # 包含命令行工具的可执行文件
├── lib       # 主要代码库，存放核心功能的 Ruby 文件
│   └── cpf_cnpj.rb     # CPF 和 CNPJ 的主要类
├── test      # 测试用例目录
└── ...

• bin: 这个目录包含了两个命令行工具——cpf 和 cnpj。
• lib: 核心代码存储在这里，特别是 cpf_cnpj.rb 文件，它实现了 CPF 和 CNPJ 的验证、生成和格式化功能。
• test: 测试目录包含对库功能的测试用例。

2. 项目的启动文件介绍

虽然这个库不包含一个传统的 "启动" 文件，但是你可以通过以下方式来交互式地使用它的功能：

require 'cpf_cnpj'
# 现在你可以使用 CPF 和 CNPJ 类进行验证、生成和格式化操作了

如果你想要从命令行运行 cpf_cnpj 工具，可以分别执行 ./bin/cpf 或 ./bin/cnpj（前提是你处于项目根目录下）。

3. 项目的配置文件介绍

cpf_cnpj 库本身没有特定的配置文件，因为它旨在作为一个独立的模块直接集成到其他 Ruby 项目中。然而，在你的应用中，你可能需要创建自己的配置文件来管理如何使用此库。例如：

# config/initializers/cpf_cnpj.rb
require 'cpf_cnpj'

# 你可以设置默认的严格验证模式
CPF::DEFAULT_STRICT_VALIDATION = true

这样就可以全局设定CPF验证的严格性。不过请注意，这并不是 cpf_cnpj 库自带的功能，而是你应用程序中的自定义配置。

---

通过以上介绍，你应该了解了 cpf_cnpj 库的基础结构和如何在自己的项目中使用它。接下来，你可以尝试导入库并在你的 Ruby 程序中利用 CPF 和 CNPJ 功能了。