datafy 0.6.1 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e762c66ae752ab2fb17cd1739408019164e135ed5e909826f1a538af2ae212'
-  data.tar.gz: 198dbed672227d35b0180319a9ef9857b58dfdc77f52b86540bbec7a2e439ee3
+  metadata.gz: 320cc715a3d47996fe4bea5b4318e3e424044dd8871101c81359a0794597f614
+  data.tar.gz: 7abb830654ee3a45b8cb58b774f6c8518b3e6dc7d726261417c882a108502d51
 SHA512:
-  metadata.gz: 04323d2e69ba66ce13412a7e28aa90db4c7c295070f9ff1f6f5c91303f8f59551476a1f33182c69824a1dc2980938afbc614b61db3fb5b733d4bfee1a433a578
-  data.tar.gz: 85c4fd3567dd533e5994c364bd9cd8e7ce6e202ec72ae4a59d6e1103b7f782fb29e7595932bbb65a2ea7b1ec6feba54d124e14ecec96001bf3d1dcc09b8e0303
+  metadata.gz: 9bdd27e05d9085670fddf74c04e5dff800b1393cf33bcf1f4df44e0edecc1fe963c93ec4841c01273aeae26dc84a9fb5651a2aacf288aa8291faef16fdbbfe59
+  data.tar.gz: 556da67854784253598b1d49dcf236eb777a89bc84a1126695c98a24da85d45f43b14660ae81c22c0234f369a9f5a7a3cad5f0da670f19f9690746ad2410d2e4

data/lib/datafy/{BaseHarvester.rb → BaseDatafier.rb}

@@ -4,15 +4,13 @@ require 'date'
 require 'logger'
 require_relative 'fileprovider'
 
-module BaseHarvester
+module BaseDatafier
 
     include FileProvider
 
-    # attr_accessor :errorMessage, :logFile, :logFileName, :showLog
-
     class HarvestError < StandardError
         attr_reader :message, :source
-        def initialize(msg="default message", thing="BaseHarvester")
+        def initialize(msg="default message", thing="BaseDatafier")
             @message = msg
             @thing   = thing
             super(msg)
@@ -22,6 +20,9 @@ module BaseHarvester
     # ==================  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 BaseHarvester
             '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.'                 },
@@ -135,4 +140,4 @@ module BaseHarvester
         num_groups.map(&:join).join(',').reverse
     end
 
-end # module BaseHarvester
+end # module BaseDatafier

data/lib/datafy/{CSVHarvester.rb → CSVifier.rb}

@@ -1,19 +1,19 @@
 require 'set'
 require 'csv'
-require_relative 'baseharvester'
+require_relative 'basedatafier'
 
-module CSVHarvester
+module CSVifier
 
-    include BaseHarvester
+    include BaseDatafier
     include FileProvider
 
     class << self
       def included(base)
-        base.extend CSVHarvesterClassMethods
+        base.extend CSVifierClassMethods
       end
     end # class << self
 
-    module CSVHarvesterClassMethods
+    module CSVifierClassMethods
 
         def logger
             @logger ||= Logger.new(logFileName,5,1024000)
@@ -24,7 +24,6 @@ module CSVHarvester
         end
 
         def data_fields
-            # @data_fields ||= KEY_FIELDS.merge( PROPERTY_FIELDS, BaseHarvester::BASE_HARVEST_DATA_FIELDS )
             @data_fields ||= register_fields :data
         end
 
@@ -33,7 +32,6 @@ module CSVHarvester
         end
 
         def details_fields
-            # @details_fields ||= KEY_FIELD.merge( BaseHarvester::DETAILS_PROPERTY_FIELDS, BaseHarvester::BASE_HARVEST_DATA_FIELDS )
             @details_fields ||= register_fields :details
           end
 
@@ -79,8 +77,8 @@ module CSVHarvester
             @details_fields = @data_fields.clone
             # --
             data_props      = self.const_defined?(:PROPERTY_FIELDS) ? self::PROPERTY_FIELDS : {}
-            @data_fields.merge!(    data_props,                             BaseHarvester::BASE_HARVEST_DATA_FIELDS )
-            @details_fields.merge!( BaseHarvester::DETAILS_PROPERTY_FIELDS, BaseHarvester::BASE_HARVEST_DATA_FIELDS )
+            @data_fields.merge!(    data_props,                            BaseDatafier::BASE_HARVEST_DATA_FIELDS )
+            @details_fields.merge!( BaseDatafier::DETAILS_PROPERTY_FIELDS, BaseDatafier::BASE_HARVEST_DATA_FIELDS )
             attr_fields @data_fields
             attr_fields @details_fields
             return type.eql?(:data) ? @data_fields : @details_fields
@@ -146,7 +144,7 @@ module CSVHarvester
             fqname = FileProvider.getDataFileName("")
             logger.debug fqname
             puts fqname
-            raise HarvestError.new "ERROR: method '#{self}::#{__method__}' not implemented source: CSVHarvester"
+            raise HarvestError.new "ERROR: method '#{self}::#{__method__}' not implemented source: CSVifier"
           end
         def prep_csv_file name, fields
             logger.debug "#{self.class}::#{__method__} name:'#{name}' fields:#{fields}"
@@ -245,7 +243,7 @@ module CSVHarvester
               @persistWhen = persist_when
           end
 
-    end # module CSVHarvesterClassMethods
+    end # module CSVifierClassMethods
 
     def logger
         # puts "#{self.class}::#{__method__}"
@@ -346,7 +344,7 @@ module CSVHarvester
         logger.debug "#{self.class}::#{__method__}"
         record( property: :harvestSuccessful, value: false )
         record( property: :harvestMessage,    value: error.message[0..150].gsub("\n", ' | ') )
-        @errorMessage = error.full_message.to_s # @errorMessage declared in BaseHarvester, useful for debugging
+        @errorMessage = error.full_message.to_s # @errorMessage declared in BaseDatafier, useful for debugging
     end
 
     def csvRecord
@@ -525,4 +523,4 @@ module CSVHarvester
         return str
     end
 
-end # module CSVHarvester
+end # module CSVifier

data/lib/datafy.rb

@@ -1,9 +1,27 @@
-require_relative 'datafy/baseharvester'
+require_relative 'datafy/basedatafier'
 require_relative 'datafy/fileprovider'
-require_relative 'datafy/csvharvester'
+require_relative 'datafy/csvifier'
 
-class Datafy
-  def self.hi
-    puts "Hello world! Datafy here to help you persist Ruby attributes as data Fields."
+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 "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\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 - register the property attributes with the class, via \"prop_accessor PROPERTY_FIELDS\""
+    my_loc =  File.dirname(__FILE__)
+    # puts "I'm at #{my_loc}"
+    proto_src    = File.join(my_loc, 'resources/Proto.rb')
+    proto_exists = File.exists? proto_src
+    # puts "Proto: #{proto_src}  exists? #{proto_exists}"
+    if proto_exists
+        puts "\nHere's an example of a prototype class employing datafy:"
+        puts   "--------------------------------------------------------"
+        contents = File.read(proto_src)
+        puts contents
+        puts   "--------------------------------------------------------"
+    end
   end
 end

data/lib/resources/Proto.rb

@@ -0,0 +1,35 @@
+require 'datafy'
+
+class Proto
+    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
+
+proto = Proto.new
+proto.harvest              # assign values to properties, there are two main ways to accomplish this:
+
+    proto.id = 'XBCD'                                                         # standard assignment
+    proto.record( property: :attribute, value: "Hi there, I'm an attribute" ) # key-value 'details' assignment
+
+proto.printCSVRecord       # print the object's data as a CSV record
+proto.printDetails         # print the object's data as a set of key-valye (aka details) records
+
+proto.persist              # persist the object's attributes into CSV files,
+                           #    - one 'flat'    file for normal records
+                           # - one key-value file for the object's details
+proto.printDataFiles       # identify the CSV files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datafy
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.5
 platform: ruby
 authors:
 - Chris Gerrard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-04-15 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
@@ -21,9 +21,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/datafy.rb
-- lib/datafy/BaseHarvester.rb
-- lib/datafy/CSVHarvester.rb
+- lib/datafy/BaseDatafier.rb
+- lib/datafy/CSVifier.rb
 - lib/datafy/FileProvider.rb
+- lib/resources/Proto.rb
 homepage: ''
 licenses:
 - MIT