legion-settings 1.0.0 → 1.2.0

data/NOTICE.txt

@@ -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

@@ -1,55 +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:
-
-    $ gem install legion-settings
-
-## Usage
+Installation and Usage
+------------------------
 
-This library is utilized by Legion to load config files
+You can verify your installation using this piece of code:
 
-## Gem
-
-This gem can be viewed and download from [RubyGems - Legion-Settings](https://rubygems.org/gems/legion-settings)
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+gem install legion-json
+```
 
-To install this gem onto your local machine, run `bundle exec install`. 
+```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

@@ -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

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

data/legion-settings.gemspec

@@ -1,35 +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.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.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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'
-  if RUBY_ENGINE == 'jruby'
-    spec.add_dependency 'legion-json-jruby'
-  else
-    spec.add_dependency 'legion-json'
-  end
-  spec.add_dependency 'legion-logging'
+  spec.add_dependency 'legion-json', '>= 1.2'
 end

data/lib/legion/settings.rb

@@ -7,6 +7,7 @@ module Legion
   module Settings
     class << self
       attr_accessor :loader
+
       def load(options = {})
         @loader = Legion::Settings::Loader.new
         @loader.load_env
@@ -23,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
 
@@ -40,7 +41,16 @@ module Legion
         @loader = load if @loader.nil?
         thing = {}
         thing[key.to_sym] = hash
-        @loader.load_module_default(thing)
+        @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

data/lib/legion/settings/loader.rb

@@ -1,14 +1,13 @@
 require 'socket'
+require 'legion/settings/os'
 
 module Legion
   module Settings
     class Loader
-      class Error < RuntimeError; end
+      include Legion::Settings::OS
 
-      attr_reader :warnings
-      attr_reader :errors
-      attr_reader :loaded_files
-      attr_reader :settings
+      class Error < RuntimeError; end
+      attr_reader :warnings, :errors, :loaded_files, :settings
 
       def initialize
         @warnings = []
@@ -16,55 +15,45 @@ module Legion
         @settings = default_settings
         @indifferent_access = false
         @loaded_files = []
-        self.class.create_category_methods
       end
 
       def client_defaults
         {
           hostname: system_hostname,
-          address:  system_address,
-          name:     "#{::Socket.gethostname.gsub('.', '_')}.#{::Process.pid}",
-          ready:    false
+          address: system_address,
+          name: "#{::Socket.gethostname.tr('.', '_')}.#{::Process.pid}",
+          ready: false
         }
       end
 
       def default_settings
         {
-          client:                     client_defaults,
-          cluster:                    { public_keys: {} },
-          crypt:                      {
-            cluster_secret:         nil,
+          client: client_defaults,
+          cluster: { public_keys: {} },
+          crypt: {
+            cluster_secret: nil,
             cluster_secret_timeout: 5,
-            vault:                  { connected: false }
+            vault: { connected: false }
           },
-          cache:                      { enabled: true, connected: false, driver: 'dalli' },
-          extensions:                 {},
+          cache: { enabled: true, connected: false, driver: 'dalli' },
+          extensions: {},
+          reload: false,
+          reloading: false,
+          auto_install_missing_lex: true,
           default_extension_settings: {
             logger: { level: 'info', trace: false, extended: false }
           },
-          logging:                    {
-            level:             'info',
-            location:          'stdout',
-            trace:             true,
+          logging: {
+            level: 'info',
+            location: 'stdout',
+            trace: true,
             backtrace_logging: true
           },
-          transport:                  { connected: false },
-          data:                       { connected: false }
+          transport: { connected: false },
+          data: { connected: false }
         }
       end
 
-      def self.create_category_methods
-        # CATEGORIES.each do |category|
-        #   define_method(category) do
-        #     setting_category(category)
-        #   end
-        #   method_name = category.to_s.chop + "_exists?"
-        #   define_method(method_name.to_sym) do |name|
-        #     definition_exists?(category, name)
-        #   end
-        # end
-      end
-
       def to_hash
         unless @indifferent_access
           indifferent_access!
@@ -97,13 +86,17 @@ module Legion
         load_api_env
       end
 
+      def load_module_settings(config)
+        @settings = deep_merge(config, @settings)
+      end
+
       def load_module_default(config)
         merged = deep_merge(@settings, config)
         deep_diff(@settings, merged) unless @loaded_files.empty?
         @settings = merged
       end
 
-      def load_file(file) # rubocop:disable Metrics/AbcSize
+      def load_file(file)
         Legion::Logging.debug("Trying to load file #{file}")
         if File.file?(file) && File.readable?(file)
           begin
@@ -124,7 +117,6 @@ module Legion
       end
 
       def load_directory(directory)
-        warning('loading config files from directory', directory: directory)
         path = directory.gsub(/\\(?=\S)/, '/')
         if File.readable?(path) && File.executable?(path)
           Dir.glob(File.join(path, '**{,/*/**}/*.json')).uniq.each do |file|

data/lib/legion/settings/os.rb

@@ -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

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

data/sonar-project.properties

@@ -0,0 +1,12 @@
+sonar.projectKey=legion-io_legion-settings
+sonar.organization=legion-io
+sonar.projectName=Legion::Settings
+sonar.sources=.
+sonar.exclusions=vendor/**
+sonar.coverage.exclusions=spec/**
+sonar.ruby.coverage.reportPath=coverage/.resultset.json
+sonar.ruby.file.suffixes=rb,ruby
+sonar.ruby.coverage.framework=RSpec
+sonar.ruby.rubocopConfig=.rubocop.yml
+sonar.ruby.rubocop.reportPath=rubocop-result.json
+sonar.ruby.rubocop.filePath=.

data/sourcehawk.yml

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

metadata

@@ -1,165 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: legion-settings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Esity
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-03-12 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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: legion-json
   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: legion-logging
-  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'
-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"
-- ".idea/.rakeTasks"
-- ".idea/legion-settings.iml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/vagrant.xml"
-- ".idea/workspace.xml"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- INDIVIDUAL_CONTRIBUTOR_LICENSE.md
+- LICENSE
+- NOTICE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- 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
-homepage: https://bitbucket.org/whonodes/legion-settings
+- sonar-project.properties
+- 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
@@ -167,15 +75,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-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: []