wc-essentials 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dd4d39d4c354a2e5f17a597a8a3314dcdac40903d37f60f646750fd5a7a7c41
+  data.tar.gz: 4c7fbc1e7c2175138bbc2ebc5d2634c917b44817885bcbdcf6b6ba1e4deac169
+SHA512:
+  metadata.gz: 4bfe39ee38cd378815ac78a253f0d901c6d4c6676c11907f95cc7693d3765d38dceec390567292235bbe79a7f9862e7fd41f2065ee3de2b741e15332a04efddf
+  data.tar.gz: 16ccae333ee7921a662eb525106e933b398830af04612967400803f9b9cc78bbd42a7b08a41d57588a582096a3d6f2de8f0aecdf79549fc8f50c262da44577c9

data/.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+FROM workcompass/wc-rails:1.1.0
+LABEL maintainer="Dev Team at WorkCompass <dev@workcompass.com>"
+ENV REFRESHED_ON 2021-08-08
+
+# Default value to allow debug server to serve content over GitHub Codespace's port forwarding service
+# The value is a comma-separated list of allowed domains 
+ENV RAILS_DEVELOPMENT_HOSTS=".githubpreview.dev"
+
+# [Choice] Node.js version: lts/*, 16, 14, 12, 10
+# ARG NODE_VERSION="lts/*"
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,32 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.3/containers/ruby-rails
+{
+  "name": "wc-essentials",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {},
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [
+    "rebornix.Ruby",
+    "ms-vscode.test-adapter-converter",
+    "connorshea.vscode-ruby-test-adapter",
+    "misogi.ruby-rubocop",
+    "eamodio.gitlens",
+    "ms-vsliveshare.vsliveshare"
+  ],
+  
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'onCreateCommand' to run commands once the container is created.
+	"onCreateCommand": "bundle install",
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "chmod +x ./.devcontainer/postCreateCommands.sh && ./.devcontainer/postCreateCommands.sh"
+
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  // "remoteUser": "vscode"
+}

data/.devcontainer/postCreateCommands.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+echo ===================================================
+git --version
+
+echo gem $(gem --version)
+ruby -v
+rails -v
+
+bundle -v
+rake -V
+rspec -v
+echo ===================================================

data/.github/workflows/coverage.yml

@@ -0,0 +1,99 @@
+name: Coverage
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+    types:
+      - ready_for_review
+      - auto_merge_enabled
+
+jobs:
+  test-base:
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+    # Docker Hub image that `container-job` executes in
+    container: workcompass/wc-rails-ci:1.1.0
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run rspec test base
+        env:
+          RAILS_ENV: test
+          SIMPLECOV: true
+        run: bundle exec rspec spec/wc/essentials_spec.rb
+
+      - name: Upload to AWS
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.COVERAGE_AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.COVERAGE_AWS_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: eu-west-1
+        run: |
+          aws s3 cp coverage/.resultset.json s3://wc-cov-codeclimate/${{ github.repository }}/${{ github.ref }}/codeclimate.base.json
+
+  test-essentials:
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+    # Docker Hub image that `container-job` executes in
+    container: workcompass/wc-rails-ci:1.1.0
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run rspec test base
+        env:
+          RAILS_ENV: test
+          SIMPLECOV: true
+        run: bundle exec rspec spec/wc/essentials/
+
+      - name: Upload to AWS
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.COVERAGE_AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.COVERAGE_AWS_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: eu-west-1
+        run: |
+          aws s3 cp coverage/.resultset.json s3://wc-cov-codeclimate/${{ github.repository }}/${{ github.ref }}/codeclimate.essentials.json
+
+  codeclimate-coverage:
+    needs:
+      - test-base
+      - test-essentials
+
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+    # Docker Hub image that `container-job` executes in
+    container: workcompass/wc-rails-ci:1.1.0
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Download coverage reports
+        shell: bash
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.COVERAGE_AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.COVERAGE_AWS_SECRET_ACCESS_KEY }}
+          AWS_DEFAULT_REGION: eu-west-1
+        run: /usr/local/bin/aws s3 cp s3://wc-cov-codeclimate/${{ github.repository }}/${{ github.ref }} cov/ --recursive
+
+      - name: Combine & Publish code coverage
+        uses: paambaati/codeclimate-action@v3.2.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageLocations: |
+            ${{ github.workspace }}/cov/codeclimate.*.json:simplecov

data/.github/workflows/publish-gem.yml

@@ -0,0 +1,25 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+    - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    # Downloads a copy of the code in your repository before running CI tests
+    - name: Check out repository code
+      uses: actions/checkout@v3
+
+    - name: Publish to RubyGems
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem

data/.github/workflows/test-base.yml

@@ -0,0 +1,34 @@
+name: Test Base
+
+on:
+  push:
+    branches:
+      - '*'         # matches every branch that doesn't contain a '/'
+      - '*/*'       # matches every branch containing a single '/'
+      - '**'        # matches every branch
+      - '!master'   # includes master
+    paths:
+      - 'lib/wc/essentials.rb'
+      - 'lib/wc/essentials/version.rb'
+      - 'spec/wc/essentials_spec.rb'
+
+jobs:
+  # Label of the container job
+  test-base:
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+    # Docker Hub image that `container-job` executes in
+    container: workcompass/wc-rails-ci:1.1.0
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run rspec test wc-essentials
+        run: >
+          bundle exec rspec
+          spec/wc/essentials_spec.rb

data/.github/workflows/test-essentials.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - '*'         # matches every branch that doesn't contain a '/'
+      - '*/*'       # matches every branch containing a single '/'
+      - '**'        # matches every branch
+      - '!master'   # includes master
+    paths:
+      - 'lib/wc/essentials/**/*'
+      - 'spec/wc/essentials/**/*'
+
+jobs:
+  # Label of the container job
+  test-essentials:
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+    # Docker Hub image that `container-job` executes in
+    container: workcompass/wc-rails-ci:1.1.0
+
+    steps:
+      # Downloads a copy of the code in your repository before running CI tests
+      - name: Check out repository code
+        uses: actions/checkout@v3
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run rspec test wc-essentials
+        run: >
+          bundle exec rspec
+          spec/wc/essentials/

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/dist/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Release
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Enabled: true
+  Max: 90
+  Exclude:
+  - bin/**/*
+  - spec/**/*
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  Exclude:
+  - spec/**/*
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+  - spec/**/*
+  - wc-essentials.gemspec
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 17
+
+Naming/VariableNumber:
+  Enabled: true
+  Exclude:
+  - spec/**/*
+
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+  - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/Lambda:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+# Use a trailing comma to keep diffs clean when elements are inserted or removed
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  Enabled: false

data/API.md

@@ -0,0 +1,50 @@
+# WC
+
+## CountTracker
+
+### Description
+Allows to track how many times an item is called.
+
+### Usage
+
+#### Sample
+```
+tracker = WC::CountTracker.new
+tracker.increase(key)
+tracker.count(key) # => 1
+```
+
+#### Chaining
+```
+tracker = WC::CountTracker.new
+tracker.increase(key).increase(key)
+tracker.count(key) # => 2
+```
+
+#### Get above
+```
+tracker = WC::CountTracker.new(
+  {
+    one: 1,
+    two: 2,
+    three: 3,
+    other_three: 3,
+  }
+)
+tracker.increase(key).increase(key)
+tracker.above(2) # => { three: 3, other_three: 3 }
+```
+
+#### Get above (keys)
+```
+tracker = WC::CountTracker.new(
+  {
+    one: 1,
+    two: 2,
+    three: 3,
+    other_three: 3,
+  }
+)
+tracker.increase(key).increase(key)
+tracker.above(2).keys # => [:three, :other_three]
+```

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-03-13
+
+### Added
+
+- Include `class_helpers`, `class_registers` & `count_tracker` from `cognito` project.
+- Convert any rails dependency to native ruby.
+
+[unreleased]: https://github.com/WorkCompass/wc-essentials/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/WorkCompass/wc-essentials/releases/tag/0.1.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/WorkCompass/wc-essentials" }
+
+# Specify your gem's dependencies in wc-work4ce.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    wc-essentials (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debase (0.2.4.1)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.17)
+    diff-lcs (1.5.0)
+    docile (1.3.5)
+    jaro_winkler (1.5.4)
+    json (2.6.2)
+    parallel (1.19.2)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+      json
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  debase (~> 0.2)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.81)
+  rubocop-rspec (~> 1.38)
+  ruby-debug-ide (~> 0.7)
+  simplecov (~> 0.17)
+  wc-essentials!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 WorkCompass
+
+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,20 @@
+# WC::Essentials
+
+Gem to provide essential and commonly used helpers to all WorkCompass projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wc-essentials'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wc-essentials
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'wc/essentials'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wc/essentials/class_helpers.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module WC
+  module Essentials
+    # Helpers for classes
+    module ClassHelpers
+      # Get the class variable name
+      # @param    {class}   klass
+      # @param    {symbol}  name
+      # @returns  {string}
+      def self.klass_var_name(klass, name)
+        "@@#{
+          klass.name.split('::')
+            .join('_')
+            .downcase
+        }_#{name}"
+      end
+
+      # Assign class variable and also merge parent
+      # class variable.
+      # Usefull if required to have class variable
+      # only bind to the class in the case of inheritence
+      # @param    {class}   klass
+      # @param    {symbol}  name
+      # @param    {any}     value
+      def self.assign_class_variable(klass, name, value)
+        klass.ancestors.each do |ancestor|
+          value = concat_var(ancestor, name, value)
+        end
+
+        k_var_name = klass_var_name(klass, name)
+        klass.class_variable_set(k_var_name, value)
+      end
+
+      # Concat values from value provided
+      # with value assigned to the class variable
+      # @param    {class}   klass
+      # @param    {symbol}  name
+      # @param    {any}     value
+      # @returns  {any} The value merged
+      def self.concat_var(klass, name, value)
+        var_name = klass_var_name(klass, name)
+        existing = var_value(
+          klass,
+          var_name,
+          value.is_a?(Array) ? [] : {}
+        )
+
+        (value.is_a?(Array) ? (existing + value) : value.merge(existing))
+      end
+
+      # Return the value of class variable
+      # @param    {class}   klass
+      # @param    {symbol}  name
+      # @param    {any}     default
+      # @returns  {any}
+      #   - default value if nothing found
+      def self.var_value(klass, name, default = [])
+        return default unless defined?(klass.class_variable_get(name))
+
+        klass.class_variable_get(name)
+      rescue StandardError
+        default
+      end
+    end
+  end
+end

data/lib/wc/essentials/class_registers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative './class_helpers'
+
+module WC
+  module Essentials
+    # Helpers for registration
+    module ClassRegisters
+      extend self
+
+      ######################################
+      # Class Methods
+      ######################################
+
+      # Class variable getter
+      # @param    {symbol}    name
+      # @param    {any}       default
+      # @returns  {any}
+      def var(name, default = [])
+        var_name = WC::Essentials::ClassHelpers.klass_var_name(self, name)
+        class_variable_get(var_name)
+      rescue StandardError
+        default
+      end
+
+      # Register CSV fields and if required
+      # @param    {Hash}
+      def fields(fields = {})
+        WC::Essentials::ClassHelpers.assign_class_variable(self, :fields, fields)
+      end
+
+      # Register CSV fields that represent identities
+      # @param    {Hash}    identities    Key/value where value represent boolean allow duplication
+      def identities(identities = {})
+        WC::Essentials::ClassHelpers.assign_class_variable(self, :identities, identities)
+      end
+
+      # Register validators to be run for validation
+      # @params   {symbol}
+      def validators(*validators)
+        WC::Essentials::ClassHelpers.assign_class_variable(self, :validators, validators)
+      end
+
+      # Register collectors to be run once main
+      # validation. Registered collectors here
+      # will not run if halted early
+      # @params   {symbol}
+      def after_validation(*collectors)
+        WC::Essentials::ClassHelpers.assign_class_variable(self, :collectors, collectors)
+      end
+    end
+  end
+end

data/lib/wc/essentials/count_tracker.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module WC
+  module Essentials
+    # Tracker for number
+    # of a key
+    class CountTracker
+      def initialize(data = {})
+        @tracking = data
+      end
+
+      # Increase the count for the
+      # key provided
+      # @param    {any}   key
+      # @returns  self
+      def increase(key)
+        @tracking ||= {}
+
+        @tracking[key] = 0 unless @tracking.key?(key)
+        @tracking[key] += 1
+        self
+      end
+
+      # Return count for specified key
+      # @param    {any}   key
+      # @returns  {int}
+      def count(key)
+        return unless @tracking.key?(key)
+
+        @tracking[key]
+      end
+
+      # Return keys for
+      # item the number provider
+      # equivalent to greater than
+      # @param    {int}   min
+      # @returns  {hash}
+      def above(min)
+        @tracking.select { |_key, total| total > min }
+      end
+    end
+  end
+end

data/lib/wc/essentials/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WC
+  module Essentials
+    VERSION = '0.1.0'
+  end
+end

data/lib/wc/essentials.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'wc/essentials/version'
+require 'wc/essentials/class_helpers'
+require 'wc/essentials/class_registers'
+require 'wc/essentials/count_tracker'
+
+module WC
+  module Essentials
+    class << self
+      # Provide developer to setup
+      # def configure
+      #   yield self
+      # end
+    end
+  end
+end

data/wc-essentials.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wc/essentials/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wc-essentials'
+  spec.version       = WC::Essentials::VERSION
+  spec.authors       = ['WorkCompass Dev Team']
+  spec.email         = ['dev@workcompass.com']
+
+  spec.summary       = 'Reusable helpers for all WorkCompass web applications.'
+  spec.description   = 'Gem to provide essential and commonly used helpers to all WorkCompass projects.'
+  spec.homepage      = 'https://workcompass.com'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes
+  # either set the 'allowed_push_host' to allow pushing to a
+  # single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['homepage_uri'] = spec.homepage
+  #   spec.metadata['source_code_uri'] = 'https://github.com/WorkCompass/wc-essentials'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have
+  # been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dev dependencies
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # Quality control
+  spec.add_development_dependency 'rubocop', '~> 0.81'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.38'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+
+  # Debugger for IDE
+  spec.add_development_dependency 'debase', '~> 0.2'
+  spec.add_development_dependency 'ruby-debug-ide', '~> 0.7'
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: wc-essentials
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- WorkCompass Dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Gem to provide essential and commonly used helpers to all WorkCompass
+  projects.
+email:
+- dev@workcompass.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/postCreateCommands.sh"
+- ".github/workflows/coverage.yml"
+- ".github/workflows/publish-gem.yml"
+- ".github/workflows/test-base.yml"
+- ".github/workflows/test-essentials.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- API.md
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wc/essentials.rb
+- lib/wc/essentials/class_helpers.rb
+- lib/wc/essentials/class_registers.rb
+- lib/wc/essentials/count_tracker.rb
+- lib/wc/essentials/version.rb
+- wc-essentials.gemspec
+homepage: https://workcompass.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Reusable helpers for all WorkCompass web applications.
+test_files: []