secvault 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1feb00404603d98e5aa714c5d3eeeab9821c16922da68196b394166c96180869
-  data.tar.gz: 1d1b3c9db92ab5eae322e3803294eb689f81064a8625f16ea2d24d78bbdafc9d
+  metadata.gz: 4516ca420928dd1fba6fbdd3a5b1a7def3068872f6b8a1f8ac82aac987405af0
+  data.tar.gz: 1a252a86fc1552b3c989a3d9a3ecee78fa11b14ef4989040e6d2c28f7c16819c
 SHA512:
-  metadata.gz: f74172837da3d461a3022574678b79ff322afb0cfa87bab3f5c09ddac4d5eff508fa573b67fe15571122c93ec62611f23405117ec2e33092fe1d61a1ad615ab1
-  data.tar.gz: 353b087160697768744a51a1404bf30f2c8b1e7ca22e9d95c833088b003a44fb0e897f03f57dd1df780c193e2f8c81b0a5b41323a23d2ea10730de1599cad817
+  metadata.gz: fa4565bff45f90436ae9255df05282e577dead6bfbcd7c6bda821e687d91d47b07ad7bb99ea113b63c23b1b2e79f1307cdafb46be515d04f632d656e24b0c803
+  data.tar.gz: c241e60c7334f8f9c589f3151c78a75f9c9a053e849e5c5820de71d5db053fbced5b507aec5411b703c7c01dff5688393068223947719e09593a974f229862a9

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 ## [Unreleased]
 
+## [1.0.4] - 2025-09-22
+
+### Added
+
+- Comprehensive Rails 7.1 integration support
+- New `Secvault.setup_rails_71_integration!` helper method for easy Rails 7.1 setup
+- Enhanced documentation with Rails 7.1 integration guide
+- Module-level documentation with usage examples and version compatibility
+
+### Improved
+
+- Better Rails 7.1 compatibility with automatic detection and setup
+- Enhanced README with Rails 7.1 integration section
+- Improved error handling and logging for Rails 7.1 integration
+- More comprehensive inline documentation
+
+### Changed
+
+- Refined automatic setup logic to avoid conflicts with Rails 7.1 native functionality
+- Updated gemspec description to include Rails 7.1+ support
+
+## [1.0.3] - 2025-09-22
+
+### Fixed
+
+- Rails 7.1 compatibility issues with native Rails::Secrets conflicts
+- String path handling in parse method
+- Zeitwerk constant name mismatch resolution
+
+### Added
+
+- Manual setup method for Rails 7.1 (opt-in)
+- Rails version detection for automatic setup decisions
+- Only create Rails::Secrets alias for Rails 7.2+ to avoid conflicts
+
+## [1.0.2] - 2025-09-22
+
+### Changed
+
+- Updated Rails dependency from >= 7.2.0 to >= 7.1.0 for broader compatibility
+- Updated gem description to include Rails 7.1+ support
+
+## [1.0.1] - 2025-09-22
+
+### Fixed
+
+- Zeitwerk constant name mismatch in rails_secrets.rb
+- Changed module definition from Rails::Secrets to Secvault::RailsSecrets
+- Added Rails::Secrets alias for backward compatibility
+- Resolved Zeitwerk::NameError when loading Rails applications
+
 ## [1.0.0] - 2025-09-22
 
 ### Added

data/README.md

@@ -29,6 +29,12 @@ And then execute:
 $ bundle install
 ```
 
+### Rails Version Compatibility
+
+- **Rails 7.2+**: Automatic setup, drop-in replacement for removed secrets functionality
+- **Rails 7.1**: Manual setup required (see Rails 7.1 Integration section below)
+- **Rails 8.0+**: Full compatibility
+
 ## Setup
 
 ### 1. Generate secrets file
@@ -147,6 +153,69 @@ ENV RAILS_SECRETS_KEY=your_encryption_key
 | `rake secvault:edit` | Edit the encrypted secrets file |
 | `rake secvault:show` | Display decrypted secrets content |
 
+## Rails 7.1 Integration
+
+For Rails 7.1 applications, Secvault provides a simple integration method to replace the native Rails::Secrets functionality and test Secvault before upgrading to Rails 7.2+.
+
+### Quick Setup (Recommended)
+
+Add this to `config/initializers/secvault.rb`:
+
+```ruby
+# config/initializers/secvault.rb
+Secvault.setup_rails_71_integration!
+```
+
+That's it! This single line will:
+- Override native Rails::Secrets with Secvault implementation
+- Replace Rails.application.secrets with Secvault functionality
+- Load secrets from config/secrets.yml automatically
+
+### Manual Setup (Advanced)
+
+If you prefer more control, you can set it up manually:
+
+```ruby
+# config/initializers/secvault.rb
+module Rails
+  remove_const(:Secrets) if defined?(Secrets)
+  Secrets = Secvault::RailsSecrets
+end
+
+Rails.application.config.after_initialize do
+  secrets_path = Rails.root.join("config/secrets.yml")
+  
+  if secrets_path.exist?
+    loaded_secrets = Rails::Secrets.parse([secrets_path], env: Rails.env)
+    secrets_object = ActiveSupport::OrderedOptions.new
+    secrets_object.merge!(loaded_secrets)
+    
+    Rails.application.define_singleton_method(:secrets) do
+      secrets_object
+    end
+  end
+end
+```
+
+### Rails 7.1 Benefits
+
+✅ **Test before upgrading**: Validate Secvault works with your secrets  
+✅ **Zero code changes**: Existing Rails 7.1 code continues to work  
+✅ **Smooth migration**: Gradual transition to Rails 7.2+  
+✅ **Full compatibility**: All Rails.application.secrets functionality preserved  
+
+### Example Rails 7.1 Usage
+
+```ruby
+# Works exactly like native Rails 7.1
+Rails.application.secrets.api_key
+Rails.application.secrets.oauth_settings[:google_client_id]
+
+# Plus enhanced Secvault functionality
+Rails::Secrets.parse_default(env: 'development')
+Rails::Secrets.parse([custom_path], env: Rails.env)
+```
+
 ## Migration from Rails < 7.2
 
 If you're upgrading from an older Rails version that had `secrets.yml`:

data/lib/secvault/version.rb

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

data/lib/secvault.rb

@@ -12,6 +12,42 @@ require_relative "secvault/version"
 loader = Zeitwerk::Loader.for_gem
 loader.setup
 
+# Secvault - Enhanced secrets management for Rails
+# 
+# Secvault restores the classic Rails secrets.yml functionality that was removed 
+# in Rails 7.2, allowing you to manage encrypted secrets using the familiar 
+# YAML-based approach.
+#
+# ## Rails Version Support:
+# - Rails 7.1: Requires manual setup (see Rails 7.1 integration guide)
+# - Rails 7.2+: Automatic setup, drop-in replacement for removed functionality
+# - Rails 8.0+: Full compatibility
+#
+# ## Rails 7.1 Integration:
+# For Rails 7.1 apps, add this initializer to override native Rails::Secrets:
+#
+#   # config/initializers/secvault.rb
+#   module Rails
+#     remove_const(:Secrets) if defined?(Secrets)
+#     Secrets = Secvault::RailsSecrets
+#   end
+#
+#   Rails.application.config.after_initialize do
+#     secrets_path = Rails.root.join("config/secrets.yml")
+#     if secrets_path.exist?
+#       loaded_secrets = Rails::Secrets.parse([secrets_path], env: Rails.env)
+#       secrets_object = ActiveSupport::OrderedOptions.new
+#       secrets_object.merge!(loaded_secrets)
+#       Rails.application.define_singleton_method(:secrets) { secrets_object }
+#     end
+#   end
+#
+# ## Usage:
+#   Rails.application.secrets.api_key
+#   Rails.application.secrets.oauth_settings[:google_client_id]
+#   Rails::Secrets.parse_default(env: 'development')
+#
+# @see https://github.com/unnitallman/secvault
 module Secvault
   class Error < StandardError; end
   class MissingKeyError < Error; end
@@ -25,6 +61,51 @@ module Secvault
     require "secvault/railtie"
     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.
+  #
+  # Usage in an initializer:
+  #   Secvault.setup_rails_71_integration!
+  #
+  # 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!
+    # Override native Rails::Secrets
+    if defined?(Rails::Secrets)
+      Rails.send(:remove_const, :Secrets)
+    end
+    Rails.const_set(:Secrets, Secvault::RailsSecrets)
+    
+    # Set up Rails.application.secrets replacement
+    Rails.application.config.after_initialize do
+      secrets_path = Rails.root.join("config/secrets.yml")
+      
+      if secrets_path.exist?
+        # Load secrets using Secvault
+        loaded_secrets = Rails::Secrets.parse([secrets_path], env: Rails.env)
+        
+        # Create ActiveSupport::OrderedOptions object for compatibility
+        secrets_object = ActiveSupport::OrderedOptions.new
+        secrets_object.merge!(loaded_secrets)
+        
+        # Replace Rails.application.secrets
+        Rails.application.define_singleton_method(:secrets) do
+          secrets_object
+        end
+        
+        # Log integration success (except in production)
+        unless Rails.env.production?
+          Rails.logger&.info "[Secvault] Rails 7.1 integration complete. Loaded #{loaded_secrets.keys.size} secret keys."
+        end
+      else
+        Rails.logger&.warn "[Secvault] No secrets.yml file found at #{secrets_path}"
+      end
+    end
+  end
 end
 
 Secvault.install! if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secvault
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Unnikrishnan KP
@@ -62,8 +62,6 @@ files:
 - lib/secvault/secrets_helper.rb
 - lib/secvault/tasks.rake
 - lib/secvault/version.rb
-- secvault-1.0.1.gem
-- secvault-1.0.2.gem
 - sig/secvault.rbs
 homepage: https://github.com/unnitallman/secvault
 licenses: