ssm_config 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7509632dfae2aa08f269331ae52ec1e645da5c3777a772721866147f4e25c46
-  data.tar.gz: 146883e2ee8cde2946de40d3ee49ba2ab1dc0f9ad529425a2970bf6bb0baf8ec
+  metadata.gz: fc2240e68acd1bb76a701e1101dfb2a457e33fdbad0e444a134284746e9fd2fa
+  data.tar.gz: a993b5e09f224a107e44dc5a612bf49fcd6455e604d9a1613d6485f589a6271e
 SHA512:
-  metadata.gz: c18bf507eda6a9f668325376d7ac0a28d0ceee717ef73909019493cb8b91aac3fc0c51e4eae8b60077674565b25fbd0505bab97f32588a5a6ed456bd8da395a9
-  data.tar.gz: 91bd9725e9ca01cc512c434db801998887fe248ed8720eeaab7e4cafde50a1d3cb2d8873700e2f5411c2e2c1f3a76457a74db801f05f22824451bc4ec7b056ef
+  metadata.gz: 1fe7b998ecc23dffdba9c74ecd7c8ac9b3d54f02e8a7efec6d8692e2ef9dbab56b904d320fce5b284c2fa2fb8f5a95a5be81d1fdab99367390bac22500b428d7
+  data.tar.gz: 952104e797a51ad680b80f0f4f5745f5f946583cbca450041d1fbfd58188c9d0bc9bc8f188795ebf068ac62b8549d7f34d621eb27a8a5191b399a139bd5c6e18

data/README.md

@@ -31,9 +31,11 @@ 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.
+The supported datatypes are `[string, integer, boolean, float]`. The first character entered in the field `datatype` should be the character that corresponds to the first character of the datatype (so one of `[s, i, b, f]`). This field is not case-sensitive. 
 
-An invalid entry will throw an exception (as well as an invalid boolean entry). 
+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 entered (given the datatype is a boolean) will be checked.
+
+An invalid `datatype` or boolean entry will throw an exception.
 
 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:
 
@@ -51,19 +53,20 @@ The accessor keys for `value1`, `value2`, and `value3` would be `"build,docker,[
 ⚠️ **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 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|
+| file | accessor_keys | value | datatype |
+| :---: | :------------: | :---: | :---: |
+| eft | days_to_enter_bank_account,default | 3 | 'i' |
+| eft | days_to_enter_bank_account,company1,[0] | 2 | 'Integer'
+| eft | days_to_enter_bank_account,company2 | true| 'boolean'
 
 ```ruby
 SsmConfig.eft
-=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>[2], "company2"=>4}}
+=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>[2], "company2"=>true}}
 ```
+To reiterate, only the first character of the datatype is processed, and it is not case sensitive.
+
 `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
@@ -72,14 +75,45 @@ any:
     default: 3
     company1:
       - 2
-    company2: 4
+    company2: true
 ```
 ```ruby
 SsmConfig.eft
-=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>[2], "company2"=>4}}
+=> {"days_to_enter_bank_account"=>{"default"=>3, "company1"=>[2], "company2"=>true}}
 ```
-
 This search will be exclusive: i.e., if any row exists in the table then the gem will not look in `config`.
+
+## Migrations
+
+To migrate a YAML file in the `config` directory into `SsmConfigRecord`, the class `SsmConfig::MigrationHelper` can be used. `MigrationHelper` takes in the file name, and has `up` and `down` methods.
+
+The `up` method will migrate the file into the table: if any validations are violated, then all rows that were added in the current call will be deleted, returning the table to the initial state. The following is a custom validation for datatype (which can be added in the corresponding model file):
+
+```ruby
+class SsmConfigRecord < ApplicationRecord
+  validate :datatype_support
+
+  def datatype_support
+    errors.add(:datatype, "is not a valid datatype (#{datatype})") unless SsmConfig::SsmStorage::Db::VALID_DATATYPES.include? datatype.downcase[0]
+  end
+end
+```
+
+
+The `down` method will remove _all_ rows in the table that match the file name. A sample migration is as follows:
+
+```ruby
+class AddFileToSsmconfigrecord < ActiveRecord::Migration[5.2]
+  def up
+    SsmConfig::MigrationHelper.new('file').up
+  end
+
+  def down
+    SsmConfig::MigrationHelper.new('file').down
+  end
+end
+```
+
 ## 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.

data/lib/ssm_config/migration_helper.rb

@@ -0,0 +1,61 @@
+module SsmConfig
+  class MigrationHelper
+    def initialize(file_name)
+      @file_name = file_name
+      @model_name = SsmConfig::SsmStorage::Db::ACTIVE_RECORD_MODEL
+    end
+
+    def up
+      added = []
+      keys_hash = accessor_key_hash(hash) # starting layer is always hash
+      last = nil
+      keys_hash.each do |accessor_key, value|
+        last = accessor_key
+        added.push(@model_name.constantize.create!(:file => @file_name, :accessor_keys => accessor_key, :value => value.to_s, :datatype => determine_class(value)))
+      end
+    rescue ActiveRecord::RecordInvalid => e
+      Rails.logger.error("#{e.message} was raised because of faulty data with accessor_key #{last}")
+      added.each(&:delete)
+    end
+
+    def down
+      @model_name.constantize.where(:file => @file_name).destroy_all
+    end
+
+    private
+
+    def accessor_key_recurse(value, curr, res)
+      case value
+      when Hash
+        res.merge!(accessor_key_hash(value, curr))
+      when Array
+        res.merge!(accessor_key_array(value, curr))
+      else
+        res[curr[1..-1]] = value
+      end
+    end
+
+    def accessor_key_hash(hash, curr = '')
+      hash.each_with_object({}) do |(key, value), res|
+        updated_hash = "#{curr},#{key}"
+        accessor_key_recurse(value, updated_hash, res)
+      end
+    end
+
+    def accessor_key_array(arr, curr = '')
+      arr.each_with_object({}).with_index do |(value, res), index|
+        updated_hash = "#{curr},[#{index}]"
+        accessor_key_recurse(value, updated_hash, res)
+      end
+    end
+
+    def determine_class(value)
+      return 'boolean' if (value == false) || (value == true)
+      return value.class
+    end
+
+    def hash
+      SsmConfig::SsmStorage::Yml.new(@file_name).hash
+    end
+  end
+end

data/lib/ssm_config/ssm_storage/db.rb

@@ -3,6 +3,7 @@ module SsmConfig
     class Db
       TABLE_NAME = 'ssm_config_records'.freeze
       ACTIVE_RECORD_MODEL = 'SsmConfigRecord'.freeze
+      VALID_DATATYPES = ['s', 'i', 'b', 'f'].freeze
       def initialize(file_name)
         @file_name = file_name
       end
@@ -40,8 +41,7 @@ module SsmConfig
       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]
+        raise SsmConfig::UnsupportedDatatype, 'Not a valid class: must be one of string, integer, boolean, or float' unless VALID_DATATYPES.include? type.to_s.downcase[0]
         return value.send("to_#{type.to_s.downcase[0]}") unless type[0] == 'b'
         convert_boolean(value)
       end

data/lib/ssm_config.rb

@@ -1,12 +1,13 @@
-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 'ssm_config/ssm_storage/db.rb'
+require 'ssm_config/ssm_storage/yml.rb'
+require 'ssm_config/ssm_storage/empty.rb'
+require 'ssm_config/errors.rb'
+require 'ssm_config/migration_helper.rb'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/time'
-require './lib/ssm_config/errors.rb'
 
 module SsmConfig
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.1'.freeze
   REFRESH_TIME = (30.minutes).freeze
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssm_config
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Santiago Herrera
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - bin/setup
 - lib/ssm_config.rb
 - lib/ssm_config/errors.rb
+- lib/ssm_config/migration_helper.rb
 - lib/ssm_config/ssm_storage/db.rb
 - lib/ssm_config/ssm_storage/empty.rb
 - lib/ssm_config/ssm_storage/yml.rb