secvault 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c2c9db7124c8ac60bf772bcb42c1367f9e5a25a72c977aecc717da47ec401e8
-  data.tar.gz: a8a46d584bf49e2ec7ca1bbfc9609c64b25642406a55efaf79f7f8e5eeeccbba
+  metadata.gz: 441940b63b8d897f1ad3b84bf43168d20dcbf62017a604e201538cee0315a7ca
+  data.tar.gz: fdd75a75105b0c34efb26096499ec6ffeac7340a170d4f8fcb7188c3f0d4e3db
 SHA512:
-  metadata.gz: 52ffd8869e91255f41bbf5bcba424efa8ccfd2a7ec3227c97a8430cd2a21ecbf816558a966ad68afeff611889085b91af765012a9c1529c27917b56cab9aceab
-  data.tar.gz: 191341590209b60085ad54047813788e3bd809ad84791c7aacca546bbc9870a653ae6c6811bce083b8e187aae9d14f9d3bdb5b6c533b549dda356e917816828d
+  metadata.gz: 14fc56f53ff8729262cb5fa07bf2de96e908d7c4f6b00a1134ea2c86b3a433b220a24b3399ad43e97846cadd0bc79546780a4e0fce5318448497b62d5fba0714
+  data.tar.gz: 3e4c8387fa38263e3bf99436211b3eaadf6b3d7d2aa5ec483cc6b19fc9dcbcb9bd402b9099e800fcc8c6fb9fc09b8281875415fdd90570fbee6625d324706032

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 ## [Unreleased]
 
+## [2.3.0] - 2025-09-22
+
+### Changed
+
+- **Better method naming**: Renamed `setup_rails_71_integration!` to `setup_backward_compatibility_with_older_rails!`
+- **More generic approach**: New method name works for any older Rails version, not just 7.1
+- **Updated documentation**: README now uses "Older Rails Integration" instead of "Rails 7.1 Integration"
+- **Clearer version support**: Documentation now shows "Rails 7.1 and older" for better clarity
+
+### Backward Compatibility
+
+- ✅ **Old method name still works**: `setup_rails_71_integration!` is aliased to the new method
+- ✅ **No breaking changes**: All existing code continues to work
+- ✅ **Updated test apps**: Rails 7.1 test app uses the new, cleaner method name
+
+### Benefits
+
+- **Future-proof naming**: Works for Rails 7.1, 7.0, 6.x, or any version with native secrets
+- **Clearer intent**: Method name clearly indicates it's for backward compatibility
+- **Better documentation**: More generic approach in README and code comments
+- **Maintained compatibility**: Existing users don't need to change anything
+
+## [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

@@ -3,7 +3,7 @@
 Restores the classic Rails `secrets.yml` functionality that was removed in Rails 7.2. Uses simple, plain YAML files for environment-specific secrets management.
 
 **Rails Version Support:**
-- **Rails 7.1**: Manual setup (see Rails 7.1 Integration below)
+- **Rails 7.1 and older**: Manual setup (see Older Rails Integration below)
 - **Rails 7.2+**: Automatic setup
 - **Rails 8.0+**: Full compatibility
 
@@ -51,13 +51,46 @@ production:
   api_key: <%= ENV['API_KEY'] %>
 ```
 
-## Rails 7.1 Integration
+## Advanced Usage
 
-Test Secvault in Rails 7.1 before upgrading to 7.2+:
+**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)
+```
+
+## Older Rails Integration
+
+For Rails versions with existing secrets functionality (like Rails 7.1), use Secvault to test before upgrading:
 
 ```ruby
 # config/initializers/secvault.rb
-Secvault.setup_rails_71_integration!
+Secvault.setup_backward_compatibility_with_older_rails!
 ```
 
 This replaces Rails.application.secrets with Secvault functionality. Your existing Rails 7.1 code works unchanged:
@@ -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.3.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
@@ -64,18 +65,18 @@ module Secvault
     require "secvault/rails_secrets"
   end
   
-  # Helper method to set up Secvault for Rails 7.1 applications
-  # This provides an easy way to integrate Secvault into Rails 7.1 apps
-  # that still have native Rails::Secrets functionality.
+  # Helper method to set up Secvault for older Rails versions
+  # This provides an easy way to integrate Secvault into older Rails apps
+  # that still have native Rails::Secrets functionality (like Rails 7.1).
   #
   # Usage in an initializer:
-  #   Secvault.setup_rails_71_integration!
+  #   Secvault.setup_backward_compatibility_with_older_rails!
   #
   # This will:
   # 1. Override native Rails::Secrets with Secvault implementation
   # 2. Replace Rails.application.secrets with Secvault-powered functionality
   # 3. Load secrets from config/secrets.yml automatically
-  def setup_rails_71_integration!
+  def setup_backward_compatibility_with_older_rails!
     # Override native Rails::Secrets
     if defined?(Rails::Secrets)
       Rails.send(:remove_const, :Secrets)
@@ -108,6 +109,9 @@ module Secvault
       end
     end
   end
+  
+  # Backward compatibility alias
+  alias_method :setup_rails_71_integration!, :setup_backward_compatibility_with_older_rails!
 end
 
 Secvault.install! if defined?(Rails)

metadata

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