visual-environments 0.1.1

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Zachery Moneypenny, David van Leeuwen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,85 @@
+= visual-environments
+
+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, 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.
+
+== Install & Configuration
+
+Add the following to your Rails app Gemfile
+
+	gem 'visual-environments'
+	
+...and run <tt>bundle install</tt>.  Then use the visual-environments generator to install the configuration file to your <tt>config/initializers</tt> directory:
+
+ rails g visual_environments:install
+
+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
+
+	# By default, the corner banner is disabled
+	ActionController::Base::VisualEnvironments.enable_env_in_corner_banner = false
+	# By default, if the corner banner is enabled it is shown on the right side of the page.  For
+	# those pages where it would be better for it to reside in the upper-left corner, uncomment
+	# the line below and change the argument to :left.  Current possible values are (:right, :left)
+	# 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 = []
+	
+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. 
+
+=== Excluding Environments
+
+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']
+	
+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, for example, you can edit your Gemfile thusly:
+
+	gem 'visual-evironments', :groups => [:development, :staging]
+	
+=== Changing the Side of the Banner
+
+The corner banner is displayed in the upper-right corner of the screen by default.  Some sites, however, may be designed such that a banner in that area would hamper functionality (by covering links, for example).  In that case you can switch the banner to the left side by uncommenting and setting the following line in <tt>config/initializers/visual-environments.rb</tt>:
+
+	ActionController::Base::VisualEnvironments.corner_banner_side = :right
+	
+=== Aliasing Environment Names
+
+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:
+
+	ActionController::Base::VisualEnvironments.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
+ 
+* 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
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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 (c) 2011 Zachery Moneypenny, David van Leeuwen. See LICENSE.txt for
+further details.  
+
+Big Ups to the Mad-Railers for their idea for this gem! If you're coding Ruby/Rails in the Madison, Wisconsin area search for MadRailers on meetup.com or check out the Google Group at http://groups.google.com/group/Mad-Railers
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "visual-environments"
+  gem.homepage = "http://github.com/madrailers/visual-environments"
+  gem.license = "MIT"
+  gem.summary = %Q{Automatic visual, in-browser cues about your current environment}
+  gem.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.}
+  gem.email = "whazzmaster@gmail.com"
+  gem.authors = ["Zachery Moneypenny, David van Leeuwen"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "visual-environments #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/generators/visual_environments/USAGE

@@ -0,0 +1,2 @@
+Usage:
+  rails generate visual-environments:install

data/lib/generators/visual_environments/install_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/base'
+
+module VisualEnvironments
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+    
+      def copy_initializer_file
+        copy_file File.expand_path("../templates/initializer.rb", __FILE__), "config/initializers/visual-environment.rb"
+      end
+
+      def self.banner
+        "rails generate visual-environments:install"
+      end
+
+      private
+
+      def add_gem(name, options = {})
+        gemfile_content = File.read(destination_path("Gemfile"))
+        File.open(destination_path("Gemfile"), 'a') { |f| f.write("\n") } unless gemfile_content =~ /\n\Z/
+        gem name, options unless gemfile_content.include? name
+      end
+
+      def print_usage
+        self.class.help(Thor::Base.shell.new)
+        exit
+      end
+  
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+ActionController::Base::VisualEnvironments.enable_env_in_title = true
+
+# By default, the corner banner is disabled
+ActionController::Base::VisualEnvironments.enable_env_in_corner_banner = false
+# By default, if the corner banner is enabled it is shown on the right side of the page.  For
+# those pages where it would be better for it to reside in the upper-left corner, uncomment
+# the line below and change the argument to :left.  Current possible values are (:right, :left)
+# 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 = []

data/lib/visual-environments.rb

@@ -0,0 +1,38 @@
+class ActionController::Base
+  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
+        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
+    
+      if VisualEnvironments.enable_env_in_corner_banner 
+        shim = ""
+        # By default the banner will be on the right side
+        if VisualEnvironments.corner_banner_side.nil? || VisualEnvironments.corner_banner_side == :right
+          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><style>#VisualEnvironment_corner{position:absolute;top:20px;right:-35px;font-family:Verdana;font-size:10px;color:#fff;padding:9px;width:120px;text-align:center;background:#000;border:#fff 1px solid;filter:alpha(opacity=70);-moz-opacity:0.7;-khtml-opacity:0.7;opacity:0.7;-webkit-transform:rotate(45deg);-moz-transform:rotate(45deg);}#VisualEnvironment_container{position:absolute;top:0;right:0;width:120px;height:93px;overflow:hidden;}</style></body>"
+        elsif VisualEnvironments.corner_banner_side == :left
+          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><style>#VisualEnvironment_corner{position:absolute;top:20px;left:-35px;font-family:Verdana;font-size:10px;color:#fff;padding:9px;width:120px;text-align:center;background:#000;border:#fff 1px solid;filter:alpha(opacity=70);-moz-opacity:0.7;-khtml-opacity:0.7;opacity:0.7;-webkit-transform:rotate(-45deg);-moz-transform:rotate(-45deg);}#VisualEnvironment_container{position:absolute;top:0;left:0;width:120px;height:93px;overflow:hidden;}</style></body>"
+        end
+        response.body = response.body.gsub /\<\/body\>/, shim
+      end  
+      
+      
+    end
+  end
+  
+  module VisualEnvironments
+    class << self
+      attr_accessor :enable_env_in_title, :enable_env_in_corner_banner
+      attr_accessor :corner_banner_side
+      attr_accessor :aliases
+      attr_accessor :excluded_environments 
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+# require 'visual-environments'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/visual-environments_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "VisualEnvironments" do
+  
+  # Need to describe a way to test this without loading all of rails
+  
+end

data/visual-environments.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{visual-environments}
+  s.version = "0.1.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-20}
+  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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/visual_environments/USAGE",
+    "lib/generators/visual_environments/install_generator.rb",
+    "lib/generators/visual_environments/templates/initializer.rb",
+    "lib/visual-environments.rb",
+    "spec/spec_helper.rb",
+    "spec/visual-environments_spec.rb",
+    "visual-environments.gemspec"
+  ]
+  s.homepage = %q{http://github.com/madrailers/visual-environments}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Automatic visual, in-browser cues about your current environment}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/visual-environments_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: visual-environments
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Zachery Moneypenny, David van Leeuwen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-20 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: 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.
+email: whazzmaster@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/generators/visual_environments/USAGE
+- lib/generators/visual_environments/install_generator.rb
+- lib/generators/visual_environments/templates/initializer.rb
+- lib/visual-environments.rb
+- spec/spec_helper.rb
+- spec/visual-environments_spec.rb
+- visual-environments.gemspec
+has_rdoc: true
+homepage: http://github.com/madrailers/visual-environments
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1131257249515580422
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Automatic visual, in-browser cues about your current environment
+test_files: 
+- spec/spec_helper.rb
+- spec/visual-environments_spec.rb