yaml-env-tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 320980f6b147ebb155338595cf94876182b2e60b
+  data.tar.gz: d5047c9c8494a2cb074eb7337bfc0f287877b8ec
+SHA512:
+  metadata.gz: c06d3fa7961c410439a962065700acc68abfb404d7de3f57fb12b3def14d9d97bfa1235082ca576268da923adbe9caa19dc611a22eb67f2049aa64e63d7c3d33
+  data.tar.gz: 7ba5b9c211012b6831acb90a7699e311a5aa014709f504217f24918708280eb20f601da1d451b9dccd19383ba26f4b5d2057fcf2c887ada46b209ce395381bfa

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright 2017 Jakub Jirutka <jakub@jirutka.cz>.
+
+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.adoc

@@ -0,0 +1,49 @@
+= YAML !ENV tag
+Jakub Jirutka <https://github.com/jirutka>
+// custom
+:gem-name: yaml-env-tag
+:gh-name: jirutka/{gem-name}
+:gh-branch: master
+:codacy-id: d1b32c16409c46a0b81882a679713a67
+
+ifdef::env-github[]
+image:https://travis-ci.org/{gh-name}.svg?branch={gh-branch}[Build Status, link="https://travis-ci.org/{gh-name}"]
+image:https://api.codacy.com/project/badge/Coverage/{codacy-id}["Test Coverage", link="https://www.codacy.com/app/{gh-name}"]
+image:https://api.codacy.com/project/badge/Grade/{codacy-id}["Codacy Code quality", link="https://www.codacy.com/app/{gh-name}"]
+image:https://img.shields.io/gem/v/{gem-name}.svg?style=flat[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+endif::env-github[]
+
+A custom YAML tag for referring environment variables in YAML files.
+No need to use ERB in YAML just to set some keys from environment variables.
+
+[source, yaml]
+.*Sample YAML file using ENV! tag*
+oauth:
+  client_id: ENV! API_CLIENT_ID
+  client_secret: ENV! API_CLIENT_SECRET
+
+
+== Usage
+
+Just require `{gem-name}` and load YAML as you’re used to:
+
+[source, rb, subs="+attributes"]
+----
+require '{gem-name}'
+
+yaml = YAML.load('secret: ENV! API_CLIENT_SECRET')
+yaml['secret']  # => "top-secret"
+----
+
+However, if you use `YAML.safe_load` (which is highly recommended), you need to explicitly whitelist `YamlEnvTag::EnvVariable`:
+
+[source, rb]
+YAML.safe_load(..., [YamlEnvTag::EnvVariable])
+
+If the specified environment variable does not exist (i.e. is not set), `YAML` will raise exception `YamlEnvTag::MissingEnvVariableError` when loading the file.
+
+
+== License
+
+This project is licensed under http://opensource.org/licenses/MIT/[MIT License].
+For the full text of the license, see the link:LICENSE[LICENSE] file.

data/lib/yaml-env-tag.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'yaml_env_tag'

data/lib/yaml_env_tag.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'yaml_env_tag/version'
+require 'yaml_env_tag/errors'
+require 'yaml_env_tag/env_variable'
+require 'yaml'
+
+YAML.add_tag '!ENV', YamlEnvTag::EnvVariable

data/lib/yaml_env_tag/env_variable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'yaml_env_tag/errors'
+
+module YamlEnvTag
+  # A specialized String that holds a value of environment variable specified
+  # by +!ENV+ tag.
+  class EnvVariable < String
+
+    # Deserializes from YAML. This method is called by {Psych}.
+    #
+    # @param coder [Psych::Coder, #scalar] coder with name of the environment
+    #   variable to read.
+    # @raise MissingEnvVariableError if the specified environment variable
+    #   is not set (i.e. does not exist in +ENV+).
+    def init_with(coder)
+      var_name = coder.scalar
+      value = ::ENV[var_name] or raise MissingEnvVariableError, var_name
+      initialize(value)
+    end
+  end
+end

data/lib/yaml_env_tag/errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module YamlEnvTag
+  # An error class raised when environment variable specified by the `!ENV` tag
+  # is not set.
+  class MissingEnvVariableError < ::RuntimeError
+
+    attr_reader :variable_name
+
+    # @param variable_name [String] name of the environment variable.
+    def initialize(variable_name)
+      @variable_name = variable_name
+      super("Environment variable '#{variable_name}' is not set")
+    end
+  end
+end

data/lib/yaml_env_tag/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module YamlEnvTag
+  VERSION = '0.1.0'.freeze
+end

data/yaml-env-tag.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/yaml_env_tag/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'yaml-env-tag'
+  s.version       = YamlEnvTag::VERSION
+  s.author        = 'Jakub Jirutka'
+  s.email         = 'jakub@jirutka.cz'
+  s.homepage      = 'https://github.com/jirutka/yaml-env-tag'
+  s.license       = 'MIT'
+
+  s.summary       = 'Custom YAML tag for referring environment variables in YAML files'
+
+  s.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rubocop', '~> 0.49.0'
+  s.add_development_dependency 'simplecov', '~> 0.14'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: yaml-env-tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Jirutka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: 
+email: jakub@jirutka.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- lib/yaml-env-tag.rb
+- lib/yaml_env_tag.rb
+- lib/yaml_env_tag/env_variable.rb
+- lib/yaml_env_tag/errors.rb
+- lib/yaml_env_tag/version.rb
+- yaml-env-tag.gemspec
+homepage: https://github.com/jirutka/yaml-env-tag
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Custom YAML tag for referring environment variables in YAML files
+test_files: []