x_ray 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bfbbb0efb83ed74530d2ce5e4d57ffc1d2d239b
-  data.tar.gz: 197b09fbb571beec222a2d449998b5c7523f5cad
+  metadata.gz: b09379710fafd39bbb50c68ae70273678502e80e
+  data.tar.gz: b15360848d164861247f4864bfc5a24d6622f391
 SHA512:
-  metadata.gz: ad831d894011b81e0924dbd23d08cac4668a8f7d05656df81d65d3f3cbfd85f6840b31d0ee918f92388bac8751b5e6120c77e2114bceb5f4389cc1e438558638
-  data.tar.gz: f34a40cf5155eddbe82aa4e4fc3abdf1255b476f51e989850cb732f1503ba071f22ff2ce3ed1ba29f4755a960fa596434a2066c96ff7872620914d8bea7eb2b9
+  metadata.gz: 5808c572bb76b92b00a07bf3caed25c06b90c21a8701a526d8ef342dcf5ceb5e1ac3c7e736fa52183aed33c502b185e3c1d5dde3ea25651414d3feefec22c914
+  data.tar.gz: c8e1e424c5dbf198e6b5022dc21c21398669652972ac3f89aafbb8dc581916f67a09d771f39e6651c77f266c6dfb8effccfc52e525b186afc6a57294bb624886

data/README.md

@@ -1,6 +1,6 @@
 # x_ray
 
-x_ray is a gem that helps easily display code examples, supports plain HTML and ERB.
+x_ray is a gem that helps easily display code examples, supports plain HTML and ERB. A lightweight tool for establishing your style guide.
 
 ## Installation
 
@@ -24,34 +24,71 @@ include XRay::Helper
 
 ## Usage
 
+Show HTML example:
 ```erb
-<!-- Render HTML from HTML -->
 <%= x_ray do %>
   <ol>
     <li>First thing</li>
     <li>Second thing</li>
   </ol>
 <% end %>
+```
+<img src="http://i.imgur.com/og5zaFx.png">
 
-<!-- Render HTML from ERB -->
+Show HTML example using ERB:
+```erb
 <%= x_ray do %>
   <%= submit_tag 'Set Time Zone', class: 'button button-primary' %>
 <% end %>
+```
+<img src="http://i.imgur.com/J0P4CIc.png">
 
-<!-- Render ERB from ERB -->
-<%= x_ray_erb do %>
-  &lt;%= submit_tag 'Set Time Zone', class: 'button button-primary' %&gt;
-<% end %>
+Show ERB example:
+```erb
+<%= x_ray_erb(
+  <<-ERB
+    \<%= submit_tag 'Set Time Zone', class: 'button button-primary' %\>
+  ERB
+) %>
+```
+<img src="http://i.imgur.com/MszQnBz.png">
 
-<!-- Render ERB from ERB for `render` (inserting ERB with block requires one-off logic) -->
-<%= x_ray_erb_render(layout: 'components/collapsable', locals: { heading: 'My virtual training plan'}) do %>
+Show ERB example that inserts with a block. Due to ERB/Rails wonkiness, the ability to use `<%=` with a block is actually a hack (http://stackoverflow.com/questions/17374274/why-is-this-an-error-with-erb); so a hack was necessary to make this to work with `x_ray`. Note: passing ERB into the `<%=` block will not render the block in the "code scan" properly, please use `x_ray_manual` for this case.
+```erb
+<%= x_ray_erb_insert_with_block(:render, layout: 'components/collapsable', locals: { heading: 'My virtual training plan'}) do %>
   <div class="box-small">
     <p class="outer-box-none">look at all this fun stuff in here!</p>
   </div>
 <% end %>
+
+<%= x_ray_erb_insert_with_block(:form_tag, 'users') do %>
+  <%= submit_tag 'Save' %>
+<% end %>
 ```
+<img src="http://i.imgur.com/zEthweg.png">
 
-<img src="http://i.imgur.com/X1QeI6M.png">
+Show ERB example manually. For all the nitty gritty corner cases, you can use this:
+```erb
+<%= x_ray_manual(
+  <<-ERB
+    \<% provide(:body) do %\>
+      \<%= render layout: 'components/collapsable', locals: { heading: 'My virtual training plan'} do %\>
+        Foo Bar!
+      \<% end %\>
+    \<% end %\>
+    \<%= yield(:body) %\>
+  ERB
+) do %>
+  <% provide(:body) do %>
+    <%= render layout: 'components/collapsable', locals: { heading: 'My virtual training plan', unique_key: '1sdasd', collapsable: nil} do %>
+      Foo Bar!
+    <% end %>
+  <% end %>
+
+  <%= yield(:body) %>
+<% end %>
+```
+<img src="http://i.imgur.com/raa94ap.png">
 
 ### Customization
 

data/app/helpers/x_ray/helper.rb

@@ -4,25 +4,20 @@ module XRay
       render(layout: 'layouts/x_ray/scan', &block)
     end
 
-    def x_ray_erb(&block)
-      render(layout: 'layouts/x_ray/erb_scan', &block)
+    def x_ray_erb(code)
+      render(partial: 'layouts/x_ray/erb_scan', locals: { code: code })
     end
 
-    def x_ray_erb_render(context, options={}, &block)
-      render(partial: 'layouts/x_ray/erb_render_scan', locals: { context: context, options: options, block: block})
+    def x_ray_erb_insert_with_block(method, *params, &block)
+      example = send(method, *params, &block)
+      render(partial: 'layouts/x_ray/erb_insert_with_block_scan', locals: { example: example,method: method, params: params, block: block })
     end
 
-    def x_ray_erb_render_code(context, options, raw_block)
-      code = if raw_block
-        "<%= render #{context}, #{options} do %>\n#{x_ray_scan(raw_block)}\n<% end %>"
-      else
-        "<%= render #{context}, #{options} %>"
-      end
-
-      x_ray_scan(code)
+    def x_ray_manual(code, &example_block)
+      render(partial: 'layouts/x_ray/manual_scan', locals: { example_block: example_block, code: code })
     end
 
-    def x_ray_scan(code)
+    def x_ray_output_code(code)
       text = <<-HTML.strip_heredoc
         #{code}
       HTML

data/app/views/layouts/x_ray/_erb_insert_with_block_scan.erb

@@ -0,0 +1,18 @@
+<div class="x-ray-block">
+  <div class="example">
+    <%= example %>
+  </div>
+
+  <div class="code-scan">
+    <div hidden>
+      <% block_code = <<-HTML.strip_heredoc
+          #{block.call}
+        HTML
+      %>
+    </div>
+    <pre>
+      <% params_string = params.map{ |param| param.is_a?(String) ? "'#{param}'" : param }.join(', ') %>
+<%= "\<%= #{method.to_s} #{params_string} do %\>#{block_code.split("\n").join("\n  ")}\n\<% end %\>" %>
+    </pre>
+  </div>
+</div>

data/app/views/layouts/x_ray/_erb_scan.html.erb

@@ -1,11 +1,11 @@
 <div class="x-ray-block">
   <div class="example">
-    <%= ERB.new(yield.gsub('&lt;', '<').gsub('&gt;', '>')).result(binding).html_safe %>
+    <%= ERB.new(code).result(binding).html_safe %>
   </div>
 
   <div class="code-scan">
     <pre>
-<%= x_ray_scan(yield.gsub('&lt;', '<').gsub('&gt;', '>')) %>
+<%= x_ray_output_code(code) %>
     </pre>
   </div>
 </div>

data/app/views/layouts/x_ray/_manual_scan.html.erb

@@ -0,0 +1,11 @@
+<div class="x-ray-block">
+  <div class="example">
+    <%= example_block.call %>
+  </div>
+
+  <div class="code-scan">
+    <pre>
+<%= x_ray_output_code(code) %>
+    </pre>
+  </div>
+</div>

data/app/views/layouts/x_ray/_scan.html.erb

@@ -5,7 +5,7 @@
 
   <div class="code-scan">
     <pre>
-<%= x_ray_scan(yield) %>
+<%= x_ray_output_code(yield) %>
     </pre>
   </div>
 </div>

data/lib/x_ray/version.rb

@@ -1,3 +1,3 @@
 module XRay
-  VERSION = '0.0.9'.freeze
+  VERSION = '0.0.10'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: x_ray
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Tiffany Huang
@@ -51,8 +51,9 @@ files:
 - app/assets/javascripts/x_ray/application.js
 - app/assets/stylesheets/x_ray/prettifier.scss
 - app/helpers/x_ray/helper.rb
-- app/views/layouts/x_ray/_erb_render_scan.html.erb
+- app/views/layouts/x_ray/_erb_insert_with_block_scan.erb
 - app/views/layouts/x_ray/_erb_scan.html.erb
+- app/views/layouts/x_ray/_manual_scan.html.erb
 - app/views/layouts/x_ray/_scan.html.erb
 - lib/x_ray.rb
 - lib/x_ray/engine.rb

data/app/views/layouts/x_ray/_erb_render_scan.html.erb

@@ -1,12 +0,0 @@
-<div class="x-ray-block">
-  <div class="example">
-    <%= render(context, options, &block) %>
-  </div>
-
-  <div class="code-scan">
-    <pre>
-      <div hidden><% raw_block = block.try(:call) %></div>
-<%= x_ray_erb_render_code(context, options, raw_block) %>
-    </pre>
-  </div>
-</div>