frozen_record 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a25a269067396d2e6054a57c514b1251e39dca90928e7bdd837bfbb9ef8d2cf
-  data.tar.gz: 77b55ee24e39590dd213c157b22e3707c8f551a051df34f516a1e9d061d4eb6a
+  metadata.gz: bfb835436fc605e43a6b928ae9e8149ec80f726dd0650801c3e1e2e4d46dba1d
+  data.tar.gz: 1b2d08e68b018cb8a0c18e68420dab5930c51c3cf42c559c841eb340b0b0226d
 SHA512:
-  metadata.gz: a1d23916d54278598ec3ba29e5c1000f4adb0f13566db9be7900e5344199e36fe02254539a531a26d8b2d211e62f3916438c98032e7166795fbbf1681a170b91
-  data.tar.gz: af66cb72d621f8d6008de238d7f0846bf576200437fbdead4cfcdd1d598af62ac4d29bd801efd14420bfddb4470301312eb992628e2c7185e21b8dbee0381f6e
+  metadata.gz: 8d7ae3739cc1a172d8a54e1f87513b307db69c937522032fbcf845a4f11141f7e373739f79c98e15216f6ce17ac4a0410cc6f72033b9a9cbb31ec260e650ea6c
+  data.tar.gz: 9f88ee2a8186533cbd8482704d2e02bc275e73af310b24801b7cebb37320ab6297038b3efa6368ea9ce0122de7aaaa56f1180fed4c9eefe1dc5de059e35ccbd0

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

@@ -24,6 +24,4 @@ Gem::Specification.new do |spec|
 
   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/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.

data/lib/frozen_record/base.rb

@@ -83,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
@@ -200,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

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/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
 
@@ -238,12 +239,12 @@ module FrozenRecord
     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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FrozenRecord
-  VERSION = '0.21.1'
+  VERSION = '0.22.0'
 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
@@ -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

@@ -2,16 +2,6 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 minimal = ENV['MINIMAL'] == 'true'
-
-require 'pry'
-require 'simplecov'
-require 'coveralls'
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start
-
 require 'objspace'
 
 if minimal

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,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
@@ -110,6 +82,7 @@ files:
 - Rakefile
 - benchmark/attribute-read
 - benchmark/memory-usage
+- benchmark/querying
 - benchmark/setup.rb
 - frozen_record.gemspec
 - lib/frozen_record.rb