fixed_record 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 156863124ec2fb0ca1668bafa2b16de94d622f577ea554ace2189dd24758bfa4
-  data.tar.gz: caf2f4fb5e63bd96218dc25eeeda8ede9bf792acc35bebb992aecb2068a395de
+  metadata.gz: 07420f9a6931182806b5ee82f717a1a99d48ffa2cbca75c6c0c7e2b535ee72e2
+  data.tar.gz: 902a5a02d643c65a60f597f4fbc26018d2a3c0546d1d5977a9adef114283dc21
 SHA512:
-  metadata.gz: 0c40bf0b31215154be4a30ee76c4db815a88b24d3f1fa6e8f3be0ddd27225db9e22c0a446a6c624adb313bf6e83ef45e12f2f4b2c2a9e7801811fa2966ef3108
-  data.tar.gz: a567503b4d12425d0ca89931707c14a41ec8b026986a51ff18676042bec51d15eaac45171faf8d13edc3c49489f7ffea62294becc5d7221e31b78db5374a72e8
+  metadata.gz: a11fa7c40a495fc4e64744b3a7da437e15dc8f95a12a1b914f14fa1b4a7c8e49a6e41695d4b977131208c5a7f071fb8bfda2cd581760859b8a8d15d6a7eae438
+  data.tar.gz: 86e95dd06779296de7c9c929500bcdf562cdbc6e0270462f7b08c464e633a5735ad1e51d07371fe10f0b2baa20557060ee134f19e4be238d56c619d8edbf309b

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Gem fixed_record Changelog
 
+## 0.4.0
+* Add support for a singleton record for general parameter access
+
 ## 0.3.0
 * Add optional required and optional arguments to specify required and optional fields respectively
 

data/Gemfile.lock

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

data/README.md

@@ -134,6 +134,37 @@ puts MyWebPages.count
 
 The declared class will also include all the methods from the `Enumerable` module.
 
+### Singleton Record
+
+Create a YAML file `site_settingss.yml` defining a single records like this:
+
+```yaml
+
+sessionExpiry: 3600
+phone: +1.613.555.1212
+address: 500 Main Street, Anytown, Antartica
+
+```
+
+Then to load these, create a class
+
+```ruby
+require 'fixed_record'
+
+class SiteSettings < FixedRecord
+    data "#{Rails.root}/data/site_settings.yml", singleton: true
+
+end
+```
+
+The values can be accessed by index:
+
+```ruby
+SiteSettings['phone'] # '+1.613.555.1212'
+SiteSettings['address'] # '500 Main Street, Anytown, Antartica'
+SiteSettings[:phone] # This works too
+```
+The `required` and `optional` arguments can be used to check for inadvertent errors being introduced into the YAML file. An ArgumentError will be raised if the name is not defined in the file and is not declared as optional. 
 
 
 ## Error Checking

data/lib/fixed_record.rb

@@ -3,11 +3,11 @@ require 'yaml'
 require 'set'
 
 class FixedRecord
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 
   # Lazy load data from given filename 
   # creating accessors for top level attributes
-  def self.data( filename, required: [], optional: [] ) 
+  def self.data( filename, required: [], optional: [], singleton: false ) 
     required = required.map( &:to_s )
     optional = optional.map( &:to_s )
     throw ArgumentError, "Required and Optional names overlap" unless (required & optional).empty?
@@ -20,54 +20,83 @@ class FixedRecord
     self.class_variable_set( :@@required_keys, required_keys )
     self.class_variable_set( :@@valid_keys, valid_keys )
     self.class_variable_set( :@@items, nil )
+    self.class_variable_set( :@@singleton, singleton )
+
+    if singleton 
+      class_eval %Q{
+        def self.[](k)
+          load!
+          k = k.to_s
+          raise ArgumentError, "\#{k} is not a valid key" unless @@valid_keys.member?(k)
+          @@items[k]
+        end
+      }
+    else
+      class_eval %Q{
+        class << self
+          include Enumerable
+        end
 
-    class_eval %Q{
-      class << self
-        include Enumerable
-      end
+        def self.all 
+          load!
+          @@items
+        end
 
-      def self.filename
-        @@filename
-      end
+        def self.each( &block )
+          load!
+          @@items.each(&block)
+        end
 
-      def self.all 
-        load!
-        @@items
-      end
+        def self.count
+          load!
+          @@items.length
+        end
 
-      def self.each( &block )
-        all.each(&block)
-      end
+        def self.[]( k )
+          if all.is_a?(Hash)
+            all[k.to_s]
+          else
+            nil
+          end
+        end
 
-      def self.count
-        all.length
-      end
+        def self.has_key?( k )
+          if all.is_a?(Hash)
+            all.has_key?( k )
+          else
+            false
+          end
+        end 
 
-      def self.[]( k )
-        if all.is_a?(Hash)
-          all[k]
-        else
-          nil
-        end
+      }
+    end
+
+    class_eval %Q{
+      def self.filename
+        @@filename
       end
 
-      def self.has_key?( k )
-        if all.is_a?(Hash)
-          all.has_key?( k )
-        else
-          false
-        end
-      end 
 
       def self.load!
         if @@items.nil?
-          y = YAML.load_file( filename )
-          validate_structure( y )
-          if y.is_a?(Array)
-            if @@valid_keys.empty?
+          y = YAML.load_file( @@filename )
+          validate_structure( y, @@singleton, @@filename )
+          if @@valid_keys.empty? 
+            # Grab keys from file
+            if @@singleton
+              @@valid_keys = y.keys
+            elsif y.is_a?(Array)
               @@valid_keys = y.first.keys
+              @@required_keys = @@valid_keys       
+            elsif y.is_a?(Hash)
+              @@valid_keys = y[y.keys.first].keys
               @@required_keys = @@valid_keys
             end
+          end
+
+          if @@singleton
+            @@items = y
+          elsif y.is_a?(Array)
             @@items = y.map.with_index do |values,i|
               validate_item( @@valid_keys, @@required_keys, values, i )
               r = new
@@ -78,11 +107,6 @@ class FixedRecord
             @@items = Hash.new
             add_key = !@@valid_keys.member?('key')
             y.each do |k,values|
-              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, @@required_keys, values, k )
               values['key'] = k if add_key
               r = new
@@ -114,25 +138,31 @@ private
   end
 
   # Validate the top level of the data structure returned 
-  def self.validate_structure( y )
-    if y.is_a?(Array)
-      if y.length <= 0
-        throw ArgumentError.new "#{filename} contain a zero length array"
-      end
-      if y.any?{ |i| !i.is_a?(Hash)}
-        throw ArgumentError.new "#{filename} does not contain an array of items (hashes)"
-      end
-    elsif y.is_a?(Hash)
-      if y.count <= 0
-         throw ArgumentError.new "#{filename} contain an empty hash"
-      end
-      if y.any?{ |k,v| !v.is_a?(Hash) }
-        throw ArgumentError.new "#{filename} does not contain an array of items (hashes)"
+  # Validate the top level of the data structure returned 
+  def self.validate_structure( y, singleton, filename )
+    if singleton
+      if !y.is_a?(Hash)
+        raise ArgumentError, "#{filename} does not contain a hash of values or an array of items"
       end
     else
-      throw ArgumentError.new "#{filename} does not contain a hash of items or an array of items"
+      if y.is_a?(Array)
+        if y.length <= 0
+          raise ArgumentError, "#{filename} contain a zero length array"
+        end
+        if y.any?{ |i| !i.is_a?(Hash)}
+          raise ArgumentError, "#{filename} does not contain an array of items (hashes)"
+        end
+      elsif y.is_a?(Hash)
+        if y.count <= 0
+           raise ArgumentError, "#{filename} contain an empty hash"
+        end
+        if y.any?{ |k,v| !v.is_a?(Hash) }
+          raise ArgumentError, "#{filename} does not contain an array of items (hashes)"
+        end
+      else
+        raise ArgumentError, "#{filename} does not contain a hash of items or an array of items"
+      end
     end
-
   end
 
   # Validate a values of name -> value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixed_record
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Bell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler