fixed_record 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e28a9a9f85d811dca1463d6d5ae8944d0d5fd66a098be6e93a9c86b939f4807
-  data.tar.gz: 1849d6bb120d51aa6f275f1bc9c2d8e78166bf492c4e39887ed2fa010dbfa1fd
+  metadata.gz: 572787b07827ff2d2e0279f93bb3b78d37b8865f2063f4076184d792843e6a18
+  data.tar.gz: 3b53ae4bba8a9e090e872d550e18f7027f5e7d8719778d4e4f3a588ee7eee04d
 SHA512:
-  metadata.gz: a03e177ac9d18c4ee7bd5f5589cdc9657369cc7444dd7b371ca644ec53c0030d160a2fd76ab3669093e44364baae267e1c165f47d23cbe481c7d2c04b61999ed
-  data.tar.gz: a6462fa10d6eff0704dbd51aa3001a5a5ee367947eea83a32962de27c8fe68c907204b20860270063ac23cbd8ce50aea2697a01d1d0649bc7b58cb1962164165
+  metadata.gz: 6c47c29c44fb5ecd9788814a163d5e2eb28d5f14a1e5d5d362ab0d9182bb5c289d9e93c1032d75875f35a48cfc07c97b205964d2dc0f4bd18a7d3590399d8b05
+  data.tar.gz: baf11d31820fbcf012aba2bb55ba8d2056f77e90694c1bd6dd7f0d8daef2cda02f1d0323efbaa9c241120bde3d3de55287df9aa6c3a9089a087768b80acf1651

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Gem fixed_record Changelog
 
+## 0.6.0
+* Internal refactoring - after reading _Metaprogramming Ruby_!
+* Added size and length methods
+
 ## 0.5.0
 * Added class method `valid_names` to return valid names in records
 * Documented class method `filename`

data/Gemfile.lock

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

data/lib/fixed_record.rb

@@ -3,8 +3,9 @@ require 'yaml'
 require 'psych'
 require 'set'
 
+# Provides error-checked simplified access to a YAML data file
 class FixedRecord
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 
   # Lazy load data from given filename 
   # creating accessors for top level attributes
@@ -13,51 +14,118 @@ class FixedRecord
     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 )
+    # Although not necessary, the class_eval makes it easier to see 
+    # we are defining variables and methods in the context of the child class which
+    # called us
+    class_eval do
+      # Use @x names for class variables to simplify access
+      @filename = filename
+      @valid_keys = Set.new( required )
+      @valid_keys.merge( optional )
+      @required_keys = Set.new( required )
+      @singleton = singleton
+
+      # Load the data and create the methods...
+      def self.load!
+        return unless @items.nil?
+        begin
+          y = YAML.load_file( @filename )
+        rescue Errno::ENOENT
+          raise 
+        rescue Psych::SyntaxError => error
+          fname = File.basename(@filename)
+          msg = error.message
+          if msg.include? @filename
+            msg.sub!( @filename, fname )
+            msg = "#{error.class.name} #{msg}"
+          else
+            msg = "#{error.class.name} #{fname} #{error.message}"
+          end
+          raise ArgumentError, msg
+        end
+
+        validate_structure( y, @singleton, @filename )
 
-    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 )
-    self.class_variable_set( :@@singleton, singleton )
+        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
+            r.instance_variable_set( :@values, values )
+            r
+          end
+        elsif y.is_a?(Hash)
+          @items = Hash.new
+          add_key = !@valid_keys.member?('key')
+          y.each do |k,values|
+            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
+          define_method( :key ) { @values['key'] }  if add_key
+        end
+        create_methods( @valid_keys  )
+      end
+
+      # filename data was loaded from
+      def self.filename
+        @filename
+      end
+
+      # valid keys (as strings)
+      def self.valid_names
+        load!
+        @valid_keys
+      end
+    end #class_eval
 
     if singleton 
-      class_eval %Q{
+      class_eval do # class methods for singleton object
         def self.[](k)
           load!
           k = k.to_s
-          raise ArgumentError, "\#{k} is not a valid key" unless @@valid_keys.member?(k)
-          @@items[k]
+          raise ArgumentError, "#{k} is not a valid key" unless @valid_keys.member?(k)
+          @items[k]
         end
-      }
+      end # class_eval
     else
-      class_eval %Q{
-        class << self
-          include Enumerable
-        end
-
-        def self.all 
+      # Add methods for Coillection based objects
+      self.class.include Enumerable
+      class_eval do
+        def self.all
           load!
-          @@items
+          @items
         end
 
         def self.each( &block )
-          load!
-          @@items.each(&block)
+          all.each(&block)
         end
 
-        def self.count
-          load!
-          @@items.length
+        def self.size
+          all.size
         end
 
         def self.[]( k )
           if all.is_a?(Hash)
             all[k.to_s]
           else
-            nil
+            nil # Arguably we could index the array, but if we did your code would smell...
           end
         end
 
@@ -68,76 +136,16 @@ class FixedRecord
             false
           end
         end 
-
-      }
-    end
-
-    class_eval %Q{
-      def self.filename
-        @@filename
+      end #class_eval
+    
+      # Only way I can find to alias class methods...
+      class << self
+        alias length size
+        alias count size
       end
 
-      def self.valid_names
-        load!
-        @@valid_keys
-      end
-
-      def self.load!
-        if @@items.nil?
-          begin
-            y = YAML.load_file( @@filename )
-          rescue Errno::ENOENT
-            raise 
-          rescue Psych::SyntaxError => error
-            fname = File.basename(@@filename)
-            msg = error.message
-            if msg.include? @@filename
-              msg.sub!( @@filename, fname )
-              msg = "\#{error.class.name} \#{msg}"
-            else
-              msg = "\#{error.class.name} \#{fname} \#{error.message}"
-            end
-            raise ArgumentError, msg
-          end
-          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
+    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
-              r.instance_variable_set( :@values, values )
-              r
-            end
-          elsif y.is_a?(Hash)
-            @@items = Hash.new
-            add_key = !@@valid_keys.member?('key')
-            y.each do |k,values|
-              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
-            define_method( :key ) { @values['key'] }  if add_key
-          end
-          create_methods( @@valid_keys  )
-        end
-      end
-    }
   end
 
 
@@ -155,11 +163,7 @@ private
       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
-      }
+    define_method( :present? ) { |name| @values.key?(name.to_s)}
   end
 
 
@@ -205,6 +209,4 @@ private
     validate( values, index )
   end
 
-
-
 end

metadata

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