variant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5730da4f5a0da8d3054369aeb2ce625008a8b2eb2edce3048b624c4bf2249e62
+  data.tar.gz: 0e2090643dff445a506ce733d5dd2bd517bbdf264cd97d43dcb552759efde140
+SHA512:
+  metadata.gz: a9b48ab48027324be95a91dbbd878a12e033f2737a179ebf80747b0b524b49cb8edd3760cdfc0f01d624ef7998d8f833ac11bf72c293447992835bb16a5fc3a0
+  data.tar.gz: 94bdf23c7aa5a3dd4cd6f0e390486c395fa3b229045700a40ba5c50f6d2383c77300e2173929e4cf285fe835c4eb07dcca2b228ea9f0fe4fe64f2346bfd7285b

data/.github/workflows/development.yml

@@ -0,0 +1,34 @@
+name: Development
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+        
+        include:
+          - os: 'ubuntu'
+            ruby: '2.6'
+            env: COVERAGE=PartialSummary,Coveralls
+    
+    runs-on: ${{matrix.os}}-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: ${{matrix.env}} bundle exec rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in variant.gemspec
+gemspec

data/README.md

@@ -0,0 +1,105 @@
+# Variant
+
+Provides a model for application variants, including documenting behaviour like `RACK_ENV` and `APP_ENV`.
+
+[![Development](https://github.com/socketry/variant/workflows/Development/badge.svg?branch=master)](https://github.com/socketry/variant/actions?workflow=Development)
+
+## Installation
+
+```
+bundle add variant
+```
+
+## Usage
+
+Variants are used to indicate the default configuration for an application. There are four suggested variants:
+
+| Variant     | Data                                | Usage                                  |
+|-------------|-------------------------------------|----------------------------------------|
+| Production  | Persistent, real data & interfaces. | Instance/cluster.                      |
+| Staging     | Duplicate/subset of production.     | Instance/cluster.                      |
+| Development | Fixtures, sample data.              | Local machine. **Default** variant.    |
+| Testing     | Fixtures, mocked interfaces.        | Local machine, continuous integration. |
+
+### Environment Variables
+
+The general mechanism for specifying a variant is on the command line before running the application:
+
+```
+VARIANT=production falcon serve
+```
+
+In your code, you access this like so:
+
+```ruby
+Variant.default # => :production
+Variant.for(:database) # => :production
+```
+
+### System-specific Variants
+
+You can specify system-specific variants. These are useful when you have e.g. 2 different database clusters, or you want to run a development instance connected to a production database.
+
+```
+VARIANT=production DATABASE_VARIANT=production-aws
+```
+
+In your code, you access this like so:
+
+```ruby
+Variant.default # => :production
+Variant.for(:database) # => :'production-aws'
+```
+
+If you don't specify a system-specific variant, it will be the same as the default variant.
+
+### Bake Integration
+
+This gem provides [bake](https://github.com/socketry/bake) recipes for setting the variants as outlined above.
+
+```
+bake variant:production ...
+bake variant:staging ...
+bake variant:development ...
+bake variant:testing ...
+```
+
+In addition, the tasks also support specifying overrides:
+
+```
+% bake variant:development database=production variant:show
+0.01s     info: Environment [pid=417910] [2020-02-29 11:43:25 +1300]
+							| {"VARIANT"=>"development", "DATABASE_VARIANT"=>"production"}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2020, by [Samuel G. D. Williams](https://www.codeotaku.com).
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bake/variant.rb

@@ -0,0 +1,42 @@
+
+require_relative '../lib/variant'
+
+# Select the production variant.
+# @param overrides [Hash] any specific variant overrides.
+def production(**overrides)
+	Variant.force!(:production, **overrides)
+end
+
+# Select the staging variant.
+# @param overrides [Hash] any specific variant overrides.
+def staging(**overrides)
+	Variant.force!(:staging, **overrides)
+end
+
+# Select the development variant.
+# @param overrides [Hash] any specific variant overrides.
+def development(**overrides)
+	Variant.force!(:development, **overrides)
+end
+
+# Select the testing variant.
+# @param overrides [Hash] any specific variant overrides.
+def testing(**overrides)
+	Variant.force!(:testing, **overrides)
+end
+
+# Force a specific variant.
+# @param name [Symbol] the default variant.
+# @param overrides [Hash] any specific variant overrides.
+def force(name, **overrides)
+	Variant.force!(name, **overrides)
+end
+
+# Show variant-related environment variables.
+def show
+	require 'console/logger'
+	
+	environment = ENV.select{|key, _| key.include?(Variant::KEY)}
+	
+	Console.logger.info("Environment", environment)
+end

data/lib/variant.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'variant/version'
+require_relative 'variant/environment'
+
+module Variant
+	KEY = 'VARIANT'
+	SUFFIX = '_VARIANT'
+	
+	# Force the process-level variant to be the specified value.
+	# 
+	# @reentrant Parallel modifications to `ENV` are undefined.
+	# 
+	# @example
+	# 	Variant.force!(:testing)
+	#
+	def self.force!(value, environment = ENV, **overrides)
+		# Clear any specific variants:
+		environment.delete_if{|key, value| key.end_with?(SUFFIX)}
+		
+		# Set the specified variant:
+		environment[KEY] = value.to_s
+		
+		overrides.each do |name, value|
+			key = name.upcase.to_s + SUFFIX
+			
+			environment[key] = value.to_s
+		end
+		
+		return environment
+	end
+	
+	def self.default
+		Environment.instance.default_variant
+	end
+	
+	def self.default= value
+		Environment.instance.default_variant= value
+	end
+	
+	def self.for(*arguments)
+		Environment.instance.variant_for(*arguments)
+	end
+end

data/lib/variant/environment.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'thread/local'
+
+module Variant
+	DEVELOPMENT = :development
+	PRODUCTION = :production
+	TESTING = :testing
+	STAGING = :staging
+	
+	class Environment
+		extend Thread::Local
+		
+		# It is not safe to modify ENV.
+		def initialize(overrides = {}, default: DEVELOPMENT)
+			@overrides = overrides
+		end
+		
+		attr :overrides
+		
+		def with(overrides)
+			old_overrides = @overrides
+			@overrides = overrides
+			
+			yield self
+		ensure
+			@overrides = old_overrides
+		end
+		
+		def to_hash
+			ENV.to_hash.update(@overrides)
+		end
+		
+		def fetch(key, *arguments, &block)
+			@overrides.fetch(key) do
+				ENV.fetch(key, *arguments, &block)
+			end
+		end
+		
+		def default_variant
+			self.fetch('VARIANT', DEVELOPMENT).to_sym
+		end
+		
+		def default_variant= name
+			@overrides['VARIANT'] = name
+		end
+		
+		def variant_for(name, default = nil)
+			self.fetch(variant_key(name)) do
+				self.fetch('VARIANT', default)
+			end&.to_sym
+		end
+		
+		def override_variant(name, value)
+			@overrides[variant_key(name)] = value
+		end
+		
+		def variant_key(name)
+			"#{name.upcase}_VARIANT"
+		end
+	end
+end

data/lib/variant/version.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Variant
+	VERSION = "0.1.0"
+end

data/variant.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'lib/variant/version'
+
+Gem::Specification.new do |spec|
+	spec.name = "variant"
+	spec.version = Variant::VERSION
+	spec.authors = ["Samuel Williams"]
+	spec.email = ["samuel.williams@oriontransfer.co.nz"]
+	
+	spec.summary = "A policy gem for selecting different environments."
+	spec.homepage = "https://github.com/socketry/variant"
+	spec.license = "MIT"
+	spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+	
+	# 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('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	end
+	
+	spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency "thread-local"
+	
+	spec.add_development_dependency "covered"
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rspec"
+	spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: variant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread-local
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/development.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bake/variant.rb
+- lib/variant.rb
+- lib/variant/environment.rb
+- lib/variant/version.rb
+- variant.gemspec
+homepage: https://github.com/socketry/variant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: A policy gem for selecting different environments.
+test_files: []