frozen_record 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 146bcc09f8a4a9622397a90709cb33fa124baca6820547de51337a827124054d
-  data.tar.gz: f9f9d76a732523aca217be6a76ab2c1a64ea3faf994dc3a2f94ad93100e9439e
+  metadata.gz: f2012cdafeeed41657b76dbe5b5489a47f5e38d863335d0e2db87609d2030974
+  data.tar.gz: 636ea1f081a595230c27a2a4abb40978b977d1e3b541d23e039aa790d5bdb62d
 SHA512:
-  metadata.gz: 6f9a8ef22f72605fd9e3156e145522748fb7b75720c61e76bdffc157f8321cb2bb3ef260e9bf9b7eaac16761a2c207b6f81489c49b66c97a872619c11c665c7e
-  data.tar.gz: c030a6f630f96d474f0d441a310dc1c79649fb3c03b5ac3fa558b04b22c7d8838f717383724efec2bbfdcaf3fe92f93fdc777ce5d96d4570fbb1039905675db9
+  metadata.gz: ae134c3c39dca424590880b06190656c2d03aa0516fa387a5742ecf2dc1943e33f4c6eee30cc7fa600e63bd3c14186c69dc348ed20783256e563657bf9058874
+  data.tar.gz: bad575675f9a764c2e84f67b9c550beee1506ef763907d32a87d5eaf967eedeb3521ec28d6d9e6dd4ebc790ce0400bf579fb1764af3d13e46f14e5a6343a1a44

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 rvm:
-  - '2.4.5'
-  - '2.5.3'
-  - '2.6.1'
+  - '2.4'
+  - '2.5'
+  - '2.6'
+  - '2.7'

data/README.md

@@ -50,7 +50,7 @@ but this option can be changed per model:
 
 ```ruby
 class Country < FrozenRecord::Base
-  self.backend = FrozenRecord::Backends::Yaml
+  self.backend = FrozenRecord::Backends::Json
 end
 ```
 

data/lib/frozen_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'set'
 require 'active_support/all'
@@ -6,15 +8,20 @@ require 'active_model'
 require 'frozen_record/version'
 require 'frozen_record/scope'
 require 'frozen_record/base'
+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/railtie' if defined?(Rails)

data/lib/frozen_record/backends.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FrozenRecord
+  module Backends
+    autoload :Json, 'frozen_record/backends/json'
+    autoload :Yaml, 'frozen_record/backends/yaml'
+  end
+end

data/lib/frozen_record/backends/json.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FrozenRecord
+  module Backends
+    module Json
+      extend self
+
+      def filename(model_name)
+        "#{model_name.underscore.pluralize}.json"
+      end
+
+      def load(file_path)
+        json_data = File.read(file_path)
+        JSON.parse(json_data) || []
+      end
+    end
+  end
+end

data/lib/frozen_record/backends/yaml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FrozenRecord
   module Backends
     module Yaml
@@ -17,10 +19,29 @@ module FrozenRecord
       # @param format [String] the file path
       # @return [Array] an Array of Hash objects with keys being attributes.
       def load(file_path)
-        yml_erb_data = File.read(file_path)
-        yml_data = ERB.new(yml_erb_data).result
+        if !File.exist?(file_path) && File.exist?("#{file_path}.erb")
+          file_path = "#{file_path}.erb"
+        end
+
+        if FrozenRecord.deprecated_yaml_erb_backend
+          yml_erb_data = File.read(file_path)
+          yml_data = ERB.new(yml_erb_data).result
+
+          unless file_path.end_with?('.erb')
+            if yml_data != yml_erb_data
+              basename = File.basename(file_path)
+              raise "[FrozenRecord] Deprecated: `#{basename}` contains ERB tags and should be renamed `#{basename}.erb`.\nSet FrozenRecord.deprecated_yaml_erb_backend = false to enable the future behavior"
+            end
+          end
 
-        YAML.load(yml_data) || []
+          YAML.load(yml_data) || []
+        else
+          if file_path.end_with?('.erb')
+            YAML.load(ERB.new(File.read(file_path)).result) || []
+          else
+            YAML.load_file(file_path) || []
+          end
+        end
       end
     end
   end

data/lib/frozen_record/base.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'set'
 require 'active_support/descendants_tracker'
-require 'frozen_record/backends/yaml'
+require 'frozen_record/backends'
 
 module FrozenRecord
   class Base
@@ -17,25 +19,12 @@ module FrozenRecord
     FIND_BY_PATTERN = /\Afind_by_(\w+)(!?)/
     FALSY_VALUES = [false, nil, 0, -''].to_set
 
-    class_attribute :base_path
-
-    class_attribute :primary_key
-
-    class << self
-      alias_method :original_primary_key=, :primary_key=
-
-      def primary_key=(primary_key)
-        self.original_primary_key = -primary_key.to_s
-      end
-    end
+    class_attribute :base_path, :primary_key, :backend, :auto_reloading, :default_attributes, instance_accessor: false
 
     self.primary_key = 'id'
 
-    class_attribute :backend
     self.backend = FrozenRecord::Backends::Yaml
 
-    class_attribute :auto_reloading
-
     attribute_method_suffix -'?'
 
     class ThreadSafeStorage
@@ -57,8 +46,34 @@ module FrozenRecord
     end
 
     class << self
+      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))
+      end
+
+      alias_method :set_primary_key, :primary_key=
+      private :set_primary_key
+      def primary_key=(primary_key)
+        set_primary_key(-primary_key.to_s)
+      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)
+      end
+
       attr_accessor :abstract_class
 
+      def attributes
+        @attributes ||= begin
+          load_records
+          @attributes
+        end
+      end
+
       def abstract_class?
         defined?(@abstract_class) && @abstract_class
       end
@@ -77,7 +92,14 @@ module FrozenRecord
 
       def file_path
         raise ArgumentError, "You must define `#{name}.base_path`" unless base_path
-        File.join(base_path, backend.filename(name))
+        @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
+        end
       end
 
       def respond_to_missing?(name, *)
@@ -101,8 +123,11 @@ module FrozenRecord
 
         @records ||= begin
           records = backend.load(file_path)
-          define_attribute_methods(list_attributes(records))
-          records.map(&method(:new)).freeze
+          records.each { |r| assign_defaults!(r) }
+          records = Deduplication.deep_deduplicate!(records)
+          @attributes = list_attributes(records).freeze
+          define_attribute_methods(@attributes.to_a)
+          records.map { |r| load(r) }.freeze
         end
       end
 
@@ -113,6 +138,13 @@ module FrozenRecord
         singleton_class.send(:define_method, name) { |*args| body.call(*args) }
       end
 
+      alias_method :load, :new
+      private :load
+
+      def new(attrs = {})
+        load(assign_defaults!(attrs.stringify_keys))
+      end
+
       private
 
       def file_changed?
@@ -125,6 +157,18 @@ module FrozenRecord
         @store ||= ThreadSafeStorage.new(name)
       end
 
+      def assign_defaults!(record)
+        if default_attributes
+          default_attributes.each do |key, value|
+            unless record.key?(key)
+              record[key] = value
+            end
+          end
+        end
+
+        record
+      end
+
       def method_missing(name, *args)
         if name.to_s =~ FIND_BY_PATTERN
           return dynamic_match($1, args, $2.present?)
@@ -140,17 +184,15 @@ module FrozenRecord
       def list_attributes(records)
         attributes = Set.new
         records.each do |record|
-          record.keys.each do |key|
-            attributes.add(key.to_s)
-          end
+          attributes.merge(record.keys)
         end
-        attributes.to_a
+        attributes
       end
 
     end
 
     def initialize(attrs = {})
-      @attributes = attrs.stringify_keys.freeze
+      @attributes = attrs.freeze
     end
 
     def attributes
@@ -158,7 +200,7 @@ module FrozenRecord
     end
 
     def id
-      self[primary_key.to_s]
+      self[self.class.primary_key]
     end
 
     def [](attr)
@@ -184,5 +226,8 @@ module FrozenRecord
       FALSY_VALUES.exclude?(self[attribute_name]) && self[attribute_name].present?
     end
 
+    def attribute_method?(attribute_name)
+      respond_to_without_attributes?(:attributes) && self.class.attributes.include?(attribute_name)
+    end
   end
 end

data/lib/frozen_record/deduplication.rb

@@ -0,0 +1,57 @@
+# 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/lib/frozen_record/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FrozenRecord
   class Railtie < Rails::Railtie
     initializer "frozen_record.setup" do |app|

data/lib/frozen_record/scope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FrozenRecord
   class Scope
     BLACKLISTED_ARRAY_METHODS = [

data/lib/frozen_record/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FrozenRecord
   module TestHelper
     NoFixturesLoaded = Class.new(StandardError)

data/lib/frozen_record/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FrozenRecord
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

data/spec/deduplication_spec.rb

@@ -0,0 +1,31 @@
+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

data/spec/fixtures/{countries.yml → countries.yml.erb}

@@ -20,7 +20,6 @@
   nato: true
   continent: Europe
 
-
 - id: 3
   name: Austria
   capital: <%= 'Vienna' %>
@@ -29,3 +28,4 @@
   founded_on: 1156-01-01
   updated_at: 2014-02-12T19:02:03-02:00
   continent: Europe
+  available: false

data/spec/frozen_record_spec.rb

@@ -71,6 +71,25 @@ describe FrozenRecord::Base do
 
   end
 
+  describe '.default_attributes' do
+
+    it 'define the attribute' do
+      expect(Country.new).to respond_to :contemporary
+    end
+
+    it 'sets the value as default' do
+      expect(Country.find_by(name: 'Austria').contemporary).to be == true
+    end
+
+    it 'gives precedence to the data file' do
+      expect(Country.find_by(name: 'Austria').available).to be == false
+    end
+
+    it 'is also set in the initializer' do
+      expect(Country.new.contemporary).to be == true
+    end
+  end
+
   describe '.scope' do
     it 'defines a scope method' do
 
@@ -134,6 +153,8 @@ describe FrozenRecord::Base do
         'king' => 'Elisabeth II',
         'nato' => true,
         'continent' => 'North America',
+        'available' => true,
+        'contemporary' => true,
       }
     end
 
@@ -179,6 +200,14 @@ describe FrozenRecord::Base do
 
   end
 
+  describe '#present?' do
+
+    it 'returns true' do
+      expect(Country.first).to be_present
+    end
+
+  end
+
   describe '#count' do
 
     it 'can count objects with no records' do

data/spec/support/animal.rb

@@ -1,16 +1,3 @@
-module JsonBackend
-  extend self
-
-  def filename(model_name)
-    "#{model_name.underscore.pluralize}.json"
-  end
-
-  def load(file_path)
-    json_data = File.read(file_path)
-    JSON.parse(json_data) || []
-  end
-end
-
 class Animal < FrozenRecord::Base
-  self.backend = JsonBackend
+  self.backend = FrozenRecord::Backends::Json
 end

data/spec/support/country.rb

@@ -1,4 +1,5 @@
 class Country < FrozenRecord::Base
+  self.default_attributes = { contemporary: true, available: true }
 
   def self.republics
     where(king: nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2020-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -110,16 +110,20 @@ files:
 - Rakefile
 - frozen_record.gemspec
 - lib/frozen_record.rb
+- lib/frozen_record/backends.rb
+- lib/frozen_record/backends/json.rb
 - lib/frozen_record/backends/yaml.rb
 - lib/frozen_record/base.rb
+- lib/frozen_record/deduplication.rb
 - lib/frozen_record/railtie.rb
 - lib/frozen_record/scope.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
-- spec/fixtures/test_helper/countries.yml
+- spec/fixtures/countries.yml.erb
+- spec/fixtures/test_helper/countries.yml.erb
 - spec/frozen_record_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb
@@ -152,10 +156,11 @@ 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
-- spec/fixtures/test_helper/countries.yml
+- spec/fixtures/countries.yml.erb
+- spec/fixtures/test_helper/countries.yml.erb
 - spec/frozen_record_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb