Values 使用与技术文档

一、安装指南

在开始使用Values之前，请确保您的系统中已经安装了Ruby环境。接下来，您可以通过Ruby的gem包管理器来安装Values库。

在终端中执行以下命令：

gem install values

该命令将会下载并安装Values库及其所有依赖。

二、项目使用说明

Values是一个用于在Ruby中创建值对象的微小库。通过Value类创建的类类似于使用Struct或OpenStruct创建的类，但解决了它们存在的两个问题：参数数量不足时允许字段为nil，以及对象是可变的。

创建值对象

使用Values创建的类会要求构造器提供预期的参数，并且实例是不可变的。

Point = Value.new(:x, :y)
p = Point.new(1, 2)

如果尝试使用不正确的参数数量来创建对象，将会抛出错误。

p = Point.new(1)
# ArgumentError: wrong number of arguments, 1 for 2

尝试修改实例的属性也会抛出错误。

p.x = 3
# NoMethodError: undefined method `x=' for #<Point:...

使用哈希创建实例

Values还提供了一个替代的构造器，它接受一个哈希。

p = Point.with(x: 3, y: 4)

复制和替换字段

Values支持使用哈希复制和替换字段。

p = Point.with(x: 1, y: -1)
q = p.with(y: 2)

转换为哈希

Values支持将值对象转换为哈希。

Point.with(x: 1, y: -1).to_h
# {:x=>1, :y=>-1}

自定义值对象

Values支持自定义继承自Value.new的值对象。

class Point < Value.new(:x, :y)
  def to_s
    "<Point at (#{x}, #{y})>"
  end
end

p = Point.new(1, 2)
puts p.to_s
# "<Point at (1, 2)>"

三、项目API使用文档

Values提供的API相对简单，主要包括：

• Value.new(*): 用于创建值对象的类。
• .with(hash): 用于从哈希创建值对象实例。
• #to_h: 将值对象实例转换为哈希。

更多API使用和细节，请参考官方文档。

四、项目安装方式

请参考安装指南部分，使用gem命令进行安装：

gem install values