cure 0.1.1 → 0.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cure
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - william
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -24,44 +24,103 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: rcsv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Anonymize private data inside CSV files
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.74.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.74.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+description: Transform, select, anonymize or manipulate data inside CSV files with
+  templates.
 email:
 - me@williamthom.as
 executables:
 - cure
+- cure.old
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -69,22 +128,101 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/README.md
+- docs/about.md
+- docs/builder/add.md
+- docs/builder/black_white_list.md
+- docs/builder/copy.md
+- docs/builder/explode.md
+- docs/builder/main.md
+- docs/builder/remove.md
+- docs/examples/examples.md
+- docs/export/main.md
+- docs/extract/main.md
+- docs/metadata/main.md
+- docs/query/main.md
+- docs/sources/main.md
+- docs/transform/main.md
+- docs/validate/main.md
 - exe/cure
+- exe/cure.old
 - lib/cure.rb
+- lib/cure/builder/base_builder.rb
+- lib/cure/builder/candidate.rb
+- lib/cure/cli/command.rb
+- lib/cure/cli/generate_command.rb
+- lib/cure/cli/new_command.rb
+- lib/cure/cli/run_command.rb
+- lib/cure/cli/templates/README.md.erb
+- lib/cure/cli/templates/gemfile.erb
+- lib/cure/cli/templates/gitignore.erb
+- lib/cure/cli/templates/new_template.rb.erb
+- lib/cure/cli/templates/tool-versions.erb
 - lib/cure/config.rb
-- lib/cure/csv_helpers.rb
-- lib/cure/export/exporter.rb
-- lib/cure/file_helpers.rb
-- lib/cure/generator/base.rb
+- lib/cure/coordinator.rb
+- lib/cure/database.rb
+- lib/cure/dsl/builder.rb
+- lib/cure/dsl/exporters.rb
+- lib/cure/dsl/extraction.rb
+- lib/cure/dsl/metadata.rb
+- lib/cure/dsl/queries.rb
+- lib/cure/dsl/source_files.rb
+- lib/cure/dsl/template.rb
+- lib/cure/dsl/transformations.rb
+- lib/cure/dsl/validator.rb
+- lib/cure/export/base_processor.rb
+- lib/cure/export/manager.rb
+- lib/cure/extract/base_processor.rb
+- lib/cure/extract/csv_lookup.rb
+- lib/cure/extract/extractor.rb
+- lib/cure/extract/filter.rb
+- lib/cure/extract/named_range.rb
+- lib/cure/extract/named_range_processor.rb
+- lib/cure/extract/variable.rb
+- lib/cure/extract/variable_processor.rb
+- lib/cure/generator/base_generator.rb
+- lib/cure/generator/case_generator.rb
+- lib/cure/generator/character_generator.rb
+- lib/cure/generator/erb_generator.rb
+- lib/cure/generator/eval_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/proc_generator.rb
+- lib/cure/generator/redact_generator.rb
+- lib/cure/generator/static_generator.rb
+- lib/cure/generator/variable_generator.rb
+- lib/cure/helpers/file_helpers.rb
+- lib/cure/helpers/object_helpers.rb
+- lib/cure/helpers/perf_helpers.rb
+- lib/cure/helpers/string.rb
+- lib/cure/launcher.rb
 - lib/cure/log.rb
-- lib/cure/main.rb
-- lib/cure/object_helpers.rb
-- lib/cure/strategy/base.rb
+- lib/cure/planner.rb
+- lib/cure/strategy/append_strategy.rb
+- lib/cure/strategy/base_strategy.rb
+- lib/cure/strategy/contain_strategy.rb
+- lib/cure/strategy/end_with_strategy.rb
+- lib/cure/strategy/full_strategy.rb
+- lib/cure/strategy/history/history_cache.rb
+- lib/cure/strategy/imports.rb
+- lib/cure/strategy/match_strategy.rb
+- lib/cure/strategy/prepend_strategy.rb
+- lib/cure/strategy/regex_strategy.rb
+- lib/cure/strategy/split_strategy.rb
+- lib/cure/strategy/start_with_strategy.rb
 - lib/cure/transformation/candidate.rb
 - lib/cure/transformation/transform.rb
+- lib/cure/validator/base_rule.rb
+- lib/cure/validator/candidate.rb
+- lib/cure/validator/manager.rb
+- lib/cure/validators.rb
 - lib/cure/version.rb
-- templates/aws_cur_template.json
-- templates/example_template.json
+- templates/dsl_example.rb
+- templates/empty_template.rb
 homepage: https://www.github.com/williamthom-as/cure
 licenses:
 - MIT
@@ -97,15 +235,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.6
 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/export/exporter.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "cure/log"
-require "cure/file_helpers"
-
-module Cure
-  module Export
-    class Exporter
-      include Cure::FileHelpers
-      include Log
-
-      def self.export_ctx(ctx, output_dir, file_name)
-        column_headers = ctx.column_headers.keys
-
-        exporter = Exporter.new
-        exporter.export(output_dir, file_name, ctx.transformed_rows, column_headers)
-      end
-
-      # @param [Array] rows
-      # @param [Array] columns
-      def export(output_dir, file_name, rows, columns)
-        log_info("Exporting file to [#{output_dir}/#{file_name}] with #{rows.length} rows")
-
-        file_contents = []
-        file_contents << columns.join(",")
-
-        rows.each do |row|
-          file_contents << row.join(",")
-        end
-
-        write_to_file(
-          output_dir, file_name, "csv", file_contents.join("\n")
-        )
-      end
-
-      # @param [String] file_path
-      # @param [String] contents
-      # @param [String] file_extension
-      def write_to_file(file_path, file_name, file_extension, contents)
-        file_location = "#{file_path}/#{file_name || Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S%-z")}"
-        clean_dir(file_path)
-
-        with_file(file_location, file_extension) do |file|
-          file.write(contents)
-        end
-      end
-    end
-  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/main.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require "cure"
-require "json"
-require "cure/transformation/candidate"
-require "cure/transformation/transform"
-require "cure/export/exporter"
-
-module Cure
-
-  class Main
-    include Configuration
-    include FileHelpers
-
-    # @return [Cure::Main]
-    def self.init(template_file, csv_file, output_dir)
-      # Run all init stuff here.
-      main = Main.new
-      main.setup(template_file, csv_file, output_dir)
-
-      main
-    end
-
-    # @return [Cure::Transformation::Transform]
-    attr_accessor :transformer
-
-    # @return [Boolean]
-    attr_reader :is_initialised
-
-    def initialize
-      @is_initialised = false
-    end
-
-    def run
-      raise "Not init" unless @transformer
-
-      ctx = build_ctx
-      export(ctx)
-    end
-
-    # @return [Cure::Transform::TransformContext]
-    def build_ctx
-      @transformer.extract_from_file(config.source_file_location)
-    end
-
-    def setup(template_file, csv_file, output_dir)
-      config = create_config(csv_file, JSON.parse(read_file(template_file)), output_dir)
-      register_config(config)
-
-      candidates = config.template["candidates"].map { |c| Cure::Transformation::Candidate.new.from_json(c) }
-
-      @transformer = Cure::Transformation::Transform.new(candidates)
-      @is_initialised = true
-    end
-
-    private
-
-    # @param [Cure::Transform::TransformContext] ctx
-    def export(ctx)
-      Cure::Export::Exporter.export_ctx(ctx, config.output_dir, "csv_file")
-    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