fixed_record 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8338a931bf7c56128b3865f814cff42f0383db1fe48d97cf36d621ab53e244
-  data.tar.gz: 9f3378e6a0423fbbd6cb042973a1c29b315114cdb3accd4b82d3dd8e94a2d529
+  metadata.gz: 0e28a9a9f85d811dca1463d6d5ae8944d0d5fd66a098be6e93a9c86b939f4807
+  data.tar.gz: 1849d6bb120d51aa6f275f1bc9c2d8e78166bf492c4e39887ed2fa010dbfa1fd
 SHA512:
-  metadata.gz: 7eb69a020b70344a11ccdbd5010ab9035cc016235ee462291fd8eef54e0d0829d70ab8581213d264d6f1a12fd99581794938258c50b2af550bb6d3b6d5785643
-  data.tar.gz: abc3b1526a5ce6b2f19271044692e4d4c1eff1acc8aadf05579075a96fd4d3aae30e594f5f1c4035eff034342a05e2d7d6c622fe09ac4e761b6a498d5c42f70a
+  metadata.gz: a03e177ac9d18c4ee7bd5f5589cdc9657369cc7444dd7b371ca644ec53c0030d160a2fd76ab3669093e44364baae267e1c165f47d23cbe481c7d2c04b61999ed
+  data.tar.gz: a6462fa10d6eff0704dbd51aa3001a5a5ee367947eea83a32962de27c8fe68c907204b20860270063ac23cbd8ce50aea2697a01d1d0649bc7b58cb1962164165

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Gem fixed_record Changelog
 
+## 0.5.0
+* Added class method `valid_names` to return valid names in records
+* Documented class method `filename`
+* Add instance method `present?` to test if a value was supplied for an  optional field
+
 ## 0.4.4
 * Syntax Errors in YAML file now reported as ArgumentError
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixed_record (0.4.3)
+    fixed_record (0.5.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", required: [:name, :url]
+    data "#{Rails.root}/data/my_favorite_websites.yml", required: [:name, :url], optional: [:title]
 
   # Return hostname of url for company
   def hostname
@@ -76,6 +76,20 @@ A count of the number of records is available:
 puts MyFavoriteWebsite.count
 ```
 
+As is the filename and the set of valid field names:
+```ruby
+puts MyFavoriteWebsite.filename # .../my_favorite_websites.yml
+puts MyFavoriteWebsite.valid_keys.include?( :name )  # true
+```
+## Value presence
+
+It's possible to check whether a value is supplied for an optional field for an item:
+
+```ruby
+puts MyFavoriteWebsite.all.first.present?(:title) # true
+```
+This makes it possible to distinguish between an optional value being omitted and explicitly being given the value nil.
+
 The declared class will also include all the methods from the `Enumerable` module.
 
 ### Hash of Records
@@ -136,7 +150,7 @@ The declared class will also include all the methods from the `Enumerable` modul
 
 ### Singleton Record
 
-Create a YAML file `site_settingss.yml` defining a single records like this:
+Create a YAML file `site_settings.yml` defining a single records like this:
 
 ```yaml
 

data/lib/fixed_record.rb

@@ -4,7 +4,7 @@ require 'psych'
 require 'set'
 
 class FixedRecord
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 
   # Lazy load data from given filename 
   # creating accessors for top level attributes
@@ -61,7 +61,7 @@ class FixedRecord
           end
         end
 
-        def self.has_key?( k )
+        def self.has_item_key?( k )
           if all.is_a?(Hash)
             all.has_key?( k )
           else
@@ -77,6 +77,10 @@ class FixedRecord
         @@filename
       end
 
+      def self.valid_names
+        load!
+        @@valid_keys
+      end
 
       def self.load!
         if @@items.nil?
@@ -150,8 +154,16 @@ private
     valid_keys.each do |key|
       define_method( key.to_sym) { @values[key] }
     end
+    # Test if a value is defined (could be nil) for a name
+    class_eval %Q{
+        def present?(name)
+          @values.key?( name.to_s )
+        end
+      }
   end
 
+
+
   # Validate the top level of the data structure returned 
   # Validate the top level of the data structure returned 
   def self.validate_structure( y, singleton, filename )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixed_record
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Bell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler