xray-rails 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6a5e69196ed74df3334802769fff5046e12acba7
-  data.tar.gz: 5cc5f2071615a6daa2a4886ec5e7f9b6f0b54721
+SHA256:
+  metadata.gz: fddfb999d09d721a49e7cb63a2630c6e44df2ab05500f724edcc43d2f2e2fe8c
+  data.tar.gz: 0b94f6788077aff52eb33da34b6e8c69ec7d83de9c5e8938c77dfcbab62f08f8
 SHA512:
-  metadata.gz: 8f1474f2f3fbcc840abf274d3381b2dd43ffc8d51879e29797b10e45277aa4d530878b6d45fb4e134aa4b391e633372cc8ee3285b909cde8cf6c293e71fa4a6a
-  data.tar.gz: f96aa8246c8509b4a5a88f6ebb628bd03804760c604de52a735d2ceaa0636a6beed6a1eefeaae85ade28a96177a1f83a6d1ba4580d7ae7993f2a6b51f24bab92
+  metadata.gz: e8aecb78e16ec95b457b48c59e4958da87ef025f8bd7f0a566f999348f2d744499222aca605a4c0c4c4ba89f355f7ab88b753d6b4f76ad39a4b8ab87881a29b2
+  data.tar.gz: d9cd337ff33da6228337dd91a90a5c165642b78444d54d8f6cc17be9a41e5a108a6acad0854311ef03991a4ba8da399fa1ff9daba1157cd151755542f75d06c3

data/README.md

@@ -8,9 +8,9 @@ Xray-rails
 
 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 visualizing the higher level components of your UI? Controllers, view templates, partials, JS templates, etc.
 
-Xray is the missing link between the browser and your app code. Press **cmd+shift+x** (Mac) or **ctrl+shift+x** to reveal an overlay of the files that rendered your UI, and click anything to open the file in your editor. [See Xray in action](http://f.cl.ly/items/1A0o3y1y3Q13103V3F1l/xray-rails-large.gif).
+Xray is the missing link between the browser and your app code. Press **command+shift+x** (Mac) or **ctrl+shift+x** to reveal an overlay of the files that rendered your UI, and click anything to open the file in your editor.
 
-![Screenshot](https://dl.dropboxusercontent.com/u/156655/xray-screenshot.png)
+![Screenshot](example/screenshot.png)
 
 ## Current Support
 
@@ -39,7 +39,7 @@ Then bundle and delete your cached assets:
 $ bundle && rm -rf tmp/cache/assets
 ```
 
-Restart your app, visit it in your browser, and press **cmd+shift+x** (Mac) or **ctrl+shift+x** to reveal the overlay.
+Restart your app, visit it in your browser, and press **command+shift+x** (Mac) or **ctrl+shift+x** to reveal the overlay.
 
 #### Note about `config.assets.debug`
 
@@ -77,14 +77,18 @@ For something more complex, use the `$file` placeholder.
 * 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 inserted filepath info to build the overlay.
 
-## Disabling Xray in particular templates
+## Disabling Xray
 
-Xray augments HTML templates by wrapping their contents with HTML comments. For some environments such as [Angular.js](http://angularjs.org/), this can cause Angular templates to stop working because Angular expects only one root node in the template HTML. You can pass in the option `xray: false` to any render statements to ensure Xray does not augment that template. Example:
+Xray augments HTML templates by wrapping their contents with HTML comments. For some environments such as [Angular.js](http://angularjs.org/), this can cause Angular templates to stop working because Angular expects only one root node in the template HTML. You can pass in the option `xray: false` to any partial render statements to ensure Xray does not augment that partial. Example:
 
 ```ruby
-render 'show', xray: false
+render partial: 'my_partial', locals: { xray: false }
 ```
 
+Note that this disables Xray's HTML comment wrappers for `my_partial`, but not any sub-partials rendered within that template, if any. You must pass `xray: false` to each `render` call where you want Xray disabled.
+
+Currently there is no way to disable Xray entirely for a given request. If this feature is important to you, please leave a comment on [issue #75](https://github.com/brentd/xray-rails/issues/75). PRs are appreciated!
+
 ## Contributing
 
 If you have an idea, open an issue and let's talk about it, or fork away and send a pull request.

data/lib/xray/config.rb

@@ -5,8 +5,6 @@ module Xray
   end
 
   class Config
-    attr_accessor :editor
-
     CONFIG_FILE = ".xrayconfig"
 
     def default_editor
@@ -34,7 +32,7 @@ module Xray
     end
 
     def config_file
-      if File.exists?("#{Dir.pwd}/#{CONFIG_FILE}")
+      if File.exist?("#{Dir.pwd}/#{CONFIG_FILE}")
         "#{Dir.pwd}/#{CONFIG_FILE}"
       else
         "#{Dir.home}/#{CONFIG_FILE}"

data/lib/xray/engine.rb

@@ -21,10 +21,10 @@ module Xray
       ActionView::Template.class_eval do
         extend Xray::Aliasing
 
-        def render_with_xray(*args, &block)
+        def render_with_xray(*args, **kwargs, &block)
           path = identifier
           view = args.first
-          source = render_without_xray(*args, &block)
+          source = render_without_xray(*args, **kwargs, &block)
 
           suitable_template = !(view.respond_to?(:mailer) && view.mailer) &&
                               !path.include?('_xray_bar') &&
@@ -33,7 +33,7 @@ module Xray
 
           options = args.last.kind_of?(Hash) ? args.last : {}
 
-          if suitable_template && !(options.has_key?(:xray) && (options[:xray] == false))
+          if source && suitable_template && !(options.has_key?(:xray) && (options[:xray] == false))
             Xray.augment_template(source, path)
           else
             source
@@ -55,7 +55,7 @@ module Xray
         end
 
         def self.run(filename, source, context)
-          path = context.pathname.to_s
+          path = Pathname.new(context.filename).to_s
           if path =~ /^#{Rails.root}.+\.(jst)(\.|$)/
             Xray.augment_template(source, path)
           else

data/lib/xray/middleware.rb

@@ -16,7 +16,7 @@ module Xray
       # Request for opening a file path.
       if env['PATH_INFO'] == OPEN_PATH
         req, res = Rack::Request.new(env), Rack::Response.new
-        out, err, status = Xray.open_file(req.GET['path'])
+        out, _err, status = Xray.open_file(req.GET['path'])
         if status.success?
           res.status = 200
         else

data/lib/xray/version.rb

@@ -1,3 +1,3 @@
 module Xray
-  VERSION = "0.3.1".freeze
+  VERSION = "0.3.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xray-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Brent Dillingham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2024-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -118,7 +118,7 @@ homepage: https://github.com/brentd/xray-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.5.21
+signing_key:
 specification_version: 4
 summary: Reveal the structure of your UI
 test_files: []