whiny_rendering 0.1.0 → 0.1.1

data/Manifest

@@ -1,5 +1,7 @@
 README.rdoc
 Rakefile
+init.rb
 lib/whiny_rendering.rb
 rails/init.rb
+whiny_rendering.gemspec
 Manifest

data/README.rdoc

@@ -0,0 +1,59 @@
+= WhinyRendering
+
+WhinyRendering is a gem for Rails which provides a method for ActionView that displays information about the current controller, action, template being rendered, and a list of all the partials being used in that view as well.
+
+It's the result of a lot of conversations held around the office about how convenient it would be to have a list, on the page you are viewing in the browser, of the exact template (and partials!) that you are actually seeing rendered in the browser. The idea is to plug it in to a project that you may not be too familiar with, and to cut down on all that annoying searching through the controllers and/or views to figure out what is actually going on in the view.
+
+This is a really early version. Feel free to send me feedback, ideas, pull requests, what-have-you.
+
+== Installing
+
+Assuming you have gemcutter installed (gem install gemcutter):
+
+  gem install whiny_rendering
+  
+Or, if you prefer plugins:
+
+  script/plugin install git://github.com/philcrissman/whiny_rendering.git
+  
+(Haven't tested it as a plugin, feedback welcomed.)
+  
+== Usage
+
+In your layout (probably application.html.(erb|haml)):
+
+  <%= whiny_rendering %>
+
+This outputs a div containing the rendering information.
+
+There are other formats available for use, however:
+
+You can hide the div, and provide a unobtrusive link that developers can click
+to toggle its display (using prototype):
+
+  <%= whiny_rendering(:hidden) %>
+
+Or, if you use jQuery:
+
+  <%= whiny_rendering(:hidden_jquery) %>
+
+Using :hidden_prototype will also work, in the event that you'd like to be
+explicit.
+
+You can also render it as an HTML comment rather than a div:
+
+  <%= whiny_rendering(:comment) %>
+
+If you use haml, well; you know what to do.
+
+You probably only want to see this in development mode, so you might rather:
+
+  <%= whiny_rendering if RAILS_ENV=="development" %>
+  
+... or something like that.
+
+Right now, this will put a div with the relevant information at whatever spot in your template you placed the call to whiny_rendering. It's completely unstyled, and there's no whiny_rendering.css included with the gem (yet!), but the div has the id of #whiny_rendering (hope you weren't using that for something already), so it is very easy to just add a few styles for this div to your default stylesheet.
+
+== Miscellany
+
+Author's homepage: http://philcrissman.com

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('whiny_rendering', '0.1.0') do |g|
+Echoe.new('whiny_rendering', '0.1.1') do |g|
   g.description = "Add a helper that will be explicitly whiny about what templates and/or partials are being rendered."
   g.url = "http://github.com/philcrissman/whiny_rendering"
   g.author = "Phil Crissman"

data/init.rb

@@ -0,0 +1,2 @@
+require 'whiny_rendering'
+ActionView::Base.send :include, WhinyRendering

data/lib/whiny_rendering.rb

@@ -1,6 +1,6 @@
 module WhinyRendering
   
-  def whiny_rendering
+  def whiny_rendering(format=:div)
     unless @_memoized__pick_partial_template.nil?  
       partials = @_memoized__pick_partial_template.map do |p|
         p[1].instance_variable_get(:"@_memoized_path")
@@ -8,15 +8,64 @@ module WhinyRendering
     else
       partials = []
     end
+
+    output = case format
+      when :div
+        build_div_output(partials)
+      when :hidden
+        build_hidden_prototype_output(partials)
+      when :hidden_prototype
+        build_hidden_prototype_output(partials)
+      when :hidden_jquery
+        build_hidden_jquery_output(partials)
+      when :comment
+        build_comment_output(partials)
+    end
+  end
+
+  private
+  def build_div_output(partials, hidden = false)
     div = <<-EOD
-      <div id='whiny_rendering'>
-        Controller <strong>#{ @controller.controller_name}</strong> and action <strong>#{ @controller.action_name }</strong> 
-        rendering template <strong>#{ @_first_render.instance_variable_get(:"@_memoized_path")}</strong>.
-        #{ "Rendering partials: <strong>" + partials.join(', ') + "</strong>" unless partials.empty? }
-      </div>
+    <div id='whiny_rendering' #{"style='display:none;'" if hidden} >
+      Controller <strong>#{ @controller.controller_name}</strong> and action <strong>#{ @controller.action_name }</strong>
+      rendering template <strong>#{ @_first_render.instance_variable_get(:"@_memoized_path") }</strong>.
+      #{ "Rendering partials: <strong>" + partials.join(', ') + "</strong>" unless partials.empty? }
+    </div>
+    EOD
+  end
+
+  def build_comment_output(partials)
+    comment = <<-EOD
+      <!--
+      Controller: #{ @controller.controller_name}
+      Action: #{ @controller.action_name}
+      Template: #{ @_first_render.instance_variable_get(:"@_memoized_path")}
+      #{ partials.empty? ? "-->" : "Partials: " + partials.join(', ') + "\n-->" }
+    EOD
+  end
+
+  def build_hidden_jquery_output(partials)
+    output = "<a href='#' id='whiny_rendering_toggle' style='font-size:0.8em;'>Whiny Rendering</a>\n"
+    output << build_div_output(partials, true)
+    output << <<-EOD
+      <script type="text/javascript">
+        jQuery('#whiny_rendering_toggle').toggle(
+          function () {
+            jQuery('#whiny_rendering').show();
+          },
+          function () {
+            jQuery('#whiny_rendering').hide();
+          }
+        );
+      </script>
     EOD
   end
   
+  def build_hidden_prototype_output(partials)
+     output = "<a href='javascript:$('whiny_rendering').toggle();' id='whiny_rendering_toggle' style='font-size:0.8em;'>Whiny Rendering</a>\n"
+     output << build_div_output(partials, true)
+  end
+  
 end
 
 
@@ -34,4 +83,4 @@ end
 #   <% end %>
 # <% else %>
 #   nil
-# <% end %>
+# <% end %>

data/whiny_rendering.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whiny_rendering}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Crissman"]
-  s.date = %q{2010-06-18}
+  s.date = %q{2010-07-31}
   s.description = %q{Add a helper that will be explicitly whiny about what templates and/or partials are being rendered.}
   s.email = %q{phil@betadeluxe.com}
   s.extra_rdoc_files = ["README.rdoc", "lib/whiny_rendering.rb"]
-  s.files = ["README.rdoc", "Rakefile", "lib/whiny_rendering.rb", "rails/init.rb", "Manifest", "whiny_rendering.gemspec"]
+  s.files = ["README.rdoc", "Rakefile", "init.rb", "lib/whiny_rendering.rb", "rails/init.rb", "whiny_rendering.gemspec", "Manifest"]
   s.homepage = %q{http://github.com/philcrissman/whiny_rendering}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whiny_rendering", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Phil Crissman
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-18 00:00:00 -05:00
+date: 2010-07-31 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -30,10 +30,11 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
+- init.rb
 - lib/whiny_rendering.rb
 - rails/init.rb
-- Manifest
 - whiny_rendering.gemspec
+- Manifest
 has_rdoc: true
 homepage: http://github.com/philcrissman/whiny_rendering
 licenses: []