hstore_translate 项目使用教程

hstore_translate 项目使用教程

hstore_translateRails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype项目地址:https://gitcode.com/gh_mirrors/hs/hstore_translate

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

hstore_translate 项目的目录结构如下：

hstore_translate/
├── Gemfile
├── MIT-LICENSE
├── README.md
├── Rakefile
├── lib/
│   ├── hstore_translate.rb
│   └── hstore_translate/
│       ├── exception.rb
│       ├── migration.rb
│       ├── translation.rb
│       └── version.rb
├── hstore_translate.gemspec
└── test/
    ├── active_record_test.rb
    ├── database.yml
    ├── schema.rb
    └── test_helper.rb

目录结构介绍

• Gemfile: 定义了项目所需的依赖。
• MIT-LICENSE: 项目的许可证文件。
• README.md: 项目的基本介绍和使用说明。
• Rakefile: 用于定义 Rake 任务。
• lib/: 包含项目的主要代码。
  • hstore_translate.rb: 项目的主文件。
  • hstore_translate/: 包含项目的各个模块。
    • exception.rb: 定义了异常类。
    • migration.rb: 包含数据库迁移相关的代码。
    • translation.rb: 包含翻译相关的代码。
    • version.rb: 定义了项目的版本号。
• hstore_translate.gemspec: 项目的 gemspec 文件，用于打包和发布。
• test/: 包含项目的测试代码。
  • active_record_test.rb: ActiveRecord 相关的测试。
  • database.yml: 数据库配置文件。
  • schema.rb: 数据库 schema 文件。
  • test_helper.rb: 测试辅助文件。

2. 项目的启动文件介绍

项目的启动文件主要是 lib/hstore_translate.rb，这个文件负责加载项目的各个模块，并初始化 hstore_translate 的功能。

require "hstore_translate/version"
require "hstore_translate/exception"
require "hstore_translate/migration"
require "hstore_translate/translation"

module HstoreTranslate
  # 模块内容
end

启动文件介绍

• require "hstore_translate/version": 加载版本信息。
• require "hstore_translate/exception": 加载异常处理模块。
• require "hstore_translate/migration": 加载数据库迁移模块。
• require "hstore_translate/translation": 加载翻译模块。
• module HstoreTranslate: 定义了主模块，包含了项目的核心功能。

3. 项目的配置文件介绍

项目的配置文件主要是 Gemfile 和 hstore_translate.gemspec。

Gemfile

Gemfile 定义了项目所需的依赖，例如 ActiveRecord 和 PostgreSQL 适配器。

source 'https://rubygems.org'

gem 'activerecord'
gem 'pg', :platform => :ruby
gem 'activerecord-jdbcpostgresql-adapter', :platform => :jruby
gem 'hstore_translate'

hstore_translate.gemspec

hstore_translate.gemspec 定义了项目的 gem 信息，包括名称、版本、作者、依赖等。

Gem::Specification.new do |spec|
  spec.name          = "hstore_translate"
  spec.version       = HstoreTranslate::VERSION
  spec.authors       = ["Rob Worley", "Cédric Fabianski"]
  spec.summary       = "Rails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype."
  spec.license       = "MIT"

  spec.files         = `git ls-files -z`.split("\x0")
  spec.require_paths = ["lib"]

  spec.add_dependency "activerecord", ">= 4.2.0"
  spec.add_development_dependency "database_cleaner"
  spec.add_development_dependency "minitest"
  spec.add_development_dependency "rake"
end

配置文件介绍

• Gemfile: 定义了项目的依赖，确保项目能够正常运行。
• hstore_translate.gemspec: 包含了项目的

hstore_translateRails I18n library for ActiveRecord model/data translation using PostgreSQL's hstore datatype项目地址:https://gitcode.com/gh_mirrors/hs/hstore_translate