RubyGems - rails-caddy - Versions diffs - 0.0.8 - Mend

rails-caddy 0.0.8

Files changed (32) hide show

data/LICENSE +20 -0
data/README.rdoc +69 -0
data/VERSION.yml +4 -0
data/lib/rails-caddy.rb +43 -0
data/lib/rails-caddy/controllers/rails_caddy_controller.rb +17 -0
data/lib/rails-caddy/controllers/sanitize_email_controller.rb +42 -0
data/lib/rails-caddy/controllers/session_editing_controller.rb +21 -0
data/lib/rails-caddy/controllers/timecop_controller.rb +56 -0
data/lib/rails-caddy/errors.rb +8 -0
data/lib/rails-caddy/helpers/rails_caddy_helper.rb +33 -0
data/lib/rails-caddy/session_controller_finder.rb +17 -0
data/lib/rails-caddy/views/_rails_caddy.html.erb +57 -0
data/lib/rails-caddy/views/_rails_caddy_css.html.erb +60 -0
data/lib/rails-caddy/views/_rails_caddy_js.html.erb +88 -0
data/test/README.txt +40 -0
data/test/files/acet.rb +40 -0
data/test/files/fct.rb +35 -0
data/test/files/rcct.rb +13 -0
data/test/files/sanitize_email_action_controller_extensions_test_methods.rb +71 -0
data/test/files/sanitize_email_controller_test_methods.rb +31 -0
data/test/files/session_editing_controller_test_methods.rb +41 -0
data/test/files/timecop_action_controller_extensions_test_methods.rb +55 -0
data/test/files/timecop_controller_test_methods.rb +30 -0
data/test/geminstaller.yml +5 -0
data/test/rails_caddy_controller_test.rb +43 -0
data/test/rails_caddy_helper_test.rb +24 -0
data/test/rails_caddy_test.rb +39 -0
data/test/rails_modifier.rb +131 -0
data/test/routes.rb +3 -0
data/test/session_controller_finder_test.rb +57 -0
data/test/test_helper.rb +12 -0
metadata +110 -0

data/lib/rails-caddy/views/_rails_caddy_js.html.erb ADDED

@@ -0,0 +1,88 @@
+<script type="text/javascript">
+  var RailsCaddyCookieStore = {
+    shouldOpenOnLoad: function() {
+      var all_cookies = $A(document.cookie.split('; '));
+      var our_cookie = all_cookies.find(function(cookie) {
+        return cookie.split('=')[0] == "rails_caddy"
+      });
+      return our_cookie != undefined;
+    },
+    removeCookie: function() {
+      // Set the expiration date in the past
+      document.cookie = "rails_caddy=off;expires=" + new Date(new Date().getTime() - 31536000000).toGMTString();
+    },
+    setCookie: function() {
+      // Set the expiration date in the future
+      document.cookie = "rails_caddy=on;expires=" + new Date(new Date().getTime() + 31536000000).toGMTString();
+    }
+  };
+  var RailsCaddy = {
+    editors: {},
+    isExtended: false,
+    sessionVariableTemplate: new Template("<p>#{key}<br /> <strong><%= escape_javascript(rc_in_place_editor_field("\#{key}", "\#{value}")) %></strong><a href='javascript:void(0)' onclick='RailsCaddy.removeSessionVariable(\"#{key}\", this);' class='x'>x</a></p>"),
+    init: function() {
+    	Event.observe('railsCaddyTab', 'click', RailsCaddy.slideSideBar, true);
+    	if (RailsCaddyCookieStore.shouldOpenOnLoad()) {
+    	  RailsCaddy.slideSideBar();
+    	}
+    },
+    slideSideBar: function() {
+    	new Effect.toggle('railsCaddyContents', 'blind', {scaleX: 'true', scaleY: 'true;', scaleContent: false});
+    	if (RailsCaddy.isExtended == 0) {
+    		new Effect.Fade('railsCaddyContents', { duration:1.0, from:0.0, to:1.0 });
+    		RailsCaddy.isExtended = true;
+    		RailsCaddyCookieStore.setCookie();
+    	}
+    	else {
+    		new Effect.Fade('railsCaddyContents', { duration:1.0, from:1.0, to:0.0 });
+    		RailsCaddy.isExtended = false;
+    		RailsCaddyCookieStore.removeCookie();
+    	}
+    },
+    scroll: function() {
+      $('railsCaddy').style.top = (window.scrollY + 100) + "px";
+    },
+    sessionVariableEditor: function(key, value) {
+      if (!value) { value = "blank"; }
+      return RailsCaddy.sessionVariableTemplate.evaluate({key : key, value : value});
+    },
+    addSessionVariable: function() {
+      var val = prompt("Enter the name of the new session variable:");
+      if (val) {
+        $('sessionObjects').insert(RailsCaddy.sessionVariableEditor(val, "blank"));
+        setTimeout("RailsCaddy.editors['" + val + "'].enterEditMode();", 100);
+      }
+    },
+    removeSessionVariable: function(key, anchor) {
+      //alert('removing key: ' + key);
+      new Ajax.Request('<%= translated_remove_session_path %>' + key, {method: 'post',
+        onSuccess: function(response) {
+          RailsCaddy.editors[key] = null;
+          $(anchor.parentNode).remove();
+        }
+      });
+    }
+  };
+  if (Event.observe === undefined) {
+    alert("It appears that the Prototype library has not been loaded.  rails_caddy currently requires Prototype.");
+  } else {
+    Event.observe(window, 'load',   RailsCaddy.init,   true);
+    Event.observe(window, 'scroll', RailsCaddy.scroll, true);
+  }
+</script>

data/test/README.txt ADDED

@@ -0,0 +1,40 @@
+## Steps to build a new baseline app in a separate rails version for testing
+rails _VERSION_ testVERSION
+ruby script/generate controller frogs index
+rake db:migrate
+edit frogs_controller, add:
+  %w(abc def ghi).each do |action|
+    define_method(action) do
+      session[:something] = action
+      render :action => 'index'
+    end
+  end
+edit frogs/index.html.erb
+  <html>
+  <head>
+    <title>Test</title>
+    <%= javascript_include_tag :all %>
+  </head>
+  <body>
+    <% if %w(development staging).include?(RAILS_ENV) -%>
+      <%= rails_caddy %>
+    <% end -%>
+  </body>
+  </html>
+edit application.rb
+  helper RailsCaddyHelper if %w(development staging).include? RAILS_ENV
+  layout nil
+edit environment.rb
+  config.gem "rails-caddy"
+  require 'rails-caddy'
+  require_dependency 'application'
+  RailsCaddy.init!

data/test/files/acet.rb ADDED

@@ -0,0 +1,40 @@
+# Becomes test/functional/action_controller_extensions_test.rb in rails apps.  Tests that our extensions to ActionController::Base work
+# in combination.
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+require 'shoulda'
+require 'rr'
+require File.join(File.dirname(__FILE__), '..', 'timecop_action_controller_extensions_test_methods')
+require File.join(File.dirname(__FILE__), '..', 'sanitize_email_action_controller_extensions_test_methods')
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit unless include?(RR::Adapters::TestUnit)
+end
+require 'rails-caddy'
+RailsCaddy.init!
+class DummyMailer < ActionMailer::Base
+  def test_email
+    recipients "nobody@smartlogicsolutions.com"
+    @subject = "A Title"
+    @body = "some dummy content"
+  end
+end
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.local_environments = ["test"]
+class TestController < ActionController::Base
+  # Simply a helper for us
+  def self.around_filters
+    self.filter_chain.select {|filter| filter.class == ActionController::Filters::AroundFilter}.map(&:method)
+  end
+end
+class ActionControllerExtensionsTest < Test::Unit::TestCase
+  include TimecopActionControllerExtensionsTestMethods
+  include SanitizeEmailActionControllerExtensionsTestMethods
+end

data/test/files/fct.rb ADDED

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+class FrogsControllerTest < ActionController::TestCase
+  def test_should_render_rails_caddy_on_index_with_empty_session
+    get :index
+    assert_response :success
+    assert_template 'index'
+  end
+  def test_should_render_entries_for_each_key_in_the_session
+    sess = {"key1" => "abc", "key2" => "def"}
+    get :index, {}, sess
+    assert_response :success
+    assert_template 'index'
+    assert_outputs_session_vars(sess.keys)
+  end
+  def test_should_render_newly_created_session_variable
+    # Recall that hitting /abc sets the 'something' session variable to 'abc'
+    sess = {"key1" => "abc", "key2" => "def"}
+    get :abc, {}, sess
+    assert_response :success
+    assert_template 'index'
+    assert_outputs_session_vars(sess.keys + ["something"])
+  end
+  private
+    def assert_outputs_session_vars(keys)
+      keys.each do |key|
+        # ugly regexp...
+        regex = Regexp.new("sessionVariableEditor\\(\\\"#{key}\\\"")
+        assert_match regex, @response.body
+      end
+    end
+end

data/test/files/rcct.rb ADDED

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+require 'shoulda'
+require File.join(File.dirname(__FILE__), '..', 'session_editing_controller_test_methods')
+require File.join(File.dirname(__FILE__), '..', 'timecop_controller_test_methods')
+require File.join(File.dirname(__FILE__), '..', 'sanitize_email_controller_test_methods')
+class RailsCaddyControllerTest < ActionController::TestCase
+  include SessionEditingControllerTestMethods
+  include TimecopControllerTestMethods
+  include SanitizeEmailControllerTestMethods
+end

data/test/files/sanitize_email_action_controller_extensions_test_methods.rb ADDED

@@ -0,0 +1,71 @@
+module SanitizeEmailActionControllerExtensionsTestMethods
+  def self.included(base)
+    base.class_eval do
+      context "TestController has been extended by SanitizeEmailController::ActionControllerExtensions" do
+        setup do
+          @controller = TestController.new
+        end
+        # should "add :handle_sanitize_email as an around_filter" do
+        #   assert @controller.class.around_filters.include?(:handle_sanitize_email)
+        # end
+        context "ActionMailer::Base.sanitized_recipients has been set in config/environment.rb" do
+          setup do
+            @default_sanitized_email = "jtrupiano@gmail.com"
+            ActionMailer::Base.sanitized_recipients = @default_sanitized_email
+          end
+          context "session[:sanitize_email_address] has been set and :handle_sanitize_email is invoked" do
+            setup do
+              @sanitize_email = "john@smartlogicsolutions.com"
+              @session_stub = {:sanitize_email_address => @sanitize_email}
+              stub(@controller).session { @session_stub }
+            end
+            should "set ActionMailer::Base.sanitized_recipients" do
+              @controller.send(:handle_sanitize_email) do
+                assert_not_nil ActionMailer::Base.sanitized_recipients
+                assert_equal @sanitize_email, ActionMailer::Base.sanitized_recipients
+              end
+            end
+            should "reroute generated emails as per session[:sanitize_email_address]" do
+              @controller.send(:handle_sanitize_email) do
+                mail = DummyMailer.create_test_email
+                assert_equal [@sanitize_email], mail.to
+              end
+            end
+          end
+          context "session[:sanitize_email_address] has not been set and :handle_sanitize_email is invoked" do
+            setup do
+              stub(@controller).session { {} }
+            end
+            should "not set ActionMailer::Base.sanitized_recipients" do
+              @controller.send(:handle_sanitize_email) do
+                assert_equal @default_sanitized_email, ActionMailer::Base.sanitized_recipients
+                # assert_nil ActionMailer::Base.sanitized_cc
+                # assert_nil ActionMailer::Base.sanitized_bcc
+              end
+            end
+            should "not reroute generated emails" do
+              @controller.send(:handle_sanitize_email) do
+                mail = DummyMailer.create_test_email
+                assert_equal [@default_sanitized_email], mail.to
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/files/sanitize_email_controller_test_methods.rb ADDED

@@ -0,0 +1,31 @@
+module SanitizeEmailControllerTestMethods
+  def self.included(base)
+    base.class_eval do
+      context "When the SanitizeEmailController module has been included" do
+        should "recognize route set_sanitize_email_address_path" do
+          assert_recognizes({:controller => 'rails_caddy', :action => 'set_sanitize_email_address'}, '/rails_caddy/set_sanitize_email_address')
+        end
+        should "recognize route unset_sanitize_email_address_path" do
+          assert_recognizes({:controller => 'rails_caddy', :action => 'unset_sanitize_email_address'}, '/rails_caddy/unset_sanitize_email_address')
+        end
+        should "set :sanitize_email_address session variable when #set_sanitize_email_address is invoked" do
+          post :set_sanitize_email_address, :value => "jtrupiano@gmail.com"
+          assert_response :success
+          assert_equal "jtrupiano@gmail.com", @response.body
+          assert_equal "jtrupiano@gmail.com", session[:sanitize_email_address]
+        end
+        should "unset :sanitize_email_address session variable when #unset_sanitize_email_address is invoked" do
+          post :unset_sanitize_email_address
+          assert_response :success
+          assert_equal "nil", @response.body
+          assert_nil session[:sanitize_email_address]
+        end
+      end
+    end
+  end
+end

data/test/files/session_editing_controller_test_methods.rb ADDED

@@ -0,0 +1,41 @@
+module SessionEditingControllerTestMethods
+  def self.included(base)
+    base.class_eval do
+      context "When the SessionEditingController module has been included" do
+        should "recognize route update_session_path" do
+          assert_recognizes({:controller => 'rails_caddy', :action => 'update_session', :id => 'foo'}, '/rails_caddy/update_session/foo')
+        end
+        should "recognize route remove_session_path" do
+          assert_recognizes({:controller => 'rails_caddy', :action => 'remove_session', :id => 'foo'}, '/rails_caddy/remove_session/foo')
+        end
+        should "be able to update an existing session variable" do
+          post(:update_session, {:id => "username", :value => "joe"}, {:username => "john"})
+          assert_response 200
+          assert_equal "joe", session[:username]
+        end
+        should "be able to add a new session variable" do
+          post(:update_session, {:id => "name", :value => "jason"})
+          assert_response 200
+          assert_equal "jason", session[:name]
+        end
+        should "render 422 when session variable id is missing" do
+          post(:update_session, {})
+          assert_response 422
+        end
+        should "be able to remove an existing session variable" do
+          post(:remove_session, {:id => "username"}, {:username => "john"})
+          assert_response 200
+          assert_equal nil, session[:username]
+        end
+      end
+    end
+  end
+end

data/test/files/timecop_action_controller_extensions_test_methods.rb ADDED

@@ -0,0 +1,55 @@
+module TimecopActionControllerExtensionsTestMethods
+  def self.included(base)
+    base.class_eval do
+      context "TestController has been extended by TimecopController::ActionControllerExtensions" do
+        setup do
+          @controller = TestController.new
+        end
+        # should "add :handle_timecop_offset as an around_filter" do
+        #   assert @controller.class.around_filters.include?(:handle_timecop_offset)
+        # end
+        context "session has been set" do
+          setup do
+            @travel_to = Time.local(2009, 1, 1)
+            @session_stub = {:timecop_adjusted_time => @travel_to}
+            stub(@controller).session { @session_stub }
+          end
+          should "adjust time" do
+            @controller.send(:handle_timecop_offset) do
+              assert_not_nil Time.now
+              assert (@travel_to - Time.now).abs < 100 # 100ms should be plenty of time for this test to run
+              # Brittle --> totally dependent upon implementation details of Timecop
+              assert (Time.now_without_mock_time - Time.now) > 5.days # We're well past Jan. 1, 2009, so this should be safe
+            end
+          end
+          should "move time forward by 3 seconds after yielding to consuming controller action" do
+            @controller.send(:handle_timecop_offset) do; end
+            # I can't do a straight assert_equal for some reason...
+            assert (@travel_to + 3 - @controller.session[:timecop_adjusted_time]).abs < 1
+          end
+        end
+        context "session has not been set" do
+          setup do
+            stub(@controller).session { {} }
+          end
+          should "not adjust time" do
+            @controller.send(:handle_timecop_offset) do
+              assert_not_nil Time.now
+              # Brittle --> totally dependent upon implementation details of Timecop
+              assert (Time.now_without_mock_time - Time.now) < 10 # shouldn't take more than 10ms to execute
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/files/timecop_controller_test_methods.rb ADDED

@@ -0,0 +1,30 @@
+module TimecopControllerTestMethods
+  def self.included(base)
+    base.class_eval do
+      context "When the TimecopController module has been included" do
+        should "recognize route timecop_update_path" do
+          assert_recognizes({:controller => 'rails_caddy', :action => 'timecop_update'}, '/rails_caddy/timecop_update')
+        end
+        should "recognize route timecop_reset_path" do
+          assert_recognizes({:controller => 'rails_caddy', :action => 'timecop_reset'}, '/rails_caddy/timecop_reset')
+        end
+        should "update time when a valid year/month/day are passed into #timecop_update" do
+          post :timecop_update, {:year => 2008, :month => 12, :day => 1}
+          assert_response :success
+          assert_equal Time.local(2008, 12, 1), session[:timecop_adjusted_time]
+        end
+        should "unset :timecop_adjusted_time when #timecop_reset action is invoked" do
+          post :timecop_reset, {}, {:timecop_adjusted_time => Time.local(2008, 4, 4)}
+          assert_response :success
+          assert_equal nil, session[:timecop_adjusted_time]
+        end
+      end
+    end
+  end
+end