Add Rails.app_env into Rails::Info

Author: tangrufus

lib/rails/app_env/railtie.rb

@@ -1,10 +1,14 @@
-require_relative "helpers"
-
 module Rails
   module AppEnv
-    class Railtie < ::Rails::Railtie
+    class Railtie < Rails::Railtie
       config.before_configuration do
-        ::Rails.extend(Helpers)
+        Rails.extend(Helpers)
+      end
+
+      config.after_initialize do
+        Rails::Info.property "Application environment" do
+          Rails.app_env
+        end
       end
     end
   end

test/dummy/config/application.rb

@@ -22,5 +22,7 @@ class Application < Rails::Application
     #
     # config.time_zone = "Central Time (US & Canada)"
     # config.eager_load_paths << Rails.root.join("extras")
+
+    config.eager_load = false if config.eager_load.nil?
   end
 end

test/env_helpers.rb

@@ -5,6 +5,8 @@
 module EnvHelpers
   private
 
+  DEFAULT_RAILS_ENV = "development"
+
   def with_rails_env(env, &block)
     Rails.instance_variable_set :@_env, nil
     switch_env "RAILS_ENV", env do

test/rails/app_env/environment_inquirer_test.rb

@@ -1,5 +1,3 @@
-require "minitest/autorun"
-
 class Rails::AppEnv::EnvironmentInquirerTest < ActiveSupport::TestCase
   test "EnvironmentInquirer is a kind of ActiveSupport::EnvironmentInquirer" do
     assert_kind_of ActiveSupport::EnvironmentInquirer, Rails::AppEnv::EnvironmentInquirer.new("foo")

test/rails/app_env/helpers_test.rb

@@ -0,0 +1,104 @@
+require_relative "../../../env_helpers"
+
+module Rails::AppEnv::RailtieTest
+  class HelperTest < ActiveSupport::TestCase
+    include EnvHelpers
+
+    test "Rails.app_env is an instance of ActiveSupport::EnvironmentInquirer when APP_ENV is present" do
+      switch_env "APP_ENV", nil do
+        assert_instance_of ActiveSupport::EnvironmentInquirer, Rails.app_env
+      end
+    end
+
+    test "Rails.app_env is a kind of ActiveSupport::EnvironmentInquirer when APP_ENV is blank" do
+      switch_env "APP_ENV", "foo" do
+        assert_kind_of ActiveSupport::EnvironmentInquirer, Rails.app_env
+      end
+    end
+
+    test "Rails.app_env is an instance of Rails::AppEnv::EnvironmentInquirer when APP_ENV is blank" do
+      switch_env "APP_ENV", "foo" do
+        assert_instance_of Rails::AppEnv::EnvironmentInquirer, Rails.app_env
+      end
+    end
+
+    test "Rails.app_env is set from APP_ENV" do
+      switch_env "APP_ENV", "foo" do
+        assert_equal "foo", Rails.app_env
+      end
+    end
+
+    test "Rails.app_env is set from APP_ENV when both APP_ENV are RAILS_ENV present" do
+      switch_env "APP_ENV", "foo" do
+        with_rails_env("bar") do
+          assert_equal "foo", Rails.app_env
+          assert_equal "bar", Rails.env
+        end
+      end
+    end
+
+    test "Rails.app_env is set from APP_ENV when APP_ENV is present but not RAILS_ENV" do
+      switch_env "APP_ENV", "foo" do
+        with_rails_env(nil) do
+          assert_equal "foo", Rails.app_env
+          assert_equal DEFAULT_RAILS_ENV, Rails.env
+        end
+      end
+    end
+
+    test "Rails.app_env falls back to Rails.env when APP_ENV is blank" do
+      switch_env "APP_ENV", nil do
+        with_rails_env("foo") do
+          assert_equal "foo", Rails.app_env
+          assert_equal "foo", Rails.env
+          assert_same Rails.env, Rails.app_env
+        end
+      end
+    end
+
+    test "Rails.app_env falls back to Rails.env when APP_ENV is blank and follow its changes" do
+      switch_env "APP_ENV", nil do
+        with_rails_env("foo") do
+          Rails.env = "bar"
+
+          assert_equal "bar", Rails.app_env
+          assert_equal "bar", Rails.env
+          assert_same Rails.env, Rails.app_env
+        end
+      end
+    end
+
+    test "Rails.app_env falls back to Rails.env when both APP_ENV and RAILS_ENV are blank" do
+      switch_env "APP_ENV", nil do
+        with_rails_env(nil) do
+          assert_equal DEFAULT_RAILS_ENV, Rails.app_env
+          assert_equal DEFAULT_RAILS_ENV, Rails.env
+          assert_same Rails.env, Rails.app_env
+        end
+      end
+    end
+
+    test "Rails.app_env falls back to Rails.env when both APP_ENV and RAILS_ENV are blank and follow its changes" do
+      switch_env "APP_ENV", nil do
+        with_rails_env(nil) do
+          Rails.env = "foo"
+
+          assert_equal "foo", Rails.app_env
+          assert_equal "foo", Rails.env
+          assert_same Rails.env, Rails.app_env
+        end
+      end
+    end
+
+    test "Rails.app_env is set from APP_ENV and does not follow Rails.env changes" do
+      switch_env "APP_ENV", "foo" do
+        with_rails_env("bar") do
+          Rails.env = "baz"
+
+          assert_equal "foo", Rails.app_env
+          assert_equal "baz", Rails.env
+        end
+      end
+    end
+  end
+end

test/rails/app_env/railtie/helpers_test.rb

@@ -0,0 +1,61 @@
+require_relative "../../../env_helpers"
+
+module Rails::AppEnv::RailtieTest
+  class InfoTest < ActiveSupport::TestCase
+    include EnvHelpers
+
+    DUMMY_RAILS = File.expand_path "../../../dummy/bin/rails", __dir__
+
+    test "Rails::Info has 'Application environment' defined" do
+      assert_includes Rails::Info.properties.names, "Application environment"
+    end
+
+    test "rails about command includes 'Application environment' when both APP_ENV and RAILS_ENV are present" do
+      switch_env "APP_ENV", "foo" do
+        with_rails_env("bar") do
+          switch_env "SECRET_KEY_BASE_DUMMY", "1" do
+            stdout, status = Open3.capture2(DUMMY_RAILS, "about")
+
+            assert status.success?
+            assert_match /Application environment\s+foo/, stdout
+          end
+        end
+      end
+    end
+
+    test "rails about command includes 'Application environment' when APP_ENV is present but not RAILS_ENV" do
+      switch_env "APP_ENV", "foo" do
+        with_rails_env(nil) do
+          stdout, status = Open3.capture2(DUMMY_RAILS, "about")
+
+          assert status.success?
+          assert_match /Application environment\s+foo/, stdout
+        end
+      end
+    end
+
+    test "rails about command falls back to use Rails.env as 'Application environment' when APP_ENV is blank" do
+      switch_env "APP_ENV", nil do
+        with_rails_env("foo") do
+          switch_env "SECRET_KEY_BASE_DUMMY", "1" do
+            stdout, status = Open3.capture2(DUMMY_RAILS, "about")
+
+            assert status.success?
+            assert_match /Application environment\s+foo/, stdout
+          end
+        end
+      end
+    end
+
+    test "rails about command falls back to use Rails.env as 'Application environment' when both APP_ENV and RAILS_ENV are blank" do
+      switch_env "APP_ENV", nil do
+        with_rails_env(nil) do
+          stdout, status = Open3.capture2(DUMMY_RAILS, "about")
+
+          assert status.success?
+          assert_match /Application environment\s+development/, stdout # Default Rails environment
+        end
+      end
+    end
+  end
+end