sourced_config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67bcae6215d95ddc63e2dd5522805c69b73c4357756160d765a9f5581404152d
-  data.tar.gz: e6d714e45c36234238ff22c7c1390273de3df7b4c9d6ea1f52ee9829946f8ff4
+  metadata.gz: 7dfe40bcfa6018fed56ca0031fc925a621f7efefac5c840fd403a0b87a0fb546
+  data.tar.gz: b1ab2ef0c2d10068aedefd39c236c9c5012952896333977180775b7953f5d0ab
 SHA512:
-  metadata.gz: 8d786b59013736cceb1435f5e88351cff813658f88ba88a0a1a927f32c2ad5baf5668b7ed7565179b880f21de5c206cb8b89454798c6545dbc52f8c7578d74ba
-  data.tar.gz: 977b760623e3e29f545de365193b83c2f1555274ed53c68dcb6941b13d56beec8b3b7c976703998a57a8ad04ad1c58c198b6eab451336a37748a0804e408f92d
+  metadata.gz: 5315cacb05c9f4fd5e4d937820fa5b3cc7eb35e2a457fd39df08cba91eb06ea0a306095f6f9bc188eb98d81a0ef95b72053a23d2fe5fae8992af2d0c8706b338
+  data.tar.gz: 36e2f37091f40b74adb0173a89012a35e7a126bafa7caeee37a74b44b0fccf6d68acca9b9ea753645ca64d4421979f85b0a937d5433011f250fba96dc9ad9df7

data/README.md

@@ -23,14 +23,56 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install sourced_config
 
-## Usage
+Then install the initializer by executing:
+
+    $ rails g sourced_config:install
 
-TODO: Write usage instructions here
 
-- Add an initializer to your app to configure the gem
-- Add a base config file to your app
+## Usage
+
 
-Access config with `SourcedConfig[key]`
+### Setup:
+
+1. Add an initializer to your app to configure the gem (eg with the generator `rails g sourced_config:install`)
+    - To manually install create an initializer, and add the following to your `Application` class:
+      ```ruby
+           # Initialise watch of application configuration
+           config.after_initialize { |app| ::SourcedConfig.setup(app) }
+           config.before_eager_load { |app| ::SourcedConfig.setup(app) }
+      ```  
+2. Add a schema class to your app to define the config schema (eg `app/config/app_contract.rb` which inherits from `SourcedConfig::ConfigContract`)
+3. Configure your app for the `aws-sdk-s3` gem
+    - If you are using the `aws-sdk-s3` gem in your app, you can skip this step
+    - otherwise read `https://github.com/aws/aws-sdk-ruby#configuration`
+4. Add a base config file to your app (eg `config/config.yml.erb` as per your initializer)
+
+### Example schema:
+
+```ruby
+class AppContract < SourcedConfig::ConfigContract
+  class ColorContract < SourcedConfig::ConfigContract 
+    params do
+      optional(:header).maybe(:string)
+      optional(:footer).maybe(:string)
+    end
+  end
+  
+  params do
+    required(:environment).filled(:string)
+    required(:app_name).filled(:string)
+    optional(:colors).hash(ColorContract.schema)
+  end
+end
+```
+
+### Accessing configuration:
+
+Access config values in your code with `SourcedConfig[key]`
+
+```ruby
+SourcedConfig[:environment]
+SourcedConfig[:colors][:footer]
+```
 
 ## Development
 

data/lib/generators/sourced_config/USAGE

@@ -0,0 +1,3 @@
+Creates an initialiser:
+
+    rails generate sourced_config:install

data/lib/generators/sourced_config/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module SourcedConfig
+  module Generators
+    # The Install generator `sourced_config:install`
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(__dir__)
+
+      desc "Creates an initializer for the gem."
+      def copy_tasks
+        template "templates/sourced_config.rb", "config/initializers/sourced_config.rb"
+
+        append_to_file 'config/application.rb' do
+<<RUBY
+    # Initialise watch of application configuration
+    config.after_initialize { |app| ::SourcedConfig.setup(app) }
+    config.before_eager_load { |app| ::SourcedConfig.setup(app) }
+RUBY
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+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
+
+  # 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")
+
+  # 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:
+  #  `SourcedConfig::ConfigManager::SOURCE_TYPE_LOCAL_FILE`
+  #  `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")
+
+  # If the remote configuration source is an S3 bucket, the bucket name of said bucket.
+  # config.configuration_bucket = "my-bucket-name"
+
+  # If the remote configuration source is an S3 bucket, the region of said bucket.
+  # config.configuration_bucket_region = "us-east-1"
+end

data/lib/sourced_config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sourced_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -80,6 +80,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/sourced_config/USAGE
+- lib/generators/sourced_config/install_generator.rb
+- lib/generators/sourced_config/templates/sourced_config.rb
 - lib/sourced_config.rb
 - lib/sourced_config/config_contract.rb
 - lib/sourced_config/config_manager.rb
@@ -114,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Load configuration & locales for Rails apps from a remote or local non-repo