frozen_record 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3ad807dcab80676636ab54fc06c01f5a20358b9
-  data.tar.gz: 252b2ef0891b9b62b62616317f1ef5ac4d378abe
+  metadata.gz: fdb7686678220892ee4d076e0dd12678eb3b5bb6
+  data.tar.gz: 1cb91679f2c40a42ff635b3ae92a28169641b4f8
 SHA512:
-  metadata.gz: e7d43b151b30c11aba06de403a8eace5f49c970f7e11c7501d85775ecd2bb9fae194f2569f00d291d0db11e75e5a96deee74aeddcb66bd2e1433fa113cae5247
-  data.tar.gz: 82e9a979804003d0143c945fa17b71cc7f23614100c95bfa79fa414b7ac7e4ff66091cfbc2f97eec88d3748188efacb291659eed182659c770ed12855e0e1c80
+  metadata.gz: a01bb54dc54ca88f5acb7b85c4739002e6e7918345f55f7bd45cd4f97350e1d721c9497f981b909ec57ae217353a881f4c01c36e8f66921353dfc099fa60d760
+  data.tar.gz: de01bdbbb0c09f3d8720711a540c7a7686ba2c7f55d64ddd39296f9e3ba8501da3f84b81259f22b26f30f2fe840e75c80e2610788abe39f98d1634a129cdeafa

data/README.md

@@ -110,6 +110,19 @@ Country.republics.part_of_nato.order(id: :desc)
   - average
 
 
+## Configuration
+
+### Reloading
+
+By default the YAML files are parsed once and then cached in memory. But in development you might want changes to be reflected without having to restart your application.
+
+For such cases you can set `auto_reloading` to `true` either globally or on a model basis:
+
+```ruby
+FrozenRecord::Base.auto_reloading = true # Activate reloading for all models
+Country.auto_reloading # Activate reloading for `Country` only
+```
+
 ## Contributors
 
 FrozenRecord is a from scratch reimplementation of a [Shopify](https://github.com/Shopify) project from 2007 named `YamlRecord`.

data/lib/frozen_record/base.rb

@@ -19,6 +19,8 @@ module FrozenRecord
     class_attribute :primary_key
     self.primary_key = :id
 
+    class_attribute :auto_reloading
+
     attribute_method_suffix '?'
 
     class ThreadSafeStorage
@@ -42,7 +44,7 @@ module FrozenRecord
     class << self
 
       def current_scope
-        store[:scope] ||= Scope.new(self, load_records)
+        store[:scope] ||= Scope.new(self)
       end
       alias_method :all, :current_scope
 
@@ -51,7 +53,7 @@ module FrozenRecord
       end
 
       delegate :find, :find_by_id, :find_by, :find_by!, :where, :first, :first!, :last, :last!, :pluck, :ids, :order, :limit, :offset,
-               :minimum, :maximum, :average, :sum, to: :current_scope
+               :minimum, :maximum, :average, :sum, :count, to: :current_scope
 
       def file_path
         fail ArgumentError, "You must define `#{name}.base_path`" unless base_path
@@ -64,12 +66,26 @@ module FrozenRecord
         end
       end
 
-      def count
-        load_records.size
+      def load_records
+        @records = nil if auto_reloading && file_changed?
+        @records ||= begin
+          yml_erb_data = File.read(file_path)
+          yml_data = ERB.new(yml_erb_data).result
+
+          records = YAML.load(yml_data) || []
+          define_attributes!(list_attributes(records))
+          records.map(&method(:new)).freeze
+        end
       end
 
       private
 
+      def file_changed?
+        last_mtime = @file_mtime
+        @file_mtime = File.mtime(file_path)
+        last_mtime != @file_mtime
+      end
+
       def store
         @store ||= ThreadSafeStorage.new(name)
       end
@@ -86,17 +102,6 @@ module FrozenRecord
         bang ? results.first! : results.first
       end
 
-      def load_records
-        @records ||= begin
-          yml_erb_data = File.read(file_path)
-          yml_data = ERB.new(yml_erb_data).result
-
-          records = YAML.load(yml_data) || []
-          define_attributes!(list_attributes(records))
-          records.map(&method(:new)).freeze
-        end
-      end
-
       def list_attributes(records)
         attributes = Set.new
         records.each do |record|

data/lib/frozen_record/scope.rb

@@ -6,7 +6,7 @@ module FrozenRecord
       :keep_if, :pop, :shift, :delete_at, :compact
     ].to_set
 
-    delegate :first, :last, :length, :collect, :map, :each, :all?, :include?, :to_ary, :to_json, :as_json, to: :to_a
+    delegate :first, :last, :length, :collect, :map, :each, :all?, :include?, :to_ary, :to_json, :as_json, :count, to: :to_a
     if defined? ActiveModel::Serializers::Xml
       delegate :to_xml, to: :to_a
     end
@@ -21,9 +21,8 @@ module FrozenRecord
       end
     end
 
-    def initialize(klass, records)
+    def initialize(klass)
       @klass = klass
-      @records = records
       @where_values = []
       @where_not_values = []
       @order_values = []
@@ -57,7 +56,7 @@ module FrozenRecord
     end
 
     def to_a
-      @results ||= query_results
+      query_results
     end
 
     def pluck(*attributes)
@@ -143,11 +142,11 @@ module FrozenRecord
     end
 
     def query_results
-      @results ||= slice_records(matching_records)
+      slice_records(matching_records)
     end
 
     def matching_records
-      @matches ||= sort_records(select_records(@records))
+      sort_records(select_records(@klass.load_records))
     end
 
     def select_records(records)

data/lib/frozen_record/version.rb

@@ -1,3 +1,3 @@
 module FrozenRecord
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/spec/frozen_record_spec.rb

@@ -4,7 +4,7 @@ describe FrozenRecord::Base do
 
   describe '.base_path' do
 
-    it 'raise a RuntimeError  on first query attempt if not set' do
+    it 'raise a RuntimeError on first query attempt if not set' do
       allow(Country).to receive_message_chain(:base_path).and_return(nil)
       expect {
         Country.file_path
@@ -13,6 +13,46 @@ describe FrozenRecord::Base do
 
   end
 
+  describe '.auto_reloading' do
+
+    context 'when enabled' do
+
+      around do |example|
+        previous_auto_reloading = Country.auto_reloading
+        Country.auto_reloading = true
+        begin
+          example.run
+        ensure
+          Country.auto_reloading = previous_auto_reloading
+        end
+      end
+
+      it 'reloads the records if the file mtime changed' do
+        mtime = File.mtime(Country.file_path)
+        expect {
+          File.utime(mtime + 1, mtime + 1, Country.file_path)
+        }.to change { Country.first.object_id }
+      end
+
+      it 'does not reload if the file has not changed' do
+        expect(Country.first.object_id).to be == Country.first.object_id
+      end
+
+    end
+
+    context 'when disabled' do
+
+      it 'does not reloads the records if the file mtime changed' do
+        mtime = File.mtime(Country.file_path)
+        expect {
+          File.utime(mtime + 1, mtime + 1, Country.file_path)
+        }.to_not change { Country.first.object_id }
+      end
+
+    end
+
+  end
+
   describe '#load_records' do
 
     it 'processes erb' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel