sourced_config 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50363af2f60bac3d001b53d6cd543b2811b34c00f8ecba3244414276440f7c99
-  data.tar.gz: 4896301d15eb303a5b82edae28b4f09c72dfb19b597cdccd181ddc4af11559d8
+  metadata.gz: 99b9388005849ac1568ac1694edd62c06c1bdc6b94b0533393f4b753720d8447
+  data.tar.gz: a614d545a272b2367834ae0c45abe2a6b1a11530653090e2778ddf6baecb327e
 SHA512:
-  metadata.gz: fc24f7bb912ca82d250b78d03eabde24cdcc92d757a64d40fcfff41c4963ce4cbe0273019d1d9542f28180160f825a40511d654efac8173064cc07e0e9f75f5c
-  data.tar.gz: 48edcddc0b10715ecbdee59f52956748afda5426f5becd608d75d7f7a54f6c8a56d68083f0e37e7e1b06c5c973f20b42eb58b93f9f3c7254a0d4ff85e45248b4
+  metadata.gz: b231f3234f177b62fff9fd6357cbc51a5ec0f8d403115f2d60f9ba30a4fe522cc388e17ebb59c5889e9aeec74211017d2d9a95a53db294f58f19711b52ed9a61
+  data.tar.gz: 3cd8e908f7a4012ea301aa54b618c3be41c3e681b3da831134abc679dfb5385fd8ab6e3441410db6fa4d27cfb5aae90fff6d122bd47deeed3bd1342000163091

data/lib/generators/sourced_config/install_generator.rb

@@ -11,9 +11,11 @@ module SourcedConfig
       desc "Creates an initializer for the gem."
       def copy_tasks
         template "templates/sourced_config.rb", "config/initializers/sourced_config.rb"
+        template "templates/config.yml.erb", "config/config.yml.erb"
+        template "templates/app_config_schema.rb", "app/config/app_config_schema.rb"
 
         application do
-<<RUBY
+          <<RUBY
     # Initialise watch of application configuration
     config.after_initialize { |app| ::SourcedConfig.setup(app) }
     config.before_eager_load { |app| ::SourcedConfig.setup(app) }

data/lib/generators/sourced_config/templates/app_config_schema.rb

@@ -0,0 +1,18 @@
+# frozen-string-literal: true
+
+class AppConfigSchema < SourcedConfig::ConfigContract
+  class LocalesConfig < SourcedConfig::ConfigContract
+    params do
+      required(:supported).filled(array[:string])
+      optional(:load_from_type).filled(:string)
+      optional(:load_from_source).maybe(:string)
+    end
+  end
+
+  schema do
+    required(:locales).hash(LocalesConfig.schema)
+
+    # TODO: Add your own config keys here...
+    # ...
+  end
+end

data/lib/generators/sourced_config/templates/config.yml.erb

@@ -0,0 +1,5 @@
+locales:
+  supported:
+    - en
+  # load_from_type: local-directory
+  # load_from_source: customer_app/locales/

data/lib/generators/sourced_config/templates/sourced_config.rb

@@ -2,14 +2,14 @@
 
 # Configure after autoloading of constants so schema class can be specified
 Rails.application.config.to_prepare do
-    SourcedConfig.configure do |config|
+  SourcedConfig.configure do |config|
     # This is the class that will be used to validate the configuration. The default is the minimum configuration
     # required, `SourcedConfig::ConfigContract` but you should create your own class that inherits from it and define
     # your own configuration schema as needed.
-    # config.config_schema_klass = SourcedConfig::ConfigContract
+    config.config_schema_klass = AppConfigSchema
 
     # The base configuration file path. This is always required and loaded first. It can be an ERB file.
-    # config.base_configuration_file_path = Rails.root.join("config/config.yml.erb")
+    config.base_configuration_file_path = Rails.root.join("config/config.yml.erb")
 
     # The type of configuration source to use. If not specified the configuration is loaded only from the default source
     # in `base_configuration_file_path`. Can be one of:
@@ -17,8 +17,8 @@ Rails.application.config.to_prepare do
     #  `SourcedConfig::ConfigManager::SOURCE_TYPE_S3_CONFIG_BUCKET`
     # config.config_type = SourcedConfig::ConfigManager::SOURCE_TYPE_LOCAL_FILE
 
-    # The path to the configuration file if loading a local file. It *cannot* be an ERB file.
-    # config.configuration_file_path = Rails.root.join("custom_config/config.yml")
+    # The path to the configuration file either locally or in S3. It *cannot* be an ERB file.
+    # config.configuration_file_path = "custom_config/config.yml"
 
     # If the remote configuration source is an S3 bucket, the bucket name of said bucket.
     # config.configuration_bucket = "my-bucket-name"

data/lib/sourced_config/config_contract.rb

@@ -7,18 +7,6 @@ module SourcedConfig
   class ConfigContract < ::Dry::Validation::Contract
     ::Dry::Validation.load_extensions(:monads)
 
-    class LocalesConfig < ConfigContract
-      params do
-        required(:supported).filled(array[:string])
-        optional(:load_from_type).filled(:string)
-        optional(:load_from_source).maybe(:string)
-      end
-    end
-
-    params do
-      required(:locales).hash(LocalesConfig.schema)
-    end
-
     class << self
       def key_names
         schema.key_map.map(&:name)

data/lib/sourced_config/config_manager.rb

@@ -11,7 +11,7 @@ module SourcedConfig
       configuration[key]
     end
 
-    def load!(external_type, external_source_path)
+    def load!(external_type, external_source_path, schema_klass: nil)
       Rails.logger.info "Load configuration data from #{external_type} - #{external_source_path}" if external_type
       if loaded?
         Rails.logger.warn "An attempt to load configuration happened when it is already loaded"
@@ -20,7 +20,7 @@ module SourcedConfig
       primary_config = load_yaml_and_parse_erb(SourcedConfig.configuration.base_configuration_file_path).deep_symbolize_keys
       external = external_type.present? && load_external_config(external_type, external_source_path).deep_symbolize_keys
 
-      schema = SourcedConfig.configuration.config_schema_klass.new
+      schema = (schema_klass || SourcedConfig.configuration.config_schema_klass).new
       config_contract = schema.call(external ? primary_config.deep_merge(external) : primary_config)
       if config_contract.failure?
         messages = config_contract.errors(full: true).to_h

data/lib/sourced_config/locale/i18n_backend.rb

@@ -7,7 +7,7 @@ module SourcedConfig
   module Locale
     class I18nBackend < ::I18n::Backend::Simple
       def load_translations
-        return unless ::SourcedConfig.loaded?
+        return unless ::SourcedConfig.loaded? && ::SourcedConfig[:locales].present?
         type = ::SourcedConfig[:locales][:load_from_type]
         source = ::SourcedConfig[:locales][:load_from_source]
         null_client = Rails.env.test? ? NullClient.new : nil

data/lib/sourced_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SourcedConfig
-  VERSION = "0.2.2"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sourced_config
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Stephen Ierodiaconou
@@ -82,6 +82,8 @@ files:
 - Rakefile
 - lib/generators/sourced_config/USAGE
 - lib/generators/sourced_config/install_generator.rb
+- lib/generators/sourced_config/templates/app_config_schema.rb
+- lib/generators/sourced_config/templates/config.yml.erb
 - lib/generators/sourced_config/templates/sourced_config.rb
 - lib/sourced_config.rb
 - lib/sourced_config/config_contract.rb