secvault 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c2c9db7124c8ac60bf772bcb42c1367f9e5a25a72c977aecc717da47ec401e8
-  data.tar.gz: a8a46d584bf49e2ec7ca1bbfc9609c64b25642406a55efaf79f7f8e5eeeccbba
+  metadata.gz: 243d63e08d1e0efc90840322ebe46d547a6733829e4cde6f009dcaee457fb141
+  data.tar.gz: 0c927adb97f3fdfa9e4680d59825b50b2741b11cb8131c1e61b0eca42dec75fb
 SHA512:
-  metadata.gz: 52ffd8869e91255f41bbf5bcba424efa8ccfd2a7ec3227c97a8430cd2a21ecbf816558a966ad68afeff611889085b91af765012a9c1529c27917b56cab9aceab
-  data.tar.gz: 191341590209b60085ad54047813788e3bd809ad84791c7aacca546bbc9870a653ae6c6811bce083b8e187aae9d14f9d3bdb5b6c533b549dda356e917816828d
+  metadata.gz: 0abb15b103100f8205b1ec4c7890d51b9ad8d8c0f55d8d96e1f55b0e85b6d0ade146c382c32e187bfb2c952d02a3fc940ee33b9c6f9beabe598b7773e9cf9fa9
+  data.tar.gz: 12edf2aad07063edb1d4385bedcc8899d388eefef26499671cdddf2bc37c67bfeec39fc08729e09e19c63c04021f28642276f81354b1729a7e08940b5a47fcc9

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ## [Unreleased]
 
+## [2.2.0] - 2025-09-22
+
+### Added
+
+- **New simplified API**: `Rails::Secrets.load()` - cleaner method to load default config/secrets.yml
+- **Enhanced README** with comprehensive examples for multiple files usage
+- **Better documentation** showing how to parse custom files and multiple file merging
+- **Backward compatibility aliases** - `parse_default` and `read` still work
+
+### Changed
+
+- **Improved method naming**: `Rails::Secrets.load()` is now the preferred method over `parse_default()`
+- **Enhanced documentation** in code with clear examples for single file, multiple files, and custom paths
+- **Better README examples** showing advanced usage patterns
+
+### Examples Added
+
+- Multiple secrets files merging: `Rails::Secrets.parse(['secrets.yml', 'secrets.local.yml'], env: Rails.env)`
+- Environment-specific loading: `Rails::Secrets.load(env: 'production')`
+- Custom file parsing: `Rails::Secrets.parse(['config/custom.yml'], env: Rails.env)`
+- Multiple path support: `Rails::Secrets.parse([Rails.root.join('config', 'secrets.yml')], env: Rails.env)`
+
+### Backward Compatibility
+
+- ✅ All existing methods still work
+- ✅ `parse_default` → `load` (alias maintained)
+- ✅ `read` → `load` (alias maintained)
+- ✅ No breaking changes
+
 ## [2.1.0] - 2025-09-22
 
 ### Removed

data/README.md

@@ -51,6 +51,39 @@ production:
   api_key: <%= ENV['API_KEY'] %>
 ```
 
+## Advanced Usage
+
+**Multiple secrets files (merged in order):**
+```ruby
+# Parse multiple files - later files override earlier ones
+secrets = Rails::Secrets.parse([
+  'config/secrets.yml',
+  'config/secrets.local.yml',
+  'config/secrets.production.yml'
+], env: Rails.env)
+```
+
+**Load specific environment:**
+```ruby
+# Load production secrets in any environment
+production_secrets = Rails::Secrets.load(env: 'production')
+
+# Load development secrets
+dev_secrets = Rails::Secrets.load(env: 'development')
+```
+
+**Custom files:**
+```ruby
+# Parse a custom secrets file
+custom_secrets = Rails::Secrets.parse(['config/custom.yml'], env: Rails.env)
+
+# Parse from different paths
+all_secrets = Rails::Secrets.parse([
+  Rails.root.join('config', 'secrets.yml'),
+  Rails.root.join('config', 'deploy', 'secrets.yml')
+], env: Rails.env)
+```
+
 ## Rails 7.1 Integration
 
 Test Secvault in Rails 7.1 before upgrading to 7.2+:
@@ -65,7 +98,8 @@ This replaces Rails.application.secrets with Secvault functionality. Your existi
 ```ruby
 Rails.application.secrets.api_key          # ✅ Works
 Rails.application.secrets.oauth_settings   # ✅ Works
-Rails::Secrets.parse_default               # ✅ Enhanced functionality
+Rails::Secrets.load                        # ✅ Load default config/secrets.yml
+Rails::Secrets.parse(['custom.yml'], env: Rails.env)  # ✅ Parse custom files
 ```
 
 

data/lib/secvault/rails_secrets.rb

@@ -7,43 +7,41 @@ module Secvault
   module RailsSecrets
     extend self
     
-    # Classic Rails::Secrets.parse method
+    # Parse secrets from one or more YAML files
     # 
-    # Parses secrets files with support for:
-    # - ERB templating 
+    # Supports:
+    # - ERB templating for environment variables
     # - Shared sections that apply to all environments
     # - Environment-specific sections
+    # - Multiple files (merged in order)
     # - Deep symbolized keys
     #
-    # Example usage:
-    #   Rails::Secrets.parse([Pathname.new('config/secrets.yml')], env: 'development')
-    #
-    # Example secrets.yml structure:
-    #   shared:
-    #     common_key: shared_value
+    # Examples:
+    #   # Single file
+    #   Rails::Secrets.parse(['config/secrets.yml'], env: 'development')
     #   
-    #   development:
-    #     secret_key_base: dev_secret
-    #     api_key: dev_api_key
+    #   # Multiple files (merged in order)
+    #   Rails::Secrets.parse([
+    #     'config/secrets.yml',
+    #     'config/secrets.local.yml'
+    #   ], env: 'development')
     #   
-    #   production:
-    #     secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
-    #     api_key: <%= ENV["API_KEY"] %>
-    #
+    #   # Load default config/secrets.yml
+    #   Rails::Secrets.load  # uses current Rails.env
+    #   Rails::Secrets.load(env: 'production')
     def parse(paths, env:)
       Secvault::Secrets.parse(paths, env: env.to_s)
     end
     
-    # Convenience method to parse the default secrets file
-    def parse_default(env: Rails.env)
+    # Load secrets from the default config/secrets.yml file
+    def load(env: Rails.env)
       secrets_path = Rails.root.join("config/secrets.yml")
       parse([secrets_path], env: env)
     end
     
-    # Read and parse secrets for the current Rails environment
-    def read(env: Rails.env)
-      parse_default(env: env)
-    end
+    # Backward compatibility aliases (deprecated)
+    alias_method :parse_default, :load
+    alias_method :read, :load
   end
 end
 

data/lib/secvault/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Secvault
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/lib/secvault.rb

@@ -44,7 +44,8 @@ loader.setup
 # ## Usage:
 #   Rails.application.secrets.api_key
 #   Rails.application.secrets.oauth_settings[:google_client_id]
-#   Rails::Secrets.parse_default(env: 'development')
+#   Rails::Secrets.load(env: 'development')  # Load default config/secrets.yml
+#   Rails::Secrets.parse(['custom.yml'], env: Rails.env)  # Parse custom files
 #
 # ## Getting Started:
 #   1. Create config/secrets.yml with your secrets

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secvault
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Unnikrishnan KP