rails_view_annotator 0.0.1 → 0.0.2

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Readme.md

@@ -0,0 +1,27 @@
+# Rails View Annotator
+
+## Purpose
+
+The Rails View Annotator simply wraps the rendering of Rails partials with html comments indicating the disk location of the rendered partial.
+
+## Usage
+
+Simply add the gem to your Gemfile's development block.
+
+````ruby
+group :development
+  gem 'rails_view_annotator'
+end
+````
+
+Now rendered content will have instructive comments.
+
+````html
+<!-- begin: app/views/user/_bio.html.haml -->
+<div class='bio'>Ed's Bio</div>
+<!-- end: app/views/user/_bio.html.haml -->
+````
+
+## License
+
+WTFPL

data/lib/rails_view_annotator.rb

@@ -0,0 +1,3 @@
+require 'rails_view_annotator/action_view/partial_renderer'
+
+RailsViewAnnotator.augment_partial_renderer ActionView::PartialRenderer

data/lib/rails_view_annotator/action_view/partial_renderer.rb

@@ -0,0 +1,17 @@
+module RailsViewAnnotator
+  def self.augment_partial_renderer klass
+    render = klass.instance_method :render
+    klass.send(:define_method, :render) do |*args|
+      inner = render.bind(self).call(*args)
+      short_identifier = Pathname.new(identifier).relative_path_from Rails.root
+      "<!-- begin: #{short_identifier} -->#{inner}<!-- end: #{short_identifier} -->".html_safe
+    end
+    klass.send(:include, InstanceMethods)
+  end
+
+  module InstanceMethods
+    def identifier
+      (@template = find_partial) ? @template.identifier : @path
+    end
+  end
+end

data/lib/rails_view_annotator/version.rb

@@ -0,0 +1,3 @@
+module RailsViewAnnotator
+  VERSION = "0.0.2"
+end

data/rails_view_annotator.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_view_annotator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_view_annotator"
+  s.version     = RailsViewAnnotator::VERSION
+  s.authors     = ["Duncan Beevers"]
+  s.email       = ["duncan@dweebd.com"]
+  s.homepage    = "https://github.com/duncanbeevers/rails_view_annotator"
+  s.summary     = "Annotate Rails partial output with source path information"
+  s.description = "The Rails View Annotator makes it easy to find out which partial generated which output"
+
+  s.rubyforge_project = "rails_view_annotator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_view_annotator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000 Z
+date: 2012-02-11 00:00:00.000000000 Z
 dependencies: []
 description: The Rails View Annotator makes it easy to find out which partial generated
   which output
@@ -18,7 +18,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Rakefile
+- Readme.md
+- lib/rails_view_annotator.rb
+- lib/rails_view_annotator/action_view/partial_renderer.rb
+- lib/rails_view_annotator/version.rb
+- rails_view_annotator.gemspec
 homepage: https://github.com/duncanbeevers/rails_view_annotator
 licenses: []
 post_install_message: