ssm_config 0.1.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62ee2af26eb305962b5a1c4f019b5a16b847de0b5b4b482bb7c077c958a8cf32
-  data.tar.gz: c7665892a5d0900d5923549dd9c08196adeb8fb854879f13f46e44a038158b25
+  metadata.gz: a7509632dfae2aa08f269331ae52ec1e645da5c3777a772721866147f4e25c46
+  data.tar.gz: 146883e2ee8cde2946de40d3ee49ba2ab1dc0f9ad529425a2970bf6bb0baf8ec
 SHA512:
-  metadata.gz: ba9d0c438b9147d33d95ad07eee3224f05b1a77a4e3b930e15c476b98a1a4a38dfbad6797491e648c213f0ed231e22f11c59a2b84809c6424f05f6c078e4b58f
-  data.tar.gz: 768c01d819f2af815c1788359870a3626257a39021129bc460b50850d9161f600d0de2c92ee0f52303af54523a845a3b2097bfd52c9cb8850999a62c6ebe7137
+  metadata.gz: c18bf507eda6a9f668325376d7ac0a28d0ceee717ef73909019493cb8b91aac3fc0c51e4eae8b60077674565b25fbd0505bab97f32588a5a6ed456bd8da395a9
+  data.tar.gz: 91bd9725e9ca01cc512c434db801998887fe248ed8720eeaab7e4cafde50a1d3cb2d8873700e2f5411c2e2c1f3a76457a74db801f05f22824451bc4ec7b056ef

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+.DS_Store
+./spec/rails_app/log/**
+

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require:
+  - rubocop-rspec
+  - rubocop-rails
+
+inherit_gem:
+  snap-style:
+    - "rubocop/rubocop.yml"
+
+Security/YAMLLoad:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 100

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.7

data/Gemfile

@@ -2,3 +2,17 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ssm_config.gemspec
 gemspec
+
+group :development, :test do
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.92', :require => false
+  gem 'rubocop-rails', :require => false
+  gem 'rubocop-rspec', :require => false
+  gem 'timecop'
+end
+
+source 'https://rubygems.pkg.github.com/bodyshopbidsdotcom' do
+  group :development do
+    gem 'snap-style'
+  end
+end

data/README.md

@@ -1,9 +1,13 @@
 # SsmConfig
 
-Any config YAML in the config directory can be accessed by calling `SsmConfig.config_name`.
-For example, if you wish to access `config/foo.yml`, just call `SsmConfig.foo` from anywhere in the app. The YAML will be parsed
-into a hash.
-
+* ActiveRecord
+  - Any file in ActiveRecord with model name `SsmConfigRecord` can be accessed by calling `SsmConfig.file_name`
+  - All rows with the corresponding file name will be parsed into a hash
+* `config` directory 
+  - If file is not found in `SsmConfigRecord` (or the ActiveRecord doesn't exist), `SsmConfig` looks in the `config` directory
+  - Any YAML file in the directory with the corresponding file name will be parsed into a hash
+
+These two are exclusive, with the former prioritized: i.e., the gem will look in the ActiveRecord model first, and then in the `config` directory if no such file is found.
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,27 +24,78 @@ Or install it yourself as:
 
     $ gem install ssm_config
 
+## Setup
+
+To utilize ActiveRecords, create the following model:
+```
+rails generate model SsmConfigRecord file:string:index accessor_keys:string value:string datatype:string
+```
+
+The supported datatypes are `[string, integer, boolean, float]`. The field `datatype` should contain the character that corresponds to the first character of the datatype (so one of `[s, i, b, f]`). This field is not case-sensitive (the gem also only checks the first character of `datatype`). Booleans should also be one of `[t, f]`, corresponding to `true` and `false`. Similarly, this is not case-sensitive and only the first character of the value (given the datatype is a boolean) will be checked.
+
+An invalid entry will throw an exception (as well as an invalid boolean entry). 
+
+When migrating a file to the ActiveRecord, it is important to correctly input the accessor keys. The field `accessor_keys` represents a hashkey corresponding to a value in the hash: for the sequence of keys used to access a value, the corresponding accessor key will be the keys concatentated with a comma delimiter. For example, if `hash[:key1][:key2][:key3] = value`, the corresponding accessor key would be the string `"key1,key2,key3"`. In the case that there is an array, we include the index embraced by brackets. Consider the following hash:
+
+```yml
+any:
+  build:
+    docker:
+      - image: value1
+    steps:
+      - value2
+      - run: value3
+```
+The accessor keys for `value1`, `value2`, and `value3` would be `"build,docker,[0],image"`, `"build,steps,[0]"`, and `"build,steps,[1],run"`, respectively.
+
+⚠️ **NOTE:** ⚠️ There should be no file name called `cache`, as this will call a method of the `SsmConfig` class. Also, all values read from the table will be strings.
 ## Usage
 
-Given `config/eft.yml`:
+
+Given the following rows in `SsmConfigRecord`:
+
+| file | accessor_keys | value |
+| :---: | :------------: | :---: |
+| eft | days_to_enter_bank_account,default | 3 |
+| eft | days_to_enter_bank_account,company1,[0] | 2 |
+| eft | days_to_enter_bank_account,company2 | 4|
+
+```ruby
+SsmConfig.eft
+=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>[2], "company2"=>4}}
+```
+`SsmConfig` will always reconstruct the hash using all the rows with the corresponding file name. In the case that no such row exists, `SsmConfig` will look for `config/foo.yml`. For example, given `config/eft.yml`,
+
 ```yml
 any:
   days_to_enter_bank_account:
     default: 3
-    company1: 2
+    company1:
+      - 2
     company2: 4
 ```
-
 ```ruby
 SsmConfig.eft
-=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>2, "company2"=>4}}
+=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>[2], "company2"=>4}}
 ```
 
+This search will be exclusive: i.e., if any row exists in the table then the gem will not look in `config`.
 ## 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To develop and test locally, include a path for your gem in the Gemfile of the desired application, i.e.,
+```
+gem 'ssm_config', path: 'path'
+```
+
+## Release to RubyGems
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To do so, you need a RubyGems account and [to be listed as an owner](https://rubygems.org/gems/ssm_config/owners).
+In the process, after pushing the tag, the console will hang. You will need to enter your RubyGems login and then its password.
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require File.expand_path('../spec/rails_app/config/application', __FILE__)
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+# YouApp::Application.load_tasks

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ssm_config"
+require 'bundler/setup'
+require 'ssm_config'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,6 @@ require "ssm_config"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
+require 'byebug'
 IRB.start(__FILE__)

data/lib/ssm_config/errors.rb

@@ -0,0 +1,13 @@
+module SsmConfig
+  # Generic SsmConfig exception.
+  class Error < StandardError
+  end
+
+  # An unexpected option, perhaps a typo, was passed to the value in the case of a boolean datatype
+  class InvalidBoolean < Error
+  end
+
+  # The datatype entered is unsupported in SsmConfigRecord
+  class UnsupportedDatatype < Error
+  end
+end

data/lib/ssm_config/ssm_storage/db.rb

@@ -0,0 +1,93 @@
+module SsmConfig
+  module SsmStorage
+    class Db
+      TABLE_NAME = 'ssm_config_records'.freeze
+      ACTIVE_RECORD_MODEL = 'SsmConfigRecord'.freeze
+      def initialize(file_name)
+        @file_name = file_name
+      end
+
+      def table_exists?
+        return active_record_model_exists? if active_record_exists? && constant_exists?
+        false
+      end
+
+      def hash
+        match_file = ACTIVE_RECORD_MODEL.constantize.where(:file => @file_name.to_s).order(:accessor_keys)
+        hashes = match_file.each_with_object({}) { |row, hash| hash[row.accessor_keys] = transform_class(row.value, row.datatype); }
+        insert_arrays(reconstruct_hash(hashes)).try(:with_indifferent_access)
+      end
+
+      private
+
+      def active_record_exists?
+        ActiveRecord::Base.connection.table_exists? TABLE_NAME
+      end
+
+      def active_record_model_exists?
+        ACTIVE_RECORD_MODEL.constantize.exists?(:file => @file_name.to_s)
+      end
+
+      def constant_exists?
+        Object.const_defined? ACTIVE_RECORD_MODEL
+      end
+
+      def convert_boolean(value)
+        value = value.to_s.downcase
+        return true if value[0] == 't'
+        return false if value[0] == 'f'
+        raise SsmConfig::InvalidBoolean, 'Not a valid boolean: must be one of true or false'
+      end
+
+      def transform_class(value, type)
+        possible_types = ['s', 'i', 'b', 'f']
+        raise SsmConfig::UnsupportedDatatype, 'Not a valid class: must be one of string, integer, boolean, or float' unless possible_types.include? type.to_s.downcase[0]
+        return value.send("to_#{type.to_s.downcase[0]}") unless type[0] == 'b'
+        convert_boolean(value)
+      end
+
+      def add_flag_for_array_index(key)
+        return "#{key}flag" if key[0] == '['
+        key
+      end
+
+      # given a hash from hashkey (sequence of keys delimited by comma) to value, reconstruct hash
+      # arrays will not be formed properly, see insert_arrays
+      def reconstruct_hash(hash)
+        hash.each_with_object({}) do |(key, value), final_hash| # key will represent sequence of keys needed to get down to value
+          curr_hash = final_hash
+          delimited = key.split(',')
+          delimited[0..-2].each do |curr_key|
+            curr_key = add_flag_for_array_index(curr_key) # if bracket, indicates array index, add a flag indicating this is for an array index, and not some key name that had a bracket in it
+            curr_hash[curr_key] = {} unless curr_hash.key?(curr_key) # if key doesn't exist, initialize it
+            curr_hash = curr_hash[curr_key] # move into next level of hash
+          end
+          curr_hash[add_flag_for_array_index(delimited[-1])] = value # insert value
+        end
+      end
+
+      def array_index_flagged?(hash)
+        hash.all? do |key, _value|
+          key[0] == '[' && key[-4..-1] == 'flag'
+        end
+      end
+
+      # reconstruct_hash is unable to create arrays where needed, so parse through
+      # result and convert to arrays where needed
+      def insert_arrays(hash)
+        return hash unless hash.class == Hash
+        return hash if hash.keys.size.zero? # if there are no keys, return
+        if array_index_flagged?(hash) # if key has bracket + flag, it is an array index
+          hash = hash.values # convert hash to just the array of values
+          hash.each_with_index do |element, index|
+            hash[index] = insert_arrays(element) # recurse on each value
+          end
+        else # no change needed, recurse on next level of hash
+          hash.each do |key, value|
+            hash[key] = insert_arrays(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ssm_config/ssm_storage/empty.rb

@@ -0,0 +1,9 @@
+module SsmConfig
+  module SsmStorage
+    class Empty
+      def hash
+        {}
+      end
+    end
+  end
+end

data/lib/ssm_config/ssm_storage/yml.rb

@@ -0,0 +1,25 @@
+module SsmConfig
+  module SsmStorage
+    class Yml
+      CONFIG_PATH = 'config'.freeze
+      def initialize(file_name)
+        @file_name = file_name
+      end
+
+      def file_exists?
+        File.exist?(file_path)
+      end
+
+      def hash
+        yaml_loaded = YAML.load(ERB.new(File.read((file_path).to_s)).result)
+        (yaml_loaded[Rails.env] || yaml_loaded['any']).try(:with_indifferent_access)
+      end
+
+      private
+
+      def file_path
+        Rails.root.join(CONFIG_PATH, "#{@file_name}.yml")
+      end
+    end
+  end
+end

data/lib/ssm_config.rb

@@ -1,37 +1,56 @@
-class SsmConfig
-  VERSION = "0.1.1"
+require './lib/ssm_config/ssm_storage/db.rb'
+require './lib/ssm_config/ssm_storage/yml.rb'
+require './lib/ssm_config/ssm_storage/empty.rb'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/time'
+require './lib/ssm_config/errors.rb'
 
-  class << self
+module SsmConfig
+  VERSION = '1.1.0'.freeze
+  REFRESH_TIME = (30.minutes).freeze
 
+  class << self
     def method_missing(meth, *args, &block)
-      config_file = Rails.root.join('config', "#{meth}.yml")
+      result = populate(meth)
+      super if result == false
+      result
+    end
 
-      if File.exists?(config_file)
-        write_config_accessor_for(meth)
-        self.send(meth)
-      else
-        super
-      end
+    def respond_to_missing?(meth, *_args)
+      determine_query(meth).present?
+    end
+
+    def last_processed_time
+      @last_processed_time ||= ActiveSupport::HashWithIndifferentAccess.new
     end
 
     private
 
-    def parse_config_file(filename)
-      YAML.load(ERB.new(File.read("#{Rails.root}/config/#{filename}")).result).symbolize_keys
+    def determine_query(meth)
+      query_database = SsmConfig::SsmStorage::Db.new(meth)
+      query_yml = SsmConfig::SsmStorage::Yml.new(meth)
+      return query_database if query_database.table_exists?
+      return query_yml if query_yml.file_exists?
+      nil
     end
 
-    def parse_config_file_with_env(filename)
-      yaml_loaded = YAML.load(ERB.new(File.read("#{Rails.root}/config/#{filename}")).result)
-      (yaml_loaded[Rails.env] || yaml_loaded['any']).try(:with_indifferent_access)
+    def populate(meth)
+      query = determine_query(meth)
+
+      return false if query.blank?
+      self.last_processed_time[meth] = Time.zone.now
+      write_config_accessor_for(meth) unless method_defined?(meth.to_sym)
+      instance_variable_set("@#{meth}".to_sym, nil)
+      self.send(meth, query)
     end
 
     def write_config_accessor_for(meth)
-      self.instance_eval %Q{
-        def #{meth}
-          @#{meth} ||= parse_config_file_with_env('#{meth}.yml')
-        end
-      }
+      self.instance_eval %{
+      def #{meth}(obj = SsmConfig::SsmStorage::Empty.new)
+        return self.send(:populate, "#{meth}") if self.last_processed_time["#{meth}".to_sym] < Time.zone.now - REFRESH_TIME
+        @#{meth} ||= obj&.hash
+      end
+    }, __FILE__, __LINE__ - 5
     end
-
   end
 end

data/ssm_config.gemspec

@@ -1,34 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ssm_config'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ssm_config"
+  spec.name          = 'ssm_config'
   spec.version       = SsmConfig::VERSION
-  spec.authors       = ["Santiago Herrera"]
-  spec.email         = ["santiago@snapsheet.me"]
+  spec.authors       = ['Santiago Herrera']
+  spec.email         = ['santiago@snapsheet.me']
 
-  spec.summary       = %q{YML file loader and parser for Rails}
-  spec.homepage      = "https://github.com/bodyshopbidsdotcom/ssm_config"
-  spec.license       = "MIT"
+  spec.summary       = 'YML file loader and parser for Rails'
+  spec.homepage      = 'https://github.com/bodyshopbidsdotcom/ssm_config'
+  spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_dependency "rails", ">= 3", "< 7"
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_dependency 'rails', '>= 3', '< 7'
+  spec.add_development_dependency 'sqlite3', '1.4'
+  spec.required_ruby_version = '>=2.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssm_config
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Santiago Herrera
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description:
 email:
 - santiago@snapsheet.me
@@ -81,6 +109,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -90,6 +120,10 @@ files:
 - bin/console
 - bin/setup
 - lib/ssm_config.rb
+- lib/ssm_config/errors.rb
+- lib/ssm_config/ssm_storage/db.rb
+- lib/ssm_config/ssm_storage/empty.rb
+- lib/ssm_config/ssm_storage/yml.rb
 - ssm_config.gemspec
 homepage: https://github.com/bodyshopbidsdotcom/ssm_config
 licenses:
@@ -104,14 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: YML file loader and parser for Rails