frozen_record 0.19.3 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9976300538ac81378c16689a47f03994e79b65a6cbbf755fa986528d4324533
-  data.tar.gz: 5e9b6c08770cd5186025041b0c6244eff2360c5b096a532802d953527abd3d1c
+  metadata.gz: b998592ed0453f220a0679b3ee2aea49d1d5381a3a7c4d6e9286434e6e3b6c27
+  data.tar.gz: 3f430857f5b5626951360d2c28402c58b5751cb1ef2805f139558d600b7e1e1c
 SHA512:
-  metadata.gz: a00f10f827cd7e046d1f12433e913c39b9442dca95986cb395f81d28a685f3e7f4625814de1aeaf31654f4d2b8decab71938fe9999ccf5cb8c2fe3d3fbebe6ca
-  data.tar.gz: 070fa00130a5577cdb7441c14cb76d76f7290245f60b7b927081d169b4e86871f936716c6bfecb9859113df71791611f57546139ab80dcf1f4078a79e1e279a0
+  metadata.gz: cbc8307030df2b393d69499c7be236ef62349ad6f74b7fc9de914260748fd0919e293204b30ba31e377acf157acb90e9371d4ed50a77da955f60222694f74892
+  data.tar.gz: f211b9298137e71e098e841658341f0cceb3dd902f7974a5a9a7c2233173bd1016037832ba744f8966beb9045fa9c93068365ad5d9b7d64f9b68631e1b840ca1

data/.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+    name: Ruby ${{ matrix.ruby }} tests
+    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
+        run: bundle exec rake

data/frozen_record.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.5'
 
   spec.add_runtime_dependency 'activemodel'
-  spec.add_development_dependency 'bundler'
+  spec.add_runtime_dependency 'dedup'
+
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'

data/lib/frozen_record.rb

@@ -1,29 +1,5 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require 'set'
-require 'active_support/all'
-require 'active_model'
-
-require 'frozen_record/version'
-require 'frozen_record/scope'
-require 'frozen_record/index'
-require 'frozen_record/base'
-require 'frozen_record/compact'
-require 'frozen_record/deduplication'
-
-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

@@ -9,9 +9,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

@@ -34,15 +34,41 @@ 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 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(Deduplication.deep_deduplicate!(default_attributes.stringify_keys))
+        set_default_attributes(Dedup.deep_intern!(default_attributes.transform_keys(&:to_s)))
       end
 
       alias_method :set_primary_key, :primary_key=
@@ -146,8 +139,9 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          records.each { |r| assign_defaults!(r) }
-          records = Deduplication.deep_deduplicate!(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 +158,7 @@ module FrozenRecord
       private :load
 
       def new(attrs = {})
-        load(assign_defaults!(attrs.stringify_keys))
+        load(assign_defaults!(attrs.transform_keys(&:to_s)))
       end
 
       private

data/lib/frozen_record/compact.rb

@@ -13,13 +13,15 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          records.each { |r| assign_defaults!(r) }
-          records = Deduplication.deep_deduplicate!(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)
+          records = records.map { |r| load(r) }.freeze
           index_definitions.values.each { |index| index.build(records) }
-          records.map { |r| load(r) }.freeze
+          records
         end
       end
 
@@ -66,7 +68,7 @@ module FrozenRecord
 
     def attributes=(attributes)
       self.class.attributes.each do |attr|
-        instance_variable_set(self.class._attributes_cache[attr], Deduplication.deep_deduplicate!(attributes[attr]))
+        instance_variable_set(self.class._attributes_cache[attr], Dedup.deep_intern!(attributes[attr]))
       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

@@ -2,7 +2,7 @@
 
 module FrozenRecord
   class Scope
-    BLACKLISTED_ARRAY_METHODS = [
+    DISALLOWED_ARRAY_METHODS = [
       :compact!, :flatten!, :reject!, :reverse!, :rotate!, :map!,
       :shuffle!, :slice!, :sort!, :sort_by!, :delete_if,
       :keep_if, :pop, :shift, :delete_at, :compact
@@ -227,13 +227,14 @@ module FrozenRecord
         super
       end
     end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
     def delegate_to_class(*args, &block)
       scoping { @klass.public_send(*args, &block) }
     end
 
     def array_delegable?(method)
-      Array.method_defined?(method) && BLACKLISTED_ARRAY_METHODS.exclude?(method)
+      Array.method_defined?(method) && DISALLOWED_ARRAY_METHODS.exclude?(method)
     end
 
     def where!(criterias)

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.19.3'
+  VERSION = '0.21.0'
 end

data/spec/scope_spec.rb

@@ -193,6 +193,11 @@ describe 'querying' do
       expect(countries.length).to be == 0
     end
 
+    it 'is chainable with methods of the form `def method(*args, **kargs)' do
+      countries = Country.republics.continent_and_capital('Europe', capital: 'Paris')
+      expect(countries.length).to be == 1
+    end
+
     it 'can be used with arrays' do
       countries = Country.where(id: [1,2])
       expect(countries.length).to be == 2

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 SimpleCov.start
 
+require 'objspace'
 require 'frozen_record'
 require 'frozen_record/test_helper'
 

data/spec/support/country.rb

@@ -12,6 +12,10 @@ class Country < FrozenRecord::Base
     where(nato: true)
   end
 
+  def self.continent_and_capital(continent, capital:)
+    where(continent: continent, capital: capital)
+  end
+
   def reverse_name
     name.reverse
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.19.3
+  version: 0.21.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dedup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -101,9 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,17 +114,18 @@ files:
 - 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/deduplication.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/deduplication_spec.rb
 - spec/fixtures/animals.json
 - spec/fixtures/cars.yml
 - spec/fixtures/countries.yml.erb
@@ -156,12 +157,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: ActiveRecord like interface to read only access and query static YAML files
 test_files:
-- spec/deduplication_spec.rb
 - spec/fixtures/animals.json
 - spec/fixtures/cars.yml
 - spec/fixtures/countries.yml.erb

data/.travis.yml

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

data/lib/frozen_record/deduplication.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/object/duplicable'
-
-module FrozenRecord
-  module Deduplication
-    extend self
-
-    # We deduplicate data in place because it is assumed it directly
-    # comes from the parser, and won't be held by anyone.
-    #
-    # Frozen Hashes and Arrays are ignored because they are likely
-    # the result of the use of YAML anchor. Meaning we already deduplicated
-    # them.
-    if RUBY_VERSION >= '2.7'
-      def deep_deduplicate!(data)
-        case data
-        when Hash
-          return data if data.frozen?
-          data.transform_keys! { |k| deep_deduplicate!(k) }
-          data.transform_values! { |v| deep_deduplicate!(v) }
-          data.freeze
-        when Array
-          return data if data.frozen?
-          data.map! { |d| deep_deduplicate!(d) }.freeze
-        when String
-          -data
-        else
-          data.duplicable? ? data.freeze : data
-        end
-      end
-    else
-      def deep_deduplicate!(data)
-        case data
-        when Hash
-          return data if data.frozen?
-          data.transform_keys! { |k| deep_deduplicate!(k) }
-          data.transform_values! { |v| deep_deduplicate!(v) }
-          data.freeze
-        when Array
-          return data if data.frozen?
-          data.map! { |d| deep_deduplicate!(d) }.freeze
-        when String
-          # String#-@ doesn't deduplicate the string if it's tainted.
-          # So in such case we need to untaint it first.
-          if data.tainted?
-            -(+data).untaint
-          else
-            -data
-          end
-        else
-          data.duplicable? ? data.freeze : data
-        end
-      end
-    end
-  end
-end

data/spec/deduplication_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-describe 'deduplication' do
-
-  it 'deduplicate string values' do
-    pending("Strings can't be deduplicated before Ruby 2.5") if RUBY_VERSION < '2.5'
-
-    records = [
-      { 'name' => 'George'.dup },
-    ]
-
-    expect(records[0]['name']).to_not equal 'George'.freeze
-    FrozenRecord::Deduplication.deep_deduplicate!(records)
-    expect(records[0]['name']).to equal 'George'.freeze
-  end
-
-  it 'handles duplicated references' do
-    # This simulates the YAML anchor behavior
-    tags = { 'foo' => 'bar' }
-    records = [
-      { 'name' => 'George', 'tags' => tags },
-      { 'name' => 'Peter', 'tags' => tags },
-    ]
-
-    expect(records[0]['tags']).to_not be_frozen
-    FrozenRecord::Deduplication.deep_deduplicate!(records)
-    expect(records[0]['tags']).to be_frozen
-    expect(records[0]['tags']).to equal records[1]['tags']
-  end
-
-end