app_configurable 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '008ea1c3e9903d1ade8d43500aee26d9006173f2a51fd94ad20bda97f682a693'
-  data.tar.gz: 0d905a63926d10af5b3f660d0e9c9051c4e4f44d190919c1c93e11c7b50cc598
+  metadata.gz: 044562b2da9b8df939abe454b140aab3d3389a893dc2dd31f278d9e9eae8495b
+  data.tar.gz: 932b8ae2e26fb5449a52c815e578689ea24a88578c11df79165d42edd5a2801a
 SHA512:
-  metadata.gz: 5d98d1e7c611cc49a14a3ba0cec6fa1f1785fa9a3bd84b34cf663d1b0a1d4e3b27e4e0285af004565db73ad4a587d7b5e2f5b5f10bb1a40d3bec61204167c21f
-  data.tar.gz: a5c238318515ebfe84cb4df741bc50b8be30a183b3f9c41f07e94fe11867743d10ecf67fbe83589f92d8e196d054344ffb67c5e89d75dcf683cdfe42faa8bc62
+  metadata.gz: 389a4ff576b8a3da9207ca41570becd67f3b5af38fb0e046c80468102ccd30a1d925f7a8817044f2ebaa88e900df26f5378972d5f92bc09bd0ac6eded9df9148
+  data.tar.gz: 190ec85b5ce0a351ae45d343d685a438b2b681f72746506c75ab01b5a373f5ffb493aa7d97706a0c1cabdd21878769ee4224880cd3d0afd7b1a1e99a8adacf94

data/.rubocop.yml

@@ -26,7 +26,7 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 120
+  Max: 180
 
 Style/ClassAndModuleChildren:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_configurable (0.1.1)
+    app_configurable (0.1.4)
       dotenv
 
 GEM
@@ -112,7 +112,7 @@ GEM
       net-smtp
     marcel (1.0.4)
     mini_mime (1.1.5)
-    minitest (5.25.1)
+    minitest (5.25.2)
     net-imap (0.5.1)
       date
       net-protocol
@@ -257,4 +257,4 @@ DEPENDENCIES
   rubocop-rspec_rails (~> 2.30.0)
 
 BUNDLED WITH
-   2.5.11
+   2.5.23

data/README.md

@@ -1,74 +1,113 @@
-# AppConfigurable
-
-Single source of truth for app configuration.
-
-## Adding a new config
-
-There are 2 types of configs:
- - Namespaced - used to store configs which could be grouped by attributes such as external service name e.g Hubspot. 
- - Root-level configs - generic configs for the app such as `rails_serve_static_files`.
-
-Example of namespaced config:
-
-```ruby
-class AppConfig::Hubspot
-  include AppConfigurable
-
-  entry :access_token, default: 'secret'
-  entry :base_url, default: 'https://app-eu1.hubspot.com/contacts/26265873', production: 'https://app-eu1.hubspot.com/contacts/25696692'
-  entry :client_secret, default: 'secret'
-end
-```
-
-Then config entries could be accessed through: `AppConfig::Hubspot.base_url`.
+# App Configurable
+
+## Single source of truth for app configuration
+
+App Configurable is a simple Ruby gem that provides a centralized and consistent way to manage application configurations. It allows you to define configurations in a single place and access them throughout your application, ensuring that your app's settings are always up-to-date and consistent across different environments.
+
+### Features
+- Centralized configuration management
+- Environment-specific settings
+- Fail on demand or on app startup
+- Support for namespaced and root-level configurations
+- Easy integration with Rails applications
+
+### Installation
+1. Add the gem to your Gemfile:
+    ```ruby
+    gem 'app_configurable'
+    ```
+2. Define your configurations in `config/app_config.rb`:
+    ```ruby
+    class AppConfig
+      include AppConfigurable
+
+      entry :secret_key, default: 'your_secret_key'
+      entry :base_url, default: 'http://my-site.local', production: 'http://  my-site.io', staging: 'http://staging.my-site.io'
+    end
+    ```
+3. Load the configurations:
+    
+    Define an initializer `config/initializers/_app_config.rb`:
+    ```ruby
+    AppConfigurable.load(%w[./config/app_config.rb])
+    ```
+    OR
+    ```ruby
+    AppConfigurable.load(%w[./config/app_config.rb], raise_on_missing: true) #  Fails on startup, reporting missing configs.
+    ```
+    *Alternatively, you could define your configs under the autoloading path if   failing on demand is acceptable.*
+
+4. Access your configurations:
+    ```ruby
+    AppConfig.secret_key
+    ```
+
+### Adding a config
+There are two types of configurations:
+- **Namespaced**: Used to store configurations grouped by attributes such as external service names (e.g., Hubspot).
+- **Root-level configs**: Generic configurations for the app, such as `rails_serve_static_files`.
+
+  ### Example
+  `./config/app_config.rb`:
+  ```ruby
+  class AppConfig
+    include AppConfigurable
+
+    entry :secret_key_base, default: 'secret_key_base'
+    entry :base_url, default: 'http://my-site.local', production: 'http://  my-site.io', staging: 'http://staging.my-site.io'
+    entry :client_secret, default: 'client_secret_token'
+  end
+  ```
+
+  `./config/app_config/hubspot.rb`:
+  ```ruby
+  class AppConfig::Hubspot
+    include AppConfigurable
+
+    entry :access_token, default: 'secret_access_token'
+    entry :base_url, default: 'https://hubspot.com/1234', production: 'https:// hubspot.com/4321'
+    entry :client_secret, default: 'client_secret_token'
+  end
+  ```
+
+  Declared configs can be accessed through: `AppConfig.secret_key_base` and   `AppConfig::Hubspot.base_url`.
 
 ## Attributes
-Attributes are declared using `entry` directive.
+
+Attributes are declared using the `entry` directive.
 Example: `entry :rails_serve_static_files`.
 
 ### Options
-`production/staging/development/test` - sets attributes per environment.
-
-`default`:
-- sets default attribute, used in `production/staging/development` environments as a fallback.
-- accepts `string`/`number`/`boolean` as well as `Proc`/`Lambda` as a parameter.
-- in `test` environment always falls back to a dummy value `some_super_dummy_#{namespaced_attribute_name}`
+- **production/staging/development/test**: Sets attributes per environment.
+- **default**:
+  - Sets the default attribute, used in `production/staging/development` environments as a fallback.
+  - Accepts `string`/`number`/`boolean` as well as `Proc`/`Lambda` as a parameter.
+  - In the `test` environment, always falls back to a dummy value `some_super_dummy_#{namespaced_attribute_name}` unless specified explicitly.
 
-#### Priority and lifecycle:
-  `production/staging/development`:
-   1) Tries to find a value in joint hash of `ENV` and `Rails.application.credentials`.
-   2) Gets value from specific environment attribute passed to `entry`.
-   3) Get's value from `default`.
-   4) Raises `AppConfig::Error::RequiredVarMissing` if no attribute found.
+#### Priority
+- **production/staging/development**:
+  1. Find value in `ENV`.
+  2. Find value in specific environment attribute passed to `entry`.
+  3. Find value from `default`.
+  4. Fail with `AppConfig::Error::RequiredVarMissing`.
 
-   `testing`:
-   1) Tries to find a value in joint hash of `ENV` and `Rails.application.credentials`.
-   2) Gets value from `test` environment attribute.
-   3) Returns `some_super_dummy_#{namespaced_attribute_name}`, ignores specified `default` attribute.
+- **testing**:
+  1. Find value in `ENV`.
+  2. Find value in `test` attribute of config `entry`.
+  3. Return `some_super_dummy_#{namespaced_attribute_name}`, **ignoring the specified `default` attribute**.
 
-### Setting the environment:
-You could set environment per namespace like so:
+### Setting the Environment
+You can set the environment per namespace like so:
 
-Given namespace `AppConfig::MyNiceConfigClass` and `.env.staging`
+Given namespace `AppConfig::MyNiceConfigClass` and `.env.staging`:
 
 ```bash
 APPCONFIG_MYNICEMODULE_ENV=staging rspec
 ```
 
-*`.env.#{RAILS_ENV}` will be read per specific `AppConfig::SomeNiceClass` class.*
-
-### Fail on startup:
-Create a new initializer in `config/initializers/_app_config.rb`
-
-```
-# Require your config files
-require './config/app_config' # Root-level configs.
-FileList['./config/app_config/*.rb'].each { |file| require file } # Secondary-level/namespaced configs.
-
-missing = AppConfigurable.missing_required_vars
-missing.present? and raise "Missing required ENV variables/encrypted credentials: #{missing.inspect}"
-```
+`.env.#{RAILS_ENV}` will be read per specific `AppConfig::SomeNiceClass` class.
 
 ### TODO:
- - Read `Rails.application.credentials`
-    - Make dynamic switch possible, simillar to what we have with `ENV`.
+
+- Read `Rails.application.credentials`.
+- Make dynamic switch possible, similar to what we have with `ENV`.

data/lib/app_configurable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppConfigurable
-  VERSION = '0.1.1'
+  VERSION = '0.1.4'
 end

data/lib/app_configurable.rb

@@ -18,10 +18,26 @@ module AppConfigurable
     owner.include InstanceMethods
   end
 
+  # Returns the list of available configuration attributes,
+  # which are defined with the `entry` method.
+  # @return [Array]
   def self.available_config_attributes
     @@available_config_attributes
   end
 
+  # @param paths [Array] List of paths to load.
+  # @param raise_on_missing [Boolean] Raise an error if required variables are missing, default is `false`.
+  # @return [void]
+  def self.load_configs(paths = [], raise_on_missing: false)
+    paths.each do |path|
+      absolute_path = Dir.pwd + "/#{path}"
+
+      File.directory?(absolute_path) ? Dir["#{absolute_path}/**/*.rb"].each { |f| require f } : require(absolute_path)
+    end
+
+    raise_on_missing && missing_required_vars.any? && raise(Error::RequiredVarMissing, missing_required_vars.join(', '))
+  end
+
   # Report missing required `ENV` variables.
   # @return [Array]
   def self.missing_required_vars
@@ -118,16 +134,14 @@ module AppConfigurable
       attrs.each { |k, v| public_send(:"#{k}=", v) }
     end
 
-    # A *copy* of the credentials for value-reading purposes.
-    # @return [Hash]
-    def credentials
-      @credentials ||= ::Rails.application&.credentials.to_h
-    end
-
     # A *copy* of the environment for value-reading purposes.
     # @return [Hash]
     def env
-      @env ||= ::Rails.env == rails_env ? ENV.to_h : ::Dotenv.parse(".env.#{rails_env}")
+      @env ||=
+        begin
+          result = ::Rails.env == rails_env ? ENV.to_h : ::Dotenv.parse(".env.#{rails_env}")
+          result.deep_transform_keys!(&:downcase).with_indifferent_access
+        end
     end
 
     # @!attribute rails_env
@@ -171,13 +185,13 @@ module AppConfigurable
 
     # @see #env_truthy?
     def env_falsey?(key)
-      self.class.env_value_falsey?(secrets[key.to_s])
+      self.class.env_value_falsey?(env[key.to_s])
     end
 
     # @param key [String/Symbol]
     # @return [String/Boolean] The value of the environment variable, converts `bolean`'ish values into boolean.
     def env_value(key)
-      v = secrets.dig(*key)
+      v = env.dig(*key)
       v = env_truthy?(key) if env_boolean?(key)
       v
     end
@@ -190,7 +204,7 @@ module AppConfigurable
     # @param key [String]
     # @return [Boolean]
     def env_truthy?(key)
-      self.class.env_value_truthy?(secrets[key.to_s])
+      self.class.env_value_truthy?(env[key.to_s])
     end
 
     # @param name [Symbol/String]
@@ -209,7 +223,7 @@ module AppConfigurable
       result = default_value.call(dummy_value) if result.nil?
       if result.nil?
         raise Error::RequiredVarMissing,
-              "Required ENV variable or credential missing: #{self.class.name}.#{name}"
+              "Required ENV variable is missing: #{self.class.name}.#{name}"
       end
 
       result
@@ -232,14 +246,6 @@ module AppConfigurable
       send(:env)
     end
 
-    # TODO: Implement this. Currently it's not re-reading secrets after enviromnemt change.
-    # Recalculates the `credentials` hash.
-    # @return [void]
-    def recalculate_credentials
-      remove_instance_variable(:@credentials) if instance_variable_defined?(:@credentials)
-      send(:credentials)
-    end
-
     # Recalculates the values of all the attributes.
     # @return [void]
     def recalculate_values
@@ -248,11 +254,5 @@ module AppConfigurable
         send(a)
       end
     end
-
-    # Joint hash of `ENV` and `Rails.application.credentials`
-    # @return [HashWithIndifferentAccess]
-    def secrets
-      { **env }.deep_transform_keys!(&:downcase).with_indifferent_access
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_configurable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Dmytro Pasichnyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: AppConfigurable allows you to configure your application with a simple DSL