simmer 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06f7560edf8cf290460176a7b0065d0e338e6869f3dacfe5a1a0967b6c721dbf
+  data.tar.gz: e33d1612ed671f3a771c5805f70dd80e5bd0797cfeed97a1299ba05965c4362d
+SHA512:
+  metadata.gz: c6bccd619eaefcf5791e42ce658ad33297a946a64e7e719db6bcf7e3ba60fb07b9c38aac44aaa76b06d86d8f9ffb594c81bbb71d21b49f276dc325425f0d5674
+  data.tar.gz: 58cd3e35d04dd78b28a943acc2cf8cd75075e4861bea29d77bfdf7ac76fa8f0f82672031a458baefdd1a19a9e59095c8969970a664eb9f4030289a844e3dfdf5

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - simmer.gemspec
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 25
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 125

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,25 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=48c3a48cc3c203ac365190a30b3c0a9aae0d2c10c9a86735e654f23b8660bb02
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.4.6
+  - 2.5.5
+  - 2.6.5
+  - 2.7.0
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1 @@
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Blue Marble Payroll, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,5 @@
+# Simmer
+
+---
+
+Under construction.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'bundler/setup'
+require 'simmer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/simmer

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Examples:
+# - ./bin/simmer
+# - ./bin/simmer ./simmer/specs/transformations/examples
+# - ./bin/simmer ./simmer/specs/transformations/examples/update_user_name.yaml
+
+require 'simmer'
+
+exit 1 unless Simmer.run(ARGV[0]).pass?

data/lib/simmer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+# External libraries
+require 'acts_as_hashable'
+require 'aws-sdk-s3'
+require 'benchmark'
+require 'bigdecimal'
+require 'fileutils'
+require 'forwardable'
+require 'mysql2'
+require 'objectable'
+require 'pdi'
+require 'securerandom'
+require 'set'
+require 'stringento'
+require 'yaml'
+
+# Monkey-patching core libaries
+require_relative 'simmer/core_ext/hash'
+Hash.include Simmer::CoreExt::Hash
+
+# Load up general use-case utils for entire library
+require_relative 'simmer/util'
+
+# Core code
+require_relative 'simmer/suite'
+
+# The main entry-point API for the library.
+module Simmer
+  DEFAULT_CONFIG_PATH = File.join('config', 'simmer.yaml')
+  DEFAULT_RESULTS_DIR = 'results'
+  DEFAULT_SPEC_DIR    = 'simmer'
+  class << self
+    def run(path)
+      Suite.new(
+        out: $stdout,
+        config_path: DEFAULT_CONFIG_PATH,
+        results_dir: DEFAULT_RESULTS_DIR,
+        spec_dir: DEFAULT_SPEC_DIR
+      ).run(path)
+    end
+  end
+end

data/lib/simmer/configuration.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Simmer
+  # Reads in the Simmer configuration file and options and provides it to the rest of the
+  # Simmer implementation.
+  class Configuration
+    # Configuration Keys
+    AWS_FILE_SYSTEM_KEY = :aws_file_system
+    MYSQL_DATABASE_KEY  = :mysql_database
+    SPOON_CLIENT_KEY    = :spoon_client
+
+    # Paths
+    FILES    = 'files'
+    FIXTURES = 'fixtures'
+    TESTS    = 'specs'
+
+    private_constant :AWS_FILE_SYSTEM_KEY,
+                     :MYSQL_DATABASE_KEY,
+                     :SPOON_CLIENT_KEY,
+                     :FILES,
+                     :FIXTURES,
+                     :TESTS
+
+    attr_reader :config
+
+    def initialize(
+      config_path:,
+      resolver: Objectable.resolver,
+      results_dir:,
+      spec_dir:,
+      yaml_reader: Util::YamlReader.new
+    )
+      @config      = yaml_reader.read(config_path)
+      @resolver    = resolver
+      @results_dir = results_dir
+      @spec_dir    = spec_dir
+      @yaml_reader = yaml_reader
+
+      freeze
+    end
+
+    def database_config
+      get(MYSQL_DATABASE_KEY) || {}
+    end
+
+    def file_system_config
+      get(AWS_FILE_SYSTEM_KEY) || {}
+    end
+
+    def spoon_client_config
+      get(SPOON_CLIENT_KEY) || {}
+    end
+
+    def tests_dir
+      File.join(spec_dir, TESTS)
+    end
+
+    def fixtures_dir
+      File.join(spec_dir, FIXTURES)
+    end
+
+    def files_dir
+      File.join(spec_dir, FILES)
+    end
+
+    def fixture_set
+      config = yaml_reader.smash(fixtures_dir)
+
+      Util::FixtureSet.new(config)
+    end
+
+    private
+
+    attr_reader :resolver,
+                :results_dir,
+                :spec_dir,
+                :yaml_reader
+
+    def get(key)
+      resolver.get(config, key)
+    end
+  end
+end

data/lib/simmer/core_ext/hash.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Simmer
+  module CoreExt
+    # Monkey-patches for the core Hash class.  These will be manually mixed in separately.
+    module Hash
+      unless method_defined?(:symbolize_keys)
+        def symbolize_keys
+          map { |k, v| [k.to_sym, v] }.to_h
+        end
+      end
+    end
+  end
+end

data/lib/simmer/externals.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'externals/aws_file_system'
+require_relative 'externals/mysql_database'
+require_relative 'externals/spoon_client'

data/lib/simmer/externals/aws_file_system.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Simmer
+  module Externals
+    # Provides the implementation for using AWS S3 as a destination file store.
+    class AwsFileSystem
+      BUCKET_SUFFIX = 'test'
+
+      private_constant :BUCKET_SUFFIX
+
+      def initialize(config, files_dir)
+        config = (config || {}).symbolize_keys
+
+        client = Aws::S3::Client.new(
+          access_key_id: config[:access_key_id],
+          secret_access_key: config[:secret_access_key],
+          region: config[:region]
+        )
+
+        bucket_name = config[:bucket].to_s
+        assert_bucket_name(bucket_name)
+
+        @bucket     = Aws::S3::Bucket.new(name: bucket_name, client: client)
+        @encryption = config[:encryption]
+        @files_dir  = files_dir
+
+        freeze
+      end
+
+      def write(specification)
+        files = specification.stage.files
+
+        files.each do |file|
+          src = File.join(files_dir, file.src)
+
+          write_single(file.dest, src)
+        end
+
+        files.length
+      end
+
+      def clean
+        bucket.objects.inject(0) do |memo, object|
+          object.delete
+
+          memo + 1
+        end
+      end
+
+      private
+
+      attr_reader :bucket, :encryption, :files_dir
+
+      def write_single(dest, src)
+        File.open(src, 'rb') do |file|
+          bucket.object(dest).put(
+            body: file,
+            server_side_encryption: encryption
+          )
+        end
+
+        nil
+      end
+
+      def assert_bucket_name(name)
+        return if name.end_with?(BUCKET_SUFFIX)
+
+        raise ArgumentError, "bucket (#{name}) must end in #{BUCKET_SUFFIX}"
+      end
+    end
+  end
+end