frozen_record 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785548769c7ba7f3bbb52f2e17b9a3199b5dbcc7
-  data.tar.gz: a35161fae1e80efc72d01ea0eb0e4c45e0cacd84
+  metadata.gz: 69d17666ac957cc0d3b75d51f49692a41be67947
+  data.tar.gz: 51214e7c50fae48f90a2bdf586cd351a266f028c
 SHA512:
-  metadata.gz: c026e89f7d50bdf288da41935a7615d9e45906ab041da84f1fb564ab79bc53ebde815d2c63adeaad16dc7bfcba36b2c1a10bf99e9f91e6e181af53b9be3aee51
-  data.tar.gz: 5081081b183668d2eb253576ffa04116a348d9e90901dee06e9ef0bec66d0b78224f906877551cd4dd255b5451b79d92722e440eee0ad045d82d393198ba06e3
+  metadata.gz: b6ea860e92550663a785be7589fc4740d15ec86ff8b2a42aecdf7d026f76b5fd674993b91d459570458a87130b780a2e054a1a2668864d4b94d0035c52211a1a
+  data.tar.gz: 5ff4a501f9996fdfc845a6cefad6571614c832fc865f70e5fc18ea4226a2d643aa73d4443c463f4b255f93da86125207ff345382ef571f7f1051d58e4b74123b

data/README.md

@@ -5,7 +5,7 @@
 [![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 YAML static data.
+ActiveRecord-like interface for **read only** access to static data files.
 
 ## Installation
 
@@ -44,6 +44,34 @@ class Country < FrozenRecord::Base
 end
 ```
 
+You can also specify a custom backend. Backends are classes that know how to
+load records from a static file. By default FrozenRecord expects an YAML file,
+but this option can be changed per model:
+
+```ruby
+class Country < FrozenRecord::Base
+  self.backend = FrozenRecord::Backends::Yaml
+end
+```
+
+### Custom backends
+
+A valid backend must implement two class methods, `filename` and `load`.
+
+```ruby
+class MyCustomBackend
+  class << self
+    def filename(model_name)
+      # Returns the file name as a String
+    end
+
+    def load(file_path)
+      # Reads file and returns records as an Array of Hash objects
+    end
+  end
+end
+```
+
 ## Query interface
 
 FrozenRecord aim to replicate only modern ActiveRecord querying interface, and only the non "string typed" ones.

data/lib/frozen_record/backends/yaml.rb

@@ -0,0 +1,27 @@
+module FrozenRecord
+  module Backends
+    module Yaml
+      extend self
+
+      # Transforms the model name into a valid filename.
+      #
+      # @param format [String] the model name that inherits
+      #   from FrozenRecord::Base
+      # @return [String] the file name.
+      def filename(model_name)
+        "#{model_name.underscore.pluralize}.yml"
+      end
+
+      # Reads file in `file_path` and return records.
+      #
+      # @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
+
+        YAML.load(yml_data) || []
+      end
+    end
+  end
+end

data/lib/frozen_record/base.rb

@@ -1,5 +1,6 @@
 require 'set'
 require 'active_support/descendants_tracker'
+require 'frozen_record/backends/yaml'
 
 module FrozenRecord
   class Base
@@ -21,6 +22,9 @@ module FrozenRecord
     class_attribute :primary_key
     self.primary_key = :id
 
+    class_attribute :backend
+    self.backend = FrozenRecord::Backends::Yaml
+
     class_attribute :auto_reloading
 
     attribute_method_suffix '?'
@@ -64,7 +68,7 @@ module FrozenRecord
 
       def file_path
         raise ArgumentError, "You must define `#{name}.base_path`" unless base_path
-        File.join(base_path, "#{name.underscore.pluralize}.yml")
+        File.join(base_path, backend.filename(name))
       end
 
       def respond_to_missing?(name, *)
@@ -91,10 +95,7 @@ module FrozenRecord
         end
 
         @records ||= begin
-          yml_erb_data = File.read(file_path)
-          yml_data = ERB.new(yml_erb_data).result
-
-          records = YAML.load(yml_data) || []
+          records = backend.load(file_path)
           define_attribute_methods(list_attributes(records))
           records.map(&method(:new)).freeze
         end

data/lib/frozen_record/version.rb

@@ -1,3 +1,3 @@
 module FrozenRecord
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/spec/fixtures/animals.json

@@ -0,0 +1,14 @@
+[
+  {
+    "name": "cat",
+    "family": "felidae"
+  },
+  {
+    "name": "dog",
+    "family": "canidae"
+  },
+  {
+    "name": "elephant",
+    "family": "elephantidae"
+  }
+]

data/spec/frozen_record_spec.rb

@@ -55,11 +55,16 @@ describe FrozenRecord::Base do
 
   describe '#load_records' do
 
-    it 'processes erb' do
+    it 'processes erb by default' do
       country = Country.first
       expect(country.capital).to be == 'Ottawa'
     end
 
+    it 'loads records with a custom backend' do
+      animal = Animal.first
+      expect(animal.name).to be == 'cat'
+    end
+
   end
 
   describe '#==' do

data/spec/support/animal.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frozen_record
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -110,15 +110,18 @@ files:
 - Rakefile
 - frozen_record.gemspec
 - lib/frozen_record.rb
+- lib/frozen_record/backends/yaml.rb
 - lib/frozen_record/base.rb
 - lib/frozen_record/scope.rb
 - lib/frozen_record/version.rb
+- spec/fixtures/animals.json
 - spec/fixtures/cars.yml
 - spec/fixtures/countries.yml
 - spec/frozen_record_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb
 - spec/support/abstract_model.rb
+- spec/support/animal.rb
 - spec/support/car.rb
 - spec/support/country.rb
 homepage: https://github.com/byroot/frozen_record
@@ -146,11 +149,13 @@ signing_key:
 specification_version: 4
 summary: ActiveRecord like interface to read only access and query static YAML files
 test_files:
+- spec/fixtures/animals.json
 - spec/fixtures/cars.yml
 - spec/fixtures/countries.yml
 - spec/frozen_record_spec.rb
 - spec/scope_spec.rb
 - spec/spec_helper.rb
 - spec/support/abstract_model.rb
+- spec/support/animal.rb
 - spec/support/car.rb
 - spec/support/country.rb