Virtus 开源项目教程

Virtus 开源项目教程

virtus[DISCONTINUED ] Attributes on Steroids for Plain Old Ruby Objects项目地址:https://gitcode.com/gh_mirrors/vi/virtus

1. 项目的目录结构及介绍

Virtus 项目的目录结构如下：

virtus/
├── lib/
│   ├── virtus.rb
│   ├── virtus/
│   │   ├── attribute.rb
│   │   ├── class_methods.rb
│   │   ├── coercion.rb
│   │   ├── configuration.rb
│   │   ├── constructor.rb
│   │   ├── embedding.rb
│   │   ├── extensions.rb
│   │   ├── hash.rb
│   │   ├── inheritance.rb
│   │   ├── instance_methods.rb
│   │   ├── lazy_accessors.rb
│   │   ├── module_methods.rb
│   │   ├── notifications.rb
│   │   ├── options.rb
│   │   ├── reader.rb
│   │   ├── writer.rb
│   │   └── version.rb
│   └── virtus.rb
├── spec/
│   ├── attribute_spec.rb
│   ├── coercion_spec.rb
│   ├── configuration_spec.rb
│   ├── constructor_spec.rb
│   ├── embedding_spec.rb
│   ├── extensions_spec.rb
│   ├── hash_spec.rb
│   ├── inheritance_spec.rb
│   ├── instance_methods_spec.rb
│   ├── lazy_accessors_spec.rb
│   ├── module_methods_spec.rb
│   ├── notifications_spec.rb
│   ├── options_spec.rb
│   ├── reader_spec.rb
│   ├── writer_spec.rb
│   └── virtus_spec.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── virtus.gemspec

目录结构介绍

• lib/：包含 Virtus 项目的核心代码。
  • virtus.rb：主文件，加载 Virtus 库。
  • virtus/：包含 Virtus 的各种模块和功能文件。
• spec/：包含项目的测试文件。
• .gitignore：Git 忽略文件配置。
• .rspec：RSpec 配置文件。
• .travis.yml：Travis CI 配置文件。
• Gemfile：Ruby 依赖管理文件。
• LICENSE.txt：项目许可证。
• README.md：项目说明文档。
• Rakefile：Rake 任务配置文件。
• virtus.gemspec：Gem 包配置文件。

2. 项目的启动文件介绍

Virtus 项目的启动文件是 lib/virtus.rb。该文件负责加载 Virtus 库的所有必要文件和模块。

require 'virtus/attribute'
require 'virtus/class_methods'
require 'virtus/coercion'
require 'virtus/configuration'
require 'virtus/constructor'
require 'virtus/embedding'
require 'virtus/extensions'
require 'virtus/hash'
require 'virtus/inheritance'
require 'virtus/instance_methods'
require 'virtus/lazy_accessors'
require 'virtus/module_methods'
require 'virtus/notifications'
require 'virtus/options'
require 'virtus/reader'
require 'virtus/writer'
require 'virtus/version'

module Virtus
  def self.included(base)
    base.extend(ClassMethods)
    base.extend(ModuleMethods) if base.is_a?(Module)
  end
end

启动文件介绍

• 该文件通过 require 语句加载 Virtus 库的所有核心模块。
• Virtus 模块定义了一个 included 方法，当 Virtus 被包含在其他类或模块中时，会扩展 ClassMethods 和 ModuleMethods。

3. 项目的配置文件介绍

Virtus 项目的配置文件是 lib/virtus/configuration.rb。该文件定义了 Virtus 的配置选项和默认值。

module Virtus
  class Configuration
    attr_accessor :coerce

    def initialize
      @coerce = true
    end

    def coerce?
      !!@coerce
    end
 

virtus[DISCONTINUED ] Attributes on Steroids for Plain Old Ruby Objects项目地址:https://gitcode.com/gh_mirrors/vi/virtus