sourced_config 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1805418799b3ae9c8b027496139bc2bbb47c4d50ee454bbc10f3fe675bf8677
-  data.tar.gz: 8be3d42e01f8c5c8e7297eacb60b79f6f8742d9db3b013e60c62809515c2e1ef
+  metadata.gz: 8310a14aa124b78a0ab2edcbe7cbe64c61892581b444fb52629286a66429c7ab
+  data.tar.gz: a8998e0fc74c18f3a270d4034a0a7e60bcffa391c1cdfb267e00c79ec899d158
 SHA512:
-  metadata.gz: 6d7aca269439664f6ceccbad924095e3244ed8f2a5bcc7d1c11608a0e0159a3851b51a3b00bc8c6de900121e65032073b7b8a52c5e1f84eda9ef93e332694494
-  data.tar.gz: da4e2f05d692e8453b9b6dd69defc24f0e9e0ff29ed9211d13a951d61056f12080a5acd441bea782f4bb611f18441a66650d9e5c1189dae53d174ea377116495
+  metadata.gz: 7dd45f4b83c0f8e171ec6f231defa09d3633cce8100ac289ffa5a6e087eab86c2a59776f9997b12afec3a7c9b768a647480fa2fd7fb160439ccfd9bea66191bb
+  data.tar.gz: 967df093e6fbe881c3128b5cf55df599eecb959c0bacc327365ffbb1c255cd820fc75371db8f824fe3b9a187d2e2a7b8f1af609d477d08e0dcde4d45828ffd06

data/lib/generators/sourced_config/install_generator.rb

@@ -12,14 +12,7 @@ module SourcedConfig
       def copy_tasks
         template "templates/sourced_config.rb", "config/initializers/sourced_config.rb"
         template "templates/config.yml.erb", "config/config.yml.erb"
-
-        application do
-          <<RUBY
-    # Initialise watch of application configuration
-    config.after_initialize { |app| ::SourcedConfig.setup(app) }
-    config.before_eager_load { |app| ::SourcedConfig.setup(app) }
-RUBY
-        end
+        template "templates/app_config_schema.rb", "app/config/app_config_schema.rb"
       end
     end
   end

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

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

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

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-# Configure after autoloading of constants so schema class can be specified
+# Configure after autoloading of constants so schema class can be specified. But we use `to_prepare` so that configuration
+# is loaded before `before_eager_load` and `after_initialize` callbacks where configuration maybe needed.
 Rails.application.config.to_prepare do
   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 = AppConfig
+    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:
@@ -26,4 +27,7 @@ Rails.application.config.to_prepare do
     # If the remote configuration source is an S3 bucket, the region of said bucket.
     # config.configuration_bucket_region = "us-east-1"
   end
+
+  # `to_prepare` is called on each app reload in development mode but setup only sets up file watchers once.
+  SourcedConfig.setup(Rails.application)
 end

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/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/locale/loader.rb

@@ -30,7 +30,7 @@ module SourcedConfig
           Rails.logger.warn "[locale - #{locale}] Using only default app copy"
           HashWithIndifferentAccess.new(locale => {})
         else
-          raise StandardError, "When loading the Copy and Content the type was unrecognised! #{type}"
+          raise StandardError, "When loading the locales the type was unrecognised! #{type}"
         end
       end
 

data/lib/sourced_config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sourced_config
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2022-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -82,6 +82,7 @@ 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