rails_env_local 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d91a33d8b8aa5718c65ce4aed867b5a0d39df3c
-  data.tar.gz: 1860911d7744c0cf5dfdef888539d0c5c48b1dcd
+  metadata.gz: 485eb26768f46bc69496783af8234edc0982b99a
+  data.tar.gz: 338f1c9c6259986f9a5c204475b08f3f1186192a
 SHA512:
-  metadata.gz: 2a6f49e08d571ce7cbc3c267335f909c7818b1a5925ee2729e3f799eb9f81b6806fed720db0ea51d6a927f856a85ada49aaf8408e77ff5c430f29b92199a0891
-  data.tar.gz: a008f8b8d3147c0a4013ddc94eef9b98c7224a06dd8d1623b066af89730134adae592e460193dc268d8bc0af7d5cad016f21dc895830f287d75b2b8052e3a633
+  metadata.gz: 686176257b35842b362bdc9071d9c95dfabbaa29b25c704c953add7afb40c765545aa61d9b2af1ffde0b9e423de28e221532f31fd6301b3ec776f8bfce1d6c90
+  data.tar.gz: 5ca9d515a397bbcc2cb535b682e4c42c361d8b3c69e7e4d38649f633dd7e1e09d336f02fbae1646732e16d4bb5d2a887227a846264e86aadbf7f59b0d9aa280f

data/README.md

@@ -6,6 +6,22 @@
 
 ... But are you going to write specs for code in your `config/boot.rb` file?  Really?
 
+
+| Project                 |  FlagShihTzu      |
+|------------------------ | ----------------- |
+| gem name                |  rails_env_local    |
+| license                 |  MIT              |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/rails_env_local.png)](http://badge.fury.io/rb/rails_env_local) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/rails_env_local.png)](https://gemnasium.com/pboling/rails_env_local) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/rails_env_local.png)](https://codeclimate.com/github/pboling/rails_env_local) |
+| inline documenation     |  [![Inline docs](http://inch-ci.org/github/pboling/rails_env_local.png)](http://inch-ci.org/github/pboling/rails_env_local) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/rails_env_local.png?branch=master)](https://travis-ci.org/pboling/rails_env_local) |
+| homepage                |  [on github](https://github.com/pboling/rails_env_local) |
+| documentation           |  [on rdoc.info](http://rdoc.info/github/pboling/rails_env_local/frames) |
+| author                  |  [Peter Boling](https://coderbits.com/pboling) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  always |
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -43,39 +59,57 @@ This gem can should work with any version of Rails that uses `Rails.env`, but it
 
 This gem is tested with Ruby 2.2-latest and 2.3-latest.  It should work with any version of Ruby that supports both Ruby 1.9 hashes and double splat arguments.
 
+## Theory
+
+### Q: Why not just "local"?
+
+A: It is too generic.  "local" is often used in the same ordinal position as, but with a different meaning than, the environment name.  For one example of this see: https://github.com/bkeepers/dotenv#multiple-rails-environments
+
+### Q: Why not just hand roll this when you need it?  Only a few lines of code.
+
+A: Doing it right requires remembering a number of things that are easily forgotten since this is a set it and forget it type configuration.  If you don't start a new project every week, you may lose details on how to properly override the RAILS_ENV for local development (e.g. you may forget that naming it "local" is a bad idea and consequently break the `dotenv` gem).  Also if you have a large team you may not want to force them all to add an `export RAILS_ENV=localdev` statement to their shell profile.
+
+### Q: Using this gem takes over the "development" environment namespace to be something else, so it precludes using "development" as a deployed environment. 
+
+A: Yeah, pretty much.  Name your deployed environment "dev", "develop", or "anything_else".  Naming your deployed environment "development", when "development" is universally understood to be local development in Rails, is a recipe for confusion.
+
 ### Options:
 
 #### `environment`
   * Type: a string
-  * Default: `"local"`
+  * Default: `"localdev"`
   * Effect: Sets the Rails environment (`Rails.env`) to the given string
   * Example:
-    
-        RailsEnvLocal.set_local_environment(environment: "panda")
+```ruby
+    RailsEnvLocal.set_local_environment(environment: "panda")
+```
 
 #### `verbose`
   * Type: boolean
   * Default: `false`
   * Effect: Prints the environment to `STDOUT` as it is being set
   * Example:
-
-        RailsEnvLocal.set_local_environment(verbose: true)
+```ruby
+    RailsEnvLocal.set_local_environment(verbose: true)
+```
 
 #### `set_rack_env`
   * Type: boolean
   * Default: `true`
   * Effect: In addition to setting `Rails.env`, will set `ENV["RAILS_ENV"]` to match `Rails.env`
   * Example:
-
-        RailsEnvLocal.set_local_environment(set_rack_env: false)
+```ruby
+    RailsEnvLocal.set_local_environment(set_rack_env: false)
+```
 
 #### `set_rails_env`
   * Type: boolean
   * Default: `true`
   * Effect: In addition to setting `Rails.env`, will set `ENV["RACK_ENV"]` to match `Rails.env`
   * Example:
-
-        RailsEnvLocal.set_local_environment(set_rails_env: false)
+```ruby
+    RailsEnvLocal.set_local_environment(set_rails_env: false)
+```
 
 ## Development
 
@@ -125,4 +159,4 @@ spec.add_dependency 'rails_env_local', '~> 0.1'
 [pvc]: http://docs.rubygems.org/read/chapter/16#page74
 [railsbling]: http://www.railsbling.com
 [mygithub]: http://github.com/pboling
-[contributors]: https://github.com/pboling/flag_shih_tzu/contributors
+[contributors]: https://github.com/pboling/rails_env_local/contributors

data/lib/rails_env_local.rb

@@ -18,7 +18,7 @@ require "rails"
 #
 # Options:
 #
-#   environment: a string (default is "local")
+#   environment: a string (default is "localdev")
 #     Effect: will set the Rails environment (Rails.env) to the given string
 #     Example: RailsEnvLocal.set_local_environment(environment: "panda")
 #
@@ -35,9 +35,13 @@ require "rails"
 #     Example: RailsEnvLocal.set_local_environment(set_rails_env: false)
 
 module RailsEnvLocal
-  DEVELOPMENT_ENVIRONMENT = "development"
-  def self.set_local_environment(environment: "local", **options)
-    if ENV["RAILS_ENV"] == DEVELOPMENT_ENVIRONMENT || Rails.env == DEVELOPMENT_ENVIRONMENT
+  ORIGINAL_RAILS_DEVELOPMENT_ENVIRONMENT = "development"
+  # Q: Why not just "local"?
+  # A: It is too generic.  "local" is often used in the same ordinal position as, but with a different meaning than,
+  #     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
       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]

data/lib/rails_env_local/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_env_local
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: '"development" is not always the best name for the local environment'