visual-environments 0.2.1 → 0.3.1

data/README.rdoc

@@ -1,11 +1,18 @@
 = visual-environments
 
-Automatic visual, in-browser cues about your current environment in Rails 3 applications.
+Automatic visual, in-browser cues about your current environment in Rails 3 applications!
 
 If you're a developer accustomed to working across multiple development and staging environments, you have certainly been in the position where you have multiple browser windows/tabs open with the same site but pointing at different environments.  This gem aims to help you keep your contexts straight!
 
 This is a configurable means for showing, via an updated <title> tag or CSS corner banner overlay, what the current runtime environment is (development, staging, test, etc.)  This functionality is never enabled for production, and fully configurable to exclude other environments as well.
 
+== Changelog
+
+	* 5 March, 2011: Changed format of initializer, added ability to alias title and corner banner strings independently, refactored internal structure of the module, updated docs.  This is a NON-BACKWARDS COMPATIBLE update; you must rerun <tt>rails g visual_environments:install</tt> to regenerate a new initializer file and then reset your options.
+	* 27 February, 2011: Updated source_root definition, fixing bug in initializer
+	* 20 February, 2011: Added generator, documented configuration options, added ability to switch corner banner from left to right side
+	* 19 February, 2011: Initial revision- a result of the MadRailers Coding Day!
+
 = Install & Configuration
 
 Add the following to your Rails application's Gemfile
@@ -18,20 +25,31 @@ Add the following to your Rails application's Gemfile
 
 There should now be a new file <tt>config/initializers/visual-environments.rb</tt> with the content
 
-	ActionController::Base::VisualEnvironments.enable_env_in_title = true
-
-	# Uncomment the line below and select which side to display the banner on.  Current possible 
-	# values are (:right, :left) corresponding to upper-right and upper-left corners, respectively
-	# ActionController::Base::VisualEnvironments.corner_banner_side = :right
-
-	# By default, the full environment name is used in the visual cues (development, test, etc.)  You
-	# can map environment names by using the below setting to alias one environment name to another
-	# Example: 'development' -> 'dev' or 'preproduction' -> 'preprod'
-	# ActionController::Base::VisualEnvironments.aliases = { 'development' => 'dev' }
-
-	# By default, the visual-environments will be enabled for all environments except production;
-	# to exclude additional environments, uncomment the line below and add them to the collection
-	# ActionController::Base::VisualEnvironments.excluded_environments = []
+	VisualEnvironments.setup do |config|
+	  # Turns on the display of the current environment in the title tag of each page in the app
+	  config.enable_env_in_title = true
+
+	  # Uncomment he line below and select which side to display the banner on.  Current possible 
+	  # values are (:right, :left) corresponding to upper-right and upper-left corners, respectively
+	  # config.corner_banner_side = :right
+
+	  # By default, the full environment name is used in the visual cues (development, test, etc.)  You
+	  # can map environment names by using the below setting to alias one environment name to another.
+	  # Using the option below configures the alias for both the title tag and the corner banner display;
+	  # if you would like different strings for each area then see the next section.
+	  # Example: 'development' -> 'dev' or 'preproduction' -> 'preprod'
+	  # config.aliases = { 'development' => 'dev' }
+
+	  # You may alternatively declare different aliases for the title tag versus the corner banner
+	  # using the options below.
+	  # config.title_aliases = { 'development' => 'dev' }
+	  # config.corner_banner_aliases = { 'preproduction' => 'preprod' }
+
+	  # By default, the visual-environments will be enabled for all environments except production;
+	  # to exclude additional environments, uncomment the line below and add them to the collection
+	  # config.excluded_environments = []
+	end
+	
 	
 By default, visual environments are enabled in the page title but disabled for corner banner display.  Also, by default only production environments are excluded from the gem functionality. 
 
@@ -39,19 +57,15 @@ By default, visual environments are enabled in the page title but disabled for c
 
 You can add additional environments to be excluded by adding their names to the <tt>excluded_environments</tt> collection.  For example, let's say you have an app with a test-oriented staging environment as well as a 'almost-ready-for-prime-time' preproduction environment.  In this case you may want the visual cues on the staging but not on preproduction.  In that case you can edit the initializer to:
 
-	ActionController::Base::VisualEnvironments.excluded_environments = ['preproduction']
+	config.excluded_environments = ['preproduction']
 	
 And now preproduction will not use the visual-environments functionality.
-
-Another way to configure is by using Gemfile groups to only conditionally load this gem.  For example, if you have many different environments but only want this gem to operate in development and staging you can edit your Gemfile thusly:
-
-	gem 'visual-evironments', :groups => [:development, :staging]
 	
 == Corner Banner & Changing the Side of the Banner
 
 The corner banner is not included by default.  To enable it, choose which side it should be displayed on via the <tt>corner_banner_side</tt> option in <tt>config/initializers/visual-environments.rb</tt>:
 
-	ActionController::Base::VisualEnvironments.corner_banner_side = :right
+	config.corner_banner_side = :right
 
 Valid options are currently <tt>:left</tt> and <tt>:right</tt>, corresponding to the upper-left and upper-right corners, respectively.
 	
@@ -59,13 +73,21 @@ Valid options are currently <tt>:left</tt> and <tt>:right</tt>, corresponding to
 
 Having the string "[development]" prepended to your title may make things a bit unwieldy for some people.  In that case, you may use the aliasing option to change such an identifier to something shorter (but still identifiable with the environment in question).  For example, you can alias 'development' to 'dev' or 'D', which would result in "[dev]" or "[D]" being prepended to the page title.
 
-To add an alias, uncomment and set the <tt>aliases</tt> setting as follows:
+To add an alias that is used both in the title and the banner, uncomment and set the <tt>aliases</tt> setting as follows:
 
-	ActionController::Base::VisualEnvironments.aliases = { 'development' => 'dev', 'preproduction' => 'preprod' }
+	config.aliases = { 'development' => 'dev', 'preproduction' => 'preprod' }
 
 The above example would show use 'dev' in a development environment and 'preprod' in a preproduction environment.  The point is, you can alias any environment you may use, not just the out-of-the-box environments Rails uses (development, test, production).
 
-== Contributing to visual-environments
+You can also set the aliases for ONLY the title or ONLY the corner banner.  For example, I like the full environment used in the banner but like the title identifier to be much shorter:
+
+	config.title_aliases = { 'development' => 'D', 'staging' => 'S' }
+	
+You can do the same to change the alias of the corner banner:
+
+	config.corner_banner_aliases = { 'development' => 'dev', 'preproduction' => 'preprod' }
+
+= Contributing to visual-environments
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -75,7 +97,7 @@ The above example would show use 'dev' in a development environment and 'preprod
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+= Copyright
 
 Copyright (c) 2011 Zachery Moneypenny, David van Leeuwen. See LICENSE.txt for further details.  
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.1

data/lib/generators/visual_environments/install_generator.rb

@@ -9,7 +9,7 @@ module VisualEnvironments
       end
     
       def copy_initializer_file
-        copy_file "initializer.rb", "config/initializers/visual-environment.rb"
+        copy_file "initializer.rb", "config/initializers/visual-environments.rb"
       end
 
       def self.banner

data/lib/generators/visual_environments/templates/initializer.rb

@@ -1,14 +1,24 @@
-ActionController::Base::VisualEnvironments.enable_env_in_title = true
+VisualEnvironments.setup do |config|
+  # Turns on the display of the current environment in the title tag of each page in the app
+  config.enable_env_in_title = true
 
-# Uncomment he line below and select which side to display the banner on.  Current possible 
-# values are (:right, :left) corresponding to upper-right and upper-left corners, respectively
-ActionController::Base::VisualEnvironments.corner_banner_side = :right
+  # Uncomment he line below and select which side to display the banner on.  Current possible 
+  # values are (:right, :left) corresponding to upper-right and upper-left corners, respectively
+  # config.corner_banner_side = :right
 
-# By default, the full environment name is used in the visual cues (development, test, etc.)  You
-# can map environment names by using the below setting to alias one environment name to another
-# Example: 'development' -> 'dev' or 'preproduction' -> 'preprod'
-# ActionController::Base::VisualEnvironments.aliases = { 'development' => 'dev' }
+  # By default, the full environment name is used in the visual cues (development, test, etc.)  You
+  # can map environment names by using the below setting to alias one environment name to another.
+  # Using the option below configures the alias for both the title tag and the corner banner display;
+  # if you would like different strings for each area then see the next section.
+  # Example: 'development' -> 'dev' or 'preproduction' -> 'preprod'
+  # config.aliases = { 'development' => 'dev' }
+  
+  # You may alternatively declare different aliases for the title tag versus the corner banner
+  # using the options below.
+  # config.title_aliases = { 'development' => 'dev' }
+  # config.corner_banner_aliases = { 'preproduction' => 'preprod' }
 
-# By default, the visual-environments will be enabled for all environments except production;
-# to exclude additional environments, uncomment the line below and add them to the collection
-# ActionController::Base::VisualEnvironments.excluded_environments = []
+  # By default, the visual-environments will be enabled for all environments except production;
+  # to exclude additional environments, uncomment the line below and add them to the collection
+  # config.excluded_environments = []
+end

data/lib/visual-environments.rb

@@ -1,13 +1,54 @@
+module VisualEnvironments
+ 
+ # Whether the current environment should be shown in the title tag
+ mattr_accessor :enable_env_in_title
+ @@enable_env_in_title = false
+ 
+ # If non-nil, describes which side of the page the banner should be
+ # displayed on (valid values are :left, :right)
+ mattr_accessor :corner_banner_side
+ @@corner_banner_side = nil
+ 
+ # Allows config to map different strings to the environments displayed
+ # in the title tag
+ mattr_accessor :title_aliases
+ @@title_aliases = {}
+
+ # Allows config to map different strings to the environments displayed
+ # in the corner banner display 
+ mattr_accessor :corner_banner_aliases
+ @@corner_banner_aliases = {}
+ 
+ # A collection of environments that this gem should not operate in
+ mattr_accessor :excluded_environments
+ @@excluded_environments = []
+ 
+ # Use setup with a block to configure the module in an initializer;
+ # run 'rails generate visual_environments:install' to create a default
+ # initializer
+ def self.setup
+   yield self
+ end
+ 
+ # Set the aliases of both the title and the corner
+ # banner to the supplied item
+ def self.aliases=(aliases)
+   @@title_aliases.replace aliases
+   @@corner_banner_aliases.replace aliases
+ end
+
+end
+
 class ActionController::Base
+  include VisualEnvironments
   after_filter :shim_visual_environments  
   
   def shim_visual_environments
     unless Rails.env == 'production' || (VisualEnvironments.excluded_environments && VisualEnvironments.excluded_environments.include?(Rails.env))
       
-      current_env = Rails.env
-      current_env = VisualEnvironments.aliases[current_env] if !VisualEnvironments.aliases.nil? && VisualEnvironments.aliases.has_key?(current_env)
-      
       if VisualEnvironments.enable_env_in_title
+        current_env = Rails.env
+        current_env = VisualEnvironments.title_aliases[current_env] if !VisualEnvironments.title_aliases.nil? && VisualEnvironments.title_aliases.has_key?(current_env)
         shim = "<script type='text/javascript'>var te=document.getElementsByTagName('title')[0];var t=te.innerHTML;te.innerHTML=\"["+current_env+"] \"+t;</script></body>"
         response.body = response.body.gsub /\<\/body\>/, shim
       end
@@ -15,6 +56,8 @@ class ActionController::Base
       unless VisualEnvironments.corner_banner_side.nil?
         # Exit if we detect invalid options in the corner_banner_side option
         return unless [:left,:right].include?(VisualEnvironments.corner_banner_side)
+        current_env = Rails.env
+        current_env = VisualEnvironments.corner_banner_aliases[current_env] if !VisualEnvironments.corner_banner_aliases.nil? && VisualEnvironments.corner_banner_aliases.has_key?(current_env)
         shim = "<script type='text/javascript'>var con=document.createElement('div');con.id='VisualEnvironment_container';document.body.appendChild(con);var ce=document.createElement('div');ce.id='VisualEnvironment_corner';ce.innerHTML='"+current_env+"';con.appendChild(ce);</script>"
         
         if VisualEnvironments.corner_banner_side == :right
@@ -26,16 +69,7 @@ class ActionController::Base
         response.body = response.body.gsub /\<\/body\>/, shim
       end  
       
-      
     end
   end
   
-  module VisualEnvironments
-    class << self
-      attr_accessor :enable_env_in_title
-      attr_accessor :corner_banner_side
-      attr_accessor :aliases
-      attr_accessor :excluded_environments 
-    end
-  end
 end

data/visual-environments.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{visual-environments}
-  s.version = "0.2.1"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zachery Moneypenny, David van Leeuwen"]
-  s.date = %q{2011-02-27}
+  s.date = %q{2011-03-05}
   s.description = %q{This gem provides a configurable means for showing, via an updated <title> tag or CSS corner banner, what the current runtime environment is (development, staging, test, etc.)  This functionality is never enabled for production, and for all other environments you can exclude specific ones.}
   s.email = %q{whazzmaster@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -2,7 +2,7 @@
 name: visual-environments
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Zachery Moneypenny, David van Leeuwen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 -06:00
+date: 2011-03-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 251171772694086353
+      hash: 810695887365503587
       segments: 
       - 0
       version: "0"