frozen_record 0.27.0 → 0.27.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad9e1749e0b964178ce78eb8825cc64feddc347d6ac2952b5992cc97b5f4212
-  data.tar.gz: 107c164a1ba9442bf7ab5fa59c03400502c2e31b8ce2e7429e2cf2992e38fcbc
+  metadata.gz: d790a4c35575afe0294cdcaa88f0f75bdee110623f40bfddd1ea4edade4df7c0
+  data.tar.gz: 0c5e6cd922365269c4a320a92c7b196749ce2016f5a8bdeb887bdc191a83ebcf
 SHA512:
-  metadata.gz: 2297514000fb2ee38d534084285d16c3768a9795869e0af2955e134c6f08114f77128689d8aa8fd95fa775c7cba8732a9f34917a0b886d3286b07aa6a36f3f4e
-  data.tar.gz: ce33c77289242c3f1d2341491c644226dad7b14fe709544c2f706d5e37c02c9649a59902f8eab9898e532eea89a0d84905b278bc299b64c217d9a53861d487c5
+  metadata.gz: af254fb45c82cd57300fd613b513f1e423f102dc9dd3ddc5a2c99f0abd4b44cbd72b104b471795c8e1b9e91cda27d27760eea30fde2c682caef91b5ef1cc30e9
+  data.tar.gz: db4fd7fc5e5d5f00566a246b29ba8c0f337bfbf7043b6925ce7492ac7862372f4098c85f341b6b01672de47345055b10a9269f691fb2d9f0ee0623d2d8425799

data/.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
         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,5 +1,21 @@
 # Unreleased
 
+# v0.27.4
+
+- Also fix compatibility with Rails 8.0.0alpha: https://github.com/rails/rails/pull/52717. Missed a few places.
+
+# v0.27.3
+
+- Fix compatibility with Rails 8.0.0alpha: https://github.com/rails/rails/pull/52717
+
+# v0.27.2
+
+- Fix a Ruby warning that was emitted when `frozen_record` is loaded.
+
+# 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.

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.
 
@@ -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')
@@ -217,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
@@ -230,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

@@ -28,18 +28,14 @@ module FrozenRecord
     FIND_BY_PATTERN = /\Afind_by_(\w+)(!?)/
     FALSY_VALUES = [false, nil, 0, -''].to_set
 
-    class_attribute :base_path, :primary_key, :backend, :auto_reloading, :default_attributes, instance_accessor: false
+    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'
-
-    self.backend = FrozenRecord::Backends::Yaml
-
-    attribute_method_suffix -'?'
+    attribute_method_suffix '?'
 
     class ThreadSafeStorage
 
@@ -68,23 +64,20 @@ module FrozenRecord
         self.max_records_scan = previous_max_records_scan
       end
 
-      alias_method :set_default_attributes, :default_attributes=
-      private :set_default_attributes
+      def default_attributes
+        _default_attributes
+      end
+
       def default_attributes=(default_attributes)
-        set_default_attributes(default_attributes.transform_keys(&:to_s))
+        self._default_attributes = default_attributes.transform_keys(&:to_s)
       end
 
-      alias_method :set_primary_key, :primary_key=
-      private :set_primary_key
-      def primary_key=(primary_key)
-        set_primary_key(-primary_key.to_s)
+      def primary_key
+        _primary_key
       end
 
-      alias_method :set_base_path, :base_path=
-      private :set_base_path
-      def base_path=(base_path)
-       @file_path = nil
-       set_base_path(base_path)
+      def primary_key=(primary_key)
+        self._primary_key = -primary_key.to_s
       end
 
       attr_accessor :abstract_class
@@ -115,13 +108,11 @@ module FrozenRecord
 
       def file_path
         raise ArgumentError, "You must define `#{name}.base_path`" unless base_path
-        @file_path ||= begin
-          file_path = File.join(base_path, backend.filename(name))
-          if !File.exist?(file_path) && File.exist?("#{file_path}.erb")
-            "#{file_path}.erb"
-          else
-            file_path
-          end
+        file_path = File.join(base_path, backend.filename(name))
+        if !File.exist?(file_path) && File.exist?("#{file_path}.erb")
+          "#{file_path}.erb"
+        else
+          file_path
         end
       end
 
@@ -283,6 +274,10 @@ module FrozenRecord
 
     end
 
+    self.primary_key = 'id'
+
+    self.backend = FrozenRecord::Backends::Yaml
+
     def initialize(attrs = {})
       @attributes = attrs.freeze
     end

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.27.0'
+  VERSION = '0.27.4'
 end

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

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

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+$VERBOSE = true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 

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.27.0
+  version: 0.27.4
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2024-08-27 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.4.6
+rubygems_version: 3.5.17
 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