datafy 0.7.4 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145a7af1e48a72862b262510783ddadbecc36bb5736000cb8f0620ac18e7712a
-  data.tar.gz: c6f91d1eb32c3fd05181f40288e3a0c26c91e50ce3e06f7561f5acd768bb16b0
+  metadata.gz: f7db53eae7e64ecd16eaa09db8451804d45221a80aa561f4fad07f751f16dffc
+  data.tar.gz: 371ec865101714566cd6bb56b701c4bb9ae17318c3ae0e964caecf6d6bef08a1
 SHA512:
-  metadata.gz: e91fae53634bc296615aa7258ec0f9a4a84831081e053b4b5cc7d789d35b9546a256a143d4e6ebb75fe4508f8aa05d159600e69493e2984b050259e421270c1a
-  data.tar.gz: 9bd5e18eb4cf6038b33c978eb99c2e883ccdb1a130b32bbd7450d88699930547bd69bf9ee51e96f3ba5ae48dd43b284a78a4ab9d2791afdf1d3e8155913353d4
+  metadata.gz: 0cb7cf2bb2e101369f91d425d2b6c0fdc8f8796e5a77547c74a3c862579e195d47f107603572beaf3fc524bec4b9234f28b452b775bf47711707fa4c709432f2
+  data.tar.gz: 265a8feeb867f8d01be900049f9ce85939ce30ed986fbfb70bbea3b8624c21bc36b16bdffb98dc9c26f8fb628cc6172877cb8f8c8b3e0a2a2d66679a8e87a4de

data/lib/datafy/BaseDatafier.rb

@@ -1,4 +1,4 @@
-# print "Executing: #{__FILE__}"
+# print "Loading: #{__FILE__}"
 
 require 'date'
 require 'logger'
@@ -8,8 +8,6 @@ module BaseDatafier
 
     include FileProvider
 
-    # attr_accessor :errorMessage, :logFile, :logFileName, :showLog
-
     class HarvestError < StandardError
         attr_reader :message, :source
         def initialize(msg="default message", thing="BaseDatafier")
@@ -22,6 +20,9 @@ module BaseDatafier
     # ==================  Data Fields Section  ==================
 
     v, $VERBOSE = $VERBOSE, nil
+        ##
+        # Metadata properties used to track the timing and success of the 'normal' properties.
+        # Optional for use in implementing classes, i.e. not required to be used, but will be present in the property sets
         BASE_HARVEST_DATA_FIELDS = {
             'Harvest When'        => { property: :harvestWhen,       comment: 'Date/Time of data harvesting'              },
             'Harvest Successful?' => { property: :harvestSuccessful, comment: 'Boolean - was harvesting successful?'      },
@@ -29,6 +30,10 @@ module BaseDatafier
             'Persist When'        => { property: :persistWhen,       comment: 'Date/Time of data persistence to CSV file' },
         }
         # --
+        ##
+        # Properties used to implement the key-value representation of the implementing classes' properties.
+        # Employed when the implementing class invokes the record method to, well, record an individual property and its value.
+        # Optional for use in implementing classes, i.e. not required to be used, but will be present in the Details record sets.
         DETAILS_PROPERTY_FIELDS = {
             'Class'   => { property: :klass,  comment: 'The class the details are being recorded for. (Base)'  },
             'Detail'  => { property: :detail, comment: 'The name of the field being recorded.'                 },
@@ -50,7 +55,7 @@ module BaseDatafier
         end
 
         def logFileName
-            @logFileName ||= FileProvider.getDataFileName("#{self.class}.log")
+            @logFileName ||= FileProvider.getDataFileName("#{self}.log")
         end
 
         def attr_fields fields
@@ -90,14 +95,6 @@ module BaseDatafier
           attr_fields fields
         end
 
-        # def register_details_fields fields
-            # return if fields.nil?
-            # @details_fields = {} if @details_fields.nil?
-            # @details_fields.merge!(fields)
-            # @details_fields.merge!(BASE_HARVEST_DATA_FIELDS)
-            # attr_fields @details_fields
-          # end
-
         def details_fields
           # puts "#{self.class}::#{__method__}"
           if @details_fields.nil?

data/lib/datafy/CSVifier.rb

@@ -323,6 +323,11 @@ module CSVifier
         end
     end
 
+    def resetData
+        resetDataFields
+        resetDetails
+    end
+
     def resetDataFields
         data_fields.each do |fieldName,parts|
             methodName = "#{parts[:property].to_s}="

data/lib/datafy/FileProvider.rb

@@ -1,4 +1,4 @@
-# puts "Executing: #{__FILE__}"
+# puts "Loading: #{__FILE__}"
 
 require 'fileutils'
 
@@ -30,7 +30,7 @@ module FileProvider
 
     def self.getDir dir='data'
         dir_name =  "#{localDir}/#{dir}".gsub(/[\/]+/,'/')
-        unless Dir.exists?(dir_name)
+        unless Dir.exist?(dir_name)
             Dir.mkdir(dir_name)
         end
         return dir_name

data/lib/datafy.rb

@@ -5,11 +5,11 @@ require_relative 'datafy/csvifier'
 module Datafy
 
   def self.usage
-    puts "\nHello there.\nDatafy.usage here to help you persist Ruby attributes as data Fields; and store the data in CSV files.\n"
+    puts "\nHi there. Datafy.usage here to help you persist Ruby attributes as data fields in CSV files.\n"
     puts "The basic  idea is simple: for each class whose instances you want to represent as data & save into a CSV file, you: "
-    puts "\t - establish class constants that identify the object attributes to dayafy, there are commonly two constants:"
+    puts "\t - establish class constants that identify the object attributes to datafy; there are commonly two constants:"
     puts "\t\t 1) KEY_FIELDS      - establish the key fields for each object"
-    puts "\t\t 2) PROPERTY_FIELDS - establish the other )non-key) fields for each object"
+    puts "\t\t 2) PROPERTY_FIELDS - establish the other, non-key, fields for each object"
     puts "\t - register the property attributes with the class, via \"prop_accessor PROPERTY_FIELDS\""
     my_loc =  File.dirname(__FILE__)
     # puts "I'm at #{my_loc}"

data/lib/resources/DatafyDemo.rb

@@ -0,0 +1,82 @@
+require 'datafy'
+class DatafyDemo
+    include CSVifier
+    v, $VERBOSE = $VERBOSE, nil
+    KEY_FIELDS = {
+        'Root' => { property: :root, comment: "Property providing information about the entity being datafied."      },
+        'ID'   => { property: :id,   comment: "Traditional ID property."      },
+    }
+    PROPERTY_FIELDS = {
+        'Introduction' => { property: :introduction, comment: "Informative material."   },
+        'Attribute'    => { property: :attribute,    comment: "Something of interest."  }
+
+    }
+    $VERBOSE = v
+    prop_accessor PROPERTY_FIELDS  # establish the class properties based upon the declared constants
+                                   # note: these property assignments will be included:
+                                   #       KEY_FIELDS                             - declared above
+                                   #       BaseDatafier::BASE_HARVEST_DATA_FIELDS - harvesting & persisting metadata
+                                   #       BaseDatafier::DETAILS_PROPERTY_FIELDS  - key-value details fields
+end
+
+
+puts " "
+puts "====================================="
+puts "Creating new DatafyDemo object 'demo'"
+puts "-------------------------------------"
+puts "> demo = DatafyDemo.new"
+demo = DatafyDemo.new
+
+puts ""
+puts "===================================="
+puts "Assigning values to demo, two forms:"
+puts "------------------------------------"
+# --
+puts ">  demo.id = 'XBCD'"
+puts "   # standard assignment, assigns value to object property 'id', does NOT establish a details key-value record"
+demo.id = 'XBCD'                                                         # standard assignment, i.e. typical 'wide' form
+# --
+puts ">  demo.record( property: :attribute, value: 'Hi there, I'm an DataDemo attribute ' )"
+puts "   # key-value 'details' record created for 'attribute' property AND a details key-value record is established"
+demo.record( property: :attribute, value: "Hi there, I'm an attribute" ) # key-value 'details' assignment, i.e. 'tall' form
+
+puts ""
+puts "==============="
+puts "Harvesting demo"
+puts "establish the time & other data about when harvesting occurred and its success or failure"
+puts "---------------"
+puts ">  demo.harvest"
+demo.harvest
+
+puts ""
+puts "================================"
+puts "Printing demo's data, two forms:"
+puts "--------------------------------"
+puts ""
+puts ">  demo.printCSVRecord"
+puts "   # print the object's data as a CSV record"
+demo.printCSVRecord
+puts " "
+puts ">  demo.printDetails"
+puts "   # print the object's data as a set of key-value (aka details) records"
+puts "   # note: ONLY those properties instantiated with 'demo.record(...)' exist as details"
+demo.printDetails
+
+puts ""
+puts "=============================================="
+puts "Persist the object's attributes into CSV files"
+puts "  creates 2 CSV files:"
+puts "  - one 'flat'    file for normal CSV records"
+puts "  - one key-value file for the object's details"
+puts "-----------------------------------------------"
+puts ">      demo.persist"
+demo.persist
+
+puts ""
+puts "================================"
+puts "Identify the persisted CSV files"
+puts "--------------------------------"
+puts ">  demo.printDataFiles"
+demo.printDataFiles
+
+puts "\n\t\t That's all, Folks."

data/lib/resources/Proto.rb

@@ -1,6 +1,7 @@
 require 'datafy'
+
 class Proto
-    include CSVifier
+    include CSVifier               # core implementation mudule
     v, $VERBOSE = $VERBOSE, nil
     KEY_FIELDS = {
         'Root' => { property: :root, comment: "Property providing information about the entity being datafied."      },
@@ -14,7 +15,7 @@ class Proto
     $VERBOSE = v
     prop_accessor PROPERTY_FIELDS  # establish the class properties based upon the declared constants
                                    # note: these property assignments will be included:
-                                   #       KEY_FIELDS                              - declared above
+                                   #       KEY_FIELDS                             - declared above
                                    #       BaseDatafier::BASE_HARVEST_DATA_FIELDS - harvesting & persisting metadata
                                    #       BaseDatafier::DETAILS_PROPERTY_FIELDS  - key-value details fields
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: datafy
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: '1.1'
 platform: ruby
 authors:
 - Chris Gerrard
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Represent, record, and persist Ruby classes' attributes as CSV fields
   and persist them as data fields into CSV files. Each attribute has an internal class
@@ -24,12 +23,12 @@ files:
 - lib/datafy/BaseDatafier.rb
 - lib/datafy/CSVifier.rb
 - lib/datafy/FileProvider.rb
+- lib/resources/DatafyDemo.rb
 - lib/resources/Proto.rb
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -44,8 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
-signing_key:
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Record class attributes as data fields, with simple property names and human-oriented
   names, and persist into CSV files.