frozen_record 0.20.1 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c98f13b693b4c7bceae48a308722c3681a678033855f40995a10fd82c0faee8
-  data.tar.gz: ff4ef784946b6fc9f067caf8e26d50433c3c396716ead1c953dd324528861ab2
+  metadata.gz: 46d80cfe87901ec547852256bff7eed06ac990a7bb9705b93fa13464354c5af5
+  data.tar.gz: 63f48c770a8e86d867382f0333f1c5d6d48b64ece3b849717fd840945f0781ff
 SHA512:
-  metadata.gz: e25090babf81d5ffa18a26acecf5af68d3424866b848508838ded880196d2178f994ce586be9bee8d63db71b3c84159ed2b4fac2c7e90f26414b9fbff4c69598
-  data.tar.gz: 384749f211db239a1d3964c16d5c23d4af4261ee052d6c0fa16f15f0d6a0ce5710df898b1f4e290c9cfa77c553d214668ab383ca33b09fbb82a03266db7a0324
+  metadata.gz: 0a5c7c217742022ff5d23532cc54c04f040ae83e9e05c191783a49db5012c2c95f2815a85a8743e00bd467bbff9fb451d94ba5a75cdd80bde71dee66ccb2a256
+  data.tar.gz: 587dc2bcd6cec261cd53c9be8cfe696b7f4944d1c55b5cea55945b7826112eed2829a323c617c906dfcd039d72578e4b4ba5cb790a1ba1131277c6076dafcafc

data/.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        minimal: [ false, true ]
+    name: Ruby ${{ matrix.ruby }} tests, minimal=${{ matrix.minimal }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('Gemfile', 'frozen_record.gemspec') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - name: Bundle install
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --path=vendor/bundle
+      - name: Run tests
+        env:
+          MINIMAL: ${{ matrix.minimal }}
+        run: bundle exec rake

data/README.md

@@ -1,8 +1,6 @@
 # FrozenRecord
 
 [![Build Status](https://secure.travis-ci.org/byroot/frozen_record.svg)](http://travis-ci.org/byroot/frozen_record)
-[![Code Climate](https://codeclimate.com/github/byroot/frozen_record.svg)](https://codeclimate.com/github/byroot/frozen_record)
-[![Coverage Status](https://coveralls.io/repos/byroot/frozen_record/badge.svg)](https://coveralls.io/r/byroot/frozen_record)
 [![Gem Version](https://badge.fury.io/rb/frozen_record.svg)](http://badge.fury.io/rb/frozen_record)
 
 ActiveRecord-like interface for **read only** access to static data files.

data/benchmark/querying

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative 'setup'
+
+records = FrozenRecord::Backends::Yaml.load(Country.file_path)
+large_records = 100.times.flat_map do |i|
+  records.map do |record|
+    new_record = record.dup
+    new_record['id'] += 10 * i
+    new_record['name'] += i.to_s
+    new_record
+  end
+end
+
+File.write('/tmp/frozen-record-bench-countries.yml', YAML.dump(large_records))
+
+class LargeCountry < Country
+  class << self
+    def file_path
+      '/tmp/frozen-record-bench-countries.yml'
+    end
+  end
+end
+
+puts "=== simple scalar match ==="
+Benchmark.ips do |x|
+  x.report('simple') { LargeCountry.nato.size }
+end
+
+puts "=== range match ==="
+Benchmark.ips do |x|
+  x.report('range') { LargeCountry.where(density: 100...200).size }
+end

data/frozen_record.gemspec

@@ -22,9 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activemodel'
   spec.add_runtime_dependency 'dedup'
 
-  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'coveralls'
 end

data/lib/frozen_record.rb

@@ -1,30 +1,5 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require 'set'
-require 'active_support/all'
-require 'active_model'
-
-require 'dedup'
-
-require 'frozen_record/version'
-require 'frozen_record/scope'
-require 'frozen_record/index'
-require 'frozen_record/base'
-require 'frozen_record/compact'
-
-module FrozenRecord
-  RecordNotFound = Class.new(StandardError)
-
-  class << self
-    attr_accessor :deprecated_yaml_erb_backend
-
-    def eager_load!
-      Base.descendants.each(&:eager_load!)
-    end
-  end
-
-  self.deprecated_yaml_erb_backend = true
-end
-
+require 'frozen_record/minimal'
+require 'frozen_record/serialization'
 require 'frozen_record/railtie' if defined?(Rails)

data/lib/frozen_record/backends/empty.json

@@ -0,0 +1 @@
+true

data/lib/frozen_record/backends/json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'json'
 
 module FrozenRecord
   module Backends
@@ -9,9 +10,26 @@ module FrozenRecord
         "#{model_name.underscore.pluralize}.json"
       end
 
-      def load(file_path)
-        json_data = File.read(file_path)
-        JSON.parse(json_data) || []
+      if JSON.respond_to?(:load_file)
+        supports_freeze = begin
+          JSON.load_file(File.expand_path('../empty.json', __FILE__), freeze: true)
+        rescue ArgumentError
+          false
+        end
+
+        if supports_freeze
+          def load(file_path)
+            JSON.load_file(file_path, freeze: true) || Dedup::EMPTY_ARRAY
+          end
+        else
+          def load(file_path)
+            Dedup.deep_intern!(JSON.load_file(file_path) || Dedup::EMPTY_ARRAY)
+          end
+        end
+      else
+        def load(file_path)
+          Dedup.deep_intern!(JSON.parse(File.read(file_path)) || Dedup::EMPTY_ARRAY)
+        end
       end
     end
   end

data/lib/frozen_record/backends/yaml.rb

@@ -3,6 +3,8 @@
 module FrozenRecord
   module Backends
     module Yaml
+      autoload :ERB, 'erb'
+
       extend self
 
       # Transforms the model name into a valid filename.
@@ -34,15 +36,49 @@ module FrozenRecord
             end
           end
 
-          YAML.load(yml_data) || []
+          load_string(yml_data)
         else
           if file_path.end_with?('.erb')
-            YAML.load(ERB.new(File.read(file_path)).result) || []
+            load_string(ERB.new(File.read(file_path)).result)
           else
-            YAML.load_file(file_path) || []
+            load_file(file_path)
           end
         end
       end
+
+      private
+
+      supports_freeze = begin
+        YAML.load_file(File.expand_path('../empty.json', __FILE__), freeze: true)
+      rescue ArgumentError
+        false
+      end
+
+      if YAML.respond_to?(:unsafe_load_file)
+        def load_file(path)
+          YAML.unsafe_load_file(path, freeze: true) || Dedup::EMPTY_ARRAY
+        end
+
+        def load_string(yaml)
+          YAML.unsafe_load(yaml, freeze: true) || Dedup::EMPTY_ARRAY
+        end
+      elsif supports_freeze
+        def load_file(path)
+          YAML.load_file(path, freeze: true) || Dedup::EMPTY_ARRAY
+        end
+
+        def load_string(yaml)
+          YAML.load(yaml, freeze: true) || Dedup::EMPTY_ARRAY
+        end
+      else
+        def load_file(path)
+          Dedup.deep_intern!(YAML.load_file(path) || Dedup::EMPTY_ARRAY)
+        end
+
+        def load_string(yaml)
+          Dedup.deep_intern!(YAML.load(yaml) || Dedup::EMPTY_ARRAY)
+        end
+      end
     end
   end
 end

data/lib/frozen_record/base.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'set'
 require 'active_support/descendants_tracker'
 require 'frozen_record/backends'
-require 'objspace'
 
 module FrozenRecord
   class Base
@@ -11,11 +9,6 @@ module FrozenRecord
     extend ActiveModel::Naming
     include ActiveModel::Conversion
     include ActiveModel::AttributeMethods
-    include ActiveModel::Serializers::JSON
-
-    if defined? ActiveModel::Serializers::Xml
-      include ActiveModel::Serializers::Xml
-    end
 
     FIND_BY_PATTERN = /\Afind_by_(\w+)(!?)/
     FALSY_VALUES = [false, nil, 0, -''].to_set
@@ -52,7 +45,7 @@ module FrozenRecord
       alias_method :set_default_attributes, :default_attributes=
       private :set_default_attributes
       def default_attributes=(default_attributes)
-        set_default_attributes(Dedup.deep_intern!(default_attributes.stringify_keys))
+        set_default_attributes(Dedup.deep_intern!(default_attributes.transform_keys(&:to_s)))
       end
 
       alias_method :set_primary_key, :primary_key=
@@ -90,8 +83,9 @@ module FrozenRecord
         store[:scope] = scope
       end
 
-      delegate :find, :find_by_id, :find_by, :find_by!, :where, :first, :first!, :last, :last!, :pluck, :ids, :order, :limit, :offset,
-               :minimum, :maximum, :average, :sum, :count, to: :current_scope
+      delegate :each, :find, :find_each, :find_by_id, :find_by, :find_by!, :where, :first, :first!, :last, :last!,
+               :pluck, :ids, :order, :limit, :offset, :minimum, :maximum, :average, :sum, :count,
+               to: :current_scope
 
       def file_path
         raise ArgumentError, "You must define `#{name}.base_path`" unless base_path
@@ -146,8 +140,9 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          records.each { |r| assign_defaults!(r) }
-          records = Dedup.deep_intern!(records)
+          if default_attributes
+            records = records.map { |r| assign_defaults!(r.dup).freeze }.freeze
+          end
           @attributes = list_attributes(records).freeze
           define_attribute_methods(@attributes.to_a)
           records = records.map { |r| load(r) }.freeze
@@ -164,7 +159,7 @@ module FrozenRecord
       private :load
 
       def new(attrs = {})
-        load(assign_defaults!(attrs.stringify_keys))
+        load(assign_defaults!(attrs.transform_keys(&:to_s)))
       end
 
       private
@@ -206,7 +201,9 @@ module FrozenRecord
       def list_attributes(records)
         attributes = Set.new
         records.each do |record|
-          attributes.merge(record.keys)
+          record.each_key do |key|
+            attributes.add(key)
+          end
         end
         attributes
       end
@@ -245,7 +242,7 @@ module FrozenRecord
     private
 
     def attribute?(attribute_name)
-      FALSY_VALUES.exclude?(self[attribute_name]) && self[attribute_name].present?
+      !FALSY_VALUES.include?(self[attribute_name]) && self[attribute_name].present?
     end
 
     def attribute_method?(attribute_name)

data/lib/frozen_record/compact.rb

@@ -13,8 +13,9 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          records.each { |r| assign_defaults!(r) }
-          records = Dedup.deep_intern!(records)
+          if default_attributes
+            records = records.map { |r| assign_defaults!(r.dup).freeze }.freeze
+          end
           @attributes = list_attributes(records).freeze
           build_attributes_cache
           define_attribute_methods(@attributes.to_a)
@@ -24,14 +25,8 @@ module FrozenRecord
         end
       end
 
-      if ActiveModel.gem_version >= Gem::Version.new('6.1.0.alpha')
-        def define_method_attribute(attr, owner:)
-          owner << "attr_reader #{attr.inspect}"
-        end
-      else
-        def define_method_attribute(attr)
-          generated_attribute_methods.attr_reader(attr)
-        end
+      def define_method_attribute(attr, **)
+        generated_attribute_methods.attr_reader(attr)
       end
 
       attr_reader :_attributes_cache
@@ -73,7 +68,7 @@ module FrozenRecord
 
     def attribute?(attribute_name)
       val = self[attribute_name]
-      Base::FALSY_VALUES.exclude?(val) && val.present?
+      !Base::FALSY_VALUES.include?(val) && val.present?
     end
   end
 end

data/lib/frozen_record/index.rb

@@ -19,12 +19,11 @@ module FrozenRecord
       false
     end
 
-    def query(value)
-      case value
-      when Array, Range
-        lookup_multi(value)
+    def query(matcher)
+      if matcher.ranged?
+        lookup_multi(matcher.value)
       else
-        lookup(value)
+        lookup(matcher.value)
       end
     end
 

data/lib/frozen_record/minimal.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'set'
+require 'active_model'
+
+require 'dedup'
+
+require 'frozen_record/version'
+require 'frozen_record/scope'
+require 'frozen_record/index'
+require 'frozen_record/base'
+require 'frozen_record/compact'
+
+module FrozenRecord
+  RecordNotFound = Class.new(StandardError)
+
+  class << self
+    attr_accessor :deprecated_yaml_erb_backend
+
+    def eager_load!
+      Base.descendants.each(&:eager_load!)
+    end
+  end
+
+  self.deprecated_yaml_erb_backend = true
+end

data/lib/frozen_record/scope.rb

@@ -9,6 +9,7 @@ module FrozenRecord
     ].to_set
 
     delegate :first, :last, :length, :collect, :map, :each, :all?, :include?, :to_ary, :to_json, :as_json, :count, to: :to_a
+    alias_method :find_each, :each
     if defined? ActiveModel::Serializers::Xml
       delegate :to_xml, to: :to_a
     end
@@ -187,8 +188,8 @@ module FrozenRecord
       end
 
       records.select do |record|
-        unindexed_where_values.all? { |attr, value| compare_value(record[attr], value) } &&
-        !@where_not_values.any? { |attr, value| compare_value(record[attr], value) }
+        unindexed_where_values.all? { |attr, matcher| matcher.match?(record[attr]) } &&
+        !@where_not_values.any? { |attr, matcher| matcher.match?(record[attr]) }
       end
     end
 
@@ -234,16 +235,16 @@ module FrozenRecord
     end
 
     def array_delegable?(method)
-      Array.method_defined?(method) && DISALLOWED_ARRAY_METHODS.exclude?(method)
+      Array.method_defined?(method) && !DISALLOWED_ARRAY_METHODS.include?(method)
     end
 
     def where!(criterias)
-      @where_values += criterias.map { |k, v| [k.to_s, v] }
+      @where_values += criterias.map { |k, v| [k.to_s, Matcher.for(v)] }
       self
     end
 
     def where_not!(criterias)
-      @where_not_values += criterias.map { |k, v| [k.to_s, v] }
+      @where_not_values += criterias.map { |k, v| [k.to_s, Matcher.for(v)] }
       self
     end
 
@@ -266,9 +267,62 @@ module FrozenRecord
 
     private
 
-    def compare_value(actual, requested)
-      return actual == requested unless requested.is_a?(Array) || requested.is_a?(Range)
-      requested.include?(actual)
+    class Matcher
+      class << self
+        def for(value)
+          case value
+          when Array
+            IncludeMatcher.new(value)
+          when Range
+            CoverMatcher.new(value)
+          else
+            new(value)
+          end
+        end
+      end
+
+      attr_reader :value
+
+      def hash
+        self.class.hash ^ value.hash
+      end
+
+      def initialize(value)
+        @value = value
+      end
+
+      def ranged?
+        false
+      end
+
+      def match?(other)
+        @value == other
+      end
+
+      def ==(other)
+        self.class == other.class && value == other.value
+      end
+      alias_method :eql?, :==
+    end
+
+    class IncludeMatcher < Matcher
+      def ranged?
+        true
+      end
+
+      def match?(other)
+        @value.include?(other)
+      end
+    end
+
+    class CoverMatcher < Matcher
+      def ranged?
+        true
+      end
+
+      def match?(other)
+        @value.cover?(other)
+      end
     end
   end
 end

data/lib/frozen_record/serialization.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'frozen_record/base'
+
+module FrozenRecord
+  class Base
+    include ActiveModel::Serializers::JSON
+
+    if defined? ActiveModel::Serializers::Xml
+      include ActiveModel::Serializers::Xml
+    end
+  end
+end

data/lib/frozen_record/version.rb

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

data/spec/frozen_record_spec.rb

@@ -90,6 +90,32 @@ RSpec.shared_examples 'main' do
 
   end
 
+  describe '.each' do
+
+    it 'yields the records one by one' do
+      count = 0
+      Country.each do |country|
+        expect(country).to be_a Country
+        count += 1
+      end
+      expect(count).to be == Country.count
+    end
+
+  end
+
+  describe '.find_each' do
+
+    it 'yields the records one by one' do
+      count = 0
+      Country.find_each do |country|
+        expect(country).to be_a Country
+        count += 1
+      end
+      expect(count).to be == Country.count
+    end
+
+  end
+
   describe '.memsize' do
 
     it 'retuns the records memory footprint' do

data/spec/scope_spec.rb

@@ -180,6 +180,20 @@ describe 'querying' do
 
   end
 
+  describe '.find_each' do
+
+    it 'yields the records one by one' do
+      scope = Country.where(name: 'France')
+      count = 0
+      scope.find_each do |country|
+        expect(country).to be_a Country
+        count += 1
+      end
+      expect(count).to be == 1
+    end
+
+  end
+
   describe '.where' do
 
     it 'returns the records that match given criterias' do
@@ -415,7 +429,7 @@ describe 'querying' do
 
   end
 
-  describe '.as_json' do
+  describe '.as_json', exclude_minimal: true do
 
     it 'serialize the results' do
       json = Country.all.as_json
@@ -445,8 +459,8 @@ describe 'querying' do
     it 'returns true when the same scope has be rechained' do
       scope_a = Country.nato.republics.nato.republics
       scope_b = Country.republics.nato
-      expect(scope_a.instance_variable_get(:@where_values)).to be == [['nato', true], ['king', nil], ['nato', true], ['king', nil]]
-      expect(scope_b.instance_variable_get(:@where_values)).to be == [['king', nil], ['nato', true]]
+      expect(scope_a.instance_variable_get(:@where_values).map { |k, v| [k, v.value] }).to be == [['nato', true], ['king', nil], ['nato', true], ['king', nil]]
+      expect(scope_b.instance_variable_get(:@where_values).map { |k, v| [k, v.value] }).to be == [['king', nil], ['nato', true]]
       expect(scope_a).to be == scope_b
     end
   end

data/spec/spec_helper.rb

@@ -1,16 +1,16 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'pry'
-require 'simplecov'
-require 'coveralls'
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start
-
-require 'frozen_record'
+minimal = ENV['MINIMAL'] == 'true'
+require 'objspace'
+require 'time'
+
+if minimal
+  require 'frozen_record/minimal'
+else
+  require 'frozen_record'
+end
+
 require 'frozen_record/test_helper'
 
 FrozenRecord::Base.base_path = File.join(File.dirname(__FILE__), 'fixtures')
@@ -22,6 +22,7 @@ FrozenRecord.eager_load!
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.filter_run_excluding :exclude_minimal if minimal
 
   config.order = 'random'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.22.2
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
 - jean.boussier@gmail.com
@@ -115,26 +73,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - benchmark/attribute-read
 - benchmark/memory-usage
+- benchmark/querying
 - benchmark/setup.rb
 - frozen_record.gemspec
 - lib/frozen_record.rb
 - lib/frozen_record/backends.rb
+- lib/frozen_record/backends/empty.json
 - lib/frozen_record/backends/json.rb
 - lib/frozen_record/backends/yaml.rb
 - lib/frozen_record/base.rb
 - lib/frozen_record/compact.rb
 - lib/frozen_record/index.rb
+- lib/frozen_record/minimal.rb
 - lib/frozen_record/railtie.rb
 - lib/frozen_record/scope.rb
+- lib/frozen_record/serialization.rb
 - lib/frozen_record/test_helper.rb
 - lib/frozen_record/version.rb
 - spec/fixtures/animals.json
@@ -168,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: ActiveRecord like interface to read only access and query static YAML files

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-rvm:
-  - '2.5'
-  - '2.6'
-  - '2.7'