Stupidedi 技术文档

1. 安装指南

Stupidedi 是一个用于解析、生成、验证和操作 ASC X12 EDI 文档的高质量库。以下是安装 Stupidedi 的步骤：

1.1 使用 RubyGems 安装

Stupidedi 可以通过 RubyGems 进行安装。确保你已经安装了 Ruby 和 RubyGems，然后在终端中运行以下命令：

gem install stupidedi

1.2 从源码安装

如果你希望从源码安装 Stupidedi，可以按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/irobayna/stupidedi.git
   

2. 进入项目目录：

   cd stupidedi
   

3. 安装依赖：

   bundle install
   

4. 构建并安装 gem：

   rake build
   gem install pkg/stupidedi-<version>.gem
   

2. 项目的使用说明

Stupidedi 提供了丰富的功能来处理 ASC X12 EDI 文档。以下是使用 Stupidedi 的基本步骤：

2.1 解析 EDI 文档

你可以使用 Stupidedi 来解析 EDI 文档。以下是一个简单的示例：

require "stupidedi"

config = Stupidedi::Config.hipaa
parser = Stupidedi::Parser.build(config)

file = File.open("path/to/your/edi/file.edi")
result = parser.read(file)

if result.success?
  puts "解析成功！"
else
  puts "解析失败：#{result.failure}"
end

2.2 生成 EDI 文档

Stupidedi 还允许你生成 EDI 文档。以下是一个生成 EDI 文档的示例：

require "stupidedi"

config = Stupidedi::Config.hipaa
builder = Stupidedi::Parser::BuilderDsl.build(config)

builder.ISA "00", nil, "00", nil,
            "ZZ", "SUBMITTER ID",
            "ZZ", "RECEIVER ID",
            "990531", "1230", nil, "00501", "123456789", "1", "T", nil

builder.GS "HC", "SENDER ID", "RECEIVER ID", "19990531", "1230", "1", "X", "005010X222A1"

builder.ST "837", "0021"

# 继续添加其他段和元素

edi_document = builder.machine.zipper.tap(&:root).node
puts edi_document

3. 项目 API 使用文档

Stupidedi 提供了丰富的 API 来处理 EDI 文档。以下是一些常用的 API：

3.1 Stupidedi::Config.hipaa

该方法返回一个预配置的 HIPAA 配置文件，适用于处理 HIPAA 相关的 EDI 文档。

3.2 Stupidedi::Parser.build(config)

该方法用于创建一个 EDI 解析器实例。config 参数是一个配置对象，通常通过 Stupidedi::Config.hipaa 获取。

3.3 parser.read(file)

该方法用于解析指定的 EDI 文件。file 参数是一个文件对象，通常通过 File.open 获取。

3.4 BuilderDsl.build(config)

该方法用于创建一个 EDI 文档生成器实例。config 参数是一个配置对象，通常通过 Stupidedi::Config.hipaa 获取。

3.5 builder.ISA(...)

该方法用于生成 ISA 段。ISA 段是 EDI 文档的起始段，包含交换控制信息。

3.6 builder.GS(...)

该方法用于生成 GS 段。GS 段是功能组控制段，包含功能组控制信息。

3.7 builder.ST(...)

该方法用于生成 ST 段。ST 段是事务集控制段，包含事务集控制信息。

4. 项目安装方式

Stupidedi 可以通过多种方式安装，以下是两种常见的安装方式：

4.1 使用 RubyGems 安装

如果你已经安装了 Ruby 和 RubyGems，可以通过以下命令安装 Stupidedi：

gem install stupidedi

4.2 从源码安装

如果你希望从源码安装 Stupidedi，可以按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/irobayna/stupidedi.git
   

2. 进入项目目录：

   cd stupidedi
   

3. 安装依赖：

   bundle install
   

4. 构建并安装 gem：

   rake build
   gem install pkg/stupidedi-<version>.gem
   

通过以上步骤，你可以成功安装并使用 Stupidedi 来处理 ASC X12 EDI 文档。