permafrost 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5e77f1ee7a485341f34349efe763a02b8242280fce028c06c3077c555efa232
+  data.tar.gz: 75646176f44aeed279f9055e88772ce5b0c6c64549dd66e0395efc56271200de
+SHA512:
+  metadata.gz: 45e9a7be245204163bc87dd76f8894fd418f62a70a8d73cba5f2387f49eb20da033e515fd5cee7102b495d3dd8b7ed05c1ae85b2a133eb784a104f1b5b862bfa
+  data.tar.gz: ae2761008088dc7be3db21b2ed1d660d6924a8faf52bf1fd59eff9c69a90cdfada7bfbdbc94494c9873d5b2aeafbfe23ce1311ffb116f77d15e56f744251f006

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,98 @@
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7.1
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+    - have_
+
+# `described_class` makes tests harder to read. When using tools that allow
+# jumping between definitions and the respective tests in a Rails project, or
+# using global search, the class `described_class` refers to might not be clear
+# to the reader. By avoiding the shortcut, we make sure the test stands on its
+# own with as much information as possible.
+RSpec/DescribedClass:
+  Enabled: false
+
+# Examples should be informative and explicit. While longer examples are
+# generally hard to read, the value should be adjusted as reasonable for a
+# project.
+RSpec/ExampleLength:
+  Max: 10
+
+# Examples should focus on testing one thing, but that does not necessarily
+# translate into a single expectation. For instance, testing validations in
+# a Rails model should assert (1) the model is invalid, (2) the model has
+# validation errors, and (3) these errors not only include the target field
+# but also the target error message. Another example would be testing
+# side-effects are contained.
+#
+# Similarly, not limiting the number of expectations in an example invites
+# colaborators (and consequently reviewers) to forget the rule of testing one
+# thing only, or to simply ignore it due over the "simplicity" and comfort of
+# checking for everything in a single test.
+#
+# Therefore, this cop should remain enabled, but its value should be adjusted 
+# as reasonable for the project.
+#
+RSpec/MultipleExpectations:
+  Max: 3
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog], and this project adheres to
+[Semantic Versioning].
+
+
+Unreleased
+----------
+
+- Add `Permafrost.merge` to complement the environment in a limited scope;
+- Add `Permafrost.freeze` to set the environment in a limited scope;
+
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
+

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in permafrost.gemspec
+gemspec
+
+gem "pry", "~> 0.13.1"
+gem "rake", "~> 12.0"
+
+group :test do
+  gem "faker", "~> 2.12"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 0.85.0"
+  gem "rubocop-performance", "~> 1.6"
+  gem "rubocop-rspec", "~> 1.39"
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    permafrost (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    faker (2.12.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.12)
+  permafrost!
+  pry (~> 0.13.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.85.0)
+  rubocop-performance (~> 1.6)
+  rubocop-rspec (~> 1.39)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Subvisual, Lda
+
+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,110 @@
+Permafrost
+==========
+
+Freeze the environment (i.e. `ENV`) in a limited scope.
+
+Inspired by [Timecop].
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "permafrost"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install permafrost
+
+
+Usage
+-----
+
+Freeze the environment, and change it at will inside a sandbox:
+
+```ruby
+ENV # { "RAILS_ENV" => "production", ... }
+
+Permafrost.freeze do
+  ENV.clear # {}
+end
+
+ENV # { "RAILS_ENV" => "production", ... }
+```
+
+Or, set the environment to use inside the sandbox:
+
+```ruby
+ENV # { "RAILS_ENV" => "production", ... }
+
+Permafrost.freeze("foo" => "bar") do
+  ENV # { "foo" => "bar" }
+end
+
+ENV # { "RAILS_ENV" => "production", ... }
+```
+
+You can also just change something in the environment, leaving the rest as it
+is:
+
+```ruby
+ENV # { "RAILS_ENV" => "production", ... }
+
+Permafrost.merge("foo" => "bar") do
+  ENV # { "RAILS_ENV" => "production", ..., "foo" => "bar" }
+end
+
+ENV # { "RAILS_ENV" => "production", ... }
+```
+
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake` to run the linter and tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to [rubygems.org].
+
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/subvisual/permafrost.
+
+
+License
+-----
+
+Permafrost is copyright © 2020 Subvisual, Lda.
+
+It is open-source, made available for free, and is subject to the terms in
+its [license].
+
+
+About
+-----
+
+Permafrost was created and is maintained with :heart: by
+[Subvisual][subvisual].
+
+[![Subvisual][subvisual-logo]][subvisual]
+
+
+[Timecop]: https://github.com/travisjeffery/timecop
+[license]: ./LICENSE.txt
+[rubygems.org]: https://rubygems.org
+[subvisual]: http://subvisual.com
+[subvisual-logo]: https://raw.githubusercontent.com/subvisual/guides/master/github/templates/logos/blue.png

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
+
+task default: %i[lint spec]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "permafrost"
+require "pry"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# Exit if any command fails
+set -e
+
+# Install required languages
+asdf install
+asdf reshim
+
+# Install Ruby dependencies
+bundle install
+asdf reshim ruby

data/lib/permafrost.rb

@@ -0,0 +1,57 @@
+require "English"
+require "permafrost/version"
+
+module Permafrost
+  module ClassMethods
+    def freeze(env = nil, &block) # rubocop:disable Metrics/MethodLength
+      reader, writer = IO.pipe
+      pid = Process.fork
+
+      if pid.nil?
+        reader.close
+
+        freeze_child(writer, env, &block)
+      else
+        writer.close
+
+        freeze_parent(reader, pid)
+      end
+    ensure
+      reader.close
+      writer.close
+    end
+
+    def merge(env, &block)
+      freeze_env = ENV.to_h.merge(env)
+
+      freeze(freeze_env, &block)
+    end
+
+    private
+
+    def freeze_child(write, env)
+      ENV.replace(env) unless env.nil?
+
+      yield
+
+      Process.exit!(true)
+    rescue StandardError => e
+      Marshal.dump(e, write)
+
+      Process.exit!(false)
+    end
+
+    def freeze_parent(_reader, child_pid)
+      Process.wait(child_pid)
+
+      return if $CHILD_STATUS.exitstatus.zero?
+
+      error_data = read.read
+      error = Marshal.load(error_data) # rubocop:disable Security/MarshalLoad
+
+      raise error
+    end
+  end
+
+  extend ClassMethods
+end

data/lib/permafrost/version.rb

@@ -0,0 +1,3 @@
+module Permafrost
+  VERSION = "1.0.0".freeze
+end

data/permafrost.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/permafrost/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "permafrost"
+  spec.version       = Permafrost::VERSION
+  spec.authors       = ["Pedro Costa"]
+  spec.email         = ["pedro@subvisual.com"]
+
+  spec.summary       = "Freeze the environment in a given state."
+  spec.description   = <<~DESCRIPTION
+    Environment variables are a standard way for configuring applications in
+    production. It allows for quickly changing the configuration, and avoids
+    having to introduce secrets in the code.
+
+    When testing code that relies on environment variables, it becomes
+    problematic to mock the environment, and even more to clean up afterwards.
+
+    Permafrost allows you to define a limited scope where the environment is
+    set as you decide, returning it to its original state afterwards.
+  DESCRIPTION
+  spec.homepage = "https://github.com/subvisual/permafrost"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/subvisual/permafrost"
+  spec.metadata["changelog_uri"] = "https://github.com/subvisual/permafrost/blob/master/CHANGELOG.md"
+
+  # 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 { |f| f.start_with?("spec") }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: permafrost
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pedro Costa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-03 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Environment variables are a standard way for configuring applications in
+  production. It allows for quickly changing the configuration, and avoids
+  having to introduce secrets in the code.
+
+  When testing code that relies on environment variables, it becomes
+  problematic to mock the environment, and even more to clean up afterwards.
+
+  Permafrost allows you to define a limited scope where the environment is
+  set as you decide, returning it to its original state afterwards.
+email:
+- pedro@subvisual.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/permafrost.rb
+- lib/permafrost/version.rb
+- permafrost.gemspec
+homepage: https://github.com/subvisual/permafrost
+licenses: []
+metadata:
+  homepage_uri: https://github.com/subvisual/permafrost
+  source_code_uri: https://github.com/subvisual/permafrost
+  changelog_uri: https://github.com/subvisual/permafrost/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Freeze the environment in a given state.
+test_files: []