frozen_record 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4a597e4419873da69776c887c5ef35c812f785493cd9597d3d3ced891578ab
-  data.tar.gz: d46b86085ceeee261b39a281aab1c62a2551e872ad1f4696e8a7325b7cfa9a7a
+  metadata.gz: 9ad9e1749e0b964178ce78eb8825cc64feddc347d6ac2952b5992cc97b5f4212
+  data.tar.gz: 107c164a1ba9442bf7ab5fa59c03400502c2e31b8ce2e7429e2cf2992e38fcbc
 SHA512:
-  metadata.gz: 8e68a5dfb1d888de4f6dc72bb42ffdc1c08af87229b7bd0dcf107d1da9b48ef5b948adea5652b132cb497a1a8c15b513aa7ba8beea7c863b06f19de14ae02865
-  data.tar.gz: f787b5072efd3997fb41942c1d9b6014ee872d6faec12a4c5a77ef489a7039ed980987bbf4102ed7d9c5cd2b296e49c1bd6a25f578559969d200d875d6cdf877
+  metadata.gz: 2297514000fb2ee38d534084285d16c3768a9795869e0af2955e134c6f08114f77128689d8aa8fd95fa775c7cba8732a9f34917a0b886d3286b07aa6a36f3f4e
+  data.tar.gz: ce33c77289242c3f1d2341491c644226dad7b14fe709544c2f706d5e37c02c9649a59902f8eab9898e532eea89a0d84905b278bc299b64c217d9a53861d487c5

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ 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:

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Unreleased
 
+# 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

@@ -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'
@@ -141,7 +141,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 +154,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.

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'
 
@@ -137,6 +139,7 @@ module FrozenRecord
           criterias.each do |attribute, value|
             attribute = attribute.to_s
             if index = index_definitions[attribute]
+              load_records
               return index.lookup(value).first
             end
           end
@@ -153,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)
 
@@ -181,16 +188,21 @@ module FrozenRecord
         load_records
       end
 
+      def unload!
+        @records = nil
+        index_definitions.values.each(&:reset)
+        undefine_attribute_methods
+      end
+
       def load_records(force: false)
         if force || (auto_reloading && file_changed?)
-          @records = nil
-          undefine_attribute_methods
+          unload!
         end
 
         @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)
@@ -208,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
@@ -235,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FrozenRecord
-  VERSION = '0.26.1'
+  VERSION = '0.27.0'
 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/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/scope_spec.rb

@@ -101,7 +101,6 @@ describe 'querying' do
       country = Country.find_by_id(42)
       expect(country).to be_nil
     end
-
   end
 
   describe '.find_by' do
@@ -116,6 +115,11 @@ describe 'querying' do
       expect(country).to be_nil
     end
 
+    it 'load records' do
+      Country.unload!
+      country = Country.find_by(name: 'France')
+      expect(country.name).to be == 'France'
+    end
   end
 
   describe '.find_by!' do

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.27.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: ActiveRecord like interface to read only access and query static YAML files