Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
F

frozen_record

> 编程语言
Open source

Read only ActiveRecord-like interface to query static YAML files

447 stars0 likes1 views
WebsiteGitHub

About

Read only ActiveRecord-like interface to query static YAML files

FrozenRecord

Active Record-like interface for read only access to static data files of reasonable size.

Installation

Add this line to your application's Gemfile:

gem 'frozen_record'

And then execute:

$ bundle

Or install it yourself as:

$ gem install frozen_record

Models definition

Just like with Active Record, your models need to inherits from FrozenRecord::Base:

ruby
class Country  { where(continent: 'Europe' ) }

  def self.republics
    where(king: nil)
  end

  def self.part_of_nato
    where(nato: true)
  end
end

Country.european.republics.part_of_nato.order(id: :desc)

Supported query methods

  • where
  • where.not
  • order
  • limit
  • offset

Supported finder methods

  • find
  • first
  • last
  • to_a
  • exists?

Supported calculation methods

  • count
  • pick
  • pluck
  • ids
  • minimum
  • maximum
  • sum
  • average

Indexing

Querying is implemented as a simple linear search (O(n)). However if you are using Frozen Record with larger datasets, or are querying a collection repeatedly, you can define indices for faster access.

ruby
class Country < FrozenRecord::Base
  add_index :name, unique: true
  add_index :continent
end

Composite index keys are not supported.

The primary key isn't indexed by default.

Rich Types

The attribute method can be used to provide a custom class to convert an attribute to a richer type. The class must implement a load class method that takes the raw attribute value and returns the deserialized value (similar to ActiveRecord serialization).

ruby
class ContinentString < String
  class << self
    alias_method :load, :new
  end
end

Size = Struct.new(:length, :width, :depth) do
  def self.load(value) # value is lxwxd eg: "23x12x5"
    new(*value.split('x'))
  end
end

class Country < FrozenRecord::Base
  attribute :continent, ContinentString
  attribute :size, Size
end

Limitations

Frozen Record is not meant to operate on large unindexed datasets.

To ensure that it doesn't happen by accident, you can set FrozenRecord::Base.max_records_scan = 500 (or whatever limit makes sense to you), in your development and test environments. This setting will cause Frozen Record to raise an error if it has to scan more than max_records_scan records. This property can also be set on a per model basis.

Configuration

Reloading

By default the YAML files are parsed once and then cached in memory. But in development you might want changes to be reflected without having to restart your application.

For such cases you can set auto_reloading to true either globally or on a model basis:

ruby
FrozenRecord::Base.auto_reloading = true # Activate reloading for all models
Country.auto_reloading # Activate reloading for `Country` only

If you need manual reloading, you can call load_records(force: true) manually on your class.

Testing

Testing your FrozenRecord-backed models with test fixtures is made easier with:

ruby
require 'frozen_record/test_helper'

# During test/spec setup
test_fixtures_base_path = 'alternate/fixture/path'
FrozenRecord::TestHelper.load_fixture(Country, test_fixtures_base_path)

# During test/spec teardown
FrozenRecord::TestHelper.unload_fixtures

Here's a Rails-specific example:

ruby
require 'test_helper'
require 'frozen_record/test_helper'

class CountryTest < ActiveSupport::TestCase
  setup do
    test_fixtures_base_path = Rails.root.join('test/support/fixtures')
    FrozenRecord::TestHelper.load_fixture(Country, test_fixtures_base_path)
  end

  teardown do
    FrozenRecord::TestHelper.unload_fixtures
  end

  test 'countries have a valid name' do
  # ...

Contributors

FrozenRecord is a from scratch reimplementation of a Shopify project from 2007 named YamlRecord. So thanks to:

  • John Duff - @jduff
  • Dennis O'Connor - @dennisoconnor
  • Christopher Saunders - @csaunders
  • Jonathan Rudenberg - @titanous
  • Jesse Storimer - @jstorimer
  • Cody Fauser - @codyfauser
  • Tobias Lütke - @tobi

Issues· 9 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

Rubyruby

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言