frozen_record 0.26.2 → 0.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e162699e1ec4c32223be26afd36c1222bedeea90b8d0f26e05407641c9f01ccd
-  data.tar.gz: f4f6dcb51344bf99558e278a746e4ae5527355ed8771c7be26186af2cab630a1
+  metadata.gz: 38d59eb398601918420c427ca2608c32d88e272948f39f502c831e92be2d6017
+  data.tar.gz: 1762510ed02e71fdfc67fcfe6f41ba4db83f766231481490e0172a4ea0c91f5b
 SHA512:
-  metadata.gz: 594beed9888fc9379882815828f1d85a0941b143b03d177662fd02a8460867135003eeeb1391ad473f393c78f299c9e0c3ed45c9dcee88dee7bc7940ce3662c4
-  data.tar.gz: bcc049e4643b24bca1c98f8947a924c97f829a2a66798fbe798cbeba744d9934c0b81cbb2bb5c29f686d8d6af723f99299312d56e7e484524021c57613d02f4d
+  metadata.gz: a58d5c272f4beb88c10a2b8186f6664843da73ee67a920a706258b1d3fd0c719fe7dcfd27d1f97485304f743c2cef86b8d5ed8924d59c69d162edf389fb0ab34
+  data.tar.gz: 1d587f2b2c7043e1137537ae0eb44fd84e1643876d8ca30d1704dc41c45b0739fe6612c71db97d14f32de3950e52fee289fcec34969e57505b7aebb5403264e3

data/.github/workflows/main.yml

@@ -8,11 +8,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' , '3.1']
+        ruby: [ '2.5', '2.6', '2.7', '3.0' , '3.1', '3.2']
         minimal: [ false, true ]
     name: Ruby ${{ matrix.ruby }} tests, minimal=${{ matrix.minimal }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # Unreleased
 
+# v0.27.1
+
+- TestHelper.unload_fixture: handle models without data.
+
+# v0.27.0
+
+- Allow to define some richer attibute types, somewhat akin to Active Record `serialize` attributes. See the README for more information.
 - Fix `Model.find_by` fastpath raising an error when called before records are loaded.
 
+# v026.2
+
+- Properly load records when entiring the single attribute lookup fastpath.
+
 # v0.26.1
 
 - Optimized single attribute lookup.

data/README.md

@@ -1,7 +1,7 @@
 # FrozenRecord
 
-[![Build Status](https://secure.travis-ci.org/byroot/frozen_record.svg)](http://travis-ci.org/byroot/frozen_record)
-[![Gem Version](https://badge.fury.io/rb/frozen_record.svg)](http://badge.fury.io/rb/frozen_record)
+[![Build Status](https://secure.travis-ci.org/byroot/frozen_record.svg)](https://travis-ci.org/byroot/frozen_record)
+[![Gem Version](https://badge.fury.io/rb/frozen_record.svg)](https://badge.fury.io/rb/frozen_record)
 
 Active Record-like interface for **read only** access to static data files of reasonable size.
 
@@ -29,7 +29,7 @@ end
 ```
 
 But you also have to specify in which directory your data files are located.
-You can either do it globaly
+You can either do it globally
 
 ```ruby
 FrozenRecord::Base.base_path = '/path/to/some/directory'
@@ -42,9 +42,27 @@ class Country < FrozenRecord::Base
 end
 ```
 
-You can also specify a custom backend. Backends are classes that know how to
-load records from a static file. By default FrozenRecord expects an YAML file,
-but this option can be changed per model:
+FrozenRecord has two built-in backends, for JSON and YAML.
+Backends are classes that know how to load records from a static file.
+
+The default backend is YAML and it expects a file that looks like this:
+
+```yaml
+- id: 'se'
+  name: 'Sweden'
+  region: 'Europe'
+  language: 'Swedish'
+  population: 10420000
+- id: 'de'
+  name: 'Germany'
+  region: 'Europe'
+  language: 'German'
+  population: 83200000
+
+# …
+```
+
+You can also specify a custom backend:
 
 ```ruby
 class Country < FrozenRecord::Base
@@ -74,18 +92,18 @@ end
 
 FrozenRecord aim to replicate only modern Active Record querying interface, and only the non "string typed" ones.
 
-e.g
 ```ruby
 # Supported query interfaces
 Country.
   where(region: 'Europe').
   where.not(language: 'English').
+  where(population: 10_000_000..).
   order(id: :desc).
   limit(10).
   offset(2).
   pluck(:name)
 
-# Non supported query interfaces
+# Non-supported query interfaces
 Country.
   where('region = "Europe" AND language != "English"').
   order('id DESC')
@@ -141,7 +159,7 @@ Country.european.republics.part_of_nato.order(id: :desc)
 ## 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 repetedly, you can define indices for faster access.
+a collection repeatedly, you can define indices for faster access.
 
 ```ruby
 class Country < FrozenRecord::Base
@@ -154,6 +172,31 @@ 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](https://api.rubyonrails.org/v7.0.4/classes/ActiveRecord/AttributeMethods/Serialization/ClassMethods.html#method-i-serialize)).
+
+```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.
@@ -192,7 +235,7 @@ FrozenRecord::TestHelper.unload_fixtures
 Here's a Rails-specific example:
 
 ```ruby
-require "test_helper"
+require 'test_helper'
 require 'frozen_record/test_helper'
 
 class CountryTest < ActiveSupport::TestCase
@@ -205,7 +248,7 @@ class CountryTest < ActiveSupport::TestCase
     FrozenRecord::TestHelper.unload_fixtures
   end
 
-  test "countries have a valid name" do
+  test 'countries have a valid name' do
   # ...
 ```
 

data/lib/frozen_record/base.rb

@@ -30,8 +30,10 @@ module FrozenRecord
 
     class_attribute :base_path, :primary_key, :backend, :auto_reloading, :default_attributes, instance_accessor: false
     class_attribute :index_definitions, instance_accessor: false
+    class_attribute :attribute_deserializers, instance_accessor: false
     class_attribute :max_records_scan, instance_accessor: false
     self.index_definitions = {}.freeze
+    self.attribute_deserializers = {}.freeze
 
     self.primary_key = 'id'
 
@@ -154,6 +156,10 @@ module FrozenRecord
         self.index_definitions = index_definitions.merge(index.attribute => index).freeze
       end
 
+      def attribute(attribute, klass)
+        self.attribute_deserializers = attribute_deserializers.merge(attribute.to_s => klass).freeze
+      end
+
       def memsize(object = self, seen = Set.new.compare_by_identity)
         return 0 unless seen.add?(object)
 
@@ -195,8 +201,8 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          if default_attributes
-            records = records.map { |r| assign_defaults!(r.dup).freeze }.freeze
+          if attribute_deserializers.any? || default_attributes
+            records = records.map { |r| assign_defaults!(deserialize_attributes!(r.dup)).freeze }.freeze
           end
           @attributes = list_attributes(records).freeze
           define_attribute_methods(@attributes.to_a)
@@ -214,7 +220,7 @@ module FrozenRecord
       private :load
 
       def new(attrs = {})
-        load(assign_defaults!(attrs.transform_keys(&:to_s)))
+        load(assign_defaults!(deserialize_attributes!(attrs.transform_keys(&:to_s))))
       end
 
       private
@@ -241,6 +247,18 @@ module FrozenRecord
         record
       end
 
+      def deserialize_attributes!(record)
+        if attribute_deserializers.any?
+          attribute_deserializers.each do |key, deserializer|
+            if record.key?(key)
+              record[key] = deserializer.load(record[key])
+            end
+          end
+        end
+
+        record
+      end
+
       def method_missing(name, *args)
         if name.to_s =~ FIND_BY_PATTERN
           return dynamic_match($1, args, $2.present?)

data/lib/frozen_record/compact.rb

@@ -13,8 +13,8 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          if default_attributes
-            records = records.map { |r| assign_defaults!(r.dup).freeze }.freeze
+          if attribute_deserializers.any? || default_attributes
+            records = records.map { |r| assign_defaults!(deserialize_attributes!(r.dup)).freeze }.freeze
           end
           @attributes = list_attributes(records).freeze
           build_attributes_cache

data/lib/frozen_record/test_helper.rb

@@ -12,7 +12,7 @@ module FrozenRecord
 
         return if @cache.key?(model_class)
 
-        @cache[model_class] ||= model_class.base_path
+        @cache[model_class] = base_path_if_file_present(model_class)
 
         model_class.base_path = alternate_base_path
         model_class.load_records(force: true)
@@ -26,9 +26,10 @@ module FrozenRecord
         return unless @cache.key?(model_class)
 
         old_base_path = @cache[model_class]
-        model_class.base_path = old_base_path
-        model_class.load_records(force: true)
-
+        if old_base_path
+          model_class.base_path = old_base_path
+          model_class.load_records(force: true)
+        end
         @cache.delete(model_class)
       end
 
@@ -40,6 +41,19 @@ module FrozenRecord
 
       private
 
+      # Checks for the existence of the file for the frozen_record in the default directory.
+      # Returns the base_path if the file is present, otherwise nil.
+      # Some tests define specific test classes that do ONLY exist in the alternate directory.
+      # As `unload_fixture(s)` tries to force load the default file, it would raise an error for
+      # the "test only" fixtures. The nil value in the cache handles that case gracefully.
+      def base_path_if_file_present(model_class)
+        if File.exist?(model_class.file_path)
+          model_class.base_path
+        else
+          nil
+        end
+      end
+
       def ensure_model_class_is_frozenrecord(model_class)
         unless model_class < FrozenRecord::Base
           raise ArgumentError, "Model class (#{model_class}) does not inherit from #{FrozenRecord::Base}"

data/lib/frozen_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FrozenRecord
-  VERSION = '0.26.2'
+  VERSION = '0.27.1'
 end

data/spec/fixtures/countries.yml.erb

@@ -9,6 +9,7 @@
   nato: true
   king: Elisabeth II
   continent: North America
+  currency_code: CAD
 
 - id: 2
   name: France
@@ -29,3 +30,4 @@
   updated_at: 2014-02-12T19:02:03-02:00
   continent: Europe
   available: false
+  currency_code: EUR

data/spec/fixtures/test_helper/only_in_tests.yml.erb

@@ -0,0 +1,3 @@
+---
+- id: 1
+  name: Some continent

data/spec/frozen_record_spec.rb

@@ -80,6 +80,41 @@ RSpec.shared_examples 'main' do
 
   end
 
+  describe '.attribute' do
+
+    it 'deserializes the attribute' do
+      expect(country_model.find_by(name: 'Canada').continent).to be_a(TectonicString)
+    end
+
+    it 'sets the default value as default' do
+      expect(country_model.find_by(name: 'France').currency_code).to be == CurrencyCode.load("EUR")
+    end
+
+    it 'returns the first matching record' do
+      country = Country.find_by(currency_code: CurrencyCode.load('EUR'))
+      expect(country.name).to be == 'France'
+    end
+
+    it 'returns nil if record not found' do
+      country = Country.find_by(currency_code: CurrencyCode.load('THB'))
+      expect(country).to be_nil
+    end
+
+    it 'raises if no record found!' do
+      expect {
+        Country.find_by!(currency_code: CurrencyCode.load('THB'))
+      }.to raise_error(FrozenRecord::RecordNotFound)
+    end
+
+    it 'deserializes in the initializer' do
+      expect(country_model.new(currency_code: "CHF").currency_code).to be == CurrencyCode.load('CHF')
+    end
+    
+    it 'also sets the default in the initializer' do
+      expect(country_model.new.currency_code).to be == CurrencyCode.load('EUR')
+    end
+  end
+
   describe '.scope' do
 
     it 'defines a scope method' do
@@ -189,6 +224,7 @@ RSpec.shared_examples 'main' do
         'continent' => 'North America',
         'available' => true,
         'contemporary' => true,
+        'currency_code' => CurrencyCode.load('CAD'),
       }
     end
 

data/spec/support/country.rb

@@ -1,9 +1,26 @@
+class CurrencyCode
+  class << self
+    def load(value)
+      value.to_sym
+    end
+  end
+end
+
+class TectonicString < String
+  class << self
+    alias_method :load, :new
+  end
+end
+
 class Country < FrozenRecord::Base
-  self.default_attributes = { contemporary: true, available: true }
+  self.default_attributes = { contemporary: true, available: true, currency_code: CurrencyCode.load('EUR') }
 
   add_index :name, unique: true
   add_index :continent
 
+  attribute :currency_code, CurrencyCode
+  attribute :continent, TectonicString
+
   def self.republics
     where(king: nil)
   end

data/spec/test_helper_spec.rb

@@ -49,6 +49,18 @@ describe 'test fixture loading' do
       expect(Continent.count).to be == 1
       expect(Country.count).to be == 3
     end
+
+    context "when the test fixture does not exist in normal base path" do
+      class OnlyInTest < FrozenRecord::Base; end
+      before do
+        test_fixtures_base_path = File.join(File.dirname(__FILE__), 'fixtures', 'test_helper')
+        FrozenRecord::TestHelper.load_fixture(OnlyInTest, test_fixtures_base_path)
+      end
+      it 'unload fixture gracefully recovers from an ' do
+
+        expect { FrozenRecord::TestHelper.unload_fixture(OnlyInTest) }.not_to raise_error
+      end
+    end
   end
 
   describe '.unload_fixtures' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.26.2
+  version: 0.27.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -95,6 +95,7 @@ files:
 - spec/fixtures/prices.yml.erb
 - spec/fixtures/test_helper/continents.yml.erb
 - spec/fixtures/test_helper/countries.yml.erb
+- spec/fixtures/test_helper/only_in_tests.yml.erb
 - spec/frozen_record_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: ActiveRecord like interface to read only access and query static YAML files
@@ -136,6 +137,7 @@ test_files:
 - spec/fixtures/prices.yml.erb
 - spec/fixtures/test_helper/continents.yml.erb
 - spec/fixtures/test_helper/countries.yml.erb
+- spec/fixtures/test_helper/only_in_tests.yml.erb
 - spec/frozen_record_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb