rails_env_local 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 485eb26768f46bc69496783af8234edc0982b99a
-  data.tar.gz: 338f1c9c6259986f9a5c204475b08f3f1186192a
+  metadata.gz: a68badb555149e69a20b383d3e7be6fb11e8d453
+  data.tar.gz: 8e2e0d41b09a066795e6939fa728cd079b868414
 SHA512:
-  metadata.gz: 686176257b35842b362bdc9071d9c95dfabbaa29b25c704c953add7afb40c765545aa61d9b2af1ffde0b9e423de28e221532f31fd6301b3ec776f8bfce1d6c90
-  data.tar.gz: 5ca9d515a397bbcc2cb535b682e4c42c361d8b3c69e7e4d38649f633dd7e1e09d336f02fbae1646732e16d4bb5d2a887227a846264e86aadbf7f59b0d9aa280f
+  metadata.gz: 5281df61c9259be336e531c4becef9796d3d7aa94771f85482c994fb197f4c76e9a927c72565760293abe551d5cff716fc9f3733464d8a3d9d0e6756e0e3c426
+  data.tar.gz: 527bcae1a18bd23388ad048d695ab7655f2df3b9a68b2b79ee3dba74a032fb27ad1c49e780f72773698a9eb56036dcf27746bd89baa5fcefeebb85350d1b5f79

data/README.md

@@ -111,6 +111,15 @@ A: Yeah, pretty much.  Name your deployed environment "dev", "develop", or "anyt
     RailsEnvLocal.set_local_environment(set_rails_env: false)
 ```
 
+#### `force`
+  * Type: boolean
+  * Default: `false`
+  * Effect: Setting `Rails.env`, no matter what, and `RAILS_ENV` / `RACK_ENV` variables according to other options given.
+  * Example:
+```ruby
+    RailsEnvLocal.set_local_environment(force: true)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run a single suite of tests, or run `wwtd` to run all specs like TravisCI would. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rails_env_local.rb

@@ -1,5 +1,6 @@
 require "rails_env_local/version"
 require "rails"
+require "rails_env_local/rails_env"
 
 # Usage:
 #
@@ -33,6 +34,10 @@ require "rails"
 #   set_rails_env: true or false (default is true)
 #     Effect: will additionally set RACK_ENV to match Rails.env
 #     Example: RailsEnvLocal.set_local_environment(set_rails_env: false)
+#
+#   force: true or false (default is false)
+#     Effect: will set Rails.env to environment no matter what.
+#     Example: RailsEnvLocal.set_local_environment(force: true)
 
 module RailsEnvLocal
   ORIGINAL_RAILS_DEVELOPMENT_ENVIRONMENT = "development"
@@ -41,12 +46,31 @@ module RailsEnvLocal
   #     the environment name.  For one example of this see: https://github.com/bkeepers/dotenv#multiple-rails-environments
   ALTERNATE_RAILS_DEVELOPMENT_ENVIRONMENT = "localdev"
   def self.set_local_environment(environment: ALTERNATE_RAILS_DEVELOPMENT_ENVIRONMENT, **options)
-    if ENV["RAILS_ENV"] == ORIGINAL_RAILS_DEVELOPMENT_ENVIRONMENT || Rails.env == ORIGINAL_RAILS_DEVELOPMENT_ENVIRONMENT
+    options = {set_rails_env: true, set_rack_env: true, verbose: false, force: false}.merge(options)
+    if was_development? || was_default? || options[:force]
       Rails.env = environment
-      options = {set_rails_env: true, set_rack_env: true, verbose: false}.merge(options)
       ENV["RAILS_ENV"] = Rails.env if options[:set_rails_env]
       ENV["RACK_ENV"] = Rails.env if options[:set_rack_env]
       puts "switching to custom local development environment: #{environment}" if options[:verbose]
+    elsif [ENV["RAILS_ENV"], ENV["RACK_ENV"], Rails.env].compact.uniq.length > 1
+      msg =  %(ENV["RAILS_ENV"], ENV["RACK_ENV"] and Rails.env are out of sync) if options[:verbose]
+      warn(msg)
+      Rails.logger.error(msg) if Rails.logger
     end
   end
+
+  private
+  def self.environment_variables
+    [ENV["RAILS_ENV"], ENV["RACK_ENV"]]
+  end
+
+  def self.was_development?
+    environment_variables.include?(ORIGINAL_RAILS_DEVELOPMENT_ENVIRONMENT)
+  end
+
+  def self.was_default?
+    environment_variables.compact.empty?
+  end
 end
+
+Rails.singleton_class.send(:prepend, RailsEnvLocal::RailsEnv)

data/lib/rails_env_local/rails_env.rb

@@ -0,0 +1,14 @@
+module RailsEnvLocal
+  # This module is prepended to Rails module
+  module RailsEnv
+    def env
+      result = super
+      if result == "development"
+        msg =  %[WARNING: environment is incorrectly "development". Early access of Rails.env might be the cause, consider moving `RailsEnvLocal.set_local_environment` up in config/boot.rb]
+        warn(msg)
+        Rails.logger.error(msg) if Rails.logger
+      end
+      result
+    end
+  end
+end

data/lib/rails_env_local/version.rb

@@ -1,3 +1,3 @@
 module RailsEnvLocal
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_env_local
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Boling
@@ -123,6 +123,7 @@ files:
 - gemfiles/rails_5_0.gemfile
 - gemfiles/rails_5_0.gemfile.lock
 - lib/rails_env_local.rb
+- lib/rails_env_local/rails_env.rb
 - lib/rails_env_local/version.rb
 - rails_env_local.gemspec
 homepage: https://github.com/pboling/rails_env_local