secvault 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d7d1404f42246f62cbc8349ab689b43e8f24fa0ea52dd0e10910dee9615dcc
-  data.tar.gz: 4453d7ebce5a81e9e5fe0ed1dcd0df410a442ff669dd8dde02c15c3db3209a2e
+  metadata.gz: 243d63e08d1e0efc90840322ebe46d547a6733829e4cde6f009dcaee457fb141
+  data.tar.gz: 0c927adb97f3fdfa9e4680d59825b50b2741b11cb8131c1e61b0eca42dec75fb
 SHA512:
-  metadata.gz: c11facd4f7abd26f8ecc9bbccabf0ede865210e220a944aee8e4640cd7851237db2c3bebeba2bc9ddee96a5fe52fa70c324f9b3f5aee4e9a09378ebf2703c91a
-  data.tar.gz: f01237875bb61dac4a8e145adeb05c36813937f72a9d4af85c3ae6e5069c02e0df9efd4df7e1f30dee9263fc69543eb04ebbb2a6998b29a30fbced84702ada90
+  metadata.gz: 0abb15b103100f8205b1ec4c7890d51b9ad8d8c0f55d8d96e1f55b0e85b6d0ade146c382c32e187bfb2c952d02a3fc940ee33b9c6f9beabe598b7773e9cf9fa9
+  data.tar.gz: 12edf2aad07063edb1d4385bedcc8899d388eefef26499671cdddf2bc37c67bfeec39fc08729e09e19c63c04021f28642276f81354b1729a7e08940b5a47fcc9

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 ## [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
+
+- **Removed all rake tasks** - Ultimate simplicity! No more `rake secvault:setup`, `rake secvault:edit`, or `rake secvault:show`
+- Removed `lib/secvault/tasks.rake` file entirely
+- Removed rake task loading from railtie
+
+### Changed
+
+- **Ultra-simple setup**: Just create `config/secrets.yml` with any text editor
+- Updated README to reflect manual file creation instead of rake tasks
+- Updated module documentation to show simple 3-step process
+- Cleaner railtie without task loading complexity
+
+### Benefits
+
+- **Zero dependencies on rake tasks** - works with just plain YAML files
+- **Even simpler** - no commands to remember, just edit YAML files
+- **More intuitive** - developers already know how to create and edit YAML files
+- **Less code** - removed unnecessary complexity
+
+### Tested
+
+- ✅ Rails 7.1 integration works perfectly
+- ✅ Rails 8.0 automatic setup works perfectly
+- ✅ No rake task conflicts or errors
+
 ## [2.0.0] - 2025-09-22
 
 ### BREAKING CHANGES

data/README.md

@@ -21,11 +21,11 @@ bundle install
 ## Quick Start (Rails 7.2+)
 
 ```bash
-# 1. Create secrets.yml with rake task
-rake secvault:setup
+# 1. Create secrets.yml
+touch config/secrets.yml
 
-# 2. Edit secrets
-rake secvault:edit
+# 2. Edit with your favorite editor
+$EDITOR config/secrets.yml
 ```
 
 **Usage in your app:**
@@ -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,16 +98,10 @@ 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
 ```
 
-## Available Commands
-
-```bash
-rake secvault:setup    # Create plain secrets.yml file
-rake secvault:edit     # Edit secrets.yml file
-rake secvault:show     # Display secrets.yml content
-```
 
 ## Security
 

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/railtie.rb

@@ -13,18 +13,17 @@ module Secvault
     # Ensure initialization happens early in all environments
     config.before_configuration do |app|
       secrets_path = app.root.join("config/secrets.yml")
-      key_path = app.root.join("config/secrets.yml.key")
       
       if secrets_path.exist? && !Rails.application.respond_to?(:secrets)
         # Early initialization for test environment compatibility
         current_env = ENV['RAILS_ENV'] || 'development'
-        secrets = Secvault::Secrets.read_secrets(secrets_path, key_path, current_env)
+        secrets = Secvault::Secrets.read_secrets(secrets_path, current_env)
         
         if secrets
           Rails.application.define_singleton_method(:secrets) do
             @secrets ||= begin
               current_secrets = ActiveSupport::OrderedOptions.new
-              env_secrets = Secvault::Secrets.read_secrets(secrets_path, key_path, Rails.env)
+              env_secrets = Secvault::Secrets.read_secrets(secrets_path, Rails.env)
               current_secrets.merge!(env_secrets) if env_secrets
               current_secrets
             end
@@ -33,12 +32,5 @@ module Secvault
       end
     end
 
-    generators do
-      require "secvault/generators/secrets_generator"
-    end
-
-    rake_tasks do
-      load "secvault/tasks.rake"
-    end
   end
 end

data/lib/secvault/version.rb

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

data/lib/secvault.rb

@@ -44,12 +44,13 @@ 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
 #
-# ## Rake Tasks:
-#   rake secvault:setup    # Create plain secrets.yml file
-#   rake secvault:edit     # Edit secrets.yml file
-#   rake secvault:show     # Display secrets.yml content
+# ## Getting Started:
+#   1. Create config/secrets.yml with your secrets
+#   2. Use Rails.application.secrets.your_secret in your app
+#   3. For production, use environment variables with ERB syntax
 #
 # @see https://github.com/unnitallman/secvault
 module Secvault

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: secvault
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Unnikrishnan KP
@@ -60,8 +60,8 @@ files:
 - lib/secvault/railtie.rb
 - lib/secvault/secrets.rb
 - lib/secvault/secrets_helper.rb
-- lib/secvault/tasks.rake
 - lib/secvault/version.rb
+- secvault-2.0.0.gem
 - sig/secvault.rbs
 homepage: https://github.com/unnitallman/secvault
 licenses:

data/lib/secvault/tasks.rake

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require "securerandom"
-
-namespace :secvault do
-  desc "Create a plain YAML secrets.yml file"
-  task setup: :environment do
-    secrets_path = Rails.root.join("config/secrets.yml")
-
-    if secrets_path.exist?
-      puts "Secrets file already exists at #{secrets_path}"
-    else
-      default_content = <<~YAML
-        # Plain YAML secrets file
-        # Environment-specific secrets for your Rails application
-        #
-        # For production, use environment variables with ERB syntax:
-        # production:
-        #   api_key: <%= ENV['API_KEY'] %>
-
-        development:
-          secret_key_base: #{SecureRandom.hex(64)}
-          # Add your development secrets here
-          # api_key: dev_key
-          # database_password: dev_password
-
-        test:
-          secret_key_base: #{SecureRandom.hex(64)}
-          # Add your test secrets here
-          # api_key: test_key
-
-        production:
-          secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
-          # Use environment variables for production secrets
-          # api_key: <%= ENV["API_KEY"] %>
-          # database_password: <%= ENV["DATABASE_PASSWORD"] %>
-      YAML
-
-      File.write(secrets_path, default_content)
-      puts "✅ Created plain secrets.yml file at #{secrets_path}"
-      puts "⚠️  Remember to add production secrets as environment variables"
-      puts "⚠️  Never commit production secrets to version control"
-    end
-  end
-
-  desc "Edit the plain YAML secrets.yml file"
-  task edit: :environment do
-    secrets_path = Rails.root.join("config/secrets.yml")
-
-    unless secrets_path.exist?
-      puts "Secrets file doesn't exist. Run 'rake secvault:setup' first."
-      exit 1
-    end
-
-    # Open the plain YAML file in editor
-    editor = ENV["EDITOR"] || "vi"
-    system("#{editor} #{secrets_path}")
-    puts "📝 Updated #{secrets_path}"
-  end
-
-  desc "Show the plain YAML secrets.yml content"
-  task show: :environment do
-    secrets_path = Rails.root.join("config/secrets.yml")
-
-    unless secrets_path.exist?
-      puts "Secrets file doesn't exist. Run 'rake secvault:setup' first."
-      exit 1
-    end
-
-    puts "📄 Contents of #{secrets_path}:"
-    puts "#{'=' * 50}"
-    puts File.read(secrets_path)
-    puts "#{'=' * 50}"
-  end
-end