RubyGems - legion-settings - Versions diffs - 1.1.3 → 1.2.0 - Mend

legion-settings 1.1.3 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

checksums.yaml +4 -4
data/.github/workflows/sourcehawk-scan.yml +20 -0
data/.gitignore +5 -4
data/.rubocop.yml +4 -1
data/CHANGELOG.md +2 -7
data/CODE_OF_CONDUCT.md +75 -0
data/CONTRIBUTING.md +55 -0
data/Gemfile +8 -0
data/INDIVIDUAL_CONTRIBUTOR_LICENSE.md +30 -0
data/LICENSE +201 -0
data/NOTICE.txt +9 -0
data/README.md +23 -36
data/SECURITY.md +9 -0
data/attribution.txt +1 -0
data/legion-settings.gemspec +22 -22
data/lib/legion/settings.rb +11 -2
data/lib/legion/settings/loader.rb +3 -0
data/lib/legion/settings/os.rb +34 -0
data/lib/legion/settings/version.rb +1 -1
data/sourcehawk.yml +4 -0
metadata +36 -122
data/.circleci/config.yml +0 -105
data/Gemfile.lock +0 -78
data/LICENSE.txt +0 -21
data/Rakefile +0 -6
data/bitbucket-pipelines.yml +0 -17
data/lib/legion/settings/constants.rb +0 -5
data/lib/legion/settings/rules.rb +0 -92
data/lib/legion/settings/validator.rb +0 -63
data/lib/legion/settings/validators.rb +0 -9

data/NOTICE.txt ADDED Viewed

@@ -0,0 +1,9 @@
+Legion::Settings(legion-settings)
+Copyright 2021 Optum
+Project Description:
+====================
+A gem written to handle LegionIO Settings in a consistent way across extensions
+Author(s):
+Esity

data/README.md CHANGED Viewed

@@ -1,49 +1,36 @@
-# Legion::Settings
+Legion::Settings
+=====
-Legion::Settings is part of the Legion Framework
+Legion::Settings is a hash like class used to store LegionIO Settings.
-###Badges
-####CICD
-|         | License | CircleCI | CodeCov | CodeBeat |
-|---------|---------|----------|---------|----------|
-| Master  |[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)|[![CircleCI](https://circleci.com/bb/legion-io/legion-settings/tree/master.svg?style=svg)](https://circleci.com/bb/legion-io/legion-settings/tree/master)|[![codecov](https://codecov.io/bb/legion-io/legion-settings/branch/master/graph/badge.svg)](https://codecov.io/bb/legion-io/legion-settings)|[![codebeat badge](https://codebeat.co/badges/e86dbe3e-b463-4f3c-91a8-c85492fd3833)](https://codebeat.co/projects/bitbucket-org-legion-io-legion-settings-master)|
-| Develop |[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)|[![CircleCI](https://circleci.com/bb/legion-io/legion-settings/tree/develop.svg?style=svg)](https://circleci.com/bb/legion-io/legion-settings/tree/develop)|[![codecov](https://codecov.io/bb/legion-io/legion-settings/branch/develop/graph/badge.svg)](https://codecov.io/bb/legion-io/legion-settings)|[![codebeat badge](https://codebeat.co/badges/e86dbe3e-b463-4f3c-91a8-c85492fd3833)](https://codebeat.co/projects/bitbucket-org-legion-io-legion-settings-develop)|
+Supported Ruby versions and implementations
+------------------------------------------------
-#####RubyGems
-![](https://ruby-gem-downloads-badge.herokuapp.com/legion-settings)
-[![Gem Version](https://badge.fury.io/rb/legion-settings.svg)](https://badge.fury.io/rb/legion-settings)
+Legion::Json should work identically on:
-#####Bitbucket
-![](https://img.shields.io/bitbucket/issues-raw/legion-io/legion-settings.svg)
-![](https://img.shields.io/bitbucket/pr-raw/legion-io/legion-settings.svg)
-## Installation
+* JRuby 9.2+
+* Ruby 2.4+
-Add this line to your application's Gemfile:
-```ruby
-gem 'legion-settings'
-```
-And then execute:
-    $ bundle
-Or install it yourself as:
+Installation and Usage
+------------------------
-    $ gem install legion-settings
+You can verify your installation using this piece of code:
-## Usage
-This library is utilized by Legion to load config files
-## Gem
+```bash
+gem install legion-json
+```
-This gem can be viewed and download from [RubyGems - Legion-Settings](https://rubygems.org/gems/legion-settings)
+```ruby
+require 'legion-settings'
+Legion::Settings.load(config_dir: './') # will automatically load json files it has access to inside this dir
-## Contributing
+Legion::Settings[:client][:hostname]
+Legion::Settings[:client][:new_attribute] = 'foobar'
-Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/legion-io/legion-settings/issues This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```
-## License
+Authors
+----------
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+* [Matthew Iverson](https://github.com/Esity) - current maintainer

data/SECURITY.md ADDED Viewed

@@ -0,0 +1,9 @@
+# Security Policy
+## Supported Versions
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+## Reporting a Vulnerability
+To be added

data/attribution.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ Add attributions here.

data/legion-settings.gemspec CHANGED Viewed

@@ -1,30 +1,30 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'legion/settings/version'
+# frozen_string_literal: true
+require_relative 'lib/legion/settings/version'
 Gem::Specification.new do |spec|
-  spec.name          = 'legion-settings'
+  spec.name = 'legion-settings'
   spec.version       = Legion::Settings::VERSION
   spec.authors       = ['Esity']
-  spec.email         = ['matthewdiverson@gmail.com']
-  spec.summary       = 'Used to load the json settings files'
-  spec.description   = "Based on Sensu's implementation of settings"
-  spec.homepage      = 'https://bitbucket.org/whonodes/legion-settings'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.email         = %w[matthewdiverson@gmail.com ruby@optum.com]
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.summary       = 'Legion::Settings'
+  spec.description   = 'A gem written to handle LegionIO Settings in a consistent way across extensions'
+  spec.homepage      = 'https://github.com/Optum/legion-settings'
+  spec.license       = 'Apache-2.0'
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4'
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files        = spec.files.select { |p| p =~ %r{^test/.*_test.rb} }
+  spec.extra_rdoc_files  = %w[README.md LICENSE CHANGELOG.md]
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/Optum/legion-settings/issues',
+    'changelog_uri' => 'https://github.com/Optum/legion-settings/src/main/CHANGELOG.md',
+    'documentation_uri' => 'https://github.com/Optum/legion-settings',
+    'homepage_uri' => 'https://github.com/Optum/LegionIO',
+    'source_code_uri' => 'https://github.com/Optum/legion-settings',
+    'wiki_uri' => 'https://github.com/Optum/legion-settings/wiki'
+  }
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov', '< 0.18.0'
-  spec.add_dependency 'legion-json'
-  spec.add_dependency 'legion-logging'
+  spec.add_dependency 'legion-json', '>= 1.2'
 end

data/lib/legion/settings.rb CHANGED Viewed

@@ -24,11 +24,11 @@ module Legion
       end
       def [](key)
-        Legion::Logging.info('Legion::Settings was not loading, auto loading now!') if @loader.nil?
+        logger.info('Legion::Settings was not loading, auto loading now!') if @loader.nil?
         @loader = load if @loader.nil?
         @loader[key]
       rescue NoMethodError, TypeError
-        Legion::Logging.fatal 'rescue inside [](key)'
+        logger.fatal 'rescue inside [](key)'
         nil
       end
@@ -43,6 +43,15 @@ module Legion
         thing[key.to_sym] = hash
         @loader.load_module_settings(thing)
       end
+      def logger
+        @logger = if ::Legion.const_defined?('Logging')
+                    ::Legion::Logging
+                  else
+                    require 'logger'
+                    ::Logger.new($stdout)
+                  end
+      end
     end
   end
 end

data/lib/legion/settings/loader.rb CHANGED Viewed

@@ -1,8 +1,11 @@
 require 'socket'
+require 'legion/settings/os'
 module Legion
   module Settings
     class Loader
+      include Legion::Settings::OS
       class Error < RuntimeError; end
       attr_reader :warnings, :errors, :loaded_files, :settings

data/lib/legion/settings/os.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module Legion
+  module Settings
+    module OS
+      def self.windows?
+        (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+      end
+      def self.mac?
+        (/darwin/ =~ RUBY_PLATFORM) != nil
+      end
+      def self.unix?
+        !OS.windows?
+      end
+      def self.linux?
+        OS.unix? and !OS.mac?
+      end
+      def self.jruby?
+        RUBY_ENGINE == 'jruby'
+      end
+      def os
+        return 'jruby' if jruby?
+        return 'windows' if windows?
+        return 'mac' if mac?
+        return 'unix' if unix?
+        'linux'
+      end
+    end
+  end
+end

data/lib/legion/settings/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Legion
   module Settings
-    VERSION = '1.1.3'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/sourcehawk.yml ADDED Viewed

@@ -0,0 +1,4 @@
+config-locations:
+  - https://raw.githubusercontent.com/optum/.github/main/sourcehawk.yml

metadata CHANGED Viewed

@@ -1,159 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: legion-settings
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Esity
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
-- !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: 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'
-- !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: rspec_junit_formatter
-  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: rubocop
-  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: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.18.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: legion-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: legion-logging
-  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'
-description: Based on Sensu's implementation of settings
+        version: '1.2'
+description: A gem written to handle LegionIO Settings in a consistent way across
+  extensions
 email:
 - matthewdiverson@gmail.com
+- ruby@optum.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+- CHANGELOG.md
 files:
-- ".circleci/config.yml"
+- ".github/workflows/sourcehawk-scan.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- INDIVIDUAL_CONTRIBUTOR_LICENSE.md
+- LICENSE
+- NOTICE.txt
 - README.md
-- Rakefile
-- bitbucket-pipelines.yml
+- SECURITY.md
+- attribution.txt
 - legion-settings.gemspec
 - lib/legion/settings.rb
-- lib/legion/settings/constants.rb
 - lib/legion/settings/loader.rb
-- lib/legion/settings/rules.rb
-- lib/legion/settings/validator.rb
-- lib/legion/settings/validators.rb
+- lib/legion/settings/os.rb
 - lib/legion/settings/validators/legion.rb
 - lib/legion/settings/version.rb
 - sonar-project.properties
-homepage: https://bitbucket.org/whonodes/legion-settings
+- sourcehawk.yml
+homepage: https://github.com/Optum/legion-settings
 licenses:
-- MIT
-metadata: {}
-post_install_message:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/Optum/legion-settings/issues
+  changelog_uri: https://github.com/Optum/legion-settings/src/main/CHANGELOG.md
+  documentation_uri: https://github.com/Optum/legion-settings
+  homepage_uri: https://github.com/Optum/LegionIO
+  source_code_uri: https://github.com/Optum/legion-settings
+  wiki_uri: https://github.com/Optum/legion-settings/wiki
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,15 +75,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: Used to load the json settings files
+summary: Legion::Settings
 test_files: []