xray-rails 0.1.1 → 0.1.2

data/README.md

@@ -1,30 +1,32 @@
-# Xray
+Xray
+====
 
-### Reveal the structure of your UI.
+### Reveal your UI's bones
 
 The dev tools available to web developers in modern browsers are great. Many of us can't remember what life was like before "Inspect Element". But what we see in the compiled output sent to our browser is often the wrong level of detail - what about being able to visualize the higher level components of your UI? Controllers, templates, partials, Backbone views, etc.
 
-Xray is the missing link between the browser and your app code. Press **cmd+ctrl+x** to reveal an overlay of what files are powering your UI - click anything to open the associated file in your editor.
+Xray is the missing link between the browser and your app code. Press **cmd+ctrl+x** to reveal an overlay of what files are powering your UI - click anything to open the associated file in your editor. [Here's a GIF](http://f.cl.ly/items/1A0o3y1y3Q13103V3F1l/xray-rails-large.gif) of Xray in action.
 
 ![Screenshot](http://dl.dropbox.com/u/156655/Screenshots/xgf7ukh3fya-.png)
 
-### Current Support
+## Current Support
 
-Xray is in early stages and currently supports only Rails 3.1+ with use of the asset pipeline as a requirement.
+Xray is intended to be run on Rails 3.1+ and Ruby 1.9.
 
 So far, Xray can reveal:
 
   * Rails views and partials
-  * Backbone View instances
+  * Backbone View instances if using the asset pipeline
 
-### Installation
+## Installation
 
-Add to your Gemfile, preferably under your development group:
+Xray depends on **jQuery**, so it will need to be included in your layout. Backbone is optional.
+
+Xray should only be present during development. Add it to your Gemfile like so:
 
 ```ruby
 group :development do
-  ...
-  gem 'xray-rails', github: 'brentd/xray-rails'
+  gem 'xray-rails'
 end
 ```
 
@@ -34,9 +36,21 @@ Then bundle and delete your cached assets:
 $ bundle && rm -rf tmp/cache/assets
 ```
 
-Restart your app, open your browser, and press `cmd+ctrl+x` to see the overlay.
+Restart your app, visit it in your browser, and press `cmd+ctrl+x` to see the overlay.
+
+**Note:** for Xray to insert itself into your views automatically, `config.assets.debug = true` (the default) must be set in development.rb. If you disabled this because of slow assets in Rails 3.2.13, [try this monkey patch instead](http://stackoverflow.com/a/15520932/24848) in an initializer.
+
+Otherwise, you can insert Xray's scripts yourself, for example like so in application.js:
+
+```js
+//= require jquery
+//= require xray
+...
+//= require backbone
+//= require xray-backbone
+```
 
-### Configuration
+## Configuration
 
 By default, Xray will open files with Sublime Text, looking for `/usr/local/bin/subl`.
 
@@ -54,14 +68,14 @@ Or for something more complex, use the `$file` placeholder.
 :editor: "/usr/local/bin/tmux split-window -v '/usr/local/bin/vim $file'"
 ```
 
-### How this works
+## How this works
 
 * During asset compilation, JS files and templates are modified to contain file path information.
 * A middleware inserts `xray.js`, `xray.css`, and the Xray bar into all successful HTML response bodies.
 * When the overlay is shown, `xray.js` examines the file path information inserted during asset compilation.
 * Another middleware piggybacks the Rails server to respond to requests to open file paths with the user's desired editor.
 
-### Contributing
+## Contributing
 
 If you have an idea, open an issue and let's talk about it, or fork away and send a pull request.
 

data/app/assets/javascripts/xray-backbone.js.coffee

@@ -9,8 +9,8 @@ return unless window.Backbone && window.Xray
 _ensureElement = Backbone.View::_ensureElement
 Backbone.View::_ensureElement = ->
   _.defer =>
-    info = Xray.constructorInfo @constructor
-    Xray.ViewSpecimen.add @el, info
+    if info = Xray.constructorInfo @constructor
+      Xray.ViewSpecimen.add @el, info
   _ensureElement.apply(this, arguments)
 
 # Cleanup when view is removed.

data/lib/xray/version.rb

@@ -1,3 +1,3 @@
 module Xray
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xray-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails