rails_app_version 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ceff4b502902ed60d708fd295202078d48fc55a56abbd427b92daed2c5da7ad
-  data.tar.gz: f517710e94b7d97c4e90593f3ca6f9ab9b2351848d3fdb1e2ead54e91aee59a7
+  metadata.gz: 1bad17b9f85b940ae01cd9fe6dad8ef04143eba4780b79259e020339a754bdf6
+  data.tar.gz: 651b75a9acc0c1afae576bcdbea83ef91bda0d4c7a36040dea64e2faac39c7cb
 SHA512:
-  metadata.gz: 656786a178a739b22a45d8e1ec71e013c4dfd121e979726dd9536ff6c90630cfb0152b6585f0b081acdd1eab584a760db21388ff278c490d4c86620ebecd1b95
-  data.tar.gz: e124ff8fb6fdc72478947a215e41865cb93bbb1c08607f74a5d7fffd9f4776964e9566433ac812eecb8a6a187f5288114ff67263dc4f144b5d1284a4c3db2e8a
+  metadata.gz: 1a9c0d991be2a9d744101219b84fe45849ab39337163d516456b98e3f4b76ffdc64cf06e8de69dea1ec38f763dd9175797f04554fc27b0d67f3ea7dc7c6d5884
+  data.tar.gz: 5aeafa9a3363f2fa6cb76b5034e09890385511db3cd6559d2880487cfcc1c2cd2cbefff8a95e5f9ff217722c6f515cd3961ebea0141f61a4fa318a11d38f6a8b

data/README.md

@@ -33,6 +33,14 @@ class AssetManifest
     "/assets/#{path}?v=#{Rails.application.version.to_cache_key}"
   end
 end
+
+# Or in your controller
+
+def index
+  Rails.cache.fetch("index-page#{Rails.application.version.to_cache_key}") do
+    render :index
+  end
+end
 ```
 
 ## Installation
@@ -48,7 +56,7 @@ Then execute:
 ```bash
 $ bundle install
 $ rails app:version:config  # Copies the default configuration file
-$ echo "1.0.0" > VERSION            # Create initial version file
+$ echo "1.0.0" > VERSION    # Create initial version file
 ```
 
 ## Version Management
@@ -61,7 +69,6 @@ The recommended approach is to maintain a `VERSION` file in your application's r
 only the version number:
 
 ```plaintext
-# VERSION
 1.2.3
 ```
 
@@ -128,7 +135,7 @@ Rails.application.version.to_cache_key # => "1-2-3"
 ## Version Headers Middleware
 
 Rails AppVersion includes an optional middleware that adds version and environment information to HTTP response headers.
-This is particularly useful in staging and development environments to verify deployment success and track which version
+This is particularly useful in staging and pre-production environments to verify deployment success and track which version
 of the application is serving requests.
 
 ### Configuring the Middleware
@@ -138,12 +145,7 @@ Enable and configure the middleware in your `config/app_version.yml`:
 ```yaml
 development:
   middleware:
-    enabled: true
-    options:
-      include_revision: true  # Include git revision in headers
-      version_header: X-App-Version
-      environment_header: X-App-Environment
-      revision_header: X-App-Revision
+    enabled: false
 
 staging:
   middleware:
@@ -161,8 +163,7 @@ You can also add the middleware manually in your application configuration:
 # config/application.rb or config/environments/staging.rb
 config.middleware.use RailsAppVersion::AppInfoMiddleware, {
   version_header: 'X-Custom-Version',
-  environment_header: 'X-Custom-Environment',
-  include_revision: true
+  environment_header: 'X-Custom-Environment'
 }
 ```
 
@@ -171,7 +172,7 @@ The middleware will add the following headers to each response:
 - X-App-Version: Current application version, optionally including revision (e.g., "1.2.3" or "1.2.3 (abc123de)")
 - X-App-Environment: Current environment (e.g., "staging")
 
-When `include_revision` is enabled, the version header will include the first 8 characters of the git revision in
+When `show_revision` is enabled, the version header will include the first 8 characters of the git revision in
 parentheses. This provides a quick way to verify both the version and the specific deployment in a single header.
 
 This makes it easy for developers to verify which version is deployed and running in each environment, particularly
@@ -211,39 +212,6 @@ Rails AppVersion supports several version formats:
 Version strings are parsed according to Semantic Versioning principles and maintain compatibility with `Gem::Version`
 for comparison operations.
 
-## Version Headers
-
-Enable version headers in HTTP responses to verify deployments and track running versions:
-
-```yaml
-# config/app_version.yml
-development:
-  middleware:
-    enabled: true
-    options:
-      include_revision: true
-
-staging:
-  middleware:
-    enabled: true
-```
-
-Or add the middleware manually:
-
-```ruby
-# config/application.rb
-config.middleware.use RailsAppVersion::AppInfoMiddleware, {
-  version_header: 'X-App-Version',
-  environment_header: 'X-App-Environment',
-  include_revision: true
-}
-```
-
-Headers added:
-
-- X-App-Version: "1.2.3" (or "1.2.3 (abc123de)" with revision)
-- X-App-Environment: "production"
-
 ## Contributing
 
 We welcome contributions! Here's how you can help:

data/config/app_version.yml

@@ -3,3 +3,8 @@ shared:
   revision: <%= Rails.root.join('REVISION').read.strip rescue (`git rev-parse HEAD`.strip rescue '0') %>
   show_revision: <%= Rails.env.local? %>
   environment: <%= ENV.fetch('RAILS_APP_ENV', Rails.env) %>
+  middleware:
+    enabled: true
+    options:
+      version_header: X-App-Version
+      environment_header: X-App-Environment

data/lib/rails_app_version/app_info_middleware.rb

@@ -4,22 +4,23 @@ module RailsAppVersion
   class AppInfoMiddleware
     DEFAULT_OPTIONS = {
       version_header: "X-App-Version",
-      environment_header: "X-App-Environment",
-      revision_header: "X-App-Revision",
-      include_revision: false
+      environment_header: "X-App-Environment"
     }.freeze
 
     def initialize(app, options = {})
-      @app = app
       @options = DEFAULT_OPTIONS.merge(options)
+      @app = app
     end
 
     def call(env)
+      # Call the next middleware in the chain first
       status, headers, response = @app.call(env)
 
+      # Add our custom headers to the response
       headers[@options[:version_header]] = Rails.application.version.full
       headers[@options[:environment_header]] = Rails.application.env
 
+      # Return the modified response
       [ status, headers, response ]
     end
   end

data/lib/rails_app_version/railtie.rb

@@ -45,9 +45,16 @@ module RailsAppVersion
                       all_configs = ActiveSupport::ConfigurationFile.parse(yaml).deep_symbolize_keys
                       all_configs[:shared]
                     end
-
       @version = RailsAppVersion::Version.create(@app_config[:version], @app_config[:revision])
       @env = ActiveSupport::StringInquirer.new(@app_config.fetch(:environment, Rails.env))
     end
+
+    initializer "middleware" do |app|
+      # Add the middleware to the stack if enabled
+      if @app_config.dig(:middleware, :enabled)
+        options = @app_config.dig(:middleware, :options) || {}
+        app.middleware.insert_before Rails::Rack::Logger, RailsAppVersion::AppInfoMiddleware, **options
+      end
+    end
   end
 end

data/lib/rails_app_version/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RailsAppVersion
-  VERSION = "1.2.0"
+  VERSION = "1.2.2"
 
   class Version < Gem::Version
     attr_reader :major, :minor, :patch, :pre, :revision
@@ -27,7 +27,7 @@ module RailsAppVersion
     end
 
     def short_revision
-      revision&.slice(0, 8)
+      revision.to_s.slice(0, 8)
     end
 
     def prerelease?

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_app_version
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-23 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -81,7 +80,6 @@ metadata:
   source_code_uri: https://github.com/seuros/rails_app_version
   changelog_uri: https://github.com/seuros/rails_app_version/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Get the version of your Rails app
 test_files: []