cure 0.1.1 → 0.1.2

data/templates/aws_cur_template.json

@@ -1,143 +1,145 @@
 {
-  "candidates" : [
-    {
-      "column" : "identity/LineItemId",
-      "translations" : [{
-        "strategy" : {
-          "name": "full",
-          "options" : {}
-        },
-        "generator" : {
-          "name" : "character",
-          "options" : {
-            "length" : 52,
-            "types" : [
-              "lowercase", "number"
-            ]
+  "transformations" : {
+    "candidates" : [
+      {
+        "column" : "identity/LineItemId",
+        "translations" : [{
+          "strategy" : {
+            "name": "full",
+            "options" : {}
+          },
+          "generator" : {
+            "name" : "character",
+            "options" : {
+              "length" : 52,
+              "types" : [
+                "lowercase", "number"
+              ]
+            }
           }
-        }
-      }]
-    },
-    {
-      "column" : "bill/PayerAccountId",
-      "translations" : [{
-        "strategy" : {
-          "name": "full",
-          "options" : {}
-        },
-        "generator" : {
-          "name" : "placeholder",
-          "options" : {
-            "name" : "$account_number"
-          }
-        }
-      }]
-    },
-    {
-      "column" : "lineItem/UsageAccountId",
-      "translations" : [{
-        "strategy" : {
-          "name": "full",
-          "options" : {}
-        },
-        "generator" : {
-          "name" : "number",
-          "options" : {
-            "length" : 6
-          }
-        }
-      }]
-    },
-    {
-      "column" : "lineItem/ResourceId",
-      "translations" : [{
-        "strategy" : {
-          "name": "regex",
-          "options" : {
-            "regex_cg" : "^i-(.*)"
-          }
-        },
-        "generator" : {
-          "name" : "hex",
-          "options" : {
-            "length" : 10
+        }]
+      },
+      {
+        "column" : "bill/PayerAccountId",
+        "translations" : [{
+          "strategy" : {
+            "name": "full",
+            "options" : {}
+          },
+          "generator" : {
+            "name" : "placeholder",
+            "options" : {
+              "name" : "$account_number"
+            }
           }
-        }
-      },{
-        "strategy" : {
-          "name": "regex",
-          "options" : {
-            "regex_cg" : "^vol-(.*)"
+        }]
+      },
+      {
+        "column" : "lineItem/UsageAccountId",
+        "translations" : [{
+          "strategy" : {
+            "name": "full",
+            "options" : {}
+          },
+          "generator" : {
+            "name" : "number",
+            "options" : {
+              "length" : 6
+            }
           }
-        },
-        "generator" : {
-          "name" : "hex",
-          "options" : {
-            "length" : 10
+        }]
+      },
+      {
+        "column" : "lineItem/ResourceId",
+        "translations" : [{
+          "strategy" : {
+            "name": "regex",
+            "options" : {
+              "regex_cg" : "^i-(.*)"
+            }
+          },
+          "generator" : {
+            "name" : "hex",
+            "options" : {
+              "length" : 10
+            }
           }
-        }
-      },{
-        "strategy" : {
-          "name": "split",
-          "options" : {
-            "token": ":",
-            "index": 4
+        },{
+          "strategy" : {
+            "name": "regex",
+            "options" : {
+              "regex_cg" : "^vol-(.*)"
+            }
+          },
+          "generator" : {
+            "name" : "hex",
+            "options" : {
+              "length" : 10
+            }
           }
-        },
-        "generator" : {
-          "name" : "placeholder",
-          "options" : {
-            "name" : "$account_number"
+        },{
+          "strategy" : {
+            "name": "split",
+            "options" : {
+              "token": ":",
+              "index": 4
+            }
+          },
+          "generator" : {
+            "name" : "placeholder",
+            "options" : {
+              "name" : "$account_number"
+            }
           }
-        }
-      },{
-        "strategy" : {
-          "name": "split",
-          "options" : {
-            "token": ":",
-            "index": -1
+        },{
+          "strategy" : {
+            "name": "split",
+            "options" : {
+              "token": ":",
+              "index": -1
+            }
+          },
+          "generator" : {
+            "name" : "faker",
+            "options" : {
+              "module" : "App",
+              "method" : "name"
+            }
           }
-        },
-        "generator" : {
-          "name" : "faker",
-          "options" : {
-            "module" : "App",
-            "method" : "name"
+        }],
+        "no_match_translation" : {
+          "strategy" : {
+            "name": "full",
+            "options" : {}
+          },
+          "generator" : {
+            "name" : "hex",
+            "options" : {
+              "length" : 10,
+              "prefix" : "s3_bucket_"
+            }
           }
         }
-      }],
-      "no_match_translation" : {
-        "strategy" : {
-          "name": "full",
-          "options" : {}
-        },
-        "generator" : {
-          "name" : "hex",
-          "options" : {
-            "length" : 10,
-            "prefix" : "s3_bucket_"
+      },
+      {
+        "column" : "resourceTags/aws:createdBy",
+        "translations" : [{
+          "strategy" : {
+            "name": "full",
+            "options" : {}
+          },
+          "generator" : {
+            "name" : "faker",
+            "options" : {
+              "module" : "Faker::Movies::StarWars",
+              "method" : "character"
+            }
           }
-        }
+        }]
       }
-    },
-    {
-      "column" : "resourceTags/aws:createdBy",
-      "translations" : [{
-        "strategy" : {
-          "name": "full",
-          "options" : {}
-        },
-        "generator" : {
-          "name" : "faker",
-          "options" : {
-            "module" : "Faker::Movies::StarWars",
-            "method" : "character"
-          }
-        }
-      }]
+    ],
+    "placeholders" : {
+      "$account_number" : "1234567891234"
     }
-  ],
-  "placeholders" : {
-    "$account_number" : "1234567891234"
   }
 }

data/templates/example_template.json

@@ -1,38 +1,54 @@
 {
-  "replacements" : [
-    {
-      "column" : "bill/PayerAccountId",
-      "strategy" : {
-        "name": "full",
-        "options" : {}
-      },
-      "generator" : {
-        "name" : "placeholder",
-        "options" : {
-          "name" : "$account_number"
-        }
-      }
-    },{
-      "column" : "lineItem/ResourceId",
-      "strategy" : {
-        "name": "regex",
-        "options" : {
-          "regex" : ""
+  "extraction": {
+    "named_ranges": [{
+      "name": "main",
+      "section": "B2:F2"
+    }],
+    "variables" : [{
+      "name" : "date",
+      "type" : "single_field",
+      "location" : "B2"
+    }]
+  },
+  "transformations": {
+    "candidates": [
+      {
+        "column": "bill/PayerAccountId",
+        "strategy": {
+          "name": "full",
+          "options": {}
+        },
+        "generator": {
+          "name": "placeholder",
+          "options": {
+            "name": "$account_number"
+          }
         }
-      },
-      "generator" : {
-        "name": "number",
-        "options" : {
-          "length" : 12
+      },{
+        "column": "lineItem/ResourceId",
+        "strategy": {
+          "name": "regex",
+          "options": {
+            "regex": ""
+          }
+        },
+        "generator": {
+          "name": "number",
+          "options": {
+            "length": 12
+          }
         }
       }
+    ],
+    "placeholders": {
+      "$account_number": "1234567891234"
     }
-  ],
-  "placeholders" : {
-    "$account_number" : "1234567891234"
   },
-  "column_export" : {
-    "type" : "blacklist",
-    "columns" : []
+  "export": {
+    "sections" : {
+      "named_range" : "main",
+      "file_name" : "main-file",
+      "type" : "csv"
+    }
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cure
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - william
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Anonymize private data inside CSV files
+description: Transform, select, anonymize or manipulate data inside CSV files with
+  templates.
 email:
 - me@williamthom.as
 executables:
@@ -72,16 +73,42 @@ files:
 - exe/cure
 - lib/cure.rb
 - lib/cure/config.rb
-- lib/cure/csv_helpers.rb
+- lib/cure/coordinator.rb
 - lib/cure/export/exporter.rb
-- lib/cure/file_helpers.rb
-- lib/cure/generator/base.rb
+- lib/cure/extract/builder.rb
+- lib/cure/extract/csv_lookup.rb
+- lib/cure/extract/extractor.rb
+- lib/cure/generator/base_generator.rb
+- lib/cure/generator/case_generator.rb
+- lib/cure/generator/character_generator.rb
+- lib/cure/generator/faker_generator.rb
+- lib/cure/generator/guid_generator.rb
+- lib/cure/generator/hex_generator.rb
+- lib/cure/generator/imports.rb
+- lib/cure/generator/number_generator.rb
+- lib/cure/generator/placeholder_generator.rb
+- lib/cure/generator/redact_generator.rb
+- lib/cure/generator/variable_generator.rb
+- lib/cure/helpers/file_helpers.rb
+- lib/cure/helpers/object_helpers.rb
 - lib/cure/log.rb
 - lib/cure/main.rb
-- lib/cure/object_helpers.rb
-- lib/cure/strategy/base.rb
+- lib/cure/strategy/append_strategy.rb
+- lib/cure/strategy/base_strategy.rb
+- lib/cure/strategy/end_with_strategy.rb
+- lib/cure/strategy/full_strategy.rb
+- lib/cure/strategy/imports.rb
+- lib/cure/strategy/match_strategy.rb
+- lib/cure/strategy/regex_strategy.rb
+- lib/cure/strategy/split_strategy.rb
+- lib/cure/strategy/start_with_strategy.rb
+- lib/cure/template/dispatch.rb
+- lib/cure/template/extraction.rb
+- lib/cure/template/template.rb
+- lib/cure/template/transformations.rb
 - lib/cure/transformation/candidate.rb
 - lib/cure/transformation/transform.rb
+- lib/cure/validators.rb
 - lib/cure/version.rb
 - templates/aws_cur_template.json
 - templates/example_template.json
@@ -107,5 +134,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: Anonymize private data inside CSV files
+summary: Cure provides the ability to transform CSVs using descriptive templates.
 test_files: []

data/lib/cure/csv_helpers.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Cure
-  module CSVHelpers
-  end
-end

data/lib/cure/file_helpers.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require "fileutils"
-
-module Cure
-  module FileHelpers
-    def with_file(path, extension, &block)
-      dir = File.dirname(path)
-
-      FileUtils.mkdir_p(dir) unless File.directory?(dir)
-
-      path = "#{path}.#{extension}"
-      File.open(path, "w", &block)
-    end
-
-    def clean_dir(path)
-      dir = File.file?(path) ? File.dirname(path) : path
-
-      FileUtils.remove_dir(dir) if File.directory?(dir)
-    end
-
-    def read_file(file_location)
-      result = file_location.start_with?("/") ? file_location : File.join(File.dirname(__FILE__), file_location)
-
-      raise "No file found at [#{file_location}]" unless File.exist? result
-
-      File.read(result)
-    end
-
-    def with_temp_dir(temp_dir, &_block)
-      return unless block_given?
-
-      clean_dir(temp_dir)
-      yield
-      clean_dir(temp_dir)
-    end
-  end
-end

data/lib/cure/generator/base.rb

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-
-module Cure
-  module Generator
-    class Base
-      # @return [Hash]
-      attr_accessor :options
-
-      def initialize(options={})
-        @options = options
-      end
-
-      # @param [Object/Nil] source_value
-      # @return [String]
-      def generate(source_value=nil)
-        translated = _generate(source_value)
-        translated = "#{prefix}#{translated}" if prefix
-        translated = "#{translated}#{suffix}" if suffix
-        translated
-      end
-
-      private
-
-      # @param [Object/Nil] _source_value
-      # @return [String]
-      def _generate(_source_value)
-        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
-      end
-
-      def prefix(default=nil)
-        extract_property("prefix", default)
-      end
-
-      def suffix(default=nil)
-        extract_property("suffix", default)
-      end
-
-      def length(default=nil)
-        extract_property("length", default)
-      end
-
-      def property_name(default=nil)
-        extract_property("name", default)
-      end
-
-      def extract_property(property, default_val)
-        @options.fetch(property, default_val)
-      end
-    end
-
-    class HexGenerator < Base
-      private
-
-      # @param [Object] _source_value
-      def _generate(_source_value)
-        1.upto(length(rand(0..9))).map { rand(0..15).to_s(16) }.join("")
-      end
-    end
-
-    class NumberGenerator < Base
-      private
-
-      # @param [Object] _source_value
-      def _generate(_source_value)
-        1.upto(length(rand(0..9))).map { rand(1..9) }.join("").to_i
-      end
-    end
-
-    class RedactGenerator < Base
-      private
-
-      # @param [Object] source_value
-      def _generate(source_value)
-        1.upto(length(source_value&.length || 5)).map { "X" }.join("")
-      end
-    end
-
-    class PlaceholderGenerator < Base
-      include Configuration
-
-      private
-
-      # @param [Object] _source_value
-      def _generate(_source_value)
-        value = config.placeholders[property_name]
-        value || raise("Missing placeholder value. Available candidates: [#{config.placeholders.join(", ")}]")
-      end
-    end
-
-    require "securerandom"
-
-    class GuidGenerator < Base
-      private
-
-      # @param [Object] _source_value
-      def _generate(_source_value)
-        SecureRandom.uuid.to_s
-      end
-    end
-
-    require "faker"
-
-    class FakerGenerator < Base
-      private
-
-      # @param [Object] _source_value
-      def _generate(_source_value)
-        mod_code = extract_property("module", nil)
-        mod = Faker.const_get(mod_code)
-
-        raise "No Faker module found for [#{mod_code}]" unless mod
-
-        meth_code = extract_property("method", nil)&.to_sym
-        raise "No Faker module found for [#{meth_code}]" unless mod.methods.include?(meth_code)
-
-        mod.send(meth_code)
-      end
-    end
-
-    class CharacterGenerator < Base
-
-      def initialize(options=nil)
-        super(options)
-      end
-
-      private
-
-      # @param [Object] source_value
-      def _generate(source_value)
-        arr = build_options.map(&:to_a).flatten
-        (0...length(source_value&.length || 5)).map { arr[rand(arr.length)] }.join
-      end
-
-      def build_options
-        return [("a".."z"), ("A".."Z"), (0..9)] unless @options.key?("types")
-
-        type_array = @options["types"]
-
-        arr = []
-        arr << ("a".."z") if type_array.include? "lowercase"
-        arr << ("A".."Z") if type_array.include? "uppercase"
-        arr << (0..9) if type_array.include? "number"
-        arr << ("!".."+") if type_array.include? "symbol"
-        arr
-      end
-    end
-  end
-end

data/lib/cure/object_helpers.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "cure"
-require "json"
-
-module Cure
-  module ObjectHelpers
-    def attributes=(hash)
-      hash.each do |key, value|
-        send("#{key}=", value)
-      rescue NoMethodError
-        Cure.logger.warn("Error deserializing object: No property for #{key}")
-      end
-    end
-
-    def from_json(json)
-      return from_hash(json) if json.is_a?(Hash) # Just a guard in case serialisation is done
-
-      from_hash(JSON.parse(json))
-    end
-
-    def from_hash(hash)
-      self.attributes = hash
-      self
-    end
-  end
-end