rails-app_env 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e75a290a83ff554c4a22d5b4de442f067335f7520bf32cac50e1cca8402587
-  data.tar.gz: 1ce34786cc77f55066f68999286290fea50ebdb77ca4067657ca9e56f378bd8d
+  metadata.gz: 68b627e3b58352cf6fdcb39e88bb2de7ace7e6ec73889226ffd66ee479de8c3c
+  data.tar.gz: 9382437f7ad8a5d1fdfe575871914946e7aabe7f1e2832518f388b9bec60d4bb
 SHA512:
-  metadata.gz: bec82722ff90a2fcb647e0c705793f19568b4105bb9c8b1d7836c139e6aca334a77902d74ff5166f1db057c0906c677a517214b5a66c68dc6bed4be1730bc173
-  data.tar.gz: 9cf5d2d52dbe36a1dc98c83239fcfe0a49dfd3f6425b94dd480514e441eb5d15ac466370494f7d0b50afac09ebc3a91d0732ab9f15c200d8de604b7da0235276
+  metadata.gz: 8bb85243784b26e19b41611d80c6026b6219cf23d02b28acd729507512d536f29b18bfed9fa8f1a8449b6444b817b2d7183e7438ac5bf97ffa6d16e6754e342d
+  data.tar.gz: 7b90bf76133badc4f903165bb3abf2e94716f08ac37c55a8ca57ce616e0ea70f46202a48c11b9892e8b7d05e8984fd1a23a0e11a51f74f90b9acde60ed07a0fe

data/README.md

@@ -1,28 +1,148 @@
-# Rails::AppEnv
-Short description and motivation.
+<div align="center">
 
-## Usage
-How to use my plugin.
+# Rails APP_ENV
 
-## Installation
-Add this line to your application's Gemfile:
+[![Gem Version](https://img.shields.io/gem/v/rails-app_env)](https://badge.fury.io/rb/rails-app_env)
+[![CI](https://github.com/typisttech/rails-app_env/actions/workflows/ci.yml/badge.svg)](https://github.com/typisttech/rails-app_env/actions/workflows/ci.yml)
+[![License](https://img.shields.io/github/license/typisttech/rails-app_env.svg)](https://github.com/typisttech/rails-app_env/blob/master/LICENSE.txt)
+[![Follow @TangRufus on X](https://img.shields.io/badge/Follow-TangRufus-15202B?logo=x&logoColor=white)](https://x.com/tangrufus)
+[![Follow @TangRufus.com on Bluesky](https://img.shields.io/badge/Bluesky-TangRufus.com-blue?logo=bluesky)](https://bsky.app/profile/tangrufus.com)
+[![Sponsor @TangRufus via GitHub](https://img.shields.io/badge/Sponsor-TangRufus-EA4AAA?logo=githubsponsors)](https://github.com/sponsors/tangrufus)
+[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-778899)](https://typist.tech/contact/)
+
+<p>
+  <strong>
+    <code>Rails APP_ENV</code> is like <code>RAILS_ENV</code> but for configurations only.
+  </strong>
+  <br>
+  <br>
+  Built with ♥ by <a href="https://typist.tech/">Typist Tech</a>
+</p>
+
+</div>
+
+---
+
+## Quick Start
+
+TODO.
+
+## Why
+
+TODO.
+
+## `RAILS_ENV` vs `APP_ENV`
+
+TODO.
+
+## Features
+
+### `Rails.app_env`
+
+`Rails.app_env` is like [`Rails.env`](https://api.rubyonrails.org/classes/Rails.html#method-c-env) but it is set by the
+`APP_ENV` environment variable (`ENV["APP_ENV"]`).
+
+It is optimization for `staging` and `review` ([the two extra Heroku pipeline stages](https://devcenter.heroku.com/articles/pipelines)),
+so it doesn't need to rely on the slower delegation through `method_missing` that `ActiveSupport::EnvironmentInquirer`
+would normally entail.
 
 ```ruby
-gem "rails-app_env"
+## Assume we booted Rails with `APP_ENV=staging RAILS_ENV=production`
+Rails.app_env # => "staging"
+Rails.app_env.staging? # => true
+Rails.app_env.production? # => false
+Rails.app_env.any_other_predicate? # => false
+
+Rails.env # => "production"
+Rails.env.staging? # => false
+Rails.env.production? # => true
 ```
 
-And then execute:
-```bash
-$ bundle
+In case `ENV["APP_ENV"]` is blank, `Rails.app_env` falls back to `Rails.env`.
+
+### `Rails.application.app_config_for`
+
+`Rails.application.app_config_for` wraps[`Rails.application.config_for`](https://api.rubyonrails.org/classes/Rails/Application.html#method-i-config_for)
+with `{env: Rails.app_env}` as the second argument.
+
+```ruby
+# These two lines are equivalent.
+Rails.application.app_config_for(:foo)
+Rails.application.config_for(:foo, env: Rails.app_env)
+```
+
+### Credentials
+
+`Rails APP_ENV` overrides the default Rails credentials `content_path` and `key_path` according to `Rails.app_env`.
+
+Given the following `*.yml.enc` and `*.key` files under `config/credentials/`, `APP_ENV=staging RAILS_ENV=production`
+would load the credentials from `config/credentials/staging.yml.enc` and `config/credentials/staging.key`.
+
+```console
+$ tree config/credentials
+config/credentials
+├── production.key
+├── production.yml.enc
+├── staging.key
+└── staging.yml.enc
+```
+
+In case `config/credentials/#{Rails.app_env}.yml.enc` does not exist, it falls back to `config/credentials.yml.enc`.
+
+In case `config/credentials/#{Rails.app_env}.key` does not exist, it falls back to `config/master.key`.
+
+As with default Rails behaviours, if `ENV["RAILS_MASTER_KEY"]` is present, it takes precedence over
+`config/credentials/#{Rails.app_env}.key` and `config/master.key`.
+
+As with default Rails behaviours, when invoking `$ rails credentials` commands, specific the `--environment` option
+instead of using `APP_ENV` and `RAILS_ENV`.
+
+```console
+# APP_ENV and RAILS_ENV are ignored.
+$ APP_ENV=foo RAILS_ENV=bar bin/rails credentials:edit --environment qaz
+      create  config/credentials/qaz.key
+      create  config/credentials/qaz.yml.enc
 ```
 
-Or install it yourself as:
+Learn more in the [Heroku](#heroku) section below.
+
+### Console
+
+Whenever Rails console is started, `Rails APP_ENV` prints the current `Rails.app_env` and gem version to the console.
+
+If the `Rails.app_env` differs from `Rials.env`, `Rails APP_ENV` appends `Rails.app_env` to the console prompt.
+
+![rails console](docs/screenshot-rails-console.jpg)
+
+## Heroku
+
+TODO.
+
+## Installation
+
+Install the gem and add to the application's `Gemfile` or `gems.rb` by executing:
+
 ```bash
-$ gem install rails-app_env
+bundle add rails-app_env
 ```
 
-## Contributing
-Contribution directions go here.
+## Prior Art
+
+- [anyway_config](https://github.com/palkan/anyway_config)
+- [config](https://github.com/rubyconfig/config)
+
+## Credits
+
+[`Rails APP_ENV`](https://github.com/typisttech/rails-app_env) is a [Typist Tech](https://typist.tech) project and
+maintained by [Tang Rufus](https://x.com/TangRufus), freelance developer [for hire](https://typist.tech/contact/).
+
+Full list of contributors can be found [on GitHub](https://github.com/typisttech/rails-app_env/graphs/contributors).
+
+## Copyright and License
+
+This project is a [free software](https://www.gnu.org/philosophy/free-sw.en.html) distributed under the terms of
+the MIT license. For the full license, see [LICENSE](LICENSE).
+
+## Contribute
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Feedbacks / bug reports / pull requests are welcome.

data/lib/rails/app_env/application_helpers.rb

@@ -0,0 +1,9 @@
+module Rails
+  module AppEnv
+    module ApplicationHelpers
+      def app_config_for(name)
+        config_for(name, env: Rails.app_env)
+      end
+    end
+  end
+end

data/lib/rails/app_env/console.rb

@@ -0,0 +1,25 @@
+require "rails/commands/console/irb_console"
+
+module Rails
+  module AppEnv
+    class Console < Rails::Console::IRBConsole
+      def colorized_env
+        return super if Rails.env == Rails.app_env
+        super + ":" + colorized_app_env
+      end
+
+      private
+
+      def colorized_app_env
+        case Rails.app_env
+        when "development"
+          IRB::Color.colorize("dev", [:MAGENTA])
+        when "production"
+          IRB::Color.colorize("prod", [:RED])
+        else
+          IRB::Color.colorize(Rails.app_env, [:MAGENTA])
+        end
+      end
+    end
+  end
+end

data/lib/rails/app_env/credentials.rb

@@ -1,7 +1,30 @@
 module Rails
   module AppEnv
     module Credentials
+      class AlreadyInitializedError < Error; end
+
       class << self
+        attr_reader :original
+
+        def initialize!
+          raise AlreadyInitializedError.new "Rails::AppEnv::Credentials has already been initialized." if @initialized
+          @initialized = true
+
+          @original = Rails.application.config.credentials
+          Rails.application.config.credentials = configuration
+
+          monkey_patch_rails_credentials_command!
+        end
+
+        def configuration
+          ActiveSupport::InheritableOptions.new(
+            content_path: content_path,
+            key_path: key_path
+          )
+        end
+
+        private
+
         def content_path
           path = Rails.root.join("config/credentials/#{Rails.app_env}.yml.enc")
           path = Rails.root.join("config/credentials.yml.enc") unless path.exist?
@@ -13,6 +36,10 @@ module Rails
           path = Rails.root.join("config/master.key") unless path.exist?
           path
         end
+
+        def monkey_patch_rails_credentials_command!
+          require_relative "../rails_ext/credentials_command"
+        end
       end
     end
   end

data/lib/rails/app_env/error.rb

@@ -0,0 +1,5 @@
+module Rails
+  module AppEnv
+    class Error < StandardError; end
+  end
+end

data/lib/rails/app_env/rails_helpers.rb

@@ -0,0 +1,9 @@
+module Rails
+  module AppEnv
+    module RailsHelpers
+      def app_env
+        @_app_env ||= EnvironmentInquirer.new(ENV["APP_ENV"] || Rails.env)
+      end
+    end
+  end
+end

data/lib/rails/app_env/railtie.rb

@@ -2,12 +2,13 @@ module Rails
   module AppEnv
     class Railtie < Rails::Railtie
       config.before_configuration do
-        Rails.extend(Helpers)
+        Rails.extend(RailsHelpers)
+        Rails.application.extend(ApplicationHelpers)
       end
 
-      config.before_configuration do |app|
-        app.config.credentials.content_path = Rails::AppEnv::Credentials.content_path
-        app.config.credentials.key_path = Rails::AppEnv::Credentials.key_path
+      config.before_configuration do
+        # TODO: Allow opt-out.
+        Credentials.initialize!
       end
 
       config.after_initialize do
@@ -15,6 +16,13 @@ module Rails
           Rails.app_env
         end
       end
+
+      console do |app|
+        # TODO: Allow opt-out.
+        app.config.console = Console.new(app)
+
+        puts "Loading #{Rails.app_env} application environment (rails-app_env #{Rails::AppEnv::VERSION})" # standard:disable Rails/Output
+      end
     end
   end
 end

data/lib/rails/app_env/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module AppEnv
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rails/app_env.rb

@@ -1,11 +1,13 @@
 require_relative "app_env/version"
-require_relative "app_env/environment_inquirer"
-require_relative "app_env/helpers"
-require_relative "app_env/credentials"
 require_relative "app_env/railtie"
 
 module Rails
   module AppEnv
-    # Your code goes here...
+    autoload :ApplicationHelpers, "rails/app_env/application_helpers"
+    autoload :Console, "rails/app_env/console"
+    autoload :Credentials, "rails/app_env/credentials"
+    autoload :EnvironmentInquirer, "rails/app_env/environment_inquirer"
+    autoload :Error, "rails/app_env/error"
+    autoload :RailsHelpers, "rails/app_env/rails_helpers"
   end
 end

data/lib/rails/rails_ext/credentials_command.rb

@@ -0,0 +1,11 @@
+module Rails
+  module Command
+    class CredentialsCommand
+      private
+
+      def config
+        Rails::AppEnv::Credentials.original
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-app_env
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Typist Tech Limited
@@ -11,19 +11,33 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.2
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.2
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
 email:
 - opensource+swagger_ui_standalone@typist.tech
 - tangrufus@gmail.com
@@ -35,11 +49,15 @@ files:
 - README.md
 - Rakefile
 - lib/rails/app_env.rb
+- lib/rails/app_env/application_helpers.rb
+- lib/rails/app_env/console.rb
 - lib/rails/app_env/credentials.rb
 - lib/rails/app_env/environment_inquirer.rb
-- lib/rails/app_env/helpers.rb
+- lib/rails/app_env/error.rb
+- lib/rails/app_env/rails_helpers.rb
 - lib/rails/app_env/railtie.rb
 - lib/rails/app_env/version.rb
+- lib/rails/rails_ext/credentials_command.rb
 - lib/tasks/rails/app_env_tasks.rake
 homepage: https://github.com/typisttech/rails-app_env
 licenses:
@@ -67,5 +85,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Summary of Rails::AppEnv.
+summary: Rails APP_ENV is like RAILS_ENV but for configurations only.
 test_files: []

data/lib/rails/app_env/helpers.rb

@@ -1,11 +0,0 @@
-module Rails
-  module AppEnv
-    module Helpers
-      def app_env
-        return Rails.env if ENV["APP_ENV"].blank?
-
-        @_app_env ||= EnvironmentInquirer.new(ENV["APP_ENV"])
-      end
-    end
-  end
-end