global 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d82e24b3a7c94f65e370d1b16142e028d3acf1ce3fe8064e9e9fcb9e4683d46e
-  data.tar.gz: 809e1b6ac4e2f0ada443202b1d80ec7d663488515f682079cd07bc02335983c4
+  metadata.gz: 0da470ddbf97c73984898898bbada287d1fef733da1059016dbe7021a6b4e55a
+  data.tar.gz: b5cf15fb7e5a9e4e9cb7b30a0bf1265a374693d6f1423b95940976c9beeca3f0
 SHA512:
-  metadata.gz: b290b4951da9d199d64ec8a27bdf630be5691ec1af0829d31e01872c1260893e2a3626fcc55a70f9ac816192279fbf04a4a2823dd770127808bd63b62ad8016d
-  data.tar.gz: afa4586a51919a0d483dbcd01e5fd027cd6a79aebaea070c544c53f4838ccbbece9312536d40ed475adf1cc207ef7864937639baa60de7bab1918de3a081944a
+  metadata.gz: cbd030fd6ced5e6e3f0d47d75d14f59e16a69411814b1432f0bf66fb03444950006a87b86eed155f758c4a5535eb6e8d9d870edbecdc26c9a66b2a9230384e82
+  data.tar.gz: b99c7b6c92c33324834ad7fd92c75606a9abddbe7d8fe0fbe22b344013000a49073ece171b8063713b370d2c6526c6c0eee928584c90317e5592034506bc3790

data/.github/workflows/tests.yml

@@ -0,0 +1,24 @@
+name: Runs linter and tests
+
+on: [push, pull_request]
+
+jobs:
+  linters_and_tests:
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ matrix.experimental == true }}
+    name: Linter and tests on ${{ matrix.os }}-ruby-${{ matrix.ruby-version }}
+    strategy:
+      matrix:
+        os: [ubuntu, macos]
+        ruby-version: ['3.1', '3.0', '2.7', '2.6', '2.5']
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Runs linter and tests
+      run: bundle exec rake

data/README.md

@@ -1,4 +1,4 @@
-# Global [![Build Status](https://travis-ci.org/railsware/global.png)](https://travis-ci.org/railsware/global) [![Code Climate](https://codeclimate.com/github/railsware/global.png)](https://codeclimate.com/github/railsware/global)
+# Global [![Runs linter and tests](https://github.com/railsware/global/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/railsware/global/actions/workflows/tests.yml) [![Code Climate](https://codeclimate.com/github/railsware/global.png)](https://codeclimate.com/github/railsware/global)
 
 The 'global' gem provides accessor methods for your configuration data and share configuration across backend and frontend.
 
@@ -19,14 +19,14 @@ Refer to the documentation on your chosen backend class for other dependencies.
 Refer to the documentation on your chosen backend class for configuration options.
 
 ```ruby
-> Global.backend(:filesystem, environment: "YOUR_ENV_HERE", directory: "PATH_TO_DIRECTORY_WITH_FILES")
+> Global.backend(:filesystem, environment: "YOUR_ENV_HERE", path: "PATH_TO_DIRECTORY_WITH_FILES")
 ```
 
 Or you can use `configure` block:
 
 ```ruby
 Global.configure do |config|
-  config.backend :filesystem, environment: "YOUR_ENV_HERE", directory: "PATH_TO_DIRECTORY_WITH_FILES"
+  config.backend :filesystem, environment: "YOUR_ENV_HERE", path: "PATH_TO_DIRECTORY_WITH_FILES"
   # set up multiple backends and have them merged together:
   config.backend :aws_parameter_store, prefix: '/prod/MyApp/'
   config.backend :gcp_secret_manager, prefix: 'prod-myapp-', project_id: 'example'
@@ -252,6 +252,12 @@ Some steps you will need to follow:
 - If you will use encrypted parameters: create a KMS key and allow the role to decrypt using the key.
 - Create parameters in Parameter Store. Use encryption for sensitive data like private keys and API credentials.
 
+#### Usage with Go
+
+You can reuse the same configuration in your Go services. For this, we developed a Go module that loads the same configuration tree into Go structs.
+
+See [github.com/railsware/go-global](https://github.com/railsware/go-global) for further instructions.
+
 #### Configuration examples
 
 Backend setup:

data/lib/global/backend/filesystem.rb

@@ -5,12 +5,12 @@ module Global
     # Loads Global configuration from the filesystem
     #
     # Available options:
-    # - `directory` (required): the directory with config files
+    # - `path` (required): the directory with config files
     # - `environment` (required): the environment to load
     # - `yaml_whitelist_classes`: the set of classes that are permitted to unmarshal from the configuration files
     #
     # For Rails:
-    # - the `directory` is optional and defaults to `config/global`
+    # - the `path` is optional and defaults to `config/global`
     # - the `environment` is optional and defaults to the current Rails environment
     class Filesystem
 
@@ -60,11 +60,14 @@ module Global
       end
 
       def load_yml_file(file)
-        YAML.safe_load(
-          ERB.new(IO.read(file)).result,
-          [Date, Time, DateTime, Symbol].concat(@yaml_whitelist_classes),
-          [], true
-        )
+        file_contents = ERB.new(IO.read(file)).result
+        permitted_classes = [Date, Time, DateTime, Symbol].concat(@yaml_whitelist_classes)
+
+        if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('4')
+          YAML.safe_load(file_contents, permitted_classes: permitted_classes, aliases: true)
+        else
+          YAML.safe_load(file_contents, permitted_classes, [], true)
+        end
       end
 
       def load_from_directory(path)

data/lib/global/base.rb

@@ -34,7 +34,7 @@ module Global
     # and the configuration hashes will be merged.
     #
     # Configure with either:
-    #   Global.backend :filesystem, directory: 'config', environment: Rails.env
+    #   Global.backend :filesystem, path: 'config', environment: Rails.env
     # or:
     #   Global.backend YourConfigurationBackend.new
     #

data/lib/global/configuration.rb

@@ -45,7 +45,7 @@ module Global
 
     def respond_to_missing?(method_name, include_private = false)
       method = normalize_key_by_method(method_name)
-      key?(method) || super
+      key?(method) || boolean_method?(method) || super
     end
 
     def method_missing(method, *args, &block)
@@ -57,8 +57,12 @@ module Global
       end
     end
 
+    def boolean_method?(method)
+      '?' == method.to_s[-1]
+    end
+
     def normalize_key_by_method(method)
-      '?' == method.to_s[-1] ? method.to_s[0..-2] : method
+      boolean_method?(method) ? method.to_s[0..-2].to_sym : method
     end
 
   end

data/lib/global/version.rb

@@ -2,6 +2,6 @@
 
 module Global
 
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 
 end

data/spec/global/configuration_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Global::Configuration do
-  let(:hash) { { 'key' => 'value', 'nested' => { 'key' => 'value' }} }
+  let(:hash) { { 'key' => 'value', 'boolean_key' => true, 'nested' => { 'key' => 'value' }} }
   let(:configuration) { described_class.new hash }
 
   describe '#hash' do
@@ -68,7 +68,7 @@ RSpec.describe Global::Configuration do
     context 'when include all' do
       let(:filter_options) { { only: :all } }
 
-      it { should == { 'key' => 'value', 'nested' => { 'key' => 'value' }} }
+      it { should == { 'key' => 'value', 'boolean_key' => true, 'nested' => { 'key' => 'value' }} }
     end
 
     context 'when except all' do
@@ -80,7 +80,7 @@ RSpec.describe Global::Configuration do
     context 'when except present' do
       let(:filter_options) { { except: %w[key] } }
 
-      it { should == { 'nested' => { 'key' => 'value' }} }
+      it { should == { 'boolean_key' => true, 'nested' => { 'key' => 'value' }} }
     end
 
     context 'when include present' do
@@ -97,18 +97,30 @@ RSpec.describe Global::Configuration do
   end
 
   describe '#method_missing' do
-    context 'when key exist' do
+    context 'when key exists' do
       subject { configuration.key }
 
       it { is_expected.to eq('value') }
     end
 
+    context 'when boolean key exists' do
+      subject { configuration.boolean_key? }
+
+      it { is_expected.to eq(true) }
+    end
+
     context 'when key does not exist' do
       subject { configuration.some_key }
 
       it { expect { subject }.to raise_error(NoMethodError) }
     end
 
+    context 'when boolean key does not exist' do
+      subject { configuration.some_boolean_key? }
+
+      it { expect { subject }.to raise_error(NoMethodError) }
+    end
+
     context 'with nested hash' do
       subject { configuration.nested.key }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Railsware LLC
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ssm
@@ -115,11 +115,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -150,7 +150,7 @@ homepage: https://github.com/railsware/global
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Simple way to load your configs from yaml/aws/gcp
 test_files:

data/.travis.yml

@@ -1,22 +0,0 @@
-language: ruby
-os: linux
-dist: bionic
-
-cache:
-  bundler: true
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - ruby-head
-  - jruby-head
-
-notifications:
-  email: false
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head