fixed_record 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eea6e2937878d931df67a139cff38882002163f62f43e9f6b4e9440c84bbc60
-  data.tar.gz: 8d51b0834f97783271b77fd8762289efad419c463aa3a6f705affded0a07de2e
+  metadata.gz: 156863124ec2fb0ca1668bafa2b16de94d622f577ea554ace2189dd24758bfa4
+  data.tar.gz: caf2f4fb5e63bd96218dc25eeeda8ede9bf792acc35bebb992aecb2068a395de
 SHA512:
-  metadata.gz: 39687e91690bd8426119d2c41b77298dc3a48c2da4000a57bc6160f14ea2eb021d4495eac2ca27d50189fa5fcedbb2196c4c543bda44ff936aba2cf27d4f9b42
-  data.tar.gz: '0697f532ce75a0e808fefe5a94a9fa42b9fa00e346c7e6dda1288066aab857ab36d196a57473134d04d66ad4aa0b4b91a4db57a8197284a5c49ff9cfaf18b432'
+  metadata.gz: 0c40bf0b31215154be4a30ee76c4db815a88b24d3f1fa6e8f3be0ddd27225db9e22c0a446a6c624adb313bf6e83ef45e12f2f4b2c2a9e7801811fa2966ef3108
+  data.tar.gz: a567503b4d12425d0ca89931707c14a41ec8b026986a51ff18676042bec51d15eaac45171faf8d13edc3c49489f7ffea62294becc5d7221e31b78db5374a72e8

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Gem fixed_record Changelog
+
+## 0.3.0
+* Add optional required and optional arguments to specify required and optional fields respectively
+
+## 0.2.0
+* Add support for a Hash of Hashes in the YAML file, and for
+accessing records by key. 
+* Added CHANGELOG.md
+
+## 0.1.x
+* Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixed_record (0.2.0)
+    fixed_record (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -48,7 +48,7 @@ Then to load these, create a class
 require 'fixed_record'
 
 class MyFavoriteWebsite < FixedRecord
-    data "#{Rails.root}/data/my_favorite_websites.yml"
+    data "#{Rails.root}/data/my_favorite_websites.yml", required: [:name, :url]
 
   # Return hostname of url for company
   def hostname
@@ -88,7 +88,8 @@ StaticPage#first:
   description: Welcome to the First Page
 
 StaticPage#last:
-  title: Last Page 
+  title: Last Page
+  short_title: LastP 
   description: Welcome to the Last Page
 
 ```
@@ -99,7 +100,7 @@ Then to load these, create a class
 require 'fixed_record'
 
 class MyWebPages < FixedRecord
-    data "#{Rails.root}/data/my_web_pages.yml"
+    data "#{Rails.root}/data/my_web_pages.yml", required: [:title,:description], optional: [:short_title]
 
 end
 ```
@@ -140,12 +141,35 @@ The declared class will also include all the methods from the `Enumerable` modul
 Some basic sanity checks are performed on the YAML file to catch common errors:
 
 * It must define a non-empty array or hash of records
-* All records must have the same set of attributes
+* If the optional `required:` or `optional:` arguments are given, then each record _must_ have all the required fields and _may_ also have any of the optional fields. 
+* If niether the `required:` or `optional:` arguments are given, then each record _must_ have the same set of fields.
+
+An `ArgumentError` exception will be thrown if any validation errors are detected. A system-dependent error (probably `Errno::ENOENT`) will be thrown if the file cannot be read. 
+
+Additional validations can be performed by defining a `validate` method. e.g.
+
+```ruby
+require 'fixed_record'
+require 'uri'
+
+class MyFavoriteWebsite < FixedRecord
+    data "#{Rails.root}/data/my_favorite_websites.yml", required: [:name, :url]
+
+  # Check that the url can be parsed
+  def validate( values, index )
+    begin
+      URI.parse(url)
+    rescue URI::InvalidURIError -> e
+      raise e.class, "#{filename} index #{index} has invalid url: #{e.message}"
+    end
+  end
+
+end
+```
+
+
 
-An `ArgumentError` exception will be thrown if any errors are detected.
 
-Additional validations can be performed by overriding the `validate_yaml` and
-`validate_item` class functions. 
 
 
 ## Development

data/lib/fixed_record.rb

@@ -1,21 +1,33 @@
 
 require 'yaml'
+require 'set'
 
 class FixedRecord
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
   # Lazy load data from given filename 
   # creating accessors for top level attributes
-  def self.data( filename ) 
+  def self.data( filename, required: [], optional: [] ) 
+    required = required.map( &:to_s )
+    optional = optional.map( &:to_s )
+    throw ArgumentError, "Required and Optional names overlap" unless (required & optional).empty?
+
+    valid_keys = Set.new( required )
+    valid_keys.merge( optional )
+    required_keys = Set.new( required )
+
+    self.class_variable_set( :@@filename, filename )
+    self.class_variable_set( :@@required_keys, required_keys )
+    self.class_variable_set( :@@valid_keys, valid_keys )
+    self.class_variable_set( :@@items, nil )
+
     class_eval %Q{
       class << self
         include Enumerable
       end
 
-      @@items = nil
-
       def self.filename
-        %Q{#{filename}}
+        @@filename
       end
 
       def self.all 
@@ -50,47 +62,59 @@ class FixedRecord
       def self.load!
         if @@items.nil?
           y = YAML.load_file( filename )
-          validate_yaml( y )
-          valid_keys = nil
+          validate_structure( y )
           if y.is_a?(Array)
-            valid_keys = y.first.keys
+            if @@valid_keys.empty?
+              @@valid_keys = y.first.keys
+              @@required_keys = @@valid_keys
+            end
             @@items = y.map.with_index do |values,i|
-              validate_item( valid_keys, values, i )
+              validate_item( @@valid_keys, @@required_keys, values, i )
               r = new
               r.instance_variable_set( :@values, values )
               r
             end
           elsif y.is_a?(Hash)
             @@items = Hash.new
-            add_key = true
+            add_key = !@@valid_keys.member?('key')
             y.each do |k,values|
-              if valid_keys.nil?
-                valid_keys = values.keys
-                add_key = !values.has_key?('key')
+              if @@valid_keys.empty?
+                @@required_keys.merge( values.keys )
+                @@valid_keys.merge( values.keys )
+                add_key = !@@valid_keys.member?('key')
               end
-              validate_item( valid_keys, values, k )
+              validate_item( @@valid_keys, @@required_keys, values, k )
               values['key'] = k if add_key
               r = new
               r.instance_variable_set( :@values, values )
               @@items[k] = r   
             end
-            valid_keys << 'key' if add_key
+            define_method( :key ) { @values['key'] }  if add_key
           end
-          create_methods( valid_keys )
+          create_methods( @@valid_keys  )
         end
       end
     }
   end
 
+
+  # Override this to perform additional entries. It gets passed the hash containing the
+  # values for each record. index is either a record index (0 based) or a key associated
+  # with the record
+  def self.validate( values, index )
+  end
+
+private
+
   # Create access methods for each of valid_keys
   def self.create_methods( valid_keys )
-    valid_keys.each do |k|
-      define_method( k.to_sym) { @values[k] }
+    valid_keys.each do |key|
+      define_method( key.to_sym) { @values[key] }
     end
   end
 
   # Validate the top level of the data structure returned 
-  def self.validate_yaml( y )
+  def self.validate_structure( y )
     if y.is_a?(Array)
       if y.length <= 0
         throw ArgumentError.new "#{filename} contain a zero length array"
@@ -112,14 +136,16 @@ class FixedRecord
   end
 
   # Validate a values of name -> value
-  def self.validate_item( valid_keys, values, index )
+  def self.validate_item( valid_keys, required_keys, values, index )
     raise ArgumentError, "#{filename} item #{index} should be name value pairs" unless values.is_a?(Hash)
-    raise ArgumentError, "#{filename} item #{index} has wrong number of values" if valid_keys.length != values.length
-    valid_keys.each do |name|
-      unless values.has_key? name
-        raise ArgumentError, "#{filename} item #{index}  is missing value for '#{name}'" 
-      end
+    required_keys.each do |name|
+        raise ArgumentError, "#{filename} item #{index}  is missing value for '#{name}'" unless values.has_key?(name)
+    end
+    values.keys.each do |v|
+      raise ArgumentError, "#{filename} item #{index} has unexpected value for '#{name}'" unless valid_keys.include?(v) 
     end
+    # User can implement this to add extra validation
+    validate( values, index )
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixed_record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Bell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md