view_inspect 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmU4ZjA5Yjg2OTdkZTg0NjhjOTlhYzllZDIyZDMyZDM1NjYwZTZiZg==
+  data.tar.gz: !binary |-
+    NjdiM2UwMzZiMjlmYjM4YmVmYzRjNjQ4MDI4MTMzYzk2MWUyNWYxNA==
+SHA512:
+  metadata.gz: !binary |-
+    YmZlNTIyNjllZWM2YjQ2NjY2YzQ5ZjEwYTAyZTJlZDAyNjY0YjU0Nzk3NmI5
+    NWViOGQ2MzdlYTJkZjUxYTE1MzA4OGQzMmU5MDMwOGU4NDY0NTU4NWRiNWQ0
+    MWRjNDA5ZTNkMDJkMzYwNDNkOTJlYWU1ZjA5N2E5ZjMzOWRmZDc=
+  data.tar.gz: !binary |-
+    NTBmMjVkNTYyMmE3OGFkZTc5N2JlNGQwODYwNGUzNWY0MTU4MGE1YTlmNjBm
+    MWNiOTVlNDY2MjZmNDQ4MjFiNzM0MDUyY2E5YjQyMzg0NjVhYWNlY2M2MDg1
+    YjliMmZkZDkzZTM4NzI2MmEzYmNjZWJjZWU1ODE5MTY4YjA0NjQ=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Reginald Tan
+
+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,31 @@
+= View Inspect
+
+View Inspect shows you the source location of a client or server rendered DOM element.
+
+== Demo
+
+
+
+== Installation
+
+  group :development do
+    gem "view_inspect"
+  end
+
+== Warning
+
+  Don't run this on production. Preferably, you should only run this locally, not even on staging environments. View Inspect shows you the fullpath of your and back-end and front-end code. That is unless you dont mind people seeing things like /home/nandato/rails/app/releases/20131012158211/app/views/ganbatte/show.html.erb:2 in the HTML source
+
+== Support
+
+Server Side:
+  works with plain html, erb, haml
+
+Client Side:
+  works with plain Javascript, and tested with Backbone, Ember
+
+== Copyright
+
+Copyright (c) 2014 Reginald Tan. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "view_inspect"
+  gem.homepage = "http://github.com/redgetan/view_inspect"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "redge.tan@gmail.com"
+  gem.authors = ["Reginald Tan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "view_inspect #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/view_inspect/erb.rb

@@ -0,0 +1,56 @@
+module ViewInspect
+  module ERB
+    # from erubis 2.7.0
+    #DEFAULT_REGEX = /(<%(=+|-|\#|%)?(.*?)([-=])?%>([ \t]*\r?\n)?)/m
+
+    ERB_REGEX_EXCLUDE_ENDING_NEWLINE = /(<%(=+|-|\#|%)?(.*?)([-=])?%>([ \t]*)?)/m
+    ERB_STUB = "__erb_stub_placement___"
+
+    @erb_orig_list = []
+
+    def self.enable
+      ActionView::Template.class_eval do
+        alias_method :orig_source, :source
+
+        def source
+          return orig_source unless handler.respond_to? :erb_implementation
+          ::ViewInspect::ERB.add_file_line_to_html_tags(orig_source, identifier)
+        end
+      end
+    end
+
+    def self.add_file_line_to_html_tags(source, filepath)
+
+      source = replace_erb_with_stub(source)
+      source = add_file_line(source, filepath)
+      source = replace_stub_with_erb(source)
+
+      source
+    end
+
+    def self.add_file_line(source, filepath)
+      doc = Nokogiri::HTML(source)
+
+      doc.traverse do |node|
+        if node.is_a?(Nokogiri::XML::Element)
+          file_line = [filepath, node.line].join(":")
+          node.set_attribute "data-orig-file-line", file_line
+        end
+      end
+
+      doc.inner_html
+    end
+
+    def self.replace_erb_with_stub(source)
+      @erb_orig_list = source.scan(ERB_REGEX_EXCLUDE_ENDING_NEWLINE).map { |a,b,c,d,e| a }
+      source.gsub(ERB_REGEX_EXCLUDE_ENDING_NEWLINE,ERB_STUB)
+    end
+
+    def self.replace_stub_with_erb(source)
+      source.gsub(ERB_STUB).with_index do |match, index|
+        @erb_orig_list[index]
+      end
+    end
+
+  end
+end

data/lib/view_inspect/haml.rb

@@ -0,0 +1,24 @@
+module ViewInspect
+  module Haml
+    def self.enable
+      return unless haml_installed?
+
+      ::Haml::Compiler.class_eval do
+        alias_method :orig_compile, :compile
+
+        def compile(node)
+          if node.type == :tag
+            file_line = [@options[:filename], node.line].join(":")
+            node.value.attributes.merge!(:data => { :orig_file_line => file_line })
+          end
+          orig_compile(node)
+        end
+      end
+    end
+
+    def self.haml_installed?
+      defined? ::Haml::Compiler
+    end
+  end
+end
+

data/lib/view_inspect/railtie.rb

@@ -0,0 +1,7 @@
+module ViewInspect
+  class Railtie < Rails::Railtie
+    initializer "view_inspect_railtie.configure_rails_initialization" do
+      ViewInspect.enable  
+    end
+  end
+end

data/lib/view_inspect.rb

@@ -0,0 +1,26 @@
+require 'view_inspect/erb'
+require 'view_inspect/haml'
+
+module ViewInspect
+  def self.enable
+    return unless allow_view_source_location?
+
+    ERB.enable
+    Haml.enable
+  end
+
+  def self.allow_view_source_location?
+    if defined?(Rails)
+      config[:allow_view_source_location] || Rails.env.development?
+    else
+      config[:allow_view_source_location] || false
+    end
+  end
+
+  def self.config
+    @config ||= {}
+  end
+
+end
+
+require 'view_inspect/railtie' if defined?(Rails)

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'view_inspect'
+
+class Test::Unit::TestCase
+end

data/test/test_view_inspect.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestViewInspect < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/view_inspect.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = "view_inspect"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = ">= 1.9.3"
+
+  s.authors = ["Reginald Tan"]
+  s.email = "redge.tan@gmail.com"
+  s.summary = "Shows you the source location of a DOM element"
+  s.description = "Shows you the source location of a DOM element. Works with Erb and Haml templates and Javascript generated DOM"
+  s.files = `git ls-files`.split($/)
+  s.homepage = "http://github.com/redgetan/view_inspect"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.10"
+
+  s.add_dependency "nokogiri"
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: view_inspect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Reginald Tan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shows you the source location of a DOM element. Works with Erb and Haml
+  templates and Javascript generated DOM
+email: redge.tan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/view_inspect.rb
+- lib/view_inspect/erb.rb
+- lib/view_inspect/haml.rb
+- lib/view_inspect/railtie.rb
+- test/helper.rb
+- test/test_view_inspect.rb
+- view_inspect.gemspec
+homepage: http://github.com/redgetan/view_inspect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Shows you the source location of a DOM element
+test_files: []
+has_rdoc: