env-contract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46b38eb0da54bf37b977e0c51e22b5c6173b830cc8bdf7fa84aff5512c90c0f6
+  data.tar.gz: 500cc89553cd30513717f8c67ea3e0a4050028fc3d0f032b2854e13455358ba4
+SHA512:
+  metadata.gz: 2ac55fbc1957dc8aad824319ad41f7ad41af217ded3857acf05ce97e4181da3cc19082e9573bf306ff2ee5dfb379b65b2f3a6e50559f326c99db3dd8a9e29e80
+  data.tar.gz: cda4fe1b60dcd5263acb28096be359b7c0b8d350e0258204b26388738c4d54de75fc8ea3b7dd678d04bff256a53e543954eb0f4f6a1d3854f913292ddf88aac0

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler
+Gemfile.lock
+

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,26 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We pledge to make participation in our community a harassment-free experience for everyone.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment include:
+- Using welcoming and inclusive language
+- Respecting differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+
+Examples of unacceptable behavior include:
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+
+## Enforcement Responsibilities
+Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior.
+
+## Scope
+This Code of Conduct applies within all project spaces and in public spaces when representing the project.
+
+## Enforcement
+Instances of abusive behavior may be reported to the maintainer listed in the gemspec.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+## Development setup
+- Run `bundle install`
+- Run `bundle exec rspec`
+
+## Release
+1. Update `CHANGELOG.md`
+2. Bump version in `lib/**/version.rb`
+3. Run `bundle exec rake release`

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in env-contract.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 MounirGaiby
+
+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,58 @@
+# Env Contract
+
+Typed ENV contracts with validation and sample generation.
+
+## About
+Env Contract lets you define required and optional environment variables with types, defaults, and descriptions. It validates values at boot time and provides a `env-contract` CLI to generate `.env.sample` output.
+
+This is useful for services that need clear, enforceable configuration contracts and easy onboarding.
+
+## Use Cases
+- Enforce required configuration at boot time
+- Generate `.env.sample` files for onboarding and docs
+- Prevent misconfigurations in multi-env deployments
+
+## Compatibility
+- Ruby 3.0+
+
+## Installation
+```ruby
+# Gemfile
+
+gem "env-contract"
+```
+
+## Usage
+```ruby
+EnvContract.define do
+  required :DATABASE_URL, type: :string, desc: "Primary DB"
+  optional :REDIS_URL, type: :string
+  optional :RETRIES, type: :integer, default: 3
+end
+
+values = EnvContract.load!
+```
+
+## Types
+- `:string`
+- `:integer`
+- `:float`
+- `:boolean`
+- `:json`
+
+## CLI
+Generate `.env.sample`:
+```bash
+env-contract > .env.sample
+```
+
+## Rails
+```ruby
+# config/application.rb
+config.env_contract.validate_on_boot = true
+```
+
+## Release
+```bash
+bundle exec rake release
+```

data/Rakefile

@@ -0,0 +1,6 @@
+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 "env/contract"
+
+# 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/env-contract

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "env/contract"
+
+puts EnvContract.sample

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/env-contract.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "env/contract/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "env-contract"
+  spec.version = EnvContract::VERSION
+  spec.authors = ["MounirGaiby"]
+  spec.email = ["mounirgaiby@gmail.com"]
+
+  spec.summary = "Typed ENV contracts with validation and sample generation."
+  spec.description = "Define required/optional ENV variables with type casting and validation."
+  spec.homepage = "https://github.com/elysium-arc/env-contract"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/elysium-arc/env-contract"
+  spec.metadata["changelog_uri"] = "https://github.com/elysium-arc/env-contract/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+end

data/lib/env/contract/railtie.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# :nocov:
+begin
+  require "rails/railtie"
+rescue LoadError
+end
+
+if defined?(Rails::Railtie)
+  module EnvContract
+    class Railtie < Rails::Railtie
+      config.env_contract = ActiveSupport::OrderedOptions.new
+      config.env_contract.validate_on_boot = false
+
+      initializer "env_contract.validate" do |app|
+        if app.config.env_contract.validate_on_boot
+          EnvContract.load!
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/env/contract/version.rb

@@ -0,0 +1,7 @@
+module EnvContract
+  VERSION = "0.1.0"
+end
+
+module Env
+  Contract = EnvContract
+end

data/lib/env/contract.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "json"
+require "env/contract/version"
+
+module EnvContract
+  class Error < StandardError; end
+  class MissingVariable < Error; end
+  class InvalidType < Error; end
+
+  Entry = Struct.new(:name, :required, :type, :default, :desc, keyword_init: true)
+
+  def self.define(&block)
+    registry.instance_eval(&block)
+    registry
+  end
+
+  def self.registry
+    @registry ||= Registry.new
+  end
+
+  def self.reset!
+    @registry = Registry.new
+  end
+
+  def self.load!
+    registry.load!
+  end
+
+  def self.sample
+    registry.sample
+  end
+
+  class Registry
+    def initialize
+      @entries = []
+    end
+
+    def required(name, type: :string, default: nil, desc: nil)
+      add(name, required: true, type: type, default: default, desc: desc)
+    end
+
+    def optional(name, type: :string, default: nil, desc: nil)
+      add(name, required: false, type: type, default: default, desc: desc)
+    end
+
+    def load!
+      values = {}
+      @entries.each do |entry|
+        raw = ENV[entry.name]
+        if raw.nil? || raw == ""
+          if entry.required && entry.default.nil?
+            raise MissingVariable, "Missing ENV #{entry.name}"
+          end
+          raw = entry.default
+        end
+        values[entry.name] = cast(raw, entry.type)
+      end
+      values
+    end
+
+    def sample
+      lines = []
+      @entries.each do |entry|
+        lines << "# #{entry.desc}" if entry.desc
+        value = entry.default.nil? ? "" : entry.default
+        lines << "#{entry.name}=#{value}"
+      end
+      lines.join("
+") + "
+"
+    end
+
+    private
+
+    def add(name, required:, type:, default:, desc:)
+      @entries << Entry.new(name: name.to_s, required: required, type: type, default: default, desc: desc)
+    end
+
+    def cast(value, type)
+      return nil if value.nil?
+      case type
+      when :string
+        value.to_s
+      when :integer
+        Integer(value)
+      when :float
+        Float(value)
+      when :boolean
+        return true if value == true || value.to_s.downcase == "true"
+        return false if value == false || value.to_s.downcase == "false"
+        raise InvalidType, "Invalid boolean #{value}"
+      when :json
+        JSON.parse(value.to_s)
+      else
+        raise InvalidType, "Unknown type #{type}"
+      end
+    rescue ArgumentError, TypeError
+      raise InvalidType, "Invalid #{type} #{value}"
+    end
+  end
+end
+
+require "env/contract/railtie"

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: env-contract
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MounirGaiby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-03 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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Define required/optional ENV variables with type casting and validation.
+email:
+- mounirgaiby@gmail.com
+executables:
+- console
+- env-contract
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/env-contract
+- bin/setup
+- env-contract.gemspec
+- lib/env/contract.rb
+- lib/env/contract/railtie.rb
+- lib/env/contract/version.rb
+homepage: https://github.com/elysium-arc/env-contract
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elysium-arc/env-contract
+  source_code_uri: https://github.com/elysium-arc/env-contract
+  changelog_uri: https://github.com/elysium-arc/env-contract/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Typed ENV contracts with validation and sample generation.
+test_files: []